devise_token_auth 0.2.0 → 1.0.0.rc1

data/lib/devise_token_auth.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "devise"
-require "devise_token_auth/engine"
-require "devise_token_auth/controllers/helpers"
-require "devise_token_auth/controllers/url_helpers"
-require "devise_token_auth/url"
-require "devise_token_auth/errors"
+require 'devise'
+require 'devise_token_auth/engine'
+require 'devise_token_auth/controllers/helpers'
+require 'devise_token_auth/controllers/url_helpers'
+require 'devise_token_auth/url'
+require 'devise_token_auth/errors'
 
 module DeviseTokenAuth
 end

data/lib/devise_token_auth/controllers/helpers.rb

@@ -28,8 +28,8 @@ module DeviseTokenAuth
         #     before_action ->{ authenticate_blogger! :admin }  # Redirects to the admin login page
         #     current_blogger :user                             # Preferably returns a User if one is signed in
         #
-        def devise_token_auth_group(group_name, opts={})
-          mappings = "[#{ opts[:contains].map { |m| ":#{m}" }.join(',') }]"
+        def devise_token_auth_group(group_name, opts = {})
+          mappings = "[#{opts[:contains].map { |m| ":#{m}" }.join(',')}]"
 
           class_eval <<-METHODS, __FILE__, __LINE__ + 1
             def authenticate_#{group_name}!(favourite=nil, opts={})
@@ -75,7 +75,12 @@ module DeviseTokenAuth
             end
 
             if respond_to?(:helper_method)
-              helper_method "current_#{group_name}", "current_#{group_name.to_s.pluralize}", "#{group_name}_signed_in?", "render_authenticate_error"
+              helper_method(
+                "current_#{group_name}",
+                "current_#{group_name.to_s.pluralize}",
+                "#{group_name}_signed_in?",
+                "render_authenticate_error"
+              )
             end
           METHODS
         end
@@ -142,7 +147,12 @@ module DeviseTokenAuth
 
         ActiveSupport.on_load(:action_controller) do
           if respond_to?(:helper_method)
-            helper_method "current_#{mapping}", "#{mapping}_signed_in?", "#{mapping}_session", "render_authenticate_error"
+            helper_method(
+              "current_#{mapping}",
+              "#{mapping}_signed_in?",
+              "#{mapping}_session",
+              'render_authenticate_error'
+            )
           end
         end
       end

data/lib/devise_token_auth/engine.rb

@@ -6,7 +6,7 @@ module DeviseTokenAuth
   class Engine < ::Rails::Engine
     isolate_namespace DeviseTokenAuth
 
-    initializer "devise_token_auth.url_helpers" do
+    initializer 'devise_token_auth.url_helpers' do
       Devise.helpers << DeviseTokenAuth::Controllers::Helpers
     end
   end
@@ -38,11 +38,11 @@ module DeviseTokenAuth
   self.enable_standard_devise_support       = false
   self.remove_tokens_after_password_reset   = false
   self.default_callbacks                    = true
-  self.headers_names                        = {:'access-token' => 'access-token',
-                                               :'client' => 'client',
-                                               :'expiry' => 'expiry',
-                                               :'uid' => 'uid',
-                                               :'token-type' => 'token-type' }
+  self.headers_names                        = { 'access-token': 'access-token',
+                                                'client': 'client',
+                                                'expiry': 'expiry',
+                                                'uid': 'uid',
+                                                'token-type': 'token-type' }
   self.bypass_sign_in                       = true
 
   def self.setup(&block)
@@ -50,23 +50,21 @@ module DeviseTokenAuth
 
     Rails.application.config.after_initialize do
       if defined?(::OmniAuth)
-        ::OmniAuth::config.path_prefix = Devise.omniauth_path_prefix = self.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
         OmniAuth::FailureEndpoint.class_eval do
           def redirect_to_failure
             message_key = env['omniauth.error.type']
-            origin_query_param = env['omniauth.origin'] ? "&origin=#{CGI.escape(env['omniauth.origin'])}" : ""
-            strategy_name_query_param = env['omniauth.error.strategy'] ? "&strategy=#{env['omniauth.error.strategy'].name}" : ""
-            extra_params = env['omniauth.params'] ? "&#{env['omniauth.params'].to_query}" : ""
+            origin_query_param = env['omniauth.origin'] ? "&origin=#{CGI.escape(env['omniauth.origin'])}" : ''
+            strategy_name_query_param = env['omniauth.error.strategy'] ? "&strategy=#{env['omniauth.error.strategy'].name}" : ''
+            extra_params = env['omniauth.params'] ? "&#{env['omniauth.params'].to_query}" : ''
             new_path = "#{env['SCRIPT_NAME']}#{OmniAuth.config.path_prefix}/failure?message=#{message_key}#{origin_query_param}#{strategy_name_query_param}#{extra_params}"
