signet 0.1.3 → 0.1.4

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.1.4
+
+* Added support for a two-legged authorization flow
+
 == 0.1.3
 
 * fixed issue with headers passed in as a Hash

data/lib/signet/oauth_1.rb

@@ -284,9 +284,8 @@ module Signet #:nodoc:
       # be a temporary credential secret when obtaining a token credential
       # for the first time
       base_string = self.generate_base_string(method, uri, parameters)
-      signature_method = (
-        parameters.inject({}) { |h,(k,v)| h[k]=v; h }
-      )['oauth_signature_method']
+      parameters = parameters.inject({}) { |h,(k,v)| h[k.to_s]=v; h }
+      signature_method = parameters['oauth_signature_method']
       case signature_method
       when 'HMAC-SHA1'
         require 'signet/oauth_1/signature_methods/hmac_sha1'
@@ -305,13 +304,13 @@ module Signet #:nodoc:
     #
     # @param [Hash] options
     #   The configuration parameters for the request.
-    #   - <code>:client_credential_key</code> — 
+    #   - <code>:client_credential_key</code> —
     #     The client credential key.
-    #   - <code>:callback</code> — 
+    #   - <code>:callback</code> —
     #     The OAuth callback.  Defaults to {Signet::OAuth1::OUT_OF_BAND}.
-    #   - <code>:signature_method</code> — 
+    #   - <code>:signature_method</code> —
     #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-    #   - <code>:additional_parameters</code> — 
+    #   - <code>:additional_parameters</code> —
     #     Non-standard additional parameters.
     #
     # @return [Array]
@@ -380,13 +379,13 @@ module Signet #:nodoc:
     #
     # @param [Hash] options
     #   The configuration parameters for the request.
-    #   - <code>:client_credential_key</code> — 
+    #   - <code>:client_credential_key</code> —
     #     The client credential key.
-    #   - <code>:temporary_credential_key</code> — 
+    #   - <code>:temporary_credential_key</code> —
     #     The temporary credential key.
-    #   - <code>:verifier</code> — 
+    #   - <code>:verifier</code> —
     #     The OAuth verifier.
-    #   - <code>:signature_method</code> — 
+    #   - <code>:signature_method</code> —
     #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
     #
     # @return [Array]
@@ -428,37 +427,44 @@ module Signet #:nodoc:
     #
     # @param [Hash] options
     #   The configuration parameters for the request.
-    #   - <code>:client_credential_key</code> — 
+    #   - <code>:client_credential_key</code> —
     #     The client credential key.
-    #   - <code>:token_credential_key</code> — 
+    #   - <code>:token_credential_key</code> —
     #     The token credential key.
-    #   - <code>:signature_method</code> — 
+    #   - <code>:signature_method</code> —
     #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
+    #   - <code>:two_legged</code> —
+    #     A switch for two-legged OAuth.  Defaults to <code>false</code>.
     #
     # @return [Array]
     #   The parameter list as an <code>Array</code> of key/value pairs.
     def self.unsigned_resource_parameters(options={})
       options = {
-        :signature_method => 'HMAC-SHA1'
+        :signature_method => 'HMAC-SHA1',
+        :two_legged => false
       }.merge(options)
       client_credential_key =
         self.extract_credential_key_option(:client, options)
-      token_credential_key =
-        self.extract_credential_key_option(:token, options)
       if client_credential_key == nil
         raise ArgumentError, "Missing :client_credential_key parameter."
       end
-      if token_credential_key == nil
-        raise ArgumentError, "Missing :token_credential_key parameter."
+      unless options[:two_legged]
+        token_credential_key =
+          self.extract_credential_key_option(:token, options)
+        if token_credential_key == nil
+          raise ArgumentError, "Missing :token_credential_key parameter."
+        end
       end
       parameters = [
         ["oauth_consumer_key", client_credential_key],
-        ["oauth_token", token_credential_key],
         ["oauth_signature_method", options[:signature_method]],
         ["oauth_timestamp", self.generate_timestamp()],
         ["oauth_nonce", self.generate_nonce()],
         ["oauth_version", "1.0"]
       ]
+      unless options[:two_legged]
+        parameters << ["oauth_token", token_credential_key]
+      end
       # No additional parameters allowed here
       return parameters
     end

data/lib/signet/oauth_1/client.rb

@@ -26,14 +26,14 @@ module Signet #:nodoc:
       #
       # @param [Hash] options
       #   The configuration parameters for the client.
-      #   - <code>:temporary_credential_uri</code> — 
+      #   - <code>:temporary_credential_uri</code> —
       #     The OAuth temporary credentials URI.
       #   - <code>:authorization_uri</code> —  The OAuth authorization URI.
-      #   - <code>:token_credential_uri</code> — 
+      #   - <code>:token_credential_uri</code> —
       #     The OAuth token credentials URI.
-      #   - <code>:client_credential_key</code> — 
+      #   - <code>:client_credential_key</code> —
       #     The OAuth client credential key.
-      #   - <code>:client_credential_secret</code> — 
+      #   - <code>:client_credential_secret</code> —
       #     The OAuth client credential secret.
       #   - <code>:callback</code> —  The OAuth callback.  Defaults to 'oob'.
       #
@@ -67,6 +67,7 @@ module Signet #:nodoc:
         self.token_credential_secret =
           Signet::OAuth1.extract_credential_secret_option(:token, options)
         self.callback = options[:callback]
+        self.two_legged = options[:two_legged] || false
       end
 
       ##
@@ -480,16 +481,39 @@ module Signet #:nodoc:
         end
       end
 
+      ##
+      # Returns whether the client is in two-legged mode.
+      #
+      # @return [TrueClass, FalseClass]
+      #   <code>true</code> for two-legged mode, <code>false</code> otherwise.
+      def two_legged
+        return @two_legged ||= false
+      end
+
+      ##
+      # Sets the client for two-legged mode.
+      #
+      # @param [TrueClass, FalseClass] new_two_legged
+      #   <code>true</code> for two-legged mode, <code>false</code> otherwise.
+      def two_legged=(new_two_legged)
+        if new_two_legged != true && new_two_legged != false
+          raise TypeError,
+            "Expected true or false, got #{new_two_legged.class}."
+        else
+          @two_legged = new_two_legged
+        end
+      end
+
       ##
       # Generates a request for temporary credentials.
       #
       # @param [Hash] options
       #   The configuration parameters for the request.
-      #   - <code>:signature_method</code> — 
+      #   - <code>:signature_method</code> —
       #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-      #   - <code>:additional_parameters</code> — 
+      #   - <code>:additional_parameters</code> —
       #     Non-standard additional parameters.
-      #   - <code>:realm</code> — 
+      #   - <code>:realm</code> —
       #     The Authorization realm.  See RFC 2617.
       #
       # @return [Array] The request object.
@@ -552,16 +576,16 @@ module Signet #:nodoc:
       #
       # @param [Hash] options
       #   The configuration parameters for the request.
-      #   - <code>:signature_method</code> — 
+      #   - <code>:signature_method</code> —
       #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-      #   - <code>:additional_parameters</code> — 
+      #   - <code>:additional_parameters</code> —
       #     Non-standard additional parameters.
-      #   - <code>:realm</code> — 
+      #   - <code>:realm</code> —
       #     The Authorization realm.  See RFC 2617.
-      #   - <code>:adapter</code> — 
+      #   - <code>:adapter</code> —
       #     The HTTP adapter.
       #     Defaults to <code>HTTPAdapter::NetHTTPRequestAdapter</code>.
-      #   - <code>:connection</code> — 
+      #   - <code>:connection</code> —
       #     An open, manually managed HTTP connection.
       #     Must be of type <code>HTTPAdapter::Connection</code> and the
       #     internal connection representation must match the HTTP adapter
@@ -620,16 +644,16 @@ module Signet #:nodoc:
       #
       # @param [Hash] options
       #   The configuration parameters for the request.
-      #   - <code>:signature_method</code> — 
+      #   - <code>:signature_method</code> —
       #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-      #   - <code>:additional_parameters</code> — 
+      #   - <code>:additional_parameters</code> —
       #     Non-standard additional parameters.
-      #   - <code>:realm</code> — 
+      #   - <code>:realm</code> —
       #     The Authorization realm.  See RFC 2617.
-      #   - <code>:adapter</code> — 
+      #   - <code>:adapter</code> —
       #     The HTTP adapter.
       #     Defaults to <code>HTTPAdapter::NetHTTPRequestAdapter</code>.
-      #   - <code>:connection</code> — 
+      #   - <code>:connection</code> —
       #     An open, manually managed HTTP connection.
       #     Must be of type <code>HTTPAdapter::Connection</code> and the
       #     internal connection representation must match the HTTP adapter
@@ -655,11 +679,11 @@ module Signet #:nodoc:
       #
       # @param [Hash] options
       #   The configuration parameters for the request.
-      #   - <code>:verifier</code> — 
+      #   - <code>:verifier</code> —
       #     The OAuth verifier provided by the server.  Required.
-      #   - <code>:signature_method</code> — 
+      #   - <code>:signature_method</code> —
       #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-      #   - <code>:realm</code> — 
+      #   - <code>:realm</code> —
       #     The Authorization realm.  See RFC 2617.
       #
       # @return [Array] The request object.
@@ -724,16 +748,16 @@ module Signet #:nodoc:
       #
       # @param [Hash] options
       #   The configuration parameters for the request.
-      #   - <code>:verifier</code> — 
+      #   - <code>:verifier</code> —
       #     The OAuth verifier provided by the server.  Required.
-      #   - <code>:signature_method</code> — 
+      #   - <code>:signature_method</code> —
       #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-      #   - <code>:realm</code> — 
+      #   - <code>:realm</code> —
       #     The Authorization realm.  See RFC 2617.
-      #   - <code>:adapter</code> — 
+      #   - <code>:adapter</code> —
       #     The HTTP adapter.
       #     Defaults to <code>HTTPAdapter::NetHTTPRequestAdapter</code>.
-      #   - <code>:connection</code> — 
+      #   - <code>:connection</code> —
       #     An open, manually managed HTTP connection.
       #     Must be of type <code>HTTPAdapter::Connection</code> and the
       #     internal connection representation must match the HTTP adapter
@@ -790,16 +814,16 @@ module Signet #:nodoc:
       #
       # @param [Hash] options
       #   The configuration parameters for the request.
-      #   - <code>:signature_method</code> — 
+      #   - <code>:signature_method</code> —
       #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-      #   - <code>:additional_parameters</code> — 
+      #   - <code>:additional_parameters</code> —
       #     Non-standard additional parameters.
-      #   - <code>:realm</code> — 
+      #   - <code>:realm</code> —
       #     The Authorization realm.  See RFC 2617.
-      #   - <code>:adapter</code> — 
+      #   - <code>:adapter</code> —
       #     The HTTP adapter.
       #     Defaults to <code>HTTPAdapter::NetHTTPRequestAdapter</code>.
-      #   - <code>:connection</code> — 
+      #   - <code>:connection</code> —
       #     An open, manually managed HTTP connection.
       #     Must be of type <code>HTTPAdapter::Connection</code> and the
       #     internal connection representation must match the HTTP adapter
@@ -823,29 +847,33 @@ module Signet #:nodoc:
       #
       # @param [Hash] options
       #   The configuration parameters for the request.
-      #   - <code>:request</code> — 
+      #   - <code>:request</code> —
       #     A pre-constructed request to sign.
-      #   - <code>:method</code> — 
+      #   - <code>:method</code> —
       #     The HTTP method for the request.  Defaults to 'GET'.
-      #   - <code>:uri</code> — 
+      #   - <code>:uri</code> —
       #     The URI for the request.
-      #   - <code>:headers</code> — 
+      #   - <code>:headers</code> —
       #     The HTTP headers for the request.
-      #   - <code>:body</code> — 
+      #   - <code>:body</code> —
       #     The HTTP body for the request.
-      #   - <code>:signature_method</code> — 
+      #   - <code>:signature_method</code> —
       #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-      #   - <code>:realm</code> — 
+      #   - <code>:realm</code> —
       #     The Authorization realm.  See RFC 2617.
       #
       # @return [Array] The request object.
       def generate_authenticated_request(options={})
         verifications = {
           :client_credential_key => 'Client credential key',
-          :client_credential_secret => 'Client credential secret',
-          :token_credential_key => 'Token credential key',
-          :token_credential_secret => 'Token credential secret'
+          :client_credential_secret => 'Client credential secret'
         }
+        unless self.two_legged
+          verifications.update(
+            :token_credential_key => 'Token credential key',
+            :token_credential_secret => 'Token credential secret'
+          )
+        end
         # Make sure all required state is set
         verifications.each do |(key, value)|
           unless self.send(key)
@@ -898,7 +926,8 @@ module Signet #:nodoc:
         parameters = ::Signet::OAuth1.unsigned_resource_parameters(
           :client_credential_key => self.client_credential_key,
           :token_credential_key => self.token_credential_key,
-          :signature_method => options[:signature_method]
+          :signature_method => options[:signature_method],
+          :two_legged => self.two_legged
         )
         media_type = nil
         headers.each do |(header, value)|
@@ -938,24 +967,24 @@ module Signet #:nodoc:
       #
       # @param [Hash] options
       #   The configuration parameters for the request.
-      #   - <code>:request</code> — 
+      #   - <code>:request</code> —
       #     A pre-constructed request to sign.
-      #   - <code>:method</code> — 
+      #   - <code>:method</code> —
       #     The HTTP method for the request.  Defaults to 'GET'.
-      #   - <code>:uri</code> — 
+      #   - <code>:uri</code> —
       #     The URI for the request.
-      #   - <code>:headers</code> — 
+      #   - <code>:headers</code> —
       #     The HTTP headers for the request.
-      #   - <code>:body</code> — 
+      #   - <code>:body</code> —
       #     The HTTP body for the request.
-      #   - <code>:signature_method</code> — 
+      #   - <code>:signature_method</code> —
       #     The signature method.  Defaults to <code>'HMAC-SHA1'</code>.
-      #   - <code>:realm</code> — 
+      #   - <code>:realm</code> —
       #     The Authorization realm.  See RFC 2617.
-      #   - <code>:adapter</code> — 
+      #   - <code>:adapter</code> —
       #     The HTTP adapter.
       #     Defaults to <code>HTTPAdapter::NetHTTPRequestAdapter</code>.
-      #   - <code>:connection</code> — 
+      #   - <code>:connection</code> —
       #     An open, manually managed HTTP connection.
       #     Must be of type <code>HTTPAdapter::Connection</code> and the
       #     internal connection representation must match the HTTP adapter

data/lib/signet/version.rb

@@ -18,7 +18,7 @@ unless defined? Signet::VERSION
     module VERSION #:nodoc:
       MAJOR = 0
       MINOR = 1
-      TINY  = 3
+      TINY  = 4
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/spec/signet/oauth_1/client_spec.rb

@@ -362,6 +362,13 @@ describe Signet::OAuth1::Client, 'unconfigured' do
       @client.token_credential_secret = 54321
     end).should raise_error(TypeError)
   end
+
+  it 'should not allow the two_legged flag ' +
+      'to be set to a non-Boolean' do
+    (lambda do
+      @client.two_legged = 42
+    end).should raise_error(TypeError)
+  end
 end
 
 describe Signet::OAuth1::Client, 'configured' do

data/spec/signet/oauth_1/services/google_spec.rb

@@ -235,3 +235,22 @@ describe Signet::OAuth1::Client, 'configured for standard Google APIs' do
     merge_body(body).should == '{"data":"goes here"}'
   end
 end
+
+describe Signet::OAuth1::Client, 'configured for two-legged OAuth' do
+  before do
+    @client = Signet::OAuth1::Client.new(
+      :client_credential_key => '12345',
+      :client_credential_secret => '12345',
+      :two_legged => true
+    )
+  end
+
+  it 'should raise an error if the client credentials are bogus' do
+    (lambda do
+      @client.fetch_protected_resource(
+        :uri =>
+          'http://www-opensocial.googleusercontent.com/api/people/@me/@self'
+      )
+    end).should raise_error(Signet::AuthorizationError)
+  end
+end

data/tasks/spec.rake

@@ -18,7 +18,8 @@ namespace :spec do
       '--exclude', 'spec',
       '--exclude', 'compat',
       '--exclude', '1\\.8\\/gems',
-      '--exclude', '1\\.9\\/gems'
+      '--exclude', '1\\.9\\/gems',
+      '--exclude', '\\.rvm'
     ]
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: signet
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Bob Aman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-13 00:00:00 -07:00
+date: 2010-10-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency