authenticatable 1.0.0

data/lib/authenticatable/serializers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "authenticatable/serializers/base"
+require "authenticatable/serializers/session"
+
+module Authenticatable
+  module Serializers
+  end
+end

data/lib/authenticatable/testing/controller_helpers.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Authenticatable
+  module Testing
+    module ControllerHelpers
+      def setup_controller_request_and_response
+        super
+        @request.env["authenticatable"] = Authenticatable::Proxy.new(@request.env)
+
+        # Set default testing scope to :users
+        @request.env["authenticatable.scope"] = Authenticatable.add_scope(:users, {})
+      end
+
+      def sign_in(resource, store = nil)
+        @request.env["authenticatable"].sign_in(resource, store)
+      end
+
+      # def sign_out(resource, store = nil)
+      #   @request.env["authenticatable"].sign_out(resource, store)
+      # end
+
+      def authenticatable_scope(scope, options = {})
+        @request.env["authenticatable.scope"] = Authenticatable.add_scope(scope, options)
+      end
+
+      def authenticatable
+        @request.env["authenticatable"]
+      end
+    end
+  end
+end

data/lib/authenticatable/token.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Authenticatable
+  # Random token used for password reset and remember tokens.
+  class Token
+    # Generate a new random hex token.
+    class << self
+      def new(bytes = 20)
+        SecureRandom.hex(bytes)
+      end
+    end
+  end
+end

data/lib/authenticatable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Authenticatable
+  VERSION = "1.0.0"
+end

data/lib/authenticatable.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "authenticatable/controllers"
+require "authenticatable/errors"
+require "authenticatable/manager"
+require "authenticatable/models"
+require "authenticatable/rails/routes"
+require "authenticatable/scope"
+require "authenticatable/proxy"
+require "authenticatable/serializers"
+require "authenticatable/token"
+require "authenticatable/version"
+require "authenticatable/engine"
+
+require "dry-configurable"
+
+# Authenticatable is an authentication solution for Rails. All related modules,
+# classes and methods will be namespaced under the namespace 'Authenticatable':
+module Authenticatable
+  extend Dry::Configurable
+
+  # Store authenticatable resources as scopes.
+  @scopes = {}
+
+  # Default extensions to load into your authenticatable models. This can for example
+  # be a custom Warden strategy, concerns with validations, or basically anything that
+  # modifies the default behavior of your authenticatable model. Feel free to develop
+  # add publish your own extensions online. We'd be happy to see what you can accomplish.
+  #
+  #   email_validator: Validates emails with the valid_email2 gem. You can remove this
+  #                    if you want to implement your own email validations or if you
+  #                    don't want to validate emails at all.
+  #
+  #   password:        Enables password authentication with has_secure_password. This extension
+  #                    includes a Warden Strategy for authentication with password. It does also
+  #                    add password validations to your authenticatable model.
+  #
+  setting :default_extensions, %i[password]
+
+  # Default column to use when looking up an authenticatable record in the database.
+  # Can be for example email or a username. Default is :email. This can also be changed
+  # for an individual resource/scope by passing :identifier to the authentication
+  # method in your model:
+  #
+  #   authenticatable identifier: :username
+  #
+  setting :default_identifier, :email
+
+  # The controller class that all Authenticatable controllers will inherit from.
+  # Defaults to `ApplicationController`.
+  setting :parent_controller, "ApplicationController"
+
+  # The mailer class that all Authenticatable mailers will inherit from.
+  # Defaults to `ApplicationMailer`.
+  setting :parent_mailer, "ApplicationMailer"
+
+  # Range validation for password length
+  setting :password_length, 6..128
+
+  # Requests method(s) allowed for sign out. You can for example add :get
+  # to enable sign out by visiting /users/sign_out.
+  setting :allowed_sign_out_methods, %i[delete]
+
+  # Which formats should be treated as navigational. Navigational formats
+  # like :html & :turbo_stream should redirect and show flash messages,
+  # but other formats like :xml or :json, should return 401. The "*/*"
+  # format below is required to match Internet Explorer.
+  setting :navigational_formats, ["*/*", :html, :turbo_stream]
+
+  # Email regex used to validate email formats. It simply asserts that
+  # one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  setting :email_regexp, /\A[^@\s]+@[^@\s]+\z/
+
+  # Specify for how long a reset_password_token will be valid.
+  # When the time expires, their token will be invalid and they
+  # have to request a "reset password link" to recover their account.
+  setting :reset_password_expiration_time, 1.hour
+
+  class << self
+    attr_reader :scopes
+
+    def reset_default_values!
+      remove_instance_variable :@config
+    end
+
+    # Add a authenticatable model to list of scopes. It could be for example
+    # :users, :admins, :subscribers or any other model that should be authenticatable.
+    def add_scope(resource, options = {})
+      scope = Authenticatable::Scope.new(resource, options)
+      @scopes[scope.singular_name.to_sym] = scope
+
+      # Define helpers like current_{scope}, authenticate_{scope}!
+      # {scope}_signed_in? etc for the given scope that can be accessed from all controllers.
+      Authenticatable::Controllers::Helpers.define_helpers(scope.singular_name)
+
+      scope
+    end
+  end
+end

data/lib/generators/active_record/authenticatable_generator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+require "generators/authenticatable/orm_helpers"
+
+module ActiveRecord
+  module Generators
+    class AuthenticatableGenerator < ActiveRecord::Generators::Base
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      include Authenticatable::Generators::OrmHelpers
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_authenticatable_migration
+        if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(table_name))
+          migration_template "migration_existing.tt", "#{db_migrate_path}/add_authenticatable_to_#{table_name}.rb",
+                             migration_version: migration_version
+        else
+          migration_template "migration.tt", "#{db_migrate_path}/authenticatable_create_#{table_name}.rb",
+                             migration_version: migration_version
+        end
+      end
+
+      def generate_model
+        invoke "active_record:model", [name], migration: false unless model_exists? && behavior == :invoke
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def inject_authenticatable
+        content = model_contents
+        class_path = (namespaced? ? class_name.to_s.split("::") : [class_name])
+        indent_depth = class_path.size - 1
+        content = content.split("\n").map { |line| ("  " * indent_depth) + line }.join("\n") << "\n"
+
+        inject_into_class(model_path, class_path.last, content) if model_exists?
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def add_route
+        route_content = "authenticatable :#{plural_name}"
+        route route_content
+      end
+
+      private
+
+      def model_contents
+        "  authenticatable\n"
+      end
+
+      # rubocop:disable Layout/IndentationWidth
+      def migration_data
+<<RUBY
+      ## Authenticatable
+      t.string :email, null: false, default: ""
+      t.string :password_digest, null: false, default: ""
+      t.string :reset_password_token, null: false, default: ""
+      t.datetime :reset_password_sent_at
+RUBY
+      end
+      # rubocop:enable Layout/IndentationWidth
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class AuthenticatableCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %><%= primary_key_type %> do |t|
+<%= migration_data -%>
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+      t.timestamps null: false
+    end
+    add_index :<%= table_name %>, :email, unique: true
+    add_index :<%= table_name %>, :reset_password_token
+  end
+end

data/lib/generators/active_record/templates/migration_existing.tt

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class AddAuthenticatableTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    change_table :<%= table_name %> do |t|
+<%= migration_data -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+      # Uncomment below if timestamps were not included in your original model.
+      # t.timestamps null: false
+    end
+    add_index :<%= table_name %>, :email, unique: true
+    add_index :<%= table_name %>, :reset_password_token
+  end
+
+  def self.down
+    # By default, we don't want to make any assumption about how to roll back a migration when your
+    # model already existed. Please edit below which fields you would like to remove in this migration.
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/authenticatable/authenticatable_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+module Authenticatable
+  module Generators
+    class AuthenticatableGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      namespace "authenticatable"
+
+      desc "Generates a model with the given NAME (if one does not exist) with authenticatable " \
+           "configuration plus a migration file and authentication routes."
+
+      hook_for :orm, required: true
+    end
+  end
+end

data/lib/generators/authenticatable/orm_helpers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Authenticatable
+  module Generators
+    module OrmHelpers
+      private
+
+      def model_exists?
+        File.exist?(File.join(destination_root, model_path))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join(destination_root, db_migrate_path)}/[0-9]*_*.rb")
+           .grep(/\d+_add_authenticatable_to_#{table_name}.rb$/).first
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5_and_up?
+      end
+
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      end
+    end
+  end
+end

data/lib/generators/authenticatable/views_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "active_support/core_ext/string/inflections"
+
+module Authenticatable
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      desc "Copy view files to app/views"
+      source_root Authenticatable::Engine.root
+      argument :scope, default: "authenticatable", type: :string
+
+      def copy_views
+        scope_directory = (scope == "authenticatable" ? "authenticatable" : ActiveSupport::Inflector.pluralize(scope))
+        directory "app/views/authenticatable", "app/views/#{scope_directory}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: authenticatable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rasmus Kjellberg
+- KIQR
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.16
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: valid_email2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description:
+email: hello@kiqr.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- app/controllers/authenticatable/passwords_controller.rb
+- app/controllers/authenticatable/registrations_controller.rb
+- app/controllers/authenticatable/sessions_controller.rb
+- app/controllers/authenticatable_controller.rb
+- app/mailers/authenticatable/mailer.rb
+- app/views/authenticatable/mailer/reset_password.html.erb
+- app/views/authenticatable/passwords/_edit_form.html.erb
+- app/views/authenticatable/passwords/_new_form.html.erb
+- app/views/authenticatable/passwords/edit.html.erb
+- app/views/authenticatable/passwords/new.html.erb
+- app/views/authenticatable/registrations/_form.html.erb
+- app/views/authenticatable/registrations/new.html.erb
+- app/views/authenticatable/sessions/_form.html.erb
+- app/views/authenticatable/sessions/new.html.erb
+- app/views/authenticatable/shared/_errors.html.erb
+- app/views/authenticatable/shared/_flash_messages.html.erb
+- app/views/authenticatable/shared/_links.html.erb
+- config/locales/en.yml
+- lib/authenticatable.rb
+- lib/authenticatable/controllers.rb
+- lib/authenticatable/controllers/helpers.rb
+- lib/authenticatable/controllers/url_helpers.rb
+- lib/authenticatable/engine.rb
+- lib/authenticatable/errors.rb
+- lib/authenticatable/errors/unauthenticated_error.rb
+- lib/authenticatable/manager.rb
+- lib/authenticatable/models.rb
+- lib/authenticatable/models/email_validator.rb
+- lib/authenticatable/models/identifier.rb
+- lib/authenticatable/models/password.rb
+- lib/authenticatable/proxy.rb
+- lib/authenticatable/rails/routes.rb
+- lib/authenticatable/rspec.rb
+- lib/authenticatable/scope.rb
+- lib/authenticatable/serializers.rb
+- lib/authenticatable/serializers/base.rb
+- lib/authenticatable/serializers/session.rb
+- lib/authenticatable/testing/controller_helpers.rb
+- lib/authenticatable/token.rb
+- lib/authenticatable/version.rb
+- lib/generators/active_record/authenticatable_generator.rb
+- lib/generators/active_record/templates/migration.tt
+- lib/generators/active_record/templates/migration_existing.tt
+- lib/generators/authenticatable/authenticatable_generator.rb
+- lib/generators/authenticatable/orm_helpers.rb
+- lib/generators/authenticatable/views_generator.rb
+homepage: https://github.com/kiqr/authenticatable
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/kiqr/authenticatable/issues
+  documentation_uri: https://github.com/kiqr/authenticatable/issues
+  source_code_uri: https://github.com/kiqr/authenticatable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.26
+signing_key:
+specification_version: 4
+summary: Authentication solution for Ruby on Rails
+test_files: []