kadmin 0.3.1 → 0.3.2

data/app/controllers/kadmin/application_controller.rb

@@ -1,64 +1,64 @@
-module Kadmin
-  class ApplicationController < ActionController::Base
-    layout 'modular/application'
-
-    helper Kadmin::ApplicationHelper
-    helper Kadmin::BootstrapHelper
-    helper Kadmin::AlertHelper
-    helper Kadmin::NavigationHelper
-    helper Kadmin::PaginationHelper
-
-    include Kadmin::Concerns::AuthorizedUser
-
-    before_action :authorize
-    before_action :set_navbar_links
-    before_action :set_default_format
-
-    # @!group Error Handling
-
-    unless defined?(BetterErrors)
-      rescue_from StandardError, with: :handle_unexpected_error
-      rescue_from ActiveRecord::RecordNotFound, with: :not_found
-      rescue_from ActionController::ParameterMissing, with: :params_missing
-    end
-
-    def params_missing(error)
-      handle_error(error, title: I18n.t('kadmin.errors.params_missing'), status: :bad_request)
-    end
-
-    def not_found(error)
-      handle_error(error, title: I18n.t('kadmin.errors.not_found'), status: :not_found)
-    end
-
-    def handle_unexpected_error(error)
-      Rails.logger.error(error)
-      handle_error(error, title: I18n.t('kadmin.errors.unexpected'), message: I18n.t('kadmin.errors.unexpected_message'))
-    end
-
-    def handle_error(error, options = {})
-      options = {
-        title: error.try(:title) || error.class.name,
-        message: error.message,
-        status: :internal_server_error
-      }.merge(options)
-      render 'kadmin/error', status: options[:status], locals: options
-    end
-
-    # @!endgroup
-
-    # @!group Helpers
-
-    # Overload in the sub-controllers to set up the links in the layout
-    def set_navbar_links
-      @layout_navbar_links = []
-    end
-    protected :set_navbar_links
-
-    def set_default_format
-      params[:format] = 'html' if params[:format].blank?
-    end
-    protected :set_default_format
-
-    # @!endgroup
-  end
-end
+module Kadmin
+  class ApplicationController < ActionController::Base
+    layout 'modular/application'
+
+    helper Kadmin::ApplicationHelper
+    helper Kadmin::BootstrapHelper
+    helper Kadmin::AlertHelper
+    helper Kadmin::NavigationHelper
+    helper Kadmin::PaginationHelper
+
+    include Kadmin::Concerns::AuthorizedUser
+
+    before_action :authorize
+    before_action :set_navbar_links
+    before_action :set_default_format
+
+    # @!group Error Handling
+
+    unless defined?(BetterErrors)
+      rescue_from StandardError, with: :handle_unexpected_error
+      rescue_from ActiveRecord::RecordNotFound, with: :not_found
+      rescue_from ActionController::ParameterMissing, with: :params_missing
+    end
+
+    def params_missing(error)
+      handle_error(error, title: I18n.t('kadmin.errors.params_missing'), status: :bad_request)
+    end
+
+    def not_found(error)
+      handle_error(error, title: I18n.t('kadmin.errors.not_found'), status: :not_found)
+    end
+
+    def handle_unexpected_error(error)
+      Rails.logger.error(error)
+      handle_error(error, title: I18n.t('kadmin.errors.unexpected'), message: I18n.t('kadmin.errors.unexpected_message'))
+    end
+
+    def handle_error(error, options = {})
+      options = {
+        title: error.try(:title) || error.class.name,
+        message: error.message,
+        status: :internal_server_error
+      }.merge(options)
+      render 'kadmin/error', status: options[:status], locals: options
+    end
+
+    # @!endgroup
+
+    # @!group Helpers
+
+    # Overload in the sub-controllers to set up the links in the layout
+    def set_navbar_links
+      @layout_navbar_links = []
+    end
+    protected :set_navbar_links
+
+    def set_default_format
+      params[:format] = 'html' if params[:format].blank?
+    end
+    protected :set_default_format
+
+    # @!endgroup
+  end
+end

data/app/controllers/kadmin/auth_controller.rb

@@ -1,98 +1,98 @@
-module Kadmin
-  class AuthController < Kadmin::ApplicationController
-    SESSION_KEY = 'kadmin.user'.freeze
-
-    # Don't try to authenticate user on the authentication controller...
-    skip_before_action :authorize
-
-    # @!group Endpoints
-    # GET /auth/login
-    def login
-      render 'kadmin/auth/login'
-    end
-
-    # GET /auth/logout
-    # DELETE /auth/logout
-    def logout
-      session.delete(SESSION_KEY)
-      redirect_to action: :login
-    end
-
-    # GET /auth/:provider/callback
-    # POST /auth/:provider/callback
-    def save
-      auth_hash = request.env['omniauth.auth']
-
-      if auth_hash.blank?
-        Kadmin.logger.error('No authorization hash provided')
-        flash.alert = I18n.t('kadmin.auth.error')
-        redirect_to action: :login
-        return
-      end
-
-      email = auth_hash.dig('info', 'email')
-      if Kadmin::Auth.users.exists?(email)
-        session[SESSION_KEY] = email
-        redirect_url = request.env['omniauth.origin']
-        redirect_url = Kadmin.config.mount_path unless valid_redirect_url?(redirect_url)
-      else
-        flash.alert = I18n.t('kadmin.auth.unauthorized_message')
-        redirect_url = url_for(action: :login)
-      end
-
-      redirect_to redirect_url
-    end
-
-    # GET /auth/failure
-    def failure
-      flash.alert = params[:message]
-      redirect_to action: :login
-    end
-
-    def unauthorized
-      render 'kadmin/error', format: ['html'], locals: {
-        title: I18n.t('kadmin.auth.unauthorized'),
-        message: I18n.t('kadmin.auth.unauthorized_message')
-      }
-    end
-
-    # @!endgroup
-
-    # @!group Helpers
-
-    def valid_redirect_url?(url)
-      valid = false
-
-      unless url.blank?
-        paths = [url_for(action: :login), url_for(action: :logout)]
-        valid = paths.none? { |invalid| url == invalid }
-      end
-
-      return valid
-    end
-    protected :valid_redirect_url?
-
-    def omniauth_provider_link
-      auth_prefix = "#{Kadmin.config.mount_path}/auth"
-      provider_link = "#{auth_prefix}/#{Kadmin::Auth.omniauth_provider}"
-      origin = params[:origin]
-
-      # if the referer is a auth route, then we risk ending in an endless loop
-      if origin.blank?
-        referer = request.referer
-        if referer.blank?
-          origin = Kadmin.config.mount_path
-        else
-          uri = URI(referer)
-          origin = referer unless uri&.path&.start_with?(auth_prefix)
-        end
-      end
-
-      provider_link = "#{provider_link}?origin=#{CGI.escape(origin)}" unless origin.blank?
-      return provider_link
-    end
-    helper_method :omniauth_provider_link
-
-    # @!endgroup
-  end
-end
+module Kadmin
+  class AuthController < Kadmin::ApplicationController
+    SESSION_KEY = 'kadmin.user'.freeze
+
+    # Don't try to authenticate user on the authentication controller...
+    skip_before_action :authorize
+
+    # @!group Endpoints
+    # GET /auth/login
+    def login
+      render 'kadmin/auth/login'
+    end
+
+    # GET /auth/logout
+    # DELETE /auth/logout
+    def logout
+      session.delete(SESSION_KEY)
+      redirect_to action: :login
+    end
+
+    # GET /auth/:provider/callback
+    # POST /auth/:provider/callback
+    def save
+      auth_hash = request.env['omniauth.auth']
+
+      if auth_hash.blank?
+        Kadmin.logger.error('No authorization hash provided')
+        flash.alert = I18n.t('kadmin.auth.error')
+        redirect_to action: :login
+        return
+      end
+
+      email = auth_hash.dig('info', 'email')
+      if Kadmin::Auth.users.exists?(email)
+        session[SESSION_KEY] = email
+        redirect_url = request.env['omniauth.origin']
+        redirect_url = Kadmin.config.mount_path unless valid_redirect_url?(redirect_url)
+      else
+        flash.alert = I18n.t('kadmin.auth.unauthorized_message')
+        redirect_url = url_for(action: :login)
+      end
+
+      redirect_to redirect_url
+    end
+
+    # GET /auth/failure
+    def failure
+      flash.alert = params[:message]
+      redirect_to action: :login
+    end
+
+    def unauthorized
+      render 'kadmin/error', format: ['html'], locals: {
+        title: I18n.t('kadmin.auth.unauthorized'),
+        message: I18n.t('kadmin.auth.unauthorized_message')
+      }
+    end
+
+    # @!endgroup
+
+    # @!group Helpers
+
+    def valid_redirect_url?(url)
+      valid = false
+
+      unless url.blank?
+        paths = [url_for(action: :login), url_for(action: :logout)]
+        valid = paths.none? { |invalid| url == invalid }
+      end
+
+      return valid
+    end
+    protected :valid_redirect_url?
+
+    def omniauth_provider_link
+      auth_prefix = "#{Kadmin.config.mount_path}/auth"
+      provider_link = "#{auth_prefix}/#{Kadmin::Auth.omniauth_provider}"
+      origin = params[:origin]
+
+      # if the referer is a auth route, then we risk ending in an endless loop
+      if origin.blank?
+        referer = request.referer
+        if referer.blank?
+          origin = Kadmin.config.mount_path
+        else
+          uri = URI(referer)
+          origin = referer unless uri&.path&.start_with?(auth_prefix)
+        end
+      end
+
+      provider_link = "#{provider_link}?origin=#{CGI.escape(origin)}" unless origin.blank?
+      return provider_link
+    end
+    helper_method :omniauth_provider_link
+
+    # @!endgroup
+  end
+end

data/app/controllers/kadmin/concerns/authorized_user.rb

@@ -1,67 +1,67 @@
-module Kadmin
-  module Concerns
-    module AuthorizedUser
-      extend ActiveSupport::Concern
-
-      included do
-        if respond_to?(:helper_method)
-          helper_method :current_user
-          helper_method :authorized_user
-          helper_method :logged_in?
-          helper_method :authorized?
-        end
-      end
-
-      # @!group before_action
-
-      # Add as a before_action whenever you wish to authorize a user for a particular
-      # resource. The app provided user model will perform authorization of the resource.
-      # @see Kadmin::Auth::User
-      # @example
-      #   before_action :authorize, except: [:index] # exclude index from authorization
-      def authorize
-        if Kadmin::Auth.config.enabled?
-          if logged_in?
-            unless authorized?
-              redirect_to Kadmin::Engine.routes.url_helpers.auth_unauthorized_path
-            end
-          else
-            redirect_to Kadmin::Engine.routes.url_helpers.auth_login_path(origin: request.path)
-          end
-        end
-      end
-
-      # @!endgroup
-
-      # @!group View Helpers
-
-      # @return [String] the current user identifier. Historically called current_user
-      def current_user
-        session[Kadmin::AuthController::SESSION_KEY]
-      end
-
-      # @see Kadmin::Concerns::AuthorizedUser#current_user
-      # @return [Kadmin::Auth::User] instance of the user identified by current_user
-      def authorized_user
-        return Kadmin::Auth.users.get(current_user)
-      end
-
-      # @!endgroup
-
-      # @!group Helpers
-
-      # @return [Boolean] true if the user is logged in, false otherwise
-      def logged_in?
-        return current_user.present?
-      end
-
-      # @see Kadmin::Auth::User
-      # @return [Boolean] true if the user is authorized in, false otherwise
-      def authorized?
-        return authorized_user&.authorized?(request)
-      end
-
-      # @!endgroup
-    end
-  end
-end
+module Kadmin
+  module Concerns
+    module AuthorizedUser
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:helper_method)
+          helper_method :current_user
+          helper_method :authorized_user
+          helper_method :logged_in?
+          helper_method :authorized?
+        end
+      end
+
+      # @!group before_action
+
+      # Add as a before_action whenever you wish to authorize a user for a particular
+      # resource. The app provided user model will perform authorization of the resource.
+      # @see Kadmin::Auth::User
+      # @example
+      #   before_action :authorize, except: [:index] # exclude index from authorization
+      def authorize
+        if Kadmin::Auth.config.enabled?
+          if logged_in?
+            unless authorized?
+              redirect_to Kadmin::Engine.routes.url_helpers.auth_unauthorized_path
+            end
+          else
+            redirect_to Kadmin::Engine.routes.url_helpers.auth_login_path(origin: request.path)
+          end
+        end
+      end
+
+      # @!endgroup
+
+      # @!group View Helpers
+
+      # @return [String] the current user identifier. Historically called current_user
+      def current_user
+        session[Kadmin::AuthController::SESSION_KEY]
+      end
+
+      # @see Kadmin::Concerns::AuthorizedUser#current_user
+      # @return [Kadmin::Auth::User] instance of the user identified by current_user
+      def authorized_user
+        return Kadmin::Auth.users.get(current_user)
+      end
+
+      # @!endgroup
+
+      # @!group Helpers
+
+      # @return [Boolean] true if the user is logged in, false otherwise
+      def logged_in?
+        return current_user.present?
+      end
+
+      # @see Kadmin::Auth::User
+      # @return [Boolean] true if the user is authorized in, false otherwise
+      def authorized?
+        return authorized_user&.authorized?(request)
+      end
+
+      # @!endgroup
+    end
+  end
+end