devise_jwt_auth 0.1.0

data/lib/devise_jwt_auth/url.rb

@@ -0,0 +1,44 @@
+# 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.path.to_s if uri.path
+    query = [uri.query, params.to_query].reject(&:blank?).join('&')
+    res += "?#{query}"
+    res += "##{uri.fragment}" if uri.fragment
+    # repeat any query params after the fragment to deal with Angular eating any pre fragment query params, used
+    # in the reset password redirect url
+    res += "?#{query}" if uri.fragment
+
+    res
+  end
+
+  def self.whitelisted?(url)
+    url.nil? || \
+      !!DeviseJwtAuth.redirect_whitelist.find do |pattern|
+        !!Wildcat.new(pattern).match(url)
+      end
+  end
+
+  # wildcard convenience class
+  class Wildcat
+    def self.parse_to_regex(str)
+      escaped = Regexp.escape(str).gsub('\*','.*?')
+      Regexp.new("^#{escaped}$", Regexp::IGNORECASE)
+    end
+
+    def initialize(str)
+      @regex = self.class.parse_to_regex(str)
+    end
+
+    def match(str)
+      !!@regex.match(str)
+    end
+  end
+
+end

data/lib/devise_jwt_auth/version.rb

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

data/lib/generators/devise_jwt_auth/USAGE

@@ -0,0 +1,31 @@
+Description:
+  This generator will install all the necessary configuration and migration
+  files for the devise_jwt_auth gem. See
+  https://github.com/lynndylanhurley/devise_jwt_auth for more information.
+
+Arguments:
+  USER_CLASS # The name of the class to use for user authentication. Default is
+             # '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
+
+Example:
+  rails generate devise_jwt_auth:install User auth
+
+  This will create:
+      config/initializers/devise_jwt_auth.rb
+      db/migrate/<%= Time.zone.now.utc.strftime("%Y%m%d%H%M%S") %>_create_devise_jwt_auth_create_users.rb
+      app/models/user.rb
+
+  If 'app/models/user.rb' already exists, the following line will be inserted
+  after the class definition:
+      include DeviseJwtAuth::Concerns::User
+
+  The following line will be inserted into your application controller at
+  app/controllers/application_controller.rb:
+      include DeviseJwtAuth::Concerns::SetUserByToken
+
+  The following line will be inserted at the top of 'config/routes.rb' if it
+  does not already exist:
+      mount_devise_jwt_auth_for "User", at: 'auth'

data/lib/generators/devise_jwt_auth/install_generator.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative 'install_generator_helpers'
+
+module DeviseJwtAuth
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    include DeviseJwtAuth::InstallGeneratorHelpers
+
+    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")
+      else
+        migration_template(
+          'devise_jwt_auth_create_users.rb.erb',
+          "db/migrate/devise_jwt_auth_create_#{user_class.pluralize.gsub('::','').underscore}.rb"
+        )
+      end
+    end
+
+    def create_user_model
+      fname = "app/models/#{user_class.underscore}.rb"
+      if File.exist?(File.join(destination_root, fname))
+        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'
+            # Include default devise modules.
+            devise :database_authenticatable, :registerable,
+                    :recoverable, :rememberable, :trackable, :validatable,
+                    :confirmable, :omniauthable
+            include DeviseJwtAuth::Concerns::User
+            RUBY
+          end
+        end
+      else
+        template('user.rb.erb', fname)
+      end
+    end
+
+    private
+
+    def self.next_migration_number(path)
+      Time.zone.now.utc.strftime('%Y%m%d%H%M%S')
+    end
+
+    def json_supported_database?
+      (postgres? && postgres_correct_version?) || (mysql? && mysql_correct_version?)
+    end
+
+    def postgres?
+      database_name == 'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'
+    end
+
+    def postgres_correct_version?
+      database_version > '9.3'
+    end
+
+    def mysql?
+      database_name == 'ActiveRecord::ConnectionAdapters::MysqlAdapter'
+    end
+
+    def mysql_correct_version?
+      database_version > '5.7.7'
+    end
+
+    def database_name
+      ActiveRecord::Base.connection.class.name
+    end
+
+    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_jwt_auth/install_generator_helpers.rb

@@ -0,0 +1,98 @@
+module DeviseJwtAuth
+  module InstallGeneratorHelpers
+    class << self
+      def included(mod)
+        mod.class_eval do
+          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_jwt_auth.rb', 'config/initializers/devise_jwt_auth.rb')
+          end
+
+          def include_controller_concerns
+            fname = 'app/controllers/application_controller.rb'
+            line  = 'include DeviseJwtAuth::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.')
+              elsif is_rails_api?
+                inject_into_file fname, after: "class ApplicationController < ActionController::API\n" do <<-'RUBY'
+        include DeviseJwtAuth::Concerns::SetUserByToken
+                RUBY
+                end
+              else
+                inject_into_file fname, after: "class ApplicationController < ActionController::Base\n" do <<-'RUBY'
+        include DeviseJwtAuth::Concerns::SetUserByToken
+                RUBY
+                end
+              end
+            else
+              say_status('skipped', "app/controllers/application_controller.rb not found. Add 'include DeviseJwtAuth::Concerns::SetUserByToken' to any controllers that require authentication.")
+            end
+          end
+
+          def add_route_mount
+            f    = 'config/routes.rb'
+            str  = "mount_devise_jwt_auth_for '#{user_class}', at: '#{mount_path}'"
+
+            if File.exist?(File.join(destination_root, f))
+              line = parse_file_for_line(f, 'mount_devise_jwt_auth_for')
+
+              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}")
+              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"\
+                    "  end\n"
+                  insert_after_line(f, str, scoped_routes)
+                end
+              end
+            else
+              say_status('skipped', "config/routes.rb not found. Add \"mount_devise_jwt_auth_for '#{user_class}', at: '#{mount_path}'\" to your routes file.")
+            end
+          end
+
+          private
+
+          def insert_after_line(filename, line, str)
+            gsub_file filename, /(#{Regexp.escape(line)})/mi do |match|
+              "#{match}\n  #{str}"
+            end
+          end
+
+          def parse_file_for_line(filename, str)
+            match = false
+
+            File.open(File.join(destination_root, filename)) do |f|
+              f.each_line do |line|
+                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'
+            parse_file_for_line(fname, line)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/devise_jwt_auth/install_mongoid_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'install_generator_helpers'
+
+module DeviseJwtAuth
+  class InstallMongoidGenerator < Rails::Generators::Base
+    include DeviseJwtAuth::InstallGeneratorHelpers
+
+    def create_user_model
+      fname = "app/models/#{user_class.underscore}.rb"
+      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'
+
+  include Mongoid::Locker
+
+  field :locker_locked_at, type: Time
+  field :locker_locked_until, type: Time
+
+  locker locked_at_field: :locker_locked_at,
+         locked_until_field: :locker_locked_until
+
+  ## Required
+  field :provider, type: String
+  field :uid,      type: String, default: ''
+
+  ## Tokens
+  field :tokens, type: Hash, default: {}
+
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable
+  include DeviseJwtAuth::Concerns::User
+
+  index({ uid: 1, provider: 1}, { name: 'uid_provider_index', unique: true, background: true })
+            RUBY
+          end
+        end
+      else
+        template('user_mongoid.rb.erb', fname)
+      end
+    end
+  end
+end

data/lib/generators/devise_jwt_auth/install_views_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DeviseJwtAuth
+  class InstallViewsGenerator < Rails::Generators::Base
+    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'
+      )
+      copy_file(
+        'reset_password_instructions.html.erb',
+        'app/views/devise/mailer/reset_password_instructions.html.erb'
+      )
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+DeviseJwtAuth.setup do |config|
+  # By default, you will only receive an access token when authenticating a
+  # user. To receive new access tokens, you should either reauthenticate or
+  # use the HTTP only refresh cookie that is sent during the authentication
+  # process and make refresh token requests.
+  # self.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.
+  # self.refresh_token_lifespan = 2.weeks
+
+  # By default, access tokens last for 15 minutes. These tokens are used to
+  # access protected resources. When these tokens expire, you need to
+  # reauthenticate the user or use a refresh token cookie to get a new access
+  # token.
+  # self.access_token_lifespan = 15.minutes
+
+  # This is the name of the HTTP Only cookie that will be sent to the client
+  # for the purpose of requesting new access tokens.
+  # self.refresh_token_name = 'refresh-token'
+
+  # This is the name of the token that will be sent in the JSON responses used
+  # for accessing protected resources. NEVER store this token in a cookie or
+  # any form of local storage on the client. Save it in memory as a javascript
+  # variable or in some kind of context manager like Redux. Send it in your
+  # request headers when you want to be authenticated.
+  # self.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.
+  # Also, its a good idea to NOT use the same key for access tokens.
+  self.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.
+  self.access_token_encryption_key = 'your-access-token-secret-key-here'
+
+  # This route will be the prefix for all oauth2 redirect callbacks. For
+  # example, using the default '/omniauth', the github oauth2 provider will
+  # redirect successful authentications to '/omniauth/github/callback'
+  # config.omniauth_prefix = "/omniauth"
+
+  # By default sending current password is not needed for the password update.
+  # Uncomment to enforce current_password param to be checked before all
+  # attribute updates. Set it to :password if you want it to be checked only if
+  # password is updated.
+  # config.check_current_password_before_update = :attributes
+
+  # By default we will use callbacks for single omniauth.
+  # It depends on fields like email, provider and uid.
+  # config.default_callbacks = true
+
+  # By default, only Bearer Token authentication is implemented out of the box.
+  # If, however, you wish to integrate with legacy Devise authentication, you can
+  # do so by enabling this flag. NOTE: This feature is highly experimental!
+  # config.enable_standard_devise_support = false
+
+  # By default DeviseJwtAuth will not send confirmation email, even when including
+  # devise confirmable module. If you want to use devise confirmable module and
+  # send email, set it to true. (This is a setting for compatibility)
+  # config.send_confirmation_email = true
+
+  # TODO: Document these settings
+  # self.default_confirm_success_url               = nil
+  # self.default_password_reset_url                = nil
+  # self.redirect_whitelist                        = nil
+  # self.update_token_version_after_password_reset = true
+  # self.bypass_sign_in                            = true
+  # self.require_client_password_reset_token       = false
+
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+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|
+      ## Required
+      t.string :provider, null: false, default: 'email'
+      t.string :uid, null: false, default: ''
+
+      ## Database authenticatable
+      t.string :encrypted_password, null: false, default: ''
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+      t.boolean  :allow_password_change, default: false
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Confirmable
+      t.string   :confirmation_token
+      t.datetime :confirmed_at
+      t.datetime :confirmation_sent_at
+      t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## Lockable
+      # t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
+      # 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
+
+    add_index :<%= table_name %>, :email,                unique: true
+    add_index :<%= table_name %>, [:uid, :provider],     unique: true
+    add_index :<%= table_name %>, :reset_password_token, unique: true
+    add_index :<%= table_name %>, :confirmation_token,   unique: true
+    # add_index :<%= table_name %>, :unlock_token,       unique: true
+  end
+end