rumour-ruby 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4aab59bc0bcf11c9eb93f31882d6787cc4791a57
-  data.tar.gz: 0054a378a2aae28ad375ce8be34d6317b237791d
+  metadata.gz: 46ad17d4fb6cc20cecbfeb40245953061ff37a06
+  data.tar.gz: bf9cc35dab1c53b265ae2c589ef19744e59b2e11
 SHA512:
-  metadata.gz: 869887c9f8456295e683b10765e2f4802952ea4171c125748752b5b7e3259a3ddd7a15fda98c36e0894215e9266029dbeaae0fea64865fab7495b2afb70229d9
-  data.tar.gz: 82199db9ea437d925e436de5bb066615d809c7bb6e873dcaa1afbccfb9ffc19f1c4869171d9eb918d0e09ab2d7dd1c19ab49c8b33b711be1e331bba235d54c0f
+  metadata.gz: 26faf381cd5daacbbe5da354afb79e989a69b98939105e76bc9266117f2d85724a232bbfb7b43187df42eff772a5995e1985ee1a005ff5c4f3e5d046ecef3fcc
+  data.tar.gz: 01cc7d2f3061ce0606b2f934fdde66515726c816d555e2ffc779445936b96d377a6cd50a05638f500513eb300bf3f19cbb18fbc633a7ee944e08f59e29a7a266

data/README.md

@@ -1,6 +1,6 @@
-# Rumour
+# rumour-ruby
 
-Rumour is a Ruby wrapper to communicate with Rumour REST API.
+**rumour-ruby** is a Ruby wrapper to communicate with Rumour REST API.
 
 ## Installation
 
@@ -34,24 +34,53 @@ rumour = Rumour::Client.new(access_token)
 Then, send a text message:
 ```ruby
 from = '+15005550006'
-recipient = '+15005550005'
+recipients = '+15005550005'
 
-rumour.send_text_message(from, recipient, 'Hello from Rumour!')
+rumour.send_text_message(from, recipient, Hello from Rumour!')
 #=> {'id' => '1', 'from' => '+15005550006', 'recipient' => '+15005550005', ... }
 ```
 
 Or an Android Push Notification:
 ```ruby
-recipient = 'Device-Token-Here'
-
-rumour.send_push_notification('android', recipient, data: { ... })
+recipients = ['android::Registration-Id-Here']
+
+rumour.send_push_notification(
+  recipients,
+  title: 'Push Notification Title', # optional
+  text: 'Push Notification Text', # optional
+  additional_data: { ... } # optional
+  android: { data: { some_key: 'some_value'}}, # optional
+)
+#=> [{'id' => '2', 'platform' => 'android', 'recipient' => 'Registration-Id-Here', ...}]
 ```
 
 Or even an iOS Push Notification:
 ```ruby
-recipient = 'Device-Token-Here'
+recipients = ['ios::Device-Token-Here']
+
+rumour.send_push_notification(
+  recipients,
+  title: 'Push Notification Title', # optional
+  text: 'Push Notification Text', # optional
+  additional_data: { ... }, # optional
+  ios: { alert: { badge: 2 } } # optional
+)
+#=> [{'id' => '2', 'platform' => 'ios', 'recipient' => 'Device-Token-Here', ...}]
+```
 
-rumour.send_push_notification('ios', recipient, alert: { ... })
+You can also send Push Notifications for multiple devices and platforms:
+```ruby
+recipients = ['android::Registration-Id-Here', 'ios::Device-Token-Here']
+
+rumour.send_push_notification(
+  recipients,
+  title: 'Push Notification Title', # optional
+  text: 'Push Notification Text', # optional
+  additional_data: { ... }, # optional
+  android: { data: { some_key: 'some_value'}}, # optional
+  ios: { alert: { badge: 2 } } # optional
+)
+#=> [{'id' => '3', 'platform' => 'android', 'recipient' => 'Registration-Id-Here', ...}, {'id' => '4', 'platform' => 'ios', 'recipient' => 'Device-Token-Here', ...}]
 ```
 
 ### Interceptors
@@ -62,7 +91,7 @@ Intercept text messages and/or push notifications when you don't want to send st
 
 Rumour.configure do |config|
   config.intercept_text_message_recipient = 'your_mobile_phone_number'
