fireauth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69db89de7b7f0021f1fca7a529c1a6584f591fa12644252c521c233efcad679e
+  data.tar.gz: 65eea3640514591b2b83806aede60a8c11fba36d906fc48781bfd5dc20f50eba
+SHA512:
+  metadata.gz: 10044a6cbfbd847bf2de086f28a979985ab9197fdf79bffede775b1a2894262ce537ffeb600b74698eeabc0cb9516845e753716f76f92922cbcf868ad953e66f
+  data.tar.gz: 79c8a81fde73e80f862dafb11f41ae49354f67157cb35c623f1c485e770a138db5904681fd7fbfbc747a5fb157d04cce1850cfd83926c70b0d28baa29e804fe9

data/.github/workflows/rspec.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v1
+        id: cache
+        with:
+          path: ~/local/rubies
+          key: ruby-3.0.0
+          restore-keys: |
+            ruby-3.0.0
+      - uses: ruby/setup-ruby@v1
+        id: ruby
+        with:
+          ruby-version: 3.0.0
+          bundler-cache: true
+
+      - name: install bundler
+        run: gem install bundler
+
+      - name: Install dependent libralies
+        run: sudo apt-get install libpq-dev
+
+      - name: Cache gems
+        uses: actions/cache@preview
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gem-
+
+      - name: Bundle install
+        run: bundle install --jobs 4 --retry 3
+
+      # - name: Run Rubocop
+      #   run: |
+      #     bundle exec rubocop
+
+      - name: Run rspec
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.rspec

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

data/.rspec_status

@@ -0,0 +1,7 @@
+example_id                                        | status | run_time        |
+------------------------------------------------- | ------ | --------------- |
+./spec/fireauth/authentication_spec.rb[1:1:1:1:1] | passed | 0.01406 seconds |
+./spec/fireauth/authentication_spec.rb[1:1:2:1:1] | passed | 0.00593 seconds |
+./spec/fireauth/authentication_spec.rb[1:1:2:2:1] | passed | 0.00182 seconds |
+./spec/fireauth/configuration_spec.rb[1:1:1]      | passed | 0.00008 seconds |
+./spec/fireauth/configuration_spec.rb[1:2:1]      | passed | 0.00007 seconds |

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fireauth.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "faraday", "~> 1.0"
+gem "rspec", "~> 3.0"
+gem "webmock", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    fireauth (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    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)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
+    rake (12.3.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.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    ruby2_keywords (0.0.4)
+    webmock (3.11.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday (~> 1.0)
+  fireauth!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 yuta17
+
+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,109 @@
+# Fireauth
+
+Simple Firebase Authentication for Ruby.
+
+The source of the idea is [this article](https://medium.com/@Mpierrax/firebase-authentification-with-ruby-on-rails-backend-a9f7afc4d715).
+
+This gem takes the idToken issued by Firebase and sends the request to identitytoolkit.
+
+And it will return the authenticated user's information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fireauth'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fireauth
+
+## Configuration
+
+t's needed to set up your Firebase API Key.
+
+If you are using Rails, this should probably go into config/initializers/fireauth.rb.
+
+```ruby
+Fireauth.configure do |config|
+  config.firebase_api_key = ENV['FIREBASE_API_KEY']
+end
+```
+
+## Usage
+
+```ruby
+response = Fireauth::Authentication.call(id_token)
+raise response['error']['message'] if response['error'].present?
+
+authenticated_user = response['users'].first
+```
+
+### Payload Structure
+
+A example of the payload structure from a Facebook login in JSON.
+
+```json
+{
+   "kind": "identitytoolkit#GetAccountInfoResponse",
+   "users": [
+      {
+         "localId": "dummyLocalId",
+         "displayName": "dummyDisplayName",
+         "photoUrl": "https://example.com/picture",
+         "providerUserInfo": [
+            {
+               "providerId": "facebook.com",
+               "displayName": "dummyDisplayName",
+               "photoUrl": "https://example.com/picture",
+               "federatedId": "00000000",
+               "email": "dummy@example.com",
+               "rawId": "0000000000"
+            }
+         ],
+         "validSince": "1611130616",
+         "lastLoginAt": "1611375910133",
+         "createdAt": "1611130616888",
+         "lastRefreshAt": "2021-01-23T04:25:10.840Z"
+      }
+   ]
+}
+```
+
+Example for request with invalid id token.
+
+```json
+{
+   "error": {
+      "code": 400,
+      "message": "INVALID_ID_TOKEN",
+      "errors": [
+         {
+            "domain": "global",
+            "message": "INVALID_ID_TOKEN",
+            "reason": "invalid"
+         }
+      ],
+      "status"
+   }
+}
+```
+
+## Development
+
+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 tags, 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/yuta17/fireauth.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fireauth"
+
+# 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/fireauth.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/fireauth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fireauth"
+  spec.version       = Fireauth::VERSION
+  spec.authors       = ["yuta17"]
+  spec.email         = ["usgitan@gmail.com"]
+
+  spec.summary       = %q{Simple Firebase Authentication for Ruby.}
+  spec.description   = %q{Simple Firebase Authentication for Ruby.}
+  spec.homepage      = "https://github.com/yuta17/fireauth"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yuta17/fireauth"
+  spec.metadata["changelog_uri"] = "https://github.com/yuta17/fireauth/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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/fireauth.rb

@@ -0,0 +1,17 @@
+require "fireauth/version"
+require "fireauth/configuration"
+require "fireauth/authentication"
+
+module Fireauth
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/fireauth/authentication.rb

@@ -0,0 +1,37 @@
+require 'faraday'
+require 'json'
+
+module Fireauth
+  class Authentication
+    IDENTITY_URL = "https://www.googleapis.com/identitytoolkit/v3/relyingparty/getAccountInfo"
+
+    # @example
+    #   response = Fireauth::Authentication.call(id_token)
+    #
+    # @param [String] id_token Firebase ID Token
+    # @return [Hash] authenticated user or error message
+    def self.call(id_token)
+      new(id_token).response
+    end
+
+    def initialize(id_token)
+      @id_token = id_token
+      @firebase_api_key = Fireauth.configuration.firebase_api_key
+    end
+
+    def response
+      JSON.parse(request.body)
+    end
+
+    private
+
+    attr_reader :id_token, :firebase_api_key
+
+    def request
+      url = "#{IDENTITY_URL}?key=#{firebase_api_key}"
+      request_body = "{ 'idToken': '#{id_token}' }"
+
+      Faraday.post(url, request_body, content_type: 'application/json')
+    end
+  end
+end

data/lib/fireauth/configuration.rb

@@ -0,0 +1,9 @@
+module Fireauth
+  class Configuration
+    attr_accessor :firebase_api_key
+
+    def initialize
+      @firebase_api_key = ''
+    end
+  end
+end

data/lib/fireauth/version.rb

@@ -0,0 +1,3 @@
+module Fireauth
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: fireauth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yuta17
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-23 00:00:00.000000000 Z
+dependencies: []
+description: Simple Firebase Authentication for Ruby.
+email:
+- usgitan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".rspec_status"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fireauth.gemspec
+- lib/fireauth.rb
+- lib/fireauth/authentication.rb
+- lib/fireauth/configuration.rb
+- lib/fireauth/version.rb
+homepage: https://github.com/yuta17/fireauth
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yuta17/fireauth
+  source_code_uri: https://github.com/yuta17/fireauth
+  changelog_uri: https://github.com/yuta17/fireauth/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Simple Firebase Authentication for Ruby.
+test_files: []