devise_jwt_auth 0.1.4 → 0.2.0

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.4'.freeze
+  VERSION = '0.2.0'
 end

data/lib/generators/devise_jwt_auth/USAGE

@@ -8,7 +8,7 @@ Arguments:
              # 'User'
   MOUNT_PATH # The path at which to mount the authentication routes. Default is
              # 'auth'. More detail documentation is here:
-             # https://devise-token-auth.gitbook.io/devise-token-auth/usage
+             # https://github.com/aarona/devise_jwt_auth
 
 Example:
   rails generate devise_jwt_auth:install User auth

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.connection_db_config.configuration_hash
+            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

data/lib/generators/devise_jwt_auth/templates/devise_jwt_auth.rb

@@ -6,7 +6,7 @@ DeviseJwtAuth.setup do |config|
   # use the HTTP only refresh cookie that is sent during the authentication
   # process and make refresh token requests.
   # config.send_new_access_token_on_each_request = false
-  
+
   # By default, refresh token HTTP Only cookies last for 2 weeks. These tokens
   # are used for requesting shorter-lived acccess tokens.
   # config.refresh_token_lifespan = 2.weeks
@@ -29,13 +29,13 @@ DeviseJwtAuth.setup do |config|
   # config.access_token_name = 'access-token'
 
   # This is the refresh token encryption key. You should set this in an
-  # environment variable or secret key base that isn't store in a repository.
+  # environment variable or secret key base that isn't stored in a repository.
   # Also, its a good idea to NOT use the same key for access tokens.
   config.refresh_token_encryption_key = 'your-refresh-token-secret-key-here'
-  
-  # This is the refresh token encryption key. You should set this in an
-  # environment variable or secret key base that isn't store in a repository.
-  # Also, its a good idea to NOT use the same key for access tokens.
+
+  # This is the access token encryption key. You should set this in an
+  # environment variable or secret key base that isn't stored in a repository.
+  # Also, its a good idea to NOT use the same key for refresh tokens.
   config.access_token_encryption_key = 'your-access-token-secret-key-here'
 
   # This route will be the prefix for all oauth2 redirect callbacks. For
@@ -70,5 +70,4 @@ DeviseJwtAuth.setup do |config|
   # config.update_token_version_after_password_reset = true
   # config.bypass_sign_in                            = true
   # config.require_client_password_reset_token       = false
-
 end

data/lib/generators/devise_jwt_auth/templates/devise_jwt_auth_create_users.rb.erb

@@ -2,12 +2,18 @@
 
 class DeviseJwtAuthCreate<%= user_class.pluralize.gsub("::","") %> < ActiveRecord::Migration<%= "[#{Rails::VERSION::STRING[0..2]}]" if Rails::VERSION::MAJOR > 4 %>
   def change
-    <% table_name = @user_class.pluralize.gsub("::","").underscore %>
-    create_table(:<%= table_name %><%= primary_key_type %>) do |t|
+    <% table_name = @user_class.pluralize.gsub("::","").underscore -%>
+create_table(:<%= table_name %><%= primary_key_type %>) do |t|
       ## Required
       t.string :provider, null: false, default: 'email'
       t.string :uid, null: false, default: ''
 
+      ## User Info
+      t.string :name
+      t.string :nickname
+      t.string :image
+      t.string :email
+
       ## Database authenticatable
       t.string :encrypted_password, null: false, default: ''
 
@@ -19,6 +25,13 @@ class DeviseJwtAuthCreate<%= user_class.pluralize.gsub("::","") %> < ActiveRecor
       ## Rememberable
       t.datetime :remember_created_at
 
+      ## Trackable
+      # t.integer  :sign_in_count, default: 0, null: false
+      # t.datetime :current_sign_in_at
+      # t.datetime :last_sign_in_at
+      # t.<%= ip_column %> :current_sign_in_ip
+      # t.<%= ip_column %> :last_sign_in_ip
+
       ## Confirmable
       t.string   :confirmation_token
       t.datetime :confirmed_at
@@ -30,15 +43,6 @@ class DeviseJwtAuthCreate<%= user_class.pluralize.gsub("::","") %> < ActiveRecor
       # t.string   :unlock_token # Only if unlock strategy is :email or :both
       # t.datetime :locked_at
 
-      ## User Info
-      t.string :name
-      t.string :nickname
-      t.string :image
-      t.string :email
-
-      ## Tokens
-      <%= json_supported_database? ? 't.json :tokens' : 't.text :tokens' %>
-
       t.timestamps
     end
 

data/lib/generators/devise_jwt_auth/templates/user.rb.erb

@@ -2,8 +2,8 @@
 
 class <%= user_class %> < ActiveRecord::Base
   # Include default devise modules. Others available are:
-  # :confirmable, :lockable, :timeoutable and :omniauthable
+  # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
   devise :database_authenticatable, :registerable,
-         :recoverable, :rememberable, :trackable, :validatable
+         :recoverable, :rememberable, :validatable
   include DeviseJwtAuth::Concerns::User
 end

data/test/controllers/custom/custom_confirmations_controller_test.rb

@@ -10,8 +10,8 @@ class Custom::ConfirmationsControllerTest < ActionController::TestCase
       @redirect_url = Faker::Internet.url
       @new_user = create(:user)
       @new_user.send_confirmation_instructions(redirect_url: @redirect_url)
-      @mail          = ActionMailer::Base.deliveries.last
-      @token         = @mail.body.match(/confirmation_token=([^&]*)&/)[1]
+      @mail = ActionMailer::Base.deliveries.last
+      @token = @mail.body.match(/confirmation_token=([^&]*)&/)[1]
       @client_config = @mail.body.match(/config=([^&]*)&/)[1]
 
       get :show,

data/test/controllers/custom/custom_omniauth_callbacks_controller_test.rb

@@ -19,7 +19,7 @@ class Custom::OmniauthCallbacksControllerTest < ActionDispatch::IntegrationTest
     end
 
     test 'yield resource to block on omniauth_success success' do
-      @redirect_url = 'http://ng-token-auth.dev/'
+      @redirect_url = 'http://ng-jwt-auth.dev/'
       get '/nice_user_auth/facebook',
           params: { auth_origin_url: @redirect_url,
                     omniauth_window_type: 'newWindow' }

data/test/controllers/custom/custom_passwords_controller_test.rb

@@ -8,20 +8,20 @@ class Custom::PasswordsControllerTest < ActionController::TestCase
 
     before do
       @resource = create(:user, :confirmed)
-      @redirect_url = 'http://ng-token-auth.dev'
+      @redirect_url = 'http://ng-jwt-auth.dev'
     end
 
     test 'yield resource to block on create success' do
       post :create,
-           params: { email:  @resource.email,
+           params: { email: @resource.email,
                      redirect_url: @redirect_url }
 
       @mail = ActionMailer::Base.deliveries.last
       @resource.reload
 
-      @mail_config_name  = CGI.unescape(@mail.body.match(/config=([^&]*)&/)[1])
+      # @mail_config_name  = CGI.unescape(@mail.body.match(/config=([^&]*)&/)[1])
       @mail_redirect_url = CGI.unescape(@mail.body.match(/redirect_url=([^&]*)&/)[1])
-      @mail_reset_token  = @mail.body.match(/reset_password_token=(.*)\"/)[1]
+      @mail_reset_token  = @mail.body.match(/reset_password_token=(.*)"/)[1]
 
       assert @controller.create_block_called?,
              'create failed to yield resource to provided block'
@@ -29,19 +29,19 @@ class Custom::PasswordsControllerTest < ActionController::TestCase
 
     test 'yield resource to block on edit success' do
       @resource = create(:user)
-      @redirect_url = 'http://ng-token-auth.dev'
+      @redirect_url = 'http://ng-jwt-auth.dev'
 
       post :create,
-           params: { email:  @resource.email,
+           params: { email: @resource.email,
                      redirect_url: @redirect_url },
            xhr: true
 
       @mail = ActionMailer::Base.deliveries.last
       @resource.reload
 
-      @mail_config_name  = CGI.unescape(@mail.body.match(/config=([^&]*)&/)[1])
+      # @mail_config_name  = CGI.unescape(@mail.body.match(/config=([^&]*)&/)[1])
       @mail_redirect_url = CGI.unescape(@mail.body.match(/redirect_url=([^&]*)&/)[1])
-      @mail_reset_token  = @mail.body.match(/reset_password_token=(.*)\"/)[1]
+      @mail_reset_token  = @mail.body.match(/reset_password_token=(.*)"/)[1]
 
       get :edit,
           params: { reset_password_token: @mail_reset_token,

data/test/controllers/custom/custom_refresh_token_controller_test.rb

@@ -9,8 +9,7 @@ class Custom::RefreshTokenControllerTest < ActionDispatch::IntegrationTest
     before do
       @resource = create(:user, :confirmed)
       @auth_headers = get_cookie_header(DeviseJwtAuth.refresh_token_name,
-                                        @resource.create_refresh_token
-      )
+                                        @resource.create_refresh_token)
     end
 
     test 'yield resource to block on refresh_token success' do
@@ -33,4 +32,4 @@ class Custom::RefreshTokenControllerTest < ActionDispatch::IntegrationTest
       assert_equal @data['custom'], 'foo'
     end
   end
-end
+end

data/test/controllers/custom/custom_registrations_controller_test.rb

@@ -8,8 +8,8 @@ class Custom::RegistrationsControllerTest < ActionDispatch::IntegrationTest
 
     before do
       @create_params = attributes_for(:user,
-        confirm_success_url: Faker::Internet.url,
-        unpermitted_param: '(x_x)')
+                                      confirm_success_url: Faker::Internet.url,
+                                      unpermitted_param: '(x_x)')
 
       @existing_user = create(:user, :confirmed)
       @auth_headers = @existing_user.create_named_token_pair

data/test/controllers/demo_group_controller_test.rb

@@ -16,33 +16,17 @@ class DemoGroupControllerTest < ActionDispatch::IntegrationTest
         @resource = create(:user, :confirmed)
         @resource_auth_headers = @resource.create_named_token_pair
 
-        # @resource_token     = @resource_auth_headers['access-token']
-        # @resource_client_id = @resource_auth_headers['client']
-        # @resource_expiry    = @resource_auth_headers['expiry']
-
         # mang
         @mang = create(:mang_user, :confirmed)
 
         @mang_auth_headers = @mang.create_named_token_pair
-
-        # @mang_token     = @mang_auth_headers['access-token']
-        # @mang_client_id = @mang_auth_headers['client']
-        # @mang_expiry    = @mang_auth_headers['expiry']
       end
 
       describe 'user access' do
         before do
-          # ensure that request is not treated as batch request
-          # age_token(@resource, @resource_client_id)
-
           get '/demo/members_only_group',
               params: {},
               headers: @resource_auth_headers
-
-          @resp_token       = response.headers['access-token']
-          @resp_client_id   = response.headers['client']
-          @resp_expiry      = response.headers['expiry']
-          @resp_uid         = response.headers['uid']
         end
 
         test 'request is successful' do
@@ -82,17 +66,9 @@ class DemoGroupControllerTest < ActionDispatch::IntegrationTest
 
       describe 'mang access' do
         before do
-          # ensure that request is not treated as batch request
-          # age_token(@mang, @mang_client_id)
-
           get '/demo/members_only_group',
               params: {},
               headers: @mang_auth_headers
-
-          @resp_token       = response.headers['access-token']
-          @resp_client_id   = response.headers['client']
-          @resp_expiry      = response.headers['expiry']
-          @resp_uid         = response.headers['uid']
         end
 
         test 'request is successful' do