devise_jwt_auth 0.1.1 → 0.1.6

data/app/models/devise_jwt_auth/concerns/mongoid_support.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# ActiveSupport Concern for Mongoid support
 module DeviseJwtAuth::Concerns::MongoidSupport
   extend ActiveSupport::Concern
 

data/app/models/devise_jwt_auth/concerns/tokens_serialization.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
+# Dumping and loading serialized tokens in JSON format.
 module DeviseJwtAuth::Concerns::TokensSerialization
   # Serialization hash to json
   def self.dump(object)
-    object.each_value(&:compact!) unless object.nil?
+    object&.each_value(&:compact!)
     JSON.generate(object)
   end
 

data/app/models/devise_jwt_auth/concerns/user.rb

@@ -22,14 +22,20 @@ module DeviseJwtAuth::Concerns::User
       include DeviseJwtAuth::Concerns::MongoidSupport
     end
 
-    if DeviseJwtAuth.default_callbacks
-      include DeviseJwtAuth::Concerns::UserOmniauthCallbacks
-    end
+    include DeviseJwtAuth::Concerns::UserOmniauthCallbacks if DeviseJwtAuth.default_callbacks
 
     # don't use default devise email validation
-    def email_required?; false; end
-    def email_changed?; false; end
-    def will_save_change_to_email?; false; end
+    def email_required?
+      false
+    end
+
+    def email_changed?
+      false
+    end
+
+    def will_save_change_to_email?
+      false
+    end
 
     if DeviseJwtAuth.send_confirmation_email && devise_modules.include?(:confirmable)
       include DeviseJwtAuth::Concerns::ConfirmableSupport
@@ -37,6 +43,7 @@ module DeviseJwtAuth::Concerns::User
 
     def password_required?
       return false unless provider == 'email'
+
       super
     end
 
@@ -77,11 +84,11 @@ module DeviseJwtAuth::Concerns::User
     end
 
     def create_token(token_options = {})
-      DeviseJwtAuth::TokenFactory.create_access_token({sub: uid}.merge(token_options))
+      DeviseJwtAuth::TokenFactory.create_access_token({ sub: uid }.merge(token_options))
     end
 
     def create_refresh_token(token_options = {})
-      DeviseJwtAuth::TokenFactory.create_refresh_token({sub: uid}.merge(token_options))
+      DeviseJwtAuth::TokenFactory.create_refresh_token({ sub: uid }.merge(token_options))
     end
   end
 
@@ -93,7 +100,9 @@ module DeviseJwtAuth::Concerns::User
 
   # this must be done from the controller so that additional params
   # can be passed on from the client
-  def send_confirmation_notification?; false; end
+  def send_confirmation_notification?
+    false
+  end
 
   def build_auth_url(base_url, args)
     args[:uid]    = uid

data/app/models/devise_jwt_auth/concerns/user_omniauth_callbacks.rb

@@ -4,12 +4,20 @@ module DeviseJwtAuth::Concerns::UserOmniauthCallbacks
   extend ActiveSupport::Concern
 
   included do
-    validates :email, presence: true,if: :email_provider?
-    validates :email, :devise_jwt_auth_email => true, allow_nil: true, allow_blank: true, if: :email_provider?
+    validates :email, presence: true, if: :email_provider?
+    validates :email,
+              devise_jwt_auth_email: true,
+              allow_nil: true,
+              allow_blank: true,
+              if: :email_provider?
+
     validates_presence_of :uid, unless: :email_provider?
 
     # only validate unique emails among email registration users
-    validates :email, uniqueness: { case_sensitive: false, scope: :provider }, on: :create, if: :email_provider?
+    validates :email,
+              uniqueness: { case_sensitive: false, scope: :provider },
+              on: :create,
+              if: :email_provider?
 
     # keep uid in sync with email
     before_save :sync_uid

data/app/validators/devise_jwt_auth_email_validator.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+# Email field validator.
 class DeviseJwtAuthEmailValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    unless value =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
-      record.errors[attribute] << email_invalid_message
-    end
+    return if value =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+
+    record.errors[attribute] << email_invalid_message
   end
 
   private
@@ -14,7 +15,7 @@ class DeviseJwtAuthEmailValidator < ActiveModel::EachValidator
     message = options[:message]
 
     if message.nil?
-      # Try DeviceTokenAuth translations or fallback to ActiveModel translations
+      # Try DeviseJwtAuth translations or fallback to ActiveModel translations
       message = I18n.t(:'errors.messages.not_email', default: :'errors.messages.invalid')
     end
 

data/lib/devise_jwt_auth/blacklist.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # don't serialize tokens
 Devise::Models::Authenticatable::BLACKLIST_FOR_SERIALIZATION << :tokens

data/lib/devise_jwt_auth/controllers/url_helpers.rb

@@ -3,8 +3,7 @@
 module DeviseJwtAuth
   module Controllers
     module UrlHelpers
-      def self.define_helpers(mapping)
-      end
+      def self.define_helpers(mapping); end
     end
   end
 end

data/lib/devise_jwt_auth/engine.rb

@@ -33,7 +33,7 @@ module DeviseJwtAuth
 
   self.send_new_access_token_on_each_request     = false
   self.refresh_token_lifespan                    = 1.week
-  self.access_token_lifespan                     = 1.day
+  self.access_token_lifespan                     = 15.minutes
   self.refresh_token_name                        = 'refresh-token'
   self.access_token_name                         = 'access-token'
   self.refresh_token_encryption_key              = 'your-refresh-token-secret-key-here'
@@ -51,12 +51,12 @@ module DeviseJwtAuth
   self.send_confirmation_email                   = false
   self.require_client_password_reset_token       = false
 
-  def self.setup(&block)
+  def self.setup
     yield self
 
     Rails.application.config.after_initialize do
       if defined?(::OmniAuth)
-        ::OmniAuth::config.path_prefix = Devise.omniauth_path_prefix = omniauth_prefix
+        ::OmniAuth.config.path_prefix = Devise.omniauth_path_prefix = omniauth_prefix
 
         # Omniauth currently does not pass along omniauth.params upon failure redirect
         # see also: https://github.com/intridea/omniauth/issues/626
@@ -84,7 +84,7 @@ module DeviseJwtAuth
               fail!(mocked_auth)
             else
               @env['omniauth.auth'] = mocked_auth
-              OmniAuth.config.before_callback_phase.call(@env) if OmniAuth.config.before_callback_phase
+              OmniAuth.config.before_callback_phase&.call(@env)
               call_app!
             end
           end

data/lib/devise_jwt_auth/rails/routes.rb

@@ -8,14 +8,13 @@ module ActionDispatch::Routing
       opts[:skip]        ||= []
 
       # check for ctrl overrides, fall back to defaults
-      sessions_ctrl          = opts[:controllers][:sessions] || 'devise_jwt_auth/sessions'
-      registrations_ctrl     = opts[:controllers][:registrations] || 'devise_jwt_auth/registrations'
-      passwords_ctrl         = opts[:controllers][:passwords] || 'devise_jwt_auth/passwords'
-      confirmations_ctrl     = opts[:controllers][:confirmations] || 'devise_jwt_auth/confirmations'
-      # token_validations_ctrl = opts[:controllers][:token_validations] || 'devise_jwt_auth/token_validations'
-      refresh_token_ctrl     = opts[:controllers][:refresh_token] || 'devise_jwt_auth/refresh_token'
-      omniauth_ctrl          = opts[:controllers][:omniauth_callbacks] || 'devise_jwt_auth/omniauth_callbacks'
-      unlocks_ctrl           = opts[:controllers][:unlocks] || 'devise_jwt_auth/unlocks'
+      sessions_ctrl      = opts[:controllers][:sessions] || 'devise_jwt_auth/sessions'
+      registrations_ctrl = opts[:controllers][:registrations] || 'devise_jwt_auth/registrations'
+      passwords_ctrl     = opts[:controllers][:passwords] || 'devise_jwt_auth/passwords'
+      confirmations_ctrl = opts[:controllers][:confirmations] || 'devise_jwt_auth/confirmations'
+      refresh_token_ctrl = opts[:controllers][:refresh_token] || 'devise_jwt_auth/refresh_token'
+      omniauth_ctrl      = opts[:controllers][:omniauth_callbacks] || 'devise_jwt_auth/omniauth_callbacks'
+      unlocks_ctrl       = opts[:controllers][:unlocks] || 'devise_jwt_auth/unlocks'
 
       # define devise controller mappings
       controllers = { sessions: sessions_ctrl,
@@ -26,7 +25,7 @@ module ActionDispatch::Routing
       controllers[:unlocks] = unlocks_ctrl if unlocks_ctrl
 
       # remove any unwanted devise modules
-      opts[:skip].each{ |item| controllers.delete(item) }
+      opts[:skip].each { |item| controllers.delete(item) }
 
       devise_for resource.pluralize.underscore.gsub('/', '_').to_sym,
                  class_name: resource,
@@ -44,12 +43,12 @@ module ActionDispatch::Routing
 
         # clear scope so controller routes aren't namespaced
         @scope = ActionDispatch::Routing::Mapper::Scope.new(
-          path:         '',
+          path: '',
           shallow_path: '',
-          constraints:  {},
-          defaults:     {},
-          options:      {},
-          parent:       nil
+          constraints: {},
+          defaults: {},
+          options: {},
+          parent: nil
         )
 
         mapping_name = resource.underscore.gsub('/', '_')
@@ -57,22 +56,34 @@ module ActionDispatch::Routing
 
         devise_scope mapping_name.to_sym do
           # path to refresh access tokens
-          get "#{full_path}/refresh_token", controller: refresh_token_ctrl.to_s, action: 'show' if !opts[:skip].include?(:refresh_token)
-          # get "#{full_path}/validate_token", controller: token_validations_ctrl.to_s, action: 'validate_token' if !opts[:skip].include?(:token_validations)
+          unless opts[:skip].include?(:refresh_token)
+            get "#{full_path}/refresh_token", controller: refresh_token_ctrl.to_s, action: 'show'
+          end
 
           # omniauth routes. only define if omniauth is installed and not skipped.
           if defined?(::OmniAuth) && !opts[:skip].include?(:omniauth_callbacks)
-            match "#{full_path}/failure",             controller: omniauth_ctrl, action: 'omniauth_failure', via: [:get]
-            match "#{full_path}/:provider/callback",  controller: omniauth_ctrl, action: 'omniauth_success', via: [:get]
-
-            match "#{DeviseJwtAuth.omniauth_prefix}/:provider/callback", controller: omniauth_ctrl, action: 'redirect_callbacks', via: [:get, :post]
-            match "#{DeviseJwtAuth.omniauth_prefix}/failure", controller: omniauth_ctrl, action: 'omniauth_failure', via: [:get, :post]
+            match "#{full_path}/failure",
+                  controller: omniauth_ctrl,
+                  action: 'omniauth_failure',
+                  via: [:get]
+            match "#{full_path}/:provider/callback",
+                  controller: omniauth_ctrl,
+                  action: 'omniauth_success',
+                  via: [:get]
+            match "#{DeviseJwtAuth.omniauth_prefix}/:provider/callback",
+                  controller: omniauth_ctrl,
+                  action: 'redirect_callbacks',
+                  via: [:get, :post]
+            match "#{DeviseJwtAuth.omniauth_prefix}/failure",
+                  controller: omniauth_ctrl,
+                  action: 'omniauth_failure',
+                  via: [:get, :post]
 
             # preserve the resource class thru oauth authentication by setting name of
             # resource as "resource_class" param
-            match "#{full_path}/:provider", to: redirect{ |params, request|
+            match "#{full_path}/:provider", to: redirect { |params, request|
               # get the current querystring
-              qs = CGI::parse(request.env['QUERY_STRING'])
+              qs = CGI.parse(request.env['QUERY_STRING'])
 
               # append name of current resource
               qs['resource_class'] = [resource]
@@ -80,7 +91,7 @@ module ActionDispatch::Routing
 
               set_omniauth_path_prefix!(DeviseJwtAuth.omniauth_prefix)
 
-              redirect_params = {}.tap { |hash| qs.each{ |k, v| hash[k] = v.first } }
+              redirect_params = {}.tap { |hash| qs.each { |k, v| hash[k] = v.first } }
 
               if DeviseJwtAuth.redirect_whitelist
                 redirect_url = request.params['auth_origin_url']

data/lib/devise_jwt_auth/token_factory.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'jwt'
 
 module DeviseJwtAuth
   # A token management factory which allow generate token objects and check them.
   module TokenFactory
-
     def self.create_refresh_token(payload)
       if payload[:exp].blank? && payload['exp'].blank?
         payload[:exp] = (Time.zone.now + DeviseJwtAuth.refresh_token_lifespan).to_i
@@ -33,7 +34,7 @@ module DeviseJwtAuth
     rescue TypeError
       {}
     end
-    
+
     def self.decode_access_token(token)
       JWT.decode(token, DeviseJwtAuth.access_token_encryption_key).first
     rescue JWT::ExpiredSignature

data/lib/devise_jwt_auth/url.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 module DeviseJwtAuth::Url
-
   def self.generate(url, params = {})
     uri = URI(url)
 
     res = "#{uri.scheme}://#{uri.host}"
-    res += ":#{uri.port}" if (uri.port && uri.port != 80 && uri.port != 443)
+    res += ":#{uri.port}" if uri.port && uri.port != 80 && uri.port != 443
     res += uri.path.to_s if uri.path
     query = [uri.query, params.to_query].reject(&:blank?).join('&')
     res += "?#{query}"
@@ -28,7 +27,7 @@ module DeviseJwtAuth::Url
   # wildcard convenience class
   class Wildcat
     def self.parse_to_regex(str)
-      escaped = Regexp.escape(str).gsub('\*','.*?')
+      escaped = Regexp.escape(str).gsub('\*', '.*?')
       Regexp.new("^#{escaped}$", Regexp::IGNORECASE)
     end
 
@@ -40,5 +39,4 @@ module DeviseJwtAuth::Url
       !!@regex.match(str)
     end
   end
-
 end

data/lib/devise_jwt_auth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeviseJwtAuth
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.6'
 end

data/lib/generators/devise_jwt_auth/install_generator.rb

@@ -10,12 +10,12 @@ module DeviseJwtAuth
     class_option :primary_key_type, type: :string, desc: 'The type for primary key'
 
     def copy_migrations
-      if self.class.migration_exists?('db/migrate', "devise_jwt_auth_create_#{user_class.pluralize.gsub('::','').underscore}")
-        say_status('skipped', "Migration 'devise_jwt_auth_create_#{user_class.pluralize.gsub('::','').underscore}' already exists")
+      if self.class.migration_exists?('db/migrate', "devise_jwt_auth_create_#{user_class.pluralize.gsub('::', '').underscore}")
+        say_status('skipped', "Migration 'devise_jwt_auth_create_#{user_class.pluralize.gsub('::', '').underscore}' already exists")
       else
         migration_template(
           'devise_jwt_auth_create_users.rb.erb',
-          "db/migrate/devise_jwt_auth_create_#{user_class.pluralize.gsub('::','').underscore}.rb"
+          "db/migrate/devise_jwt_auth_create_#{user_class.pluralize.gsub('::', '').underscore}.rb"
         )
       end
     end
@@ -26,8 +26,9 @@ module DeviseJwtAuth
         inclusion = 'include DeviseJwtAuth::Concerns::User'
         unless parse_file_for_line(fname, inclusion)
 
-          active_record_needle = (Rails::VERSION::MAJOR == 5) ? 'ApplicationRecord' : 'ActiveRecord::Base'
-          inject_into_file fname, after: "class #{user_class} < #{active_record_needle}\n" do <<-'RUBY'
+          active_record_needle = Rails::VERSION::MAJOR == 5 ? 'ApplicationRecord' : 'ActiveRecord::Base'
+          inject_into_file fname, after: "class #{user_class} < #{active_record_needle}\n" do
+            <<-'RUBY'
             # Include default devise modules.
             devise :database_authenticatable, :registerable,
                     :recoverable, :rememberable, :trackable, :validatable,
@@ -43,7 +44,7 @@ module DeviseJwtAuth
 
     private
 
-    def self.next_migration_number(path)
+    def self.next_migration_number(_path)
       Time.zone.now.utc.strftime('%Y%m%d%H%M%S')
     end
 

data/lib/generators/devise_jwt_auth/install_generator_helpers.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module DeviseJwtAuth
+  # Helper methods for installation generators.
   module InstallGeneratorHelpers
     class << self
       def included(mod)
@@ -19,15 +22,19 @@ module DeviseJwtAuth
             if File.exist?(File.join(destination_root, fname))
               if parse_file_for_line(fname, line)
                 say_status('skipped', 'Concern is already included in the application controller.')
-              elsif is_rails_api?
-                inject_into_file fname, after: "class ApplicationController < ActionController::API\n" do <<-'RUBY'
+              elsif rails_api?
+                inject_into_file fname,
+                                 after: "class ApplicationController < ActionController::API\n" do
+                  <<-'RUBY'
         include DeviseJwtAuth::Concerns::SetUserByToken
-                RUBY
+                  RUBY
                 end
               else
-                inject_into_file fname, after: "class ApplicationController < ActionController::Base\n" do <<-'RUBY'
+                inject_into_file fname,
+                                 after: "class ApplicationController < ActionController::Base\n" do
+                  <<-'RUBY'
         include DeviseJwtAuth::Concerns::SetUserByToken
-                RUBY
+                  RUBY
                 end
               end
             else
@@ -67,6 +74,20 @@ module DeviseJwtAuth
             end
           end
 
+          def ip_column
+            # Padded with spaces so it aligns nicely with the rest of the columns.
+            format('%-8s', (inet? ? 'inet' : 'string'))
+          end
+
+          def inet?
+            postgresql?
+          end
+
+          def postgresql?
+            config = ActiveRecord::Base.configurations[Rails.env]
+            config && config['adapter'] == 'postgresql'
+          end
+
           private
 
           def insert_after_line(filename, line, str)
@@ -86,7 +107,7 @@ module DeviseJwtAuth
             match
           end
 
-          def is_rails_api?
+          def rails_api?
             fname = 'app/controllers/application_controller.rb'
             line = 'class ApplicationController < ActionController::API'
             parse_file_for_line(fname, line)

data/lib/generators/devise_jwt_auth/install_mongoid_generator.rb

@@ -3,6 +3,7 @@
 require_relative 'install_generator_helpers'
 
 module DeviseJwtAuth
+  # Adds Mongoid settings to ORM
   class InstallMongoidGenerator < Rails::Generators::Base
     include DeviseJwtAuth::InstallGeneratorHelpers
 
@@ -11,8 +12,8 @@ module DeviseJwtAuth
       if File.exist?(File.join(destination_root, fname))
         inclusion = 'include DeviseJwtAuth::Concerns::User'
         unless parse_file_for_line(fname, inclusion)
-          inject_into_file fname, before: /end\s\z/ do <<-'RUBY'
-
+          inject_into_file fname, before: /end\s\z/ do
+            <<-'RUBY'
   include Mongoid::Locker
 
   field :locker_locked_at, type: Time