google-ads-common 0.6.0 → 0.6.1

data/ChangeLog

@@ -1,3 +1,8 @@
+0.6.1:
+  - Support for GZip compression.
+  - Added logging of the response HTTP headers.
+  - Updated minimal requirement for httpclient (~>2.2.3) and httpi (~>0.9.3).
+
 0.6.0:
   - Better namespace handling in complex cases.
   - Large refactoring on parameter processing code.

data/README

@@ -18,8 +18,9 @@ Install it using the gem install command.
 
 The following gem libraries are required:
  - savon v0.9.7;
- - httpi v0.9.2 or greater;
- - httpclient v2.1.6 or greater.
+ - httpi v0.9.3 or greater;
+ - httpclient v2.2.3 or greater.
+ - psych-1.2.2 or greater (for ruby-1.9.2 and later only).
 
 = Docs for Developers
 

data/Rakefile

@@ -48,8 +48,8 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc = true
   s.extra_rdoc_files = docs
   s.add_dependency('savon', '= 0.9.7')
-  s.add_dependency('httpclient', '>= 2.1.6')
-  s.add_dependency('httpi', '~> 0.9.2')
+  s.add_dependency('httpclient', '~> 2.2.3')
+  s.add_dependency('httpi', '~> 0.9.3')
   s.add_dependency('oauth', '~> 0.4.5')
 end
 

data/lib/ads_common/api_config.rb

@@ -26,7 +26,7 @@ module AdsCommon
   # Contains helper methods for loading and managing the available services.
   # This module is meant to be imported into API-specific modules.
   module ApiConfig
-    ADS_COMMON_VERSION = '0.6.0'
+    ADS_COMMON_VERSION = '0.6.1'
 
     # Get the available API versions.
     #

data/lib/ads_common/auth/oauth_handler.rb

@@ -117,8 +117,11 @@ module AdsCommon
       # - Authentication string
       #
       def generate_oauth_parameters_string(credentials, request)
-        oauth_params = {:consumer => @consumer,
-                        :token => get_token(credentials)}
+        oauth_params = {
+            # get_token() ensures @consumer is initialized.
+            :token => get_token(credentials),
+            :consumer => @consumer
+        }
         oauth_helper = OAuth::Client::Helper.new(request, oauth_params)
         return oauth_helper.header
       end

data/lib/ads_common/config.rb

@@ -21,6 +21,7 @@
 # rewrite it in memory.
 
 require 'rubygems'
+require 'psych' if RUBY_VERSION >= "1.9.2"
 require 'yaml'
 
 module AdsCommon

data/lib/ads_common/credential_handler.rb

@@ -58,6 +58,13 @@ module AdsCommon
       @auth_handler.property_changed(credential, value) if @auth_handler
     end
 
+    # Returns current configuration.
+    # TODO: we need better way to access config widely,
+    #       remove after refactoring.
+    def get_config()
+      return @config
+    end
+
     private
 
     # Loads the credentials from the config data.

data/lib/ads_common/parameters_validator.rb

@@ -103,7 +103,7 @@ module AdsCommon
       # An array passed when an object is expected.
       if (field[:max_occurs] == 1) and arg.kind_of?(Array)
         raise AdsCommon::Errors::TypeMismatchError.new(
-            field[:type], Array)
+            field[:type], Array, field[:name])
       end
     end
 

data/lib/ads_common/savon_headers/base_header_handler.rb

@@ -43,6 +43,7 @@ module AdsCommon
         @element_name = element_name
         @namespace = namespace
         @version = version
+        @config = credential_handler.get_config
         Savon.configure {|config| config.raise_errors = false}
       end
 
@@ -88,9 +89,11 @@ module AdsCommon
         app_name = credentials[:userAgent] || credentials[:useragent]
         # We don't know the library version here. A breaking change needs to be
         # introduced. This is scheduled for 0.7.0, using Common version for now.
-        lib_version = '0.6.0'
+        lib_version = '0.6.1'
         soap_user_agent = "Common-Ruby-%s; %s" % [lib_version, app_name]
