firefighter 0.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 65a0d550b0817cc14a79f82f16ba44c628f710cb
-  data.tar.gz: 1a277e9c5cba8f0df19d4f267ad07b25d917d1a7
+SHA256:
+  metadata.gz: 00b94b5878f703b6332b33493fe3c09ed2b9860a8d402952ce91fd047640ee67
+  data.tar.gz: 586bb23666589a122d0722b9772e0d850d27fca12c49eb9ddf70ffd52cc47c3d
 SHA512:
-  metadata.gz: 74bbdd14e60fc5f6db685fda2413dcde977796667e51fce457176b69e18af4be72f07f79272e1e00784e073b0ca156a10c02f77a2f292f133527bfe59d123934
-  data.tar.gz: 0e5880b19bf6718f0d6e4ae490bf27dca481bd7f604d97dd527d2839cd2571255b2e84fc8eb83eb9ecc4ea07daf8c603a0a522b2c03747db573c88e74d40b911
+  metadata.gz: 0ba9000e62c3baf013389f774faee390fff31fce12deb119e53d269ff300a7630ac20a10c1de2badb4b9936c24db602b6d13a336c98f017210b25dfda72156b0
+  data.tar.gz: 356363578224f2e8a95959a7f3a4ce1d770f0f74abd9e13ecbb645950db304fe8c2acaeacde444d6b9e34fcf1aa8b40297d03b191701cc63af1d6e96e1ebf02a

data/.circleci/config.yml

@@ -4,7 +4,7 @@ jobs:
     working_directory: ~/repo
 
     docker:
-    - image: circleci/ruby:2.4
+    - image: circleci/ruby:2.7
 
     steps:
     - checkout

data/.irbrc

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path('lib')
+
+require 'byebug'
+require 'firefighter'
+require_relative 'spec/support/credentials'
+
+@client = Firefighter::RealtimeDatabase.from_env
+puts "loaded realtime db, use the @client var"

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+### 1.3.0
+
+- adds db_host for realtime database to enable different hosting locations
+
+### 1.2.0
+
+- adds `Firefighter::Identitytoolkit#verify_password`
+
+### 1.1.0
+
+- compatibility with ruby 2.7.1
+
+### 1.0.0
+
+- adds `Firefighter::RealtimeDatabase#listen` (experimental)
+- moves `Firefighter::RealtimeDatabase#fetch_access_token` to `Firefighter::TokenGenerator#fetch_access_token` (breaking)
+
+### 0.3.0
+
+- adds `Firefighter::RealtimeDatabase#delete`

data/Gemfile.lock

@@ -1,70 +1,72 @@
 PATH
   remote: .
   specs:
