google-ads-common 0.7.0 → 0.7.1

data/ChangeLog

@@ -1,3 +1,6 @@
+0.7.1:
+  - Fixed issues #63, #73, #74.
+
 0.7.0:
   - Cleaned up unused features.
   - Now require HTTPI 0.9.7 (fixes issue #61).

data/lib/ads_common/api.rb

@@ -150,7 +150,7 @@ module AdsCommon
       unless api_config.version_has_service(version, service)
         raise AdsCommon::Errors::Error,
             "Version '%s' does not contain service '%s'" %
-            [version.to_s, name.to_s]
+            [version.to_s, service.to_s]
       end
     end
 

data/lib/ads_common/api_config.rb

@@ -123,7 +123,7 @@ module AdsCommon
     #
     def endpoint(environment, version, service)
       base = get_wsdl_base(environment, version)
-      # TODO(dklimkin): Unflatten subdir constants. Cross-API refactor 0.7.0.
+      # TODO(dklimkin): Unflatten subdir constants. Cross-API refactor 0.8.0.
       if !subdir_config().nil?
         base = base.to_s + subdir_config()[[version, service]].to_s
       end
@@ -141,7 +141,7 @@ module AdsCommon
     #
     def subdir(version, service)
       return nil if subdir_config().nil?
-      # TODO(dklimkin): Unflatten subdir constants. Cross-API refactor 0.7.0.
+      # TODO(dklimkin): Unflatten subdir constants. Cross-API refactor 0.8.0.
       subdir_config()[[version, service]]
     end
 

data/lib/ads_common/build/savon_registry.rb

@@ -150,6 +150,10 @@ module AdsCommon
             'sequence | complexContent/extension/sequence') do |seq_node|
           type[:fields] += get_element_fields(seq_node)
         end
+        REXML::XPath.each(type_element, 'choice') do |seq_node|
+          type[:choices] ||= []
+          type[:choices] += get_element_fields(seq_node)
+        end
         return type
       end
 

data/lib/ads_common/credential_handler.rb

@@ -68,27 +68,30 @@ module AdsCommon
     end
 
     # Generates string for UserAgent to put into HTTP headers.
-    def generate_http_user_agent()
-      agent_data = []
-      agent_data << HTTPI::Adapter.use.to_s
-      ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
-      agent_data << [ruby_engine, RUBY_VERSION].join('/')
-      agent_data << (credentials[:user_agent] || $0)
-      user_agent = "HTTPI/%s (%s)" % [HTTPI::VERSION, agent_data.join(', ')]
-      return user_agent
+    def generate_http_user_agent(extra_ids = [], agent_app = nil)
+      return generate_user_agent(extra_ids, agent_app)
     end
 
     # Generates string for UserAgent to put into SOAP headers.
-    def generate_soap_user_agent(extra_ids = [])
-      agent_data = extra_ids
-      agent_data << "Common-Ruby-%s" % AdsCommon::ApiConfig::CLIENT_LIB_VERSION
-      agent_data << (@credentials[:user_agent] || $0)
-      user_agent = "Savon/%s (%s)" % [Savon::Version, agent_data.join(', ')]
-      return user_agent
+    def generate_soap_user_agent(extra_ids = [], agent_app = nil)
+      return generate_user_agent(extra_ids, agent_app)
     end
 
     private
 
+    # Generates user-agent.
+    def generate_user_agent(extra_ids, agent_app)
+      agent_app ||= $0
+      agent_data = extra_ids
+      agent_data << "Common-Ruby/%s" % AdsCommon::ApiConfig::CLIENT_LIB_VERSION
+      agent_data << "Savon/%s" % Savon::Version
+      ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
+      agent_data << [ruby_engine, RUBY_VERSION].join('/')
+      agent_data << "HTTPI/%s" % HTTPI::VERSION
+      agent_data << HTTPI::Adapter.use.to_s
+      return "%s (%s)" % [agent_app, agent_data.join(', ')]
+    end
+
     # Loads the credentials from the config data.
     def load_from_config(config)
       @credentials = config.read('authentication')

data/lib/ads_common/results_extractor.rb

@@ -43,21 +43,17 @@ module AdsCommon
       return result
     end
 
-    private
-
     # Extracts misc data from response header.
     def extract_header_data(response)
       header_type = get_full_type_signature(:SoapResponseHeader)
       headers = response.header[:response_header].dup
       process_attributes(headers, false)
-      result = headers.inject({}) do |result, (key, v)|
-        normalize_output_field(headers, header_type[:fields], key)
-        result[key] = headers[key]
-        result
-      end
-      return result
+      headers = normalize_fields(headers, header_type[:fields])
+      return headers
     end
 
