rack-oauth 0.1.2 → 0.1.3

data/lib/rack-oauth.rb

@@ -30,6 +30,17 @@ module Rack #:nodoc:
     # Helper methods intended to be included in your Rails controller or 
     # in your Sinatra helpers block
     module Methods
+
+      # This is *the* method you want to call.
+      #
+      # After you're authorized and redirected back to your #redirect_to path, 
+      # you should be able to call get_access_token to get and hold onto 
+      # the access token for the user you've been authorized as.
+      #
+      # You can use the token to make GET/POST/etc requests
+      def get_access_token name = nil
+        oauth(name).get_access_token(oauth_request_env)
+      end
       
       # [Internal] this method returns the Rack 'env' for the current request.
       #
@@ -53,32 +64,6 @@ module Rack #:nodoc:
         oauth
       end
 
-      # Makes a request using the stored access token for the current session.
-      #
-      # Without a user logged in to an OAuth provider in the current session, this won't work.
-      #
-      # This is *not* the method to use to fire off requests for saved access tokens.
-      def oauth_request *args
-        oauth.request oauth_request_env, *args
-      end
-
-      def oauth_request_with_access_token token, *args
-        oauth.request_with_access_token token, *args
-      end
-
-      # Get the access token object for the currently authorized session
-      def oauth_access_token name = nil
-        oauth(name).get_access_token(oauth_request_env)
-      end
-
-      # If Rack::OAuth#get_access_token is nil given the #oauth_request_env available
-      # (inotherwords, it's nil in our user's current session), then we didn't 
-      # log in.  If we have an access token for this particular session, then 
-      # we are logged in.
-      def logged_in? name = nil
-        !! oauth_access_token(name)
-      end
-
       # Returns the path to rediret to for logging in via OAuth
       def oauth_login_path name = nil
         oauth(name).login_path
@@ -117,32 +102,9 @@ module Rack #:nodoc:
       :login_path          => '/oauth_login',
       :callback_path       => '/oauth_callback',
       :redirect_to         => '/oauth_complete',
-      :rack_session        => 'rack.session',
-      :json_parser         => lambda {|json_string| require 'json'; JSON.parse(json_string); },
-      :access_token_getter => lambda {|key, oauth| oauth.get_access_token_via_instance_variable(key) },
-      :access_token_setter => lambda {|key, token, oauth| oauth.set_access_token_via_instance_variable(key, token) }
+      :rack_session        => 'rack.session'
     }
 
-    # A proc that accepts an argument for the KEY we're using to get an access token 
-    # that should return the actual access token object.
-    #
-    # A second parameter is passed to your block with the Rack::OAuth instance
-    #
-    # This allows you to override how access tokens are persisted
-    attr_accessor :access_token_getter
-    alias get  access_token_getter
-    alias get= access_token_getter=
-
-    # A proc that accepts an argument for the KEY we're using to set an access token 
-    # and a second argument with the actual access token object.
-    #
-    # A third parameter is passed to your block with the Rack::OAuth instance
-    #
-    # This allows you to override how access tokens are persisted
-    attr_accessor :access_token_setter
-    alias set  access_token_setter
-    alias set= access_token_setter=
-
     # the URL that should initiate OAuth and redirect to the OAuth provider's login page
     def login_path
       ::File.join *[@login_path.to_s, name_unless_default].compact
@@ -182,9 +144,6 @@ module Rack #:nodoc:
     alias site  consumer_site
     alias site= consumer_site=
 
-    # a Proc that accepts a JSON string and returns a Ruby object.  Defaults to using the 'json' gem, if available.
-    attr_accessor :json_parser
-
     # an arbitrary name for this instance of Rack::OAuth
     def name
       @name.to_s
@@ -204,96 +163,76 @@ module Rack #:nodoc:
     end
 
     def call env
+      # put this instance of Rack::OAuth in the env 
+      # so it's accessible from the application
       env['rack.oauth'] ||= {}
       env['rack.oauth'][name] = self
 
       case env['PATH_INFO']
-      when login_path;      do_login     env
-      when callback_path;   do_callback  env
-      else;                 @app.call    env
+      
+      # find out where to redirect to authorize for this oauth provider 
+      # and redirect there.  when the authorization is finished, 
+      # the provider will redirect back to our application's callback path
+      when login_path
+        do_login(env)
+
+      # the oauth provider has redirected back to us!  we should have a 
+      # verifier now that we can use, in combination with out token and 
+      # secret, to get an access token for this user
+      when callback_path
+        do_callback(env)
+
+      else
+        @app.call(env)
       end
     end
 
     def do_login env
-
       if Rack::OAuth.test_mode?
-        session(env)[:token]  = "Token" 
-        session(env)[:secret] = "Secret"
-        set_access_token env, "AccessToken"
+        set_access_token env, OpenStruct.new(:params => { 'I am a' => 'fake token' })
         return [ 302, { 'Content-Type' => 'text/html', 'Location' => redirect_to }, [] ]
       end
 
+      # get request token and hold onto the token/secret (which we need later to get the access token)
       request = consumer.get_request_token :oauth_callback => ::File.join("http://#{ env['HTTP_HOST'] }", callback_path)
       session(env)[:token]  = request.token
       session(env)[:secret] = request.secret
+
+      # redirect to the oauth provider's authorize url to authorize the user
       [ 302, { 'Content-Type' => 'text/html', 'Location' => request.authorize_url }, [] ]
     end
 
     def do_callback env
-      session(env)[:verifier] = Rack::Request.new(env).params['oauth_verifier']
+      # get access token and persist it in the session in a way that we can get it back out later
       request = ::OAuth::RequestToken.new consumer, session(env)[:token], session(env)[:secret]
-      access  = request.get_access_token :oauth_verifier => session(env)[:verifier]
+      set_access_token env, request.get_access_token(:oauth_verifier => Rack::Request.new(env).params['oauth_verifier'])
 
-      # hold onto the access token
-      set_access_token env, access
+      # clear out the session variables (won't need these anymore)
+      session(env).delete(:token)
+      session(env).delete(:secret)
 
+      # we have an access token now ... redirect back to the user's application
       [ 302, { 'Content-Type' => 'text/html', 'Location' => redirect_to }, [] ]
     end
 
-    # Default implementation of access_token_getter
-    #
-    # Keeps tokens in an instance variable
-    def get_access_token_via_instance_variable key
-      @tokens[key] if @tokens
-    end
-
-    # Default implementation of access_token_setter
-    #
-    # Keeps tokens in an instance variable
-    def set_access_token_via_instance_variable key, token
-      @tokens ||= {}
-      @tokens[key] = token
-    end
-
-    # Returns the key to use (for this particular session) to get or set an 
-    # access token for this Rack env
-    #
-    # TODO this will very likely change as we want to be able to get or set 
-    #      access tokens using useful data like a user's name in the future
-    def key_for_env env
-      val = session(env)[:token] + session(env)[:secret] if session(env)[:token] and session(env)[:secret]
-      session(env)[:token] + session(env)[:secret] if session(env)[:token] and session(env)[:secret]
+    # Stores the access token in this env's session in a way that we can get it back out via #get_access_token(env)
+    def set_access_token env, token
+      session(env)[:access_token_params] = token.params
     end
 
-    # Gets an Access Token by key using access_token_getter (for this specific ENV)
+    # See #set_access_token
     def get_access_token env
-      access_token_getter.call key_for_env(env), self
-    end
-
-    # Sets an Access Token by key and value using access_token_setter (for this specific ENV)
-    def set_access_token env, token
-      access_token_setter.call key_for_env(env), token, self
+      params = session(env)[:access_token_params]
+      ::OAuth::AccessToken.from_hash consumer, params if params
     end
 
     # Usage:
     #
-    #   request '/account/verify_credentials.json'
-    #   request 'GET', '/account/verify_credentials.json'
-    #   request :post, '/statuses/update.json', :status => params[:tweet]
+    #   request @token, '/account/verify_credentials.json'
+    #   request @token, 'GET', '/account/verify_credentials.json'
+    #   request @token, :post, '/statuses/update.json', :status => params[:tweet]
     #
-    def request env, method, path = nil, *args
-      if method.to_s.start_with?('/')
-        path   = method
-        method = :get
-      end
-
-      return Rack::OAuth.mock_response_for(method, path) if Rack::OAuth.test_mode?
-
-      consumer.request method.to_s.downcase.to_sym, path, get_access_token(env), *args
-    end
-
-    # Same as #request but you can manually pass your own request token
-    def request_with_access_token token, method, path = nil, *args
+    def request token, method, path = nil, *args
       if method.to_s.start_with?('/')
         path   = method
         method = :get

data/spec/sample_sinatra_app_spec.rb

@@ -1,30 +1,26 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
+require 'fakeweb'
+FakeWeb.allow_net_connect = false
+FakeWeb.register_uri :get, 'http://twitter.com/account/verify_credentials.json', :body => %{{"friends_count":190,"utc_offset":-28800,"profile_sidebar_border_color":"829D5E","status":{"in_reply_to_screen_name":null,"text":"Come on people, don't you realize that smoking isn't cool anymore?  Try a healthier stimulant.  Maybe one that doesn't irritate my sinuses?","in_reply_to_user_id":null,"in_reply_to_status_id":null,"source":"web","truncated":false,"favorited":false,"id":5177704516,"created_at":"Mon Oct 26 17:15:10 +0000 2009"},"notifications":false,"statuses_count":1689,"time_zone":"Pacific Time (US & Canada)","verified":false,"profile_text_color":"3E4415","profile_image_url":"http://a3.twimg.com/profile_images/54765389/remi-rock-on_bak_normal.png","profile_background_image_url":"http://s.twimg.com/a/1256577591/images/themes/theme5/bg.gif","location":"Phoenix, AZ","following":false,"favourites_count":0,"profile_link_color":"D02B55","screen_name":"THE_REAL_SHAQ","geo_enabled":false,"profile_background_tile":false,"protected":false,"profile_background_color":"352726","name":"THE_REAL_SHAQ","followers_count":255,"url":"http://remi.org","id":11043342,"created_at":"Tue Dec 11 09:13:43 +0000 2007","profile_sidebar_fill_color":"99CC33","description":"Beer goes in, Code comes out"}}
+
 require 'json'
 require 'sinatra/base'
 class SampleSinatraApp < Sinatra::Base
 
-  # this is hardcore optional ... if you want to override where ALL tokens are persisted, you can do this ...
-
-  def self.get_token key, oauth
-    @tokens[key] if @tokens
-  end
-  def self.set_token key, token, oauth
-    @tokens ||= {}
-    @tokens[key] = token
-  end
-
   use Rack::Session::Cookie
   use Rack::OAuth, :site   => 'http://twitter.com',
                    :key    => '4JjFmhjfZyQ6rdbiql5A', 
-                   :secret => 'rv4ZaCgvxVPVjxHIDbMxTGFbIMxUa4KkIdPqL7HmaQo',
-                   :get    => method(:get_token),
-                   :set    => method(:set_token)
+                   :secret => 'rv4ZaCgvxVPVjxHIDbMxTGFbIMxUa4KkIdPqL7HmaQo'
 
   enable :raise_errors
 
   helpers do
     include Rack::OAuth::Methods
+
+    def logged_in?
+      get_access_token.present?
+    end
   end
 
   get '/' do
@@ -36,13 +32,12 @@ class SampleSinatraApp < Sinatra::Base
   end
 
   get '/oauth_complete' do
-    info = JSON.parse oauth_request('/account/verify_credentials.json')
+    info = JSON.parse get_access_token.get('/account/verify_credentials.json').body
     name = info['screen_name']
-    $access_tokens[name] = oauth_access_token
   end
 
   get '/get_user_info' do
-    info = JSON.parse oauth_request('/account/verify_credentials.json')
+    info = JSON.parse get_access_token.get('/account/verify_credentials.json').body
   end
 end
 
@@ -78,28 +73,4 @@ describe SampleSinatraApp do
     request('/').body.should include('Hello World')
   end
 
-  it 'should be able to specify a mock response for an arbitrary authorized response' do
-    request('/oauth_login') # login
-
-    # if we don't mock the request, it should blow up
-    lambda { request('/get_user_info') }.should raise_error
-
-    Rack::OAuth.mock_request '/account/verify_credentials.json', example_json
-
-    request('/get_user_info').body.should include('remitaylor')
-  end
-
-  it 'should be able to persist access token by some arbitrary value like twitter screen_name' do
-    $access_tokens ||= {}
-    request('/oauth_login').status.should == 302
-
-    # token should be nil
-    $access_tokens['remitaylor'].should be_nil
-
-    request('/oauth_complete')
-
-    # token should not be nil because the oauth_complete goes and gets and persists it
-    $access_tokens['remitaylor'].should_not be_nil
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-oauth
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - remi
@@ -11,8 +11,27 @@ cert_chain: []
 
 date: 2009-11-02 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Rack Middleware for OAuth Authorization
 email: remi@remitaylor.com
 executables: []
@@ -97,6 +116,9 @@ files:
 - examples/rails-example/tmp/webrat-1257210581.html
 - examples/rails-example/tmp/webrat-1257210600.html
 - examples/rails-example/tmp/webrat-1257210608.html
+- examples/rails-example/tmp/webrat-1257219890.html
+- examples/rails-example/tmp/webrat-1257219947.html
+- examples/rails-example/tmp/webrat-1257219957.html
 - examples/sinatra-twitter.rb
 - examples/sinatra-twitter.ru
 - lib/rack-oauth.rb