digix_devise_token_auth 0.1.44

data/lib/devise_token_auth/rails/routes.rb

@@ -0,0 +1,114 @@
+module ActionDispatch::Routing
+  class Mapper
+    def mount_devise_token_auth_for(resource, opts)
+      # ensure objects exist to simplify attr checks
+      opts[:controllers] ||= {}
+      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"
+
+      # define devise controller mappings
+      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)}
+
+      devise_for resource.pluralize.underscore.gsub('/', '_').to_sym,
+        :class_name  => resource,
+        :module      => :devise,
+        :path        => "#{opts[:at]}",
+        :controllers => controllers,
+        :skip        => opts[:skip] + [:omniauth_callbacks]
+
+      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"
+
+          # 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 "#{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|
+              # get the current querystring
+              qs = CGI::parse(request.env["QUERY_STRING"])
+
+              # append name of current resource
+              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}}
+
+              if DeviseTokenAuth.redirect_whitelist
+                redirect_url = request.params['auth_origin_url']
+                unless DeviseTokenAuth::Url.whitelisted?(redirect_url)
+                  message = I18n.t(
+                    'devise_token_auth.registrations.redirect_url_not_allowed',
+                    redirect_url: redirect_url
+                  )
+                  redirect_params['message'] = message
+                  next "#{::OmniAuth.config.path_prefix}/failure?#{redirect_params.to_param}"
+                end
+              end
+
+              # re-construct the path for omniauth
+              "#{::OmniAuth.config.path_prefix}/#{params[:provider]}?#{redirect_params.to_param}"
+            }, via: [:get]
+          end
+        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
+
+    # ignore error about omniauth/multiple model support
+    def set_omniauth_path_prefix!(path_prefix)
+      ::OmniAuth.config.path_prefix = path_prefix
+    end
+  end
+end

data/lib/devise_token_auth/url.rb

@@ -0,0 +1,37 @@
+module DeviseTokenAuth::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}" if uri.path
+    query = [uri.query, params.to_query].reject(&:blank?).join('&')
+    res += "?#{query}"
+    res += "##{uri.fragment}" if uri.fragment
+
+    return res
+  end
+
+  def self.whitelisted?(url)
+    url.nil? || !!DeviseTokenAuth.redirect_whitelist.find { |pattern| !!Wildcat.new(pattern).match(url) }
+  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_token_auth/version.rb

@@ -0,0 +1,3 @@
+module DeviseTokenAuth
+  VERSION = '0.1.44'
+end

data/lib/generators/devise_token_auth/USAGE

@@ -0,0 +1,31 @@
+Description:
+  This generator will install all the necessary configuration and migration
+  files for the devise_token_auth gem. See
+  https://github.com/lynndylanhurley/devise_token_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://github.com/lynndylanhurley/devise_token_auth#usage-tldr
+
+Example:
+  rails generate devise_token_auth:install User auth
+
+  This will create:
+      config/initializers/devise_token_auth.rb
+      db/migrate/<%= Time.now.utc.strftime("%Y%m%d%H%M%S") %>_create_devise_token_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 DeviseTokenAuth::Concerns::User
+
+  The following line will be inserted into your application controller at
+  app/controllers/application_controller.rb:
+      include DeviseTokenAuth::Concerns::SetUserByToken
+
+  The following line will be inserted at the top of 'config/routes.rb' if it
+  does not already exist:
+      mount_devise_token_auth_for "User", at: 'auth'

data/lib/generators/devise_token_auth/install_generator.rb

@@ -0,0 +1,160 @@
+module DeviseTokenAuth
+  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_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.underscore }")
+        say_status("skipped", "Migration 'devise_token_auth_create_#{ user_class.underscore }' already exists")
+      else
+        migration_template(
+          "devise_token_auth_create_users.rb.erb",
+          "db/migrate/devise_token_auth_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 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
+          end
+        end
+      end
+    end
+
+    def include_controller_concerns
+      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.")
+        elsif is_rails_api?
+          inject_into_file fname, after: "class ApplicationController < ActionController::API\n" do <<-'RUBY'
+  include DeviseTokenAuth::Concerns::SetUserByToken
+          RUBY
+          end
+        else
+          inject_into_file fname, after: "class ApplicationController < ActionController::Base\n" do <<-'RUBY'
+  include DeviseTokenAuth::Concerns::SetUserByToken
+          RUBY
+          end
+        end
+      else
+        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"
+      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")
+
+        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 \"mount_devise_token_auth_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_auth/install_views_generator.rb

@@ -0,0 +1,16 @@
+module DeviseTokenAuth
+  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_auth/templates/devise_token_auth.rb

@@ -0,0 +1,48 @@
+DeviseTokenAuth.setup do |config|
+  # By default the authorization headers will change after each request. The
+  # client is responsible for keeping track of the changing tokens. Change
+  # this to false to prevent the Authorization header from changing after
+  # each request.
+  # config.change_headers_on_each_request = true
+
+  # 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
+
+  # Sets the max number of concurrent devices per user, which is 10 by default.
+  # After this limit is reached, the oldest tokens will be removed.
+  # config.max_number_of_devices = 10
+
+  # Sometimes it's necessary to make several requests to the API at the same
+  # time. In this case, each request in the batch will need to share the same
+  # auth token. This setting determines how far apart the requests can be while
+  # still using the same auth token.
+  # config.batch_request_buffer_throttle = 5.seconds
+
+  # 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
+
+  # Makes it possible to change the headers names
+  # config.headers_names = {:'access-token' => 'access-token',
+  #                        :'client' => 'client',
+  #                        :'expiry' => 'expiry',
+  #                        :'uid' => 'uid',
+  #                        :'token-type' => 'token-type' }
+
+  # 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
+end

data/lib/generators/devise_token_auth/templates/devise_token_auth_create_users.rb.erb

@@ -0,0 +1,55 @@
+class DeviseTokenAuthCreate<%= 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