signet 0.1.0

data/spec/signet/oauth_1/credential_spec.rb

@@ -0,0 +1,163 @@
+# Copyright (C) 2010 Google Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'spec_helper'
+
+require 'signet/oauth_1/credential'
+
+describe Signet::OAuth1::Credential, 'with a Hash for initialization' do
+  it 'should accept "oauth_token" and "oauth_token_secret" pairs' do
+    token = Signet::OAuth1::Credential.new({
+      "oauth_token" => "dpf43f3p2l4k3l03",
+      "oauth_token_secret" => "kd94hf93k423kf44"
+    })
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should accept :oauth_token and :oauth_token_secret pairs' do
+    token = Signet::OAuth1::Credential.new({
+      :oauth_token => "dpf43f3p2l4k3l03",
+      :oauth_token_secret => "kd94hf93k423kf44"
+    })
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should accept "key" and "secret" pairs' do
+    token = Signet::OAuth1::Credential.new({
+      "key" => "dpf43f3p2l4k3l03",
+      "secret" => "kd94hf93k423kf44"
+    })
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should accept :key and :secret pairs' do
+    token = Signet::OAuth1::Credential.new(
+      :key => "dpf43f3p2l4k3l03",
+      :secret => "kd94hf93k423kf44"
+    )
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should not complain about additional parameters' do
+    token = Signet::OAuth1::Credential.new({
+      "oauth_token" => "dpf43f3p2l4k3l03",
+      "oauth_token_secret" => "kd94hf93k423kf44",
+      "oauth_version" => "1.0"
+    })
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should allow parameters to be specified as an implicit Hash' do
+    class ParameterHashSet
+      def initialize(parameters)
+        @parameters = Hash[parameters]
+      end
+
+      def to_hash
+        return @parameters
+      end
+    end
+
+    token = Signet::OAuth1::Credential.new(ParameterHashSet.new({
+      "oauth_token" => "dpf43f3p2l4k3l03",
+      "oauth_token_secret" => "kd94hf93k423kf44",
+      "oauth_version" => "1.0"
+    }))
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should allow parameters to be specified as an Enumerable' do
+    token = Signet::OAuth1::Credential.new([
+      ["oauth_token", "dpf43f3p2l4k3l03"],
+      ["oauth_token_secret", "kd94hf93k423kf44"],
+      ["oauth_version", "1.0"]
+    ])
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should allow parameters to be specified as an implicit Array' do
+    class ParameterArraySet
+      def initialize(parameters)
+        @parameters = parameters
+      end
+
+      def to_ary
+        return @parameters
+      end
+    end
+
+    token = Signet::OAuth1::Credential.new(ParameterArraySet.new([
+      ["oauth_token", "dpf43f3p2l4k3l03"],
+      ["oauth_token_secret", "kd94hf93k423kf44"],
+      ["oauth_version", "1.0"]
+    ]))
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should raise an error if key and secret are not present' do
+    (lambda do
+      Signet::OAuth1::Credential.new({})
+    end).should raise_error(ArgumentError)
+  end
+
+  it 'should allow key and secret to be passed in as a tuple' do
+    token = Signet::OAuth1::Credential.new(
+      ["dpf43f3p2l4k3l03", "kd94hf93k423kf44"]
+    )
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should allow key and secret to be passed in as normal parameters' do
+    token = Signet::OAuth1::Credential.new(
+      "dpf43f3p2l4k3l03", "kd94hf93k423kf44"
+    )
+    token.key.should == "dpf43f3p2l4k3l03"
+    token.secret.should == "kd94hf93k423kf44"
+  end
+
+  it 'should raise an error if key or secret are of the wrong type' do
+    (lambda do
+      Signet::OAuth1::Credential.new("dpf43f3p2l4k3l03", 42)
+    end).should raise_error(TypeError)
+    (lambda do
+      Signet::OAuth1::Credential.new(42, "kd94hf93k423kf44")
+    end).should raise_error(TypeError)
+  end
+
+  it 'should raise an error if the wrong number of arguments are passed' do
+    (lambda do
+      Signet::OAuth1::Credential.new(
+        "dpf43f3p2l4k3l03", "kd94hf93k423kf44", "something else"
+      )
+    end).should raise_error(ArgumentError)
+  end
+
+  it 'should convert to a Hash object' do
+    token = Signet::OAuth1::Credential.new(
+      "dpf43f3p2l4k3l03", "kd94hf93k423kf44"
+    )
+    parameters = Hash[token]
+    parameters['oauth_token'].should == "dpf43f3p2l4k3l03"
+    parameters['oauth_token_secret'].should == "kd94hf93k423kf44"
+  end
+end

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

