fcm 0.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4200d68170fc0c8cee514824e77244e51fc68802dc8ad6a34a1c592c11f36a71
-  data.tar.gz: a70490fb7e92cf2ea66e53ba1cb58a5c8caad45b8d6bbbf1335bc13c3e49c774
+  metadata.gz: 16615f79f5432e2a352dc3c26e42d48efed7727a86f04f2b9d2bf93cca47aae6
+  data.tar.gz: d2fe30204d7ef51288014fbcc2df5f211ea8d8b4dbbc28cb9af0d9fadc54d6c7
 SHA512:
-  metadata.gz: a5d276a776ddd9eed746f16e129c1820e27361e99fa3e6c6f8be14af04561a8f4dd520d4296bf632d31bb1269b4a8817e18bb3938d8992d736503e310dfbd8cb
-  data.tar.gz: 7049ded384b5df8a097addbd96cce01ca559ddb6a61b8ec27e2f5fe06d7d4d70d0009b4d7bfa240dfe84598acfb917ce735ec4b8c6a71e072108d4ed1d6cc629
+  metadata.gz: 06c32340bae1ab25e1d66c06d63fa5d7276214604902218a1a9f5cf06774a60a08ab4bc700616f63ed5563a8b106227ef073168fcbfa29798348fadec2480767
+  data.tar.gz: ffa28e382feba7728e496318ea546237c9c5070ccc175d71a2dc83e9adf0a58efa932336a729549599978b6a2406ec01e80bd060997f779631d3a53122660b59

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      - name: Run tests
+        run: |
+          bundle exec rspec

data/.gitignore

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

data/Gemfile

@@ -5,3 +5,4 @@ gem 'rake'
 gem 'rspec'
 gem 'webmock'
 gem 'ci_reporter_rspec'
+gem 'googleauth'

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://github.com/decision-labs/fcm/workflows/Tests/badge.svg)](https://github.com/decision-labs/fcm/actions)
 
 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,17 +19,56 @@ 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.10`
-- `2.2.10`
-- `2.3.8`
-- `2.4.5`
-- `2.5.3`
+A version of supported Ruby, currently:
+`ruby >= 2.4`
 
 ## Usage
 
+## HTTP v1 API
+
+To migrate to HTTP v1 see: https://firebase.google.com/docs/cloud-messaging/migrate-v1
+
+```ruby
+fcm = FCM.new(
+  API_TOKEN,
+  GOOGLE_APPLICATION_CREDENTIALS_PATH,
+  FIREBASE_PROJECT_ID
+)
+message = {
+  'topic': "89023", # OR token if you want to send to a specific device
+  # 'token': "000iddqd",
+  'data': {
+    payload: {
+      data: {
+        id: 1
+      }
+    }.to_json
+  },
+  'notification': {
+    title: notification.title_th,
+    body: notification.body_th,
+  },
+  'android': {},
+  'apns': {
+    payload: {
+      aps: {
+        sound: "default",
+        category: "#{Time.zone.now.to_i}"
+      }
+    }
+  },
+  'fcm_options': {
+    analytics_label: 'Label'
+  }
+}
+
+fcm.send_v1(message)
+```
+
+## HTTP Legacy Version
+
+To migrate to HTTP v1 see: https://firebase.google.com/docs/cloud-messaging/migrate-v1
+
 For your server to send a message to one or more devices, you must first initialise a new `FCM` class with your Firebase Cloud Messaging server key, and then call the `send` method on this and give it 1 or more (up to 1000) registration tokens as an array of strings. You can also optionally send further [HTTP message parameters](https://firebase.google.com/docs/cloud-messaging/http-server-ref) like `data` or `time_to_live` etc. as a hash via the second optional argument to `send`.
 
 Example sending notifications:
@@ -38,14 +77,10 @@ Example sending notifications:
 require 'fcm'
 
 fcm = FCM.new("my_server_key")
-# you can set option parameters in here
-#  - all options are pass to HTTParty method arguments
-#  - ref: https://github.com/jnunemaker/httparty/blob/master/lib/httparty.rb#L29-L60
-#  fcm = FCM.new("my_server_key", timeout: 3)
 
 registration_ids= ["12", "13"] # an array of one or more client registration tokens
 
-# See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages for all available options.
+# See https://firebase.google.com/docs/cloud-messaging/http-server-ref for all available options.
 options = { "notification": {
               "title": "Portugal vs. Denmark",
               "body": "5 to 1"
@@ -105,14 +140,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
@@ -141,8 +176,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!"
   }
 )
 ```
