searls-auth 0.0.1

data/lib/searls/auth/creates_user.rb

@@ -0,0 +1,37 @@
+require_relative "engine"
+
+module Searls
+  module Auth
+    class CreatesUser
+      include Engine.routes.url_helpers
+      Result = Struct.new(:user, :success?, :error_messages)
+
+      def call(params)
+        user = Searls::Auth.config.user_finder_by_email.call(params[:email]) ||
+          Searls::Auth.config.user_initializer.call(params)
+
+        if user.persisted?
+          Result.new(nil, false, ["An account already exists for that email address. <a href=\"#{login_path(**forwardable_params(params))}\">Log in</a> instead?".html_safe])
+        elsif (errors = Searls::Auth.config.validate_registration.call(user, params, [])).any?
+          Result.new(nil, false, errors)
+        elsif user.save
+          Result.new(user, true)
+        else
+          Result.new(user, false, simplified_error_messages(user))
+        end
+      end
+
+      private
+
+      def forwardable_params(params)
+        params.permit(:redirect_path, :redirect_subdomain, :email)
+      end
+
+      def simplified_error_messages(model)
+        model.errors.details.keys.map { |attr|
+          model.errors.full_messages_for(attr).first
+        }.join
+      end
+    end
+  end
+end

data/lib/searls/auth/emails_link.rb

@@ -0,0 +1,15 @@
+module Searls
+  module Auth
+    class EmailsLink
+      def email(user:, short_code:, redirect_path: nil, redirect_subdomain: nil)
+        LoginLinkMailer.with(
+          user:,
+          token: Searls::Auth.config.token_generator.call(user),
+          short_code:,
+          redirect_path:,
+          redirect_subdomain:
+        ).login_link.deliver_later
+      end
+    end
+  end
+end

data/lib/searls/auth/engine.rb

@@ -0,0 +1,28 @@
+module Searls
+  module Auth
+    class Engine < ::Rails::Engine
+      isolate_namespace Searls::Auth
+
+      initializer "searls.auth.helpers" do
+        ActiveSupport.on_load(:action_controller) do
+          helper Searls::Auth::Engine.helpers
+        end
+      end
+
+      initializer "searls.auth.url_options" do |app|
+        Searls::Auth::Engine.routes.default_url_options = app.routes.default_url_options
+      end
+
+      initializer "searls.auth.assets" do |app|
+        app.config.assets.paths << root.join("app/javascript")
+      end
+
+      initializer "searls.auth.importmap", before: "importmap" do |app|
+        if app.config.respond_to?(:importmap)
+          app.config.importmap.paths << root.join("config/importmap.rb")
+          app.config.importmap.cache_sweepers << root.join("app/javascript")
+        end
+      end
+    end
+  end
+end

data/lib/searls/auth/railtie.rb

@@ -0,0 +1,20 @@
+module Searls
+  module Auth
+    class Railtie < ::Rails::Railtie
+      # Register rake tasks if needed
+      # rake_tasks do
+      #   load "tasks/searls_auth_tasks.rake"
+      # end
+
+      # Register generators if needed
+      # generators do
+      #   require "generators/searls_auth_generator"
+      # end
+
+      # Initialize configuration defaults
+      initializer "searls.auth.configure" do |app|
+        # Set up any configuration defaults here
+      end
+    end
+  end
+end

data/lib/searls/auth/resets_session.rb

@@ -0,0 +1,13 @@
+module Searls
+  module Auth
+    class ResetsSession
+      def reset(receiver, except_for:)
+        backup = Searls::Auth.config.preserve_session_keys_after_logout.map { |key|
+          [key, receiver.session[key]]
+        }
+        receiver.reset_session
+        backup.each { |key, value| receiver.session[key] = value }
+      end
+    end
+  end
+end

data/lib/searls/auth/version.rb

@@ -0,0 +1,5 @@
+module Searls
+  module Auth
+    VERSION = "0.0.1"
+  end
+end

data/lib/searls/auth.rb

@@ -0,0 +1,63 @@
+require_relative "auth/authenticates_user"
+require_relative "auth/config"
+require_relative "auth/creates_user" if defined?(Rails)
+require_relative "auth/emails_link"
+require_relative "auth/engine" if defined?(Rails)
+require_relative "auth/railtie" if defined?(Rails)
+require_relative "auth/resets_session"
+require_relative "auth/version"
+
+module Searls
+  module Auth
+    class Error < StandardError; end
+
+    DEFAULT_CONFIG = {
+      # Data setup
+      user_finder_by_email: ->(email) { User.find_by(email:) },
+      user_finder_by_id: ->(id) { User.find_by(id:) },
+      user_finder_by_token: ->(token) { User.find_by_token_for(:email_auth, token) },
+      user_initializer: ->(params) { User.new(params[:email]) },
+      user_name_field: "name",
+      token_generator: ->(user) { user.generate_token_for(:email_auth) },
+      token_expiry_minutes: 30,
+      # Controller setup
+      preserve_session_keys_after_logout: [],
+      # View setup
+      layout: "application",
+      register_view: "searls/auth/registrations/show",
+      login_view: "searls/auth/logins/show",
+      verify_view: "searls/auth/verifications/show",
+      mail_layout: "searls/auth/layouts/mailer",
+      mail_login_template_path: "searls/auth/login_link_mailer",
+      mail_login_template_name: "login_link",
+      # Route setup
+      redirect_path_after_register: ->(user, params, request, routes) {
+        # Not every app defines a root_path, so guarding here:
+        routes.respond_to?(:root_path) ? routes.root_path : "/"
+      },
+      default_redirect_path_after_login: ->(user, params, request, routes) {
+        # Not every app defines a root_path, so guarding here:
+        routes.respond_to?(:root_path) ? routes.root_path : "/"
+      },
+      # Hook setup
+      validate_registration: ->(user, params, errors) { errors },
+      after_login_success: nil,
+      # Branding setup
+      app_name: nil,
+      app_url: nil,
+      support_email_address: nil,
+      email_background_color: "#d8d7ed",
+      email_button_color: "#c664f3",
+      email_banner_image_path: nil
+    }.freeze
+
+    CONFIG = Config.new(**DEFAULT_CONFIG)
+    def self.configure(&blk)
+      yield CONFIG
+    end
+
+    def self.config
+      CONFIG.dup.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: searls-auth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Searls
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+email:
+- searls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/searls/auth/base_controller.rb
+- app/controllers/searls/auth/logins_controller.rb
+- app/controllers/searls/auth/registrations_controller.rb
+- app/controllers/searls/auth/verifications_controller.rb
+- app/helpers/searls/auth/application_helper.rb
+- app/javascript/controllers/searls_auth_login_controller.js
+- app/javascript/controllers/searls_auth_otp_controller.js
+- app/mailers/searls/auth/base_mailer.rb
+- app/mailers/searls/auth/login_link_mailer.rb
+- app/views/searls/auth/layouts/mailer.html.erb
+- app/views/searls/auth/login_link_mailer/login_link.html.erb
+- app/views/searls/auth/login_link_mailer/login_link.text.erb
+- app/views/searls/auth/logins/show.html.erb
+- app/views/searls/auth/registrations/show.html.erb
+- app/views/searls/auth/verifications/show.html.erb
+- config/importmap.rb
+- config/routes.rb
+- lib/searls/auth.rb
+- lib/searls/auth/authenticates_user.rb
+- lib/searls/auth/config.rb
+- lib/searls/auth/creates_user.rb
+- lib/searls/auth/emails_link.rb
+- lib/searls/auth/engine.rb
+- lib/searls/auth/railtie.rb
+- lib/searls/auth/resets_session.rb
+- lib/searls/auth/version.rb
+homepage: https://github.com/searls/searls-auth
+licenses:
+- GPL-3.0-only
+metadata:
+  homepage_uri: https://github.com/searls/searls-auth
+  source_code_uri: https://github.com/searls/searls-auth/tree/main
+  changelog_uri: https://github.com/searls/searls-auth/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Searls-flavored login for Rails apps
+test_files: []