+    private
+
     # Normalizes output starting with root output node.
     def normalize_output(output_data, method_definition)
       fields = method_definition[:output][:fields]
@@ -104,20 +100,72 @@ module AdsCommon
     # Normalizes every item of a Hash.
     def normalize_hash_field(field, field_def)
       process_attributes(field, true)
-      field_type = determine_type(field, field_def[:type])
-      type_signature = get_full_type_signature(field_type)
-      # If we don't know the type, pass as-is.
-      return (type_signature.nil?) ?
-          field : normalize_fields(field, type_signature[:fields])
+      field_type = field_def[:type]
+      field_def = get_full_type_signature(field_type)
+
+      # First checking for xsi:type provided.
+      xsi_type_override = determine_xsi_type_override(field, field_def)
+      unless xsi_type_override.nil?
+        field_def = get_full_type_signature(xsi_type_override)
+        return (field_def.nil?) ? field :
+            normalize_fields(field, field_def[:fields])
+      end
+
+      # Now checking for choice options from wsdl.
+      choice_type_override = determine_choice_type_override(field, field_def)
+      unless choice_type_override.nil?
+        # For overrides we need to process sub-field and than return it
+        # in the original structure.
+        field_key = field.keys.first
+        field_data = field[field_key]
+        field_def = get_full_type_signature(choice_type_override)
+        if !field_def.nil? and field_data.kind_of?(Hash)
+          field_data = normalize_fields(field_data, field_def[:fields])
+        end
+        return {field_key => field_data}
+      end
+
+      # Otherwise using the best we have.
+      field = normalize_fields(field, field_def[:fields]) unless field_def.nil?
+
+      return field
     end
 
-    # Returns field type based on the field structure. Allows to override the
-    # type with custom xsi:type.
-    def determine_type(field_data, field_type)
+    # Determines an xsi:type override for for the field. Returns nil if no
+    # override found.
+    def determine_xsi_type_override(field_data, field_def)
+      result = nil
       if field_data.kind_of?(Hash) and field_data.include?(:xsi_type)
-        field_type = field_data[:xsi_type]
+        result = field_data[:xsi_type]
       end
-      return field_type
+      return result
+    end
+
+    # Determines a choice type override for for the field. Returns nil if no
+    # override found.
+    def determine_choice_type_override(field_data, field_def)
+      result = nil
+      if field_data.kind_of?(Hash) and field_def.include?(:choices)
+        result = determine_choice(field_data, field_def[:choices])
+      end
+      return result
+    end
+
+    # Finds the choice option matching data provided.
+    def determine_choice(field_data, field_choices)
+      result = nil
+      key_name = field_data.keys.first
+      unless key_name.nil?
+        choice = find_named_entry(field_choices, key_name)
+        result = choice[:type] unless choice.nil?
+      end
+      return result
+    end
+
+    # Finds an item in an Array based on its ':name' field.
+    def find_named_entry(data_array, name)
+      index = data_array.index {|item| name.eql?(item[:name])}
+      return index.nil? ? nil : data_array[index]
     end
 
     # Converts one leaf item to a built-in type.
@@ -154,7 +202,7 @@ module AdsCommon
       result = []
       if data_type[:base]
         parent_type = @registry.get_type_signature(data_type[:base])
-        result += implode_parent(parent_type)
+        result += implode_parent(parent_type) unless parent_type.nil?
       end
       data_type[:fields].each do |field|
         # If the parent type includes a field with the same name, overwrite it.

data/lib/ads_common/version.rb

@@ -21,6 +21,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.7.0'
+    CLIENT_LIB_VERSION = '0.7.1'
   end
 end

data/test/test_results_extractor.rb

@@ -33,6 +33,17 @@ module AdsCommon
 end
 
 class StubRegistry
+  def get_type_signature(type_name)
+    if type_name == :SoapResponseHeader
+      return {:fields => []}
+    else
+      return nil
+    end
+  end
+end
+
+class StubResponse
+  attr_accessor :header
 end
 
 class TestResultsExtractor < Test::Unit::TestCase
@@ -162,4 +173,31 @@ class TestResultsExtractor < Test::Unit::TestCase
         {}, {:min_occurs => '0', :max_occurs => :unbounded})
     assert_equal([{}], result7)
   end
+
+  def test_extract_headers_empty()
+    headers = {}
+    response = StubResponse.new()
+    response.header = {:response_header => headers}
+    result = @extractor.extract_header_data(response)
+    assert_equal(headers, result)
+    assert_not_same(headers, result)
+  end
+
+  def test_extract_headers_passthrough()
+    headers = {:a => 'aa', :b => '42'}
+    response = StubResponse.new()
+    response.header = {:response_header => headers}
+    result = @extractor.extract_header_data(response)
+    assert_equal(headers, result)
+    assert_not_same(headers, result)
+  end
+
+  def test_extract_headers_attrs_removed()
+    headers = {:a => 'aa', :@xmlns => '42'}
+    expected = {:a => 'aa'}
+    response = StubResponse.new()
+    response.header = {:response_header => headers}
+    result = @extractor.extract_header_data(response)
+    assert_equal(expected, result)
+  end
 end

metadata

@@ -1,171 +1,149 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: google-ads-common
-version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: false
-  segments: 
-  - 0
-  - 7
-  - 0
-  version: 0.7.0
+version: !ruby/object:Gem::Version
+  version: 0.7.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Sergio Gomes
 - Danial Klimkin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-15 00:00:00 +04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: savon
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 41
-        segments: 
-        - 0
-        - 9
-        - 9
+      - !ruby/object:Gem::Version
         version: 0.9.9
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: httpclient
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 2
-        - 2
-        - 3
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 2.2.3
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: httpi
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 53
-        segments: 
-        - 0
-        - 9
-        - 7
+      - !ruby/object:Gem::Version
         version: 0.9.7
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: oauth
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 4
-        - 5
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 0.4.5
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
 description: Essential utilities shared by all Ads Ruby client libraries
-email: 
+email:
 - api.dklimkin@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/ads_common/auth/base_handler.rb
+files:
+- lib/ads_common/api.rb
+- lib/ads_common/version.rb
+- lib/ads_common/credential_handler.rb
+- lib/ads_common/savon_service.rb
+- lib/ads_common/api_config.rb
 - lib/ads_common/auth/client_login_handler.rb
 - lib/ads_common/auth/oauth_handler.rb
+- lib/ads_common/auth/base_handler.rb
+- lib/ads_common/http.rb
+- lib/ads_common/errors.rb
+- lib/ads_common/parameters_validator.rb
+- lib/ads_common/savon_headers/oauth_header_handler.rb
+- lib/ads_common/savon_headers/base_header_handler.rb
+- lib/ads_common/savon_headers/httpi_request_proxy.rb
+- lib/ads_common/results_extractor.rb
 - lib/ads_common/build/savon_abstract_generator.rb
-- lib/ads_common/build/savon_generator.rb
+- lib/ads_common/build/savon_service_generator.rb
 - lib/ads_common/build/savon_registry.rb
 - lib/ads_common/build/savon_registry_generator.rb
-- lib/ads_common/build/savon_service_generator.rb
-- lib/ads_common/savon_headers/base_header_handler.rb
-- lib/ads_common/savon_headers/httpi_request_proxy.rb
-- lib/ads_common/savon_headers/oauth_header_handler.rb
-- lib/ads_common/api_config.rb
-- lib/ads_common/api.rb
+- lib/ads_common/build/savon_generator.rb
 - lib/ads_common/config.rb
-- lib/ads_common/credential_handler.rb
-- lib/ads_common/errors.rb
-- lib/ads_common/http.rb
-- lib/ads_common/parameters_validator.rb
-- lib/ads_common/savon_service.rb
-- lib/ads_common/version.rb
-- lib/ads_common/results_extractor.rb
-- test/test_client_login_handler.rb
-- test/test_config.rb
-- test/test_config.yml
-- test/test_parameters_validator.rb
 - test/test_savon_service.rb
 - test/coverage.rb
+- test/test_results_extractor.rb
 - test/suite_unittests.rb
 - test/test_credential_handler.rb
-- test/test_results_extractor.rb
+- test/test_client_login_handler.rb
+- test/test_parameters_validator.rb
+- test/test_config.rb
+- test/test_config.yml
 - COPYING
 - README
 - ChangeLog
-has_rdoc: true
 homepage: http://code.google.com/p/google-api-ads-ruby/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: google-ads-common
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Common code for Google Ads APIs
-test_files: 
-- test/test_client_login_handler.rb
-- test/test_config.rb
-- test/test_parameters_validator.rb
+test_files:
 - test/test_savon_service.rb
-- test/test_credential_handler.rb
 - test/test_results_extractor.rb
+- test/test_credential_handler.rb
+- test/test_client_login_handler.rb
+- test/test_parameters_validator.rb
+- test/test_config.rb