-            Rack::Response.new(["302 Moved"], 302, 'Location' => new_path).finish
+            Rack::Response.new(['302 Moved'], 302, 'Location' => new_path).finish
           end
         end
 
-
         # Omniauth currently removes omniauth.params during mocked requests
         # see also: https://github.com/intridea/omniauth/pull/812
         OmniAuth::Strategy.class_eval do

data/lib/devise_token_auth/errors.rb

@@ -2,6 +2,6 @@
 
 module DeviseTokenAuth
   module Errors
-    class NoResourceDefinedError < StandardError ; end
+    class NoResourceDefinedError < StandardError; end
   end
 end

data/lib/devise_token_auth/rails/routes.rb

@@ -8,31 +8,31 @@ module ActionDispatch::Routing
       opts[:skip]        ||= []
 
       # check for ctrl overrides, fall back to defaults
-      sessions_ctrl          = opts[:controllers][:sessions] || "devise_token_auth/sessions"
-      registrations_ctrl     = opts[:controllers][:registrations] || "devise_token_auth/registrations"
-      passwords_ctrl         = opts[:controllers][:passwords] || "devise_token_auth/passwords"
-      confirmations_ctrl     = opts[:controllers][:confirmations] || "devise_token_auth/confirmations"
-      token_validations_ctrl = opts[:controllers][:token_validations] || "devise_token_auth/token_validations"
-      omniauth_ctrl          = opts[:controllers][:omniauth_callbacks] || "devise_token_auth/omniauth_callbacks"
-      unlocks_ctrl           = opts[:controllers][:unlocks] || "devise_token_auth/unlocks"
+      sessions_ctrl          = opts[:controllers][:sessions] || 'devise_token_auth/sessions'
+      registrations_ctrl     = opts[:controllers][:registrations] || 'devise_token_auth/registrations'
+      passwords_ctrl         = opts[:controllers][:passwords] || 'devise_token_auth/passwords'
+      confirmations_ctrl     = opts[:controllers][:confirmations] || 'devise_token_auth/confirmations'
+      token_validations_ctrl = opts[:controllers][:token_validations] || 'devise_token_auth/token_validations'
+      omniauth_ctrl          = opts[:controllers][:omniauth_callbacks] || 'devise_token_auth/omniauth_callbacks'
+      unlocks_ctrl           = opts[:controllers][:unlocks] || 'devise_token_auth/unlocks'
 
       # define devise controller mappings
-      controllers = {:sessions           => sessions_ctrl,
-                     :registrations      => registrations_ctrl,
-                     :passwords          => passwords_ctrl,
-                     :confirmations      => confirmations_ctrl}
+      controllers = { sessions: sessions_ctrl,
+                      registrations: registrations_ctrl,
+                      passwords: passwords_ctrl,
+                      confirmations: confirmations_ctrl }
 
       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,
-        :module      => :devise,
-        :path        => "#{opts[:at]}",
-        :controllers => controllers,
-        :skip        => opts[:skip] + [:omniauth_callbacks]
+                 class_name: resource,
+                 module: :devise,
+                 path: opts[:at].to_s,
+                 controllers: controllers,
+                 skip: opts[:skip] + [:omniauth_callbacks]
 
       unnest_namespace do
         # get full url path as if it were namespaced
@@ -43,8 +43,8 @@ module ActionDispatch::Routing
 
         # clear scope so controller routes aren't namespaced
         @scope = ActionDispatch::Routing::Mapper::Scope.new(
-          path:         "",
-          shallow_path: "",
+          path:         '',
+          shallow_path: '',
           constraints:  {},
           defaults:     {},
           options:      {},
@@ -56,29 +56,29 @@ module ActionDispatch::Routing
 
         devise_scope mapping_name.to_sym do
           # path to verify token validity
-          get "#{full_path}/validate_token", controller: "#{token_validations_ctrl}", action: "validate_token"
+          get "#{full_path}/validate_token", controller: token_validations_ctrl.to_s, action: 'validate_token'
 
           # 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 "#{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 "#{DeviseTokenAuth.omniauth_prefix}/:provider/callback", controller: omniauth_ctrl, action: "redirect_callbacks", via: [:get, :post]
-            match "#{DeviseTokenAuth.omniauth_prefix}/failure", controller: omniauth_ctrl, action: "omniauth_failure", via: [:get, :post]
+            match "#{DeviseTokenAuth.omniauth_prefix}/:provider/callback", controller: omniauth_ctrl, action: 'redirect_callbacks', via: [:get, :post]
+            match "#{DeviseTokenAuth.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]
-              qs["namespace_name"] = [namespace_name] if namespace_name
+              qs['resource_class'] = [resource]
+              qs['namespace_name'] = [namespace_name] if namespace_name
 
               set_omniauth_path_prefix!(DeviseTokenAuth.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 DeviseTokenAuth.redirect_whitelist
                 redirect_url = request.params['auth_origin_url']

data/lib/devise_token_auth/url.rb

@@ -7,19 +7,21 @@ module DeviseTokenAuth::Url
 
     res = "#{uri.scheme}://#{uri.host}"
     res += ":#{uri.port}" if (uri.port && uri.port != 80 && uri.port != 443)
-    res += "#{uri.path}" if uri.path
+    res += uri.path.to_s if uri.path
     query = [uri.query, params.to_query].reject(&:blank?).join('&')
     res += "?#{query}"
     res += "##{uri.fragment}" if uri.fragment
 
-    return res
+    res
   end
 
   def self.whitelisted?(url)
-    url.nil? || !!DeviseTokenAuth.redirect_whitelist.find { |pattern| !!Wildcat.new(pattern).match(url) }
+    url.nil? || \
+      !!DeviseTokenAuth.redirect_whitelist.find do |pattern|
+        !!Wildcat.new(pattern).match(url)
+      end
   end
 
-
   # wildcard convenience class
   class Wildcat
     def self.parse_to_regex(str)

data/lib/devise_token_auth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeviseTokenAuth
-  VERSION = '0.2.0'
+  VERSION = '1.0.0.rc1'.freeze
 end

data/lib/generators/devise_token_auth/install_generator.rb

@@ -4,54 +4,56 @@ module DeviseTokenAuth
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root File.expand_path('../templates', __FILE__)
+    class_option :primary_key_type, type: :string, desc: 'The type for primary key'
 
-    argument :user_class, type: :string, default: "User"
+    source_root File.expand_path('templates', __dir__)
+
+    argument :user_class, type: :string, default: 'User'
     argument :mount_path, type: :string, default: 'auth'
 
     def create_initializer_file
-      copy_file("devise_token_auth.rb", "config/initializers/devise_token_auth.rb")
+      copy_file('devise_token_auth.rb', 'config/initializers/devise_token_auth.rb')
     end
 
     def copy_migrations
-      if self.class.migration_exists?("db/migrate", "devise_token_auth_create_#{ user_class.pluralize.gsub("::","").underscore }")
-        say_status("skipped", "Migration 'devise_token_auth_create_#{ user_class.pluralize.gsub("::","").underscore }' already exists")
+      if self.class.migration_exists?('db/migrate', "devise_token_auth_create_#{user_class.pluralize.gsub('::','').underscore}")
+        say_status('skipped', "Migration 'devise_token_auth_create_#{user_class.pluralize.gsub('::','').underscore}' already exists")
       else
         migration_template(
-          "devise_token_auth_create_users.rb.erb",
-          "db/migrate/devise_token_auth_create_#{ user_class.pluralize.gsub("::","").underscore }.rb"
+          'devise_token_auth_create_users.rb.erb',
+          "db/migrate/devise_token_auth_create_#{user_class.pluralize.gsub('::','').underscore}.rb"
         )
       end
     end
 
     def create_user_model
-      fname = "app/models/#{ user_class.underscore }.rb"
-      unless File.exist?(File.join(destination_root, fname))
-        template("user.rb", fname)
-      else
-        inclusion = "include DeviseTokenAuth::Concerns::User"
+      fname = "app/models/#{user_class.underscore}.rb"
+      if File.exist?(File.join(destination_root, fname))
+        inclusion = 'include DeviseTokenAuth::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'
-  # Include default devise modules.
-  devise :database_authenticatable, :registerable,
-          :recoverable, :rememberable, :trackable, :validatable,
-          :confirmable, :omniauthable
-  include DeviseTokenAuth::Concerns::User
-          RUBY
+            # Include default devise modules.
+            devise :database_authenticatable, :registerable,
+                    :recoverable, :rememberable, :trackable, :validatable,
+                    :confirmable, :omniauthable
+            include DeviseTokenAuth::Concerns::User
+            RUBY
           end
         end
+      else
+        template('user.rb.erb', fname)
       end
     end
 
     def include_controller_concerns
-      fname = "app/controllers/application_controller.rb"
-      line  = "include DeviseTokenAuth::Concerns::SetUserByToken"
+      fname = 'app/controllers/application_controller.rb'
+      line  = 'include DeviseTokenAuth::Concerns::SetUserByToken'
 
       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.")
+          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'
   include DeviseTokenAuth::Concerns::SetUserByToken
@@ -64,46 +66,46 @@ module DeviseTokenAuth
           end
         end
       else
-        say_status("skipped", "app/controllers/application_controller.rb not found. Add 'include DeviseTokenAuth::Concerns::SetUserByToken' to any controllers that require authentication.")
+        say_status('skipped', "app/controllers/application_controller.rb not found. Add 'include DeviseTokenAuth::Concerns::SetUserByToken' to any controllers that require authentication.")
       end
     end
 
     def add_route_mount
-      f    = "config/routes.rb"
+      f    = 'config/routes.rb'
       str  = "mount_devise_token_auth_for '#{user_class}', at: '#{mount_path}'"
 
       if File.exist?(File.join(destination_root, f))
-        line = parse_file_for_line(f, "mount_devise_token_auth_for")
+        line = parse_file_for_line(f, 'mount_devise_token_auth_for')
 
-        unless line
-          line = "Rails.application.routes.draw do"
-          existing_user_class = false
-        else
+        if line
           existing_user_class = true
+        else
+          line = 'Rails.application.routes.draw do'
+          existing_user_class = false
         end
 
         if parse_file_for_line(f, str)
-          say_status("skipped", "Routes already exist for #{user_class} at #{mount_path}")
+          say_status('skipped', "Routes already exist for #{user_class} at #{mount_path}")
         else
           insert_after_line(f, line, str)
 
           if existing_user_class
-            scoped_routes = ""+
-              "as :#{user_class.underscore} do\n"+
-              "    # Define routes for #{user_class} within this block.\n"+
+            scoped_routes = ''\
+              "as :#{user_class.underscore} do\n"\
+              "    # Define routes for #{user_class} within this block.\n"\
               "  end\n"
             insert_after_line(f, str, scoped_routes)
           end
         end
       else
-        say_status("skipped", "config/routes.rb not found. Add \"mount_devise_token_auth_for '#{user_class}', at: '#{mount_path}'\" to your routes file.")
+        say_status('skipped', "config/routes.rb not found. Add \"mount_devise_token_auth_for '#{user_class}', at: '#{mount_path}'\" to your routes file.")
       end
     end
 
     private
 
     def self.next_migration_number(path)
-      Time.zone.now.utc.strftime("%Y%m%d%H%M%S")
+      Time.zone.now.utc.strftime('%Y%m%d%H%M%S')
     end
 
     def insert_after_line(filename, line, str)
@@ -117,17 +119,15 @@ module DeviseTokenAuth
 
       File.open(File.join(destination_root, filename)) do |f|
         f.each_line do |line|
-          if line =~ /(#{Regexp.escape(str)})/mi
-            match = line
-          end
+          match = line if line =~ /(#{Regexp.escape(str)})/mi
         end
       end
       match
     end
 
     def is_rails_api?
-      fname = "app/controllers/application_controller.rb"
-      line = "class ApplicationController < ActionController::API"
+      fname = 'app/controllers/application_controller.rb'
+      line = 'class ApplicationController < ActionController::API'
       parse_file_for_line(fname, line)
     end
 
@@ -158,5 +158,18 @@ module DeviseTokenAuth
     def database_version
       ActiveRecord::Base.connection.select_value('SELECT VERSION()')
     end
+
+    def rails5?
+      Rails.version.start_with? '5'
+    end
+
+    def primary_key_type
+      primary_key_string if rails5?
+    end
+
+    def primary_key_string
+      key_string = options[:primary_key_type]
+      ", id: :#{key_string}" if key_string
+    end
   end
 end

data/lib/generators/devise_token_auth/install_views_generator.rb

@@ -2,16 +2,16 @@
 
 module DeviseTokenAuth
   class InstallViewsGenerator < Rails::Generators::Base
-    source_root File.expand_path('../../../../app/views/devise/mailer', __FILE__)
+    source_root File.expand_path('../../../app/views/devise/mailer', __dir__)
 
     def copy_mailer_templates
       copy_file(
-        "confirmation_instructions.html.erb",
-        "app/views/devise/mailer/confirmation_instructions.html.erb"
+        'confirmation_instructions.html.erb',
+        'app/views/devise/mailer/confirmation_instructions.html.erb'
       )
       copy_file(
-        "reset_password_instructions.html.erb",
-        "app/views/devise/mailer/reset_password_instructions.html.erb"
+        'reset_password_instructions.html.erb',
+        'app/views/devise/mailer/reset_password_instructions.html.erb'
       )
     end
   end