google-api-client 0.5.0 → 0.6.0

data/lib/google/api_client/railtie.rb

@@ -0,0 +1,16 @@
+require 'google/api_client/logging'
+
+module Google
+  class APIClient
+    
+    ##
+    # Optional support class for Rails. Currently replaces the built-in logger
+    # with Rails' application log.
+    #
+    class Railtie < Rails::Railtie
+      initializer 'google-api-client' do |app|
+        Google::APIClient.logger = Rails.logger
+      end
+    end
+  end
+end

data/lib/google/api_client/request.rb

@@ -19,6 +19,7 @@ require 'compat/multi_json'
 require 'addressable/uri'
 require 'stringio'
 require 'google/api_client/discovery'
+require 'google/api_client/logging'
 
 module Google
   class APIClient
@@ -26,8 +27,10 @@ module Google
     ##
     # Represents an API request.
     class Request
-      MULTIPART_BOUNDARY = "-----------RubyApiMultipartPost".freeze
+      include Google::APIClient::Logging
       
+      MULTIPART_BOUNDARY = "-----------RubyApiMultipartPost".freeze
+
       # @return [Hash] Request parameters
       attr_reader :parameters
       # @return [Hash] Additional HTTP headers
@@ -42,7 +45,7 @@ module Google
       attr_accessor :authenticated
       # @return [#read, #to_str] Request body
       attr_accessor :body
-      
+
       ##
       # Build a request
       #
@@ -52,7 +55,7 @@ module Google
       # @option options [Google::APIClient::Method] :api_method
       #   API method to invoke. Either :api_method or :uri must be specified
       # @option options [TrueClass, FalseClass] :authenticated
-      #   True if request should include credentials. Implicitly true if 
+      #   True if request should include credentials. Implicitly true if
       #   unspecified and :authorization present
       # @option options [#generate_signed_request] :authorization
       #   OAuth credentials
@@ -74,12 +77,12 @@ module Google
         self.api_method = options[:api_method]
         self.authenticated = options[:authenticated]
         self.authorization = options[:authorization]
-        
+
         # These parameters are handled differently because they're not
         # parameters to the API method, but rather to the API system.
         self.parameters['key'] ||= options[:key] if options[:key]
         self.parameters['userIp'] ||= options[:user_ip] if options[:user_ip]
-        
+
         if options[:media]
           self.initialize_media_upload(options)
         elsif options[:body]
@@ -90,13 +93,13 @@ module Google
         else
           self.body = ''
         end
-        
+
         unless self.api_method
           self.http_method = options[:http_method] || 'GET'
           self.uri = options[:uri]
         end
       end
-      
+
       # @!attribute [r] upload_type
       # @return [String] protocol used for upload
       def upload_type
@@ -128,7 +131,7 @@ module Google
             "Expected Google::APIClient::Method, got #{new_api_method.class}."
         end
       end
-      
+
       # @!attribute uri
       # @return [Addressable::URI] URI to send request
       def uri
@@ -145,26 +148,31 @@ module Google
       #
       # @api private
       #
-      # @param [Faraday::Connection] connection 
+      # @param [Faraday::Connection] connection
       #   the connection to transmit with
-      # 
-      # @return [Google::APIClient::Result] 
+      #
+      # @return [Google::APIClient::Result]
       #   result of API request
       def send(connection)
-        http_response = connection.app.call(self.to_env(connection))        
+        env = self.to_env(connection)
+        logger.debug  { "#{self.class} Sending API request #{env[:method]} #{env[:url].to_s} #{env[:request_headers]}" }
+        http_response = connection.app.call(env)
         result = self.process_http_response(http_response)
-        
+
+        logger.debug { "#{self.class} Result: #{result.status} #{result.headers}" }
+
         # Resumamble slightly different than other upload protocols in that it requires at least
         # 2 requests.
         if self.upload_type == 'resumable'
           upload =  result.resumable_upload
           unless upload.complete?
+            logger.debug { "#{self.class} Sending upload body" }
             result = upload.send(connection)
           end
         end
         return result
       end
-      
+
       # Convert to an HTTP request. Returns components in order of method, URI,
       # request headers, and body
       #
@@ -172,7 +180,7 @@ module Google
       #
       # @return [Array<(Symbol, Addressable::URI, Hash, [#read,#to_str])>]
       def to_http_request
-        request = ( 
+        request = (
           if self.uri
             unless self.parameters.empty?
               self.uri.query = Addressable::URI.form_encode(self.parameters)
@@ -204,7 +212,7 @@ module Google
         end
         return options
       end
-      
+
       ##
       # Prepares the request for execution, building a hash of parts
       # suitable for sending to Faraday::Connection.
@@ -233,7 +241,7 @@ module Google
 
         request_env = http_request.to_env(connection)
       end
-      
+
       ##
       # Convert HTTP response to an API Result
       #
@@ -247,9 +255,9 @@ module Google
       def process_http_response(response)
         Result.new(self, response)
       end
-      
+
       protected
-      
+
       ##
       # Adjust headers & body for media uploads
       #
@@ -269,14 +277,14 @@ module Google
         self.media = options[:media]
         case self.upload_type
         when "media"
-          if options[:body] || options[:body_object] 
+          if options[:body] || options[:body_object]
             raise ArgumentError, "Can not specify body & body object for simple uploads"
           end
           self.headers['Content-Type'] ||= self.media.content_type
           self.body = self.media
         when "multipart"
-          unless options[:body_object] 
-            raise ArgumentError, "Multipart requested but no body object"              
+          unless options[:body_object]
+            raise ArgumentError, "Multipart requested but no body object"
           end
           metadata = StringIO.new(serialize_body(options[:body_object]))
           build_multipart([Faraday::UploadIO.new(metadata, 'application/json', 'file.json'), self.media])
@@ -286,13 +294,13 @@ module Google
           self.headers['X-Upload-Content-Length'] = file_length.to_s
           if options[:body_object]
             self.headers['Content-Type'] ||= 'application/json'
-            self.body = serialize_body(options[:body_object]) 
+            self.body = serialize_body(options[:body_object])
           else
             self.body = ''
           end
         end
       end
-      
+
       ##
       # Assemble a multipart message from a set of parts
       #
@@ -304,7 +312,7 @@ module Google
       #   MIME type of the message
       # @param [String] boundary
       #   Boundary for separating each part of the message
-      def build_multipart(parts, mime_type = 'multipart/related', boundary = MULTIPART_BOUNDARY) 
+      def build_multipart(parts, mime_type = 'multipart/related', boundary = MULTIPART_BOUNDARY)
         env = {
           :request_headers => {'Content-Type' => "#{mime_type};boundary=#{boundary}"},
           :request => { :boundary => boundary }
@@ -313,10 +321,10 @@ module Google
         self.body = multipart.create_multipart(env, parts.map {|part| [nil, part]})
         self.headers.update(env[:request_headers])
       end
-      
+
       ##
       # Serialize body object to JSON
-      # 
+      #
       # @api private
       #
       # @param [#to_json,#to_hash] body
@@ -326,7 +334,7 @@ module Google
       #   JSON
       def serialize_body(body)
         return body.to_json if body.respond_to?(:to_json)
-        return MultiJson.dump(options[:body_object].to_hash) if body.respond_to?(:to_hash)
+        return MultiJson.dump(body.to_hash) if body.respond_to?(:to_hash)
         raise TypeError, 'Could not convert body object to JSON.' +
                          'Must respond to :to_json or :to_hash.'
       end

data/lib/google/api_client/service_account.rb

@@ -14,3 +14,4 @@
 
 require 'google/api_client/auth/pkcs12'
 require 'google/api_client/auth/jwt_asserter'
+require 'google/api_client/auth/key_utils'

data/lib/google/api_client/version.rb

@@ -21,7 +21,7 @@ if !defined?(::Google::APIClient::VERSION)
     class APIClient
       module VERSION
         MAJOR = 0
-        MINOR = 5
+        MINOR = 6
         TINY  = 0
         STRING = [MAJOR, MINOR, TINY].join('.')
       end

data/spec/fixtures/files/secret.pem

@@ -0,0 +1,19 @@
+Bag Attributes
+    friendlyName: privatekey
+    localKeyID: 54 69 6D 65 20 31 33 35 31 38 38 38 31 37 38 36 39 36 
+Key Attributes: <No Attributes>
+-----BEGIN RSA PRIVATE KEY-----
+MIICXAIBAAKBgQDYDyPb3GhyFx5i/wxS/jFsO6wSLys1ehAk6QZoBXGlg7ETVrIJ
+HYh9gXQUno4tJiQoaO8wOvleIRrqI0LkiftCXKWVSrzOiV+O9GkKx1byw1yAIZus
+QdwMT7X0O9hrZLZwhICWC9s6cGhnlCVxLIP/+JkVK7hxEq/LxoSszNV77wIDAQAB
+AoGAa2G69L7quil7VMBmI6lqbtyJfNAsrXtpIq8eG/z4qsZ076ObAKTI/XeldcoH
+57CZL+xXVKU64umZMt0rleJuGXdlauEUbsSx+biGewRfGTgC4rUSjmE539rBvmRW
+gaKliorepPMp/+B9CcG/2YfDPRvG/2cgTXJHVvneo+xHL4ECQQD2Jx5Mvs8z7s2E
+jY1mkpRKqh4Z7rlitkAwe1NXcVC8hz5ASu7ORyTl8EPpKAfRMYl1ofK/ozT1URXf
+kL5nChPfAkEA4LPUJ6cqrY4xrrtdGaM4iGIxzen5aZlKz/YNlq5LuQKbnLLHMuXU
+ohp/ynpqNWbcAFbmtGSMayxGKW5+fJgZ8QJAUBOZv82zCmn9YcnK3juBEmkVMcp/
+dKVlbGAyVJgAc9RrY+78kQ6D6mmnLgpfwKYk2ae9mKo3aDbgrsIfrtWQcQJAfFGi
+CEpJp3orbLQG319ZsMM7MOTJdC42oPZOMFbAWFzkAX88DKHx0bn9h+XQizkccSej
+Ppz+v3DgZJ3YZ1Cz0QJBALiqIokZ+oa3AY6oT0aiec6txrGvNPPbwOsrBpFqGNbu
+AByzWWBoBi40eKMSIR30LqN9H8YnJ91Aoy1njGYyQaw=
+-----END RSA PRIVATE KEY-----

data/spec/google/api_client/batch_spec.rb

@@ -17,7 +17,7 @@ require 'google/api_client'
 require 'google/api_client/version'
 
 describe Google::APIClient::BatchRequest do
-  CLIENT = Google::APIClient.new unless defined?(CLIENT)
+  CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
 
   after do
     # Reset client to not-quite-pristine state

data/spec/google/api_client/discovery_spec.rb

@@ -43,7 +43,7 @@ end
 
 describe Google::APIClient do
   include ConnectionHelpers
-  CLIENT = Google::APIClient.new unless defined?(CLIENT)
+  CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
 
   after do
     # Reset client to not-quite-pristine state
@@ -53,7 +53,7 @@ describe Google::APIClient do
 
   it 'should raise a type error for bogus authorization' do
     (lambda do
-      Google::APIClient.new(:authorization => 42)
+      Google::APIClient.new(:application_name => 'API Client Tests', :authorization => 42)
     end).should raise_error(TypeError)
   end
 
@@ -214,6 +214,23 @@ describe Google::APIClient do
       conn.verify
     end
 
+    it 'should generate valid requests when parameter value includes semicolon' do
+      conn = stub_connection do |stub|
+        # semicolon (;) in parameter value was being converted to 
+        # bare ampersand (&) in 0.4.7. ensure that it gets converted 
+        # to a CGI-escaped semicolon (%3B) instead.
+        stub.post('/prediction/v1.2/training?data=12345%3B67890') do |env|
+          env[:body].should == ''
+        end
+      end
+      request = CLIENT.execute(
+        :api_method => @prediction.training.insert,
+        :parameters => {'data' => '12345;67890'},
+        :connection => conn
+      )
+      conn.verify
+    end
+
     it 'should generate valid requests when repeated parameters are passed' do
       pending("This is caused by Faraday's encoding of query parameters.")
       conn = stub_connection do |stub|
@@ -258,7 +275,7 @@ describe Google::APIClient do
     it 'should allow modification to the base URIs for testing purposes' do
       # Using a new client instance here to avoid caching rebased discovery doc
       prediction_rebase =
-        Google::APIClient.new.discovered_api('prediction', 'v1.2')
+        Google::APIClient.new(:application_name => 'API Client Tests').discovered_api('prediction', 'v1.2')
       prediction_rebase.method_base =
         'https://testing-domain.example.com/prediction/v1.2/'
 

data/spec/google/api_client/media_spec.rb

@@ -58,7 +58,7 @@ describe Google::APIClient::UploadIO do
 end
 
 describe Google::APIClient::ResumableUpload do
-  CLIENT ||= Google::APIClient.new
+  CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
 
   after do
     # Reset client to not-quite-pristine state

data/spec/google/api_client/result_spec.rb

@@ -18,7 +18,7 @@ require 'google/api_client'
 require 'google/api_client/version'
 
 describe Google::APIClient::Result do
-  CLIENT ||= Google::APIClient.new
+  CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
 
   describe 'with the plus API' do
     before do

data/spec/google/api_client/service_account_spec.rb

@@ -16,6 +16,39 @@ require 'spec_helper'
 
 require 'google/api_client'
 
+fixtures_path = File.expand_path('../../../fixtures', __FILE__)
+
+describe Google::APIClient::KeyUtils do  
+  it 'should read PKCS12 files from the filesystem' do
+    pending "Reading from PKCS12 not supported on jruby" if RUBY_PLATFORM == 'java'
+    path =  File.expand_path('files/privatekey.p12', fixtures_path)
+    key = Google::APIClient::KeyUtils.load_from_pkcs12(path, 'notasecret')
+    key.should_not == nil
+  end
+
+  it 'should read PKCS12 files from loaded files' do
+    pending "Reading from PKCS12 not supported on jruby" if RUBY_PLATFORM == 'java'
+    path =  File.expand_path('files/privatekey.p12', fixtures_path)
+    content = File.read(path)
+    key = Google::APIClient::KeyUtils.load_from_pkcs12(content, 'notasecret')
+    key.should_not == nil
+  end
+
+  it 'should read PEM files from the filesystem' do
+    path =  File.expand_path('files/secret.pem', fixtures_path)
+    key = Google::APIClient::KeyUtils.load_from_pem(path, 'notasecret')
+    key.should_not == nil
+  end
+
+  it 'should read PEM files from loaded files' do
+    path =  File.expand_path('files/secret.pem', fixtures_path)
+    content = File.read(path)
+    key = Google::APIClient::KeyUtils.load_from_pem(content, 'notasecret')
+    key.should_not == nil
+  end
+
+end
+
 describe Google::APIClient::JWTAsserter do
   include ConnectionHelpers
 
@@ -25,7 +58,7 @@ describe Google::APIClient::JWTAsserter do
 
   it 'should generate valid JWTs' do
     asserter = Google::APIClient::JWTAsserter.new('client1', 'scope1 scope2', @key)
-    jwt = asserter.to_jwt
+    jwt = asserter.to_authorization.to_jwt
     jwt.should_not == nil
 
     claim = JWT.decode(jwt, @key.public_key, true)

data/spec/google/api_client_spec.rb

@@ -59,7 +59,7 @@ end
 describe Google::APIClient do
   include ConnectionHelpers
 
-  let(:client) { Google::APIClient.new }
+  let(:client) { Google::APIClient.new(:application_name => 'API Client Tests') }
 
   it 'should make its version number available' do
     Google::APIClient::VERSION::STRING.should be_instance_of(String)

data/tasks/gem.rake

@@ -24,11 +24,11 @@ namespace :gem do
     s.rdoc_options.concat ['--main',  'README.md']
 
     # Dependencies used in the main library
-    s.add_runtime_dependency('signet', '>= 0.4.1')
+    s.add_runtime_dependency('signet', '>= 0.4.4')
     s.add_runtime_dependency('addressable', '>= 2.3.2')
     s.add_runtime_dependency('uuidtools', '>= 2.1.0')
     s.add_runtime_dependency('autoparse', '>= 0.3.2')
-    s.add_runtime_dependency('faraday', '~> 0.8.1')
+    s.add_runtime_dependency('faraday', '~> 0.8.4')
     s.add_runtime_dependency('multi_json', '>= 1.0.0')
     s.add_runtime_dependency('extlib', '>= 0.9.15')
     s.add_runtime_dependency('jwt', '>= 0.1.5')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-api-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000Z
+date: 2013-01-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: signet
-  requirement: &70253195775940 !ruby/object:Gem::Requirement
+  requirement: &70149072361020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.4
   type: :runtime
   prerelease: false
-  version_requirements: *70253195775940
+  version_requirements: *70149072361020
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70253195774000 !ruby/object:Gem::Requirement
+  requirement: &70149072360300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 2.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *70253195774000
+  version_requirements: *70149072360300
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &70253195765900 !ruby/object:Gem::Requirement
+  requirement: &70149072359760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70253195765900
+  version_requirements: *70149072359760
 - !ruby/object:Gem::Dependency
   name: autoparse
-  requirement: &70253195764740 !ruby/object:Gem::Requirement
+  requirement: &70149072359200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,21 +55,21 @@ dependencies:
         version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *70253195764740
+  version_requirements: *70149072359200
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70253195763760 !ruby/object:Gem::Requirement
+  requirement: &70149072358480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *70253195763760
+  version_requirements: *70149072358480
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70253195762140 !ruby/object:Gem::Requirement
+  requirement: &70149072357900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70253195762140
+  version_requirements: *70149072357900
 - !ruby/object:Gem::Dependency
   name: extlib
-  requirement: &70253195760160 !ruby/object:Gem::Requirement
+  requirement: &70149072357260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: 0.9.15
   type: :runtime
   prerelease: false
-  version_requirements: *70253195760160
+  version_requirements: *70149072357260
 - !ruby/object:Gem::Dependency
   name: jwt
-  requirement: &70253195750640 !ruby/object:Gem::Requirement
+  requirement: &70149072356600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: 0.1.5
   type: :runtime
   prerelease: false
-  version_requirements: *70253195750640
+  version_requirements: *70149072356600
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &70253195745420 !ruby/object:Gem::Requirement
+  requirement: &70149072356100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70253195745420
+  version_requirements: *70149072356100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70253195733560 !ruby/object:Gem::Requirement
+  requirement: &70149072355480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70253195733560
+  version_requirements: *70149072355480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70253195725940 !ruby/object:Gem::Requirement
+  requirement: &70149072354900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,7 +132,7 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70253195725940
+  version_requirements: *70149072354900
 description: ! 'The Google API Ruby Client makes it trivial to discover and access
   supported
 
@@ -147,27 +147,33 @@ extra_rdoc_files:
 - README.md
 files:
 - lib/compat/multi_json.rb
+- lib/google/api_client.rb
+- lib/google/api_client/auth/installed_app.rb
 - lib/google/api_client/auth/jwt_asserter.rb
+- lib/google/api_client/auth/key_utils.rb
 - lib/google/api_client/auth/pkcs12.rb
 - lib/google/api_client/batch.rb
 - lib/google/api_client/client_secrets.rb
+- lib/google/api_client/discovery.rb
 - lib/google/api_client/discovery/api.rb
 - lib/google/api_client/discovery/media.rb
 - lib/google/api_client/discovery/method.rb
 - lib/google/api_client/discovery/resource.rb
 - lib/google/api_client/discovery/schema.rb
-- lib/google/api_client/discovery.rb
 - lib/google/api_client/environment.rb
 - lib/google/api_client/errors.rb
+- lib/google/api_client/logging.rb
 - lib/google/api_client/media.rb
+- lib/google/api_client/railtie.rb
 - lib/google/api_client/reference.rb
 - lib/google/api_client/request.rb
 - lib/google/api_client/result.rb
 - lib/google/api_client/service_account.rb
 - lib/google/api_client/version.rb
-- lib/google/api_client.rb
 - lib/google/inflection.rb
+- spec/fixtures/files/privatekey.p12
 - spec/fixtures/files/sample.txt
+- spec/fixtures/files/secret.pem
 - spec/google/api_client/batch_spec.rb
 - spec/google/api_client/discovery_spec.rb
 - spec/google/api_client/media_spec.rb
@@ -183,10 +189,9 @@ files:
 - tasks/yard.rake
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
-- Rakefile
 - README.md
+- Rakefile
 - bin/google-api
 homepage: http://code.google.com/p/google-api-ruby-client/
 licenses: []