@@ -0,0 +1,234 @@
+# Copyright (C) 2010 Google Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'spec_helper'
+
+require 'signet/oauth_1/client'
+require 'httpadapter/adapters/typhoeus'
+
+def merge_body(chunked_body)
+  merged_body = StringIO.new
+  chunked_body.each do |chunk|
+    merged_body.write(chunk)
+  end
+  return merged_body.string
+end
+
+describe Signet::OAuth1::Client, 'configured for standard Google APIs' do
+  before do
+    @client = Signet::OAuth1::Client.new(
+      :temporary_credential_uri =>
+        'https://www.google.com/accounts/OAuthGetRequestToken',
+      :authorization_uri =>
+        'https://www.google.com/accounts/OAuthAuthorizeToken',
+      :token_credential_uri =>
+        'https://www.google.com/accounts/OAuthGetAccessToken',
+      :client_credential_key => 'anonymous',
+      :client_credential_secret => 'anonymous'
+    )
+  end
+
+  it 'should raise an error if scope is omitted' do
+    (lambda do
+      @client.fetch_temporary_credential!
+    end).should raise_error(Signet::AuthorizationError)
+  end
+
+  it 'should raise an error if the server gives an unexpected status' do
+    (lambda do
+      hydra = Typhoeus::Hydra.new
+      stubbed_response = Typhoeus::Response.new(
+        :code => 999,
+        :headers => '',
+        :body => 'Rate limit hit or something.'
+      )
+      hydra.stub(
+        :post,
+        'https://www.google.com/accounts/OAuthGetRequestToken'
+      ).and_return(stubbed_response)
+      connection = HTTPAdapter::Connection.new(
+        'www.google.com', 443, hydra,
+        :join => [:run, [], nil]
+      )
+      @client.fetch_temporary_credential!(
+        :adapter => HTTPAdapter::TyphoeusRequestAdapter,
+        :connection => connection,
+        :additional_parameters => {
+          :scope => 'https://www.google.com/m8/feeds/'
+        }
+      )
+    end).should raise_error(Signet::AuthorizationError)
+  end
+
+  it 'should be able to obtain temporary credentials for the Contacts API' do
+    @client.fetch_temporary_credential!(:additional_parameters => {
+      :scope => 'https://www.google.com/m8/feeds/'
+    })
+    @client.temporary_credential_key.size.should > 0
+    @client.temporary_credential_secret.size.should > 0
+  end
+
+  it 'should have the correct authorization URI' do
+    @client.fetch_temporary_credential!(:additional_parameters => {
+      :scope => 'https://www.google.com/m8/feeds/'
+    })
+    @client.authorization_uri.query_values["oauth_token"].should ==
+      @client.temporary_credential_key
+  end
+
+  it 'should raise an error if the temporary credentials are bogus' do
+    (lambda do
+      @client.temporary_credential_key = '12345'
+      @client.temporary_credential_secret = '12345'
+      @client.fetch_token_credential!(:verifier => 'XbVKagBShNsAGBRJWoC4gtFR')
+    end).should raise_error(Signet::AuthorizationError)
+  end
+
+  it 'should raise an error if the token credentials are bogus' do
+    (lambda do
+      @client.token_credential_key = '12345'
+      @client.token_credential_secret = '12345'
+      @client.fetch_protected_resource(
+        :uri =>
+          'http://www-opensocial.googleusercontent.com/api/people/@me/@self'
+      )
+    end).should raise_error(Signet::AuthorizationError)
+  end
+
+  # We have to stub responses for the token credentials
+
+  it 'should be able to obtain token credentials for the Contacts API' do
+    hydra = Typhoeus::Hydra.new
+    stubbed_response = Typhoeus::Response.new(
+      :code => 200,
+      :headers => '',
+      :body => (
+        'oauth_token=1%2FYFw6UH2Dn7W691-qAbCfsmqEHQrPb7ptIvYx9m6YkUQ&' +
+        'oauth_token_secret=Ew3YHAY4bcBryiOUvbdHGa57'
+      )
+    )
+    hydra.stub(
+      :post,
+      'https://www.google.com/accounts/OAuthGetAccessToken'
+    ).and_return(stubbed_response)
+    connection = HTTPAdapter::Connection.new(
+      'www.google.com', 443, hydra,
+      :join => [:run, [], nil]
+    )
+    @client.temporary_credential_key = '4/oegn2eP-3yswD7HiESnJOB-8oh2i'
+    @client.temporary_credential_secret = '8E1BF0J6ovMva0j87atj/tTG'
+    @client.fetch_token_credential!(
+      :verifier => 'XbVKagBShNsAGBRJWoC4gtFR',
+      :adapter => HTTPAdapter::TyphoeusRequestAdapter,
+      :connection => connection,
+      :additional_parameters => {
+        :scope => 'https://www.google.com/m8/feeds/'
+      }
+    )
+    @client.token_credential_key.should ==
+      '1/YFw6UH2Dn7W691-qAbCfsmqEHQrPb7ptIvYx9m6YkUQ'
+    @client.token_credential_secret.should == 'Ew3YHAY4bcBryiOUvbdHGa57'
+  end
+
+  it 'should raise an error if the server gives an unexpected status' do
+    (lambda do
+      hydra = Typhoeus::Hydra.new
+      stubbed_response = Typhoeus::Response.new(
+        :code => 999,
+        :headers => '',
+        :body => 'Rate limit hit or something.'
+      )
+      hydra.stub(
+        :post,
+        'https://www.google.com/accounts/OAuthGetAccessToken'
+      ).and_return(stubbed_response)
+      connection = HTTPAdapter::Connection.new(
+        'www.google.com', 443, hydra,
+        :join => [:run, [], nil]
+      )
+      @client.temporary_credential_key = '4/oegn2eP-3yswD7HiESnJOB-8oh2i'
+      @client.temporary_credential_secret = '8E1BF0J6ovMva0j87atj/tTG'
+      @client.fetch_token_credential!(
+        :verifier => 'XbVKagBShNsAGBRJWoC4gtFR',
+        :adapter => HTTPAdapter::TyphoeusRequestAdapter,
+        :connection => connection,
+        :additional_parameters => {
+          :scope => 'https://www.google.com/m8/feeds/'
+        }
+      )
+    end).should raise_error(Signet::AuthorizationError)
+  end
+
+  it 'should correctly fetch the protected resource' do
+    hydra = Typhoeus::Hydra.new
+    stubbed_response = Typhoeus::Response.new(
+      :code => 200,
+      :headers => "Content-Type: application/json\r\n",
+      :body => '{"data":"goes here"}'
+    )
+    hydra.stub(
+      :get,
+      'http://www-opensocial.googleusercontent.com/api/people/@me/@self'
+    ).and_return(stubbed_response)
+    connection = HTTPAdapter::Connection.new(
+      'www.google.com', 443, hydra,
+      :join => [:run, [], nil]
+    )
+    @client.token_credential_key =
+      '1/YFw6UH2Dn7W691-qAbCfsmqEHQrPb7ptIvYx9m6YkUQ'
+    @client.token_credential_secret = 'Ew3YHAY4bcBryiOUvbdHGa57'
+    response = @client.fetch_protected_resource(
+      :adapter => HTTPAdapter::TyphoeusRequestAdapter,
+      :connection => connection,
+      :uri =>
+        'http://www-opensocial.googleusercontent.com/api/people/@me/@self'
+    )
+    status, headers, body = response
+    status.should == 200
+    Hash[headers]['Content-Type'].should == 'application/json'
+    merge_body(body).should == '{"data":"goes here"}'
+  end
+
+  it 'should correctly fetch the protected resource' do
+    hydra = Typhoeus::Hydra.new
+    stubbed_response = Typhoeus::Response.new(
+      :code => 200,
+      :headers => "Content-Type: application/json\r\n",
+      :body => '{"data":"goes here"}'
+    )
+    hydra.stub(
+      :get,
+      'http://www-opensocial.googleusercontent.com/api/people/@me/@self'
+    ).and_return(stubbed_response)
+    connection = HTTPAdapter::Connection.new(
+      'www.google.com', 443, hydra,
+      :join => [:run, [], nil]
+    )
+    @client.token_credential_key =
+      '1/YFw6UH2Dn7W691-qAbCfsmqEHQrPb7ptIvYx9m6YkUQ'
+    @client.token_credential_secret = 'Ew3YHAY4bcBryiOUvbdHGa57'
+    response = @client.fetch_protected_resource(
+      :adapter => HTTPAdapter::TyphoeusRequestAdapter,
+      :connection => connection,
+      :request => Typhoeus::Request.new(
+        'http://www-opensocial.googleusercontent.com/api/people/@me/@self',
+        :method => :get
+      )
+    )
+    status, headers, body = response
+    status.should == 200
+    Hash[headers]['Content-Type'].should == 'application/json'
+    merge_body(body).should == '{"data":"goes here"}'
+  end
+end

data/spec/signet/oauth_1/signature_methods/hmac_sha1_spec.rb

@@ -0,0 +1,62 @@
+# Copyright (C) 2010 Google Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'spec_helper'
+
+require 'signet'
+require 'signet/oauth_1/signature_methods/hmac_sha1'
+
+describe Signet::OAuth1::HMACSHA1 do
+  it 'should correctly generate a signature' do
+    method = "GET"
+    uri = "http://photos.example.net/photos"
+    parameters = {
+      "oauth_consumer_key" => "dpf43f3p2l4k3l03",
+      "oauth_token" => "nnch734d00sl2jdk",
+      "oauth_signature_method" => "HMAC-SHA1",
+      "oauth_timestamp" => "1191242096",
+      "oauth_nonce" => "kllo9940pd9333jh",
+      "oauth_version" => "1.0",
+      "file" => "vacation.jpg",
+      "size" => "original"
+    }
+    client_credential_secret = "kd94hf93k423kf44"
+    token_credential_secret = "pfkkdhi9sl3r4s00"
+    base_string = Signet::OAuth1.generate_base_string(method, uri, parameters)
+    Signet::OAuth1::HMACSHA1.generate_signature(
+      base_string, client_credential_secret, token_credential_secret
+    ).should == "tR3+Ty81lMeYAr/Fid0kMTYa/WM="
+  end
+
+  it 'should correctly generate a signature' do
+    method = "GET"
+    uri = "http://photos.example.net/photos"
+    parameters = {
+      "oauth_consumer_key" => "www.example.com",
+      "oauth_token" => "4/QL2GT6b5uznYem1ZGH6v+-9mMvRL",
+      "oauth_signature_method" => "HMAC-SHA1",
+      "oauth_timestamp" => "1191242096",
+      "oauth_nonce" => "kllo9940pd9333jh",
+      "oauth_version" => "1.0",
+      "file" => "vacation.jpg",
+      "size" => "original"
+    }
+    client_credential_secret = "Kv+o2XXL/9RxkQW3lO3QTVlH"
+    token_credential_secret = "QllSuL9eQ5FXFO1Z/HcgL4ON"
+    base_string = Signet::OAuth1.generate_base_string(method, uri, parameters)
+    Signet::OAuth1::HMACSHA1.generate_signature(
+      base_string, client_credential_secret, token_credential_secret
+    ).should == "G/nkdbmbpEA+6RD1Sc5uIefhFfQ="
+  end
+end