minimalist_authentication 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06e297700ba62d9fef159d0cb8250f7740d020a9
-  data.tar.gz: c0d08dd52efbfa264a3e12b8be898baf81dacf4a
+  metadata.gz: bda0fef1ab5c360af94e908ec11ba51059788808
+  data.tar.gz: f691883871f612e2ed2f709736f3fb3eebf68d8b
 SHA512:
-  metadata.gz: d01e275ff312ba91f03abff19e221bc3bdcdb188fce8dce2b74d1f37df4bac82e61ef90740e101a808bde45be9b4004cf30c11fbdca4f61313ffc720cc1b3a8d
-  data.tar.gz: a6a28b7e973111b32620029d02a3f04927f743a42e1bd45fe608412cc231a5396a3232f104dcc3d1c5498b2ddab973fd4ed412870e9b2e656c7008f37c944be9
+  metadata.gz: 3fb4e425254e581abdf5e2fc9a7e461a4c5208513bcc122447acdf2db79e8dfd3db9b1595d58758b2c274ed667711863533e298ca469676c51091802273eb7bc
+  data.tar.gz: b782a7c2a6070fa446636a040ac60b969014a17500e22d68fdca2332426163759dedb58843107b358096ff5896a3e2047c32c5ceaca120fed4e4cb3771a61c5a

data/README.md

@@ -14,7 +14,7 @@ And then execute:
 $ bundle
 ```
 
-Create a user model for with **email** for an identifier:
+Create a user model with **email** for an identifier:
 ```bash
 bin/rails generate model user active:boolean email:string crypted_password:string salt:string last_logged_in_at:datetime
 ```
@@ -26,31 +26,47 @@ bin/rails generate model user active:boolean username:string crypted_password:st
 
 
 ## Example
-Include Minimalist::Authentication in your user model (app/models/user.rb)
+Include MinimalistAuthentication::User in your user model (app/models/user.rb)
 ```ruby
 class User < ApplicationRecord
-  include Minimalist::Authentication
+  include MinimalistAuthentication::User
 end
 ```
 
-Include Minimalist::Authorization in your ApplicationController (app/controllers/application.rb)
+Include MinimalistAuthentication::Controller in your ApplicationController (app/controllers/application.rb)
 ```ruby
 class ApplicationController < ActionController::Base
-  include Minimalist::Authorization
+  include MinimalistAuthentication::Controller
 end
 ```
 
-Include Minimalist::Sessions in your SessionsController (app/controllers/sessions_controller.rb)
+Include MinimalistAuthentication::Sessions in your SessionsController (app/controllers/sessions_controller.rb)
 ```ruby
 class SessionsController < ApplicationController
-  include Minimalist::Sessions
+  include MinimalistAuthentication::Sessions
+end
+```
+
+Add session to your routes file (config/routes.rb)
+```ruby
+Rails.application.routes.draw do
+  resource :session, only: %i(new create destroy)
 end
 ```
 
 Include Minimalist::TestHelper in your test helper (test/test_helper.rb)
 ```ruby
 class ActiveSupport::TestCase
-  include Minimalist::TestHelper
+  include MinimalistAuthentication::TestHelper
+end
+```
+
+## Example
+Customize the configuration with an initializer. Create a **minimalist_authentication.rb** file in /Users/baldwina/git/brightways/config/initializers.
+```ruby
+MinimalistAuthentication.configure do |configuration|
+  configuration.user_model_name   = 'CustomModelName'     # default is '::User'
+  configuration.session_key       = :custom_session_key   # default is ':user_id'
 end
 ```
 

data/lib/minimalist_authentication.rb

@@ -1,8 +1,7 @@
 require 'minimalist_authentication/engine'
+require 'minimalist_authentication/configuration'
+require 'minimalist_authentication/user'
 require 'minimalist_authentication/null_password'
-
-# MinimalistAuthentication
-require 'minimalist/authentication'
-require 'minimalist/authorization'
-require 'minimalist/sessions'
-require 'minimalist/test_helper'
+require 'minimalist_authentication/controller'
+require 'minimalist_authentication/sessions'
+require 'minimalist_authentication/test_helper'

data/lib/minimalist_authentication/configuration.rb

@@ -0,0 +1,38 @@
+module MinimalistAuthentication
+  # store the configuration object
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # yield the configuration object for modification
+  def self.configure
+    yield configuration
+  end
+
+  # reset the configuration object
+  def self.reset_configuration!
+    @configuration = nil
+  end
+
+  class Configuration
+    # The session_key used to store the current_user id.
+    # Defaults to :user_id
+    attr_accessor :session_key
+
+    # The application user class name
+    # Defaults to '::User'
+    attr_accessor :user_model_name
+
+    def initialize
+      self.user_model_name  = '::User'
+      self.session_key      = :user_id
+    end
+
+    # Returns the user_model class
+    # Calling constantize on a string makes this work correctly with
+    # the spring application preloader gem.
+    def user_model
+      @user_model ||= user_model_name.constantize
+    end
+  end
+end

data/lib/{minimalist/authorization.rb → minimalist_authentication/controller.rb}

@@ -1,5 +1,5 @@
-module Minimalist
-  module Authorization
+module MinimalistAuthentication
+  module Controller
     extend ActiveSupport::Concern
 
     included do
@@ -13,11 +13,15 @@ module Minimalist
     private
 
     def current_user
-      @current_user ||= (get_user_from_session || User.guest)
+      @current_user ||= (get_user_from_session || MinimalistAuthentication.configuration.user_model.guest)
     end
 
     def get_user_from_session
-      User.find_by_id(session[:user_id]) if session[:user_id]
+      MinimalistAuthentication.configuration.user_model.find_by_id(session_user_id) if session_user_id
+    end
+
+    def session_user_id
+      session[MinimalistAuthentication.configuration.session_key]
     end
 
     def authorization_required

data/lib/{minimalist → minimalist_authentication}/sessions.rb

@@ -1,4 +1,4 @@
-module Minimalist
+module MinimalistAuthentication
   module Sessions
     extend ActiveSupport::Concern
 
@@ -8,14 +8,14 @@ module Minimalist
     end
 
     def new
-      @user = User.new
+      @user = MinimalistAuthentication.configuration.user_model.new
     end
 
     def create
       if authenticated_user
         scrub_session!
         authenticated_user.logged_in
-        session[:user_id] = authenticated_user.id
+        session[MinimalistAuthentication.configuration.session_key] = authenticated_user.id
         after_authentication_success
         return
       else
@@ -32,7 +32,7 @@ module Minimalist
     private
 
     def authenticated_user
-      @authenticated_user ||= User.authenticate(user_params)
+      @authenticated_user ||= MinimalistAuthentication.configuration.user_model.authenticate(user_params)
     end
 
     def user_params

data/lib/minimalist_authentication/test_helper.rb

@@ -0,0 +1,22 @@
+module MinimalistAuthentication
+  module TestHelper
+    def login_as(user_fixture_name, password = 'password')
+      post session_path, params: { user: { email: users(user_fixture_name).email, password: password } }
+    end
+
+
+    def current_user
+      @current_user ||= load_user_from_session
+    end
+
+    private
+
+    def load_user_from_session
+      MinimalistAuthentication.configuration.user_model.find(session_user_id) if session_user_id
+    end
+
+    def session_user_id
+      @request.session[MinimalistAuthentication.configuration.session_key]
+    end
+  end
+end

data/lib/{minimalist/authentication.rb → minimalist_authentication/user.rb}

@@ -1,7 +1,7 @@
 require 'bcrypt'
 
-module Minimalist
-  module Authentication
+module MinimalistAuthentication
+  module User
     extend ActiveSupport::Concern
 
     GUEST_USER_EMAIL = 'guest'
@@ -88,8 +88,6 @@ module Minimalist
 
     def encrypt_password
       return if password.blank?
-      # self.salt = self.class.make_token
-      # self.crypted_password = encrypt(password)
       password_hash         = self.class.password_hash(password)
       self.salt             = password_hash.salt
       self.crypted_password = password_hash.checksum

data/lib/minimalist_authentication/version.rb

@@ -1,3 +1,3 @@
 module MinimalistAuthentication
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimalist_authentication
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Aaron Baldwin
@@ -74,13 +74,14 @@ files:
 - app/views/sessions/_form.html.erb
 - app/views/sessions/new.html.erb
 - config/routes.rb
-- lib/minimalist/authentication.rb
-- lib/minimalist/authorization.rb
-- lib/minimalist/sessions.rb
-- lib/minimalist/test_helper.rb
 - lib/minimalist_authentication.rb
+- lib/minimalist_authentication/configuration.rb
+- lib/minimalist_authentication/controller.rb
 - lib/minimalist_authentication/engine.rb
 - lib/minimalist_authentication/null_password.rb
+- lib/minimalist_authentication/sessions.rb
+- lib/minimalist_authentication/test_helper.rb
+- lib/minimalist_authentication/user.rb
 - lib/minimalist_authentication/version.rb
 - lib/tasks/minimalist_authentication_tasks.rake
 homepage: https://github.com/wwidea/minimalist_authentication

data/lib/minimalist/test_helper.rb

@@ -1,12 +0,0 @@
-module Minimalist
-  module TestHelper
-    def login_as(user_fixture_name, password = 'password')
-      post session_path, params: { user: { email: users(user_fixture_name).email, password: password } }
-    end
-
-
-    def current_user
-      @current_user ||= (@request.session[:user_id] ? User.find(@request.session[:user_id]) : nil)
-    end
-  end
-end