mcfedr/awspushbundle

A set of services to simplify using Aws to send push notifications

Monday, March 12, 2018
by mcfedr
Repository
3 Watchers
34 Stars
124,245 Installations

PHP
1 Dependents
0 Suggesters
17 Forks
2 Open issues
78 Versions
5 % Grown

The README.md

Aws Push Bundle

A convenient bundle for registering devices and then pushing to them using amazons SNS service., _(*1)

, _(*2)

Install

Composer

php composer.phar require mcfedr/awspushbundle

AppKernel

Include the bundle in your AppKernel, _(*3)

public function registerBundles()
{
    $bundles = array(
        ...
        new Mcfedr\AwsPushBundle\McfedrAwsPushBundle()

Config

Put something like this in your config. The arns in the platforms section should be the preconfigured app arns in SNS., _(*4)

mcfedr_aws_push:
    platforms:
        ios: 'arn:aws:sns:....'
        android: 'arn:aws:sns:....'
    topic_arn: 'arn:aws:sns:...'
    pushPlatforms: [apns, fcm]
    aws:
        credentials: 
            key: 'my key'
            secret: 'my secret'
        region: 'my region'

You can skip credentials if you have want the Aws SDK to get credentials indirectly, either from environment or ec2 role., _(*5)

If you don't set the pushPlatforms setting then android messages will sent in a format compatible with GCM, i.e. the notification field will not be set. This is for backwards compatibility of this bundle., _(*6)

Usage

Basically have a look at how the ApiController does its stuff, _(*7)

$arn = $this->get('mcfedr_aws_push.devices')->registerDevice($token, $platform)

Send message to one device, _(*9)

$this->get('mcfedr_aws_push.messages')->send($message, $arn)

Send message to all devices, _(*10)

$this->get('mcfedr_aws_push.messages')->broadcast($message)

Alternative usage, using topics to send messages to lots of devices, _(*11)

$arn = $this->get('mcfedr_aws_push.devices')->registerDevice($token, $platform)

$this->get('mcfedr_aws_push.topics')->registerDeviceOnTopic($arn, $topicArn)

Send messages, _(*14)

$this->get('mcfedr_aws_push.topics')->broadcast($message, $topicArn)

If you later add a topic_name to the configuration you can run the mcfedr:aws:subscribe command to add your existing devices to the topic., _(*15)

Text in notifications

For GCM and ADM there is no 'standard' key for text data as there is for Apple pushes, so this bundle send text in a key called message., _(*16)

If localized text is sent the keys are * message-loc-key * message-loc-args, _(*17)

'Complicated' data on ADM

ADM only allows strings as values in the push data. This bundle lets you send 'complicated' values and will automatically json encode these values for ADM. When it does this the key has _json added so that its easy to handle this on the app side., _(*18)

Example

Sending:, _(*19)

$message = new Message();
$message->setCustom(['simple' => 'Hello', 'complicated' => ['inner' => 'value']]);

ADM received data:, _(*20)

{"data": {"simple": "Hello", "complicated_json": "{\"inner\":\"value\"}"}}

To handle this data you should detect keys that end with _json and decode the values, _(*21)

The applies to message-loc-args as well, they will always come as message-loc-args_json via ADM, _(*22)

Commands

There are some commands to help manage the devices, _(*23)

mcfedr:aws:enable, _(*24)

This will reenable all the devices, _(*25)
mcfedr:aws:remove, _(*26)

This will remove any disabled devices. Its a good idea to do something like this regularly to remove old devices, _(*27)
mcfedr:aws:subscribe, _(*28)

This will subscribe all devices to a topic, useful when introducing a topic, _(*29)

Api Controller

Optional., _(*30)

There is a controller included which makes basic usage of the bundle very easy. You may or may not want to use it, you might find it most useful as an example., _(*31)

There are some extra dependencies you must add when using the controller, _(*32)

sensio/framework-extra-bundle
symfony/validator
symfony/serializer
symfony/property-info
symfony/security-bundle
symfony/expression-language

They also need enabling in the framework config, _(*33)

framework:
    validation: { enable_annotations: true }
    serializer:
        enabled: true
    property_info:
        enabled: true

Add the routes in your routing.yaml:, _(*34)

mcfedr_aws_push:
    resource: "@McfedrAwsPushBundle/Controller/"
    type:     annotation
    prefix:   /

Usage

The controller provides two urls, both expect a JSON POST body, _(*35)

The first is a way to register a device, _(*36)

POST /devices
{
    "device": {
        "deviceId": "a push token",
        "platform": "the platform name in your config file"
    }
}

The second is a way to send a broadcast message. If you are using a topic for all devices then don't send the platform parameter., _(*37)

POST /broadcast
{
    "broadcast": {
        "platform": "ios"
        "message": {
            "text": "The plain text message to send",
            "badge": 1
        }
    }
}

More info

The Versions

12/03 2018

dev-master

9999999-dev

A set of services to simplify using Aws to send push notifications

symfony-bundle awspushbundle

A set of services to simplify using Aws to send push notifications

mcfedr/awspushbundle

The README.md

Aws Push Bundle

Install

Composer

AppKernel

Config

Usage

Text in notifications

'Complicated' data on ADM

Example

Commands

Api Controller

Usage

More info

The Versions

dev-master

The Requires

The Development Requires

by Fred Cox

6.10.0

The Requires

The Development Requires

by Fred Cox

6.9.1

The Requires

The Development Requires

by Fred Cox

6.9.0

The Requires

The Development Requires

by Fred Cox

dev-remove-unused

The Requires

The Development Requires

by Fred Cox

6.8.3

The Requires

The Development Requires

by Fred Cox

6.8.2

The Requires

The Development Requires

by Fred Cox

6.8.1

The Requires

The Development Requires

by Fred Cox

6.8.0

The Requires

The Development Requires

by Fred Cox

6.7.0

The Requires

The Development Requires

by Fred Cox

6.6.1

The Requires

The Development Requires

by Fred Cox

6.6.0

The Requires

The Development Requires

by Fred Cox

v5.x-dev

The Requires

The Development Requires

by Fred Cox

5.1.3

The Requires

The Development Requires

by Fred Cox

6.5.2

The Requires

The Development Requires

by Fred Cox

6.5.1

The Requires