-  config.intercept_push_notification_recipient = 'your_device_token'
+  config.intercept_push_notification_recipients = ['android::your_registration_id']
 end
 ```
 

data/lib/rumour-ruby/client.rb

@@ -16,13 +16,13 @@ module Rumour
     end
 
     def send_text_message(sender, recipient, body)
-      recipient = Rumour.configuration.intercept_text_message_recipient || recipient
+      recipient = intercept_tm_recipient || recipient
       post('/text_messages', text_message: { from: sender, recipient: recipient, body: body })
     end
 
-    def send_push_notification(recipient, options= {})
-      recipient = Rumour.configuration.intercept_push_notification_recipient || recipient
-      post('/push_notifications', push_notification: { recipient: recipient }.merge(options))
+    def send_push_notification(recipients, options= {})
+      recipients = intercept_pn_recipients unless [intercept_pn_recipients].compact.empty?
+      post('/push_notifications', push_notification: { recipients: [recipients].flatten }.merge(options))
     end
 
     private
@@ -54,5 +54,13 @@ module Rumour
           raise Rumour::Errors::AuthenticationError.new response_body['message']
         end
       end
+
+      def intercept_tm_recipient
+        Rumour.configuration.intercept_text_message_recipient
+      end
+
+      def intercept_pn_recipients
+        Rumour.configuration.intercept_push_notification_recipients
+      end
   end
 end

data/lib/rumour-ruby/configuration.rb

@@ -4,7 +4,7 @@ module Rumour
       :api_key,
       :access_token,
       :intercept_text_message_recipient,
-      :intercept_push_notification_recipient
+      :intercept_push_notification_recipients
     ]
 
     attr_accessor *CONFIGURABLE_ATTRIBUTES

data/lib/rumour-ruby/version.rb

@@ -1,3 +1,3 @@
 module Rumour
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/spec/client_spec.rb

@@ -35,7 +35,6 @@ RSpec.describe Rumour::Client do
       it 'creates and retrieves a new message as a hash' do
         rumour_client = Rumour::Client.new(RUMOUR_TEST_ACCESS_TOKEN)
         text_message = rumour_client.send_text_message(TWILIO_TEST_SENDER_NUMBER, TWILIO_TEST_RECIPIENT_NUMBER, 'Hello from rumour-ruby!')
-
         expect(text_message['id']).to_not be_nil
       end
     end
@@ -55,9 +54,9 @@ RSpec.describe Rumour::Client do
     describe 'send with valid data' do
       it 'creates and retrieves a new push notification as a hash' do
         rumour_client = Rumour::Client.new(RUMOUR_TEST_ACCESS_TOKEN)
-        push_notification = rumour_client.send_push_notification('android::some_registration_id', title: 'PN Title', text: 'PN Text', android_data: { my_key: 'my_value'})
+        push_notifications = rumour_client.send_push_notification(['android::some_registration_id'], title: 'PN Title', body: 'PN Text', android: { data: { my_key: 'my_value'}})
 
-        expect(push_notification['id']).to_not be_nil
+        expect(push_notifications[0]['id']).to_not be_nil
       end
     end
   end
@@ -66,9 +65,21 @@ RSpec.describe Rumour::Client do
     describe 'send with valid data' do
       it 'creates and retrieves a new push notification as a hash' do
         rumour_client = Rumour::Client.new(RUMOUR_TEST_ACCESS_TOKEN)
-        push_notification = rumour_client.send_push_notification('ios::some_device_token', title: 'PN Title', text: 'PN Text', ios_alert: { title: 'iOS Title'})
+        push_notifications = rumour_client.send_push_notification('ios::some_device_token', title: 'PN Title', body: 'PN Text', ios: { alert: { title: 'iOS Title'}})
+        
+        expect(push_notifications[0]['id']).to_not be_nil
+      end
+    end
+  end
+
+  describe 'ios push_notifications' do
+    describe 'send for multiple recipients with valid data' do
+      it 'creates and retrieves a new push notification as a hash' do
+        rumour_client = Rumour::Client.new(RUMOUR_TEST_ACCESS_TOKEN)
+        push_notifications = rumour_client.send_push_notification(['ios::some_device_token', 'android::some_device_token'], title: 'PN Title', body: 'PN Text', ios: { alert: { title: 'iOS Title'}})
         
-        expect(push_notification['id']).to_not be_nil
+        expect(push_notifications[0]['id']).to_not be_nil
+        expect(push_notifications[1]['id']).to_not be_nil
       end
     end
   end
@@ -91,14 +102,14 @@ RSpec.describe Rumour::Client do
     describe 'for push notifications' do
       it 'sends the push notification to the interceptor' do
         Rumour.configure do |config|
-          config.intercept_push_notification_recipient = 'ios::push_recipient'
+          config.intercept_push_notification_recipients = ['ios::push_recipient']
         end
 
         rumour_client = Rumour::Client.new(RUMOUR_TEST_ACCESS_TOKEN)
-        push_notification = rumour_client.send_push_notification('ios::some_device_token', title: 'PN Title', text: 'PN Text', ios_alert: { title: 'iOS Title'})
+        push_notifications = rumour_client.send_push_notification('ios::some_device_token', title: 'PN Title', body: 'PN Text', ios_alert: { title: 'iOS Title'})
 
-        expect(push_notification['id']).to_not be_nil
-        expect(push_notification['recipient']).to eq('push_recipient')
+        expect(push_notifications[0]['id']).to_not be_nil
+        expect(push_notifications[0]['recipient']).to eq('push_recipient')
       end
     end
   end

data/spec/configuration_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Rumour do
         config.api_key = 'some_api_key'
         config.access_token = 'some_access_token'
         config.intercept_text_message_recipient = '+14108675309'
-        config.intercept_push_notification_recipient = 'push_recipient'
+        config.intercept_push_notification_recipients = ['android::push_recipient']
       end
     end
 
@@ -15,7 +15,7 @@ RSpec.describe Rumour do
       expect(described_class.configuration.api_key).to eq('some_api_key')
       expect(described_class.configuration.access_token).to eq('some_access_token')
       expect(described_class.configuration.intercept_text_message_recipient).to eq('+14108675309')
-      expect(described_class.configuration.intercept_push_notification_recipient).to eq('push_recipient')
+      expect(described_class.configuration.intercept_push_notification_recipients).to eq(['android::push_recipient'])
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumour-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Joao Diogo Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty