warden 1.1.1 → 1.2.0

data/History.rdoc

@@ -1,3 +1,7 @@
+== Version 1.2.0 / 2012-05-08
+* Deprecate warden_cookies since it was never functional
+* Add support to serialize_from_session and serialize_into_session per scope
+
 == Version 1.1.1 / 2012-02-16
 * Allow run_callbacks as an option to set_user and user
 

data/README.textile

@@ -1,11 +1,8 @@
 Please see the "Warden Wiki":http://wiki.github.com/hassox/warden for overview documentation.
 
-h2. Contributors
-
-I'm going to try and keep a list of all the contributors to this project.  If I've missed your name please just let me know and I'll update it.
+h2. Maintainers
 
 * Daniel Neighman (hassox)
-* Mick Staugaard (staugaard)
 * José Valim (josevalim)
-* Carlos Antonio da Silva (carlosantoniodasilva)
-* Justin Smestad (jsmestad)
+
+"A list of all contributors is available on Github.":https://github.com/hassox/warden/contributors

data/lib/warden.rb

@@ -33,8 +33,10 @@ module Warden
     unless Warden::Test::WardenHelpers === Warden
       Warden.extend Warden::Test::WardenHelpers
       Warden::Manager.on_request do |proxy|
-        while blk = Warden._on_next_request.shift
-          blk.call(proxy)
+        unless proxy.asset_request?
+          while blk = Warden._on_next_request.shift
+            blk.call(proxy)
+          end
         end
       end
     end

data/lib/warden/manager.rb

@@ -59,23 +59,32 @@ module Warden
       # Generally however complex object should not be stored in the session.
       # If possible store only a "key" of the user object that will allow you to reconstitute it.
       #
+      # You can supply different methods of serialization for different scopes by passing a scope symbol
+      #
       # Example:
       #   Warden::Manager.serialize_into_session{ |user| user.id }
+      #   # With Scope:
+      #   Warden::Manager.serialize_into_session(:admin) { |user| user.id }
       #
       # :api: public
-      def serialize_into_session(&block)
-        Warden::SessionSerializer.send :define_method, :serialize, &block
+      def serialize_into_session(scope = nil, &block)
+        method_name = scope.nil? ? :serialize : "#{scope}_serialize"
+        Warden::SessionSerializer.send :define_method, method_name, &block
       end
 
       # Reconstitues the user from the session.
       # Use the results of user_session_key to reconstitue the user from the session on requests after the initial login
+      # You can supply different methods of de-serialization for different scopes by passing a scope symbol
       #
       # Example:
       #   Warden::Manager.serialize_from_session{ |id| User.get(id) }
+      #   # With Scope:
+      #   Warden::Manager.serialize_from_session(:admin) { |id| AdminUser.get(id) }
       #
       # :api: public
-      def serialize_from_session(&block)
-        Warden::SessionSerializer.send :define_method, :deserialize, &block
+      def serialize_from_session(scope = nil, &block)
+        method_name = scope.nil? ? :deserialize : "#{scope}_deserialize"
+        Warden::SessionSerializer.send :define_method, method_name, &block
       end
     end
 
@@ -85,7 +94,7 @@ module Warden
       config[:intercept_401] && !env['warden'].custom_failure?
     end
 
-    # When a request is unauthentiated, here's where the processing occurs.
+    # When a request is unauthenticated, here's where the processing occurs.
     # It looks at the result of the proxy to see if it's been executed and what action to take.
     # :api: private
     def process_unauthenticated(env, options={})

data/lib/warden/mixins/common.rb

@@ -22,6 +22,7 @@ module Warden
       # when the response is streamed back from the app.
       # :api: public
       def warden_cookies
+        warn "warden_cookies was never functional and is going to be removed in next versions"
         env['warden.cookies'] ||= {}
       end # response
 

data/lib/warden/proxy.rb

@@ -268,12 +268,18 @@ module Warden
       @custom_failure = true
     end
 
-    # Check to see if the custom failur flag has been set
+    # Check to see if the custom failure flag has been set
     # :api: public
     def custom_failure?
       !!@custom_failure
     end
 
+    # Check to see if this is an asset request
+    # :api: public
+    def asset_request?
+      ::Warden::asset_paths.any? { |r| env['PATH_INFO'].to_s.match(r) }
+    end
+
     def inspect(*args)
       "Warden::Proxy:#{object_id} @config=#{@config.inspect}"
     end

data/lib/warden/session_serializer.rb

@@ -22,13 +22,17 @@ module Warden
 
     def store(user, scope)
       return unless user
-      session[key_for(scope)] = serialize(user)
+      method_name = "#{scope}_serialize"
+      specialized = respond_to?(method_name)
+      session[key_for(scope)] = specialized ? send(method_name, user) : serialize(user)
     end
 
     def fetch(scope)
       key = session[key_for(scope)]
       return nil unless key
-      user = deserialize(key)
+
+      method_name = "#{scope}_deserialize"
+      user = respond_to?(method_name) ? send(method_name, key) : deserialize(key)
       delete(scope) unless user
       user
     end
@@ -41,4 +45,4 @@ module Warden
       session.delete(key_for(scope))
     end
   end # SessionSerializer
-end # Warden
+end # Warden

data/lib/warden/test/warden_helpers.rb

@@ -4,6 +4,20 @@ module Warden
 
   module Test
     module WardenHelpers
+      # Returns list of regex objects that match paths expected to be an asset
+      # @see Warden::Proxy#asset_request?
+      # @api public
+      def asset_paths
+        @asset_paths ||= [/^\/assets\//]
+      end
+
+      # Sets list of regex objects that match paths expected to be an asset
+      # @see Warden::Proxy#asset_request?
+      # @api public
+      def asset_paths=(*vals)
+        @asset_paths = vals
+      end
+
       # Adds a block to be executed on the next request when the stack reaches warden.
       # The warden proxy is yielded to the block
       # @api public

data/lib/warden/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Warden
-  VERSION = "1.1.1".freeze
+  VERSION = "1.2.0".freeze
 end

data/spec/warden/proxy_spec.rb

@@ -956,4 +956,29 @@ describe "dynamic default_strategies" do
       session['warden.user.baz.key'].should == "User"
     end
   end
-end
+
+  describe "#asset_request?" do
+    before(:each) do
+      @asset_regex = /^\/assets\//
+      ::Warden.asset_paths = @asset_regex
+    end
+
+    it "should return true if PATH_INFO is in asset list" do
+      env = env_with_params('/assets/fun.gif')
+      setup_rack(success_app).call(env)
+      proxy = env["warden"]
+
+      proxy.env['PATH_INFO'].should match(@asset_regex)
+      proxy.should be_asset_request
+    end
+
+    it "should return false if PATH_INFO is not in asset list" do
+      env = env_with_params('/home')
+      setup_rack(success_app).call(env)
+      proxy = env["warden"]
+
+      proxy.env['PATH_INFO'].should_not match(@asset_regex)
+      proxy.should_not be_asset_request
+    end
+  end
+end

data/spec/warden/scoped_session_serializer.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Warden::Manager do
+  before(:each) do
+    @env = env_with_params
+    @env['rack.session'] ||= {}
+    Warden::Manager.serialize_from_session { |k| k }
+    Warden::Manager.serialize_into_session { |u| u }
+    begin
+      Warden::SessionSerializer.send :remove_method, :admin_serialize
+    rescue
+    end
+    begin
+      Warden::SessionSerializer.send :remove_method, :admin_deserialize
+    rescue
+    end
+  end
+  after(:each) do
+    Warden::Manager.serialize_from_session { |k| k }
+    Warden::Manager.serialize_into_session { |u| u }
+    begin
+      Warden::SessionSerializer.send :remove_method, :admin_deserialize
+      Warden::SessionSerializer.send :remove_method, :admin_serialize
+    rescue
+    end
+  end
+
+  def serializer_respond_to?(name)
+    Warden::SessionSerializer.new(@env).respond_to? name
+  end
+
+  it "should respond to :serialize" do
+    serializer_respond_to?(:serialize).should == true
+  end
+
+  it "should respond to :deserialize" do
+    serializer_respond_to?(:deserialize).should == true
+  end
+
+  it "should respond to {scope}_deserialize if Manager.serialize_from_session is called with scope" do
+    Rack::Builder.new do 
+      Warden::Manager.serialize_from_session ( :admin ) { |n| n }
+    end
+    serializer_respond_to?(:admin_deserialize).should == true
+  end
+
+  it "should respond to {scope}_serialize if Manager.serialize_into_session is called with scope" do
+    Rack::Builder.new do 
+      Warden::Manager.serialize_into_session(:admin) { |n| n }
+    end
+    serializer_respond_to?(:admin_serialize).should == true
+  end
+
+  def initialize_with_scope(scope, &block)
+    Rack::Builder.new do
+      Warden::Manager.serialize_into_session(scope, &block)
+    end
+  end
+
+  it "should execute serialize if no {scope}_serialize is present" do
+    serialized_object = nil
+    initialize_with_scope(nil) do |user|
+      serialized_object = user
+      user
+    end
+    serializer = Warden::SessionSerializer.new(@env)
+    serializer.store("user", :admin)
+    serialized_object.should == "user"
+  end
+
+  it "should not have a {scope}_serialize by default" do
+    serializer_respond_to?(:admin_serialize).should == false
+  end
+
+  it "should execute {scope}_serialize when calling store with a scope" do
+    serialized_object = nil
+    initialize_with_scope(:admin) do |user|
+      serialized_object = user
+      user
+    end
+
+    serializer = Warden::SessionSerializer.new(@env)
+    serializer.store("user", :admin)
+    serialized_object.should == "user"
+  end
+
+
+  it "should execute {scope}_deserialize when calling store with a scope" do
+    serialized_object = nil
+
+    Rack::Builder.new do
+      Warden::Manager.serialize_from_session(:admin) do |key|
+        serialized_object = key
+        key
+      end
+    end
+
+    serializer = Warden::SessionSerializer.new(@env)
+    @env['rack.session'][serializer.key_for(:admin)] = "test"
+    serializer.fetch(:admin)
+
+    serialized_object.should == "test"
+  end
+
+  it "should execute deserialize if {scope}_deserialize is not present" do
+    serialized_object = nil
+
+    Rack::Builder.new do
+      Warden::Manager.serialize_from_session do |key|
+        serialized_object = key
+        key
+      end
+    end
+
+    serializer = Warden::SessionSerializer.new(@env)
+    @env['rack.session'][serializer.key_for(:admin)] = "test"
+    serializer.fetch(:admin)
+
+    serialized_object.should == "test"
+  end
+
+end

data/spec/warden/test/helpers_spec.rb

@@ -87,4 +87,9 @@ describe Warden::Test::Helpers do
     $captures.should == [:run]
   end
 
+  describe "#asset_paths" do
+    it "should default asset_paths to anything asset path regex" do
+      Warden.asset_paths.should == [/^\/assets\//]      
+    end
+  end
 end

data/spec/warden/test/test_mode_spec.rb

@@ -64,4 +64,13 @@ describe Warden::Test::WardenHelpers do
     app.call(env_with_params)
     $captures.should == []
   end
+
+  context "asset requests" do
+    it "should not execute on_next_request blocks if this is an asset request" do
+      app = setup_rack(@app)
+      Warden.on_next_request{|w| $captures << :first }
+      app.call(env_with_params("/assets/fun.gif"))
+      $captures.should == []
+    end
+  end
 end

data/warden.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
     "LICENSE",
      "README.textile"
   ]
-  s.files = Dir["**/*"] - Dir["*.gem"]
+  s.files = Dir["**/*"] - Dir["*.gem"] - ["Gemfile.lock"]
   s.homepage = %q{http://github.com/hassox/warden}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]

metadata

@@ -1,50 +1,36 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: warden
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 1
-  version: 1.1.1
 platform: ruby
-authors: 
+authors:
 - Daniel Neighman
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-27 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156244180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *2156244180
 description: 
 email: has.sox@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.textile
-files: 
+files:
 - Gemfile
-- Gemfile.lock
 - History.rdoc
 - lib/warden/config.rb
 - lib/warden/errors.rb
@@ -76,46 +62,37 @@ files:
 - spec/warden/hooks_spec.rb
 - spec/warden/manager_spec.rb
 - spec/warden/proxy_spec.rb
+- spec/warden/scoped_session_serializer.rb
 - spec/warden/session_serializer_spec.rb
 - spec/warden/strategies/base_spec.rb
 - spec/warden/strategies_spec.rb
 - spec/warden/test/helpers_spec.rb
 - spec/warden/test/test_mode_spec.rb
-- TODO.textile
 - warden.gemspec
-has_rdoc: true
 homepage: http://github.com/hassox/warden
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: warden
-rubygems_version: 1.5.3
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Rack middleware that provides authentication for rack applications
 test_files: []
-
+has_rdoc: 

data/Gemfile.lock

@@ -1,32 +0,0 @@
-PATH
-  remote: .
-  specs:
-    warden (1.1.1)
-      rack (>= 1.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    rack (1.3.0)
-    rack-test (0.6.0)
-      rack (>= 1.0)
-    rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rack (= 1.3)
-  rack-test
-  rake
-  rspec (~> 2)
-  warden!

data/TODO.textile

@@ -1,2 +0,0 @@
-* Allow a spec / test mode where a _spec_authenticate! method is called on a strategy instead if present
-* Implement back urls