fcm 0.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d92dc29d8a781ef45a9e3cd113fe834a3a41b63
-  data.tar.gz: e3413daa3b418bfbc0631ffdf79f653950599f25
+SHA256:
+  metadata.gz: 16615f79f5432e2a352dc3c26e42d48efed7727a86f04f2b9d2bf93cca47aae6
+  data.tar.gz: d2fe30204d7ef51288014fbcc2df5f211ea8d8b4dbbc28cb9af0d9fadc54d6c7
 SHA512:
-  metadata.gz: 994687542f81b3d11b403d71dde8097a1990445c66249922215da103cff7737d44ee30d99537676cf2695f5606d2837cbb45cfdf59aed2b8c7649290450bf9a1
-  data.tar.gz: 1516e659f3c1d7180a77ac177e0f79e4f45d9d471d0f22434533657de07d9de4c29855baf66dcbee003cf9c3b1ac6976ac8a543ca9e75a07b1d9fd04297dfb59
+  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,15 +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.9`
-- `2.2.5`
-- `2.3.1`
+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:
@@ -36,19 +77,14 @@ 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://developers.google.com/cloud-messaging/http 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",
-              "text": "5 to 1"
-          },
-          "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
+              "body": "5 to 1"
+          }
 }
 response = fcm.send(registration_ids, options)
 ```
@@ -104,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
@@ -140,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!"
   }
 )
 ```
@@ -174,11 +210,41 @@ 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`
+
 ### 0.0.2
 
 - Fixed group messaging url.
 - Added API to `recover_notification_key`.
 
+
 ### 0.0.1
 
 - Initial version.
@@ -191,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.6"
-  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('httparty', '~> 0.10', '>= 0.10.0')
+  s.add_runtime_dependency("faraday", ">= 1.0.0", "< 3.0")
+  s.add_runtime_dependency("googleauth", "~> 1")
 end