@@ -175,6 +210,31 @@ The guide to set up an iOS app to get notifications is here: [Setting up a FCM C
 
 ## ChangeLog
 
+### 1.0.8
+- caches calls to `Google::Auth::ServiceAccountCredentials` #103
+- Allow `faraday` versions from 1 up to 2  #101
+
+### 1.0.7
+
+- Fix passing `DEFAULT_TIMEOUT` to `faraday` [#96](https://github.com/decision-labs/fcm/pull/96)
+- Fix issue with `get_instance_id_info` option params [#98](https://github.com/decision-labs/fcm/pull/98)
+- Accept any IO object for credentials [#95](https://github.com/decision-labs/fcm/pull/94)
+
+Huge thanks to @excid3 @jsparling @jensljungblad
+
+### 1.0.3
+
+- Fix overly strict faraday dependency
+
+### 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`
@@ -184,6 +244,7 @@ The guide to set up an iOS app to get notifications is here: [Setting up a FCM C
 - Fixed group messaging url.
 - Added API to `recover_notification_key`.
 
+
 ### 0.0.1
 
 - Initial version.
@@ -196,8 +257,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.7"
+gem build fcm.gemspec
+git tag -a v${VERSION} -m "Releasing version v${VERSION}"
+git push origin --tags
+gem push fcm-${VERSION}.gem
+```

data/fcm.gemspec

@@ -2,24 +2,23 @@
 $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name        = "fcm"
-  s.version     = "0.0.7"
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Kashif Rasul", "Shoaib Burq"]
-  s.email       = ["kashif@spacialdb.com", "shoaib@spacialdb.com"]
-  s.homepage    = "https://github.com/spacialdb/fcm"
-  s.summary     = %q{Reliably deliver messages and notifications via FCM}
+  s.name = "fcm"
+  s.version = "1.0.8"
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Kashif Rasul", "Shoaib Burq"]
+  s.email = ["kashif@decision-labs.com", "shoaib@decision-labs.com"]
+  s.homepage = "https://github.com/decision-labs/fcm"
+  s.summary = %q{Reliably deliver messages and notifications via FCM}
   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.license = "MIT"
 
-  s.required_ruby_version     = '>= 2.0.0'
+  s.required_ruby_version = ">= 2.4.0"
 
-  s.rubyforge_project = "fcm"
-
-  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.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('faraday','0.15.4')
+  s.add_runtime_dependency("faraday", ">= 1.0.0", "< 3.0")
+  s.add_runtime_dependency("googleauth", "~> 1")
 end

data/lib/fcm.rb

@@ -1,24 +1,71 @@
-require 'faraday'
-require 'cgi'
-require 'json'
+require "faraday"
+require "cgi"
+require "json"
+require "googleauth"
 
 class FCM
-  BASE_URI = 'https://fcm.googleapis.com'
+  BASE_URI = "https://fcm.googleapis.com"
+  BASE_URI_V1 = "https://fcm.googleapis.com/v1/projects/"
   DEFAULT_TIMEOUT = 30
   FORMAT = :json
 
   # constants
-  GROUP_NOTIFICATION_BASE_URI = 'https://android.googleapis.com'
-  INSTANCE_ID_API = 'https://iid.googleapis.com'
+  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
+  attr_accessor :timeout, :api_key, :json_key_path, :project_base_uri
 
-  def initialize(api_key, client_options = {})
+  def initialize(api_key, json_key_path = "", project_name = "", client_options = {})
     @api_key = api_key
     @client_options = client_options
+    @json_key_path = json_key_path
+    @project_base_uri = BASE_URI_V1 + project_name.to_s
   end
 
+  # See https://firebase.google.com/docs/cloud-messaging/send-message
+  # {
+  #   "token": "4sdsx",
+  #   "notification": {
+  #     "title": "Breaking News",
+  #     "body": "New news story available."
+  #   },
+  #   "data": {
+  #     "story_id": "story_12345"
+  #   },
+  #   "android": {
+  #     "notification": {
+  #       "click_action": "TOP_STORY_ACTIVITY",
+  #       "body": "Check out the Top Story"
+  #     }
+  #   },
+  #   "apns": {
+  #     "payload": {
+  #       "aps": {
+  #         "category" : "NEW_MESSAGE_CATEGORY"
+  #       }
+  #     }
+  #   }
+  # }
+  # fcm = FCM.new(api_key, json_key_path, project_name)
+  # fcm.send(
+  #    { "token": "4sdsx",, "to" : "notification": {}.. }
+  # )
+  def send_notification_v1(message)
+    return if @project_base_uri.empty?
+
+    post_body = { 'message': message }
+
+    response = Faraday.post("#{@project_base_uri}/messages:send") do |req|
+      req.headers["Content-Type"] = "application/json"
+      req.headers["Authorization"] = "Bearer #{jwt_token}"
+      req.body = post_body.to_json
+    end
+    build_response(response)
+  end
+
+  alias send_v1 send_notification_v1
+
   # See https://developers.google.com/cloud-messaging/http for more details.
   # { "notification": {
   #  "title": "Portugal vs. Denmark",
@@ -35,72 +82,72 @@ class FCM
     post_body = build_post_body(registration_ids, options)
 
     for_uri(BASE_URI) do |connection|
-      response = connection.post('/fcm/send', post_body.to_json)
+      response = connection.post("/fcm/send", post_body.to_json)
       build_response(response, registration_ids)
     end
   end
+
   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)
 
     extra_headers = {
-      'project_id' => project_id
+      "project_id" => project_id,
     }
 
     for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
-      response = connection.post('/gcm/notification', post_body.to_json)
+      response = connection.post("/gcm/notification", post_body.to_json)
       build_response(response)
     end
   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)
 
     extra_headers = {
-      'project_id' => project_id
+      "project_id" => project_id,
     }
 
     for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
-      response = connection.post('/gcm/notification', post_body.to_json)
+      response = connection.post("/gcm/notification", post_body.to_json)
       build_response(response)
     end
   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)
 
     extra_headers = {
-      'project_id' => project_id
+      "project_id" => project_id,
     }
 
     for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
-      response = connection.post('/gcm/notification', post_body.to_json)
+      response = connection.post("/gcm/notification", post_body.to_json)
       build_response(response)
     end
   end
+
   alias remove remove_registration_ids
 
   def recover_notification_key(key_name, project_id)
-    params = {
-      query: {
-        notification_key_name: key_name
-      }
-    }
-      
+    params = { notification_key_name: key_name }
+
     extra_headers = {
-      'project_id' => project_id
+      "project_id" => project_id,
     }
 
     for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
-      response = connection.get('/gcm/notification', params)
+      response = connection.get("/gcm/notification", params)
       build_response(response)
     end
   end
@@ -118,11 +165,11 @@ class FCM
   end
 
   def batch_topic_subscription(topic, registration_ids)
-    manage_topics_relationship(topic, registration_ids, 'Add')
+    manage_topics_relationship(topic, registration_ids, "Add")
   end
 
   def batch_topic_unsubscription(topic, registration_ids)
-    manage_topics_relationship(topic, registration_ids, 'Remove')
+    manage_topics_relationship(topic, registration_ids, "Remove")
   end
 
   def manage_topics_relationship(topic, registration_ids, action)
@@ -136,35 +183,33 @@ class FCM
 
   def send_to_topic(topic, options = {})
     if topic.gsub(TOPIC_REGEX, "").length == 0
-      send_with_notification_key('/topics/' + topic, options)
+      send_with_notification_key("/topics/" + topic, options)
     end
   end
 
-  def get_instance_id_info iid_token, options={}
-    params = {
-      query: options
-    }
-    
+  def get_instance_id_info(iid_token, options = {})
+    params = options
+
     for_uri(INSTANCE_ID_API) do |connection|
-      response = connection.get('/iid/info/'+iid_token, params)
+      response = connection.get("/iid/info/" + iid_token, params)
       build_response(response)
     end
   end
 
-  def subscribe_instance_id_to_topic iid_token, topic_name
+  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
+  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')
+  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')
+  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 = {})
@@ -177,8 +222,11 @@ class FCM
   private
 
   def for_uri(uri, extra_headers = {})
-    connection = ::Faraday.new(:url => uri) do |faraday|
-      faraday.adapter  Faraday.default_adapter
+    connection = ::Faraday.new(
+      url: uri,
+      request: { timeout: DEFAULT_TIMEOUT }
+    ) 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|
@@ -198,18 +246,18 @@ class FCM
     response_hash = { body: body, headers: response.headers, status_code: response.status }
     case response.status
     when 200
-      response_hash[:response] = 'success'
+      response_hash[:response] = "success"
       body = JSON.parse(body) unless body.empty?
       response_hash[:canonical_ids] = build_canonical_ids(body, registration_ids) unless registration_ids.empty?
       response_hash[:not_registered_ids] = build_not_registered_ids(body, registration_ids) unless registration_ids.empty?
     when 400
-      response_hash[:response] = 'Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields.'
+      response_hash[:response] = "Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields."
     when 401
-      response_hash[:response] = 'There was an error authenticating the sender account.'
+      response_hash[:response] = "There was an error authenticating the sender account."
     when 503
-      response_hash[:response] = 'Server is temporarily unavailable.'
+      response_hash[:response] = "Server is temporarily unavailable."
     when 500..599
-      response_hash[:response] = 'There was an internal error in the FCM server while trying to process the request.'
+      response_hash[:response] = "There was an internal error in the FCM server while trying to process the request."
     end
     response_hash
   end
@@ -217,9 +265,9 @@ class FCM
   def build_canonical_ids(body, registration_ids)
     canonical_ids = []
     unless body.empty?
-      if body['canonical_ids'] > 0
-        body['results'].each_with_index do |result, index|
-          canonical_ids << { old: registration_ids[index], new: result['registration_id'] } if has_canonical_id?(result)
+      if body["canonical_ids"] > 0
+        body["results"].each_with_index do |result, index|
+          canonical_ids << { old: registration_ids[index], new: result["registration_id"] } if has_canonical_id?(result)
         end
       end
     end
@@ -229,8 +277,8 @@ class FCM
   def build_not_registered_ids(body, registration_id)
     not_registered_ids = []
     unless body.empty?
-      if body['failure'] > 0
-        body['results'].each_with_index do |result, index|
+      if body["failure"] > 0
+        body["results"].each_with_index do |result, index|
           not_registered_ids << registration_id[index] if is_not_registered?(result)
         end
       end
@@ -240,17 +288,17 @@ class FCM
 
   def execute_notification(body)
     for_uri(BASE_URI) do |connection|
-      response = connection.post('/fcm/send', body.to_json)
+      response = connection.post("/fcm/send", body.to_json)
       build_response(response)
     end
   end
 
   def has_canonical_id?(result)
-    !result['registration_id'].nil?
+    !result["registration_id"].nil?
   end
 
   def is_not_registered?(result)
-    result['error'] == 'NotRegistered'
+    result["error"] == "NotRegistered"
   end
 
   def validate_condition?(condition)
@@ -269,4 +317,22 @@ class FCM
     topics = condition.scan(/(?:^|\S|\s)'([^']*?)'(?:$|\S|\s)/).flatten
     topics.all? { |topic| topic.gsub(TOPIC_REGEX, "").length == 0 }
   end
+
+  def jwt_token
+    scope = "https://www.googleapis.com/auth/firebase.messaging"
+    @authorizer ||= Google::Auth::ServiceAccountCredentials.make_creds(
+      json_key_io: json_key,
+      scope: scope,
+    )
+    token = @authorizer.fetch_access_token!
+    token["access_token"]
+  end
+
+  def json_key
+    @json_key ||= if @json_key_path.respond_to?(:read)
+                    @json_key_path
+                  else
+                    File.open(@json_key_path)
+                  end
+  end
 end