-        return "Savon/%s (%s)" % [Savon::Version, soap_user_agent]
+        user_agent = "Savon/%s (%s)" % [Savon::Version, soap_user_agent]
+        user_agent += ' (gzip)' if @config.read('connection.enable_gzip', false)
+        return user_agent
       end
     end
   end

data/lib/ads_common/savon_service.rb

@@ -69,11 +69,13 @@ module AdsCommon
     # Creates and sets up Savon client.
     def create_savon_client(endpoint, namespace)
       proxy = @api.config.read('connection.proxy')
+      enable_gzip = @api.config.read('connection.enable_gzip', false)
       client = Savon::Client.new do |wsdl, http|
         wsdl.endpoint = endpoint
         wsdl.namespace = namespace
-        http.proxy = proxy if !proxy.nil?
         http.read_timeout = HTTP_READ_TIMEOUT
+        http.proxy = proxy if proxy
+        http.gzip if enable_gzip
       end
       return client
     end
@@ -84,10 +86,16 @@ module AdsCommon
       args = validator.validate_args(action_name, args)
       response = execute_soap_request(
           action_name.to_sym, args, validator.extra_namespaces)
+      log_headers(response.http.headers)
       handle_errors(response)
       return extract_result(response, action_name, &block)
     end
 
+    # Logs response headers.
+    def log_headers(headers)
+      @api.logger.debug(headers.map {|k, v| [k, v].join(': ')}.join(', '))
+    end
+
     # Executes the SOAP request with original SOAP name.
     def execute_soap_request(action, args, extra_namespaces)
       original_action_name =

data/test/test_parameters_validator.rb

@@ -22,11 +22,13 @@
 require 'rubygems'
 require 'test/unit'
 
+require 'ads_common/errors'
 require 'ads_common/parameters_validator'
 
 module AdsCommon
   class ParametersValidator
     public :deep_copy, :add_attribute, :array_from_named_list
+    public :check_required_argument_present
   end
 end
 
@@ -100,4 +102,31 @@ class TestParametersValidator < Test::Unit::TestCase
     result = @validator.array_from_named_list(src)
     assert_equal(['foo', 'bar', 'ipsum'], result)
   end
+
+  def test_check_required_argument_present
+    field1 = {:min_occurs => 1, :max_occurs => 1,
+              :name => 'field1', :type => 'type1'}
+    assert_raises(AdsCommon::Errors::MissingPropertyError) do
+      @validator.check_required_argument_present(nil, field1)
+    end
+    assert_raises(AdsCommon::Errors::TypeMismatchError) do
+      @validator.check_required_argument_present([], field1)
+    end
+    assert_nothing_raised do
+      @validator.check_required_argument_present({}, field1)
+      @validator.check_required_argument_present('foobar', field1)
+      @validator.check_required_argument_present(42, field1)
+    end
+
+    field2 = {:min_occurs => 0, :max_occurs => :unbounded,
+              :name => 'field2', :type => 'type2'}
+    assert_raises(AdsCommon::Errors::TypeMismatchError) do
+      @validator.check_required_argument_present({}, field2)
+    end
+    assert_nothing_raised do
+      @validator.check_required_argument_present(nil, field2)
+      @validator.check_required_argument_present([], field2)
+      @validator.check_required_argument_present([field1, field2], field2)
+    end
+  end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-ads-common
 version: !ruby/object:Gem::Version 
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Sergio Gomes
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-02 00:00:00 +04:00
+date: 2011-12-23 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,6 +27,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 53
         segments: 
         - 0
         - 9
@@ -39,13 +41,14 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 2
-        - 1
-        - 6
-        version: 2.1.6
+        - 2
+        - 3
+        version: 2.2.3
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -56,11 +59,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 61
         segments: 
         - 0
         - 9
-        - 2
-        version: 0.9.2
+        - 3
+        version: 0.9.3
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -71,6 +75,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 5
         segments: 
         - 0
         - 4
@@ -130,6 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -138,6 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"