fcmpush 0.1.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eff608513cb7687d9cca8c68084dcfd5be1ca90c4037d62988bbd641bf988387
-  data.tar.gz: 6a48e86e369b7aa8864be4106ea0914a59d6d10c72d0d3c7399061686f7fdad2
+  metadata.gz: a58a38f4ef75e8d95b3806d811c72901a8c36b6deb339d0add0733fec54a6712
+  data.tar.gz: f97502ea7319cda995cde93901dc392e3530d13aff30d6385c9f76302b751722
 SHA512:
-  metadata.gz: 71a1906f8a7abe5f8d84144ff4bbc37d635224448563aac8b619383751f2a9fed4bdb71fedcc909e63fe4f590b2cdc6d42c12b641f6d33492b3885485f5ce286
-  data.tar.gz: 0f451566f5ca7174c72f3434f15b541b8ae44136202d7e211f684a869aa6e2d979a55dbb26339adfd2ba05e019c00ecb1565feaba4c4962a3dfa6d10c1d523be
+  metadata.gz: 23b20f5aef8feede77ccbc519a6abfb70932055b0a761b4ea2d29418d54dd8820d0b34b6e1292ac5c4f72f6c29de92cc7dd5f6bc1672970692f7bdcb7bf5a10a
+  data.tar.gz: e17f9cba6b6053229f6fff77678e20fbe132dfe837b684b732656a4701db98a9a5381bf44733b8f096ce72b9af587f35b6b4a8139bb16d2f635937445bb57e05

data/.rubocop.yml

@@ -6,3 +6,6 @@ Metrics/LineLength:
 
 Style/Documentation:
   Enabled: false
+
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods

data/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in fcmpush.gemspec
 gemspec
 
+gem 'activesupport', '< 6.0'
 gem 'pry-byebug'

data/Gemfile.lock

@@ -1,17 +1,23 @@
 PATH
   remote: .
   specs:
-    fcmpush (0.1.2)
+    fcmpush (0.9.0)
       googleauth (>= 0.10.0)
       net-http-persistent (>= 3.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     byebug (11.0.1)
     coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     connection_pool (2.2.2)
     diff-lcs (1.3)
     faraday (0.17.0)
@@ -23,9 +29,12 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.12)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
     jwt (2.2.1)
     memoist (0.16.0)
     method_source (0.9.2)
+    minitest (5.12.2)
     multi_json (1.13.1)
     multipart-post (2.1.1)
     net-http-persistent (3.1.0)
@@ -57,11 +66,15 @@ GEM
       faraday (~> 0.9)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (< 6.0)
   bundler (~> 2.0)
   fcmpush!
   pry-byebug

data/README.md

@@ -1,7 +1,7 @@
 # Fcmpush [![Build Status](https://travis-ci.org/miyataka/fcmpush.svg?branch=master)](https://travis-ci.org/miyataka/fcmpush)
 
-Fcmpush is an Firebase Cloud Messaging(FCM) Client. It implements [FCM HTTP v1 API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages).
-This gem supports HTTP v1 API only, **NOT supported [legacy HTTP protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref)**, because both authentication method is different.
+Fcmpush is an Firebase Cloud Messaging(FCM) Client. It implements [FCM HTTP v1 API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages), including **Auto Refresh** access_token feature!!
+This gem supports HTTP v1 API only, **NOT supported [legacy HTTP protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref)**.
 
 fcmpush is highly inspired by [andpush gem](https://github.com/yuki24/andpush).
 
@@ -26,6 +26,7 @@ Or install it yourself as:
 on Rails, config/initializers/fcmpush.rb
 ```ruby
 Fcmpush.configure do |config|
+  ## for message push
   # firebase web console => project settings => service account => firebase admin sdk => generate new private key
   config.json_key_io = "#{Rails.root}/path/to/service_account_credentials.json"
 
@@ -33,12 +34,19 @@ Fcmpush.configure do |config|
   # ENV['GOOGLE_ACCOUNT_TYPE'] = 'service_account'
   # ENV['GOOGLE_CLIENT_ID'] = '000000000000000000000'
   # ENV['GOOGLE_CLIENT_EMAIL'] = 'xxxx@xxxx.iam.gserviceaccount.com'
-  # ENV['GOOGLE_PRIVATE_KEY'] = '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n\
+  # ENV['GOOGLE_PRIVATE_KEY'] = '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n\'
+
+  ## for topic subscribe/unsubscribe because they use regacy auth
+  # firebase web console => project settings => cloud messaging => Project credentials => Server key
+  config.server_key = 'your firebase server key'
+  # Or set environment variables
+  # ENV['FCM_SERVER_KEY'] = 'your firebase server key'
 end
 ```
 
 for more detail. see [here](https://github.com/googleapis/google-auth-library-ruby#example-service-account).
 
+### push message
 ```ruby
 require 'fcmpush'
 
@@ -62,9 +70,24 @@ json = response.json
 json[:name] # => "projects/[your_project_id]/messages/0:1571037134532751%31bd1c9631bd1c96"
 ```
 
+### topic subscribe/unsubscribe
+```ruby
+require 'fcmpush'
+
+project_id   = "..." # Your project_id
+topic = "your_topic_name"
+device_tokens = ["device_tokenA", "device_tokenB", ...] # The device tokens of the device you'd like to subscribe
+
+client  = Fcmpush.new(project_id)
+
+response = client.subscribe(topic, device_tokens)
+# response = client.unsubscribe(topic, device_tokens)
+
+json = response.json
+json[:results] # => [{}, {"error":"NOT_FOUND"}, ...]  ref. https://developers.google.com/instance-id/reference/server#example_result_3
+```
+
 ## Future Work
-- topic subscribe/unsubscribe
-- auto refresh access_token before expiry
 - [DEV] compare other gems
 
 ## Contributing

data/lib/fcmpush.rb

@@ -3,14 +3,11 @@ require 'googleauth'
 
 require 'fcmpush/configuration'
 require 'fcmpush/version'
-require 'fcmpush/exceptions'
-require 'fcmpush/json_response'
+require 'fcmpush/client'
 
 module Fcmpush
   class Error < StandardError; end
   DOMAIN = 'https://fcm.googleapis.com'.freeze
-  V1_ENDPOINT_PREFIX = '/v1/projects/'.freeze
-  V1_ENDPOINT_SUFFIX = '/messages:send'.freeze
 
   class << self
     def build(project_id, domain: nil)
@@ -30,60 +27,4 @@ module Fcmpush
   def self.configure(&block)
     yield(configuration(&block))
   end
-
-  class Client
-    attr_reader :domain, :path, :connection, :access_token, :configuration
-
-    def initialize(domain, project_id, configuration, **options)
-      @domain = domain
-      @project_id = project_id
-      @path = V1_ENDPOINT_PREFIX + project_id.to_s + V1_ENDPOINT_SUFFIX
-      @options = {}.merge(options)
-      @configuration = configuration
-      @access_token = authorize
-      @connection = Net::HTTP::Persistent.new
-    end
-
-    def authorize
-      @auth ||= if configuration.json_key_io
-                  Google::Auth::ServiceAccountCredentials.make_creds(
-                    json_key_io: File.open(configuration.json_key_io),
-                    scope: configuration.scope
-                  )
-                else
-                  # from ENV
-                  Google::Auth::ServiceAccountCredentials.make_creds(
-                    scope: configuration.scope
-                  )
-                end
-      @auth.fetch_access_token!['access_token']
-    end
-
-    def push(body, query: {}, headers: {})
-      uri = URI.join(domain, path)
-      uri.query = URI.encode_www_form(query) unless query.empty?
-
-      headers = authorized_header(headers)
-      post = Net::HTTP::Post.new(uri, headers)
-      post.body = body.is_a?(String) ? body : body.to_json
-
-      response = exception_handler(connection.request(uri, post))
-      JsonResponse.new(response)
-    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
-      raise NetworkError, "A network error occurred: #{e.class} (#{e.message})"
-    end
-
-    def authorized_header(headers)
-      headers.merge('Content-Type' => 'application/json',
-                    'Accept' => 'application/json',
-                    'Authorization' => "Bearer #{access_token}")
-    end
-
-    def exception_handler(response)
-      error = STATUS_TO_EXCEPTION_MAPPING[response.code]
-      raise error.new("Receieved an error response #{response.code} #{error.to_s.split('::').last}: #{response.body}", response) if error
-
-      response
-    end
-  end
 end

data/lib/fcmpush/client.rb

@@ -0,0 +1,125 @@
+require 'fcmpush/exceptions'
+require 'fcmpush/json_response'
+
+module Fcmpush
+  V1_ENDPOINT_PREFIX = '/v1/projects/'.freeze
+  V1_ENDPOINT_SUFFIX = '/messages:send'.freeze
+  TOPIC_DOMAIN = 'https://iid.googleapis.com'.freeze
+  TOPIC_ENDPOINT_PREFIX = '/iid/v1'.freeze
+
+  class Client
+    attr_reader :domain, :path, :connection, :configuration, :server_key, :access_token, :access_token_expiry
+
+    def initialize(domain, project_id, configuration, **options)
+      @domain = domain
+      @project_id = project_id
+      @path = V1_ENDPOINT_PREFIX + project_id.to_s + V1_ENDPOINT_SUFFIX
+      @options = {}.merge(options)
+      @configuration = configuration
+      access_token_response = v1_authorize
+      @access_token = access_token_response['access_token']
+      @access_token_expiry = Time.now.utc + access_token_response['expires_in']
+      @server_key = configuration.server_key
+      @connection = Net::HTTP::Persistent.new
+    end
+
+    def v1_authorize
+      @auth ||= if configuration.json_key_io
+                  Google::Auth::ServiceAccountCredentials.make_creds(
+                    json_key_io: File.open(configuration.json_key_io),
+                    scope: configuration.scope
+                  )
+                else
+                  # from ENV
+                  Google::Auth::ServiceAccountCredentials.make_creds(scope: configuration.scope)
+                end
+      @auth.fetch_access_token
+    end
+
+    def push(body, query: {}, headers: {})
+      uri, request = make_push_request(body, query, headers)
+      response = exception_handler(connection.request(uri, request))
+      JsonResponse.new(response)
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+      raise NetworkError, "A network error occurred: #{e.class} (#{e.message})"
+    end
+
+    def subscribe(topic, *instance_ids, query: {}, headers: {})
+      uri, request = make_subscription_request(topic, *instance_ids, :subscribe, query, headers)
+      response = exception_handler(connection.request(uri, request))
+      JsonResponse.new(response)
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+      raise NetworkError, "A network error occurred: #{e.class} (#{e.message})"
+    end
+
+    def unsubscribe(topic, *instance_ids, query: {}, headers: {})
+      uri, request = make_subscription_request(topic, *instance_ids, :unsubscribe, query, headers)
+      response = exception_handler(connection.request(uri, request))
+      JsonResponse.new(response)
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+      raise NetworkError, "A network error occurred: #{e.class} (#{e.message})"
+    end
+
+    private
+
+      def make_push_request(body, query, headers)
+        uri = URI.join(domain, path)
+        uri.query = URI.encode_www_form(query) unless query.empty?
+
+        access_token_refresh
+        headers = v1_authorized_header(headers)
+        post = Net::HTTP::Post.new(uri, headers)
+        post.body = body.is_a?(String) ? body : body.to_json
+
+        [uri, post]
+      end
+
+      def make_subscription_request(topic, instance_ids, type, query, headers)
+        suffix = type == :subscribe ? ':batchAdd' : ':batchRemove'
+
+        uri = URI.join(TOPIC_DOMAIN, TOPIC_ENDPOINT_PREFIX + suffix)
+        uri.query = URI.encode_www_form(query) unless query.empty?
+
+        headers = legacy_authorized_header(headers)
+        post = Net::HTTP::Post.new(uri, headers)
+        post.body = make_subscription_body(topic, *instance_ids)
+
+        [uri, post]
+      end
+
+      def access_token_refresh
+        return if access_token_expiry > Time.now.utc + 300
+
+        access_token_response = v1_authorize
+        @access_token = access_token_response['access_token']
+        @access_token_expiry = Time.now.utc + access_token_response['expires_in']
+      end
+
+      def v1_authorized_header(headers)
+        headers.merge('Content-Type' => 'application/json',
+                      'Accept' => 'application/json',
+                      'Authorization' => "Bearer #{access_token}")
+      end
+
+      def legacy_authorized_header(headers)
+        headers.merge('Content-Type' => 'application/json',
+                      'Accept' => 'application/json',
+                      'Authorization' => "Bearer key=#{server_key}")
+      end
+
+      def exception_handler(response)
+        error = STATUS_TO_EXCEPTION_MAPPING[response.code]
+        raise error.new("Receieved an error response #{response.code} #{error.to_s.split('::').last}: #{response.body}", response) if error
+
+        response
+      end
+
+      def make_subscription_body(topic, *instance_ids)
+        topic = topic.match?(%r{^/topics/}) ? topic : '/topics/' + topic
+        {
+          to: topic,
+          registration_tokens: instance_ids
+        }.to_json
+      end
+  end
+end

data/lib/fcmpush/configuration.rb

@@ -1,6 +1,6 @@
 module Fcmpush
   class Configuration
-    attr_accessor :scope, :json_key_io
+    attr_accessor :scope, :json_key_io, :server_key
 
     def initialize
       @scope = ['https://www.googleapis.com/auth/firebase.messaging']
@@ -13,6 +13,9 @@ module Fcmpush
       # ENV['GOOGLE_CLIENT_ID'] = '000000000000000000000'
       # ENV['GOOGLE_CLIENT_EMAIL'] = 'xxxx@xxxx.iam.gserviceaccount.com'
       # ENV['GOOGLE_PRIVATE_KEY'] = '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n'
+
+      # regacy auth
+      @server_key = ENV['FCM_SERVER_KEY']
     end
   end
 end

data/lib/fcmpush/version.rb

@@ -1,3 +1,3 @@
 module Fcmpush
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fcmpush
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Takayuki Miyahara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -100,6 +100,7 @@ files:
 - bin/setup
 - fcmpush.gemspec
 - lib/fcmpush.rb
+- lib/fcmpush/client.rb
 - lib/fcmpush/configuration.rb
 - lib/fcmpush/exceptions.rb
 - lib/fcmpush/json_response.rb