fcm 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a9acc9e72359d421c740b5ac8ce3c9547a587a1e08672931a51355523b27a0
-  data.tar.gz: 250eb8a97008cc4affc39a512695c5cf9339baa35de77854169746ed80fcf7c3
+  metadata.gz: 2802aecc49a82a5fedf980c9cdf38c3a429f0ebfa358efef7b4fbb0097ac8295
+  data.tar.gz: a124f4d7b09930550d58993807e4a6c5944279c47e16f51b90c18fab7b5f54a5
 SHA512:
-  metadata.gz: 0beb8691a1a5dc0090ce92cb584c1f44aa97545de9f45d649a65b2ac4cd2196db8178ace4675a7f39deca00bcb8650fb4a9e71569b609f24aa6942fa88e08c2c
-  data.tar.gz: e079ef26d913c7e418e89943cedc980034f03d49cc749c681ee8e4e237fe6a2a059342f012c235a84d2ba227fa8941671e9834350beea5ce93e6ee7341f2aa49
+  metadata.gz: aacdfb6460c7ce30f990119219ddaa6ef5fc3ad33efe0f8bed5095df5f4435ec93aeac604f91031a9e9db58a4b19e3499fddbc9bc230e6c6b51c20557a283015
+  data.tar.gz: 684c306d874a14909f7f3dd3f95355aba895a9680e2eede3fb6b9b5b568636be09e639d3cfdaf17278cab9d157954b6b917bff6f974762a56ed003641a8be8f7

data/README.md

