warden_oauth 0.0.0 → 0.1.0

data/CHANGELOG

@@ -1,3 +1,15 @@
+* 0.1.0 (Jan 9, 2010) Lets stay up to date with josevalim's work
+* Renaming the warden_oauth/manager.rb to warden_oauth/config_extension.rb,
+given that the Warden::Manager is not the given instance on the
+Warden::Manager block anymore
+* Creating a new way to assign access_token_user_finders to the strategies,
+using the sole strategy had a drawback, the class was lazily created after the
+first request to the Rack middleware.
+* Added an example of a twitter client (given that's the more popular client
+being used)
+* Update of the README
+
+
 * 0.0.2 (Oct 1, 2009) Keep the manager out of the business of strategies
 * Removing the access_token_user_finder from Warden::Manager and adding it to
 the Warden::StrategyBuilder module

data/README.rdoc

@@ -8,42 +8,42 @@ oauth strategies.
 To get started you just have to require the warden_oauth libraries, and setup the 
 oauth services you would like to have on the <tt>Warden::Manager</tt> middleware declaration:
 
-  Warden::Manager do |manager|
-    manager.failure_app = FailureApp
-    manager.oauth(:twitter) do |twitter|
+  Warden::Manager do |config|
+    config.failure_app = FailureApp
+    config.oauth(:twitter) do |twitter|
       twitter.consumer_secret = <YOUR CONSUMER SECRET>
       twitter.consumer_key  = <YOUR CONSUMER KEY>
       twitter.options :site => 'http://twitter.com'
     end
-    manager.default_strategies(:twitter_oauth, :password, :other)
+    config.default_strategies(:twitter_oauth, :password, :other)
   end
 
 == Giving an Access Token fetcher
 
 Users get identified on a system via an access_token and an access_secret, when a valid access_token is 
-recevied, warden_oauth calls a fetcher declared on <tt>Warden::Manager.access_token_user_finder</tt>. 
+recevied, warden_oauth calls a fetcher declared on <tt>Warden::OAuth.access_token_user_finder(:<strategy_key>)</tt>. 
 
-  Warden::Manager.access_token_user_finder(:twitter) do |access_token|
+  Warden::OAuth.access_token_user_finder(:twitter) do |access_token|
     User.find_by_access_token_and_access_secret(access_token.token, access_token.secret)
   end
 
 If a user is returned, then this is the user that is going to be authenticated in the session, otherwise the 
 <tt>FailureApp</tt> will be called, you may check the <tt>env['warden.options'][:oauth][:access_token]</tt> to check
-the original access_token and <em>create a new user</em> from there if desired. 
+the original access_token and <bold>create a new user</bold> from there if desired. 
 
 == Strategy Class info
 
-When you declare an oauth strategy on the <tt>Warden::Manager</tt> initialization, (e.g. manager.oauth(:service_name))
+When you declare an oauth strategy on the <tt>Warden::Config</tt> initialization, (e.g. config.oauth(:service_name))
 a <tt>Warden::OAuth::Strategy::ServiceName</tt> will be declared, at the same time this class will be registered as
 <tt>:service_name_oauth</tt> on the <tt>Warden::Strategies</tt>.
 
-So if we have a declaration like the one of the Getting Started section, we will have an Strategy class 
-called <tt>Warden::OAuth::Strategy::Twitter</tt>, and this will be registered as <tt>:twitter_oauth</tt>.
+So when we have a declaration like the one we have in the Getting Started section, we will have an Strategy class 
+called <tt>Warden::OAuth::Strategy::Twitter</tt>, and this will be registered as <tt>:twitter_oauth</tt> on the Warden::Strategies.
 
 == Running the Strategy
 
 In order to get the strategy running in the app, you have to specify a parameter called warden_oauth_provider
-with the name of the oauth service you want to start. So for example, if you would like to boot the twitter
+with the name of the oauth service you want to use. So for example, if you would like to boot the twitter
 oauth example given on the "Getting Started" section you just have to specify the parameter on a protected
 url.
 
@@ -51,6 +51,21 @@ In Rails:
   
   link_to 'Twitter Authentication', url_for(login_path(:warden_oauth_provider => 'twitter'))
 
+There can be 3 different outcomes from this strategy:
+
+1. The OAuth credentials are invalid and the FailureApp is called.
+2. The OAuth credentials are valid, but there is no user associated to them. In this case the FailureApp is called, but the env['warden.options'][:oauth][:access_token] will be = Note on Patches/Pull Requests available.
+3. The OAuth credentials are valid, and the user is authenticated successfuly. 
+
+Note:
+
+In Rails, don't set the <tt>:warden_oauth_provider</tt> parameter as part of the login route, if you do this, rails will catch the parameter, but not the
+warden rack middleware, ergo, it won't work as expected.
+
+== Examples
+
+If you want to know how to make a twitter authentication client, check examples/twitter/application.rb
+
 == Note on Patches/Pull Requests
 
 For any error send an email to: romanandreg [at] gmail [dot] com

data/Rakefile

@@ -14,7 +14,7 @@ begin
     gem.homepage = "http://github.com/roman/warden_oauth"
     gem.authors = ["Roman Gonzalez"]
     gem.rubyforge_project = "warden_oauth"
-    gem.add_dependency('warden')
+    gem.add_dependency('warden', ">= 0.8.1")
     gem.add_dependency('oauth')
     gem.add_development_dependency("rack-test")
     gem.add_development_dependency("fakeweb")
@@ -29,8 +29,10 @@ end
 
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
+  root = File.dirname(__FILE__)
   spec.libs << 'lib' << 'spec'
   spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', "#{root}/spec/spec.opts"]
 end
 
 Spec::Rake::SpecTask.new(:rcov) do |spec|

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/examples/twitter/application.rb

@@ -0,0 +1,62 @@
+require "rubygems"
+$:.unshift << File.dirname(__FILE__) + "/../../lib"
+require "warden"
+require "warden_oauth"
+
+
+# You need to specify the following URL in the browser to run the twitter authentication
+# http://localhost:4567/?warden_oauth_provider=twitter
+
+
+class ClientApp
+
+  def self.call(env)
+    env['warden'].authenticate!
+    [200, {"Content-Type" => 'text/plain'}, "Welcome"]
+  end
+
+end
+
+class ErrorApp
+  
+  def self.call(env)
+    if env['warden.options'][:oauth].nil?
+      [401, {'Content-Type' => 'text/plain'}, "You are not authenticated"]
+    else
+      access_token = env['warden.options'][:oauth][:access_token]
+      [401, {'Content-Type' => 'text/plain'}, "No user with the given access token"]
+    end
+  end
+
+end
+
+class User
+  attr_accessor :token
+  attr_accessor :secret
+  def initialize(token, secret)
+    @token = token
+    @secret = secret
+  end
+end
+
+Warden::OAuth.access_token_user_finder(:twitter) do |access_token|
+  # NOTE: Normally here you use AR/DM to fetch up the user given an access_token and an access_secret
+  User.new(access_token.token, access_token.secret)
+end
+
+app = Rack::Builder.new do
+  use Rack::Session::Cookie
+  use Warden::Manager do |config|
+    config.oauth(:twitter) do |twitter|
+      # If you want this example to work, you need to specify both consumer_key and consumer_secret
+      twitter.consumer_key ""
+      twitter.consumer_secret ""
+      twitter.options :site => 'http://twitter.com'
+    end
+    config.default_strategies :twitter_oauth
+    config.failure_app = ErrorApp
+  end
+  run ClientApp
+end
+
+Rack::Handler::Mongrel.run app, :Port => '4567'

data/lib/warden_oauth.rb

@@ -7,12 +7,13 @@ module Warden
 
     base_path = File.dirname(__FILE__) + "/warden_oauth"
     
+    require base_path + "/base"
     require base_path + "/errors"
     autoload :Utils,           base_path + '/utils'
     autoload :StrategyBuilder, base_path + '/strategy_builder'
     autoload :Strategy,        base_path + '/strategy'
     autoload :Config,          base_path + "/config"
-    require base_path + "/manager"
+    require base_path + "/config_extension"
     
 
   end

data/lib/warden_oauth/base.rb

@@ -0,0 +1,13 @@
+module Warden
+  module OAuth
+
+    def self.access_token_user_finder(key, &block)
+      Strategy.access_token_user_finders[key] = block
+    end
+
+    def self.clear_access_token_user_finders
+      Strategy.access_token_user_finders.clear
+    end
+
+  end
+end

data/lib/warden_oauth/{manager.rb → config_extension.rb}

@@ -2,10 +2,10 @@ module Warden
   module OAuth
 
     #
-    # Holds all the extensions made to Warden::Manager in order to create OAuth
+    # Holds all the extensions made to Warden::Config in order to create OAuth
     # consumers.
     #
-    module Manager
+    module ConfigExtension
 
       #
       # Helps to setup a new OAuth client authentication, to get started you need to define
@@ -14,11 +14,12 @@ module Warden
       # @param [Symbol] service An identifier of the OAuth service
       # 
       # @example
-      #
-      #   Warden::Manager.oauth(:twitter) do
-      #     consumer_key "<YOUR CONSUMER KEY>"
-      #     consumer_secret "<YOUR CONSUMER SECRET>"
-      #     options :site => 'http://twitter.com'
+      #   use Warden::Manager do |config|
+      #     config.oauth(:twitter) do
+      #       consumer_key "<YOUR CONSUMER KEY>"
+      #       consumer_secret "<YOUR CONSUMER SECRET>"
+      #       options :site => 'http://twitter.com'
+      #     end
       #   end
       #
       def oauth(service, &block)
@@ -40,4 +41,5 @@ module Warden
   end
 end
 
-Warden::Manager.send(:include, Warden::OAuth::Manager)
+Warden::Config.send(:include, Warden::OAuth::ConfigExtension)
+

data/lib/warden_oauth/strategy.rb

@@ -12,6 +12,11 @@ module Warden
       ### Strategy Logic ###
       ######################
 
+
+      def self.access_token_user_finders
+        (@_user_token_finders ||= {})
+      end
+
       #
       # An OAuth strategy will be valid to execute if:
       # * A 'warden_oauth_provider' parameter is given, with the name of the OAuth service
@@ -88,7 +93,7 @@ module Warden
         
 You need to define a finder by access_token for this strategy.
 Write on the warden initializer the following code:
-Warden::Strategies[:#{config.provider_name}_oauth].access_token_user_finder do |access_token|
+Warden::OAuth.access_token_user_finder(:#{config.provider_name}) do |access_token|
   # Logic to get your user from an access_token
 end
 

data/lib/warden_oauth/strategy_builder.rb

@@ -31,6 +31,10 @@ module Warden
         strategy_class = self.create_oauth_strategy_class(keyword)
         self.register_oauth_strategy_class(keyword, strategy_class)
         self.set_oauth_service_info(strategy_class, config)
+        # adding the access_token_user_finder to the strategy
+        if self.access_token_user_finders.include?(keyword)
+          strategy_class.access_token_user_finder(&self.access_token_user_finders[keyword])
+        end
       end
 
       #

data/spec/application_runner.rb

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'warden_oauth'
 require File.dirname(__FILE__) + "/application_scenario"
 
-Warden::Manager.access_token_user_finder do |access_token|
+Warden::OAuth.access_token_user_finder(:example) do |access_token|
   nil
 end
 

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse
+

data/spec/warden_oauth/{manager_spec.rb → config_extension_spec.rb}

@@ -1,14 +1,18 @@
 require File.dirname(__FILE__) + "/../spec_helper"
 
-describe Warden::Manager do 
+describe Warden::Config do 
 
   before(:each) do
     failure_app = lambda { |env| "Failure" }
-    @manager = Warden::Manager.new(nil, :failure_app => failure_app)
+    config = nil
+    Warden::Manager.new(nil, :failure_app => failure_app) do |_config|
+      config = _config
+    end
+    @config = config
   end
   
   it "should respond to an `oauth` message" do
-    @manager.should respond_to(:oauth)
+    @config.should respond_to(:oauth)
   end
 
   describe "#oauth" do
@@ -17,7 +21,7 @@ describe Warden::Manager do
 
       it "should require setting the consumer_key" do
         lambda do
-          @manager.oauth(:service) do |service|
+          @config.oauth(:service) do |service|
             service.consumer_secret "ABC"
           end
         end.should raise_error(Warden::OAuth::ConfigError,  "You need to specify the consumer key and the consumer secret")
@@ -25,14 +29,14 @@ describe Warden::Manager do
 
       it "should require setting the consumer_secret" do
         lambda do 
-          @manager.oauth(:service) do |service|
+          @config.oauth(:service) do |service|
             service.consumer_key "ABC"
           end
         end.should raise_error(Warden::OAuth::ConfigError, "You need to specify the consumer key and the consumer secret")
       end
 
       it "should create a new instance of strategy" do
-        @manager.oauth(:service) do |service|
+        @config.oauth(:service) do |service|
           service.consumer_key "ABC"
           service.consumer_secret "123"
         end

data/spec/warden_oauth/strategy_spec.rb

@@ -60,8 +60,8 @@ describe Warden::OAuth::Strategy do
       before(:each) do
         FakeWeb.register_uri(:post, 'http://localhost:3000/oauth/request_token', 
                              :body => fixture_response("unauthorized_request_token"))
-        @response = @request.get("/", :input => 'warden_oauth_provider=example')
-      end
+        @response = @request.get("/", :params => { 'warden_oauth_provider' => 'example' })
+      end 
 
       it "should redirect to the authorize url" do
         @response.headers['Location'].should =~ %r"http://localhost:3000/oauth/authorize"
@@ -76,7 +76,12 @@ describe Warden::OAuth::Strategy do
         $app
       end
 
-      describe "and the access_token_finder hasn't been declared" do
+      before(:each) do
+        Warden::Strategies.clear!
+        Warden::OAuth::Strategy.send(:remove_const, "Example") if Warden::OAuth::Strategy.const_defined?("Example")
+      end
+
+      describe "and the access_token_user_finder hasn't been declared" do
 
         before(:each) do
           FakeWeb.register_uri(:post, 'http://localhost:3000/oauth/request_token', 
@@ -95,10 +100,10 @@ describe Warden::OAuth::Strategy do
 
       end
       
-      describe "and the access_token_finder has been declared" do
+      describe "and the access_token_user_finder has been declared" do
 
         before(:each) do
-          Warden::Strategies[:example_oauth].access_token_user_finder do |access_token|
+          Warden::OAuth.access_token_user_finder(:example) do |access_token|
             Object.new if access_token.token == 'ABC' && access_token.secret == '123' 
           end
           FakeWeb.register_uri(:post, 'http://localhost:3000/oauth/request_token', 
@@ -106,6 +111,10 @@ describe Warden::OAuth::Strategy do
           get "/", 'warden_oauth_provider' => 'example'
         end
 
+        after(:each) do
+          Warden::OAuth.clear_access_token_user_finders
+        end
+
         describe "and the user is not found" do
 
           before(:each) do

data/warden_oauth.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{warden_oauth}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roman Gonzalez"]
-  s.date = %q{2009-11-02}
+  s.date = %q{2010-01-09}
   s.description = %q{ 
       warden_oauth will help you create oauth authentication strategies using the oauth
       helper method on the Warden::Manager config setup
@@ -27,10 +27,12 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "examples/twitter/application.rb",
      "lib/warden_oauth.rb",
+     "lib/warden_oauth/base.rb",
      "lib/warden_oauth/config.rb",
+     "lib/warden_oauth/config_extension.rb",
      "lib/warden_oauth/errors.rb",
-     "lib/warden_oauth/manager.rb",
      "lib/warden_oauth/strategy.rb",
      "lib/warden_oauth/strategy_builder.rb",
      "lib/warden_oauth/utils.rb",
@@ -38,8 +40,9 @@ Gem::Specification.new do |s|
      "spec/application_scenario.rb",
      "spec/fixtures/authorize_request_token.txt",
      "spec/fixtures/unauthorized_request_token.txt",
+     "spec/spec.opts",
      "spec/spec_helper.rb",
-     "spec/warden_oauth/manager_spec.rb",
+     "spec/warden_oauth/config_extension_spec.rb",
      "spec/warden_oauth/strategy_spec.rb",
      "warden_oauth.gemspec"
   ]
@@ -53,8 +56,9 @@ Gem::Specification.new do |s|
     "spec/application_runner.rb",
      "spec/application_scenario.rb",
      "spec/spec_helper.rb",
-     "spec/warden_oauth/manager_spec.rb",
-     "spec/warden_oauth/strategy_spec.rb"
+     "spec/warden_oauth/config_extension_spec.rb",
+     "spec/warden_oauth/strategy_spec.rb",
+     "examples/twitter/application.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -62,14 +66,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<warden>, [">= 0"])
+      s.add_runtime_dependency(%q<warden>, [">= 0.8.1"])
       s.add_runtime_dependency(%q<oauth>, [">= 0"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])
       s.add_development_dependency(%q<fakeweb>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
-      s.add_dependency(%q<warden>, [">= 0"])
+      s.add_dependency(%q<warden>, [">= 0.8.1"])
       s.add_dependency(%q<oauth>, [">= 0"])
       s.add_dependency(%q<rack-test>, [">= 0"])
       s.add_dependency(%q<fakeweb>, [">= 0"])
@@ -77,7 +81,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
-    s.add_dependency(%q<warden>, [">= 0"])
+    s.add_dependency(%q<warden>, [">= 0.8.1"])
     s.add_dependency(%q<oauth>, [">= 0"])
     s.add_dependency(%q<rack-test>, [">= 0"])
     s.add_dependency(%q<fakeweb>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: warden_oauth
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Roman Gonzalez
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-02 00:00:00 -08:00
+date: 2010-01-09 00:00:00 -04:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.8.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: oauth
@@ -89,10 +89,12 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/twitter/application.rb
 - lib/warden_oauth.rb
+- lib/warden_oauth/base.rb
 - lib/warden_oauth/config.rb
+- lib/warden_oauth/config_extension.rb
 - lib/warden_oauth/errors.rb
-- lib/warden_oauth/manager.rb
 - lib/warden_oauth/strategy.rb
 - lib/warden_oauth/strategy_builder.rb
 - lib/warden_oauth/utils.rb
@@ -100,8 +102,9 @@ files:
 - spec/application_scenario.rb
 - spec/fixtures/authorize_request_token.txt
 - spec/fixtures/unauthorized_request_token.txt
+- spec/spec.opts
 - spec/spec_helper.rb
-- spec/warden_oauth/manager_spec.rb
+- spec/warden_oauth/config_extension_spec.rb
 - spec/warden_oauth/strategy_spec.rb
 - warden_oauth.gemspec
 has_rdoc: true
@@ -136,5 +139,6 @@ test_files:
 - spec/application_runner.rb
 - spec/application_scenario.rb
 - spec/spec_helper.rb
-- spec/warden_oauth/manager_spec.rb
+- spec/warden_oauth/config_extension_spec.rb
 - spec/warden_oauth/strategy_spec.rb
+- examples/twitter/application.rb