google-ads-common 0.5.1 → 0.5.2

data/ChangeLog

@@ -1,3 +1,8 @@
+0.5.2:
+  - Additional information such as headers are now available via user-specified
+    block. See API-specific README for more details.
+  - Fixed xsi:types were not returned in responses (issue #10).
+
 0.5.1:
   - Now passing response header information as :header field in response.
   - Major performance improvements.

data/lib/ads_common/api.rb

@@ -91,7 +91,7 @@ module AdsCommon
       # Check if the specified version has the requested service.
       if !api_config.version_has_service(version, name)
         raise AdsCommon::Errors::Error,
-            "Version '%s' does not contain service '%s'", [version, name]
+            "Version '%s' does not contain service '%s'" % [version, name]
       end
 
       # Try to re-use the service for this version if it was requested before.

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.5.1'
+    ADS_COMMON_VERSION = '0.5.2'
 
     # Get the available API versions.
     #

data/lib/ads_common/build/savon_service_generator.rb

@@ -48,8 +48,8 @@ module AdsCommon
           end
           <% @actions.each do |action| %>
 
-          def <%= action %>(*args)
-            return execute_action('<%= action %>', args)
+          def <%= action %>(*args, &block)
+            return execute_action('<%= action %>', args, &block)
           end
           <% end %>
           <% @extensions.each do |extention| %>

data/lib/ads_common/savon_headers/base_header_handler.rb

@@ -88,7 +88,7 @@ module AdsCommon
         app_name = credentials[:user_agent]
         # We don't know the library version here. A breaking change needs to be
         # introduced. This is scheduled for 0.6.0, using Common version for now.
-        lib_version = '0.5.1'
+        lib_version = '0.5.2'
         soap_user_agent = "Common-Ruby-%s; %s" % [lib_version, app_name]
         return "Savon/%s (%s)" % [Savon::Version, soap_user_agent]
       end

data/lib/ads_common/savon_service.rb

@@ -80,11 +80,11 @@ module AdsCommon
     end
 
     # Executes SOAP action specified as a string with given arguments.
-    def execute_action(action_name, args)
+    def execute_action(action_name, args, &block)
       args = validate_args(action_name, args)
       response = execute_soap_request(action_name.to_sym, args)
       handle_errors(response)
-      return extract_result(response, action_name)
+      return extract_result(response, action_name, &block)
     end
 
     # Executes the SOAP request with original SOAP name.
@@ -101,7 +101,7 @@ module AdsCommon
     # Validates input parameters to:
     # - add parameter names;
     # - resolve xsi:type where required;
-    # - convert some native types to xml.
+    # - convert some native types to XML.
     def validate_args(action_name, args)
       validated_args = {}
       in_params = get_service_registry.get_method_signature(action_name)[:input]
@@ -110,6 +110,9 @@ module AdsCommon
         value = deep_copy(args[index])
         validated_args[key] = (value.nil?) ?
              nil : validate_arg(value, validated_args, key, in_param[:type])
+        # Adding :order! key to keep correct order in SOAP elements.
+        validated_args[:order!] =
+            generate_order_for_args(validated_args, in_params)
       end
       return validated_args
     end
@@ -143,7 +146,8 @@ module AdsCommon
       # Non-default namespace should be used, overriding default.
       if field_type and field_type.include?(:ns)
         namespace = get_service_registry.get_namespace(field_type[:ns])
-        add_attribute(parent, prefix_key(key), 'xmlns', namespace)
+        key = prefix_key(key)
+        add_attribute(parent, key, 'xmlns', namespace)
       end
 
       # Handling custom xsi:type.
@@ -274,26 +278,38 @@ module AdsCommon
 
     # Extracts the finest results possible for the given result. Returns the
     # response itself in worst case (contents unknown).
-    def extract_result(response, action_name)
+    def extract_result(response, action_name, &block)
       method = get_service_registry.get_method_signature(action_name)
       action = method[:output][:name].to_sym
       result = response.to_hash
       result = result[action] if result.include?(action)
       result = normalize_output(result, method)
-      result[:header] = extract_header_data(response) if result.kind_of?(Hash)
+      run_user_block(response, result, &block) if block_given?
       return result
     end
 
+    # Yields to user-specified block with additional information such as
+    # headers.
+    def run_user_block(response, body, &block)
+      header = extract_header_data(response)
+      case block.arity
+        when 1: yield(header)
+        when 2: yield(header, body)
+        else
+          raise AdsCommon::Errors::ApiException,
+              "Wrong number of block parameters: %d" % block.arity
+      end
+      return nil
+    end
+
     # 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)|
-        # Attributes start with '@' and are not included in type definition.
-        if !(key.to_s.start_with?('@'))
-          normalize_output_field(headers, header_type[:fields], key)
-          result[key] = headers[key]
-        end
+        normalize_output_field(headers, header_type[:fields], key)
+        result[key] = headers[key]
         result
       end
       return result
@@ -313,6 +329,9 @@ module AdsCommon
     #  - field_name: specifies field name to normalize
     def normalize_output_field(output_data, fields_list, field_name)
       return nil if output_data.nil?
+
+      process_attributes(output_data, true)
+
       field_definition = get_field_by_name(fields_list, field_name)
       if field_definition.nil?
         @api.logger.warn("Can not determine type for field: %s" % field_name)
@@ -366,7 +385,7 @@ module AdsCommon
       return (item.nil?) ? item :
           case type_name
             when 'long', 'int' then Integer(item)
-            when 'double' then Float(item)
+            when 'double', 'float' then Float(item)
             when 'boolean' then item.kind_of?(String) ?
                 item.casecmp('true') == 0 : item
             else item
@@ -423,5 +442,16 @@ module AdsCommon
       end
       return result
     end
+
+    # Handles attributes received from Savon.
+    def process_attributes(data, keep_xsi_type = false)
+      if data.kind_of?(Hash)
+        if keep_xsi_type
+          xsi_type = data.delete(:"@xsi:type")
+          data[:xsi_type] = xsi_type if xsi_type
+        end
+        data.reject! {|key, value| key.to_s.start_with?('@')}
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-ads-common
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Sergio Gomes
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-21 00:00:00 +04:00
+date: 2011-10-20 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,25 +94,25 @@ extra_rdoc_files:
 - COPYING
 - ChangeLog
 files: 
-- lib/ads_common/config.rb
-- lib/ads_common/build/savon_abstract_generator.rb
-- lib/ads_common/build/savon_service_generator.rb
+- lib/ads_common/auth/client_login_handler.rb
+- lib/ads_common/auth/base_handler.rb
+- lib/ads_common/auth/oauth_handler.rb
+- lib/ads_common/credential_handler.rb
 - lib/ads_common/build/savon_generator.rb
 - lib/ads_common/build/savon_registry_generator.rb
 - lib/ads_common/build/savon_registry.rb
+- lib/ads_common/build/savon_service_generator.rb
+- lib/ads_common/build/savon_abstract_generator.rb
+- lib/ads_common/api_config.rb
+- lib/ads_common/config.rb
+- lib/ads_common/api.rb
 - lib/ads_common/savon_headers/base_header_handler.rb
 - lib/ads_common/savon_headers/simple_header_handler.rb
-- lib/ads_common/savon_headers/httpi_request_proxy.rb
 - lib/ads_common/savon_headers/oauth_header_handler.rb
+- lib/ads_common/savon_headers/httpi_request_proxy.rb
 - lib/ads_common/savon_service.rb
-- lib/ads_common/api_config.rb
 - lib/ads_common/http.rb
-- lib/ads_common/api.rb
-- lib/ads_common/auth/oauth_handler.rb
-- lib/ads_common/auth/base_handler.rb
-- lib/ads_common/auth/client_login_handler.rb
 - lib/ads_common/errors.rb
-- lib/ads_common/credential_handler.rb
 - Rakefile
 - test/test_config.rb
 - test/test_savon_service.rb