fcm 0.0.5 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c66c86d3d3691b424672e80b59a82960bb4ff54d
-  data.tar.gz: '091c4d8413d499f23d87f419e0b0f0f560242bb7'
+SHA256:
+  metadata.gz: 2e620131ea8e4a53c7a3927da1c48f4893fbeffbbcce88c9306a41614c3e5768
+  data.tar.gz: 9dae9eb3980e57fe84344afb22f68b29d874dbde580dc28ccd6cf3028cc9e16a
 SHA512:
-  metadata.gz: a9540aeb7f04c0a80d2777511261a87d5e6fc08e88dc6806775c23b83aa2df10cf10c80d6aa7abfdeb9140e92ab47e37c6e1c507555b813500fa5b85892be24f
-  data.tar.gz: 96121c74b6e7ecea819fbc9db61b5cea64b8d2eff054620950bc9f73d4da270fe0b5cfd8ce31152f0075c71b87d4c7620bc1be12f1e387917dc4f7435250c0cb
+  metadata.gz: 63ee034d8813fce59b32673c846b1c86d4dddfc3b1136caa3e6d25fdcc0ca2dc00bfc7a8aa6ef4871bdcfd66790bbf28321c70312171ae994463aac2ce18b6e8
+  data.tar.gz: 45886b059e48c8497767a2747842178ae2db282a0dde6438cc67fedc54c5264de2f0707c52863dd5015bc0389e0fdc93c23ca8268238210809299fe29d834364

data/.gitignore

@@ -48,4 +48,4 @@ specifications
 Gemfile.lock
 .rvmrc
 spec/reports
-*.gem
+*.gem

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
+  - 2.4.0
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1
+  - 2.7.0

data/README.md

@@ -1,6 +1,6 @@
 # Firebase Cloud Messaging (FCM) for Android and iOS
 
-[![Gem Version](https://badge.fury.io/rb/fcm.svg)](http://badge.fury.io/rb/fcm) [![Build Status](https://secure.travis-ci.org/spacialdb/fcm.png?branch=master)](http://travis-ci.org/spacialdb/fcm)
+[![Gem Version](https://badge.fury.io/rb/fcm.svg)](http://badge.fury.io/rb/fcm) [![Build Status](https://secure.travis-ci.org/spacialdb/fcm.svg?branch=master)](http://travis-ci.org/spacialdb/fcm)
 
 The FCM gem lets your ruby backend send notifications to Android and iOS devices via [
 Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/).
@@ -19,12 +19,10 @@ gem 'fcm'
 
 For Android you will need a device running 2.3 (or newer) that also have the Google Play Store app installed, or an emulator running Android 2.3 with Google APIs. iOS devices are also supported.
 
-One of the following, tested Ruby versions:
 
-- `2.0.0`
-- `2.1.9`
-- `2.2.5`
-- `2.3.1`
+A version of supported Ruby, currently:  
+`ruby >= 2.4`
+
 
 ## Usage
 
@@ -43,12 +41,11 @@ fcm = FCM.new("my_server_key")
 
 registration_ids= ["12", "13"] # an array of one or more client registration tokens
 
-# See https://developers.google.com/cloud-messaging/http for all available options.
+# See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages for all available options.
 options = { "notification": {
               "title": "Portugal vs. Denmark",
-              "text": "5 to 1"
-          },
-          "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
+              "body": "5 to 1"
+          }
 }
 response = fcm.send(registration_ids, options)
 ```
@@ -104,14 +101,14 @@ FCM [topic messaging](https://firebase.google.com/docs/cloud-messaging/topic-mes
 
 ```ruby
 response = fcm.send_with_notification_key("/topics/yourTopic",
-            data: {message: "This is a FCM Topic Message!"})
+            notification: {body: "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!"})
+            notification: {body: "This is a FCM Topic Message!"})
 ```
 
 ### Sending to Multiple Topics
@@ -140,8 +137,8 @@ The `send_to_topic_condition` method within this library allows you to specicy a
 ```ruby
 response = fcm.send_to_topic_condition(
   "'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)",
-  data: {
-    message: "This is an FCM Topic Message sent to a condition!"
+  notification: {
+    body: "This is an FCM Topic Message sent to a condition!"
   }
 )
 ```
@@ -173,6 +170,18 @@ You can find a guide to implement an Android Client app to receive notifications
 The guide to set up an iOS app to get notifications is here: [Setting up a FCM Client App on iOS](https://firebase.google.com/docs/cloud-messaging/ios/client).
 
 ## ChangeLog
+### 1.0.2
+
+- Bug fix: retrieve notification key" params: https://github.com/spacialdb/fcm/commit/b328a75c11d779a06d0ceda83527e26aa0495774
+
+### 1.0.0
+
+- Bumped supported ruby to `>= 2.4`
+- Fix deprecation warnings from `faraday` by changing dependency version to `faraday 1.0.0`
+
+### 0.0.7
+
+- replace `httparty` with `faraday`
 
 ### 0.0.2
 
@@ -191,8 +200,15 @@ The guide to set up an iOS app to get notifications is here: [Setting up a FCM C
 
 - [Contributors](https://github.com/spacialdb/fcm/contributors)
 
-## Donations
+## Cutting a release
 
-We accept tips through [Gratipay](https://gratipay.com/spacialdb/).
+Update version in `fcm.gemspec` with `VERSION` and update `README.md` `## ChangeLog` section.
 
-[![Gratipay](https://img.shields.io/gratipay/spacialdb.svg)](https://www.gittip.com/spacialdb/)
+```bash
+# set the version
+# VERSION="1.0.2"
+gem build fcm.gemspec
+gem push fcm-${VERSION}.gem
+git tag -a v${VERSION} -m "Releasing version v${VERSION}"
+git push origin --tags
+```

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.5"
+  s.version     = "1.0.2"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Kashif Rasul", "Shoaib Burq"]
   s.email       = ["kashif@spacialdb.com", "shoaib@spacialdb.com"]
@@ -12,14 +12,12 @@ Gem::Specification.new do |s|
   s.description = %q{fcm provides ruby bindings to Firebase Cloud Messaging (FCM) a cross-platform messaging solution that lets you reliably deliver messages and notifications at no cost to Android, iOS or Web browsers.}
   s.license     = "MIT"
 
-  s.required_ruby_version     = '>= 2.0.0'
-
-  s.rubyforge_project = "fcm"
+  s.required_ruby_version     = '>= 2.4.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency('httparty', '~> 0.1')
+  s.add_runtime_dependency('faraday', '~> 1.0.0')
 end

data/lib/fcm.rb

@@ -1,16 +1,15 @@
-require 'httparty'
+require 'faraday'
 require 'cgi'
 require 'json'
 
 class FCM
-  include HTTParty
-  base_uri 'https://fcm.googleapis.com/fcm'
-  default_timeout 30
-  format :json
+  BASE_URI = 'https://fcm.googleapis.com'
+  DEFAULT_TIMEOUT = 30
+  FORMAT = :json
 
   # constants
-  GROUP_NOTIFICATION_BASE_URI = 'https://android.googleapis.com/gcm'
-  INSTANCE_ID_API = 'https://iid.googleapis.com/iid/v1'
+  GROUP_NOTIFICATION_BASE_URI = 'https://android.googleapis.com'
+  INSTANCE_ID_API = 'https://iid.googleapis.com'
   TOPIC_REGEX = /[a-zA-Z0-9\-_.~%]+/
 
   attr_accessor :timeout, :api_key
@@ -35,15 +34,10 @@ class FCM
   def send_notification(registration_ids, options = {})
     post_body = build_post_body(registration_ids, options)
 
-    params = {
-      body: post_body.to_json,
-      headers: {
-        'Authorization' => "key=#{@api_key}",
-        'Content-Type' => 'application/json'
-      }
-    }
-    response = self.class.post('/send', params.merge(@client_options))
-    build_response(response, registration_ids)
+    for_uri(BASE_URI) do |connection|
+      response = connection.post('/fcm/send', post_body.to_json)
+      build_response(response, registration_ids)
+    end
   end
   alias send send_notification
 
@@ -51,22 +45,14 @@ class FCM
     post_body = build_post_body(registration_ids, operation: 'create',
                                 notification_key_name: key_name)
 
-    params = {
-      body: post_body.to_json,
-      headers: {
-        'Content-Type' => 'application/json',
-        'project_id' => project_id,
-        'Authorization' => "key=#{@api_key}"
-      }
+    extra_headers = {
+      'project_id' => project_id
     }
 
-    response = nil
-
-    for_uri(GROUP_NOTIFICATION_BASE_URI) do
-      response = self.class.post('/notification', params.merge(@client_options))
+    for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
+      response = connection.post('/gcm/notification', post_body.to_json)
+      build_response(response)
     end
-
-    build_response(response)
   end
   alias create create_notification_key
 
@@ -75,21 +61,14 @@ class FCM
                                 notification_key_name: key_name,
                                 notification_key: notification_key)
 
-    params = {
-      body: post_body.to_json,
-      headers: {
-        'Content-Type' => 'application/json',
-        'project_id' => project_id,
-        'Authorization' => "key=#{@api_key}"
-      }
+    extra_headers = {
+      'project_id' => project_id
     }
 
-    response = nil
-
-    for_uri(GROUP_NOTIFICATION_BASE_URI) do
-      response = self.class.post('/notification', params.merge(@client_options))
+    for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
+      response = connection.post('/gcm/notification', post_body.to_json)
+      build_response(response)
     end
-    build_response(response)
   end
   alias add add_registration_ids
 
@@ -98,42 +77,28 @@ class FCM
                                 notification_key_name: key_name,
                                 notification_key: notification_key)
 
-    params = {
-      body: post_body.to_json,
-      headers: {
-        'Content-Type' => 'application/json',
-        'project_id' => project_id,
-        'Authorization' => "key=#{@api_key}"
-      }
+    extra_headers = {
+      'project_id' => project_id
     }
 
-    response = nil
-
-    for_uri(GROUP_NOTIFICATION_BASE_URI) do
-      response = self.class.post('/notification', params.merge(@client_options))
+    for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
+      response = connection.post('/gcm/notification', post_body.to_json)
+      build_response(response)
     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}"
-      }
+    params = {notification_key_name: key_name}
+      
+    extra_headers = {
+      'project_id' => project_id
     }
 
-    response = nil
-
-    for_uri(GROUP_NOTIFICATION_BASE_URI) do
-      response = self.class.get('/notification', params.merge(@client_options))
+    for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
+      response = connection.get('/gcm/notification', params)
+      build_response(response)
     end
-    build_response(response)
   end
 
   def send_with_notification_key(notification_key, options = {})
@@ -142,20 +107,10 @@ class FCM
   end
 
   def topic_subscription(topic, registration_id)
-    params = {
-      headers: {
-          'Authorization' => "key=#{@api_key}",
-          'Content-Type' => 'application/json'
-      }
-    }
-
-    response = nil
-
-    for_uri(INSTANCE_ID_API) do
-      response = self.class.post("/#{registration_id}/rel/topics/#{topic}", params)
+    for_uri(INSTANCE_ID_API) do |connection|
+      response = connection.post("/iid/v1/#{registration_id}/rel/topics/#{topic}")
+      build_response(response)
     end
-
-    build_response(response)
   end
 
   def batch_topic_subscription(topic, registration_ids)
@@ -168,31 +123,46 @@ class FCM
 
   def manage_topics_relationship(topic, registration_ids, action)
     body = { to: "/topics/#{topic}", registration_tokens: registration_ids }
-    params = {
-        body: body.to_json,
-        headers: {
-            'Authorization' => "key=#{@api_key}",
-            'Content-Type' => 'application/json'
-        }
-    }
 
-    response = nil
-
-    for_uri(INSTANCE_ID_API) do
-      response = self.class.post("/:batch#{action}", params)
+    for_uri(INSTANCE_ID_API) do |connection|
+      response = connection.post("/iid/v1:batch#{action}", body.to_json)
+      build_response(response)
     end
-
-    build_response(response)
   end
 
-
-
   def send_to_topic(topic, options = {})
     if topic.gsub(TOPIC_REGEX, "").length == 0
       send_with_notification_key('/topics/' + topic, options)
     end
   end
 
+  def get_instance_id_info iid_token, options={}
+    params = {
+      query: options
+    }
+    
+    for_uri(INSTANCE_ID_API) do |connection|
+      response = connection.get('/iid/info/'+iid_token, params)
+      build_response(response)
+    end
+  end
+
+  def subscribe_instance_id_to_topic iid_token, topic_name
+    batch_subscribe_instance_ids_to_topic([iid_token], topic_name)
+  end
+
+  def unsubscribe_instance_id_from_topic iid_token, topic_name
+    batch_unsubscribe_instance_ids_from_topic([iid_token], topic_name)
+  end
+
+  def batch_subscribe_instance_ids_to_topic instance_ids, topic_name
+    manage_topics_relationship(topic_name, instance_ids, 'Add')
+  end
+
+  def batch_unsubscribe_instance_ids_from_topic instance_ids, topic_name
+    manage_topics_relationship(topic_name, instance_ids, 'Remove')
+  end
+
   def send_to_topic_condition(condition, options = {})
     if validate_condition?(condition)
       body = { condition: condition }.merge(options)
@@ -202,11 +172,16 @@ 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
+  def for_uri(uri, extra_headers = {})
+    connection = ::Faraday.new(:url => uri) do |faraday|
+      faraday.adapter  Faraday.default_adapter
+      faraday.headers["Content-Type"] = "application/json"
+      faraday.headers["Authorization"] = "key=#{api_key}"
+      extra_headers.each do |key, value|
+        faraday.headers[key] = value
+      end
+    end
+    yield connection
   end
 
   def build_post_body(registration_ids, options = {})
@@ -216,8 +191,8 @@ class FCM
 
   def build_response(response, registration_ids = [])
     body = response.body || {}
-    response_hash = { body: body, headers: response.headers, status_code: response.code }
-    case response.code
+    response_hash = { body: body, headers: response.headers, status_code: response.status }
+    case response.status
     when 200
       response_hash[:response] = 'success'
       body = JSON.parse(body) unless body.empty?
@@ -260,16 +235,10 @@ class FCM
   end
 
   def execute_notification(body)
-    params = {
-      body: body.to_json,
-      headers: {
-        'Authorization' => "key=#{@api_key}",
-        'Content-Type' => 'application/json'
-      }
-    }
-
-    response = self.class.post('/send', params.merge(@client_options))
-    build_response(response)
+    for_uri(BASE_URI) do |connection|
+      response = connection.post('/fcm/send', body.to_json)
+      build_response(response)
+    end
   end
 
   def has_canonical_id?(result)

data/spec/fcm_spec.rb

@@ -1,8 +1,8 @@
 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(:send_url) { "#{FCM::BASE_URI}/fcm/send" }
+  let(:group_notification_base_uri) { "#{FCM::GROUP_NOTIFICATION_BASE_URI}/gcm/notification" }
   let(:api_key) { 'AIzaSyB-1uEai2WiUapxCs2Q0GZYzPu7Udno5aA' }
   let(:registration_id) { '42' }
   let(:registration_ids) { ['42'] }
@@ -254,7 +254,7 @@ describe FCM do
 
         it 'should not send notification due to 599' do
           subject.send(registration_ids).should eq(body: '{"body-key" => "Body value"}',
-                                                   headers: { 'header-key' => ['Header value'] },
+                                                   headers: { 'header-key' => 'Header value' },
                                                    response: 'There was an internal error in the FCM server while trying to process the request.',
                                                    status_code: 599)
         end
@@ -472,6 +472,25 @@ describe FCM do
     end # remove context
   end
 
+  describe "#recover_notification_key" do
+    it "sends a 'retrieve notification key' request" do
+      uri = "#{FCM::GROUP_NOTIFICATION_BASE_URI}/gcm/notification"
+      endpoint = stub_request(:get, uri).with(
+        headers: {
+          'Content-Type' => 'application/json',
+          'Authorization' => "key=TEST_SERVER_KEY",
+          'project_id' => "TEST_PROJECT_ID"
+        },
+        query: {notification_key_name: "TEST_KEY_NAME"}
+      )
+      client = FCM.new("TEST_SERVER_KEY")
+
+      client.recover_notification_key("TEST_KEY_NAME", "TEST_PROJECT_ID")
+
+      expect(endpoint).to have_been_requested
+    end
+  end
+
   describe 'subscribing to a topic' do
     # TODO
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fcm
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.2
 platform: ruby
 authors:
 - Kashif Rasul
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.0.0
 description: fcm provides ruby bindings to Firebase Cloud Messaging (FCM) a cross-platform
   messaging solution that lets you reliably deliver messages and notifications at
   no cost to Android, iOS or Web browsers.
@@ -58,15 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: fcm
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Reliably deliver messages and notifications via FCM