fcmpush 1.2.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c7f11759745db6416a5b7b896e3ba7f1e69234cebd81ebb553b50fba9d01623
-  data.tar.gz: a8690c9c01c8f57975abf2fea467245cb2f8da5477bb26906b768ee6cd1f3c82
+  metadata.gz: a437176b9b06e22c8ccbfc7caed5603ff2fc331111c22dbfc585dceb782ab6f2
+  data.tar.gz: 250617403b4caa35cda5395fca5daef64649dd428e20c5f1e619561984bf8ef8
 SHA512:
-  metadata.gz: 40db8fe5c68788635395923d8cb710b88e20b8d229cab81c540ce73bf807ac214ce31c1da43ada246e17dd8af33d4284ee4c0c129ec01fc2292c39b25ecf8dc5
-  data.tar.gz: 6603ea073fb892b5c16593b484c85cf53de1e0ccf02b6e2b1989466f8047b00bc1b3e33b0f8f13e17961aa84cc3f3282a9ffc60a6dd2d76daf44c53d610f178e
+  metadata.gz: 5628699a3505d7dbc67c7b62fd90b15db6177f97dec2e1f979b4c6bb79b41496104af8325db819b3b83a354a3dec120d5e965b5eee7f5be5a945bba2da652923
+  data.tar.gz: 4cdbbde0ea2649e681756c9b66671cc60dfff34b062886dd22a01af8b39284a4ce202916f393aa3c92e64939f1302c31fd3ec002aa5c967fd7963e99b181f189

data/fcmpush.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3', '< 2.8'
+  spec.required_ruby_version = '>= 2.6', '< 3.5'
 
-  spec.add_dependency 'googleauth', '>= 0.9.0'
-  spec.add_dependency 'net-http-persistent', '>= 3.1.0'
+  spec.add_dependency 'google-apis-identitytoolkit_v3'
+  spec.add_dependency 'net-http-persistent', '~> 4.0.1'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13'

data/lib/fcmpush/client.rb

@@ -23,8 +23,25 @@ module Fcmpush
       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
+      # @server_key = configuration.server_key
       @connection = Net::HTTP::Persistent.new
+
+      @connection.open_timeout = configuration.open_timeout if configuration.open_timeout
+      @connection.read_timeout = configuration.read_timeout if configuration.read_timeout
+
+      if !configuration.proxy
+        # do nothing
+      elsif configuration.proxy == :ENV
+        @connection.proxy = :ENV
+      elsif configuration.proxy && configuration.proxy[:uri]
+        uri = URI(configuration.proxy[:uri])
+        # user name must not be a empty string, password can
+        if configuration.proxy[:user] && configuration.proxy[:user].strip != ''
+          uri.user = configuration.proxy[:user]
+          uri.password = configuration.proxy[:password] if configuration.proxy[:password]
+        end
+        @connection.proxy = uri
+      end
     end
 
     def v1_authorize
@@ -34,6 +51,7 @@ module Fcmpush
                        else
                          File.open(configuration.json_key_io)
                        end
+                  io.rewind if io.respond_to?(:read)
                   Google::Auth::ServiceAccountCredentials.make_creds(
                     json_key_io: io,
                     scope: configuration.scope
@@ -69,12 +87,15 @@ module Fcmpush
       raise NetworkError, "A network error occurred: #{e.class} (#{e.message})"
     end
 
+    #-------------------------------------------------------------------------------
+    # BATCH REQUESTS DEPRECATED BY GOOGLE ON June 20,2023 AND SHUTDOWN ON June 21, 2024
+    # https://firebase.google.com/support/faq/#fcm-depr-features
+    # 
+    # Until upgrading to use HTTP/2, warning and throwing error
+    #-------------------------------------------------------------------------------
     def batch_push(messages, query: {}, headers: {})
-      uri, request = make_batch_request(messages, query, headers)
-      response = exception_handler(connection.request(uri, request))
-      BatchResponse.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})"
+      warn '[DEPRECATION] `batch_push` is deprecated.  Please use `push` for each message instead.'
+      raise DeprecatedApiError, 'BATCH REQUESTS DEPRECATED BY GOOGLE ON June 20,2023 AND SHUTDOWN ON June 21, 2024 (https://firebase.google.com/support/faq/#fcm-depr-features)'
     end
 
     private
@@ -97,7 +118,10 @@ module Fcmpush
         uri = URI.join(TOPIC_DOMAIN, TOPIC_ENDPOINT_PREFIX + suffix)
         uri.query = URI.encode_www_form(query) unless query.empty?
 
-        headers = legacy_authorized_header(headers)
+        headers = v1_authorized_header(headers)
+        # cf. https://takanamito.hateblo.jp/entry/2020/07/04/175045
+        # cf. https://github.com/miyataka/fcmpush/issues/40
+        headers['access_token_auth'] = 'true'
         post = Net::HTTP::Post.new(uri, headers)
         post.body = make_subscription_body(topic, *instance_ids)
 
@@ -118,15 +142,17 @@ module Fcmpush
                       'Authorization' => "Bearer #{access_token}")
       end
 
+      # @deprecated TODO: remove this method next version
       def legacy_authorized_header(headers)
+        warn "[DEPRECATION] `legacy_authorized_header` is deprecated.  Please use `v1_authorized_header` instead."
         headers.merge('Content-Type' => 'application/json',
                       'Accept' => 'application/json',
-                      'Authorization' => "Bearer key=#{server_key}")
+                      'Authorization' => "Bearer #{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
+        raise error.new("Received an error response #{response.code} #{error.to_s.split('::').last}: #{response.body}", response) if error
 
         response
       end

data/lib/fcmpush/configuration.rb

@@ -1,6 +1,6 @@
 module Fcmpush
   class Configuration
-    attr_accessor :scope, :json_key_io, :server_key
+    attr_accessor :scope, :json_key_io, :server_key, :proxy, :open_timeout, :read_timeout
 
     def initialize
       @scope = ['https://www.googleapis.com/auth/firebase.messaging']
@@ -15,7 +15,21 @@ module Fcmpush
       # ENV['GOOGLE_PRIVATE_KEY'] = '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n'
 
       # regacy auth
+      # @deprecated TODO: remove this next version
       @server_key = ENV['FCM_SERVER_KEY']
+      if @server_key
+        warn '[DEPRECATION] `FCM_SERVER_KEY` environment variable, also @server_key is deprecated. This attribute will be removed next version.'
+      end
+
+      # THIS IS EXPERIMENTAL
+      # NOT support `HTTPS_PROXY` environment variable. This feature not tested well on CI.
+      # cf. https://github.com/miyataka/fcmpush/pull/39#issuecomment-1722533622
+      # proxy
+      @proxy = :ENV
+
+      # connection timeouts
+      @open_timeout = nil
+      @read_timeout = nil
     end
   end
 end

data/lib/fcmpush/exceptions.rb

@@ -1,5 +1,6 @@
 module Fcmpush
   class APIError < StandardError; end
+  class DeprecatedApiError < StandardError; end
   class NetworkError < APIError; end
 
   class HttpError < APIError

data/lib/fcmpush/version.rb

@@ -1,3 +1,3 @@
 module Fcmpush
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

metadata

@@ -1,43 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: fcmpush
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.5.0
 platform: ruby
 authors:
 - miyataka
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2025-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: googleauth
+  name: google-apis-identitytoolkit_v3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +79,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description:
 email:
 - voyager.3taka28@gmail.com
 executables: []
@@ -102,7 +100,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/miyataka/fcmpush
   source_code_uri: https://github.com/miyataka/fcmpush
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,18 +107,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '2.8'
+      version: '3.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Firebase Cloud Messaging API wrapper for ruby, supports HTTP v1. And including
   access_token Auto Refresh feature!