@@ -274,6 +274,12 @@ The guide to set up an iOS app to get notifications is here: [Setting up a FCM C
 
 ## ChangeLog
 
+### 2.0.2
+- Ensure JSON key path is an actual file or IO object before opening [#134](https://github.com/spacialdb/fcm/pull/134)
+
+### 2.0.1
+- Add `http_options` to `initialize` method and whitelist `timeout` option
+
 ### 2.0.0
 #### Breaking Changes
 - Remove deprecated `API_KEY`

data/fcm.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name = "fcm"
-  s.version = "2.0.0"
+  s.version = "2.0.2"
   s.platform = Gem::Platform::RUBY
   s.authors = ["Kashif Rasul", "Shoaib Burq"]
   s.email = ["kashif@decision-labs.com", "shoaib@decision-labs.com"]

data/lib/fcm.rb

@@ -4,6 +4,8 @@ require "json"
 require "googleauth"
 
 class FCM
+  class InvalidCredentialError < StandardError; end
+
   BASE_URI = "https://fcm.googleapis.com"
   BASE_URI_V1 = "https://fcm.googleapis.com/v1/projects/"
   DEFAULT_TIMEOUT = 30
@@ -12,9 +14,10 @@ class FCM
   INSTANCE_ID_API = "https://iid.googleapis.com"
   TOPIC_REGEX = /[a-zA-Z0-9\-_.~%]+/
 
-  def initialize(json_key_path = "", project_name = "")
+  def initialize(json_key_path = "", project_name = "", http_options = {})
     @json_key_path = json_key_path
     @project_name = project_name
+    @http_options = http_options
   end
 
   # See https://firebase.google.com/docs/cloud-messaging/send-message
@@ -192,7 +195,7 @@ class FCM
   def for_uri(uri, extra_headers = {})
     connection = ::Faraday.new(
       url: uri,
-      request: { timeout: DEFAULT_TIMEOUT }
+      request: { timeout: @http_options.fetch(:timeout, DEFAULT_TIMEOUT) }
     ) do |faraday|
       faraday.adapter Faraday.default_adapter
       faraday.headers["Content-Type"] = "application/json"
@@ -290,11 +293,31 @@ class FCM
     token["access_token"]
   end
 
+  def raise_credentials_error(param)
+    error_msg = 'credentials must be an IO-like ' \
+      'object or path. You passed'
+
+    param_klass = param.nil? ? 'nil' : "a #{param.class.name}"
+    error_msg += " #{param_klass}."
+    raise InvalidCredentialError, error_msg
+  end
+
+  def valid_json_key_path?(path)
+    valid_io_object = path.respond_to?(:open)
+    return true if valid_io_object && File.file?(path)
+
+    max_path_len = 1024
+    valid_path = path.is_a?(String) && path.length <= max_path_len
+    valid_path && File.file?(path)
+  end
+
   def json_key
     @json_key ||= if @json_key_path.respond_to?(:read)
                     @json_key_path
-                  else
+                  elsif valid_json_key_path?(@json_key_path)
                     File.open(@json_key_path)
+                  else
+                    raise_credentials_error(@json_key_path)
                   end
   end
 end

data/spec/fcm_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require 'tempfile'
 
 describe FCM do
   let(:project_name) { 'test-project' }
@@ -13,27 +14,105 @@ describe FCM do
     }
   end
 
+  let(:client_email) do
+    '83315528762cf7e0-7bbcc3aad87e0083391bc7f234d487' \
+    'c8@developer.gserviceaccount.com'
+  end
+
+  let(:client_x509_cert_url) do
+    'https://www.googleapis.com/robot/v1/metadata/x509/' \
+    'fd6b61037dd2bb8585527679" + "-7bbcc3aad87e0083391b' \
+    'c7f234d487c8%40developer.gserviceaccount.com'
+  end
+
+  let(:large_file_name) do
+    Array.new(1021) { 'a' }.join('') + '.txt'
+  end
+
+  let(:creds_error) do
+    FCM::InvalidCredentialError
+  end
+
+  let(:json_credentials) do
+    {
+      "type": 'service_account',
+      "project_id": 'example',
+      "private_key_id": 'c09c4593eee53707ca9f4208fbd6fe72b29fc7ab',
+      "private_key": OpenSSL::PKey::RSA.new(2048).to_s,
+      "client_email": client_email,
+      "client_id": 'acedc3c0a63b3562376386f0.apps.googleusercontent.com',
+      "auth_uri": 'https://accounts.google.com/o/oauth2/auth',
+      "token_uri": 'https://oauth2.googleapis.com/token',
+      "auth_provider_x509_cert_url": 'https://www.googleapis.com/oauth2/v1/certs',
+      "client_x509_cert_url": client_x509_cert_url,
+      "universe_domain": 'googleapis.com'
+    }.to_json
+  end
+
   before do
     allow(client).to receive(:json_key)
 
     # Mock the Google::Auth::ServiceAccountCredentials
-    allow(Google::Auth::ServiceAccountCredentials).to receive(:make_creds).
-      and_return(double(fetch_access_token!: { 'access_token' => mock_token }))
+    allow(Google::Auth::ServiceAccountCredentials).to receive(:make_creds)
+      .and_return(double(fetch_access_token!: { 'access_token' => mock_token }))
   end
 
-  it "should initialize" do
+  it 'should initialize' do
     expect { client }.not_to raise_error
   end
 
   describe "credentials path" do
-    it "can be a path to a file" do
+    it 'can be a path to a file' do
       fcm = FCM.new("README.md")
       expect(fcm.__send__(:json_key).class).to eq(File)
     end
 
-    it "can be an IO object" do
-      fcm = FCM.new(StringIO.new("hey"))
+    it 'raises an error when passed a large path' do
+      expect do
+        FCM.new(large_file_name).__send__(:json_key)
+      end.to raise_error(creds_error)
+    end
+
+    it 'can be an IO object' do
+      fcm = FCM.new(StringIO.new('hey'))
       expect(fcm.__send__(:json_key).class).to eq(StringIO)
+
+      temp_file = Tempfile.new('hello_world.json')
+      temp_file.write(json_credentials)
+      fcm_with_temp_file = FCM.new(temp_file)
+
+      expect do
+        fcm_with_temp_file
+      end.not_to raise_error
+      temp_file.close
+      temp_file.unlink
+    end
+
+    it 'raises an error when passed a non IO-like object' do
+      expect do
+        FCM.new(nil, '', {}).__send__(:json_key)
+      end.to raise_error(creds_error, 'credentials must be' \
+      ' an IO-like object or path. You passed nil.')
+
+      expect do
+        FCM.new(json_credentials, '', {}).__send__(:json_key)
+      end.to raise_error(creds_error, 'credentials must be' \
+      ' an IO-like object or path. You passed a String.')
+
+      expect do
+        FCM.new({}, '', {}).__send__(:json_key)
+      end.to raise_error(creds_error, 'credentials must be' \
+      ' an IO-like object or path. You passed a Hash.')
+    end
+
+    it 'raises an error when passed a non-existent credentials file path' do
+      fcm = FCM.new('spec/fake_credentials.json', '', {})
+      expect { fcm.__send__(:json_key) }.to raise_error(creds_error)
+    end
+
+    it 'raises an error when passed a string of a file that does not exist' do
+      fcm = FCM.new('example.txt', '', {})
+      expect { fcm.__send__(:json_key) }.to raise_error(creds_error)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fcm
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Kashif Rasul
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2026-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday