Merge pull request #162 from AgoraSecurity/add_authorize

Implement authenticate_url

Author: pboling

lib/oauth/consumer.rb

@@ -23,6 +23,7 @@ class Consumer
 
       # default paths on site. These are the same as the defaults set up by the generators
       :request_token_path => '/oauth/request_token',
+      :authenticate_path  => '/oauth/authenticate',
       :authorize_path     => '/oauth/authorize',
       :access_token_path  => '/oauth/access_token',
 
@@ -266,6 +267,10 @@ def request_token_path
       @options[:request_token_path]
     end
 
+    def authenticate_path
+      @options[:authenticate_path]
+    end
+
     def authorize_path
       @options[:authorize_path]
     end
@@ -283,6 +288,14 @@ def request_token_url?
       @options.has_key?(:request_token_url)
     end
 
+    def authenticate_url
+      @options[:authenticate_url] || site + authenticate_path
+    end
+
+    def authenticate_url?
+      @options.has_key?(:authenticate_url)
+    end
+
     def authorize_url
       @options[:authorize_url] || site + authorize_path
     end

lib/oauth/tokens/request_token.rb

@@ -8,7 +8,14 @@ def authorize_url(params = nil)
       return nil if self.token.nil?
 
       params = (params || {}).merge(:oauth_token => self.token)
-      build_authorize_url(consumer.authorize_url, params)
+      build_url(consumer.authorize_url, params)
+    end
+
+    def authenticate_url(params = nil)
+      return nil if self.token.nil?
+
+      params = (params || {}).merge(:oauth_token => self.token)
+      build_url(consumer.authenticate_url, params)
     end
 
     def callback_confirmed?
@@ -23,8 +30,8 @@ def get_access_token(options = {}, *arguments)
 
   protected
 
-    # construct an authorization url
-    def build_authorize_url(base_url, params)
+    # construct an authorization or authentication url
+    def build_url(base_url, params)
       uri = URI.parse(base_url.to_s)
       queries = {}
       queries = Hash[URI.decode_www_form(uri.query)] if uri.query

lib/oauth/version.rb

@@ -1,3 +1,3 @@
 module OAuth
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

test/units/test_request_token.rb

@@ -1,8 +1,8 @@
 require File.expand_path('../../test_helper', __FILE__)
 
 class StubbedToken < OAuth::RequestToken
-  define_method :build_authorize_url_promoted do |root_domain, params|
-    build_authorize_url root_domain, params
+  define_method :build_url_promoted do |root_domain, params|
+    build_url root_domain, params
   end
 end
 
@@ -40,14 +40,38 @@ def test_request_token_returns_nil_authorize_url_when_token_is_nil
     assert_nil @request_token.authorize_url
   end
 
+  def test_request_token_builds_authenticate_url_connectly_with_additional_params
+    authenticate_url = @request_token.authenticate_url({:oauth_callback => "github.com"})
+    assert authenticate_url
+    assert_match(/oauth_token/, authenticate_url)
+    assert_match(/oauth_callback/, authenticate_url)
+  end
+
+  def test_request_token_builds_authenticate_url_connectly_with_no_or_nil_params
+    # we should only have 1 key in the url returned if we didn't pass anything.
+    # this is the only required param to authenticate the client.
+    authenticate_url = @request_token.authenticate_url(nil)
+    assert authenticate_url
+    assert_match(/\?oauth_token=/, authenticate_url)
+
+    authenticate_url2 = @request_token.authenticate_url
+    assert authenticate_url2
+    assert_match(/\?oauth_token=/, authenticate_url2)
+  end
+
+  def test_request_token_returns_nil_authenticate_url_when_token_is_nil
+    @request_token.token = nil
+    assert_nil @request_token.authenticate_url
+  end
+
   #TODO: mock out the Consumer to test the Consumer/AccessToken interaction.
   def test_get_access_token
   end
 
-  def test_build_authorize_url
+  def test_build_url
    @stubbed_token = StubbedToken.new(nil, nil, nil)
-    assert_respond_to @stubbed_token, :build_authorize_url_promoted
-    url = @stubbed_token.build_authorize_url_promoted(
+    assert_respond_to @stubbed_token, :build_url_promoted
+    url = @stubbed_token.build_url_promoted(
       "http://github.com/oauth/authorize",
       {:foo => "bar bar"})
     assert url