google-api-client 0.3.0 → 0.4.0

data/lib/google/api_client/discovery/api.rb

@@ -19,6 +19,7 @@ require 'google/inflection'
 require 'google/api_client/discovery/resource'
 require 'google/api_client/discovery/method'
 
+
 module Google
   class APIClient
     ##

data/lib/google/api_client/discovery/method.rb

@@ -18,6 +18,7 @@ require 'addressable/template'
 
 require 'google/api_client/errors'
 
+
 module Google
   class APIClient
     ##
@@ -139,16 +140,14 @@ module Google
       def normalize_parameters(parameters={})
         # Convert keys to Strings when appropriate
         if parameters.kind_of?(Hash) || parameters.kind_of?(Array)
-          # Is a Hash or an Array a better return type?  Do we ever need to
-          # worry about the same parameter being sent twice with different
-          # values?
-          parameters = parameters.inject({}) do |accu, (k, v)|
+          # Returning an array since parameters can be repeated (ie, Adsense Management API)
+          parameters = parameters.inject([]) do |accu, (k, v)|
             k = k.to_s if k.kind_of?(Symbol)
             k = k.to_str if k.respond_to?(:to_str)
             unless k.kind_of?(String)
               raise TypeError, "Expected String, got #{k.class}."
             end
-            accu[k] = v
+            accu << [k,v]
             accu
           end
         else
@@ -174,7 +173,7 @@ module Google
           template_variables.include?(k)
         end
         if query_parameters.size > 0
-          uri.query_values = (uri.query_values || {}).merge(query_parameters)
+          uri.query_values = (uri.query_values || []) + query_parameters
         end
         # Normalization is necessary because of undesirable percent-escaping
         # during URI template expansion
@@ -204,7 +203,11 @@ module Google
         method = self.http_method
         uri = self.generate_uri(parameters)
         headers = headers.to_a if headers.kind_of?(Hash)
-        return [method, uri.to_str, headers, [body]]
+        return Faraday::Request.create(method.to_s.downcase.to_sym) do |req|
+          req.url(Addressable::URI.parse(uri))
+          req.headers = Faraday::Utils::Headers.new(headers)
+          req.body = body
+        end
       end
 
       ##
@@ -271,7 +274,7 @@ module Google
         required_variables = ((self.parameter_descriptions.select do |k, v|
           v['required']
         end).inject({}) { |h,(k,v)| h[k]=v; h }).keys
-        missing_variables = required_variables - parameters.keys
+        missing_variables = required_variables - parameters.map(&:first)
         if missing_variables.size > 0
           raise ArgumentError,
             "Missing required parameters: #{missing_variables.join(', ')}."

data/lib/google/api_client/discovery/resource.rb

@@ -18,6 +18,7 @@ require 'addressable/uri'
 require 'google/inflection'
 require 'google/api_client/discovery/method'
 
+
 module Google
   class APIClient
     ##

data/lib/google/api_client/discovery/schema.rb

@@ -14,7 +14,7 @@
 
 
 require 'time'
-require 'json'
+require 'multi_json'
 require 'base64'
 require 'autoparse'
 require 'addressable/uri'
@@ -23,6 +23,7 @@ require 'addressable/template'
 require 'google/inflection'
 require 'google/api_client/errors'
 
+
 module Google
   class APIClient
     module Schema

data/lib/google/api_client/environment.rb

@@ -1,3 +1,18 @@
+# Copyright 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.
+
+
 module Google
   class APIClient
     module ENV

data/lib/google/api_client/reference.rb

@@ -12,11 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'stringio'
-require 'json'
+
+gem 'faraday', '~> 0.7.0'
+require 'faraday'
+require 'faraday/utils'
+require 'multi_json'
 require 'addressable/uri'
+require 'stringio'
 require 'google/api_client/discovery'
 
+
 module Google
   class APIClient
     class Reference
@@ -27,6 +32,7 @@ module Google
         @client = options[:client]
         @version = options[:version] || 'v1'
 
+        self.connection = options[:connection] || Faraday.default_connection
         self.api_method = options[:api_method]
         self.parameters = options[:parameters] || {}
         # These parameters are handled differently because they're not
@@ -36,21 +42,19 @@ module Google
         self.headers = options[:headers] || []
         if options[:body]
           self.body = options[:body]
-        elsif options[:merged_body]
-          self.merged_body = options[:merged_body]
         elsif options[:body_object]
           if options[:body_object].respond_to?(:to_json)
             serialized_body = options[:body_object].to_json
           elsif options[:body_object].respond_to?(:to_hash)
-            serialized_body = JSON.generate(options[:body_object].to_hash)
+            serialized_body = MultiJson.encode(options[:body_object].to_hash)
           else
             raise TypeError,
               'Could not convert body object to JSON.' +
               'Must respond to :to_json or :to_hash.'
           end
-          self.merged_body = serialized_body
+          self.body = serialized_body
         else
-          self.merged_body = ''
+          self.body = ''
         end
         unless self.api_method
           self.http_method = options[:http_method] || 'GET'
@@ -62,6 +66,19 @@ module Google
         end
       end
 
+      def connection
+        return @connection
+      end
+
+      def connection=(new_connection)
+        if new_connection.kind_of?(Faraday::Connection)
+          @connection = new_connection
+        else
+          raise TypeError,
+            "Expected Faraday::Connection, got #{new_connection.class}."
+        end
+      end
+
       def api_method
         return @api_method
       end
@@ -113,32 +130,18 @@ module Google
       end
 
       def body=(new_body)
-        if new_body.respond_to?(:each)
-          @body = new_body
+        if new_body.respond_to?(:to_str)
+          @body = new_body.to_str
+        elsif new_body.respond_to?(:inject)
+          @body = (new_body.inject(StringIO.new) do |accu, chunk|
+            accu.write(chunk)
+            accu
+          end).string
         else
-          raise TypeError, "Expected body to respond to :each."
+          raise TypeError, "Expected body to be String or Enumerable chunks."
         end
       end
 
-      def merged_body
-        return (self.body.inject(StringIO.new) do |accu, chunk|
-          accu.write(chunk)
-          accu
-        end).string
-      end
-
-      def merged_body=(new_merged_body)
-        if new_merged_body.respond_to?(:string)
-          new_merged_body = new_merged_body.string
-        elsif new_merged_body.respond_to?(:to_str)
-          new_merged_body = new_merged_body.to_str
-        else
-          raise TypeError,
-            "Expected String or StringIO, got #{new_merged_body.class}."
-        end
-        self.body = [new_merged_body]
-      end
-
       def headers
         return @headers ||= []
       end
@@ -177,10 +180,16 @@ module Google
       def to_request
         if self.api_method
           return self.api_method.generate_request(
-            self.parameters, self.merged_body, self.headers
+            self.parameters, self.body, self.headers
           )
         else
-          return [self.http_method, self.uri, self.headers, self.body]
+          return Faraday::Request.create(
+            self.http_method.to_s.downcase.to_sym
+          ) do |req|
+            req.url(Addressable::URI.parse(self.uri))
+            req.headers = Faraday::Utils::Headers.new(self.headers)
+            req.body = self.body
+          end
         end
       end
 
@@ -195,6 +204,7 @@ module Google
         end
         options[:headers] = self.headers
         options[:body] = self.body
+        options[:connection] = self.connection
         return options
       end
     end

data/lib/google/api_client/result.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Google
   class APIClient
     ##
@@ -30,21 +31,15 @@ module Google
       attr_reader :response
 
       def status
-        return @response[0]
+        return @response.status
       end
 
       def headers
-        return @response[1]
+        return @response.headers
       end
 
       def body
-        return @body ||= (begin
-          response_body = @response[2]
-          merged_body = (response_body.inject(StringIO.new) do |accu, chunk|
-            accu.write(chunk)
-            accu
-          end).string
-        end)
+        return @response.body
       end
 
       def data
@@ -56,7 +51,7 @@ module Google
           data = self.body
           case media_type
           when 'application/json'
-            data = ::JSON.parse(data)
+            data = MultiJson.decode(data)
             # Strip data wrapper, if present
             data = data['data'] if data.has_key?('data')
           else

data/lib/google/api_client/version.rb

@@ -15,11 +15,13 @@
 
 # Used to prevent the class/module from being loaded more than once
 if !defined?(::Google::APIClient::VERSION)
+
+
   module Google
     class APIClient
       module VERSION
         MAJOR = 0
-        MINOR = 3
+        MINOR = 4
         TINY  = 0
 
         STRING = [MAJOR, MINOR, TINY].join('.')

data/spec/google/api_client/discovery_spec.rb

@@ -14,9 +14,13 @@
 
 require 'spec_helper'
 
-require 'json'
+gem 'faraday', '~> 0.7.0'
+require 'faraday'
+require 'faraday/utils'
+require 'multi_json'
+
+gem 'signet', '~> 0.3.0'
 require 'signet/oauth_1/client'
-require 'httpadapter/adapters/net_http'
 
 require 'google/api_client'
 require 'google/api_client/version'
@@ -84,8 +88,7 @@ describe Google::APIClient do
         :uri => @client.discovery_uri('prediction', 'v1.2'),
         :authenticated => false
       )
-      http_method, uri, headers, body = request
-      uri.should === (
+      request.to_env(Faraday.default_connection)[:url].should === (
         'https://www.googleapis.com/discovery/v1/apis/prediction/v1.2/rest' +
         '?userIp=127.0.0.1'
       )
@@ -98,8 +101,7 @@ describe Google::APIClient do
         :uri => @client.discovery_uri('prediction', 'v1.2'),
         :authenticated => false
       )
-      http_method, uri, headers, body = request
-      uri.should === (
+      request.to_env(Faraday.default_connection)[:url].should === (
         'https://www.googleapis.com/discovery/v1/apis/prediction/v1.2/rest' +
         '?key=qwerty'
       )
@@ -113,11 +115,10 @@ describe Google::APIClient do
         :uri => @client.discovery_uri('prediction', 'v1.2'),
         :authenticated => false
       )
-      http_method, uri, headers, body = request
-      uri.should === (
-        'https://www.googleapis.com/discovery/v1/apis/prediction/v1.2/rest' +
-        '?key=qwerty&userIp=127.0.0.1'
-      )
+      request.to_env(Faraday.default_connection)[:url].query_values.should == {
+        'key' => 'qwerty',
+        'userIp' => '127.0.0.1'
+      }
     end
 
     it 'should correctly generate API objects' do
@@ -167,12 +168,21 @@ describe Google::APIClient do
         :api_method => @prediction.training.insert,
         :parameters => {'data' => '12345', }
       )
-      method, uri, headers, body = request
-      method.should == 'POST'
-      uri.should ==
+      request.method.should == :post
+      request.to_env(Faraday.default_connection)[:url].should ===
         'https://www.googleapis.com/prediction/v1.2/training?data=12345'
-      (headers.inject({}) { |h,(k,v)| h[k]=v; h }).should == {}
-      body.should respond_to(:each)
+      request.headers.should be_empty
+      request.body.should == ''
+    end
+
+    it 'should generate valid requests when repeated parameters are passed' do
+      request = @client.generate_request(
+        :api_method => @prediction.training.insert,
+        :parameters => [['data', '1'],['data','2']]
+      )
+      request.method.should == :post
+      request.to_env(Faraday.default_connection)[:url].should ===
+        'https://www.googleapis.com/prediction/v1.2/training?data=1&data=2'
     end
 
     it 'should generate requests against the correct URIs' do
@@ -180,8 +190,7 @@ describe Google::APIClient do
         :api_method => @prediction.training.insert,
         :parameters => {'data' => '12345'}
       )
-      method, uri, headers, body = request
-      uri.should ==
+      request.to_env(Faraday.default_connection)[:url].should ===
         'https://www.googleapis.com/prediction/v1.2/training?data=12345'
     end
 
@@ -190,8 +199,7 @@ describe Google::APIClient do
         :api_method => @prediction.training.insert,
         :parameters => {'data' => '12345'}
       )
-      method, uri, headers, body = request
-      uri.should ==
+      request.to_env(Faraday.default_connection)[:url].should ===
         'https://www.googleapis.com/prediction/v1.2/training?data=12345'
     end
 
@@ -203,8 +211,7 @@ describe Google::APIClient do
         :api_method => prediction.training.insert,
         :parameters => {'data' => '123'}
       )
-      method, uri, headers, body = request
-      uri.should == (
+      request.to_env(Faraday.default_connection)[:url].should === (
         'https://testing-domain.googleapis.com/' +
         'prediction/v1.2/training?data=123'
       )
@@ -218,10 +225,8 @@ describe Google::APIClient do
         :api_method => @prediction.training.insert,
         :parameters => {'data' => '12345'}
       )
-      method, uri, headers, body = request
-      headers = headers.inject({}) { |h,(k,v)| h[k]=v; h }
-      headers.keys.should include('Authorization')
-      headers['Authorization'].should =~ /^OAuth/
+      request.headers.should have_key('Authorization')
+      request.headers['Authorization'].should =~ /^OAuth/
     end
 
     it 'should generate OAuth 2 requests' do
@@ -231,10 +236,8 @@ describe Google::APIClient do
         :api_method => @prediction.training.insert,
         :parameters => {'data' => '12345'}
       )
-      method, uri, headers, body = request
-      headers = headers.inject({}) { |h,(k,v)| h[k]=v; h }
-      headers.keys.should include('Authorization')
-      headers['Authorization'].should =~ /^OAuth/
+      request.headers.should have_key('Authorization')
+      request.headers['Authorization'].should =~ /^Bearer/
     end
 
     it 'should not be able to execute improperly authorized requests' do
@@ -245,8 +248,7 @@ describe Google::APIClient do
         @prediction.training.insert,
         {'data' => '12345'}
       )
-      status, headers, body = result.response
-      status.should == 401
+      result.response.status.should == 401
     end
 
     it 'should not be able to execute improperly authorized requests' do
@@ -256,8 +258,7 @@ describe Google::APIClient do
         @prediction.training.insert,
         {'data' => '12345'}
       )
-      status, headers, body = result.response
-      status.should == 401
+      result.response.status.should == 401
     end
 
     it 'should not be able to execute improperly authorized requests' do
@@ -289,11 +290,10 @@ describe Google::APIClient do
       result = @client.execute(
         @prediction.training.insert,
         {},
-        JSON.generate({"id" => "bucket/object"}),
+        MultiJson.encode({"id" => "bucket/object"}),
         {'Content-Type' => 'application/json'}
       )
-      method, uri, headers, body = result.request
-      Hash[headers]['Content-Type'].should == 'application/json'
+      result.request.headers['Content-Type'].should == 'application/json'
     end
   end
 
@@ -334,8 +334,7 @@ describe Google::APIClient do
         },
         :authenticated => false
       )
-      method, uri, headers, body = request
-      uri.should == (
+      request.to_env(Faraday.default_connection)[:url].should === (
         'https://www.googleapis.com/plus/v1/' +
         'people/107807692475771887386/activities/public'
       )
@@ -395,8 +394,7 @@ describe Google::APIClient do
         :api_method => 'latitude.currentLocation.get',
         :authenticated => false
       )
-      method, uri, headers, body = request
-      uri.should ==
+      request.to_env(Faraday.default_connection)[:url].should ===
         'https://www.googleapis.com/latitude/v1/currentLocation'
     end
 
@@ -405,8 +403,7 @@ describe Google::APIClient do
         :api_method => @latitude.current_location.get,
         :authenticated => false
       )
-      method, uri, headers, body = request
-      uri.should ==
+      request.to_env(Faraday.default_connection)[:url].should ===
         'https://www.googleapis.com/latitude/v1/currentLocation'
     end
 
@@ -415,8 +412,7 @@ describe Google::APIClient do
         :api_method => 'latitude.currentLocation.get',
         :authenticated => false
       )
-      status, headers, body = result.response
-      status.should == 401
+      result.response.status.should == 401
     end
   end
 
@@ -451,8 +447,7 @@ describe Google::APIClient do
         :api_method => 'moderator.profiles.get',
         :authenticated => false
       )
-      method, uri, headers, body = request
-      uri.should ==
+      request.to_env(Faraday.default_connection)[:url].should ===
         'https://www.googleapis.com/moderator/v1/profiles/@me'
     end
 
@@ -461,8 +456,7 @@ describe Google::APIClient do
         :api_method => @moderator.profiles.get,
         :authenticated => false
       )
-      method, uri, headers, body = request
-      uri.should ==
+      request.to_env(Faraday.default_connection)[:url].should ===
         'https://www.googleapis.com/moderator/v1/profiles/@me'
     end
 
@@ -474,8 +468,7 @@ describe Google::APIClient do
         [],
         {:authenticated => false}
       )
-      status, headers, body = result.response
-      status.should == 401
+      result.response.status.should == 401
     end
   end
 end