-    firefighter (0.2.0)
-      http (~> 3.0)
-      jwt (~> 2.0)
+    firefighter (1.3.0)
+      http (> 3.0)
+      jwt (> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    byebug (10.0.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    domain_name (0.5.20180417)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    hashdiff (0.3.7)
-    http (3.3.0)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http_parser.rb (0.6.0)
-    jwt (2.1.0)
-    public_suffix (3.0.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    jwt (2.2.1)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    safe_yaml (1.0.4)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
     timecop (0.9.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
-    vcr (4.0.0)
-    webmock (3.4.2)
+    unf_ext (0.0.7.7)
+    vcr (6.0.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler
   byebug
   firefighter!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  timecop (~> 0.9)
-  vcr (~> 4.0)
-  webmock (~> 3.4)
-
-BUNDLED WITH
-   1.16.1
+  rake
+  rspec
+  timecop
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 phoet
+
+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

@@ -2,9 +2,9 @@
 
 Talk to Firebase API from Ruby:
 
-- signup
-- read, write, add data
-- generate JWT tokens for token-auth
+- identity: signup, account_info, accounts_download, verify_password
+- realtime: read, listen, write, add, delete data
+- tokens: generate JWT tokens for token-auth
 
 ## Installation
 
@@ -24,7 +24,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Firefighter::Identitytoolkit
+# from_env uses environment variables:
+# - FIREBASE_WEB_API_KEY
+# - FIREBASE_SERVICE_ACCOUNT_EMAIL
+identitytoolkit = Firefighter::Identitytoolkit.from_env
+
+account = identitytoolkit.signup('test@test.de', 'totalgeheimespasswort')
+
+account = identitytoolkit.account_info(account['idToken'])
+
+accounts = identitytoolkit.download_accounts
+
+account = identitytoolkit.verify_password('test@test.de', 'totalgeheimespasswort')
+```
+
+```ruby
+# Firefighter::RealtimeDatabase
+# from_env uses environment variables:
+# - FIREBASE_WEB_DB_NAME
+# - FIREBASE_WEB_DB_SECRET
+# - FIREBASE_WEB_DB_HOST (defaults to host for us-central1)
+
+realtime_database = Firefighter::RealtimeDatabase.from_env
+
+realtime_database.write("some-path/key", {some: 'data'})
+
+hash = realtime_database.read("some-path/key")
+
+realtime_database.add("some-path/list", {some: 'data'})
+
+list = realtime_database.read("some-path/list")
+
+realtime_database.delete("some-path/list")
+
+realtime_database.listen("some-test/write/") do |connection, event, path, data|
+  puts event, path, data
+  connection.close
+end
+```
+
+```ruby
+# Firefighter::TokenGenerator
+# from_env uses environment variables:
+# - FIREBASE_SERVICE_ACCOUNT_EMAIL
+# - FIREBASE_SERVICE_ACCOUNT_PRIVATE_KEY
+token_generator = Firefighter::TokenGenerator.from_env
+
+access_token = token_generator.create_access_token
+
+custom_token = token_generator.create_custom_token('someUid', data: {some: 'payload'})
+
+payload = token_generator.read_token(custom_token)
+
+token = token_generator.fetch_access_token
+```
 
 ## Development
 
@@ -34,8 +89,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/phoet/firefighter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/penseo/firefighter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 
-Everyone interacting in the Firefighter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/phoet/firefighter/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Firefighter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/penseo/firefighter/blob/master/CODE_OF_CONDUCT.md).
+
+## Changelog
+
+[changelog](https://github.com/penseo/firefighter/blob/master/CHANGELOG.md)

data/firefighter.gemspec

@@ -28,13 +28,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "http", "~> 3.0"
-  spec.add_dependency "jwt", "~> 2.0"
+  spec.add_dependency "http", "> 3.0"
+  spec.add_dependency "jwt", "> 2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "vcr", "~> 4.0"
-  spec.add_development_dependency "webmock", "~> 3.4"
-  spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "timecop"
 end

data/lib/firefighter/identitytoolkit.rb

@@ -3,17 +3,25 @@ module Firefighter
     include Web
 
     def self.from_env
-      config = {
+      new(
         api_key: ENV['FIREBASE_WEB_API_KEY'],
         service_account_email: ENV['FIREBASE_SERVICE_ACCOUNT_EMAIL'],
-      }
-      new(config)
+      )
     end
 
-    def initialize(api_key:, service_account_email:, token_generator: TokenGenerator.from_env)
+    def initialize(api_key:, service_account_email:)
       @api_key = api_key
       @service_account_email = service_account_email
-      @token_generator = token_generator
+    end
+
+    def verify_password(email, password)
+      url = endpoint('verifyPassword')
+      data = {
+        email: email,
+        password: password,
+        returnSecureToken: true
+      }
+      call(:post, url, data)
     end
 
     def signup(email, password)
@@ -36,24 +44,14 @@ module Firefighter
       call(:post, url, data)
     end
 
-    def download_accounts
-      url = endpoint('downloadAccount')
-
-      headers = {Authorization: "Bearer #{fetch_access_token}" }
-
+    def download_accounts(access_token = TokenGenerator.from_env.fetch_access_token)
       users = []
+
+      headers = {Authorization: "Bearer #{access_token}" }
+      url = endpoint('downloadAccount')
       paginate(url, headers: headers) { |data| users << data['users'] }
-      users.flatten.compact
-    end
 
-    def fetch_access_token
-      url = 'https://accounts.google.com/o/oauth2/token'
-      data = {
-        assertion: @token_generator.create_access_token,
-        grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer'
-      }
-      response = call(:post, url, data)
-      response['access_token']
+      users.flatten.compact
     end
 
     private

data/lib/firefighter/realtime_database.rb

@@ -3,16 +3,36 @@ module Firefighter
     include Web
 
     def self.from_env
-      config = {
+      new(
         db_name: ENV['FIREBASE_WEB_DB_NAME'],
-        db_secret: ENV['FIREBASE_WEB_DB_SECRET']
-      }
-      new(config)
+        db_secret: ENV['FIREBASE_WEB_DB_SECRET'],
+        db_host: ENV['FIREBASE_WEB_DB_HOST'] || DEFAULT_DB_HOST,
+      )
     end
 
-    def initialize(db_name:, db_secret:)
+    DB_HOSTS = {
+      'us-central1' => 'firebaseio.com',
+      'europe-west1' => 'europe-west1.firebasedatabase.app',
+    }
+    DEFAULT_DB_HOST = DB_HOSTS['us-central1']
+
+    def initialize(db_name:, db_secret:, db_host: DEFAULT_DB_HOST)
       @db_name = db_name
       @db_secret = db_secret
+      @db_host = db_host
+    end
+
+    def listen(path)
+      url = endpoint(path)
+      sse(url) do |connection, event, payload|
+        data = JSON.parse(payload)
+        yield connection, event, data['path'], data['data']
+      end
+    end
+
+    def read(path)
+      url = endpoint(path)
+      call(:get, url)
     end
 
     def write(path, data)
@@ -25,15 +45,15 @@ module Firefighter
       call(:post, url, data)
     end
 
-    def read(path)
+    def delete(path)
       url = endpoint(path)
-      call(:get, url)
+      call(:delete, url)
     end
 
     private
 
     def endpoint(path)
-      "https://#{@db_name}.firebaseio.com/#{path}.json?auth=#{@db_secret}"
+      "https://#{@db_name}.#{@db_host}/#{path}.json?auth=#{@db_secret}"
     end
   end
 end

data/lib/firefighter/token_generator.rb

@@ -3,12 +3,13 @@ require 'jwt'
 # https://firebase.google.com/docs/auth/admin/create-custom-tokens
 module Firefighter
   class TokenGenerator
+    include Web
+
     def self.from_env
-      config = {
+      new(
         service_account_email: ENV['FIREBASE_SERVICE_ACCOUNT_EMAIL'],
         service_account_private_key: ENV['FIREBASE_SERVICE_ACCOUNT_PRIVATE_KEY'],
-      }
-      new(config)
+      )
     end
 
     def initialize(service_account_email:, service_account_private_key:, algorithm: 'RS256')
@@ -17,6 +18,15 @@ module Firefighter
       @private_key = OpenSSL::PKey::RSA.new(service_account_private_key)
     end
 
+    def fetch_access_token
+      url = 'https://accounts.google.com/o/oauth2/token'
+      data = {
+        assertion: create_access_token,
+        grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer'
+      }
+      response = call(:post, url, data)
+      response['access_token']
+    end
 
     def create_access_token(expiration: 60 * 60)
       now_seconds = Time.now.to_i

data/lib/firefighter/version.rb

@@ -1,3 +1,3 @@
 module Firefighter
-  VERSION = "0.2.1"
+  VERSION = "1.3.0"
 end

data/lib/firefighter/web.rb

@@ -8,10 +8,31 @@ module Firefighter
       @logger ||= Logger.new(STDOUT)
     end
 
+    def sse(url, headers = {})
+      response = HTTP.get(url, headers: headers.merge(Accept: 'text/event-stream'))
+      if response.status == 200
+        body = response.body
+        while part = body.readpartial do
+          part = part.to_s.strip
+          next if part.empty?
+
+          lines = part.split("\n")
+          event = lines.grep(/event: (.+)/) { $1 }[0]
+          payload = lines.grep(/data: (.+)/) { $1 }[0]
+          yield response.connection, event, payload
+        end
+      end
+    ensure
+      response.connection.close if response
+    end
+
     def call(method, url, data = {}, headers = {})
-      if method == :get
+      case method
+      when :get
         response = HTTP.get(url, headers: headers)
-      elsif method == :form
+      when :delete
+        response = HTTP.delete(url, headers: headers)
+      when :form
         response = HTTP.send(:post, url, form: data, headers: headers)
       else
         response = HTTP.send(method, url, json: data, headers: headers)

metadata

@@ -1,127 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: firefighter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - phoet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 description: Firebase API Wrapper
 email:
 - phoetmail@googlemail.com
@@ -131,10 +131,13 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".gitignore"
+- ".irbrc"
 - ".rspec"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -165,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Firebase API Wrapper