simple_auth 2.0.4 → 3.0.0

data/lib/simple_auth/action_controller/require_login_action.rb

@@ -0,0 +1,47 @@
+module SimpleAuth
+  module ActionController
+    class RequireLoginAction
+      DEFAULT_UNLOGGED_IN_MESSAGE = "You must be logged in to access this page."
+      DEFAULT_UNAUTHORIZED_MESSAGE = "You don't have permission to access this page."
+
+      attr_reader :controller, :scope
+
+      def initialize(controller, scope)
+        @controller = controller
+        @scope = scope
+      end
+
+      def valid?
+        valid_session? && authorized?
+      end
+
+      def message
+        return nil if valid?
+        return unauthorized_message unless authorized?
+        unlogged_message
+      end
+
+      private
+
+      def valid_session?
+        controller.send("#{scope}_session").valid?
+      end
+
+      def authorized?
+        controller.send("authorized_#{scope}?")
+      end
+
+      def unauthorized_message
+        translation_for("#{scope}.unauthorized", DEFAULT_UNAUTHORIZED_MESSAGE)
+      end
+
+      def unlogged_message
+        translation_for("#{scope}.unlogged_in", DEFAULT_UNLOGGED_IN_MESSAGE)
+      end
+
+      def translation_for(translation_scope, default_message)
+        I18n.t(translation_scope, scope: :simple_auth, default: default_message)
+      end
+    end
+  end
+end

data/lib/simple_auth/config.rb

@@ -1,44 +1,21 @@
 module SimpleAuth
-  # Add a shortcut to SimpleAuth::Config
-  def self.setup(&block)
-    yield SimpleAuth::Config if block_given?
-  end
-
   class Config
-    # Automatically remove all session values that start with your model name.
-    #
-    # When an existing session is destroyed or a new session is created,
-    # SimpleAuth will remove the record id stored as <tt>#{SimpleAuth::Config.model}</tt>.
-    #
-    # Additionally, you can enable this option to remove any other key composed by
-    # <tt>#{SimpleAuth::Config.model}_*</tt>.
-    #
-    cattr_accessor :wipeout_session
-    @@wipeout_session = false
-
-    # Set which attributes will be used for authentication.
-    cattr_accessor :credentials
-    @@credentials = [:email, :login]
-
-    # Set the user model
-    cattr_accessor :model
-    @@model = :user
-
-    # Set the current controller object
-    cattr_accessor :controller
-    @@controller = nil
+    # Set which scopes will be activated.
+    # By default it enables `user` and `admin`.
+    attr_accessor :scopes
 
-    # Set the login url
-    cattr_accessor :login_url
-    @@login_url = proc { login_path }
+    # Set the login url.
+    # This will be used to redirect unlogged users to the login page.
+    # Default to `login_path`.
+    attr_accessor :login_url
 
-    # Logged users will be redirect to this url
-    # when +redirect_logged_user+ helper is used.
-    cattr_accessor :logged_url
-    @@logged_url = proc { dashboard_path }
+    # Set the logged url.
+    # This will be used to redirect logged users to the dashboard page.
+    # Default to `dashboard_path`.
+    attr_accessor :logged_url
 
-    def self.model_class
-      model.to_s.classify.constantize
+    def install_helpers!
+      ::ActionController::Base.include SimpleAuth::ActionController
     end
   end
 end

data/lib/simple_auth/generator.rb

@@ -1,8 +1,8 @@
-require "rails/generators/base"
+require "rails/generators"
 
 module SimpleAuth
   class InstallGenerator < ::Rails::Generators::Base
-    source_root File.dirname(__FILE__) + "/../../templates"
+    source_root "#{__dir__}/templates/install"
 
     def copy_initializer_file
       copy_file "initializer.rb", "config/initializers/simple_auth.rb"

data/lib/simple_auth/railtie.rb

@@ -3,16 +3,5 @@ module SimpleAuth
     generators do
       require "simple_auth/generator"
     end
-
-    initializer "simple_auth.initialize" do |app|
-      ::ActionController::Base.instance_eval do
-        include SimpleAuth::ActionController
-        helper SimpleAuth::Helper
-        prepend_before_filter :activate_simple_auth
-        helper_method :current_user, :current_session, :logged_in?
-      end
-
-      ::ActiveRecord::Base.class_eval { include SimpleAuth::ActiveRecord }
-    end
   end
 end

data/lib/simple_auth/session.rb

@@ -1,163 +1,39 @@
 module SimpleAuth
   class Session
-    attr_accessor :credential
-    attr_accessor :password
-    attr_accessor :model
-    attr_accessor :controller
-    attr_accessor :record
-    attr_accessor :errors
-
-    class Errors # :nodoc:all
-      attr_accessor :errors
-
-      def add_to_base(message)
-        @errors << message
-      end
-
-      def initialize
-        @errors = []
-      end
-
-      def on(attr_name)
-        nil
-      end
-
-      def full_messages
-        @errors
-      end
-
-      def empty?
-        @errors.empty?
-      end
-
-      def [](attr_name)
-        []
-      end
-    end
-
-    def self.session_key
-      "#{SimpleAuth::Config.model.to_s}_id".to_sym
-    end
-
-    def self.record_id
-      controller && controller.session[session_key]
-    end
-
-    def self.backup(&block)
-      backup = controller.session.to_hash.reject do |name, value|
-        rejected = [:session_id, session_key].include?(name.to_sym) || SimpleAuth::Config.wipeout_session && name.to_s =~ /^#{SimpleAuth::Config.model}_/
-        controller.session.delete(name) if rejected
-        rejected
-      end
-
-      yield
-
-      backup.each do |name, value|
-        controller.session[name.to_sym] = value
-      end
-    end
-
-    def self.find
-      return unless controller && record_id
-      session = new
-      session.record = session.model.find_by_id(record_id)
-
-      if session.record
-        session
-      else
-        nil
-      end
-    end
-
-    def self.create(options = {})
-      new(options).tap do |session|
-        session.save
-      end
+    def self.create(**kwargs)
+      new(**kwargs)
     end
 
-    def self.create!(options = {})
-      new(options).tap do |session|
-        session.save!
-      end
+    def initialize(scope:, session:, record: nil)
+      @scope = scope
+      @session = session
+      self.record = record if record
     end
 
-    def self.controller
-      SimpleAuth::Config.controller
+    def record=(record)
+      @session[record_key] = record.try(:id)
+      @record = record
     end
 
-    def self.destroy!
-      [:session_id, session_key].each {|name| controller.session.delete(name) }
-
-      controller.instance_variable_set("@current_user", nil)
-      controller.instance_variable_set("@current_session", nil)
-
-      backup { controller.reset_session }
-
-      true
-    end
-
-    def self.model_name
-      ActiveModel::Name.new(self)
-    end
-
-    def initialize(options = {})
-      options ||= {}
-
-      @credential = options[:credential]
-      @password = options[:password]
-      @controller = SimpleAuth::Config.controller
-      @model = SimpleAuth::Config.model_class
-      @errors = Errors.new
+    def record
+      @record ||= record_class
+                  .find_by_id(record_id_from_session) if record_id_from_session
     end
 
-    def to_key
-      nil
+    def record_class
+      @record_class ||= Object.const_get(:"#{@scope.to_s.camelize}")
     end
 
-    def new_record?
-      record.nil?
+    def record_key
+      :"#{@scope}_id"
     end
 
-    def persisted?
-      !new_record?
+    def record_id_from_session
+      @session[record_key]
     end
 
     def valid?
-      if record && controller.send(:authorized?)
-        true
-      else
-        errors.add_to_base I18n.translate("simple_auth.sessions.invalid_credentials")
-        self.class.destroy!
-        false
-      end
-    end
-
-    def record
-      @record ||= model
-        .find_by_credential(credential)
-        .try(:authenticate, password)
-    end
-
-    def save
-      self.class.destroy!
-
-      controller.session[self.class.session_key] = record.id if valid?
-      controller.session[self.class.session_key] != nil
-    end
-
-    def save!
-      if valid?
-        save
-      else
-        raise SimpleAuth::NotAuthorized
-      end
-    end
-
-    def destroy
-      @record = nil
-      @credential = nil
-      @password = nil
-      self.class.destroy!
+      record.present?
     end
   end
 end

data/lib/simple_auth/templates/install/initializer.rb

@@ -0,0 +1,23 @@
+SimpleAuth.setup do |config|
+  # Define with scopes will be installed.
+  # This can be useful if you want to have separated sessions
+  # (e.g. regular user and admin user).
+  #
+  # To enable both user and admin sessions, you can define the scopes
+  # like this:
+  #
+  # config.scopes = %i[user admin]
+  #
+  config.scopes = %i[user]
+
+  # Set the login url.
+  # This is where users will be redirected to when they're unlogged.
+  config.login_url = proc { login_path }
+
+  # Logged users will be redirect to this url
+  # when `before_action :redirect_logged_user` filter is used.
+  config.logged_url = proc { dashboard_path }
+
+  # Install SimpleAuth helpers to the controllers.
+  config.install_helpers!
+end

data/lib/simple_auth/version.rb

@@ -1,8 +1,3 @@
 module SimpleAuth
-  module Version
-    MAJOR = 2
-    MINOR = 0
-    PATCH = 4
-    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
-  end
+  VERSION = "3.0.0"
 end

data/simple_auth.gemspec

@@ -1,8 +1,9 @@
 require "./lib/simple_auth/version"
 
 Gem::Specification.new do |s|
+  s.required_ruby_version = ">= 2.2.0"
   s.name        = "simple_auth"
-  s.version     = SimpleAuth::Version::STRING
+  s.version     = SimpleAuth::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Nando Vieira"]
   s.email       = ["fnando.vieira@gmail.com"]
@@ -15,9 +16,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", ">= 3.1.0"
+  s.add_dependency "rails", ">= 4.2.0"
   s.add_development_dependency "sqlite3-ruby"
-  s.add_development_dependency "rspec-rails", "3.0.0.beta2"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "minitest-utils"
   s.add_development_dependency "bcrypt", "~> 3.1.7"
   s.add_development_dependency "pry-meta"
 end

data/test/controllers/admin/dashboard_controller_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+
+class AdminDashboardControllerTest < ActionController::TestCase
+  tests Admin::DashboardController
+
+  setup do
+    @routes = Rails.application.routes
+    @controller.reset_session
+  end
+
+  test "authorizes logged admin" do
+    get :log_in_as_admin
+    get :index
+
+    assert_response :success
+  end
+
+  test "authorizes logged user with admin flag" do
+    get :log_in_as_admin
+    get :index
+
+    assert_response :success
+  end
+
+  test "denies user" do
+    get :log_in_as_user
+    get :index
+
+    assert_redirected_to login_path
+  end
+end

data/test/controllers/dashboard_controller_test.rb

@@ -0,0 +1,56 @@
+require "test_helper"
+
+class DashboardControllerTest < ActionController::TestCase
+  setup do
+    @routes = Rails.application.routes
+    @controller.reset_session
+
+    User.delete_all
+    User.create!(password: "test", email: "john@example.com")
+  end
+
+  test "redirects unlogged user to login path" do
+    get :index
+    assert_redirected_to login_path
+  end
+
+  test "sets flash message while redirecting unlogged user" do
+    get :index
+    assert_equal "You don't have permission to access this page.", flash[:alert]
+  end
+
+  test "renders page for logged user" do
+    get :log_in
+    get :index
+
+    assert_response :success
+  end
+
+  test "redirects logged user" do
+    get :log_in
+    get :not_logged
+
+    assert_redirected_to dashboard_path
+  end
+
+  test "renders page for unlogged user" do
+    get :not_logged
+    assert_response :success
+  end
+
+  test "redirects unauthorized user" do
+    User.create!(password: "test", email: "john@example.org")
+    get :log_in
+    get :index
+
+    assert_redirected_to login_path
+  end
+
+  test "sets flash message while redirecting unauthorized user" do
+    User.create!(password: "test", email: "john@example.org")
+    get :log_in
+    get :index
+
+    assert_equal "You don't have permission to access this page.", flash[:alert]
+  end
+end