fcm 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d92dc29d8a781ef45a9e3cd113fe834a3a41b63
-  data.tar.gz: e3413daa3b418bfbc0631ffdf79f653950599f25
+SHA256:
+  metadata.gz: 4200d68170fc0c8cee514824e77244e51fc68802dc8ad6a34a1c592c11f36a71
+  data.tar.gz: a70490fb7e92cf2ea66e53ba1cb58a5c8caad45b8d6bbbf1335bc13c3e49c774
 SHA512:
-  metadata.gz: 994687542f81b3d11b403d71dde8097a1990445c66249922215da103cff7737d44ee30d99537676cf2695f5606d2837cbb45cfdf59aed2b8c7649290450bf9a1
-  data.tar.gz: 1516e659f3c1d7180a77ac177e0f79e4f45d9d471d0f22434533657de07d9de4c29855baf66dcbee003cf9c3b1ac6976ac8a543ca9e75a07b1d9fd04297dfb59
+  metadata.gz: a5d276a776ddd9eed746f16e129c1820e27361e99fa3e6c6f8be14af04561a8f4dd520d4296bf632d31bb1269b4a8817e18bb3938d8992d736503e310dfbd8cb
+  data.tar.gz: 7049ded384b5df8a097addbd96cce01ca559ddb6a61b8ec27e2f5fe06d7d4d70d0009b4d7bfa240dfe84598acfb917ce735ec4b8c6a71e072108d4ed1d6cc629

data/README.md

@@ -22,9 +22,11 @@ For Android you will need a device running 2.3 (or newer) that also have the Goo
 One of the following, tested Ruby versions:
 
 - `2.0.0`
-- `2.1.9`
-- `2.2.5`
-- `2.3.1`
+- `2.1.10`
+- `2.2.10`
+- `2.3.8`
+- `2.4.5`
+- `2.5.3`
 
 ## Usage
 
@@ -43,12 +45,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)
 ```
@@ -174,6 +175,10 @@ The guide to set up an iOS app to get notifications is here: [Setting up a FCM C
 
 ## ChangeLog
 
+### 0.0.7
+
+- replace `httparty` with `faraday`
+
 ### 0.0.2
 
 - Fixed group messaging url.

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.6"
+  s.version     = "0.0.7"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Kashif Rasul", "Shoaib Burq"]
   s.email       = ["kashif@spacialdb.com", "shoaib@spacialdb.com"]
@@ -21,5 +21,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency('httparty', '~> 0.10', '>= 0.10.0')
+  s.add_runtime_dependency('faraday','0.15.4')
 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,21 +77,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 remove remove_registration_ids
 
@@ -120,20 +92,17 @@ class FCM
     params = {
       query: {
         notification_key_name: key_name
-      },
-      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.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 +111,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 +127,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 +176,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 +195,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 +239,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fcm
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Kashif Rasul
@@ -9,28 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2020-02-29 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.10'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.4
 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.
@@ -71,8 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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