require 'google/api_client/discovery'
module Google #:nodoc:
+ # TODO(bobaman): Document all this stuff.
+
##
# This class manages communication with a single API.
class APIClient
+ ##
+ # An error which is raised when there is an unexpected response or other
+ # transport error that prevents an operation from succeeding.
+ class TransmissionError < StandardError
+ end
def initialize(options={})
@options = {
end)
end
+ ##
+ # Returns the URI for the discovery document.
+ #
+ # @return [Addressable::URI] The URI of the discovery document.
def discovery_uri
return @options[:discovery_uri] ||= (begin
if @options[:service]
service_id = @options[:service]
service_version = @options[:service_version] || 'v1'
- "http://www.googleapis.com/discovery/0.1/describe" +
- "?api=#{service_id}"
+ Addressable::URI.parse(
+ "http://www.googleapis.com/discovery/0.1/describe" +
+ "?api=#{service_id}"
+ )
else
raise ArgumentError,
'Missing required configuration value, :discovery_uri.'
def discovery_document
return @discovery_document ||= (begin
- request = ['GET', self.discovery_uri, [], []]
+ request = ['GET', self.discovery_uri.to_s, [], []]
response = self.transmit_request(request)
status, headers, body = response
- if status == 200
+ if status == 200 # TODO(bobaman) Better status code handling?
merged_body = StringIO.new
body.each do |chunk|
merged_body.write(chunk)
require 'google/api_client/version'
require 'google/api_client/parsers/json_parser'
+describe Google::APIClient, 'unconfigured' do
+ before do
+ @client = Google::APIClient.new
+ end
+
+ it 'should not be able to determine the discovery URI' do
+ (lambda do
+ @client.discovery_uri
+ end).should raise_error(ArgumentError)
+ end
+end
+
+describe Google::APIClient, 'configured for a bogus API' do
+ before do
+ @client = Google::APIClient.new(:service => 'bogus')
+ end
+
+ it 'should not be able to retrieve the discovery document' do
+ (lambda do
+ @client.discovery_document
+ end).should raise_error(Google::APIClient::TransmissionError)
+ end
+end
+
describe Google::APIClient, 'configured for the prediction API' do
before do
@client = Google::APIClient.new(:service => 'prediction')
end
+ it 'should correctly determine the discovery URI' do
+ @client.discovery_uri.should ===
+ 'http://www.googleapis.com/discovery/0.1/describe?api=prediction'
+ end
+
it 'should have multiple versions available' do
@client.discovered_services.size.should > 1
end
# Sanity check the algorithm
@client.latest_service('bogus').should == nil
end
+
+ it 'should generate requests against the correct URIs' do
+ request = @client.generate_request(
+ 'prediction.training.insert',
+ {'query' => '12345'},
+ '',
+ [],
+ {:signed => false}
+ )
+ method, uri, headers, body = request
+ uri.should ==
+ 'https://www.googleapis.com/prediction/v1/training?query=12345'
+ end
+
+ it 'should generate signed requests' do
+ @client.authorization.token_credential_key = '12345'
+ @client.authorization.token_credential_secret = '12345'
+ request = @client.generate_request(
+ 'prediction.training.insert',
+ {'query' => '12345'},
+ '',
+ [],
+ {:signed => true}
+ )
+ method, uri, headers, body = request
+ headers = Hash[headers]
+ headers.keys.should include('Authorization')
+ headers['Authorization'].should =~ /^OAuth/
+ end
+
+ it 'should not be able to execute improperly authorized requests' do
+ @client.authorization.token_credential_key = '12345'
+ @client.authorization.token_credential_secret = '12345'
+ response = @client.execute(
+ 'prediction.training.insert',
+ {'query' => '12345'},
+ '',
+ [],
+ {:signed => true}
+ )
+ status, headers, body = response
+ status.should == 401
+ end
end