firebase-admin 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e0160923e857a6f2bb9010287cdc66fc7f7b06f10ed9644a13d8423f06ed417
-  data.tar.gz: 469ed074842e19e352ec98c0e1232c85eed7dd56464e33a7b7669f6a7e35c619
+  metadata.gz: e17ee3117fba2303b9994810707260adc620a0df6856fafcab5f2d91ae73d198
+  data.tar.gz: 1b8cb745fdcb281555ba1210ae46de28d88adbe32fd0a3eb4f28b4dffa0bf579
 SHA512:
-  metadata.gz: 634a6bb2e8ccb27851b527859e98460b9fa2b101ff24ec87fbcff5843474529d2fa71f0c20794659ab9938dda3e891cb6c2fda9116ffb00969c0b6ef00e2faf6
-  data.tar.gz: 8eb5c88f3b47ec5f0a8aff837d5c6db40d6ae890a70e39b0cfcb024b6dd443da449a6091dbcbe19091d255870a8edc3fa40240b8c7d5e07be453b8f7f3c97b67
+  metadata.gz: 3b477554cecc66c68eca389b9a6b1b1b406e3279c73fab7be20c1435f53e688338c8df6093e7ea2196a27ef21b82335ff7345cbb15670b2bc33b187fd76d94f6
+  data.tar.gz: eeb3c9e88e13fb973c051d3c8d389f0870b48fb27f372ab36733a0f51247291499afaee4a971c2a18ef2068aa5fd4fc619983a985550d5b6ab96e4443ad4b091

data/.gitignore

@@ -1,3 +1,6 @@
 firebase-admin.iml
 out
 coverage
+vendor/bundle
+.idea
+.run

data/Gemfile.lock

@@ -1,43 +1,57 @@
 PATH
   remote: .
   specs:
-    firebase-admin (0.1.4)
+    firebase-admin (0.2.0)
       addressable (~> 2.7)
       faraday (~> 1.3)
       faraday_middleware (~> 1.0)
       hashie (~> 4.1)
-      jwt (~> 2.2.2)
+      jwt (>= 2.2)
       multi_json (~> 1.15)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    faraday (1.3.0)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
     faraday-net_http (1.0.1)
-    faraday_middleware (1.0.0)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
     hashie (4.1.0)
-    jwt (2.2.2)
+    jwt (2.3.0)
     multi_json (1.15.0)
     multipart-post (2.1.1)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.21.0)
+    parser (3.0.3.1)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -50,27 +64,28 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.9.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.14.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
-    unicode-display_width (2.0.0)
-    webmock (3.11.2)
-      addressable (>= 2.3.6)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -81,4 +96,4 @@ DEPENDENCIES
   webmock (~> 3.11)
 
 BUNDLED WITH
-   2.2.6
+   2.3.17

data/firebase-admin.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('faraday_middleware', '~> 1.0')
   s.add_runtime_dependency('hashie',  '~> 4.1')
   s.add_runtime_dependency('multi_json', '~> 1.15')
-  s.add_runtime_dependency('jwt', '~> 2.2.2')
+  s.add_runtime_dependency('jwt', '>= 2.2')
   s.authors = ['Colin Harris']
   s.description = 'A Ruby wrapper for the Firebase Admin APIs'
   s.email = ['colin@jiva.ag']

data/lib/firebase-admin/client/accounts.rb

@@ -117,6 +117,16 @@ module FirebaseAdmin
       # @example
       #   FirebaseAdmin.create_custom_token('...')
       def create_custom_token(uid)
+        if service_account_email.nil? || service_account_email == ''
+          raise InvalidCredentials,
+                "No client email provided via options, 'GOOGLE_APPLICATION_CREDENTIALS' or 'GOOGLE_CLIENT_EMAIL'"
+        end
+
+        if service_account_private_key.nil? || service_account_private_key == ''
+          raise InvalidCredentials,
+                "No private key provided via options, 'GOOGLE_APPLICATION_CREDENTIALS' or 'GOOGLE_PRIVATE_KEY'"
+        end
+
         now_seconds = Time.now.to_i
         payload = {
           iss: service_account_email,
@@ -126,7 +136,7 @@ module FirebaseAdmin
           exp: now_seconds + (60 * 60), # Maximum expiration time is one hour
           uid: uid
         }
-        JWT.encode(payload, private_key, 'RS256')
+        JWT.encode(payload, OpenSSL::PKey::RSA.new(unescape(service_account_private_key)), 'RS256')
       end
 
       # Get user by email/phone/uid
@@ -163,42 +173,6 @@ module FirebaseAdmin
         str = str[1..-2] if str.start_with?('"') && str.end_with?('"')
         str
       end
