entrance 0.2.0 → 0.2.1

data/README.md

@@ -19,6 +19,7 @@ Entrance.configure do |config|
   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
+  config.cookie_secure             = Rails.env.production?
 end
 
 # in your controller
@@ -52,30 +53,31 @@ class SessionsController < ApplicationController
   end
 
   def create
-    if user = authenticate_and_login(params[:email], params[:password], params[:remember_me])
+    if user = authenticate_and_login(params[:email], params[:password], params[:remember_me] == 'on')
       redirect_to '/app'
     else
-      redirect_to :new, :notice => "Invalid credentials."
+      redirect_to '/login', :notice => "Invalid credentials."
     end
   end
 
 end
 ```
 
-If you need more control, you can call directly the model's `.authenticate` method.
+If you need more control, -- like checking a users state before letting him in -- you can call directly the model's `.authenticate` method, and then call the `login!` method once you're ready.
 
 ``` rb
   def create
     if user = User.authenticate(params[:email], params[:password]) and user.active?
-      remember = params[:remember_me] == '1'
-      login!(user, remember)
+      login!(user, params[:remember_me] == '1')
       redirect_to '/app'
     else
-      redirect_to :new, :notice => "Invalid credentials."
+      redirect_to '/login', :notice => "Invalid credentials."
     end
   end
 ```
 
+As you can see, Entrance comes with out-of-box support for the "remember me" option. It also supports the usual 'reset password' token/email logic, but that's it. That's as far as Entrance goes -- we want to keep things simple and lean.
+
 ## Entrance::Config
 
 All available options, along with their defaults.
@@ -83,7 +85,7 @@ All available options, along with their defaults.
 ``` rb
 Entrance.configure do |config|
   config.model                      = 'User'
-  config.cipher                     = Ciphers::BCrypt
+  config.cipher                     = Entrance::Ciphers::BCrypt # can also be Entrance::Ciphers::SHA1
   config.secret                     = nil
   config.stretches                  = 10
   config.salt_attr                  = nil
@@ -129,6 +131,11 @@ Provides:
  - #remember_me! and #forget_me!
  - #password and #password=(value)
  - #request_password_reset!
+
+Examples
+========
+
+Thought you might ask. There's a full example Rails app in the examples folder. Check it out. 
  
 Author
 ======
@@ -138,5 +145,4 @@ Written by Tomás Pollak.
 Copyright
 =========
 
-(c) Fork, Ltd. MIT Licensed. 
- 
+(c) Fork, Ltd. MIT Licensed.

data/entrance.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project         = "entrance"
   
   s.add_runtime_dependency "bcrypt", "~> 3.0"
-  s.add_runtime_dependency "activesupport", "> 3.0"
+  s.add_runtime_dependency "activesupport", ">= 3.0"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/examples/rails-app/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ./../../
   specs:
-    entrance (0.1.1)
-      activesupport (> 3.0)
+    entrance (0.2.0)
+      activesupport (>= 3.0)
       bcrypt (~> 3.0)
 
 GEM

data/examples/rails-app/README.rdoc

@@ -1,28 +1,9 @@
-== README
+== Example Rails App with Entrance
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+    git clone https://github.com/tomas/entrance
+    cd entrance/examples/rails-app
+    bundle install
+    bin/rake db:migrate
+    bin/rails s
 
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.
+And ready-o. Then point your browser to localhost:3000 and sign up, then sign in using your credentials.

data/examples/rails-app/app/controllers/sessions_controller.rb

@@ -7,8 +7,8 @@ class SessionsController < ApplicationController
   end
 
   def create
-    remember = ['on', 'true'].include?(params[:remember_me])
-    puts "Should remember: #{remember}"
+    # boolean flag that determines whether we'll log the user automatically if the browser is closed
+    remember = ['on', 'true', '1'].include?(params[:remember_me])
     if user = authenticate_and_login(params[:email], params[:password], remember)
       redirect_to :root
     else
@@ -22,4 +22,4 @@ class SessionsController < ApplicationController
     redirect_to :login, :notice => 'Logged out! See you soon.'
   end
 
-end
+end

data/examples/rails-app/config/initializers/entrance.rb

@@ -1,9 +1,5 @@
-puts 'Initializing Entrance...'
-
 Entrance.configure do |config|
   config.remember_for              = 1.month
-  config.cipher                    = Entrance::Ciphers::SHA1
-  config.secret                    = 'somethingveryveryveryveryverysecret'
   config.access_denied_redirect_to = '/login'
   config.cookie_secure             = Rails.env.production?
 end

data/lib/entrance/controller.rb

@@ -77,7 +77,9 @@ module Entrance
     end
 
     def login_from_session
-      self.current_user = Entrance.model.where(session[:user_id]).first if session[:user_id]
+      query = {}
+      query[Entrance.config.unique_key] = session[:user_id]
+      self.current_user = Entrance.model.where(query).first if session[:user_id]
     end
 
     def login_from_cookie
@@ -108,7 +110,7 @@ module Entrance
 
     def set_remember_cookie
       values = {
-        :expires  => Entrance.config.remember_for.from_now,
+        :expires  => Entrance.config.remember_for.to_i.from_now,
         :httponly => Entrance.config.cookie_httponly,
         :path     => Entrance.config.cookie_path,
         :secure   => Entrance.config.cookie_secure,

data/lib/entrance/model.rb

@@ -30,12 +30,21 @@ module Entrance
 
       %w(remember reset).each do |what|
         if field = Entrance.config.send("#{what}_token_attr")
+          until_field = Entrance.config.send("#{what}_until_attr")
 
           unless fields.include?(field.to_sym)
             raise "No #{Entrance.config.send("#{what}_token_attr")} field found. \
                    Set the config.#{what}_token_attr option to nil to disable the #{what} option."
           end
 
+          if until_field
+            unless fields.include?(until_field.to_sym)
+              raise "Couldn't find a #{Entrance.config.send("#{what}_until_attr")} field. Cannot continue."
+            end
+          else
+            puts "Disabling expiration timestamp for the #{what} option. This is a VERY bad idea."
+          end
+
           Entrance.config.can?(what, true)
           include what.to_sym == :remember ? RememberMethods : ResetMethods
         end
@@ -94,17 +103,17 @@ module Entrance
 
       def remember_me!(until_date = nil)
         update_attribute(Entrance.config.remember_token_attr, Entrance.generate_token)
-        update_remember_token_expiration!(until_date)
+        update_remember_token_expiration!(until_date) if Entrance.config.remember_until_attr
       end
 
       def update_remember_token_expiration!(until_date = nil)
-        timestamp = until_date || Entrance.config.remember_for
-        update_attribute(Entrance.config.remember_until_attr, timestamp.from_now)
+        seconds = (until_date || Entrance.config.remember_for).to_i
+        update_attribute(Entrance.config.remember_until_attr, seconds.from_now)
       end
 
       def forget_me!
         update_attribute(Entrance.config.remember_token_attr, nil)
-        update_attribute(Entrance.config.remember_until_attr, nil)
+        update_attribute(Entrance.config.remember_until_attr, nil) if Entrance.config.remember_until_attr
       end
 
     end

data/lib/entrance/version.rb

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

data/lib/entrance.rb

@@ -21,7 +21,9 @@ module Entrance
   end
 
   def self.generate_token(length = 40)
-    SecureRandom.hex(length/2).encode('UTF-8')
+    str = SecureRandom.hex(length/2)
+    return str unless str.respond_to?(:encode)
+    str.encode('UTF-8')
   end
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - "Tom\xC3\xA1s Pollak"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-01-07 00:00:00 -03:00
+date: 2015-01-08 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 3