devise_token 0.1.1

data/lib/devise_token/rails/routes.rb

@@ -0,0 +1,66 @@
+module ActionDispatch::Routing
+  class Mapper
+    def devise_token_for(resource, opts)
+      # ensure objects exist to simplify attr checks
+      opts[:controllers] ||= {}
+      opts[:skip]        ||= []
+
+      # check for ctrl overrides, fall back to defaults
+      authentications_ctrl   = opts[:controllers][:sessions] || "devise_token/authentications"
+      registrations_ctrl     = opts[:controllers][:registrations] || "devise_token/registrations"
+      confirmations_ctrl     = opts[:controllers][:confirmations] || "devise_token/confirmations"
+      token_validations_ctrl = opts[:controllers][:token_validations] || "devise_token/token_validations"
+
+      # define devise controller mappings
+      controllers = {:sessions           => authentications_ctrl,
+                     :registrations      => registrations_ctrl,
+                     :confirmations      => confirmations_ctrl}
+
+      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]
+
+      unnest_namespace do
+        # get full url path as if it were namespaced
+        full_path = "#{@scope[:path]}/#{opts[:at]}"
+
+        # get namespace name
+        namespace_name = @scope[:as]
+
+        # clear scope so controller routes aren't namespaced
+        @scope = ActionDispatch::Routing::Mapper::Scope.new(
+          path:         "",
+          shallow_path: "",
+          constraints:  {},
+          defaults:     {},
+          options:      {},
+          parent:       nil
+        )
+
+        mapping_name = resource.underscore.gsub('/', '_')
+        mapping_name = "#{namespace_name}_#{mapping_name}" if namespace_name
+
+        devise_scope mapping_name.to_sym do
+          # path to verify token validity
+          get "#{full_path}/validate_token", controller: "#{token_validations_ctrl}", action: "validate_token"
+
+
+        end
+      end
+    end
+
+    # this allows us to use namespaced paths without namespacing the routes
+    def unnest_namespace
+      current_scope = @scope.dup
+      yield
+    ensure
+      @scope = current_scope
+    end
+
+  end
+end

data/lib/devise_token/version.rb

@@ -0,0 +1,3 @@
+module DeviseToken
+  VERSION = '0.1.1'
+end

data/lib/generators/devise_token/install_generator.rb

@@ -0,0 +1,160 @@
+module DeviseToken
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :user_class, type: :string, default: "User"
+    argument :mount_path, type: :string, default: 'auth'
+
+    def create_initializer_file
+      copy_file("devise_token.rb", "config/initializers/devise_token.rb")
+    end
+
+    def copy_migrations
+      if self.class.migration_exists?("db/migrate", "devise_token_create_#{ user_class.underscore }")
+        say_status("skipped", "Migration 'devise_token_create_#{ user_class.underscore }' already exists")
+      else
+        migration_template(
+          "devise_token_create_users.rb.erb",
+          "db/migrate/devise_token_create_#{ user_class.pluralize.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 DeviseToken::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 DeviseToken::Concerns::User
+          RUBY
+          end
+        end
+      end
+    end
+
+    def include_controller_concerns
+      fname = "app/controllers/application_controller.rb"
+      line  = "include DeviseToken::Concerns::AuthenticateToken"
+
+      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 DeviseToken::Concerns::AuthenticateToken
+          RUBY
+          end
+        else
+          inject_into_file fname, after: "class ApplicationController < ActionController::Base\n" do <<-'RUBY'
+  include DeviseToken::Concerns::AuthenticateToken
+          RUBY
+          end
+        end
+      else
+        say_status("skipped", "app/controllers/application_controller.rb not found. Add 'include DeviseToken::Concerns::AuthenticateToken' to any controllers that require authentication.")
+      end
+    end
+
+    def add_route_mount
+      f    = "config/routes.rb"
+      str  = "devise_token_for '#{user_class}', at: '#{mount_path}'"
+
+      if File.exist?(File.join(destination_root, f))
+        line = parse_file_for_line(f, "devise_token_for")
+
+        unless line
+          line = "Rails.application.routes.draw do"
+          existing_user_class = false
+        else
+          existing_user_class = true
+        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 \"devise_token_for '#{user_class}', at: '#{mount_path}'\" to your routes file.")
+      end
+    end
+
+    private
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    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|
+          if line =~ /(#{Regexp.escape(str)})/mi
+            match = line
+          end
+        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
+
+    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
+  end
+end

data/lib/generators/devise_token/install_views_generator.rb

@@ -0,0 +1,16 @@
+module DeviseToken
+  class InstallViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../app/views/devise/mailer', __FILE__)
+
+    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_token/templates/devise_token.rb

@@ -0,0 +1,16 @@
+DeviseToken.setup do |config|
+
+  # By default, users will need to re-authenticate after 2 weeks. This setting
+  # determines how long tokens will remain valid after they are issued.
+  # config.token_lifespan = 2.weeks
+
+  # 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
+end

data/lib/generators/devise_token/templates/devise_token_create_users.rb.erb

@@ -0,0 +1,55 @@
+class DeviseTokenCreate<%= user_class.pluralize %> < ActiveRecord::Migration<%= "[#{Rails::VERSION::STRING[0..2]}]" if Rails::VERSION::MAJOR > 4 %>
+  def change
+    create_table(:<%= user_class.pluralize.underscore %>) 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
+
+      ## Trackable
+      t.integer  :sign_in_count, :default => 0, :null => false
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string   :current_sign_in_ip
+      t.string   :last_sign_in_ip
+
+      ## 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 :<%= user_class.pluralize.underscore %>, :email,                unique: true
+    add_index :<%= user_class.pluralize.underscore %>, [:uid, :provider],     unique: true
+    add_index :<%= user_class.pluralize.underscore %>, :reset_password_token, unique: true
+    add_index :<%= user_class.pluralize.underscore %>, :confirmation_token,   unique: true
+    # add_index :<%= user_class.pluralize.underscore %>, :unlock_token,       unique: true
+  end
+end

data/lib/tasks/devise_token_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :devise_token do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: devise_token
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Samuel Akrah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Authentication for all Rails Api applications
+email:
+- akrahdan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/devise_token_manifest.js
+- app/assets/javascripts/devise_token/application.js
+- app/assets/stylesheets/devise_token/application.css
+- app/controllers/devise_token/application_controller.rb
+- app/controllers/devise_token/authentications_controller.rb
+- app/controllers/devise_token/concerns/authenticate_token.rb
+- app/controllers/devise_token/confirmations_controller.rb
+- app/controllers/devise_token/registrations_controller.rb
+- app/controllers/devise_token/token_validations_controller.rb
+- app/helpers/devise_token/application_helper.rb
+- app/jobs/devise_token/application_job.rb
+- app/mailers/devise_token/application_mailer.rb
+- app/models/devise_token/application_record.rb
+- app/models/devise_token/concerns/user.rb
+- app/models/devise_token/json_web_token.rb
+- app/views/devise/mailer/confirmation_instructions.html.erb
+- app/views/devise/mailer/reset_password_instructions.html.erb
+- app/views/devise/mailer/unlock_instructions.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- lib/devise_token.rb
+- lib/devise_token/authenticable.rb
+- lib/devise_token/controllers/helpers.rb
+- lib/devise_token/controllers/url_helpers.rb
+- lib/devise_token/engine.rb
+- lib/devise_token/rails/routes.rb
+- lib/devise_token/version.rb
+- lib/generators/devise_token/install_generator.rb
+- lib/generators/devise_token/install_views_generator.rb
+- lib/generators/devise_token/templates/devise_token.rb
+- lib/generators/devise_token/templates/devise_token_create_users.rb.erb
+- lib/tasks/devise_token_tasks.rake
+homepage: https://github.com/akrahdan/devise_token
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: JWT Token based authentication with devise.
+test_files: []