fcm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 566f06986ceeeb5c1feb04bd49988c7d1a1698ed
-  data.tar.gz: 60daa74b40a83b9536a54db75b04d8b02b1526f0
+  metadata.gz: 54f66db484403cdfb990353ebf8c52553de4beb9
+  data.tar.gz: 77bdb6784ce6688ee0f3cc468ecf3ab1e7ccd2b4
 SHA512:
-  metadata.gz: 6c58de63c80e324d3425278ebebe22c617be80d2514a8d0a6944bda90a3c6bd06d2de3bb4afd137e1528fc363f97eb8e8671f3e0f7cf73a71381a0a75f60e107
-  data.tar.gz: aaf37a387be61be0dbb3a094404204dfcb433549c68757dd4863ea97dbf80be236dcbd7706e298ac5148643af217aa76ad73a7e6eef14a06e009adbb650b2aba
+  metadata.gz: a97f8d1a9d24f436a928f288b302828022bb542529435a155d4758cd014ff19bfd5ce295e746597717d2b45e3e8d6523a97a1336e87555e734c492d31b6252bf
+  data.tar.gz: dc3ea1cf7d433759648a27e579000616f1fd322bf0d477dd5d67fc39ca7483dc2d12d870856585161d809df3d641c3482f0380af0168b69d1003312a71a30e83

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.9
+  - 2.1.10
   - 2.2.5
   - 2.3.1

data/README.md

@@ -57,16 +57,16 @@ Then you will need a notification key which you can create for a particular `key
 ```ruby
 response = fcm.create(key_name: "appUser-Chris",
                 project_id: "my_project_id",
-                registration_ids:["4", "8", "15", "16", "23", "42"])
+                registration_ids: ["4", "8", "15", "16", "23", "42"])
 ```
 
 ### Send to Notification Key
-Now you can send a message to a particular `notification_key` via the `send_with_notification_key` method. This allows the server to send a single data to multiple app instances  (typically on multiple devices) owned by a single user (instead of sending to some registration tokens). Note: the maximum number of members allowed for a `notification_key` is 20.
+Now you can send a message to a particular `notification_key` via the `send_with_notification_key` method. This allows the server to send a single [data](https://firebase.google.com/docs/cloud-messaging/concept-options#data_messages) payload or/and [notification](https://firebase.google.com/docs/cloud-messaging/concept-options#notifications) payload to multiple app instances (typically on multiple devices) owned by a single user (instead of sending to some registration tokens). Note: the maximum number of members allowed for a `notification_key` is 20.
 
 ```ruby
-response = fcm.send_with_notification_key("notification_key", {
+response = fcm.send_with_notification_key("notification_key",
             data: {score: "3x1"},
-            collapse_key: "updated_score"})
+            collapse_key: "updated_score")
 ```
 
 ### Add/Remove Registration Tokens
@@ -90,15 +90,15 @@ response = fcm.remove(key_name: "appUser-Chris",
 FCM [topic messaging](https://firebase.google.com/docs/cloud-messaging/topic-messaging) allows your app server to send a message to multiple devices that have opted in to a particular topic. Based on the publish/subscribe model, topic messaging supports unlimited subscriptions per app. Sending to a topic is very similar to sending to an individual device or to a user group, in the sense that you can use the `fcm.send_with_notification_key()` method where the `noticiation_key` matches the regular expression `"/topics/[a-zA-Z0-9-_.~%]+"`:
 
 ```ruby
-response = fcm.send_with_notification_key("/topics/yourTopic", {
-            data: {message: "This is a FCM Topic Message!"})
+response = fcm.send_with_notification_key("/topics/yourTopic",
+            data: {message: "This is a FCM Topic Message!")
 ```
 
 Or you can use the helper:
 
 ```ruby
-response = fcm.send_to_topic("yourTopic", {
-            data: {message: "This is a FCM Topic Message!"})
+response = fcm.send_to_topic("yourTopic",
+            data: {message: "This is a FCM Topic Message!")
 ```
 
 ## Mobile Clients
@@ -109,11 +109,15 @@ The guide to set up an iOS app to get notifications is here: [Setting up a FCM C
 
 ## ChangeLog
 
+### 0.0.2
+
+* Fixed group messaging url.
+* Added API to `recover_notification_key`.
+
 ### 0.0.1
 
 * Initial version.
 
-
 ##MIT License
 
 * Copyright (c) 2016 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details.

data/fcm.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fcm"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Kashif Rasul", "Shoaib Burq"]
   s.email       = ["kashif@spacialdb.com", "shoaib@spacialdb.com"]

data/lib/fcm.rb

@@ -8,6 +8,9 @@ class FCM
   default_timeout 30
   format :json
 
+  # constants
+  GROUP_NOTIFICATION_BASE_URI = 'https://android.googleapis.com/gcm'
+
   attr_accessor :timeout, :api_key
 
   def initialize(api_key, client_options = {})
@@ -43,8 +46,8 @@ class FCM
   alias send send_notification
 
   def create_notification_key(key_name, project_id, registration_ids = [])
-    post_body = build_post_body(registration_ids,                   operation: 'create',
-                                                                    notification_key_name: key_name)
+    post_body = build_post_body(registration_ids, operation: 'create',
+                                notification_key_name: key_name)
 
     params = {
       body: post_body.to_json,
@@ -55,15 +58,20 @@ class FCM
       }
     }
 
-    response = self.class.post('/notification', params.merge(@client_options))
+    response = nil
+
+    for_uri(GROUP_NOTIFICATION_BASE_URI) do
+      response = self.class.post('/notification', params.merge(@client_options))
+    end
+
     build_response(response)
   end
   alias create create_notification_key
 
   def add_registration_ids(key_name, project_id, notification_key, registration_ids)
-    post_body = build_post_body(registration_ids,                     operation: 'add',
-                                                                      notification_key_name: key_name,
-                                                                      notification_key: notification_key)
+    post_body = build_post_body(registration_ids, operation: 'add',
+                                notification_key_name: key_name,
+                                notification_key: notification_key)
 
     params = {
       body: post_body.to_json,
@@ -74,15 +82,19 @@ class FCM
       }
     }
 
-    response = self.class.post('/notification', params.merge(@client_options))
+    response = nil
+
+    for_uri(GROUP_NOTIFICATION_BASE_URI) do
+      response = self.class.post('/notification', params.merge(@client_options))
+    end
     build_response(response)
   end
   alias add add_registration_ids
 
   def remove_registration_ids(key_name, project_id, notification_key, registration_ids)
-    post_body = build_post_body(registration_ids,                   operation: 'remove',
-                                                                    notification_key_name: key_name,
-                                                                    notification_key: notification_key)
+    post_body = build_post_body(registration_ids, operation: 'remove',
+                                notification_key_name: key_name,
+                                notification_key: notification_key)
 
     params = {
       body: post_body.to_json,
@@ -93,11 +105,35 @@ class FCM
       }
     }
 
-    response = self.class.post('/notification', params.merge(@client_options))
+    response = nil
+
+    for_uri(GROUP_NOTIFICATION_BASE_URI) do
+      response = self.class.post('/notification', params.merge(@client_options))
+    end
     build_response(response)
   end
   alias remove remove_registration_ids
 
+  def recover_notification_key(key_name, project_id)
+    params = {
+      query: {
+        notification_key_name: key_name
+      },
+      headers: {
+        'Content-Type' => 'application/json',
+        'project_id' => project_id,
+        'Authorization' => "key=#{@api_key}"
+      }
+    }
+
+    response = nil
+
+    for_uri(GROUP_NOTIFICATION_BASE_URI) do
+      response = self.class.post('/notification', params.merge(@client_options))
+    end
+    build_response(response)
+  end
+
   def send_with_notification_key(notification_key, options = {})
     body = { to: notification_key }.merge(options)
 
@@ -108,6 +144,7 @@ class FCM
         'Content-Type' => 'application/json'
       }
     }
+
     response = self.class.post('/send', params.merge(@client_options))
     build_response(response)
   end
@@ -120,6 +157,13 @@ class FCM
 
   private
 
+  def for_uri(uri)
+    current_uri = self.class.base_uri
+    self.class.base_uri uri
+    yield
+    self.class.base_uri current_uri
+  end
+
   def build_post_body(registration_ids, options = {})
     { registration_ids: registration_ids }.merge(options)
   end

data/spec/fcm_spec.rb

@@ -2,9 +2,15 @@ require 'spec_helper'
 
 describe FCM do
   let(:send_url) { "#{FCM.base_uri}/send" }
+  let(:group_notification_base_uri) { "https://android.googleapis.com/gcm/notification" }
+  let(:api_key) { 'AIzaSyB-1uEai2WiUapxCs2Q0GZYzPu7Udno5aA' }
+  let(:registration_ids) { ['42'] }
+  let(:key_name) { 'appUser-Chris' }
+  let(:project_id) { "123456789" } # https://developers.google.com/cloud-messaging/gcm#senderid
+  let(:notification_key) { "APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ" }
 
   it 'should raise an error if the api key is not provided' do
-    expect { FCM.new }.to raise_error
+    expect { FCM.new }.to raise_error(ArgumentError)
   end
 
   it 'should raise error if time_to_live is given' do
@@ -12,8 +18,6 @@ describe FCM do
   end
 
   describe 'sending notification' do
-    let(:api_key) { 'AIzaSyB-1uEai2WiUapxCs2Q0GZYzPu7Udno5aA' }
-    let(:registration_ids) { ['42'] }
     let(:valid_request_body) do
       { registration_ids: registration_ids }
     end
@@ -238,4 +242,137 @@ describe FCM do
       end
     end
   end
+
+  describe 'sending group notifications' do
+    # TODO: refactor to should_behave_like
+    let(:valid_request_headers) do
+      {
+        "Authorization" => "key=#{api_key}",
+        "Content-Type" => 'application/json',
+        "Project-Id" => project_id
+      }
+    end
+    let(:valid_response_body) do
+      { notification_key: "APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ" }
+    end
+
+    let(:default_valid_request_body) do
+      {
+        registration_ids: registration_ids,
+        operation: "create",
+        notification_key_name: key_name
+      }
+    end
+
+    subject { FCM.new(api_key) }
+
+    # ref: https://firebase.google.com/docs/cloud-messaging/notifications#managing-device-groups-on-the-app-server
+    context 'create' do
+      let(:valid_request_body) do
+        default_valid_request_body.merge({
+          operation: "create"
+        })
+      end
+
+      let(:mock_request_attributes) do
+        {
+          body: valid_request_body.to_json,
+          headers: valid_request_headers
+        }
+      end
+
+      before do
+        stub_request(:post, group_notification_base_uri).with(
+          mock_request_attributes
+        ).to_return(
+          body: valid_response_body.to_json,
+          headers: {},
+          status: 200
+        )
+      end
+
+      it 'should send a post request' do
+        response = subject.create(key_name, project_id, registration_ids)
+        response.should eq(
+          headers: {},
+          status_code: 200,
+          response: 'success',
+          body: valid_response_body.to_json
+        )
+      end
+    end # create context
+
+    context 'add' do
+      let(:valid_request_body) do
+        default_valid_request_body.merge({
+          operation: "add",
+          notification_key: notification_key
+        })
+      end
+
+      let(:mock_request_attributes) do
+        {
+          body: valid_request_body.to_json,
+          headers: valid_request_headers
+        }
+      end
+
+      before do
+        stub_request(:post, group_notification_base_uri).with(
+          mock_request_attributes
+        ).to_return(
+          body: valid_response_body.to_json,
+          headers: {},
+          status: 200
+        )
+      end
+
+      it 'should send a post request' do
+        response = subject.add(key_name, project_id, notification_key, registration_ids)
+        response.should eq(
+          headers: {},
+          status_code: 200,
+          response: 'success',
+          body: valid_response_body.to_json
+        )
+      end
+    end # add context
+
+    context 'remove' do
+      let(:valid_request_body) do
+        default_valid_request_body.merge({
+          operation: "remove",
+          notification_key: notification_key
+        })
+      end
+
+      let(:mock_request_attributes) do
+        {
+          body: valid_request_body.to_json,
+          headers: valid_request_headers
+        }
+      end
+
+      before do
+        stub_request(:post, group_notification_base_uri).with(
+          mock_request_attributes
+        ).to_return(
+          body: valid_response_body.to_json,
+          headers: {},
+          status: 200
+        )
+      end
+
+      it 'should send a post request' do
+        response = subject.remove(key_name, project_id, notification_key, registration_ids)
+        response.should eq(
+          headers: {},
+          status_code: 200,
+          response: 'success',
+          body: valid_response_body.to_json
+        )
+      end
+    end # remove context
+
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fcm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kashif Rasul
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: fcm
-rubygems_version: 2.6.4
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Reliably deliver messages and notifications via FCM