trestle-auth 0.3.0 → 0.4.0

data/lib/trestle/auth/backends.rb

@@ -0,0 +1,34 @@
+module Trestle
+  module Auth
+    module Backends
+      extend ActiveSupport::Autoload
+
+      require_relative "backends/base"
+
+      autoload :Basic
+      autoload :Devise
+      autoload :Warden
+
+      def self.lookup(backend)
+        case backend
+        when Class
+          backend
+        else
+          registry.fetch(backend) { raise ArgumentError, "Invalid authentication backend: #{backend.inspect}" }
+        end
+      end
+
+      def self.registry
+        @registry ||= {}
+      end
+
+      def self.register(name, klass)
+        registry[name] = klass
+      end
+
+      register(:basic, Basic)
+      register(:devise, Devise)
+      register(:warden, Warden)
+    end
+  end
+end

data/lib/trestle/auth/backends/base.rb

@@ -0,0 +1,28 @@
+module Trestle
+  module Auth
+    module Backends
+      class Base
+        attr_reader :controller, :request, :session, :cookies
+
+        def initialize(controller:, request:, session:, cookies:)
+          @controller, @request, @session, @cookies = controller, request, session, cookies
+        end
+
+        # Default params scope to use for the login form.
+        def scope
+          :user
+        end
+
+        # Stores the previous return location in the session to return to after logging in.
+        def store_location(url)
+          session[:trestle_return_to] = url
+        end
+
+        # Returns (and deletes) the previously stored return location from the session.
+        def previous_location
+          session.delete(:trestle_return_to)
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/backends/basic.rb

@@ -0,0 +1,72 @@
+module Trestle
+  module Auth
+    module Backends
+      class Basic < Base
+        # Returns the current logged in user (after #authentication).
+        attr_reader :user
+
+        # Authenticates a user from a login form request.
+        def authenticate!
+          params = login_params
+
+          if user = Trestle.config.auth.authenticate(params)
+            login!(user)
+            remember_me! if Trestle.config.auth.remember.enabled && params[:remember_me]
+            user
+          end
+        end
+
+        # Authenticates a user from the session or cookie. Called on each request via a before_action.
+        def authenticate
+          @user = find_authenticated_user || find_remembered_user
+        end
+
+        # Checks if there is a logged in user.
+        def logged_in?
+          !!user
+        end
+
+        # Stores the given user in the session as logged in.
+        def login!(user)
+          session[:trestle_user] = user.id
+          @user = user
+        end
+
+        # Logs out the current user.
+        def logout!
+          if logged_in? && Trestle.config.auth.remember.enabled
+            Trestle.config.auth.remember.forget_me(user)
+            cookies.delete(:trestle_remember_token)
+          end
+
+          session.delete(:trestle_user)
+          @user = nil
+        end
+
+      protected
+        def remember_me!
+          Trestle.config.auth.remember.remember_me(user)
+          cookies.signed[:trestle_remember_token] = Trestle.config.auth.remember.cookie(user)
+        end
+
+        def find_authenticated_user
+          Trestle.config.auth.find_user(session[:trestle_user]) if session[:trestle_user]
+        end
+
+        def find_remembered_user
+          return unless Trestle.config.auth.remember.enabled
+
+          if token = cookies.signed[:trestle_remember_token]
+            user = Trestle.config.auth.remember.authenticate(token)
+            login!(user) if user
+            user
+          end
+        end
+
+        def login_params
+          controller.params.require(:user).permit!
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/backends/devise.rb

@@ -0,0 +1,14 @@
+module Trestle
+  module Auth
+    module Backends
+      class Devise < Warden
+        # Authenticates a user from a login form request.
+        # Devise requires that params authentication is explicitly enabled.
+        def authenticate!
+          request.env["devise.allow_params_authentication"] = true
+          super
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/backends/warden.rb

@@ -0,0 +1,53 @@
+module Trestle
+  module Auth
+    module Backends
+      class Warden < Base
+        # Authenticates a user from a login form request.
+        def authenticate!
+          authenticate
+        end
+
+        # Authenticates the user using Warden.
+        def authenticate
+          warden.authenticate(scope: scope)
+        end
+
+        # Checks if there is a logged in user.
+        def logged_in?
+          warden.authenticated?(scope)
+        end
+
+        # Returns the current logged in user.
+        def user
+          warden.user(scope)
+        end
+
+        # Stores the given user as logged in.
+        def login!(user)
+          warden.set_user(user, scope: scope)
+        end
+
+        # Logs out the current user.
+        def logout!
+          if scope
+            warden.logout(scope)
+            warden.clear_strategies_cache!(scope: scope)
+          else
+            warden.logout
+            warden.clear_strategies_cache!
+          end
+        end
+
+        # Set the login params scope from configuration, which is also used as the Warden scope.
+        def scope
+          Trestle.config.auth.warden.scope
+        end
+
+      protected
+        def warden
+          request.env['warden']
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/configuration.rb

@@ -1,9 +1,8 @@
 module Trestle
   module Auth
     class Configuration
-      extend ActiveSupport::Autoload
-
-      autoload :Rememberable
+      require_relative "configuration/rememberable"
+      require_relative "configuration/warden"
 
       include Configurable
 
@@ -26,6 +25,16 @@ module Trestle
         Trestle.config.auth.user_scope.find_by(id: id)
       }
 
+      option :human_attribute_name, ->(field) {
+        model = Trestle.config.auth.user_class rescue nil
+
+        if model && model.respond_to?(:human_attribute_name)
+          model.human_attribute_name(field)
+        else
+          field.to_s.humanize
+        end
+      }
+
       option :avatar, ->(user) {
         avatar { gravatar(user.email) }
       }, evaluate: false
@@ -46,12 +55,25 @@ module Trestle
         user.time_zone if user.respond_to?(:time_zone)
       }, evaluate: false
 
+      option :enable_login, true
+      option :enable_logout, true
+
+      option :login_url, -> { login_url }, evaluate: false
+
       option :redirect_on_login, -> { Trestle.config.path }, evaluate: false
       option :redirect_on_logout, -> { login_url }, evaluate: false
 
       option :logo
 
       option :remember, Rememberable.new
+
+      option :backend, Backends::Basic
+
+      def backend=(backend)
+        assign(:backend, Backends.lookup(backend))
+      end
+
+      option :warden, Warden.new
     end
   end
 end

data/lib/trestle/auth/configuration/warden.rb

@@ -0,0 +1,11 @@
+module Trestle
+  module Auth
+    class Configuration
+      class Warden
+        include Configurable
+
+        option :scope
+      end
+    end
+  end
+end

data/lib/trestle/auth/controller/authentication.rb

@@ -0,0 +1,55 @@
+module Trestle
+  module Auth
+    module Controller
+      module Authentication
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :current_user, :logged_in?, :authentication_scope
+
+          prepend_before_action :require_authenticated_user
+          prepend_before_action :authenticate_user
+        end
+
+      protected
+        def authentication_backend
+          @_authentication_backend ||= Trestle.config.auth.backend.new(controller: self, request: request, session: session, cookies: cookies)
+        end
+
+        def current_user
+          authentication_backend.user
+        end
+
+        def logged_in?
+          authentication_backend.logged_in?
+        end
+
+        def authenticate_user
+          authentication_backend.authenticate
+        end
+
+        def require_authenticated_user
+          logged_in? || login_required!
+        end
+
+        def login!(user)
+          authentication_backend.login!(user)
+        end
+
+        def logout!
+          authentication_backend.logout!
+        end
+
+        def login_required!
+          authentication_backend.store_location(request.fullpath)
+          redirect_to instance_exec(&Trestle.config.auth.login_url)
+          false
+        end
+
+        def authentication_scope
+          authentication_backend.scope
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/controller/locale.rb

@@ -0,0 +1,18 @@
+module Trestle
+  module Auth
+    module Controller
+      module Locale
+        extend ActiveSupport::Concern
+
+        included do
+          around_action :set_locale, if: :logged_in? if Trestle.config.auth.locale
+        end
+
+      protected
+        def set_locale
+          I18n.with_locale(instance_exec(current_user, &Trestle.config.auth.locale) || I18n.default_locale) { yield }
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/controller/time_zone.rb

@@ -0,0 +1,18 @@
+module Trestle
+  module Auth
+    module Controller
+      module TimeZone
+        extend ActiveSupport::Concern
+
+        included do
+          around_action :set_time_zone, if: :logged_in? if Trestle.config.auth.time_zone
+        end
+
+      protected
+        def set_time_zone
+          Time.use_zone(instance_exec(current_user, &Trestle.config.auth.time_zone) || Rails.application.config.time_zone) { yield }
+        end
+      end
+    end
+  end
+end

data/lib/trestle/auth/controller_methods.rb

@@ -3,80 +3,9 @@ module Trestle
     module ControllerMethods
       extend ActiveSupport::Concern
 
-      included do
-        helper_method :current_user, :logged_in?
-
-        before_action :require_authenticated_user
-
-        around_action :set_locale, if: :logged_in? if Trestle.config.auth.locale
-        around_action :set_time_zone, if: :logged_in? if Trestle.config.auth.time_zone
-      end
-
-    protected
-      def current_user
-        @current_user ||= begin
-          if session[:trestle_user]
-            Trestle.config.auth.find_user(session[:trestle_user])
-          elsif Trestle.config.auth.remember.enabled && token = cookies.signed[:trestle_remember_token]
-            user = Trestle.config.auth.remember.authenticate(token)
-            login!(user) if user
-            user
-          end
-        end
-      end
-
-      def login!(user)
-        session[:trestle_user] = user.id
-        @current_user = user
-      end
-
-      def logout!
-        forget_me!
-        session.delete(:trestle_user)
-        @current_user = nil
-      end
-
-      def logged_in?
-        !!current_user
-      end
-
-      def store_location
-        session[:trestle_return_to] = request.fullpath
-      end
-
-      def previous_location
-        session.delete(:trestle_return_to)
-      end
-
-      def require_authenticated_user
-        logged_in? || login_required!
-      end
-
-      def login_required!
-        store_location
-        redirect_to trestle.login_url
-        false
-      end
-
-      def remember_me!
-        return unless Trestle.config.auth.remember.enabled
-        Trestle.config.auth.remember.remember_me(current_user)
-        cookies.signed[:trestle_remember_token] = Trestle.config.auth.remember.cookie(current_user)
-      end
-
-      def forget_me!
-        return unless Trestle.config.auth.remember.enabled
-        Trestle.config.auth.remember.forget_me(current_user) if logged_in?
-        cookies.delete(:trestle_remember_token)
-      end
-
-      def set_locale
-        I18n.with_locale(Trestle.config.auth.locale.call(current_user) || I18n.default_locale) { yield }
-      end
-
-      def set_time_zone
-        Time.use_zone(Trestle.config.auth.time_zone.call(current_user) || Rails.application.config.time_zone) { yield }
-      end
+      include Trestle::Auth::Controller::Authentication
+      include Trestle::Auth::Controller::Locale
+      include Trestle::Auth::Controller::TimeZone
     end
   end
 end