firebase-admin 0.1.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9693687c6c5f815855662c55897a1f9fc1b44f9e21b2887fa3f843f630613959
-  data.tar.gz: 1ea223a2eb707350eee44de4b46d115537d961986bc6b7bc513cbe4eba56d6ab
+  metadata.gz: 20dc769e214cf7c48d6b86d37bd17d0b806fada175e90e538fb728645d31e3ea
+  data.tar.gz: 885264043ab60ad951e9b9ddb2785e2d9710523ce1d342b82851899a720f362d
 SHA512:
-  metadata.gz: c57e26695001a4be8cdec4a8850bfa6b0e49e5b33215c7163612b31805d28cc936e771f65333af1b0d219a706fe2ccb8fe65d952ed55a10a1d9929d868486154
-  data.tar.gz: 2d35835dccdddb45c97604f11bf79c24f03c714e96b1d3ec969bac8320499ed126f210b54e1ae02e966d93d85ec59f301da3bbb05b84e9de8eb6a07450f87fcf
+  metadata.gz: 5c2f316c8753ab8e3855e45f08fa0355c40cb31a9bf4127de53f4d51761f801b1ed2c8313d7c4b19cfc597e1b4f2680259d4193d60bfd2a836d6d3c06adf7058
+  data.tar.gz: d79b0c5cff44a1de0b96474680f88440ddfe9c5942045437a63e1b6346961371d6cf1866331fbfa078f7b281351c219e962c351906b2309c2556024baf38e5dc

data/.gitignore

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    firebase-admin (0.1.6)
+    firebase-admin (0.3.0)
       addressable (~> 2.7)
       faraday (~> 1.3)
       faraday_middleware (~> 1.0)
@@ -85,6 +85,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -95,4 +96,4 @@ DEPENDENCIES
   webmock (~> 3.11)
 
 BUNDLED WITH
-   2.2.22
+   2.3.17

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

@@ -63,6 +63,20 @@ module FirebaseAdmin
         post("v1/projects/#{project_id}/accounts:update", params)
       end
 
+      # DELETES the account completely from firebase. Once deleted we can retreive the account
+      # Need to be used cautiously
+      #
+      # @return 200 OK
+      # @see https://firebase.google.com/docs/reference/rest/auth
+      #
+      # @param localId [String] profile ID
+      def delete_account(localId)
+        params = {'localId': localId}
+        path = "v1/projects/#{project_id}/accounts:delete"
+        post path, params
+      end
+
+
       # Sign in with a password
       #
       # @param params [Hash] A customizable set of params
@@ -117,6 +131,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 +150,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 +187,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/version.rb

@@ -1,3 +1,3 @@
 module FirebaseAdmin
-  VERSION = '0.1.6'.freeze unless defined?(::FirebaseAdmin::VERSION)
+  VERSION = '0.3.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)
@@ -37,14 +35,31 @@ describe FirebaseAdmin::Client do
     end
   end
 
+  describe '.delete_account' do
+    before do
+      stub_post('v1/projects/test-project/accounts:delete')
+        .to_return(body: fixture('delete_account.json'), headers: { content_type: 'application/json; charset=utf-8' })
+    end
+
+    it 'should post to the  delete endpoint' do
+      client.delete_account('local-id')
+      expect(
+        a_post('v1/projects/test-project/accounts:delete')
+          .with(body: { localId: 'local-id'}.to_json)
+          .with(headers: { 'Authorization' => 'Bearer owner' })
+      ).to have_been_made
+    end
+  end
+
   describe '.create_custom_token' 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 +68,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 +86,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 +101,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

data/spec/fixtures/delete_account.json

@@ -0,0 +1 @@
+{ "kind": "identitytoolkit#DeleteAccountResponse"}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase-admin
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Colin Harris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -185,6 +185,7 @@ files:
 - spec/fixtures/400_error.json
 - spec/fixtures/bad_gateway.html
 - spec/fixtures/create_account.json
+- spec/fixtures/delete_account.json
 - spec/fixtures/example_key
 - spec/fixtures/gateway_timeout.html
 - spec/fixtures/google_credentials.json
@@ -223,6 +224,7 @@ test_files:
 - spec/fixtures/400_error.json
 - spec/fixtures/bad_gateway.html
 - spec/fixtures/create_account.json
+- spec/fixtures/delete_account.json
 - spec/fixtures/example_key
 - spec/fixtures/gateway_timeout.html
 - spec/fixtures/google_credentials.json