fbase_auth 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f855c0c74114e8f6d0166a84007475ec645abbc35288da30cbdca1c9d01cb4d7
+  data.tar.gz: c77012d34ab623ca225f7f00fed54f1391283a2ba6a0461af931e33fa7a658e1
+SHA512:
+  metadata.gz: 783f520abded32bd221ebab8e8de2b16c2b2563e8af55fb4f11c6a84198e342ef2745e760241f11e6f71eeb92ce9d7c16526725b23c65b808dbbd2c570acd10b
+  data.tar.gz: 7befc8fd0f1f0c48c3c20d4ae72817a349c1abf68636b3c682d53612d3a9551cdbdb6f1543dd12807c6ca958755e4ac3d5c932fa8a565611165094b5512d659c

data/.github/workflows/build.yml

@@ -0,0 +1,29 @@
+name: build
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - '*'
+      
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Ruby 2.6.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.6
+
+    - name: build
+      run: |
+        gem install bundler
+        bin/setup
+    - name: rspec
+      run: bundle exec rspec
+    - name: Run Rubocop
+      run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 2.6.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-03-29
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,8 @@
+FROM ruby:2.7
+
+WORKDIR /app
+
+COPY . ./
+RUN bundle install
+
+CMD ["bin/console"]

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fbase_auth.gemspec
+gemspec
+
+gem "http", "~> 4.4.1"
+gem "rake", "~> 13.0.3"
+gem "rspec", "~> 3.10.0"
+gem "rubocop", "~> 1.10.0"
+gem "webmock", "~> 3.12"

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    fbase_auth (0.1.3)
+
+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)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.0)
+    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.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    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.1.1)
+    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.10.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)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  fbase_auth!
+  http (~> 4.4.1)
+  rake (~> 13.0.3)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.10.0)
+  webmock (~> 3.12)
+
+BUNDLED WITH
+   2.2.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Scotto
+
+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/Makefile

@@ -0,0 +1,23 @@
+docker:
+	@docker-compose build
+	@docker-compose up -d
+
+start:
+	@docker-compose start
+
+restart:
+	@docker-compose restart
+
+stop:
+	@docker-compose stop
+
+clean:
+	@docker-compose down
+	@docker system prune --volumes --force
+	@rm -rf tmp/* || sudo rm -rf tmp/*
+
+bash:
+	@docker-compose exec fbase_auth bash
+
+logs:
+	@docker-compose logs -f --tail=0 app

data/README.md

@@ -0,0 +1,67 @@
+# FbaseAuth ![build](https://github.com/joaoscotto/fbase_auth/workflows/build/badge.svg?event=push) [![Gem version](https://img.shields.io/gem/v/fbase_auth.svg)](https://rubygems.org/gems/fbase_auth)
+
+FbaseAuth is a Ruby wrapper for [Firebase Authentication](https://firebase.google.com/docs/auth).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fbase_auth'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fbase_auth
+
+## Usage
+
+
+### Configuration example:
+
+```ruby
+
+FbaseAuth.configure do |config| 
+  config.api_key = 'example'
+  config.return_secure_token = false #(default is true)
+end
+```
+### Usage examples:
+
+```ruby
+FbaseAuth::Client.sign_up(email:, password: '')
+FbaseAuth::Client.sign_in_with_password(email:, password: '')
+FbaseAuth::Client.send_email_verification(id_token: '')
+FbaseAuth::Client.confirm_email_verification(oob_code: '')
+FbaseAuth::Client.send_password_reset_email(email: '')
+FbaseAuth::Client.verify_password_reset_code(oob_code: '')
+FbaseAuth::Client.confirm_password_reset(oob_code: '', new_password: '')
+FbaseAuth::Client.delete_account(id_token: '')
+```
+
+## Development
+
+### Build and start Docker
+
+```bash
+make docker
+make bash
+```
+
+See the [Makefile](/Makefile) for more commands.
+
+### Publish a new version
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joaoscotto/fbase_auth.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fbase_auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,7 @@
+version: '3'
+services:
+  fbase_auth:
+    build: .
+    volumes:
+      - ./:/app
+    tty: true

data/fbase_auth.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/fbase_auth/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fbase_auth"
+  spec.version       = FbaseAuth::VERSION
+  spec.authors       = ["Scotto"]
+  spec.email         = ["joao.scotto@gmail.com"]
+
+  spec.summary       = "Firebase Authentication for Ruby"
+  spec.description   = "Firebase Authentication for Ruby"
+  spec.homepage      = "https://github.com/joaoscotto/fbase_auth"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.6")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/joaoscotto/fbase_auth"
+  spec.metadata["changelog_uri"] = "https://github.com/joaoscotto/fbase_auth/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/fbase_auth/action/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class Base
+    def initialize
+      raise NotImplementedError
+    end
+
+    def call
+      FbaseAuth::Request.post self.class::PATH, payload
+    end
+  end
+end

data/lib/fbase_auth/action/confirm_email_verification.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class ConfirmEmailVerification < Base
+    PATH = "update"
+
+    def initialize oob_code:
+      @oob_code = oob_code
+    end
+
+    private
+
+    def payload
+      { oobCode: @oob_code }
+    end
+  end
+end

data/lib/fbase_auth/action/confirm_password_reset.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class ConfirmPasswordReset < Base
+    PATH = "resetPassword"
+
+    def initialize oob_code:, new_password:
+      @oob_code = oob_code
+      @new_password = new_password
+    end
+
+    private
+
+    def payload
+      {
+        oobCode: @oob_code,
+        newPassword: @new_password
+      }
+    end
+  end
+end

data/lib/fbase_auth/action/delete_account.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class DeleteAccount < Base
+    PATH = "delete"
+
+    def initialize id_token:
+      @id_token = id_token
+    end
+
+    private
+
+    def payload
+      { idToken: @id_token }
+    end
+  end
+end

data/lib/fbase_auth/action/send_email_verification.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class SendEmailVerification < Base
+    PATH = "sendOobCode"
+
+    def initialize id_token:
+      @id_token = id_token
+    end
+
+    private
+
+    def payload
+      {
+        idToken: @id_token,
+        requestType: "VERIFY_EMAIL"
+      }
+    end
+  end
+end

data/lib/fbase_auth/action/send_password_reset_email.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class SendPasswordResetEmail < Base
+    PATH = "sendOobCode"
+
+    def initialize email:
+      @email = email
+    end
+
+    private
+
+    def payload
+      {
+        email: @email,
+        requestType: "PASSWORD_RESET"
+      }
+    end
+  end
+end

data/lib/fbase_auth/action/sign_in_with_password.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class SignInWithPassword < Base
+    PATH = "signInWithPassword"
+
+    def initialize email:, password:
+      @email = email
+      @password = password
+    end
+
+    private
+
+    def payload
+      {
+        email: @email,
+        password: @password,
+        return_secure_token: true
+      }
+    end
+  end
+end

data/lib/fbase_auth/action/sign_up.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class SignUp < Base
+    PATH = "signUp"
+
+    def initialize email:, password:
+      @email = email
+      @password = password
+    end
+
+    private
+
+    def payload
+      {
+        email: @email,
+        password: @password,
+        return_secure_token: true
+      }
+    end
+  end
+end

data/lib/fbase_auth/action/verify_password_reset_code.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Action
+  class VerifyPasswordResetCode < Base
+    PATH = "resetPassword"
+
+    def initialize oob_code:
+      @oob_code = oob_code
+    end
+
+    private
+
+    def payload
+      { oobCode: @oob_code }
+    end
+  end
+end

data/lib/fbase_auth/client.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Client; end

data/lib/fbase_auth/client_decorator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module FbaseAuth::ClientDecorator
+  def self.apply
+    FbaseAuth::Helper.action_classes.each do |klass|
+      klass_name = FbaseAuth::Helper.camelize klass
+
+      FbaseAuth::Client.define_singleton_method klass do |**args|
+        Object
+          .const_get("FbaseAuth::Action::#{klass_name}")
+          .new(**args)
+          .call
+      end
+    end
+  end
+end

data/lib/fbase_auth/config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FbaseAuth
+  class Config
+    HOST = "https://identitytoolkit.googleapis.com/v1/accounts:"
+    attr_reader :host
+    attr_accessor :api_key, :return_secure_token
+
+    def initialize
+      @api_key = ""
+      @host = HOST
+      @return_secure_token = true
+    end
+  end
+end

data/lib/fbase_auth/helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Helper
+  def self.camelize str
+    str.split("_").map(&:capitalize).join
+  end
+
+  def self.action_classes
+    Dir
+      .entries("#{File.dirname(__FILE__)}/action/")
+      .map { |file| file.gsub(".rb", "") if file.include?(".rb") }
+      .tap { |file| file.delete("base") }
+      .compact
+  end
+end

data/lib/fbase_auth/request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FbaseAuth::Request
+  def self.post path, payload
+    url = "#{FbaseAuth.config.host}#{path}?key=#{FbaseAuth.config.api_key}"
+    response = HTTP.post url, json: payload
+
+    {
+      code: response.code,
+      body: JSON.parse(response.to_s)
+    }
+  end
+end

data/lib/fbase_auth/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FbaseAuth
+  VERSION = "0.1.3"
+end

data/lib/fbase_auth.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "http"
+require "fbase_auth/version"
+require "fbase_auth/config"
+require "fbase_auth/client"
+require "fbase_auth/client_decorator"
+require "fbase_auth/helper"
+require "fbase_auth/request"
+Dir["#{File.dirname(__FILE__)}/fbase_auth/action/*.rb"].sort.each { |file| require file }
+
+module FbaseAuth
+  class << self
+    attr_writer :config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield config
+    FbaseAuth::ClientDecorator.apply
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: fbase_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Scotto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-04 00:00:00.000000000 Z
+dependencies: []
+description: Firebase Authentication for Ruby
+email:
+- joao.scotto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- fbase_auth.gemspec
+- lib/fbase_auth.rb
+- lib/fbase_auth/action/base.rb
+- lib/fbase_auth/action/confirm_email_verification.rb
+- lib/fbase_auth/action/confirm_password_reset.rb
+- lib/fbase_auth/action/delete_account.rb
+- lib/fbase_auth/action/send_email_verification.rb
+- lib/fbase_auth/action/send_password_reset_email.rb
+- lib/fbase_auth/action/sign_in_with_password.rb
+- lib/fbase_auth/action/sign_up.rb
+- lib/fbase_auth/action/verify_password_reset_code.rb
+- lib/fbase_auth/client.rb
+- lib/fbase_auth/client_decorator.rb
+- lib/fbase_auth/config.rb
+- lib/fbase_auth/helper.rb
+- lib/fbase_auth/request.rb
+- lib/fbase_auth/version.rb
+homepage: https://github.com/joaoscotto/fbase_auth
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joaoscotto/fbase_auth
+  source_code_uri: https://github.com/joaoscotto/fbase_auth
+  changelog_uri: https://github.com/joaoscotto/fbase_auth/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key: 
+specification_version: 4
+summary: Firebase Authentication for Ruby
+test_files: []