roost 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77377fdae341f44fe67ef2cfd7dbf48d6074b1fb
-  data.tar.gz: 0d774da3a5932e1dfea1aa1b183ef3c65f7a8cd0
+  metadata.gz: f20982ad4d6a908888cfc215b3ffdc3029a138d3
+  data.tar.gz: f2df7f813aba45c79a88f100f79ce6689aa031fa
 SHA512:
-  metadata.gz: 16acce3631d7fac1a49e25713a14bfe2e9459a1c6598622273ebcb72e05d466d0e88183b3a57a98a1da406b3eacc8a23ebe8e46ba2e090748ab65d848669e866
-  data.tar.gz: b8bdfd4636e6e049ac53af2d511be2e32c535139148ca4fbc4db6b0754336f8e82698df6fda7ee8318052712d50583c5e9ea3839f93f34d70397c023226ad92a
+  metadata.gz: 731dcfe5adacb57d08cd2dd107e9758a33c1f2da52079b52fc38211e7843dcfbe0621d3ce0c8e4167d0b04da6fbe1587b94ef47c24f03dcb40f9eab950806947
+  data.tar.gz: 413bf36d8d4613c2c4df1f7b737a99413f572fd98a78d04ec10184902974b715826f60432619b4eb72feab7afbcc8de05bda251dd77cb4ecb0f8d3829d1dff0c

data/README.md

@@ -26,18 +26,55 @@ To send notifications you will first need to create an account on the [Roost web
 Set your Roost app key and app secret to the following environment variables: ENV["ROOST_APPKEY"] / ENV["ROOST_APPSECRET"]
 These can be found in the [Roost dashboard](https://dashboard.goroost.com) under settings -> API.
 
-Easliy send notifications through Roost. Notifications incule text (alert) and a landing page URL (url).
+### Basic Send
+
+Easily send notifications through Roost. Notifications must include text (alert) and a landing page URL (url).
+
+```
+alert = 'Thanks for subscribing for notifications'
+url = 'https://goroost.com'
+
+response = Roost::API.send({alert: alert,url: url})
+
+if response['success'] == true
+    ..success..
+else
+    ..failure..
+end
 ```
-    alert = 'Thanks for subscribing for notifications'
-    url = 'https://goroost.com'
 
-    response = Roost::API.send({alert: alert,url: url})
+### Sending With Parameters
 
-    if response['success'] == true
-        ..success..
-    else
-        ..failure..
-    end
+It is possible to target segments of your subscribers, or even individuals, and send scheduled notifications or advanced tests on notification sending. You must first have set these segments or identifiers via our [JavaScript API](http://docs.goroost.com/v1.0/docs/api-basics).
+
+#### Accepted Parameters
+
+| Key Name | Description |
+| :--- | :--- |
+| segments | List of Segments. If included, notification will be sent only to subscribers associated with one or more of the listed Segments.|
+| aliases | List of user Aliases. If included, notification will be sent only to subscribers listed. |
+| device_tokens | List of device tokens on which users registered. If included, notification will be sent only to devices listed. |
+| exclude_tokens | List of device tokens. If included, devices listed will be excluded when the notification is sent. |
+| test_type | Specifies that progressive A/B split-testing will be done to optimize delivery. If included, value must be: 'MULTI_ARM_BANDIT'. In this case, alert must also be specified as an array with a list of alternate titles (EX: ['A Notification Title', 'Alternate Title', 'Third Title']). |
+| schedule_for | Time when the notification will be scheduled for delivery. Format: "YYYY-MM-DDTHH:mm:SSZ". Time is specified in Zulu/GMT. **Example:** '2015-06-20T08:00:00Z' |
+
+```
+alert = 'Thanks for subscribing for notifications'
+url = 'https://goroost.com'
+aliases = ['dan@abc123.com', 'burton@xyz456', 'sattles@lmno789.com']
+device_tokens = ['abcdefg123456789', '987654321gfedcba']
+exclude_tokens = ['lmnopqrs789']
+schedule_for = '2015-06-05T15:17:00Z'
+segments = ['Story', 'News', 'Weather']
+test_type = 'MULTI_ARM_BANDIT'
+
+response = Roost::API.send({alert: alert,url: url, segments: segments, schedule_for: schedule_for})
+
+if response['success'] == true
+    ..success..
+else
+    ..failure..
+end
 ```
 
 ## Contributing

data/lib/roost.rb

@@ -20,10 +20,31 @@ module Roost
       request = Net::HTTP::Post.new(uri.path, initheader = {'Content-Type' =>'application/json'})
       request.basic_auth key,secret
 
-      request.body = {
+      body = {
               alert:opts[:alert],
               url:opts[:url]
-      }.to_json
+      }
+
+      if opts[:aliases] && !opts[:aliases].empty?
+          body[:aliases] =  opts[:aliases]
+      end
+      if opts[:device_tokens] && !opts[:device_tokens].empty?
+          body[:device_tokens] =  opts[:device_tokens]
+      end
+      if opts[:exclude_tokens] && !opts[:exclude_tokens].empty?
+          body[:exclude_tokens] =  opts[:exclude_tokens]
+      end
+      if opts[:schedule_for] && !opts[:schedule_for].empty?
+          body[:schedule_for] =  opts[:schedule_for]
+      end
+      if opts[:segments] && !opts[:segments].empty?
+          body[:segments] =  opts[:segments]
+      end
+      if opts[:test_type] && !opts[:test_type].empty?
+          body[:test_type] =  opts[:test_type]
+      end
+
+      request.body = body.to_json
 
       response = http.request(request)
       if response.code == "200"

data/lib/roost/version.rb

@@ -1,3 +1,3 @@
 module Roost
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roost
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Roost
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler