More flexible http request handler about airnotifier

[dcai]

Proposed request format, the http body will be the $eventdata in json format.

cc @jleyva

POST http://push.moodle.net/notification/
X-AN-APP-NAME: moodlemobile
X-AN-APP-KEY: 4EF234523AD
Content-Type: application/json

{
  "alert": "blogger#post",
  "device": "",
  "token" : "device token/regid for gcm/channel url for windows",
  "sound": "",
  "badge": "",
  "userfrom": "",
  "userto": "",
  "subject": "message subject",
  "fullmessage": "",
  "timecreated": "",
}

[jleyva]

I think that we should distinguish between the "full message object" and the Airnotifier required parameters by AIRNOTIFIER (APPNAME, APPKEY, TOKEN, etc...)

So, why don't use HEADERS for platform and token and the body for the rest of the elements?
Notice that the token size (length) can be huge, so I'm not sure if HTTP headers will be valid

Another option is tu use prefixes for the Airnotifier required parameters like:

{
"alert": "blogger#post",
"an-device": "",
"an-token" : "device token/regid for gcm/channel url for windows",
"sound": "",
"badge": "",
"userfrom": "",
"userto": "",
"subject": "message subject",
"fullmessage": "",
"timecreated": "",
}

[jleyva]

Another question, do you think that the current curl class (you made for Moodle) can support this type of requests?
I've been looking the code and I see methods por POST/GET/PUT and a generic method called request

[dcai]

Hi @jleyva

It might not be the best option to use customized headers for mandatory parameters, "X-" headers are being deprecated: http://tools.ietf.org/html/rfc6648

It looks a little messy to use prefixes in JSON, probably we could keep required parameters on top level, and optional parameters in a nested property, it looks like:

POST http://push.moodle.net/api/v2/push/
X-AN-APP-NAME: moodlemobile
X-AN-APP-KEY: 4EF234523AD
Content-Type: application/json

{
  "alert": "Notification from client",
  "device": "wns",
  "token" : "for wns, this is a channel url",
  "sound": "",
  "badge": "",
  "wns": {
    "type": "toast",
    "image": "...",
    "template: "ToastImageAndText04"
  }
  "extra": {
    "processor": "moodle",
    "data": {
      "userfrom": "",
      "userto": "",
      "subject": "message subject",
      "fullmessage": "",
      "timecreated": "",
    }
  }
}

[dcai]

And if required parameters are missing "400 Bad Request" should be responded, 202 if successfully (200 at the moment, but 202 Accepted is more appropriated for triggering an event)

[dcai]

Another question, do you think that the current curl class (you made for Moodle) can support this type of requests?
I've been looking the code and I see methods por POST/GET/PUT and a generic method called request

Yes, you can do $curl->post($url, json_enable($eventdata));, when the second parameter isn't array, curl library will use it as raw post body.

[jleyva]

+1 extra properties nested

Thanks for the clarification about the curl library