firebase-admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be6f75e823e4cb67948c9e7f421d8ecbf853e67a2d82a327f130e9d885a2647e
+  data.tar.gz: a1875e974a100cd4718add6cf91157717345bb2f722285bb5818556395d98980
+SHA512:
+  metadata.gz: 9aa236550ed151bf5668751a0981dd80162414418838393da4d0d1e994b1f2e67dd0ad049b3f4faa861842ca376291b87480008c48b26498751947216c26d790
+  data.tar.gz: 64d74c30441e8ba9666d93d21cbab49ecca8c1ba96f391c33bccd8b4b7b98504c60ad11d5d7f9e8022a7808b1121d354380fcefa07a831825ca97c53e6413ec0

data/.gitignore

@@ -0,0 +1,3 @@
+firebase-admin.iml
+out
+coverage

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+  <% `git status --ignored --porcelain`.lines.grep(/^!! /).each do |path| %>
+    - <%= path.sub(/^!! /, '') %>
+  <% end %>
+    - spec/spec_helper.rb
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case

data/.rubocop_todo.yml

@@ -0,0 +1,49 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-02-01 09:18:40 UTC using RuboCop version 1.9.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 20
+
+# Offense count: 6
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 111
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 25
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 3
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/firebase-admin.rb'
+    - 'lib/firebase-admin/response.rb'
+    - 'lib/firebase-admin/version.rb'
+
+# Offense count: 18
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    firebase-admin (0.1.0)
+      addressable (~> 2.7)
+      faraday (~> 1.3)
+      faraday_middleware (~> 1.0)
+      hashie (~> 4.1)
+      jwt (~> 2.2.2)
+      multi_json (~> 1.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.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-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    hashie (4.1.0)
+    jwt (2.2.2)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      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)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    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)
+      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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    unicode-display_width (2.0.0)
+    webmock (3.11.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  firebase-admin!
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.9)
+  webmock (~> 3.11)
+
+BUNDLED WITH
+   2.2.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Colin Harris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+# Firebase Admin
+
+A ruby wrapper for the Firebase Admin APIs.
+
+## Example
+
+```
+# Initial global configuration
+FirebaseAdmin.configure do |config|
+  config.project_id = "YOUR_PROJECT_ID"   
+end
+
+# Client specific configuration 
+client = FirebaseAdmin.client(access_token: "")
+
+# API call
+response = client.create_account(
+    email: "",
+    ...
+)
+
+```

data/firebase-admin.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('lib/firebase-admin/version', __dir__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('rake', '~> 13.0')
+  s.add_development_dependency('rspec', '~> 3.10')
+  s.add_development_dependency('rubocop', '~> 1.9')
+  s.add_development_dependency('webmock', '~> 3.11')
+  s.add_runtime_dependency('addressable', '~> 2.7')
+  s.add_runtime_dependency('faraday', '~> 1.3')
+  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.authors = ['Colin Harris']
+  s.description = 'A Ruby wrapper for the Firebase Admin APIs'
+  s.email = ['colin@jiva.ag']
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/col/firebase-admin'
+  s.license = 'MIT'
+  s.name = 'firebase-admin'
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.required_ruby_version = '> 2.7'
+  s.summary = 'Ruby wrapper for the Firebase Admin APIs'
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = FirebaseAdmin::VERSION.dup
+end

data/lib/faraday/loud_logger.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class LoudLogger < Faraday::Middleware
+    extend Forwardable
+    def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+    def initialize(app, options = {})
+      super
+      @app = app
+      @logger = options.fetch(:logger) do
+        require 'logger'
+        ::Logger.new($stdout)
+      end
+    end
+
+    def call(env)
+      start_time = Time.now
+      info  { request_info(env) }
+      debug { request_debug(env) }
+      @app.call(env).on_complete do
+        end_time = Time.now
+        response_time = end_time - start_time
+        info  { response_info(env, response_time) }
+        debug { response_debug(env) }
+      end
+    end
+
+    private
+
+    def filter(output)
+      output
+    end
+
+    def request_info(env)
+      format('Started %<method>s request to: %<url>s', method: env[:method].to_s.upcase, url: filter(env[:url]))
+    end
+
+    def response_info(env, response_time)
+      format(
+        'Response from %<method>s; Status: %<status>d; Time: %<time>.1fms',
+        method: env[:method].to_s.upcase,
+        status: env[:status],
+        time: (response_time * 1_000.0)
+      )
+    end
+
+    def request_debug(env)
+      debug_message('Request', env[:request_headers], env[:body])
+    end
+
+    def response_debug(env)
+      debug_message('Response', env[:response_headers], env[:body])
+    end
+
+    def debug_message(name, headers, body)
+      <<-MESSAGE.gsub(/^ +([^ ])/m, '\\1')
+      #{name} Headers:
+      ----------------
+      #{format_headers(headers)}
+
+      #{name} Body:
+      -------------
+      #{filter(body)}
+      MESSAGE
+    end
+
+    def format_headers(headers)
+      length = headers.map { |k, _| k.to_s.size }.max
+      headers.map { |name, value| "#{name.to_s.ljust(length)} : #{filter(value)}" }.join("\n")
+    end
+  end
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,61 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise FirebaseAdmin::BadRequest,
+                error_message_400(response)
+        when 404
+          raise FirebaseAdmin::NotFound,
+                error_message_400(response)
+        when 429
+          raise FirebaseAdmin::TooManyRequests,
+                error_message_400(response)
+        when 500
+          raise FirebaseAdmin::InternalServerError,
+                error_message_500(response, 'Something is technically wrong.')
+        when 502
+          raise FirebaseAdmin::BadGateway,
+                error_message_500(response, 'The server returned an invalid or incomplete response.')
+        when 503
+          raise FirebaseAdmin::ServiceUnavailable,
+                error_message_500(response, 'Firebase is rate limiting your requests.')
+        when 504
+          raise FirebaseAdmin::GatewayTimeout,
+                error_message_500(response, '504 Gateway Time-out')
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "#{response[:method].to_s.upcase} #{response[:url]}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      # body gets passed as a string, not sure if it is passed as something else from other spots?
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
+
+      if body.nil?
+        nil
+      elsif body['error'] && body['error']['message'] && !body['error']['message'].empty?
+        ": #{body['error']['message']}"
+      end
+    end
+
+    def error_message_500(response, body = nil)
+      "#{response[:method].to_s.upcase} #{response[:url]}: #{response[:status]}: #{body}"
+    end
+  end
+end

data/lib/firebase-admin.rb

@@ -0,0 +1,32 @@
+require File.expand_path('firebase-admin/error', __dir__)
+require File.expand_path('firebase-admin/configuration', __dir__)
+require File.expand_path('firebase-admin/api', __dir__)
+require File.expand_path('firebase-admin/client', __dir__)
+
+module FirebaseAdmin
+  extend Configuration
+
+  # Alias for FirebaseAdmin::Client.new
+  #
+  # @return [FirebaseAdmin::Client]
+  def self.client(options = {})
+    FirebaseAdmin::Client.new(options)
+  end
+
+  # Delegate to FirebaseAdmin::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to FirebaseAdmin::Client
+  def self.respond_to_missing?(method, include_all)
+    client.respond_to_missing?(method, include_all) || super
+  end
+
+  # Delegate to FirebaseAdmin::Client
+  def self.respond_to?(method, include_all)
+    client.respond_to?(method, include_all) || super
+  end
+end

data/lib/firebase-admin/api.rb

@@ -0,0 +1,29 @@
+require File.expand_path('connection', __dir__)
+require File.expand_path('request', __dir__)
+
+module FirebaseAdmin
+  # @private
+  class API
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    # Creates a new API
+    def initialize(options = {})
+      options = FirebaseAdmin.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Connection
+    include Request
+  end
+end