rails_jwt_auth_omniauth 2.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b089f55ef748ff14d8e1f82e57acf3959e9885f20a245ec94062c6ad137a603
+  data.tar.gz: f8d99b0c40211dfc4a1a960a22dc038d4f3ea1ffc53def101fa8e219c3231cf9
+SHA512:
+  metadata.gz: 945e08fbabc1f3d77d52fc02a044412843dd655bc957498284781e426fa2b796714c3b423fff550f59358871e3a85b2c7a69925e9a9e7cd2fce4d1c94d597072
+  data.tar.gz: f54bf0bfe9231a8965acd066f650ef7c048aa527c84e88da78ab6a663dcbf07db43ce54c2f6605cfac355d0db387741439ac3129e72adf27b085d5b2019d30c6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 rjurado
+
+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,151 @@
+# RailsJwtAuthOmniauth
+
+Addon for rails_jwt_auth gem. Add omniauth capabilities to gem
+
+> This gem require rails_jwt_auth 2.x version
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Modules](#modules)
+- [ORMs support](#orms-support)
+- [Omniauth](#omniauth)
+- [Testing](#testing-rspec)
+- [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_jwt_auth'
+gem 'rails_jwt_auth_omniauth'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install rails_jwt_auth_omniauth
+```
+
+## Configuration
+
+You can edit configuration options into `config/initializers/rails_jwt_auth_omniauth.rb` file created by generator.
+
+| Option                                    | Default value              | Description                                                            |
+| ----------------------------------        | ----------------           | ---------------------------------------------------------------------- |
+
+| omniauth                                  | `nil`                      | Allow add omniauths providers |
+
+## Modules
+
+It's composed of 1 module:
+
+| Module        | Description                                                                                                     |
+| ------------- | --------------------------------------------------------------------------------------------------------------- |
+| Omniauthable  | Allows you to define behaviours for omniauth sessions                                                           |
+
+## ORMs Support
+
+**ActiveRecord**
+
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+  include RailsJwtAuth::Authenticatable
+  include RailsJwtAuthOmniath::Omniauthable
+
+  validates :email, presence: true,
+                    uniqueness: true,
+                    format: URI::MailTo::EMAIL_REGEXP
+end
+```
+
+**Mongoid**
+
+```ruby
+class User
+  include Mongoid::Document
+  include RailsJwtAuth::Authenticatable
+  include RailsJwtAuthOmniauth::Omniauthable
+
+  field :email, type: String
+
+  validates :email, presence: true,
+                    uniqueness: true,
+                    format: URI::MailTo::EMAIL_REGEXP
+end
+```
+
+## Omniauth
+
+Allow you to use omniauth providers to login in the platform. Rails_jwt_auth_omniauth will not save `auth_token`
+from providers and only will create a jwt session.
+
+To configure omniauth clients:
+
+Select a provider and define it in your Gemfile and install:
+
+```ruby
+# Gemfile
+gem 'omniauth' # Required if omniauth is not dependency in your provider gem
+gem 'omniauth-google-oauth2'
+```
+
+Configuration providers:
+
+```ruby
+# config/initialize/rails_jwt_auth.rb
+RailsJwtAuthOmniauth.setup do |config|
+  # ...
+  config.omniauth :google_oauth2, ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'], {
+    provider_ignores_state: true, # this is neccesary for CSRF in extenals requests
+    scope: 'userinfo.email, userinfo.profile'
+  }
+  # You can add multiple omniauth configurations of each provider
+end
+```
+
+In router:
+
+```ruby
+#cofig/router.rb
+post '/auth/:provider/callback', to: 'rails_jwt_auth_omniauth/omniauths#callback' # If not use generator
+```
+
+In model:
+
+```ruby
+include RailsJwtAuthOmniauth::Omniauthable
+def self.from_omniauth(auth)
+  # Define logic to search or create User. This method should return a user to be logged
+  # auth.provider: provider that has processed request
+  # auth['info']: User data from provider
+end
+```
+
+In js you will need a library to get auth_code from provider to pass the code to the backend:
+
+```js
+  // Ej: vue-google-oauth2
+  const authCode = await this.$gAuth.getAuthCode()
+  const response = await this.$http.post(
+    'http://yout-backend-server-api/auth/google_oauth2/callback',
+    { code: authCode }
+  )
+```
+
+## Locales
+
+Copy `config/locales/en.yml` into your project `config/locales` folder and edit it.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsJwtAuthOmniauth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/rails_jwt_auth_omniauth/omniauths_controller.rb

@@ -0,0 +1,24 @@
+module RailsJwtAuthOmniauth
+  class OmniauthsController < ApplicationController
+    include RailsJwtAuth::RenderHelper
+
+    def callback
+      puts '*' * 100
+      puts auth_hash
+      user = RailsJwtAuth.model_name.constantize.from_omniauth(auth_hash)
+      se = RailsJwtAuthOmniauth::OmniauthSession.new(user)
+
+      if se.generate!
+        render_session se.jwt, se.user
+      else
+        render_422 se.errors.details
+      end
+    end
+
+    protected
+
+    def auth_hash
+      request.env['omniauth.auth']
+    end
+  end
+end

data/app/models/concerns/rails_jwt_auth_omniauth/omniauthable.rb

@@ -0,0 +1,20 @@
+module RailsJwtAuthOmniauth
+  module Omniauthable
+    class NotImplementedMethod < StandardError; end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def from_omniauth(_auth)
+        raise NotImplementedMethod.new(
+          I18n.t(
+            'rails_jwt_auth.models.omniauthable.from_omniauth.not_implemented',
+            model:RailsJwtAuth.model
+          )
+        )
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  rails_jwt_auth:
+    models:
+      omniauthable:
+        from_omniauth:
+          not_implemented: "You must implement 'self.from_omniauth' in your '%{model}' model"

data/lib/rails_jwt_auth_omniauth/engine.rb

@@ -0,0 +1,16 @@
+module RailsJwtAuthOmniauth
+  class Engine < ::Rails::Engine
+    initializer(
+      'rails_jwt_auth_omniauth.omniauth',
+      after: :load_config_initializers,
+      before: :build_middleware_stack
+     ) do |app|
+      app.middleware.use ActionDispatch::Session::CacheStore
+      RailsJwtAuthOmniauth.omniauth_configs&.each do |provider, config|
+        app.middleware.use config.strategy_class, *config.args do |strategy|
+          config.strategy = strategy
+        end
+      end
+    end
+  end
+end

data/lib/rails_jwt_auth_omniauth/omniauth_manager.rb

@@ -0,0 +1,32 @@
+module RailsJwtAuthOmniauth
+  class StrategyNotFound < NameError
+    def initialize(strategy)
+      @strategy = strategy
+      super("Could not find a strategy with name `#{strategy}'. " \
+        "Please ensure it is required or explicitly set it using the :strategy_class option.")
+    end
+  end
+
+  class OmniauthManager
+    # Based on https://github.com/heartcombo/devise Config
+
+    attr_accessor :strategy
+    attr_reader :args, :options, :provider, :strategy_name
+
+    def initialize(provider, args)
+      @provider = provider
+      @args = args
+      @options = @args.last.is_a?(Hash) ? @args.last : {}
+      @strategy = nil
+      @strategy_class = nil
+      @strategy_name  = options[:name] || @provider
+    end
+
+    def strategy_class
+      @strategy_class ||= ::OmniAuth.strategies.find do |strategy|
+        strategy.to_s =~ /#{::OmniAuth::Utils.camelize(strategy_name)}$/ ||
+          strategy.default_options[:name] == strategy_name
+      end
+    end
+  end
+end

data/lib/rails_jwt_auth_omniauth/omniauth_session.rb

@@ -0,0 +1,56 @@
+require 'rails_jwt_auth/session'
+
+module RailsJwtAuthOmniauth
+  class OmniauthSession < RailsJwtAuth::Session
+
+    attr_reader :user, :errors, :jwt
+
+    def initialize(user)
+      @user = user
+    end
+
+    def valid?
+      validate!
+
+      !errors?
+    end
+
+    def generate!
+      if valid?
+        @user.clean_reset_password if recoverable?
+        @user.clean_lock if lockable?
+        @user.load_auth_token
+
+        unless user.save
+          add_error(RailsJwtAuth.model_name.underscore, :invalid)
+
+          return false
+        end
+
+        generate_jwt(nil)
+
+        true
+      else
+        @user.failed_attempt if lockable?
+
+        false
+      end
+    end
+
+    private
+
+    def validate!
+      # Can't use ActiveModel::Validations since we have dynamic fields
+      @errors = Errors.new({})
+
+      validate_user
+      validate_user_is_confirmed if confirmable?
+      validate_user_is_not_locked if lockable?
+      validate_custom
+    end
+
+    def validate_user
+      add_error(:session, :not_found) if @user.blank?
+    end
+  end
+end

data/lib/rails_jwt_auth_omniauth/version.rb

@@ -0,0 +1,3 @@
+module RailsJwtAuthOmniauth
+  VERSION = '2.0.3'
+end

data/lib/rails_jwt_auth_omniauth.rb

@@ -0,0 +1,17 @@
+require 'rails_jwt_auth'
+require 'rails_jwt_auth_omniauth/engine'
+require 'rails_jwt_auth_omniauth/omniauth_manager'
+require 'rails_jwt_auth_omniauth/omniauth_session'
+
+module RailsJwtAuthOmniauth
+  mattr_accessor :omniauth_configs
+  self.omniauth_configs = {}
+
+  def self.setup
+    yield self
+  end
+
+  def self.omniauth(provider, *args)
+    omniauth_configs[provider] = RailsJwtAuthOmniauth::OmniauthManager.new(provider, args)
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rails_jwt_auth_omniauth
+version: !ruby/object:Gem::Version
+  version: 2.0.3
+platform: ruby
+authors:
+- jmjurado23
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails_jwt_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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'
+description: Addon for rails_jwt_auth gem. Add omniauth capabilities to gem
+email:
+- jmjurado23@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/rails_jwt_auth_omniauth/omniauths_controller.rb
+- app/models/concerns/rails_jwt_auth_omniauth/omniauthable.rb
+- config/locales/en.yml
+- lib/rails_jwt_auth_omniauth.rb
+- lib/rails_jwt_auth_omniauth/engine.rb
+- lib/rails_jwt_auth_omniauth/omniauth_manager.rb
+- lib/rails_jwt_auth_omniauth/omniauth_session.rb
+- lib/rails_jwt_auth_omniauth/version.rb
+homepage: https://github.com/jmjurado23/rails_jwt_auth_omniauth
+licenses:
+- MIT
+metadata: {}
+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.31
+signing_key: 
+specification_version: 4
+summary: Rails jwt authentication Omniauthable.
+test_files: []