firebase-admin-sdk 0.1.0

data/lib/firebase/admin/config.rb

@@ -0,0 +1,57 @@
+require "json"
+
+module Firebase
+  module Admin
+    # The name of the environment variable to lookup a Firebase config.
+    FIREBASE_CONFIG_ENV_VAR = "FIREBASE_CONFIG"
+
+    # Configuration options used to initialize an App.
+    class Config
+      attr_reader :project_id, :service_account_id
+
+      class << self
+        # Loads a configuration using the FIREBASE_CONFIG environment variable.
+        #
+        # If the value of the FIREBASE_CONFIG environment variable starts with "{" it is
+        # parsed as a JSON object, otherwise it is interpreted as a path to the config file.
+        #
+        # @return [Firebase::Admin::Config]
+        def from_env
+          config = ENV[FIREBASE_CONFIG_ENV_VAR]
+          return new if config.nil?
+          return from_json(config) if config.start_with?("{")
+          from_file(config)
+        end
+
+        # Loads a configuration from a file.
+        #
+        # @param [File, String] file
+        #   The path of the configuration file.
+        #
+        # @return [Firebase::Admin::Config]
+        def from_file(file)
+          json = file.is_a?(File) ? file.read : File.read(file)
+          from_json(json)
+        end
+
+        # Loads a configuration from JSON.
+        #
+        # @param [String] json
+        #   A configuration encoded as a JSON string.
+        #
+        # @return [Firebase::Admin::Config]
+        def from_json(json)
+          data = JSON.parse(json)
+          new(project_id: data["projectId"],
+              service_account_id: data["serviceAccountId"])
+        end
+      end
+
+      # Initializes the configuration object.
+      def initialize(project_id: nil, service_account_id: nil)
+        @project_id = project_id
+        @service_account_id = service_account_id
+      end
+    end
+  end
+end

data/lib/firebase/admin/credentials.rb

@@ -0,0 +1,79 @@
+require "stringio"
+require "googleauth/default_credentials"
+require "googleauth/application_default"
+
+module Firebase
+  module Admin
+    SCOPE = %w[
+      https://www.googleapis.com/auth/cloud-platform
+      https://www.googleapis.com/auth/datastore
+      https://www.googleapis.com/auth/devstorage.read_write
+      https://www.googleapis.com/auth/firebase
+      https://www.googleapis.com/auth/identitytoolkit
+      https://www.googleapis.com/auth/userinfo.email
+    ]
+
+    # Firebase credentials.
+    class Credentials
+      class << self
+        # Loads google credentials from a specified file path.
+        #
+        # @param [File, String] file
+        #   The credentials file path
+        #
+        # @return [Firebase::Admin::Credentials]
+        def from_file(file)
+          json = file.is_a?(File) ? file.read : File.read(file)
+          from_json(json)
+        end
+
+        # Loads google credentials from a JSON string.
+        #
+        # @param [String] json
+        #   A JSON string containing valid google credentials.
+        #
+        # @return [Firebase::Admin::Credentials]
+        def from_json(json)
+          io = StringIO.new(json)
+          new(Google::Auth::DefaultCredentials.make_creds(scope: SCOPE, json_key_io: io))
+        end
+
+        # Loads application default credentials.
+        #
+        # @return [Firebase::Admin::Credentials]
+        def from_default
+          new(Google::Auth.get_application_default(SCOPE))
+        end
+      end
+
+      # Gets the google credentials
+      attr_reader :credentials
+
+      # Constructs a Credential from the specified Google Credentials.
+      #
+      # @param [Google::Auth::ServiceAccountCredentials, Google::Auth::UserRefreshCredentials, Google::Auth::GCECredentials] credentials
+      #   The google credentials to connect with.
+      def initialize(credentials)
+        raise ArgumentError, "credentials cannot be nil" if credentials.nil?
+        @credentials = credentials
+      end
+
+      # Gets the google project id
+      def project_id
+        @credentials.project_id
+      end
+
+      # Apply the credentials
+      def apply!(hash, opts = {})
+        @credentials.apply!(hash, opts)
+      end
+    end
+
+    # Firebase Admin emulator credentials.
+    class EmulatorCredentials
+      def apply!(hash, opts = {})
+        hash[:authorization] = "Bearer owner"
+      end
+    end
+  end
+end

data/lib/firebase/admin/error.rb

@@ -0,0 +1,9 @@
+module Firebase
+  module Admin
+    # A base class for errors raised by the admin sdk.
+    class Error < StandardError; end
+
+    # Raised when there is an incorrect argument.
+    class ArgumentError < Error; end
+  end
+end

data/lib/firebase/admin/gce.rb

@@ -0,0 +1,42 @@
+require "faraday"
+require "googleauth/compute_engine"
+
+module Firebase
+  module Admin
+    module GCE
+      # The compute engine metadata project id endpoint.
+      PROJECT_ID_URI =
+        "#{Google::Auth::GCECredentials.compute_check_uri}/computeMetadata/v1/project/project-id".freeze
+
+      # Patches GCECredentials to lookup the project id using the metadata service when on compute engine.
+      class ::Google::Auth::GCECredentials
+        # The compute engine project id
+        def project_id
+          @project_id ||= fetch_project_id
+        end
+
+        private
+
+        # Fetches the project id using the compute engine metadata service.
+        def fetch_project_id
+          connection = build_default_connection || Faraday.default_connection
+          retry_with_error do
+            uri = Firebase::Admin::GCE::PROJECT_ID_URI
+            resp = connection.get(uri) do |req|
+              req.headers["Metadata-Flavor"] = "Google"
+            end
+            case resp.status
+            when 200
+              resp.body
+            when 404
+              raise Signet::AuthorizationError, NO_METADATA_SERVER_ERROR
+            else
+              msg = "Unexpected error code #{resp.status} #{UNEXPECTED_ERROR_SUFFIX}"
+              raise Signet::AuthorizationError, msg
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/firebase/admin/internal/http_client.rb

@@ -0,0 +1,78 @@
+require "faraday"
+require "faraday_middleware"
+
+module Firebase
+  module Admin
+    module Internal
+      # A class to work with
+      class HTTPClient
+        # The admin sdk user agent.
+        USER_AGENT = "Firebase/HTTP/#{VERSION}/#{RUBY_VERSION}/AdminRuby"
+
+        def initialize(uri: nil, credentials: nil)
+          @uri = uri ? Faraday::Utils::URI(uri) : nil
+          @credentials = credentials
+        end
+
+        def head(url = nil, params = nil, headers = nil)
+          connection.head(url, params, headers)
+        end
+
+        def get(url = nil, params = nil, headers = nil)
+          connection.get(url, params, headers)
+        end
+
+        def delete(url = nil, params = nil, headers = nil)
+          connection.delete(url, params, headers)
+        end
+
+        def trace(url = nil, params = nil, headers = nil)
+          connection.trace(url, params, headers)
+        end
+
+        def put(url = nil, params = nil, headers = nil)
+          connection.put(url, params, headers)
+        end
+
+        def post(url = nil, params = nil, headers = nil)
+          connection.post(url, params, headers)
+        end
+
+        def patch(url = nil, params = nil, headers = nil)
+          connection.patch(url, params, headers)
+        end
+
+        private
+
+        # @return [Faraday::Connection]
+        def connection
+          options = {
+            headers: {
+              Accept: "application/json; charset=utf-8",
+              "Content-Type": "application/json; charset=utf-8",
+              "User-Agent": USER_AGENT
+            }
+          }
+
+          @connection ||= Faraday::Connection.new(@uri, options) do |c|
+            c.use CredentialsMiddleware, credentials: @credentials unless @credentials.nil?
+            c.use Faraday::Request::UrlEncoded
+            c.use FaradayMiddleware::EncodeJson
+            c.use Faraday::Response::ParseJson
+            c.use Faraday::Response::RaiseError
+            c.adapter(Faraday.default_adapter)
+          end
+        end
+
+        # Middleware for applying credentials to authenticate requests.
+        class CredentialsMiddleware < Faraday::Middleware
+          def on_request(env)
+            creds = options[:credentials]
+            creds.apply!(env[:request_headers])
+          end
+        end
+        private_constant :CredentialsMiddleware
+      end
+    end
+  end
+end

data/lib/firebase/admin/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Firebase
+  module Admin
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: firebase-admin-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tariq Zaid
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- tariq@cheddar.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firebase-admin-sdk.gemspec
+- lib/firebase-admin-sdk.rb
+- lib/firebase/admin/app.rb
+- lib/firebase/admin/auth/certificates_fetcher.rb
+- lib/firebase/admin/auth/client.rb
+- lib/firebase/admin/auth/error.rb
+- lib/firebase/admin/auth/token_verifier.rb
+- lib/firebase/admin/auth/user_info.rb
+- lib/firebase/admin/auth/user_manager.rb
+- lib/firebase/admin/auth/user_record.rb
+- lib/firebase/admin/auth/utils.rb
+- lib/firebase/admin/config.rb
+- lib/firebase/admin/credentials.rb
+- lib/firebase/admin/error.rb
+- lib/firebase/admin/gce.rb
+- lib/firebase/admin/internal/http_client.rb
+- lib/firebase/admin/version.rb
+homepage: https://github.com/cheddar-me/firebase-admin-sdk-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Firebase Admin SDK for Ruby
+test_files: []