rails_warden 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Neighman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,34 @@
+h1. Rails Warden
+
+Provides authentication for Rails applications via the "Warden":http://github.com/hassox/warden Rack authentication framework.
+
+Require the gem:
+
+config/environment.rb
+
+<pre><code>
+  config.gem "rails_warden"
+</code></pre>
+
+Setup an initializer:
+
+config/initializers/warden.rb
+
+<pre><code>
+  Rails.configuration.middleware.use RailsWarden::Manager do |manager|
+    manager.default_strategies :my_strategy
+    manager.failure_app = LoginController
+  end
+
+  # Setup Session Serialization
+  Warden::Manager.serialize_into_session{ |user|      [user.class, user.id] }
+  Warden::Manager.serialize_from_session{ |klass, id| klass.find(id)        }
+
+  # Declare your strategies here
+  #Warden::Strategies.add(:my_strategy) do
+  #  def authenticate!
+  #    # do stuff
+  #  end
+  #end
+  
+</code></pre>

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = "rails_warden"
+GEM_VERSION = "0.1.1"
+AUTHOR = "Daniel Neighman"
+EMAIL = "has.sox@gmail.com"
+HOMEPAGE = "http://github.com/hassox/rails_warden"
+SUMMARY = "A gem that provides authenitcation via the Warden framework"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.textile", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  s.add_dependency "warden"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.textile Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1 @@
+TODO:

data/lib/rails_warden.rb

@@ -0,0 +1,37 @@
+here = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'warden'
+require 'active_support'
+require "#{here}/rails_warden/manager"
+require "#{here}/rails_warden/rails_settings"
+require "#{here}/rails_warden/controller_mixin"
+
+Warden::Manager.before_failure do |env, opts|
+  request = env["action_controller.rescue.request"]
+  request.params["action"] = RailsWarden.unauthenticated_action || "unauthenticated"
+end
+
+if defined?(Rails)
+  Rails.configuration.after_initialize do
+    ActionController::Base.class_eval{ include RailsWarden::ControllerMixin }
+  end
+end
+
+# Session Serialization in.  This block determines how the user will 
+# be stored in the session.  If you're using a complex object like an 
+# ActiveRecord model, it is not a good idea to store the complete object.
+# An ID is sufficient
+Warden::Manager.serialize_into_session{ |user| [user.class, user.id] } 
+
+# Session Serialization out.  This block gets the user out of the session.
+# It should be the reverse of serializing the object into the session
+Warden::Manager.serialize_from_session do |klass, id| 
+  klass = case klass
+  when Class
+    klass
+  when String, Symbol
+    klass.to_s.classify.constantize
+  end
+  klass.find(id)
+end

data/lib/rails_warden/controller_mixin.rb

@@ -0,0 +1,48 @@
+module RailsWarden
+  module ControllerMixin
+    
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+    end
+    
+    module InstanceMethods
+      # The main accessor for the warden proxy instance
+      # :api: public
+      def warden
+        request.env['warden']
+      end
+      
+      # Proxy to the authenticate method on warden
+      # :api: public
+      def authenticate(*args)
+        warden.authenticate(*args)
+      end
+      
+      # Proxy to the authenticate method on warden
+      # :api: public
+      def authenticate!(*args)
+        warden.authenticate!(*args)
+      end
+      
+      # Proxy to the authenticated? method on warden
+      # :api: public
+      def authenticated?(*args)
+        warden.authenticated?(*args)
+      end
+      alias_method :logged_in?, :authenticated?
+      
+      # Access the currently logged in user
+      # :api: public
+      def user(*args)
+        warden.user(*args)
+      end
+      alias_method :current_user, :user
+      
+      # Logout the current user
+      # :api: public
+      def logout(*args)
+        warden.logout(*args)
+      end
+    end
+  end
+end

data/lib/rails_warden/manager.rb

@@ -0,0 +1,30 @@
+module RailsWarden
+  class Manager
+    
+    def self.new(app, opts = {}, &block)
+      # Get the failure application
+      opts[:failure_app] = opts[:failure_app].to_s.classify.constantize if opts[:failure_app]
+      opts[:defaults] = [opts[:defaults]].flatten if opts[:defaults]
+      
+      # Set the default user
+      if user = opts.delete(:default_user)
+        RailsWarden.default_user_class = user.to_s.classify.constantize
+      end
+      
+      # Set the unauthenticated action if it's set
+      if ua = opts.delete(:unauthenticated_action)
+        RailsWarden.unauthenticated_action = ua
+      end
+      
+      # Rails needs the action to be passed in with the params
+      Warden::Manager.before_failure do |env, opts|
+        if request = env["action_controller.rescue.request"]
+          request.params["action"] = RailsWarden.unauthenticated_action
+        end
+      end
+      
+      Warden::Manager.new(app, opts, &block)
+    end
+    
+  end
+end

data/lib/rails_warden/rails_settings.rb

@@ -0,0 +1,51 @@
+module RailsWarden
+  
+  # Set the default user class for the application
+  # :api: public
+  def self.default_user_class=(klass)
+    @default_user_class = klass
+  end
+  
+  # Accessor for the default user class for the application 
+  # :api: public
+  def self.default_user_class
+    @default_user_class ||= User
+  end
+  
+  # Get the action called when there is an unauthenticated failure
+  # This is usually an action on a controller
+  # The action is called on the failure application.  This would normally be 
+  # A rails controller
+  #
+  # Example
+  #  RailsWarden::Manager.new(@app,  :failure_app  => "login_controller",
+  #                                   :defaults     => :password,
+  #                                   :unauthenticated_action => :bad_login
+  #                           )
+  # 
+  # The unauthenticated_action is :bad_login
+  # The bad_login action will be called on the LoginController
+  # :api: public
+  def self.unauthenticated_action=(action)
+    action = action.to_s if action
+    @unauthenticated_action = action
+  end
+  
+  # Get the action called when there is an unauthenticated failure
+  # This is usually an action on a controller
+  # The action is called on the failure application.  This would normally be 
+  # A rails controller
+  #
+  # Example
+  #  RailsWarden::Manager.new(@app,  :failure_app  => "login_controller",
+  #                                   :defaults     => :password,
+  #                                   :unauthenticated_action => :bad_login
+  #                           )
+  # 
+  # The unauthenticated_action is :bad_login
+  # The bad_login action will be called on the LoginController
+  # :api: public
+  def self.unauthenticated_action
+    @unauthenticated_action ||= "unauthenticated"
+  end
+end

data/spec/controller_mixin_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe "rails_warden controller mixin" do
+  
+  before(:each) do
+    @app = lambda{|e| [200, {"Content-Type" => "text/plain"}, ["resonse"]]}
+    class FooFailure
+    end
+    
+    class User
+    end
+    
+    class MockController 
+      include RailsWarden::ControllerMixin
+      attr_accessor :env
+      def request
+        self
+      end
+    end
+    
+    RailsWarden.default_user_class = nil
+    RailsWarden.unauthenticated_action = nil
+    
+    @controller = MockController.new
+    @mock_warden = OpenStruct.new
+    @controller.env = {"warden" => @mock_warden }
+  end
+  
+  it "should setup the spec" do
+    @controller.warden.should_not be_nil
+  end
+  
+  it "should provide access to the warden instance" do
+    @controller.warden.should == @controller.env["warden"]
+  end
+  
+  it "should run authenticate on warden" do
+    @mock_warden.should_receive(:authenticate).and_return(true)
+    @controller.authenticate
+  end
+  
+  it "should run authenticate! on warden" do
+    @mock_warden.should_receive(:authenticate!).and_return(true)
+    @controller.authenticate!
+  end
+  
+  it "should run authenticate? on warden" do
+    @mock_warden.should_receive(:authenticated?).and_return(true)
+    @controller.authenticated?
+  end
+  
+  it "should proxy logged_in? to authenticated" do
+    @mock_warden.should_receive(:authenticated?).and_return(true)
+    @controller.logged_in?
+  end
+  
+  it "should run user on warden" do
+    @mock_warden.should_receive(:user).and_return(true)
+    @controller.user
+  end
+  
+  it "should run current_user on warden" do
+    @mock_warden.should_receive(:user).and_return(true)
+    @controller.current_user
+  end
+  
+  it "should proxy logout to warden" do
+    @mock_warden.should_receive(:logout).and_return(true)
+    @controller.logout
+  end
+end

data/spec/rails_warden_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "rails_warden" do
+  
+  before(:each) do
+    @app = lambda{|e| [200, {"Content-Type" => "text/plain"}, ["resonse"]]}
+    class FooFailure
+    end
+    
+    class FooUser
+    end
+    
+    class User
+    end
+    
+    RailsWarden.default_user_class = nil
+    RailsWarden.unauthenticated_action = nil
+  end
+  
+  it "RailsWarden::Manager.new should return an instance of Warden::Manager" do
+    r = RailsWarden::Manager.new(@app, :failure_app => "foo_failure", :defaults => :password)
+    r.should be_an_instance_of(Warden::Manager)
+  end
+  
+  it "should set the failure application to FooFailure" do
+    r = RailsWarden::Manager.new(@app, :failure_app => "foo_failure", :defaults => :password)
+    r.failure_app.should == FooFailure
+  end
+  
+  it "should set the default user to FooUser if specified" do
+    r = RailsWarden::Manager.new(@app,  :failure_app  => "foo_failure", 
+                                        :defaults     => :password, 
+                                        :default_user => "foo_user")
+    RailsWarden.default_user_class.should == FooUser
+  end
+  
+  it "should set the default user to User if there is none specified" do
+    r = RailsWarden::Manager.new(@app,  :failure_app  => "foo_failure", 
+                                        :defaults     => :password)
+    RailsWarden.default_user_class.should == User
+  end
+  
+  it "should set the failure action when specified" do
+    r = RailsWarden::Manager.new(@app,  :failure_app  => "foo_failure",
+                                        :defaults     => :password,
+                                        :unauthenticated_action => :bad_login
+                                        )
+    RailsWarden.unauthenticated_action.should == "bad_login"
+  end
+  
+  it "should set the failure action to unauthenticated when not specified" do
+    r = RailsWarden::Manager.new(@app,  :failure_app  => "foo_failure",
+                                        :defaults     => :password
+                                        )
+    RailsWarden.unauthenticated_action.should == "unauthenticated"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rails_warden'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: rails_warden
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Daniel Neighman
+autorequire: rails_warden
+bindir: bin
+cert_chain: []
+
+date: 2009-06-10 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: warden
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A gem that provides authenitcation via the Warden framework
+email: has.sox@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- TODO
+- lib/rails_warden/controller_mixin.rb
+- lib/rails_warden/manager.rb
+- lib/rails_warden/rails_settings.rb
+- lib/rails_warden.rb
+- spec/controller_mixin_spec.rb
+- spec/rails_warden_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hassox/rails_warden
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: A gem that provides authenitcation via the Warden framework
+test_files: []
+