firebase-admin 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8ff8b5b882e80cee049010198961bde97f52c64dc5a5e6d5902bcab4dd40060
-  data.tar.gz: 35e4530ed48199101dd666743c959af4890b161e594545470a1a37dec02993ff
+  metadata.gz: cef0674854fe33d6dd681638d9827eb360c8125922afd84d717072f3d2c0a359
+  data.tar.gz: 2729536a92a94c68cf977b608c8f948c4af965280b3820b3012bb882e774142c
 SHA512:
-  metadata.gz: 54cd5fc99fd435c7f5151ca76b47456da8cdee6b38eaaf3afcb72048adb9219d329ceec054e1e8634881fd9326f8ddece9ea0d7801c686a509b11d2c269137b1
-  data.tar.gz: 5c117435a3122766517027c076faf2591cc5b66e38964e9e881d2f3bf64a0a9dd902ae572585d7bba2c2e7c681a9a169daf15e90e1a1a0f1cc62655794f70911
+  metadata.gz: dd2bba2ad71b970ad58d1f6eda5cc5a82d39ebb21bbb7b3756c021af9cc541d7653f6bef9e36380ed6cae5a86d9aec498e6c169daa5741b8a3532313ca32257a
+  data.tar.gz: 7aafdeb40669eb59443585d1627ac29d7233f90b7ef09f195a918866908956c132ce7f7578628ee814dda51cc8e2cc0fd82ff5531189cae95ccf8ecf8637e2ec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    firebase-admin (0.1.1)
+    firebase-admin (0.1.4)
       addressable (~> 2.7)
       faraday (~> 1.3)
       faraday_middleware (~> 1.0)
@@ -18,11 +18,25 @@ GEM
     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-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
@@ -63,7 +77,7 @@ GEM
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     unicode-display_width (2.0.0)
     webmock (3.11.2)
       addressable (>= 2.3.6)
@@ -81,4 +95,4 @@ DEPENDENCIES
   webmock (~> 3.11)
 
 BUNDLED WITH
-   2.2.6
+   2.2.22

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

@@ -93,6 +93,20 @@ module FirebaseAdmin
         post('v1/accounts:signInWithCustomToken', { token: token, returnSecureToken: true })
       end
 
+      # Sign in based on the UID of an account
+      # This generates a custom token for the UID and signs in using the custom token
+      #
+      # @param uid [String] The uid of a user
+      #
+      # @return [Resource] with idToken
+      #
+      # @example
+      #   FirebaseAdmin.sign_in_for_uid("...")
+      def sign_in_for_uid(uid)
+        custom_token = create_custom_token(uid)
+        sign_in_with_custom_token(custom_token)
+      end
+
       # Create a custom JWT token for a UID
       #
       # @param uid [String] The uid of a user
@@ -103,11 +117,6 @@ module FirebaseAdmin
       # @example
       #   FirebaseAdmin.create_custom_token('...')
       def create_custom_token(uid)
-        credentials = default_credentials
-
-        service_account_email = credentials.fetch('client_email', ENV['GOOGLE_CLIENT_EMAIL'])
-        private_key = OpenSSL::PKey::RSA.new credentials.fetch('private_key', unescape(ENV['GOOGLE_PRIVATE_KEY']))
-
         now_seconds = Time.now.to_i
         payload = {
           iss: service_account_email,
@@ -118,7 +127,6 @@ module FirebaseAdmin
           uid: uid
         }
         JWT.encode(payload, private_key, 'RS256')
-        JWT.decode()
       end
 
       # Get user by email/phone/uid
@@ -156,10 +164,40 @@ module FirebaseAdmin
         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
-        return {} if ENV['GOOGLE_APPLICATION_CREDENTIALS'].nil?
+        @default_credentials ||= read_default_credentials
+      end
 
-        JSON.parse(File.read(ENV['GOOGLE_APPLICATION_CREDENTIALS']))
+      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

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/error.rb

@@ -25,4 +25,7 @@ module FirebaseAdmin
 
   # Raised when Firebase returns the HTTP status code 429
   class RateLimitExceeded < Error; end
+
+  # Raised when no valid credentials are found
+  class InvalidCredentials < Error; end
 end

data/lib/firebase-admin/version.rb

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

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

@@ -20,4 +20,82 @@ describe FirebaseAdmin::Client do
       ).to have_been_made
     end
   end
+
+  describe '.update_account' do
+    before do
+      stub_post('v1/projects/test-project/accounts:update')
+        .to_return(body: fixture('update_account.json'), headers: { content_type: 'application/json; charset=utf-8' })
+    end
+
+    it 'should post to the  update endpoint' do
+      @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)
+          .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
+      end
+
+      it 'returns a valid JWT token' do
+        token = @client.create_custom_token('user-123')
+        token_data, _alg = JWT.decode(token, nil, false)
+        expect(token_data['uid']).to eq('user-123')
+      end
+    end
+
+    context 'when GOOGLE_APPLICATION_CREDENTIALS points to an invalid file' do
+      before do
+        ENV['GOOGLE_APPLICATION_CREDENTIALS'] = fixture('google_credentials_invalid.json').path
+      end
+
+      it 'raises an error' do
+        expect { @client.create_custom_token('user-123') }.to raise_error FirebaseAdmin::InvalidCredentials
+      end
+    end
+
+    context 'when credentials are set via GOOGLE_CLIENT_EMAIL / GOOGLE_PRIVATE_KEY' do
+      let(:email) { 'example@example.com' }
+      let(:private_key) { fixture('example_key').read }
+
+      before do
+        ENV['GOOGLE_APPLICATION_CREDENTIALS'] = nil
+        ENV['GOOGLE_CLIENT_EMAIL'] = email
+        ENV['GOOGLE_PRIVATE_KEY'] = private_key
+      end
+
+      it 'returns a valid JWT token' do
+        token = @client.create_custom_token('user-123')
+        token_data, _alg = JWT.decode(token, nil, false)
+        expect(token_data['uid']).to eq('user-123')
+      end
+    end
+
+    context 'when no credentials are provided' do
+      before do
+        ENV['GOOGLE_APPLICATION_CREDENTIALS'] = nil
+        ENV['GOOGLE_CLIENT_EMAIL'] = nil
+        ENV['GOOGLE_PRIVATE_KEY'] = nil
+      end
+
+      it 'raises an error' do
+        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(result).to eq('result')
+    end
+  end
 end

data/spec/fixtures/example_key

@@ -0,0 +1 @@
+-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDW04sWbA5qIYUQ\nLU+dVoEf0ipYYmu9/2Z+Teobkhd9f6ZQ++1a0hnpelIx3vulrO0uPU/CZIh75cPR\nl/UGg2wxB2QnQcznUCJylOKoV412L7nTauYolNkI71X95npQyQtP+i3E7mQHAEJc\nOqF+cd6ufH5KouKtkJvSioHVKMr1YWDAmCfvQdYQ9Chv4K3Fvr1yniFk7OqcB1Td\nf9XcMpCaC6XokOzgvZ0TbNoqG2ceR66E04J33nRenqiRv8I/jmzsvYb692CuzKEL\nf/F4eY8bnIRYrMgT+7qgBkLMbNN/7m95uoBvJASvosx9+Fp3h6q9DhdphyV0iFjL\nHtvFpH1PAgMBAAECggEACJhCEk2Ubg6VQkZtzv+s/tbrtsmJQfq74QXA/gVkRzMa\nNlc98cpCGyM3sqMXMlOu0ZDGZiKbi0lwAiywMuiDJZsEGMX7Kq38EtV+E/ocwMO8\nDYdTWgBKhp78s8HK1vyUJUj/F8fp3JXYEdSOrX5kyFpWuym1I/iLI2tDMoIFTLfb\n3+NGAZQti7jXO8HMPTBhTj9X4wunCHucc6zd7QwRMmAyNITK+q9gOWoH3ruhN0/h\nj58USy5CuUAXuhQWoNxUPZlUiXg7ei2bSTH+tMBoCyqcDi4TKEXAHKXKS5Fd5he4\nXOQVsobqwCDKCoVGoaH+QdSru7TLVWqRox0RQY/NkQKBgQDwOXI2zQsrVnrSqS+X\nl0r+G21H5NkjjY5x1aOAG0BIBW6OK5MAbP1bUbOVA00hfey2kaSR69/7px134Lsi\ntgC9JziyjIpyS6yMlYisTKuqg3SY1GjKkGrZkdCO+xcY/Jiamo6VNGzuwJzmjWQ5\n3cfaZDcgo/4bqtGI9QbQ6rW06wKBgQDk7x2OPlCHMusVq0DOa7TraRelhTMDYco5\nNvzJ8r27W0NoHrmgvPFgVkzE+rkwDf2LO5D5TwPyzw1+lnqxaNmKF2EU/OXoGTUG\ntqu1xPu0NXr8bZn5YRwR1Zc+6cbXqUFIm5BtBlKXfc+Yrg7XFw1Y28aakSa3Kvft\n8GL9g+8QLQKBgQCdDvH9olGLJB9pW/QhyGjfek8Ykibld8eJ5YPgXfDJJcQCb7rM\nrHV5HxGqe14SZ6I8Ozy9qtnmTnyVw/iV2SjigqIvGnPqBk/qGlohTH9wHEI/KaDZ\nz1IMrakN0lxnmb6sViCirIQMFSKAGjFNJBNmVd81GAMrU6NrR8gND2d9wQKBgEbF\ntPlYQkTJdOtJ+crWeSOdZXYB63dML9voJ9W2ePkGiZwSg4gxYN1LUIhEiiNU7+Cv\nFW49Axd48s8DbgKSS03pVFXMqLZLtJzSs9qJftaDAfYvW75ASxEoWo1Ub+gTpt7v\nWIKbxcSXXCnzBRtxQOsLZiY6YSGW4vZnrfJ5atoxAoGBAJF9oxseUWLFi8G9jaMD\nBnGqha7wCrQE6rFjgG9olbYxVB0IYN6hnPoelkrJWDJDz9bpvXSsbO7lwFv0x3Ks\n6ehj1fDjibTz9BNiqNwFzoPWq4Th2TqHrYY34ohtcW4tQdtLYPgQyhmNASUytAlG\nzipYnskyVze/3An/VEFrhSdy\n-----END PRIVATE KEY-----\n

data/spec/fixtures/google_credentials.json

@@ -0,0 +1,12 @@
+{
+  "type": "service_account",
+  "project_id": "example-project",
+  "private_key_id": "123",
+  "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDW04sWbA5qIYUQ\nLU+dVoEf0ipYYmu9/2Z+Teobkhd9f6ZQ++1a0hnpelIx3vulrO0uPU/CZIh75cPR\nl/UGg2wxB2QnQcznUCJylOKoV412L7nTauYolNkI71X95npQyQtP+i3E7mQHAEJc\nOqF+cd6ufH5KouKtkJvSioHVKMr1YWDAmCfvQdYQ9Chv4K3Fvr1yniFk7OqcB1Td\nf9XcMpCaC6XokOzgvZ0TbNoqG2ceR66E04J33nRenqiRv8I/jmzsvYb692CuzKEL\nf/F4eY8bnIRYrMgT+7qgBkLMbNN/7m95uoBvJASvosx9+Fp3h6q9DhdphyV0iFjL\nHtvFpH1PAgMBAAECggEACJhCEk2Ubg6VQkZtzv+s/tbrtsmJQfq74QXA/gVkRzMa\nNlc98cpCGyM3sqMXMlOu0ZDGZiKbi0lwAiywMuiDJZsEGMX7Kq38EtV+E/ocwMO8\nDYdTWgBKhp78s8HK1vyUJUj/F8fp3JXYEdSOrX5kyFpWuym1I/iLI2tDMoIFTLfb\n3+NGAZQti7jXO8HMPTBhTj9X4wunCHucc6zd7QwRMmAyNITK+q9gOWoH3ruhN0/h\nj58USy5CuUAXuhQWoNxUPZlUiXg7ei2bSTH+tMBoCyqcDi4TKEXAHKXKS5Fd5he4\nXOQVsobqwCDKCoVGoaH+QdSru7TLVWqRox0RQY/NkQKBgQDwOXI2zQsrVnrSqS+X\nl0r+G21H5NkjjY5x1aOAG0BIBW6OK5MAbP1bUbOVA00hfey2kaSR69/7px134Lsi\ntgC9JziyjIpyS6yMlYisTKuqg3SY1GjKkGrZkdCO+xcY/Jiamo6VNGzuwJzmjWQ5\n3cfaZDcgo/4bqtGI9QbQ6rW06wKBgQDk7x2OPlCHMusVq0DOa7TraRelhTMDYco5\nNvzJ8r27W0NoHrmgvPFgVkzE+rkwDf2LO5D5TwPyzw1+lnqxaNmKF2EU/OXoGTUG\ntqu1xPu0NXr8bZn5YRwR1Zc+6cbXqUFIm5BtBlKXfc+Yrg7XFw1Y28aakSa3Kvft\n8GL9g+8QLQKBgQCdDvH9olGLJB9pW/QhyGjfek8Ykibld8eJ5YPgXfDJJcQCb7rM\nrHV5HxGqe14SZ6I8Ozy9qtnmTnyVw/iV2SjigqIvGnPqBk/qGlohTH9wHEI/KaDZ\nz1IMrakN0lxnmb6sViCirIQMFSKAGjFNJBNmVd81GAMrU6NrR8gND2d9wQKBgEbF\ntPlYQkTJdOtJ+crWeSOdZXYB63dML9voJ9W2ePkGiZwSg4gxYN1LUIhEiiNU7+Cv\nFW49Axd48s8DbgKSS03pVFXMqLZLtJzSs9qJftaDAfYvW75ASxEoWo1Ub+gTpt7v\nWIKbxcSXXCnzBRtxQOsLZiY6YSGW4vZnrfJ5atoxAoGBAJF9oxseUWLFi8G9jaMD\nBnGqha7wCrQE6rFjgG9olbYxVB0IYN6hnPoelkrJWDJDz9bpvXSsbO7lwFv0x3Ks\n6ehj1fDjibTz9BNiqNwFzoPWq4Th2TqHrYY34ohtcW4tQdtLYPgQyhmNASUytAlG\nzipYnskyVze/3An/VEFrhSdy\n-----END PRIVATE KEY-----\n",
+  "client_email": "example@example.iam.gserviceaccount.com",
+  "client_id": "456",
+  "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": "https://www.googleapis.com/robot/v1/metadata/x509/example%40example.iam.gserviceaccount.com"
+}

data/spec/fixtures/google_credentials_invalid.json

@@ -0,0 +1 @@
+invalid

data/spec/fixtures/update_account.json

@@ -0,0 +1,6 @@
+{
+  "kind": "identitytoolkit#SignupNewUserResponse",
+  "localId": "abcdefghijklmnopqrstuvwxyzab",
+  "displayName": "John Smith",
+  "email": "john@smith.com"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase-admin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Colin Harris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -185,7 +185,11 @@ files:
 - spec/fixtures/400_error.json
 - spec/fixtures/bad_gateway.html
 - spec/fixtures/create_account.json
+- spec/fixtures/example_key
 - spec/fixtures/gateway_timeout.html
+- spec/fixtures/google_credentials.json
+- spec/fixtures/google_credentials_invalid.json
+- spec/fixtures/update_account.json
 - spec/spec_helper.rb
 homepage: https://github.com/col/firebase-admin
 licenses:
@@ -219,5 +223,9 @@ test_files:
 - spec/fixtures/400_error.json
 - spec/fixtures/bad_gateway.html
 - spec/fixtures/create_account.json
+- spec/fixtures/example_key
 - spec/fixtures/gateway_timeout.html
+- spec/fixtures/google_credentials.json
+- spec/fixtures/google_credentials_invalid.json
+- spec/fixtures/update_account.json
 - spec/spec_helper.rb