shield 0.0.4 → 0.1.0.rc1

data/lib/shield.rb

@@ -1,7 +1,5 @@
 module Shield
-  VERSION = "0.0.3"
-
-  autoload :Password,  "shield/password"
-  autoload :Helpers,   "shield/helpers"
-  autoload :Model,     "shield/model"
+  autoload :Password, "shield/password"
+  autoload :Helpers,  "shield/helpers"
+  autoload :Model,    "shield/model"
 end

data/lib/shield/helpers.rb

@@ -1,11 +1,31 @@
 module Shield
   module Helpers
-    def ensure_authenticated(model)
+    class NoSessionError < StandardError; end
+
+    def session
+      env["rack.session"] || raise(NoSessionError)
+    end
+
+    def redirect(path, status = 302)
+      if defined?(super)
+        # If the application context has defined a proper redirect
+        # we can simply use that definition.
+        super
+      else
+        # We implement the Cuba redirect here, being Cuba users we
+        # are biased towards it of course.
+        halt [status, { "Location" => path, "Content-Type" => "text/html" }, []]
+      end
+    end
+
+    def ensure_authenticated(model, login_url = "/login")
       if authenticated(model)
         return true
       else
-        session[:return_to] = request.fullpath
-        redirect_to_login
+        # If you've ever used request.path, it just so happens
+        # to be SCRIPT_NAME + PATH_INFO.
+        session[:return_to] = env["SCRIPT_NAME"] + env["PATH_INFO"]
+        redirect login_url
         return false
       end
     end
@@ -15,20 +35,18 @@ module Shield
       @_authenticated[model] ||= session[model.to_s] && model[session[model.to_s]]
     end
 
-    def redirect_to_login
-      redirect "/login"
-    end
-
-    def redirect_to_stored(default = "/")
-      redirect(session.delete(:return_to) || default)
+    def persist_session!
+      if session[:remember_for]
+        env["rack.session.options"][:expire_after] = session[:remember_for]
+      end
     end
 
-    def login(model, username, password)
+    def login(model, username, password, remember = false, expire = 1209600)
       instance = model.authenticate(username, password)
 
       if instance
+        session[:remember_for] = expire if remember
         session[model.to_s] = instance.id
-        return true
       else
         return false
       end
@@ -37,6 +55,7 @@ module Shield
     def logout(model)
       session.delete(model.to_s)
       session.delete(:return_to)
+      session.delete(:remember_for)
 
       @_authenticated.delete(model) if defined?(@_authenticated)
     end

data/test/cuba.rb

@@ -0,0 +1,110 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+class User < Struct.new(:id)
+  extend Shield::Model
+
+  def self.[](id)
+    User.new(1) unless id.to_s.empty?
+  end
+
+  def self.authenticate(username, password)
+    User.new(1001) if username == "quentin" && password == "password"
+  end
+end
+
+Cuba.use Rack::Session::Cookie
+
+Cuba.send :include, Shield::Helpers
+
+Cuba.define do
+  on get, "public" do
+    res.write "Public"
+  end
+
+  on get, "private" do
+    ensure_authenticated(User)
+
+    res.write "Private"
+  end
+
+  on get, "login" do
+    res.write "Login"
+  end
+
+  on post, "login", param("login"), param("password") do |u, p|
+    if login(User, u, p, req[:remember_me])
+      res.redirect(session[:return_to] || "/")
+    else
+      res.redirect "/login"
+    end
+  end
+
+  on "logout" do
+    logout(User)
+    res.redirect "/"
+  end
+end
+
+scope do
+  def app
+    Cuba
+  end
+
+  def assert_redirected_to(path)
+    unless last_response.status == 302
+      flunk
+    end
+    assert_equal path, URI(last_response.headers["Location"]).path
+  end
+
+  def session
+    last_request.env["rack.session"]
+  end
+
+  setup do
+    clear_cookies
+  end
+
+  test "public" do
+    get "/public"
+    assert "Public" == last_response.body
+  end
+
+  test "successful logging in" do
+    get "/private"
+
+    assert_redirected_to "/login"
+    assert "/private" == session[:return_to]
+
+    post "/login", :login => "quentin", :password => "password"
+    assert_redirected_to "/private"
+
+    assert 1001 == session["User"]
+  end
+
+  test "failed login" do
+    post "/login", :login => "q", :password => "p"
+    assert_redirected_to "/login"
+
+    assert nil == session["User"]
+  end
+
+  test "logging out" do
+    post "/login", :login => "quentin", :password => "password"
+
+    get "/logout"
+
+    assert nil == session["User"]
+    assert nil == session[:return_to]
+  end
+
+  test "remember functionality" do
+    post "/login", :login => "quentin", :password => "password", :remember_me => "1"
+
+    assert_equal session[:remember_for], 86400 * 14
+
+    get "/logout"
+
+    assert_equal nil, session[:remember_for]
+  end
+end

data/test/helper.rb

@@ -3,17 +3,8 @@ $:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
 require "shield"
 require "cutest"
 require "rack/test"
-require "sinatra/base"
+require "cuba"
 
 class Cutest::Scope
   include Rack::Test::Methods
-
-  def assert_redirected_to(path)
-    assert_equal 302,  last_response.status
-    assert_equal path, URI(last_response.headers["Location"]).path
-  end
-
-  def session
-    last_request.env["rack.session"]
-  end
 end

data/test/{shield_test.rb → shield.rb}

@@ -17,6 +17,10 @@ class Context
     @path = path
   end
 
+  def env
+    { "SCRIPT_NAME" => "", "PATH_INFO" => @path }
+  end
+
   def session
     @session ||= {}
   end
@@ -24,7 +28,7 @@ class Context
   class Request < Struct.new(:fullpath)
   end
 
-  def request
+  def req
     Request.new(@path)
   end
 
@@ -73,22 +77,6 @@ test "caches authenticated in @_authenticated" do |context|
   assert User.new(1) == context.instance_variable_get(:@_authenticated)[User]
 end
 
-test "redirect to stored when :return_to is set" do |context|
-  context.session[:return_to] = "/private"
-  context.redirect_to_stored
-
-  assert "/private" == context.redirect
-  assert nil == context.session[:return_to]
-end
-
-test "redirect to stored when no return to" do |context|
-  context.redirect_to_stored
-  assert "/" == context.redirect
-
-  context.redirect_to_stored("/custom")
-  assert "/custom" == context.redirect
-end
-
 test "login success" do |context|
   assert context.login(User, "quentin", "password")
   assert 1001 == context.session["User"]

data/test/{sinatra_test.rb → sinatra.rb}

@@ -1,4 +1,5 @@
 require File.expand_path("helper", File.dirname(__FILE__))
+require "sinatra/base"
 
 class User < Struct.new(:id)
   extend Shield::Model
@@ -31,10 +32,10 @@ class SinatraApp < Sinatra::Base
   end
 
   post "/login" do
-    if login(User, params[:login], params[:password])
-      redirect_to_stored
+    if login(User, params[:login], params[:password], params[:remember_me])
+      redirect(session[:return_to] || "/")
     else
-      redirect_to_login
+      redirect "/login"
     end
   end
 
@@ -49,6 +50,23 @@ scope do
     SinatraApp.new
   end
 
+  def assert_redirected_to(path)
+    unless last_response.status == 302
+      flunk
+    end
+    assert_equal path, URI(last_response.headers["Location"]).path
+  end
+
+  def session
+    last_request.env["rack.session"]
+  end
+
+  def debug
+    require "open3"
+    out, _, _ = Open3.capture3("elinks -dump", stdin_data: last_response.body)
+    puts out
+  end
+
   setup do
     clear_cookies
   end
@@ -60,8 +78,9 @@ scope do
 
   test "successful logging in" do
     get "/private"
+
     assert_redirected_to "/login"
-    assert "/private" == session[:return_to]
+    assert_equal "/private", session[:return_to]
 
     post "/login", :login => "quentin", :password => "password"
     assert_redirected_to "/private"
@@ -84,4 +103,14 @@ scope do
     assert nil == session["User"]
     assert nil == session[:return_to]
   end
+
+  test "remember functionality" do
+    post "/login", :login => "quentin", :password => "password", :remember_me => "1"
+
+    assert_equal session[:remember_for], 86400 * 14
+
+    get "/logout"
+
+    assert_equal nil, session[:remember_for]
+  end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: shield
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.1.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Michel Martens
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2156259380 !ruby/object:Gem::Requirement
+  requirement: &2156273880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156259380
+  version_requirements: *2156273880
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: &2156272920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156272920
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2156274580 !ruby/object:Gem::Requirement
+  requirement: &2156271720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156274580
+  version_requirements: *2156271720
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2156273800 !ruby/object:Gem::Requirement
+  requirement: &2156270860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,7 +56,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156273800
+  version_requirements: *2156270860
 description: ! "\n    Provides all the protocol you need in order to do authentication
   on\n    your rack application. The implementation specifics can be found in\n    http://github.com/cyx/shield-contrib\n
   \ "
@@ -59,15 +70,16 @@ extra_rdoc_files: []
 files:
 - lib/shield/helpers.rb
 - lib/shield/model.rb
-- lib/shield/password.rb
-- lib/shield/password/simple.rb
 - lib/shield/password/pbkdf2.rb
+- lib/shield/password/simple.rb
+- lib/shield/password.rb
 - lib/shield.rb
+- test/cuba.rb
 - test/helper.rb
-- test/model_test.rb
-- test/password_hash_test.rb
-- test/shield_test.rb
-- test/sinatra_test.rb
+- test/model.rb
+- test/password.rb
+- test/shield.rb
+- test/sinatra.rb
 homepage: http://github.com/cyx/shield
 licenses: []
 post_install_message: 
@@ -83,9 +95,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: shield
 rubygems_version: 1.8.11