Merge lp:~ralsina/ubuntu-push/bring-in-examples into lp:ubuntu-push

[Roberto Alsina]

Deduplicate text, and bring in the example code into the project.

Deduplicate text, and bring in the example code into the project.

A second branch will add a bunch of links to them in the document.

[lp:~ralsina/ubuntu-push/bring-in-examples]

329. By Roberto Alsina on 2014-09-05

added example app server

Unmerged revisions

=== modified file 'debian/ubuntu-push-client.conf'
--- debian/ubuntu-push-client.conf	2014-08-06 14:08:29 +0000
+++ debian/ubuntu-push-client.conf	2014-09-05 14:53:45 +0000
@@ -3,6 +3,10 @@
 start on started unity8
 stop on stopping unity8
 
+# set the media role for sounds to notifications' role
+env PULSE_PROP="media.role=alert"
+export PULSE_PROP
+
 exec /usr/lib/ubuntu-push-client/ubuntu-push-client
 respawn
 

=== added file 'docs/_common.txt'
--- docs/_common.txt	1970-01-01 00:00:00 +0000
+++ docs/_common.txt	2014-09-05 14:53:45 +0000
@@ -0,0 +1,186 @@
+Application Helpers
+-------------------
+
+The payload delivered to push-client will be passed onto a helper program that can modify it as needed before passing it onto
+the postal service (see `Helper Output Format <#helper-output-format>`__).
+
+The helper receives two arguments ``infile`` and ``outfile``. The message is delivered via ``infile`` and the transformed
+version is placed in ``outfile``.
+
+This is the simplest possible useful helper, which simply passes the message through unchanged::
+
+    #!/usr/bin/python3
+
+    import sys
+    f1, f2 = sys.argv[1:3]
+    open(f2, "w").write(open(f1).read())
+
+Helpers need to be added to the click package manifest::
+
+    {
+        "name": "com.ubuntu.developer.ralsina.hello",
+        "description": "description of hello",
+        "framework": "ubuntu-sdk-14.10-qml-dev2",
+        "architecture": "all",
+        "title": "hello",
+        "hooks": {
+            "hello": {
+                "apparmor": "hello.json",
+                "desktop": "hello.desktop"
+            },
+            "helloHelper": {
+                "apparmor": "helloHelper-apparmor.json",
+                "push-helper": "helloHelper.json"
+            }
+        },
+        "version": "0.2",
+        "maintainer": "Roberto Alsina <[e-mail]>"
+    }
+
+Here, we created a helloHelper entry in hooks that has an apparmor profile and an additional JSON file for the push-helper hook.
+
+helloHelper-apparmor.json must contain **only** the push-notification-client policy group::
+
+    {
+        "policy_groups": [
+            "push-notification-client"
+        ],
+        "policy_version": 1.2
+    }
+
+And helloHelper.json must have at least a exec key with the path to the helper executable relative to the json, and optionally
+an app_id key containing the short id of one of the apps in the package (in the format packagename_appname without a version).
+If the app_id is not specified, the helper will be used for all apps in the package::
+
+    {
+        "exec": "helloHelper",
+        "app_id": "com.ubuntu.developer.ralsina.hello_hello"
+    }
+
+.. note:: For deb packages, helpers should be installed into /usr/lib/ubuntu-push-client/legacy-helpers/ as part of the package.
+
+Helper Output Format
+--------------------
+
+Helpers output has two parts, the postal message (in the "message" key) and a notification to be presented to the user (in the "notification" key).
+
+.. note:: This format **will** change with future versions of the SDK and it **may** be incompatible.
+
+Here's a simple example::
+
+    {
+        "message": "foobar",
+        "notification": {
+            "tag": "foo",
+            "card": {
+                "summary": "yes",
+                "body": "hello",
+                "popup": true,
+                "persist": true,
+                "timestamp": 1407160197
+            }
+            "sound": "buzz.mp3",
+            "vibrate": {
+                "pattern": [200, 100],
+                "repeat": 2
+            }
+            "emblem-counter": {
+                "count": 12,
+                "visible": true
+            }
+        }
+    }
+
+The notification can contain a **tag** field, which can later be used by the `persistent notification management API. <#persistent-notification-management>`__
+
+:message: (optional) A JSON object that is passed as-is to the application via PopAll.
+:notification: (optional) Describes the user-facing notifications triggered by this push message.
+
+The notification can contain a **card**. A card describes a specific notification to be given to the user,
+and has the following fields:
+
+:summary: (required) a title. The card will not be presented if this is missing.
+:body: longer text, defaults to empty.
+:actions: If empty (the default), a bubble notification is non-clickable.
+          If you add a URL, then bubble notifications are clickable and launch that URL. One use for this is using a URL like
+          ``appid://com.ubuntu.developer.ralsina.hello/hello/current-user-version`` which will switch to the app or launch
+          it if it's not running. See `URLDispatcher <https://wiki.ubuntu.com/URLDispatcher>`__ for more information.
+
+:icon: An icon relating to the event being notified. Defaults to empty (no icon);
+       a secondary icon relating to the application will be shown as well, regardless of this field.
+:timestamp: Seconds since the unix epoch, only used for persist (for now). If zero or unset, defaults to current timestamp.
+:persist: Whether to show in notification centre; defaults to false
+:popup: Whether to show in a bubble. Users can disable this, and can easily miss them, so don't rely on it exclusively. Defaults to false.
+
+.. note:: Keep in mind that the precise way in which each field is presented to the user depends on factors such as
+          whether it's shown as a bubble or in the notification centre, or even the version of Ubuntu Touch the user
+          has on their device.
+
+The notification can contain a **sound** field. This is either a boolean (play a predetermined sound) or the path to a sound file. The user can disable it, so don't rely on it exclusively.
+Defaults to empty (no sound). The path is relative, and will be looked up in (a) the application's .local/share/<pkgname>, and (b)
+standard xdg dirs.
+
+The notification can contain a **vibrate** field, causing haptic feedback, which can be either a boolean (if true, vibrate a predetermined way) or an object that has the following content:
+
+:pattern: a list of integers describing a vibration pattern (duration of alternating vibration/no vibration times, in milliseconds).
+:repeat: number of times the pattern has to be repeated (defaults to 1, 0 is the same as 1).
+
+The notification can contain a **emblem-counter** field, with the following content:
+
+:count: a number to be displayed over the application's icon in the launcher.
+:visible: set to true to show the counter, or false to hide it.
+
+.. note:: Unlike other notifications, emblem-counter needs to be cleaned by the app itself.
+          Please see `the persistent notification management section. <#persistent-notification-management>`__
+
+.. FIXME crosslink to hello example app on each method
+
+Security
+~~~~~~~~
+
+To use the push API, applications need to request permission in their security profile, using something like this::
+
+    {
+        "policy_groups": [
+            "networking",
+            "push-notification-client"
+        ],
+        "policy_version": 1.2
+    }
+
+
+Ubuntu Push Server API
+----------------------
+
+The Ubuntu Push server is located at https://push.ubuntu.com and has a single endpoint: ``/notify``.
+To notify a user, your application has to do a POST with ``Content-type: application/json``.
+
+.. note:: The contents of the data field are arbitrary. They should be enough for your helper to build
+          a notification using it, and decide whether it should be displayed or not. Keep in mind
+          that this will be processed by more than one version of the helper, because the user may be using
+          an older version of your app.
+
+Here is an example of the POST body using all the fields::
+
+    {
+        "appid": "com.ubuntu.music_music",
+        "expire_on": "2014-10-08T14:48:00.000Z",
+        "token": "LeA4tRQG9hhEkuhngdouoA==",
+        "clear_pending": true,
+        "replace_tag": "tagname",
+        "data": {
+            "id": 43578,
+            "timestamp": 1409583746,
+            "serial": 1254,
+            "sender": "Joe",
+            "snippet": "Hi there!"
+        }
+    }
+
+
+:appid: ID of the application that will receive the notification, as described in the client side documentation.
+:expire_on: Expiration date/time for this message, in `ISO8601 Extendend format <http://en.wikipedia.org/wiki/ISO_8601>`__
+:token: The token identifying the user+device to which the message is directed, as described in the client side documentation.
+:clear_pending: Discards all previous pending notifications. Usually in response to getting a "too-many-pending" error.
+:replace_tag: If there's a pending notification with the same tag, delete it before queuing this new one.
+:data: A JSON object.

=== added file 'docs/_description.txt'
--- docs/_description.txt	1970-01-01 00:00:00 +0000
+++ docs/_description.txt	2014-09-05 14:53:45 +0000
@@ -0,0 +1,46 @@
+Let's describe the push system by way of an example.
+
+Alice has written a chat application called Chatter. Using it, Bob can send messages to Carol and viceversa. Alice has a
+web application for it, so the way it works now is that Bob connects to the service, posts a message, and when Carol
+connects, she gets it. If Carol leaves the browser window open, it beeps when messages arrive.
+
+Now Alice wants to create an Ubuntu Touch app for Chatter, so she implements the same architecture using a client that
+does the same thing as the web browser. Sadly, since applications on Ubuntu Touch don't run continuously, messages are
+only delivered when Carol opens the app, and the user experience suffers.
+
+Using the Ubuntu Push Server, this problem is alleviated: the Chatter server will deliver the messages to the Ubuntu
+Push Server, which in turn will send it in an efficient manner to the Ubuntu Push Client running in Bob and Carol's
+devices. The user sees a notification (all without starting the app) and then can launch it if he's interested in
+reading messages at that point.
+
+Since the app is not started and messages are delivered oportunistically, this is both battery and bandwidth-efficient.
+
+.. figure:: push.svg
+
+The Ubuntu Push system provides:
+
+* A push server which receives **push messages** from the app servers, queues them and delivers them efficiently
+  to the devices.
+* A push client which receives those messages, queues messages to the app and displays notifications to the user
+
+The full lifecycle of a push message is:
+
+* Created in a application-specific server
+* Sent to the Ubuntu Push server, targeted at a user or user+device pair
+* Delivered to one or more Ubuntu devices
+* Passed through the application helper for processing
+* Notification displayed to the user (via different mechanisms)
+* Application Message queued for the app's use
+
+If the user interacts with the notification, the application is launched and should check its queue for messages
+it has to process.
+
+For the app developer, there are several components needed:
+
+* A server that sends the **push messages** to the Ubuntu Push server
+* Support in the client app for registering with the Ubuntu Push client
+* Support in the client app to react to **notifications** displayed to the user and process **application messages**
+* A helper program with application-specific knowledge that transforms **push messages** as needed.
+
+In the following sections, we'll see how to implement all the client side parts. For the application server, see the
+`Ubuntu Push Server API section <#ubuntu-push-server-api>`__

=== added directory 'docs/example-client'
=== added file 'docs/example-client/.excludes'
=== added file 'docs/example-client/Makefile'
--- docs/example-client/Makefile	1970-01-01 00:00:00 +0000
+++ docs/example-client/Makefile	2014-09-05 14:53:45 +0000
@@ -0,0 +1,22 @@
+# More information: https://wiki.ubuntu.com/Touch/Testing
+#
+# Notes for autopilot tests:
+# -----------------------------------------------------------
+# In order to run autopilot tests:
+# sudo apt-add-repository ppa:autopilot/ppa
+# sudo apt-get update
+# sudo apt-get install python-autopilot autopilot-qt
+#############################################################
+
+all:
+
+autopilot:
+	chmod +x tests/autopilot/run
+	tests/autopilot/run
+
+check:
+	qmltestrunner -input tests/unit
+
+run:
+	/usr/bin/qmlscene $@ push-example.qml
+

=== added file 'docs/example-client/README'
--- docs/example-client/README	1970-01-01 00:00:00 +0000
+++ docs/example-client/README	2014-09-05 14:53:45 +0000
@@ -0,0 +1,28 @@
+Example App for the QML notifications API. This is an example application
+showing how to use push notifications in Ubuntu Touch devices.
+
+= Running on Ubuntu Touch =
+
+Since push is currently only meant for Ubuntu Touch devices, this is meant
+to be used in the emulator or on a real device.
+
+* Open the example project in Ubuntu-SDK
+* Build a click file
+* Run in the emulator or device
+
+= Running on the desktop =
+
+This is more complicated but may be convenient while experimenting:
+
+* Install qtdeclarative5-ubuntu-push-notifications-plugin
+* Install ubuntu-push-client
+* Run ubuntu-push-client in trivial helper mode:
+
+	UBUNTU_PUSH_USE_TRIVIAL_HELPER=1 ./ubuntu-push-client
+
+* Build click package
+* Install in your desktop:
+
+	sudo click install --all-users com.ubuntu.developer.push.ubuntu-push-example_0.1_all.click
+
+* Run example app from the SDK using the "Desktop" kit

=== added directory 'docs/example-client/components'
=== added file 'docs/example-client/components/ChatClient.qml'
--- docs/example-client/components/ChatClient.qml	1970-01-01 00:00:00 +0000
+++ docs/example-client/components/ChatClient.qml	2014-09-05 14:53:45 +0000
@@ -0,0 +1,99 @@
+import QtQuick 2.0
+import Ubuntu.Components 0.1
+
+Item {
+    property string nick
+    property string token
+    property bool registered: false
+    signal error (string msg)
+    onNickChanged: {
+        if (nick) {
+            register()
+        } else {
+            registered = false
+        }
+    }
+    onTokenChanged: {register()}
+    function register() {
+        console.log("registering ", nick, token);
+        if (nick && token) {
+            var req = new XMLHttpRequest();
+            req.open("post", "http://direct.ralsina.me:8001/register", true);
+            req.setRequestHeader("Content-type", "application/json");
+            req.onreadystatechange = function() {//Call a function when the state changes.
+                if(req.readyState == 4) {
+                    if (req.status == 200) {
+                        registered = true;
+                    } else {
+                        error(JSON.parse(req.responseText)["error"]);
+                    }
+                }
+            }
+            req.send(JSON.stringify({
+                "nick" : nick.toLowerCase(),
+                "token": token
+            }))
+        }
+    }
+
+    /* options is of the form:
+      {
+          enabled: false,
+          persist: false,
+          popup: false,
+          sound: "buzz.mp3",
+          vibrate: false,
+          counter: 5
+      }
+    */
+    function sendMessage(message, options) {
+        var to_nick = message["to"]
+        var data = {
+            "from_nick": nick.toLowerCase(),
+            "from_token": token,
+            "nick": to_nick.toLowerCase(),
+            "data": {
+                "message": message,
+                "notification": {}
+            }
+        }
+        if (options["enabled"]) {
+            data["data"]["notification"] = {
+                "card": {
+                    "summary": nick + " says: " + message["message"],
+                    "body": "",
+                    "popup": options["popup"],
+                    "persist": options["persist"],
+                    "actions": ["appid://com.ubuntu.developer.ralsina.hello/hello/current-user-version"]
+                }
+            }
+            if (options["sound"]) {
+                data["data"]["notification"]["sound"] = options["sound"]
+            }
+            if (options["vibrate"]) {
+                data["data"]["notification"]["vibrate"] = {
+                    "duration": 200
+                }
+            }
+            if (options["counter"]) {
+                data["data"]["notification"]["emblem-counter"] = {
+                    "count": Math.floor(options["counter"]),
+                    "visible": true
+                }
+            }
+        }
+        var req = new XMLHttpRequest();
+        req.open("post", "http://direct.ralsina.me:8001/message", true);
+        req.setRequestHeader("Content-type", "application/json");
+        req.onreadystatechange = function() {//Call a function when the state changes.
+            if(req.readyState == 4) {
+                if (req.status == 200) {
+                    registered = true;
+                } else {
+                    error(JSON.parse(req.responseText)["error"]);
+                }
+            }
+        }
+        req.send(JSON.stringify(data))
+    }
+}

=== added file 'docs/example-client/hello.desktop'
--- docs/example-client/hello.desktop	1970-01-01 00:00:00 +0000
+++ docs/example-client/hello.desktop	2014-09-05 14:53:45 +0000
@@ -0,0 +1,8 @@
+[Desktop Entry]
+Name=hello
+Exec=qmlscene $@ main.qml
+Icon=push-example.png
+Terminal=false
+Type=Application
+X-Ubuntu-Touch=true
+

=== added file 'docs/example-client/hello.json'
--- docs/example-client/hello.json	1970-01-01 00:00:00 +0000
+++ docs/example-client/hello.json	2014-09-05 14:53:45 +0000
@@ -0,0 +1,7 @@
+{
+    "policy_groups": [
+        "networking",
+        "push-notification-client"
+    ],
+    "policy_version": 1.2
+}
\ No newline at end of file

=== added file 'docs/example-client/helloHelper'
--- docs/example-client/helloHelper	1970-01-01 00:00:00 +0000
+++ docs/example-client/helloHelper	2014-09-05 14:53:45 +0000
@@ -0,0 +1,7 @@
+#!/usr/bin/python3
+
+import sys
+
+f1, f2 = sys.argv[1:3]
+
+open(f2, "w").write(open(f1).read())

=== added file 'docs/example-client/helloHelper-apparmor.json'
--- docs/example-client/helloHelper-apparmor.json	1970-01-01 00:00:00 +0000
+++ docs/example-client/helloHelper-apparmor.json	2014-09-05 14:53:45 +0000
@@ -0,0 +1,6 @@
+{
+    "policy_groups": [
+        "push-notification-client"
+    ],
+    "policy_version": 1.2
+}

=== added file 'docs/example-client/helloHelper.json'
--- docs/example-client/helloHelper.json	1970-01-01 00:00:00 +0000
+++ docs/example-client/helloHelper.json	2014-09-05 14:53:45 +0000
@@ -0,0 +1,3 @@
+{
+    "exec": "helloHelper"
+}

=== added file 'docs/example-client/main.qml'
--- docs/example-client/main.qml	1970-01-01 00:00:00 +0000
+++ docs/example-client/main.qml	2014-09-05 14:53:45 +0000
@@ -0,0 +1,266 @@
+import QtQuick 2.0
+import Qt.labs.settings 1.0
+import Ubuntu.Components 0.1
+import Ubuntu.Components.ListItems 0.1 as ListItem
+import Ubuntu.PushNotifications 0.1
+import "components"
+
+MainView {
+    id: "mainView"
+    // objectName for functional testing purposes (autopilot-qt5)
+    objectName: "mainView"
+
+    // Note! applicationName needs to match the "name" field of the click manifest
+    applicationName: "com.ubuntu.developer.ralsina.hello"
+
+    automaticOrientation: true
+    useDeprecatedToolbar: false
+
+    width: units.gu(100)
+    height: units.gu(75)
+
+    Settings {
+        property alias nick: chatClient.nick
+        property alias nickText: nickEdit.text
+        property alias nickPlaceholder: nickEdit.placeholderText
+        property alias nickEnabled: nickEdit.enabled
+    }
+
+    ChatClient {
+        id: chatClient
+        onRegisteredChanged: {nickEdit.registered()}
+        onError: {messageList.handle_error(msg)}
+        token: pushClient.token
+    }
+
+    PushClient {
+        id: pushClient
+        Component.onCompleted: {
+            notificationsChanged.connect(messageList.handle_notifications)
+            error.connect(messageList.handle_error)
+        }
+        appId: "com.ubuntu.developer.ralsina.hello_hello"
+    }
+
+    TextField {
+        id: nickEdit
+        focus: true
+        placeholderText: "Your nickname"
+        anchors.left: parent.left
+        anchors.right: loginButton.left
+        anchors.top: parent.top
+        anchors.leftMargin: units.gu(.5)
+        anchors.rightMargin: units.gu(1)
+        anchors.topMargin: units.gu(.5)
+        function registered() {
+            readOnly = true
+            text = "Your nick is " + chatClient.nick
+            messageEdit.focus = true
+            messageEdit.enabled = true
+            loginButton.text = "Logout"
+        }
+        onAccepted: { loginButton.clicked() }
+    }
+
+    Button {
+        id: loginButton
+        text: chatClient.rgistered? "Logout": "Login"
+        anchors.top: nickEdit.top
+        anchors.right: parent.right
+        anchors.rightMargin: units.gu(.5)
+        onClicked: {
+            if (chatClient.nick) { // logout
+                chatClient.nick = ""
+                text = "Login"
+                nickEdit.enabled = true
+                nickEdit.readOnly = false
+                nickEdit.text = ""
+                nickEdit.focus = true
+                messageEdit.enabled = false
+            } else { // login
+                chatClient.nick = nickEdit.text
+            }
+        }
+    }
+
+    TextField {
+        id: messageEdit
+        anchors.right: parent.right
+        anchors.left: parent.left
+        anchors.top: nickEdit.bottom
+        anchors.topMargin: units.gu(1)
+        anchors.rightMargin: units.gu(.5)
+        anchors.leftMargin: units.gu(.5)
+        placeholderText: "Your message"
+        enabled: false
+        onAccepted: {
+            console.log("sending " + text)
+            var idx = text.indexOf(":")
+            var nick_to = text.substring(0, idx).trim()
+            var msg = text.substring(idx+1, 9999).trim()
+            var i = {
+                "from" :  chatClient.nick,
+                "to" :  nick_to,
+                "message" : msg
+            }
+            var o = {
+                enabled: annoyingSwitch.checked,
+                persist: persistSwitch.checked,
+                popup: popupSwitch.checked,
+                sound: soundSwitch.checked,
+                vibrate: vibrateSwitch.checked,
+                counter: counterSlider.value
+            }
+            chatClient.sendMessage(i, o)
+            i["type"] = "sent"
+            messagesModel.insert(0, i)
+            text = ""
+        }
+    }
+    ListModel {
+        id: messagesModel
+        ListElement {
+            from: ""
+            to: ""
+            type: "info"
+            message: "Register by typing your nick and clicking Login."
+        }
+        ListElement {
+            from: ""
+            to: ""
+            type: "info"
+            message: "Send messages in the form \"destination: hello\""
+        }
+        ListElement {
+            from: ""
+            to: ""
+            type: "info"
+            message: "Slide from the bottom to control notification behaviour."
+        }
+    }
+
+    UbuntuShape {
+        anchors.left: parent.left
+        anchors.right: parent.right
+        anchors.bottom: notificationSettings.bottom
+        anchors.top: messageEdit.bottom
+        anchors.topMargin: units.gu(1)
+        ListView {
+            id: messageList
+            model: messagesModel
+            anchors.fill: parent
+            delegate: Rectangle {
+                MouseArea {
+                    anchors.fill: parent
+                    onClicked: {
+                        if (from != "") {
+                            messageEdit.text = from + ": "
+                            messageEdit.focus = true
+                        }
+                    }
+                }
+                height: label.height + units.gu(2)
+                width: parent.width
+                Rectangle {
+                    color: {
+                        "info": "#B5EBB9",
+                        "received" : "#A2CFA5",
+                        "sent" : "#FFF9C8",
+                        "error" : "#FF4867"}[type]
+                    height: label.height + units.gu(1)
+                    anchors.fill: parent
+                    radius: 5
+                    anchors.margins: units.gu(.5)
+                    Text {
+                        id: label
+                        text: "<b>" + ((type=="sent")?to:from) + ":</b> " + message
+                        wrapMode: Text.Wrap
+                        width: parent.width - units.gu(1)
+                        x: units.gu(.5)
+                        y: units.gu(.5)
+                        horizontalAlignment: (type=="sent")?Text.AlignRight:Text.AlignLeft
+                    }
+                }
+            }
+
+            function handle_error(error) {
+                messagesModel.insert(0, {
+                     "from" :  "",
+                     "to" :  "",
+                     "type" :  "error",
+                     "message" : "<b>ERROR: " + error + "</b>"
+                })
+            }
+
+            function handle_notifications(list) {
+                list.forEach(function(notification) {
+                    var item = JSON.parse(notification)
+                    item["type"] = "received"
+                    messagesModel.insert(0, item)
+                })
+            }
+        }
+    }
+    Panel {
+        id: notificationSettings
+        anchors {
+            left: parent.left
+            right: parent.right
+            bottom: parent.bottom
+        }
+        height: item1.height * 7
+        UbuntuShape {
+            anchors.fill: parent
+            color: Theme.palette.normal.overlay
+            Column {
+                id: settingsColumn
+                anchors.fill: parent
+                ListItem.Header {
+                    text: "<b>Notification Settings</b>"
+                }
+                ListItem.Standard {
+                    id: item1
+                    text: "Enable Notifications"
+                    control: Switch {
+                        id: annoyingSwitch
+                    }
+                }
+                ListItem.Standard {
+                    text: "Enable Popup"
+                    enabled: annoyingSwitch.checked
+                    control: Switch {
+                        id: popupSwitch
+                    }
+                }
+                ListItem.Standard {
+                    text: "Persistent"
+                    enabled: annoyingSwitch.checked
+                    control: Switch {
+                        id: persistSwitch
+                    }
+                }
+                ListItem.Standard {
+                    text: "Make Sound"
+                    enabled: annoyingSwitch.checked
+                    control: Switch {
+                        id: soundSwitch
+                    }
+                }
+                ListItem.Standard {
+                    text: "Vibrate"
+                    enabled: annoyingSwitch.checked
+                    control: Switch {
+                        id: vibrateSwitch
+                    }
+                }
+                ListItem.Standard {
+                    text: "Counter Value"
+                    enabled: annoyingSwitch.checked
+                    control: Slider {
+                        id: counterSlider
+                    }
+                }
+            }
+        }
+    }
+}

=== added file 'docs/example-client/manifest.json'
--- docs/example-client/manifest.json	1970-01-01 00:00:00 +0000
+++ docs/example-client/manifest.json	2014-09-05 14:53:45 +0000
@@ -0,0 +1,19 @@
+{
+    "architecture": "all",
+    "description": "Example app for Ubuntu push notifications.",
+    "framework": "ubuntu-sdk-14.10-dev2",
+    "hooks": {
+        "hello": {
+            "apparmor": "hello.json",
+            "desktop": "hello.desktop"
+        },
+        "helloHelper": {
+            "apparmor": "helloHelper-apparmor.json",
+            "push-helper": "helloHelper.json"
+        }
+    },
+    "maintainer": "Roberto Alsina <[e-mail]>",
+    "name": "com.ubuntu.developer.ralsina.hello",
+    "title": "ubuntu-push-example",
+    "version": "0.4"
+}

=== added file 'docs/example-client/push-example.png'
Binary files docs/example-client/push-example.png	1970-01-01 00:00:00 +0000 and docs/example-client/push-example.png	2014-09-05 14:53:45 +0000 differ
=== added file 'docs/example-client/push-example.qmlproject'
--- docs/example-client/push-example.qmlproject	1970-01-01 00:00:00 +0000
+++ docs/example-client/push-example.qmlproject	2014-09-05 14:53:45 +0000
@@ -0,0 +1,52 @@
+import QmlProject 1.1
+
+Project {
+    mainFile: "main.qml"
+
+    /* Include .qml, .js, and image files from current directory and subdirectories */
+    QmlFiles {
+        directory: "."
+    }
+    JavaScriptFiles {
+        directory: "."
+    }
+    ImageFiles {
+        directory: "."
+    }
+    Files {
+        filter: "*.desktop"
+    }
+    Files {
+        filter: "www/*.html"
+    }
+    Files {
+        filter: "Makefile"
+    }
+    Files {
+        directory: "www"
+        filter: "*"
+    }
+    Files {
+        directory: "www/img/"
+        filter: "*"
+    }
+    Files {
+        directory: "www/css/"
+        filter: "*"
+    }
+    Files {
+        directory: "www/js/"
+        filter: "*"
+    }
+    Files {
+        directory: "tests/"
+        filter: "*"
+    }
+    Files {
+        directory: "debian"
+        filter: "*"
+    }
+    /* List of plugin directories passed to QML runtime */
+    importPaths: [ "." ,"/usr/bin","/usr/lib/x86_64-linux-gnu/qt5/qml" ]
+}
+

=== added directory 'docs/example-client/tests'
=== added directory 'docs/example-client/tests/autopilot'
=== added directory 'docs/example-client/tests/autopilot/push-example'
=== added file 'docs/example-client/tests/autopilot/push-example/__init__.py'
--- docs/example-client/tests/autopilot/push-example/__init__.py	1970-01-01 00:00:00 +0000
+++ docs/example-client/tests/autopilot/push-example/__init__.py	2014-09-05 14:53:45 +0000
@@ -0,0 +1,72 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+
+"""Ubuntu Touch App autopilot tests."""
+
+import os
+import subprocess
+
+from autopilot import input, platform
+from autopilot.matchers import Eventually
+from testtools.matchers import Equals
+from ubuntuuitoolkit import base, emulators
+
+
+def _get_module_include_path():
+    return os.path.join(get_path_to_source_root(), 'modules')
+
+
+def get_path_to_source_root():
+    return os.path.abspath(
+        os.path.join(
+            os.path.dirname(__file__), '..', '..', '..', '..'))
+
+
+class ClickAppTestCase(base.UbuntuUIToolkitAppTestCase):
+    """Common test case that provides several useful methods for the tests."""
+
+    package_id = ''  # TODO
+    app_name = 'push-example'
+
+    def setUp(self):
+        super(ClickAppTestCase, self).setUp()
+        self.pointing_device = input.Pointer(self.input_device_class.create())
+        self.launch_application()
+
+        self.assertThat(self.main_view.visible, Eventually(Equals(True)))
+
+    def launch_application(self):
+        if platform.model() == 'Desktop':
+            self._launch_application_from_desktop()
+        else:
+            self._launch_application_from_phablet()
+
+    def _launch_application_from_desktop(self):
+        app_qml_source_location = self._get_app_qml_source_path()
+        if os.path.exists(app_qml_source_location):
+            self.app = self.launch_test_application(
+                base.get_qmlscene_launch_command(),
+                '-I' + _get_module_include_path(),
+                app_qml_source_location,
+                app_type='qt',
+                emulator_base=emulators.UbuntuUIToolkitEmulatorBase)
+        else:
+            raise NotImplementedError(
+                "On desktop we can't install click packages yet, so we can "
+                "only run from source.")
+
+    def _get_app_qml_source_path(self):
+        qml_file_name = '{0}.qml'.format(self.app_name)
+        return os.path.join(self._get_path_to_app_source(), qml_file_name)
+
+    def _get_path_to_app_source(self):
+        return os.path.join(get_path_to_source_root(), self.app_name)
+
+    def _launch_application_from_phablet(self):
+        # On phablet, we only run the tests against the installed click
+        # package.
+        self.app = self.launch_click_package(self.pacakge_id, self.app_name)
+
+    @property
+    def main_view(self):
+        return self.app.select_single(emulators.MainView)
+

=== added file 'docs/example-client/tests/autopilot/push-example/test_main.py'
--- docs/example-client/tests/autopilot/push-example/test_main.py	1970-01-01 00:00:00 +0000
+++ docs/example-client/tests/autopilot/push-example/test_main.py	2014-09-05 14:53:45 +0000
@@ -0,0 +1,25 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+
+"""Tests for the Hello World"""
+
+import os
+
+from autopilot.matchers import Eventually
+from testtools.matchers import Equals
+
+import push-example
+
+
+class MainViewTestCase(push-example.ClickAppTestCase):
+    """Generic tests for the Hello World"""
+
+    def test_initial_label(self):
+        label = self.main_view.select_single(objectName='label')
+        self.assertThat(label.text, Equals('Hello..'))
+
+    def test_click_button_should_update_label(self):
+        button = self.main_view.select_single(objectName='button')
+        self.pointing_device.click_object(button)
+        label = self.main_view.select_single(objectName='label')
+        self.assertThat(label.text, Eventually(Equals('..world!')))
+

=== added file 'docs/example-client/tests/autopilot/run'
--- docs/example-client/tests/autopilot/run	1970-01-01 00:00:00 +0000
+++ docs/example-client/tests/autopilot/run	2014-09-05 14:53:45 +0000
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+if [[ -z `which autopilot` ]]; then
+  echo "Autopilot is not installed. Skip"
+  exit
+fi
+
+SCRIPTPATH=`dirname $0`
+pushd ${SCRIPTPATH}
+autopilot run push-example
+popd
+

=== added directory 'docs/example-client/tests/unit'
=== added file 'docs/example-client/tests/unit/tst_hellocomponent.qml'
--- docs/example-client/tests/unit/tst_hellocomponent.qml	1970-01-01 00:00:00 +0000
+++ docs/example-client/tests/unit/tst_hellocomponent.qml	2014-09-05 14:53:45 +0000
@@ -0,0 +1,50 @@
+import QtQuick 2.0
+import QtTest 1.0
+import Ubuntu.Components 0.1
+import "../../components"
+
+// See more details @ http://qt-project.org/doc/qt-5.0/qtquick/qml-testcase.html
+
+// Execute tests with:
+//   qmltestrunner
+
+Item {
+    // The objects
+    HelloComponent {
+        id: objectUnderTest
+    }
+
+    TestCase {
+        name: "HelloComponent"
+
+        function init() {
+            console.debug(">> init");
+            compare("",objectUnderTest.text,"text was not empty on init");
+            console.debug("<< init");
+        }
+
+        function cleanup() {
+            console.debug(">> cleanup");
+            console.debug("<< cleanup");
+        }
+
+        function initTestCase() {
+            console.debug(">> initTestCase");
+            console.debug("<< initTestCase");
+        }
+
+        function cleanupTestCase() {
+            console.debug(">> cleanupTestCase");
+            console.debug("<< cleanupTestCase");
+        }
+
+        function test_canReadAndWriteText() {
+            var expected = "Hello World";
+
+            objectUnderTest.text = expected;
+
+            compare(expected,objectUnderTest.text,"expected did not equal result");
+        }
+    }
+}
+

=== modified file 'docs/highlevel.txt'
--- docs/highlevel.txt	2014-08-08 09:09:39 +0000
+++ docs/highlevel.txt	2014-09-05 14:53:45 +0000
@@ -1,8 +1,10 @@
-Ubuntu Push Client Developer Guide
-==================================
+Ubuntu Push Client High Level Developer Guide
+============================================
 
 :Version: 0.50+
 
+.. contents::
+
 Introduction
 ------------
 
@@ -11,52 +13,7 @@
 
 ---------
 
-Let's describe the push system by way of an example.
-
-Alice has written a chat application called Chatter. Using it, Bob can send messages to Carol and viceversa. Alice has a
-web application for it, so the way it works now is that Bob connects to the service, posts a message, and when Carol
-connects, she gets it. If Carol leaves the browser window open, it beeps when messages arrive.
-
-Now Alice wants to create an Ubuntu Touch app for Chatter, so she implements the same architecture using a client that
-does the same thing as the web browser. Sadly, since applications on Ubuntu Touch don't run continuously, messages are
-only delivered when Carol opens the app, and the user experience suffers.
-
-Using the Ubuntu Push Server, this problem is alleviated: the Chatter server will deliver the messages to the Ubuntu
-Push Server, which in turn will send it in an efficient manner to the Ubuntu Push Client running in Bob and Carol's
-devices. The user sees a notification (all without starting the app) and then can launch it if he's interested in
-reading messages at that point.
-
-Since the app is not started and messages are delivered oportunistically, this is both battery and bandwidth-efficient.
-
-.. figure:: push.svg
-
-The Ubuntu Push system provides:
-
-* A push server which receives **push messages** from the app servers, queues them and delivers them efficiently
-  to the devices.
-* A push client which receives those messages, queues messages to the app and displays notifications to the user
-
-The full lifecycle of a push message is:
-
-* Created in a application-specific server
-* Sent to the Ubuntu Push server, targeted at a user or user+device pair
-* Delivered to one or more Ubuntu devices
-* Passed through the application helper for processing
-* Notification displayed to the user (via different mechanisms)
-* Application Message queued for the app's use
-
-If the user interacts with the notification, the application is launched and should check its queue for messages
-it has to process.
-
-For the app developer, there are several components needed:
-
-* A server that sends the **push messages** to the Ubuntu Push server
-* Support in the client app for registering with the Ubuntu Push client
-* Support in the client app to react to **notifications** displayed to the user and process **application messages**
-* A helper program with application-specific knowledge that transforms **push messages** as needed.
-
-In the following sections, we'll see how to implement all the client side parts. For the application server, see the
-`Ubuntu Push Server API section <#ubuntu-push-server-api>`__
+.. include:: _description.txt
 
 The PushClient Component
 ------------------------
@@ -68,7 +25,7 @@
     PushClient {
         id: pushClient
         Component.onCompleted: {
-            newNotifications.connect(messageList.handle_notifications)
+            notificationsChanged.connect(messageList.handle_notifications)
             error.connect(messageList.handle_error)
         }
         appId: "com.ubuntu.developer.push.hello_hello"
@@ -95,13 +52,13 @@
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 When a notification is received by the Push Client, it will be delivered to your application's push helper, and then
-placed in your application's mailbox. At that point, the PushClient will emit the ``newNotifications(QStringList)`` signal
+placed in your application's mailbox. At that point, the PushClient will emit the ``notificationsChanged(QStringList)`` signal
 containing your messages. You should probably connect to that signal and handle those messages.
 
 Because of the application's lifecycle, there is no guarantee that it will be running when the signal is emitted. For that
 reason, apps should check for pending notifications whenever they are activated or started. To do that, use the
 ``getNotifications()`` slot. Triggering that slot will fetch notifications and trigger the
-``newNotifications(QStringList)`` signal.
+``notificationsChanged(QStringList)`` signal.
 
 Error Handling
 ~~~~~~~~~~~~~~
@@ -111,8 +68,8 @@
 Persistent Notification Management
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Some notifications are persistent, meaning they don't disappear automatically. For those notifications, there is an API that
-allows the app to manage them without having to know the underlying details of the platform.
+Some notifications are persistent, meaning that, after they are presented, they don't disappear automatically.
+This API allows the app to manage that type of notifications.
 
 On each notification there's an optional ``tag`` field, used for this purpose.
 
@@ -125,201 +82,4 @@
 
 The ``count`` property sets the counter in the application's icon to the given value.
 
-
-Application Helpers
--------------------
-
-The payload delivered to push-client will be passed onto a helper program that can modify it as needed before passing it onto
-the postal service (see `Helper Output Format <#helper-output-format>`__).
-
-The helper receives two arguments ``infile`` and ``outfile``. The message is delivered via ``infile`` and the transformed
-version is placed in ``outfile``.
-
-This is the simplest possible useful helper, which simply passes the message through unchanged::
-
-	#!/usr/bin/python3
-
-	import sys
-	f1, f2 = sys.argv[1:3]
-	open(f2, "w").write(open(f1).read())
-
-Helpers need to be added to the click package manifest::
-
-	{
-		"name": "com.ubuntu.developer.ralsina.hello",
-		"description": "description of hello",
-		"framework": "ubuntu-sdk-14.10-qml-dev2",
-		"architecture": "all",
-		"title": "hello",
-		"hooks": {
-			"hello": {
-				"apparmor": "hello.json",
-				"desktop": "hello.desktop"
-			},
-			"helloHelper": {
-				"apparmor": "helloHelper-apparmor.json",
-				"push-helper": "helloHelper.json"
-			}
-		},
-		"version": "0.2",
-		"maintainer": "Roberto Alsina <[e-mail]>"
-	}
-
-Here, we created a helloHelper entry in hooks that has an apparmor profile and an additional JSON file for the push-helper hook.
-
-helloHelper-apparmor.json must contain **only** the push-notification-client policy group::
-
-	{
-		"policy_groups": [
-			"push-notification-client"
-		],
-		"policy_version": 1.2
-	}
-
-And helloHelper.json must have at least a exec key with the path to the helper executable relative to the json, and optionally
-an app_id key containing the short id of one of the apps in the package (in the format packagename_appname without a version).
-If the app_id is not specified, the helper will be used for all apps in the package::
-
-	{
-		"exec": "helloHelper",
-		"app_id": "com.ubuntu.developer.ralsina.hello_hello"
-	}
-
-.. note:: For deb packages, helpers should be installed into /usr/lib/ubuntu-push-client/legacy-helpers/ as part of the package.
-
-Helper Output Format
---------------------
-
-Helpers output has two parts, the postal message (in the "message" key) and a notification to be presented to the user (in the "notification" key).
-
-Here's a simple example::
-
-	{
-		"message": "foobar",
-		"notification": {
-			"tag": "foo",
-			"card": {
-				"summary": "yes",
-				"body": "hello",
-				"popup": true,
-				"persist": true,
-				"timestamp": 1407160197
-			}
-			"sound": "buzz.mp3",
-			"vibrate": {
-				"pattern": [200, 100],
-				"repeat": 2
-			}
-			"emblem-counter": {
-				"count": 12,
-				"visible": true
-			}
-		}
-	}
-
-The notification can contain a **tag** field, which can later be used by the `persistent notification management API. <#persistent-notification-management>`__
-
-:message: (optional) A JSON object that is passed as-is to the application via PopAll.
-:notification: (optional) Describes the user-facing notifications triggered by this push message.
-
-The notification can contain a **card**. A card describes a specific notification to be given to the user,
-and has the following fields:
-
-:summary: (required) a title. The card will not be presented if this is missing.
-:body: longer text, defaults to empty.
-:actions: If empty (the default), a bubble notification is non-clickable.
-          If you add a URL, then bubble notifications are clickable and launch that URL. One use for this is using a URL like
-          ``appid://com.ubuntu.developer.ralsina.hello/hello/current-user-version`` which will switch to the app or launch
-          it if it's not running. See `URLDispatcher <https://wiki.ubuntu.com/URLDispatcher>`__ for more information.
-
-:icon: An icon relating to the event being notified. Defaults to empty (no icon);
-       a secondary icon relating to the application will be shown as well, regardless of this field.
-:timestamp: Seconds since the unix epoch, only used for persist (for now). If zero or unset, defaults to current timestamp.
-:persist: Whether to show in notification centre; defaults to false
-:popup: Whether to show in a bubble. Users can disable this, and can easily miss them, so don't rely on it exclusively. Defaults to false.
-
-.. note:: Keep in mind that the precise way in which each field is presented to the user depends on factors such as
-          whether it's shown as a bubble or in the notification centre, or even the version of Ubuntu Touch the user
-          has on their device.
-
-The notification can contain a **sound** field. This is either a boolean (play a predetermined sound) or the path to a sound file. The user can disable it, so don't rely on it exclusively.
-Defaults to empty (no sound). The path is relative, and will be looked up in (a) the application's .local/share/<pkgname>, and (b)
-standard xdg dirs.
-
-The notification can contain a **vibrate** field, causing haptic feedback, which can be either a boolean (if true, vibrate a predetermined way) or an object that has the following content:
-
-:pattern: a list of integers describing a vibration pattern (duration of alternating vibration/no vibration times, in milliseconds).
-:repeat: number of times the pattern has to be repeated (defaults to 1, 0 is the same as 1).
-
-The notification can contain a **emblem-counter** field, with the following content:
-
-:count: a number to be displayed over the application's icon in the launcher.
-:visible: set to true to show the counter, or false to hide it.
-
-.. note:: Unlike other notifications, emblem-counter needs to be cleaned by the app itself.
-          Please see `the persistent notification management section. <#persistent-notification-management>`__
-
-.. FIXME crosslink to hello example app on each method
-
-Security
-~~~~~~~~
-
-To use the push API, applications need to request permission in their security profile, using something like this::
-
-	{
-		"policy_groups": [
-			"networking",
-			"push-notification-client"
-		],
-		"policy_version": 1.2
-	}
-
-
-Ubuntu Push Server API
-----------------------
-
-The Ubuntu Push server is located at https://push.ubuntu.com and has a single endpoint: ``/notify``.
-To notify a user, your application has to do a POST with ``Content-type: application/json``.
-
-Here is an example of the POST body using all the fields::
-
-	{
-		"appid": "com.ubuntu.music_music",
-		"expire_on": "2014-10-08T14:48:00.000Z",
-		"token": "LeA4tRQG9hhEkuhngdouoA==",
-		"clear_pending": true,
-		"replace_tag": "tagname",
-		"data": {
-			"message": "foobar",
-			"notification": {
-				"card": {
-					"summary": "yes",
-					"body": "hello",
-					"popup": true,
-					"persist": true,
-					"timestamp": 1407160197
-				}
-				"sound": "buzz.mp3",
-				"tag": "foo",
-				"vibrate": {
-					"pattern": [200, 100],
-					"repeat": 2
-				}
-				"emblem-counter": {
-					"count": 12,
-					"visible": true
-				}
-			}
-		}
-	}
-
-
-:appid: ID of the application that will receive the notification, as described in the client side documentation.
-:expire_on: Expiration date/time for this message, in `ISO8601 Extendend format <http://en.wikipedia.org/wiki/ISO_8601>`__
-:token: The token identifying the user+device to which the message is directed, as described in the client side documentation.
-:clear_pending: Discards all previous pending notifications. Usually in response to getting a "too-many-pending" error.
-:replace_tag: If there's a pending notification with the same tag, delete it before queuing this new one.
-:data: A JSON object.
-
-In this example, data is `what a helper would output <#helper-output-format>`__ but that's not necessarily the case.
-The content of the data field will be passed to the helper application which **has** to produce output in that format.
+.. include:: _common.txt
\ No newline at end of file

=== modified file 'docs/lowlevel.txt'
--- docs/lowlevel.txt	2014-08-08 09:09:39 +0000
+++ docs/lowlevel.txt	2014-09-05 14:53:45 +0000
@@ -1,8 +1,10 @@
-Ubuntu Push Client Developer Guide
-==================================
+Ubuntu Push Client Low Level Developer Guide
+============================================
 
 :Version: 0.50+
 
+.. contents::
+
 Introduction
 ------------
 
@@ -14,52 +16,8 @@
 
 ---------
 
-Let's describe the push system by way of an example.
-
-Alice has written a chat application called Chatter. Using it, Bob can send messages to Carol and viceversa. Alice has a
-web application for it, so the way it works now is that Bob connects to the service, posts a message, and when Carol
-connects, she gets it. If Carol leaves the browser window open, it beeps when messages arrive.
-
-Now Alice wants to create an Ubuntu Touch app for Chatter, so she implements the same architecture using a client that
-does the same thing as the web browser. Sadly, since applications on Ubuntu Touch don't run continuously, messages are
-only delivered when Carol opens the app, and the user experience suffers.
-
-Using the Ubuntu Push Server, this problem is alleviated: the Chatter server will deliver the messages to the Ubuntu
-Push Server, which in turn will send it in an efficient manner to the Ubuntu Push Client running in Bob and Carol's
-devices. The user sees a notification (all without starting the app) and then can launch it if he's interested in
-reading messages at that point.
-
-Since the app is not started and messages are delivered oportunistically, this is both battery and bandwidth-efficient.
-
-.. figure:: push.svg
-
-The Ubuntu Push system provides:
-
-* A push server which receives **push messages** from the app servers, queues them and delivers them efficiently
-  to the devices.
-* A push client which receives those messages, queues messages to the app and displays notifications to the user
-
-The full lifecycle of a push message is:
-
-* Created in a application-specific server
-* Sent to the Ubuntu Push server, targeted at a user or user+device pair
-* Delivered to one or more Ubuntu devices
-* Passed through the application helper for processing
-* Notification displayed to the user (via different mechanisms)
-* Application Message queued for the app's use
-
-If the user interacts with the notification, the application is launched and should check its queue for messages
-it has to process.
-
-For the app developer, there are several components needed:
-
-* A server that sends the **push messages** to the Ubuntu Push server
-* Support in the client app for registering with the Ubuntu Push client
-* Support in the client app to react to **notifications** displayed to the user and process **application messages**
-* A helper program with application-specific knowledge that transforms **push messages** as needed.
-
-In the following sections, we'll see how to implement all the client side parts. For the application server, see the
-`Ubuntu Push Server API section <#ubuntu-push-server-api>`__
+.. include:: _description.txt
+
 
 The PushNotifications Service
 -----------------------------
@@ -202,8 +160,8 @@
 Persistent Notification Management
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Some notifications are persistent, meaning they don't disappear automatically. For those notifications, there is an API that
-allows the app to manage them without having to know the underlying details of the platform.
+Some notifications are persistent, meaning that, after they are presented, they don't disappear automatically.
+This API allows the app to manage that type of notifications.
 
 On each notification there's an optional ``tag`` field, used for this purpose.
 
@@ -220,200 +178,4 @@
 Set the counter to the given values.
 
 
-Application Helpers
--------------------
-
-The payload delivered to push-client will be passed onto a helper program that can modify it as needed before passing it onto
-the postal service (see `Helper Output Format <#helper-output-format>`__).
-
-The helper receives two arguments ``infile`` and ``outfile``. The message is delivered via ``infile`` and the transformed
-version is placed in ``outfile``.
-
-This is the simplest possible useful helper, which simply passes the message through unchanged::
-
-	#!/usr/bin/python3
-
-	import sys
-	f1, f2 = sys.argv[1:3]
-	open(f2, "w").write(open(f1).read())
-
-Helpers need to be added to the click package manifest::
-
-	{
-		"name": "com.ubuntu.developer.ralsina.hello",
-		"description": "description of hello",
-		"framework": "ubuntu-sdk-14.10-qml-dev2",
-		"architecture": "all",
-		"title": "hello",
-		"hooks": {
-			"hello": {
-				"apparmor": "hello.json",
-				"desktop": "hello.desktop"
-			},
-			"helloHelper": {
-				"apparmor": "helloHelper-apparmor.json",
-				"push-helper": "helloHelper.json"
-			}
-		},
-		"version": "0.2",
-		"maintainer": "Roberto Alsina <[e-mail]>"
-	}
-
-Here, we created a helloHelper entry in hooks that has an apparmor profile and an additional JSON file for the push-helper hook.
-
-helloHelper-apparmor.json must contain **only** the push-notification-client policy group::
-
-	{
-		"policy_groups": [
-			"push-notification-client"
-		],
-		"policy_version": 1.2
-	}
-
-And helloHelper.json must have at least a exec key with the path to the helper executable relative to the json, and optionally
-an app_id key containing the short id of one of the apps in the package (in the format packagename_appname without a version).
-If the app_id is not specified, the helper will be used for all apps in the package::
-
-	{
-		"exec": "helloHelper",
-		"app_id": "com.ubuntu.developer.ralsina.hello_hello"
-	}
-
-.. note:: For deb packages, helpers should be installed into /usr/lib/ubuntu-push-client/legacy-helpers/ as part of the package.
-
-Helper Output Format
---------------------
-
-Helpers output has two parts, the postal message (in the "message" key) and a notification to be presented to the user (in the "notification" key).
-
-Here's a simple example::
-
-	{
-		"message": "foobar",
-		"notification": {
-			"tag": "foo",
-			"card": {
-				"summary": "yes",
-				"body": "hello",
-				"popup": true,
-				"persist": true,
-				"timestamp": 1407160197
-			}
-			"sound": "buzz.mp3",
-			"vibrate": {
-				"pattern": [200, 100],
-				"repeat": 2
-			}
-			"emblem-counter": {
-				"count": 12,
-				"visible": true
-			}
-		}
-	}
-
-The notification can contain a **tag** field, which can later be used by the `persistent notification management API. <#persistent-notification-management>`__
-
-:message: (optional) A JSON object that is passed as-is to the application via PopAll.
-:notification: (optional) Describes the user-facing notifications triggered by this push message.
-
-The notification can contain a **card**. A card describes a specific notification to be given to the user,
-and has the following fields:
-
-:summary: (required) a title. The card will not be presented if this is missing.
-:body: longer text, defaults to empty.
-:actions: If empty (the default), a bubble notification is non-clickable.
-          If you add a URL, then bubble notifications are clickable and launch that URL. One use for this is using a URL like
-          ``appid://com.ubuntu.developer.ralsina.hello/hello/current-user-version`` which will switch to the app or launch
-          it if it's not running. See `URLDispatcher <https://wiki.ubuntu.com/URLDispatcher>`__ for more information.
-
-:icon: An icon relating to the event being notified. Defaults to empty (no icon);
-       a secondary icon relating to the application will be shown as well, regardless of this field.
-:timestamp: Seconds since the unix epoch, only used for persist (for now). If zero or unset, defaults to current timestamp.
-:persist: Whether to show in notification centre; defaults to false
-:popup: Whether to show in a bubble. Users can disable this, and can easily miss them, so don't rely on it exclusively. Defaults to false.
-
-.. note:: Keep in mind that the precise way in which each field is presented to the user depends on factors such as
-          whether it's shown as a bubble or in the notification centre, or even the version of Ubuntu Touch the user
-          has on their device.
-
-The notification can contain a **sound** field. This is either a boolean (play a predetermined sound) or the path to a sound file. The user can disable it, so don't rely on it exclusively.
-Defaults to empty (no sound). The path is relative, and will be looked up in (a) the application's .local/share/<pkgname>, and (b)
-standard xdg dirs.
-
-The notification can contain a **vibrate** field, causing haptic feedback, which can be either a boolean (if true, vibrate a predetermined way) or an object that has the following content:
-
-:pattern: a list of integers describing a vibration pattern (duration of alternating vibration/no vibration times, in milliseconds).
-:repeat: number of times the pattern has to be repeated (defaults to 1, 0 is the same as 1).
-
-The notification can contain a **emblem-counter** field, with the following content:
-
-:count: a number to be displayed over the application's icon in the launcher.
-:visible: set to true to show the counter, or false to hide it.
-
-.. note:: Unlike other notifications, emblem-counter needs to be cleaned by the app itself.
-          Please see `the persistent notification management section. <#persistent-notification-management>`__
-
-.. FIXME crosslink to hello example app on each method
-
-Security
-~~~~~~~~
-
-To use the push API, applications need to request permission in their security profile, using something like this::
-
-	{
-		"policy_groups": [
-			"networking",
-			"push-notification-client"
-		],
-		"policy_version": 1.2
-	}
-
-
-Ubuntu Push Server API
-----------------------
-
-The Ubuntu Push server is located at https://push.ubuntu.com and has a single endpoint: ``/notify``.
-To notify a user, your application has to do a POST with ``Content-type: application/json``.
-
-Here is an example of the POST body using all the fields::
-
-	{
-		"appid": "com.ubuntu.music_music",
-		"expire_on": "2014-10-08T14:48:00.000Z",
-		"token": "LeA4tRQG9hhEkuhngdouoA==",
-		"clear_pending": true,
-		"replace_tag": "tagname",
-		"data": {
-			"message": "foobar",
-			"notification": {
-				"card": {
-					"summary": "yes",
-					"body": "hello",
-					"popup": true,
-					"persist": true,
-					"timestamp": 1407160197
-				}
-				"sound": "buzz.mp3",
-				"tag": "foo",
-				"vibrate": {
-					"pattern": [200, 100],
-					"repeat": 2
-				}
-				"emblem-counter": {
-					"count": 12,
-					"visible": true
-				}
-			}
-		}
-	}
-
-
-:appid: ID of the application that will receive the notification, as described in the client side documentation.
-:expire_on: Expiration date/time for this message, in `ISO8601 Extendend format <http://en.wikipedia.org/wiki/ISO_8601>`__
-:token: The token identifying the user+device to which the message is directed, as described in the client side documentation.
-:clear_pending: Discards all previous pending notifications. Usually in response to getting a "too-many-pending" error.
-:replace_tag: If there's a pending notification with the same tag, delete it before queuing this new one.
-:data: A JSON object.
-
-In this example, data is `what a helper would output <#helper-output-format>`__ but that's not necessarily the case.
-The content of the data field will be passed to the helper application which **has** to produce output in that format.
+.. include:: _common.txt
\ No newline at end of file