entrance 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3320468261098d87b1536592f636be4d39b25403
-  data.tar.gz: f3b36768c497d6af747677461693920860a52c71
+  metadata.gz: 7854b9b5664f2f83c08fe0caa6a9edc1015921b2
+  data.tar.gz: 1837c76e8a619f050c27108007ccaf75cf0caf1c
 SHA512:
-  metadata.gz: e6169c56830fe1d3d430c854d2b0847c70d8776fc634bf0b72bfbf9124fedc0bb808a89cbc57d0bffdddcfe901697c474786703416c056d85c48985d36d9c06d
-  data.tar.gz: 3aa89b3005787082ae19173da9e8ba64135e9bc1521e49f1ed06ad5466d885b983c34a56d615906710b6d2e9c7d0a807f2b3adf60309c628c41e8f8a310a7872
+  metadata.gz: 505d8c13735e3081caadea508eeb1cc7f5a7f0b1e38cdb0d1aecf435162697a33b6080ed173af97495d11d228d483a615acbb28bb0a911919723799f09b2d5ed
+  data.tar.gz: eaae0ff772e873994d9beea456feeef07c1efed3161ce7da3498a89da01f2addbc389b64ee6ce2469f2f4f7952f04a897eba033497d8ec281249fe0595371d1c

data/README.md

@@ -0,0 +1,142 @@
+Entrance
+========
+
+Clean, adaptable authentication library for Rails and Sinatra.
+
+    $ gem install entrance
+
+Still in early phase, but it works. BCrypt and SHA1 (a-la Restful Auth) encryption are supported.
+
+# Usage
+
+``` rb
+# in an intializer, e.g. config/initializers/entrance.rb
+
+require 'entrance'
+
+Entrance.configure do |config|
+  config.username_attr             = 'email'
+  config.password_attr             = 'password_hash' # make sure you map the right attribute name
+  config.access_denied_message_key = 'messages.access_denied'
+  config.remember_for              = 1.month
+end
+
+# in your controller
+
+class ApplicationController < ActionController::Base
+  include Entrance::Controller
+
+  before_filter :login_required
+
+  ...
+end
+
+# in your model
+
+class User
+  include Entrance::Model
+
+  ...
+end
+```
+
+Now, you're ready to roll.
+
+``` rb
+class SessionsController < ApplicationController
+
+  skip_before_filter :login_required
+  
+  def new
+    # render login form
+  end
+
+  def create
+    if user = authenticate_and_login(params[:email], params[:password], params[:remember_me])
+      redirect_to '/app'
+    else
+      redirect_to :new, :notice => "Invalid credentials."
+    end
+  end
+
+end
+```
+
+If you need more control, you can call directly the model's `.authenticate` method.
+
+``` rb
+  def create
+    if user = User.authenticate(params[:email], params[:password]) and user.active?
+      remember = params[:remember_me] == '1'
+      login!(user, remember)
+      redirect_to '/app'
+    else
+      redirect_to :new, :notice => "Invalid credentials."
+    end
+  end
+```
+
+## Entrance::Config
+
+All available options, along with their defaults.
+
+``` rb
+Entrance.configure do |config|
+  config.model                      = 'User'
+  config.cipher                     = Ciphers::BCrypt
+  config.secret                     = nil
+  config.stretches                  = 10
+  config.salt_attr                  = nil
+  config.username_attr              = 'email'
+  config.password_attr              = 'password_hash'
+  config.remember_token_attr        = 'remember_token'
+  config.remember_until_attr        = 'remember_token_expires_at'
+  config.reset_token_attr           = 'reset_token'
+  config.reset_until_attr           = 'reset_token_expires_at'
+  config.access_denied_redirect_to  = '/'
+  config.access_denied_message_key  = nil
+  config.reset_password_mailer      = 'UserMailer'
+  config.reset_password_method      = 'reset_password_request'
+  config.reset_password_window      = 1.hour
+  config.remember_for               = 2.weeks
+  config.cookie_domain              = nil
+  config.cookie_secure              = true
+  config.cookie_path                = '/'
+  config.cookie_httponly            = false
+end
+```
+
+## Entrance::Controller
+
+When including it into your controller, this module will provide the following methods:
+  
+ - authenticate_and_login(username, password, remember_me = false)
+ - login!(user, remember_me = false)
+ - logout!
+
+And the following helpers: 
+
+ - current_user 
+ - login_required
+ - logged_in?
+ - logged_out?
+  
+## Entrance::Model
+
+Provides:
+
+ - .authenticate(username, password)
+ - #remember_me! and #forget_me!
+ - #password and #password=(value)
+ - #request_password_reset!
+ 
+Author
+======
+
+Written by Tomás Pollak.
+
+Copyright
+=========
+
+(c) Fork, Ltd. MIT Licensed. 
+ 

data/lib/entrance/config.rb

@@ -0,0 +1,40 @@
+module Entrance
+
+  class Config
+
+    attr_accessor *%w(
+      model cipher secret stretches
+      username_attr password_attr salt_attr
+      remember_token_attr remember_until_attr reset_token_attr reset_until_attr
+      access_denied_redirect_to access_denied_message_key
+      reset_password_mailer reset_password_method reset_password_window remember_for
+      cookie_domain cookie_secure cookie_path cookie_httponly
+    )
+
+    def initialize
+      @model                      = 'User'
+      @cipher                     = Ciphers::BCrypt # or Ciphers::SHA1 
+      @secret                     = nil
+      @stretches                  = 10
+      @salt_attr                  = nil
+      @username_attr              = 'email'
+      @password_attr              = 'password_hash'
+      @remember_token_attr        = 'remember_token'
+      @remember_until_attr        = 'remember_token_expires_at'
+      @reset_token_attr           = 'reset_token'
+      @reset_until_attr           = 'reset_token_expires_at'
+      @access_denied_redirect_to  = '/'
+      @access_denied_message_key  = nil # e.g. 'messages.access_denied'
+      @reset_password_mailer      = 'UserMailer'
+      @reset_password_method      = 'reset_password_request'
+      @reset_password_window      = 1.hour
+      @remember_for               = 2.weeks
+      @cookie_domain              = nil
+      @cookie_secure              = true
+      @cookie_path                = '/'
+      @cookie_httponly            = false
+    end
+
+  end
+
+end

data/lib/entrance/controller.rb

@@ -67,7 +67,11 @@ module Entrance
       if request.xhr?
         render :nothing => true, :status => 401
       else
-        flash[:notice] = I18n.t(Entrance.config.access_denied_message_key)
+        if Entrance.config.access_denied_message_key
+          flash[:notice] = I18n.t(Entrance.config.access_denied_message_key)
+        else
+          flash[:notice] = 'Access denied.'
+        end
         redirect_to Entrance.config.access_denied_redirect_to
       end
     end
@@ -90,7 +94,7 @@ module Entrance
     end
 
     def store_location
-      session[:return_to] = request.request_uri
+      session[:return_to] = request.path # request.request_uri
     end
 
     def redirect_to_stored_or(default_path)
@@ -117,7 +121,7 @@ module Entrance
 
     def delete_remember_cookie
       cookies.delete(REMEMBER_ME_TOKEN)
-      # cookies.delete(REMEMBER_ME_TOKEN, :domain => AppConfig.cookie_domain)
+      # cookies.delete(REMEMBER_ME_TOKEN, :domain => Entrance.config.cookie_domain)
     end
 
 #    def cookies

data/lib/entrance/model.rb

@@ -33,8 +33,9 @@ module Model
 
       query = {}
       query[Entrance.config.reset_token_attr] = token.strip
-      if u = where(query).first and u.send(Entrance.config.reset_until_attr) > Time.now
-        return u
+      if u = where(query).first \
+        and (!Doorman.config.reset_until_attr || u.send(Doorman.config.reset_until_attr) > Time.now)
+          return u
       end
     end
 
@@ -80,9 +81,12 @@ module Model
 
   def request_password_reset!
     send(Entrance.config.reset_token_attr + '=', Entrance.generate_token)
-    update_attribute(Entrance.config.reset_until_attr, Entrance.config.reset_password_window.from_now)
+    if Doorman.config.reset_until_attr
+      update_attribute(Entrance.config.reset_until_attr, Entrance.config.reset_password_window.from_now)
+    end
     if save(:validate => false)
-      Entrance.config.mailer_class.constantize.reset_password_request(self).deliver
+      method = Entrance.config.reset_password_method
+      Entrance.config.reset_password_mailer.constantize.send(method, self).deliver
     end
   end
 

data/lib/entrance/version.rb

@@ -1,7 +1,7 @@
 module Entrance
   MAJOR = 0
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/lib/entrance.rb

@@ -1,38 +1,11 @@
-####################################
-# Entrance
-#
-# By Tomas Pollak
-# Simple Ruby Authentication Library
-###################################
-
-=begin
-
-In your controller:
-  include Entrance::Controller
-
-  - Provides authenticate_and_login, login!(user), logout! methods
-  - Provices login_required, logged_in? and logged_out? helpers
-
-In your model:
-
-  include Entrance::Model
-
-  - Provides Model.authenticate(username, password)
-  - Provices Model#remember_me! and Model#forget_me!
-  - Provides Model#password getter and setter
-  - Provides Model#request_password_reset!
-=end
-
 require 'entrance/controller'
 require 'entrance/model'
 require 'entrance/ciphers'
 
-require 'active_support/time'
+require 'active_support/core_ext/numeric/time'
 
 module Entrance
 
-  REMEMBER_ME_TOKEN = 'auth_token'
-
   def self.config
     @config ||= Config.new
   end
@@ -45,39 +18,4 @@ module Entrance
     SecureRandom.hex(length/2).encode('UTF-8')
   end
 
-  class Config
-
-    attr_accessor *%w(
-      model mailer_class cipher secret stretches
-      username_attr password_attr salt_attr
-      remember_token_attr remember_until_attr reset_token_attr reset_until_attr
-      access_denied_redirect_to access_denied_message_key reset_password_window remember_for
-      cookie_domain cookie_secure cookie_path cookie_httponly
-    )
-
-    def initialize
-      @model                 = 'User'
-      @mailer_class          = 'UserMailer'
-      @cipher                = Ciphers::SHA1
-      @secret                = nil
-      @stretches             = 1
-      @username_attr         = 'email'
-      @password_attr         = 'password_hash'
-      @salt_attr             = nil
-      @remember_token_attr   = 'remember_token'
-      @remember_until_attr   = 'remember_token_expires_at'
-      @reset_token_attr      = 'reset_token'
-      @reset_until_attr      = 'reset_token_expires_at'
-      @access_denied_redirect_to  = '/'
-      @access_denied_message_key = 'messages.access_denied'
-      @reset_password_window = 1.hour
-      @remember_for          = 2.weeks
-      @cookie_domain         = nil
-      @cookie_secure         = true
-      @cookie_path           = '/'
-      @cookie_httponly       = false
-    end
-
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: entrance
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-05 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -46,10 +46,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- README.md
 - Rakefile
 - entrance.gemspec
 - lib/entrance.rb
 - lib/entrance/ciphers.rb
+- lib/entrance/config.rb
 - lib/entrance/controller.rb
 - lib/entrance/model.rb
 - lib/entrance/version.rb
@@ -77,3 +79,4 @@ signing_key:
 specification_version: 4
 summary: Lean authentication alternative for Rails and Sinatra.
 test_files: []
+has_rdoc: