rodauth-rails 0.1.0

data/lib/rodauth/rails/controller_methods.rb

@@ -0,0 +1,20 @@
+module Rodauth
+  module Rails
+    module ControllerMethods
+      def self.included(controller)
+        # ActionController::API doesn't have helper methods
+        if controller.respond_to?(:helper_method)
+          controller.helper_method :rodauth
+        end
+      end
+
+      def rodauth(name = nil)
+        if name
+          request.env["rodauth.#{name}"]
+        else
+          request.env["rodauth"]
+        end
+      end
+    end
+  end
+end

data/lib/rodauth/rails/feature.rb

@@ -0,0 +1,118 @@
+module Rodauth
+  Feature.define(:rails) do
+    depends :email_base
+
+    # List of overridable methods.
+    auth_methods(
+      :rails_render,
+      :rails_csrf_tag,
+      :rails_csrf_param,
+      :rails_csrf_token,
+      :rails_check_csrf!,
+      :rails_controller_instance,
+      :rails_controller,
+    )
+
+    # Renders templates with layout. First tries to render a user-defined
+    # template, otherwise falls back to Rodauth's template.
+    def view(page, *)
+      rails_render(action: page.tr("-", "_"), layout: true) ||
+        rails_render(html: super.html_safe, layout: true)
+    end
+
+    # Renders templates without layout. First tries to render a user-defined
+    # template or partial, otherwise falls back to Rodauth's template.
+    def render(page)
+      rails_render(partial: page.tr("-", "_"), layout: false) ||
+        rails_render(action: page.tr("-", "_"), layout: false) ||
+        super
+    end
+
+    # Render Rails CSRF tags in Rodauth templates.
+    def csrf_tag(*)
+      rails_csrf_tag
+    end
+
+    # Default the flash error key to Rails' default :alert.
+    def flash_error_key
+      :alert
+    end
+
+    private
+
+    # Verify Rails' authenticity token before each Rodauth route.
+    def before_rodauth
+      rails_check_csrf!
+      super
+    end
+
+    # Create emails with ActionMailer which uses configured delivery method.
+    def create_email_to(to, subject, body)
+      Mailer.create_email(to: to, from: email_from, subject: "#{email_subject_prefix}#{subject}", body: body)
+    end
+
+    # Delivers the given email.
+    def send_email(email)
+      email.deliver_now
+    end
+
+    # Calls the Rails renderer, returning nil if a template is missing.
+    def rails_render(*args)
+      rails_controller_instance.render_to_string(*args)
+    rescue ActionView::MissingTemplate
+      nil
+    end
+
+    # Hidden tag with Rails CSRF token inserted into Rodauth templates.
+    def rails_csrf_tag
+      %(<input type="hidden" name="#{rails_csrf_param}" value="#{rails_csrf_token}">)
+    end
+
+    # The request parameter under which to send the Rails CSRF token.
+    def rails_csrf_param
+      rails_controller.request_forgery_protection_token
+    end
+
+    # The Rails CSRF token value inserted into Rodauth templates.
+    def rails_csrf_token
+      rails_controller_instance.send(:form_authenticity_token)
+    end
+
+    # Calls the controller to verify the authenticity token.
+    def rails_check_csrf!
+      rails_controller_instance.send(:verify_authenticity_token)
+    end
+
+    # Instances of the configured controller with current request's env hash.
+    def rails_controller_instance
+      request  = ActionDispatch::Request.new(scope.env)
+      instance = rails_controller.new
+
+      if ActionPack.version >= Gem::Version.new("5.0.0")
+        instance.set_request! request
+        instance.set_response! rails_controller.make_response!(request)
+      else
+        instance.send(:set_response!, request)
+        instance.instance_variable_set(:@_request, request)
+      end
+
+      instance
+    end
+
+    # Controller class to use for rendering and CSRF protection.
+    def rails_controller
+      ActionController::Base
+    end
+
+    # ActionMailer subclass for correct email delivering.
+    class Mailer < ActionMailer::Base
+      def create_email(**options)
+        mail(**options)
+      end
+    end
+  end
+
+  # Assign feature and feature configuration to constants for introspection.
+  Rails::Feature              = FEATURES[:rails]
+  Rails::FeatureConfiguration = FEATURES[:rails].configuration
+end

data/lib/rodauth/rails/middleware.rb

@@ -0,0 +1,21 @@
+module Rodauth
+  module Rails
+    # Middleware that's added to the Rails middleware stack. Normally the main
+    # Roda app could be used directly, but this trick allows the app class to
+    # be reloadable.
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        app = Rodauth::Rails.app.new(@app)
+
+        # allow the Rails app to call Rodauth methods that throw :halt
+        catch(:halt) do
+          app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/rodauth/rails/railtie.rb

@@ -0,0 +1,18 @@
+require "rodauth/rails/middleware"
+require "rodauth/rails/controller_methods"
+
+module Rodauth
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "rodauth.middleware" do |app|
+        app.middleware.use Rodauth::Rails::Middleware if Rodauth::Rails.middleware?
+      end
+
+      initializer "rodauth.controller" do
+        ActiveSupport.on_load(:action_controller) do
+          include Rodauth::Rails::ControllerMethods
+        end
+      end
+    end
+  end
+end

data/lib/rodauth/rails.rb

@@ -0,0 +1,33 @@
+require "rodauth/rails/railtie"
+
+module Rodauth
+  module Rails
+    class Error < StandardError
+    end
+
+    # This allows the developer to avoid loading Rodauth at boot time.
+    autoload :App, "rodauth/rails/app"
+
+    def self.configure
+      yield self
+    end
+
+    @app = nil
+    @middleware = true
+
+    class << self
+      attr_writer :app
+      attr_writer :middleware
+
+      def app
+        fail Rodauth::Rails::Error, "app was not configured" unless @app
+
+        @app.constantize
+      end
+
+      def middleware?
+        @middleware
+      end
+    end
+  end
+end

data/lib/rodauth-rails.rb

@@ -0,0 +1 @@
+require "rodauth/rails"

data/rodauth-rails.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name          = "rodauth-rails"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Janko Marohnić"]
+  spec.email         = ["janko.marohnic@gmail.com"]
+
+  spec.summary       = %q{Provides Rails integration for Rodauth.}
+  spec.description   = %q{Provides Rails integration for Rodauth.}
+  spec.homepage      = "https://github.com/janko/rodauth-rails"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.2.0"
+
+  spec.files         = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "lib/**/*.rb", "*.gemspec"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 4.2", "< 7"
+  spec.add_dependency "rodauth", ">= 1.23", "< 3"
+  spec.add_dependency "sequel-activerecord_connection", "~> 0.2"
+  spec.add_dependency "tilt"
+  spec.add_dependency "bcrypt"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: rodauth-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rodauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.23'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.23'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sequel-activerecord_connection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides Rails integration for Rodauth.
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/generators/rodauth/install_generator.rb
+- lib/generators/rodauth/mailer_generator.rb
+- lib/generators/rodauth/templates/app/controllers/rodauth_controller.rb
+- lib/generators/rodauth/templates/app/mailers/rodauth_mailer.rb
+- lib/generators/rodauth/templates/app/models/account.rb
+- lib/generators/rodauth/templates/config/initializers/rodauth.rb
+- lib/generators/rodauth/templates/config/initializers/sequel.rb
+- lib/generators/rodauth/templates/db/migrate/create_rodauth.rb
+- lib/generators/rodauth/templates/lib/rodauth_app.rb
+- lib/generators/rodauth/views_generator.rb
+- lib/rodauth-rails.rb
+- lib/rodauth/features/rails.rb
+- lib/rodauth/rails.rb
+- lib/rodauth/rails/app.rb
+- lib/rodauth/rails/app/flash.rb
+- lib/rodauth/rails/controller_methods.rb
+- lib/rodauth/rails/feature.rb
+- lib/rodauth/rails/middleware.rb
+- lib/rodauth/rails/railtie.rb
+- rodauth-rails.gemspec
+homepage: https://github.com/janko/rodauth-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.1
+signing_key: 
+specification_version: 4
+summary: Provides Rails integration for Rodauth.
+test_files: []