contrib-auth 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb10ef1984df8036c7cc625c7560808a2da9e8613a953fbf3b2b715dbccab364
+  data.tar.gz: 759d43d360a3c22b074963a41e5f69b9899dfb509b7db106da49a480cc7a3139
+SHA512:
+  metadata.gz: 41467b432ea48e15fd651813769e525b57e1af206e07c9afb628244a6b3dd71e11d1cd6e73322b07c9129d456544a00ee3211e6871a89b4523dc4ee77bdad2cc
+  data.tar.gz: 9076f1eead44bc2ea93994484352ba77dd52558f45ff03d1fbb13ae626825a15f90540e50ef24fd510e1c81762f4625a10c0a9d856e7580ab7cfe28dc4d87132

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 
+
+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,71 @@
+# Contrib::Auth
+Plug-n-play vendor agnostic Rails authentication engine API. (Working in progress, not ready for production environments)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'contrib-auth'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Setup the provider:
+
+```ruby
+Contrib::Auth.configure do |config|
+  config.provider = Contrib::Auth::Provider::GoogleAuth.new(YOUR_API_KEY)
+end
+```
+
+Mount the engine in your app:
+
+```ruby
+Rails.application.routes.draw do
+  mount Contrib::Auth::Engine => "/auth"
+end
+```
+
+## Usage
+
+Once installed, the `contrib-auth` will expose authentication endpoints in your application. For instance:
+
+```bash
+curl http://localhost:3000/auth/sign_in_with_password -d '{"email":"nandosousafr@gmail.com","password":"batatinha1234"}' -H 'Content-Type: application/json'
+```
+
+If the credentials are correct, the API will respond `200` with the following response:
+
+```json
+{
+    "id_token": "[ID_TOKEN]",
+    "refresh_token": "[REFRESH_TOKEN]",
+    "expires_in": "3600",
+}
+```
+
+## Supported providers
+
+| Provider                                           | Status              |
+| ---------------------------------------------------|:-------------------:|
+| [Firebase](https://firebase.google.com/docs/auth)  | Working in progress |
+| Auth0                                              | Pending             |
+| Devise                                             | Pending             |
+
+## Contributing
+
+Requirements:
+ - Docker
+
+There are some make tasks available to quickly start working on this project:
+
+| Command                                            | Description              |
+| ---------------------------------------------------|:------------------------:|
+| make build                                         | Build the docker image   |
+| make bash                                          | Access the bash inside the container |
+
+## 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,5 @@
+require "bundler/setup"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/contrib_auth_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/contrib/auth .css

data/app/assets/stylesheets/contrib/auth/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/contrib/auth/application_controller.rb

@@ -0,0 +1,6 @@
+module Contrib
+  module Auth
+    class ApplicationController <  ActionController::API
+    end
+  end
+end

data/app/controllers/contrib/auth/authentication_controller.rb

@@ -0,0 +1,12 @@
+module Contrib
+  module Auth
+    class AuthenticationController < ApplicationController
+      def sign_in_with_password
+        @response = Contrib::Auth.api.sign_in_with_password(
+          params[:email_or_username],
+          params[:password]
+        )
+      end
+    end
+  end
+end

data/app/helpers/contrib/auth/application_helper.rb

@@ -0,0 +1,6 @@
+module Contrib
+  module Auth
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/contrib/auth/application_job.rb

@@ -0,0 +1,6 @@
+module Contrib
+  module Auth
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/contrib/auth/application_mailer.rb

@@ -0,0 +1,8 @@
+module Contrib
+  module Auth
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/models/contrib/auth/application_record.rb

@@ -0,0 +1,7 @@
+module Contrib
+  module Auth
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/views/contrib/auth/authentication/sign_in_with_password.json.jbuilder

@@ -0,0 +1 @@
+json.extract!(@response, :id_token, :refresh_token, :expires_in)

data/config/routes.rb

@@ -0,0 +1,5 @@
+Contrib::Auth::Engine.routes.draw do
+  defaults format: :json do
+    post '/sign_in_with_password' => 'authentication#sign_in_with_password'
+  end
+end

data/lib/contrib/auth/api.rb

@@ -0,0 +1,22 @@
+module Contrib
+  module Auth
+    class Api
+      def initialize(provider = nil)
+        @provider = provider
+      end
+
+      def sign_in_with_password(email_or_username, password)
+        # TODO: Implement retryable
+        @provider.sign_in_with_password(email_or_username, password)
+      end
+
+      def reset_password(email_or_username)
+        @provider.reset_password(email_or_username)
+      end
+
+      def sign_up_with_email_and_password(email_or_username, password)
+        @provider.sign_up_with_email_and_password(email_or_username, password)
+      end
+    end
+  end
+end

data/lib/contrib/auth/configuration.rb

@@ -0,0 +1,11 @@
+module Contrib
+  module Auth
+    class Configuration
+      attr_accessor :provider
+
+      def initialize(provider = nil)
+        self.provider = provider
+      end
+    end
+  end
+end

data/lib/contrib/auth/engine.rb

@@ -0,0 +1,11 @@
+module Contrib
+  module Auth
+    class Engine < ::Rails::Engine
+      isolate_namespace Contrib::Auth
+
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+    end
+  end
+end

data/lib/contrib/auth/provider/google_auth.rb

@@ -0,0 +1,76 @@
+require 'faraday'
+
+module Contrib
+  module Auth
+    module Provider
+      class GoogleAuth
+        DEFAULT_BASE_ENDPOINT = 'https://identitytoolkit.googleapis.com'.freeze
+
+        def initialize(api_key, http_client = Faraday.new(DEFAULT_BASE_ENDPOINT))
+          @api_key       = api_key
+          @http_client   = http_client
+        end
+
+        # refers to: https://firebase.google.com/docs/reference/rest/auth#section-create-email-password
+        def sign_up_with_email_and_password(email_or_username, password)
+          response = @http_client.post('/v1/accounts:signUp') do |req|
+            req.params[:key] = @api_key
+            req.headers['Content-Type'] = 'application/json'
+            req.body = JSON.generate(
+              email: email_or_username,
+              password: password,
+              returnSecureToken: true,
+            )
+          end
+
+          parsed_response = JSON.parse(response.body)
+
+          # TODO: Handle errors
+          Contrib::Auth::Provider::Responses::SignUpWithEmailAndPassword.new(
+            id_token:       parsed_response['idToken'],
+            refresh_token:  parsed_response['refreshToken'],
+            expires_in:     parsed_response['expiresIn'],
+          )
+        end
+
+        # refers to: https://firebase.google.com/docs/reference/rest/auth#section-sign-in-email-password
+        def sign_in_with_password(email_or_username, password)
+          response = @http_client.post('/v1/accounts:signInWithPassword') do |req|
+            req.params[:key] = @api_key
+            req.headers['Content-Type'] = 'application/json'
+            req.body = JSON.generate(
+              email: email_or_username,
+              password: password,
+              returnSecureToken: true,
+            )
+          end
+
+          parsed_response = JSON.parse(response.body)
+
+          # TODO: Handle errors
+          Contrib::Auth::Provider::Responses::SignInWithPassword.new(
+            id_token:       parsed_response['idToken'],
+            refresh_token:  parsed_response['refreshToken'],
+            expires_in:     parsed_response['expiresIn'],
+          )
+        end
+
+        # refers to: https://firebase.google.com/docs/reference/rest/auth#section-send-password-reset-email
+        def reset_password(email_or_username)
+          # TODO: X-Firebase-Locale optional header
+          response = @http_client.post('/v1/accounts:sendOobCode') do |req|
+            req.params[:key] = @api_key
+            req.headers['Content-Type'] = 'application/json'
+
+            req.body = JSON.generate(
+              email: email_or_username,
+              requestType: 'PASSWORD_RESET',
+            )
+          end
+
+          response.success?
+        end
+      end
+    end
+  end
+end

data/lib/contrib/auth/provider/responses/sign_in_with_password.rb

@@ -0,0 +1,19 @@
+module Contrib
+  module Auth
+    module Provider
+      module Responses
+        class SignInWithPassword
+          attr_accessor :id_token
+          attr_accessor :refresh_token
+          attr_accessor :expires_in
+
+          def initialize(params = {})
+            params.each do  |param, key|
+              public_send("#{param}=", key)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrib/auth/provider/responses/sign_up_with_email_and_password.rb

@@ -0,0 +1,19 @@
+module Contrib
+  module Auth
+    module Provider
+      module Responses
+        class SignUpWithEmailAndPassword
+          attr_accessor :id_token
+          attr_accessor :refresh_token
+          attr_accessor :expires_in
+
+          def initialize(params = {})
+            params.each do  |param, key|
+              public_send("#{param}=", key)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrib/auth/provider/responses.rb

@@ -0,0 +1,2 @@
+require 'contrib/auth/provider/responses/sign_in_with_password'
+require 'contrib/auth/provider/responses/sign_up_with_email_and_password'

data/lib/contrib/auth/version.rb

@@ -0,0 +1,5 @@
+module Contrib
+  module Auth
+    VERSION = '0.3.1'
+  end
+end

data/lib/contrib/auth.rb

@@ -0,0 +1,27 @@
+require 'rails'
+require 'jbuilder'
+
+require 'contrib/auth/api'
+require 'contrib/auth/provider/google_auth'
+require 'contrib/auth/configuration'
+require 'contrib/auth/provider/responses'
+require 'contrib/auth/version'
+require 'contrib/auth/engine'
+
+module Contrib
+  module Auth
+    class << self
+      def config
+        @@configuration ||= Configuration.new
+      end
+
+      def configure
+        yield config if block_given?
+      end
+
+      def api
+        @@api ||= Api.new(config.provider)
+      end
+    end
+  end
+end

data/lib/tasks/contrib/auth_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :contrib_auth do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: contrib-auth
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Contribyard Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Vendor-agnostic authentication component for Rails APIs
+email:
+- developers@contribyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/contrib_auth_manifest.js
+- app/assets/stylesheets/contrib/auth/application.css
+- app/controllers/contrib/auth/application_controller.rb
+- app/controllers/contrib/auth/authentication_controller.rb
+- app/helpers/contrib/auth/application_helper.rb
+- app/jobs/contrib/auth/application_job.rb
+- app/mailers/contrib/auth/application_mailer.rb
+- app/models/contrib/auth/application_record.rb
+- app/views/contrib/auth/authentication/sign_in_with_password.json.jbuilder
+- config/routes.rb
+- lib/contrib/auth.rb
+- lib/contrib/auth/api.rb
+- lib/contrib/auth/configuration.rb
+- lib/contrib/auth/engine.rb
+- lib/contrib/auth/provider/google_auth.rb
+- lib/contrib/auth/provider/responses.rb
+- lib/contrib/auth/provider/responses/sign_in_with_password.rb
+- lib/contrib/auth/provider/responses/sign_up_with_email_and_password.rb
+- lib/contrib/auth/version.rb
+- lib/tasks/contrib/auth_tasks.rake
+homepage: https://github.com/contribyard/contrib-auth
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/contribyard/contrib-auth
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Vendor-agnostic authentication component for Rails APIs
+test_files: []