-
-      def service_account_email
-        email = default_credentials.fetch('client_email') { ENV['GOOGLE_CLIENT_EMAIL'] }
-        if email.nil? || email == ''
-          raise InvalidCredentials,
-                "No client email provided via 'GOOGLE_APPLICATION_CREDENTIALS' or 'GOOGLE_CLIENT_EMAIL'"
-        end
-
-        email
-      end
-
-      def private_key
-        key = default_credentials.fetch('private_key') { unescape(ENV['GOOGLE_PRIVATE_KEY']) }
-        if key.nil? || key == ''
-          raise InvalidCredentials,
-                "No private key provided via 'GOOGLE_APPLICATION_CREDENTIALS' or 'GOOGLE_PRIVATE_KEY'"
-        end
-
-        OpenSSL::PKey::RSA.new(key)
-      end
-
-      def default_credentials
-        @default_credentials ||= read_default_credentials
-      end
-
-      def read_default_credentials
-        credentials_path = ENV['GOOGLE_APPLICATION_CREDENTIALS']
-        if credentials_path && File.exist?(credentials_path)
-          JSON.parse(File.read(credentials_path))
-        else
-          {}
-        end
-      rescue StandardError => e
-        raise InvalidCredentials,
-              "Failed reading credentials from '#{ENV['GOOGLE_APPLICATION_CREDENTIALS']}'. Error: #{e.message}"
-      end
     end
   end
 end

data/lib/firebase-admin/configuration.rb

@@ -13,6 +13,8 @@ module FirebaseAdmin
       user_agent
       project_id
       loud_logger
+      service_account_email
+      service_account_private_key
     ].freeze
 
     # By default, don't set a user access token
@@ -47,6 +49,18 @@ module FirebaseAdmin
     # @private
     attr_accessor(*VALID_OPTIONS_KEYS)
 
+    def service_account_email
+      @service_account_email ||= service_account_credentials.fetch('client_email') do
+        ENV['GOOGLE_CLIENT_EMAIL']
+      end
+    end
+
+    def service_account_private_key
+      @service_account_private_key ||= service_account_credentials.fetch('private_key') do
+        ENV['GOOGLE_PRIVATE_KEY']
+      end
+    end
+
     # When this module is extended, set all configuration options to their default values
     def self.extended(base)
       base.reset
@@ -64,6 +78,23 @@ module FirebaseAdmin
       end
     end
 
+    def service_account_credentials
+      return {} unless ENV['GOOGLE_APPLICATION_CREDENTIALS']
+
+      @service_account_credentials ||= read_service_account_credentials(ENV['GOOGLE_APPLICATION_CREDENTIALS'])
+    end
+
+    def read_service_account_credentials(credentials_path)
+      if credentials_path && File.exist?(credentials_path)
+        JSON.parse(File.read(credentials_path))
+      else
+        {}
+      end
+    rescue StandardError => e
+      raise InvalidCredentials,
+            "Failed reading credentials from '#{ENV['GOOGLE_APPLICATION_CREDENTIALS']}'. Error: #{e.message}"
+    end
+
     # Reset all configuration options to defaults
     def reset
       self.access_token       = DEFAULT_ACCESS_TOKEN
@@ -73,6 +104,9 @@ module FirebaseAdmin
       self.user_agent         = DEFAULT_USER_AGENT
       self.project_id         = DEFAULT_PROJECT_ID
       self.loud_logger        = DEFAULT_LOUD_LOGGER
+      @service_account_credentials = nil
+      self.service_account_email = nil
+      self.service_account_private_key = nil
     end
   end
 end

data/lib/firebase-admin/connection.rb

@@ -17,7 +17,7 @@ module FirebaseAdmin
       }.merge(connection_options)
 
       Faraday::Connection.new(options) do |connection|
-        connection.authorization :Bearer, access_token if access_token
+        connection.request :authorization, 'Bearer', access_token if access_token
         connection.use Faraday::Request::UrlEncoded
         connection.use FaradayMiddleware::Mashify
         connection.use Faraday::Response::ParseJson

data/lib/firebase-admin/version.rb

@@ -1,3 +1,3 @@
 module FirebaseAdmin
-  VERSION = '0.1.4'.freeze unless defined?(::FirebaseAdmin::VERSION)
+  VERSION = '0.2.0'.freeze unless defined?(::FirebaseAdmin::VERSION)
 end

data/spec/firebase-admin/api_spec.rb

@@ -34,7 +34,9 @@ describe FirebaseAdmin::API do
           endpoint: 'http://tumblr.com/',
           user_agent: 'Custom User Agent',
           project_id: 'test-project',
-          loud_logger: true
+          loud_logger: true,
+          service_account_email: 'example@gmail.com',
+          service_account_private_key: '===private key==='
         }
       end
 

data/spec/firebase-admin/client/accounts_spec.rb

@@ -1,9 +1,7 @@
 require File.expand_path('../../spec_helper', __dir__)
 
 describe FirebaseAdmin::Client do
-  before do
-    @client = FirebaseAdmin::Client.new(project_id: 'test-project')
-  end
+  let(:client) { FirebaseAdmin::Client.new(project_id: 'test-project') }
 
   describe '.create_account' do
     before do
@@ -12,7 +10,7 @@ describe FirebaseAdmin::Client do
     end
 
     it 'should get the correct resource' do
-      @client.create_account(email: 'john@smith.com', password: 'supersecret')
+      client.create_account(email: 'john@smith.com', password: 'supersecret')
       expect(
         a_post('v1/projects/test-project/accounts')
           .with(body: { email: 'john@smith.com', password: 'supersecret' }.to_json)
@@ -28,7 +26,7 @@ describe FirebaseAdmin::Client do
     end
 
     it 'should post to the  update endpoint' do
-      @client.update_account(email: 'john@smith.com', password: 'supersecret')
+      client.update_account(email: 'john@smith.com', password: 'supersecret')
       expect(
         a_post('v1/projects/test-project/accounts:update')
           .with(body: { email: 'john@smith.com', password: 'supersecret' }.to_json)
@@ -41,10 +39,11 @@ describe FirebaseAdmin::Client do
     context 'when credentials are set via GOOGLE_APPLICATION_CREDENTIALS' do
       before do
         ENV['GOOGLE_APPLICATION_CREDENTIALS'] = fixture('google_credentials.json').path
+        FirebaseAdmin.reset
       end
 
       it 'returns a valid JWT token' do
-        token = @client.create_custom_token('user-123')
+        token = client.create_custom_token('user-123')
         token_data, _alg = JWT.decode(token, nil, false)
         expect(token_data['uid']).to eq('user-123')
       end
@@ -53,10 +52,13 @@ describe FirebaseAdmin::Client do
     context 'when GOOGLE_APPLICATION_CREDENTIALS points to an invalid file' do
       before do
         ENV['GOOGLE_APPLICATION_CREDENTIALS'] = fixture('google_credentials_invalid.json').path
+        FirebaseAdmin.reset
       end
 
       it 'raises an error' do
-        expect { @client.create_custom_token('user-123') }.to raise_error FirebaseAdmin::InvalidCredentials
+        expect {
+          client.create_custom_token('user-123')
+        }.to raise_error FirebaseAdmin::InvalidCredentials
       end
     end
 
@@ -68,10 +70,11 @@ describe FirebaseAdmin::Client do
         ENV['GOOGLE_APPLICATION_CREDENTIALS'] = nil
         ENV['GOOGLE_CLIENT_EMAIL'] = email
         ENV['GOOGLE_PRIVATE_KEY'] = private_key
+        FirebaseAdmin.reset
       end
 
       it 'returns a valid JWT token' do
-        token = @client.create_custom_token('user-123')
+        token = client.create_custom_token('user-123')
         token_data, _alg = JWT.decode(token, nil, false)
         expect(token_data['uid']).to eq('user-123')
       end
@@ -82,19 +85,22 @@ describe FirebaseAdmin::Client do
         ENV['GOOGLE_APPLICATION_CREDENTIALS'] = nil
         ENV['GOOGLE_CLIENT_EMAIL'] = nil
         ENV['GOOGLE_PRIVATE_KEY'] = nil
+        FirebaseAdmin.reset
       end
 
       it 'raises an error' do
-        expect { @client.create_custom_token('user-123') }.to raise_error FirebaseAdmin::InvalidCredentials
+        expect {
+          client.create_custom_token('user-123')
+        }.to raise_error FirebaseAdmin::InvalidCredentials
       end
     end
   end
 
   describe '.sign_in_for_uid' do
     it 'should post to the  update endpoint' do
-      expect(@client).to receive(:create_custom_token).with('user-123').and_return('token')
-      expect(@client).to receive(:sign_in_with_custom_token).with('token').and_return('result')
-      result = @client.sign_in_for_uid('user-123')
+      expect(client).to receive(:create_custom_token).with('user-123').and_return('token')
+      expect(client).to receive(:sign_in_with_custom_token).with('token').and_return('result')
+      result = client.sign_in_for_uid('user-123')
       expect(result).to eq('result')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase-admin
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Colin Harris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -140,16 +140,16 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
 description: A Ruby wrapper for the Firebase Admin APIs
 email:
 - colin@jiva.ag