google-ads-common 0.3.0 → 0.4.0

data/ChangeLog

@@ -1,6 +1,11 @@
+0.4.0:
+  - Extracted soap4r specific code from main path.
+  - APIs with Savon backend are now ruby1.9 - compatible.
+  - Fixed possible statement corruption after call.
+
 0.3.0:
   - Fixes towards Ruby1.9 compatibility.
-  - Support for method names with CAPSed words (Savon),
+  - Support for method names with CAPSed words (Savon).
   - New single-Logger logging system.
 
 0.2.1:

data/Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 #
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -20,109 +20,58 @@
 # Rakefile for the ads_common package.
 
 require 'rubygems'
-gem 'rake'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/clean'
+require 'rubygems/package_task'
 require 'rake/testtask'
-require 'lib/ads_common/api_config'
-
-$WSDLDIR = 'wsdl'
-$LIBDIR = 'lib'
-$DOCDIR = 'doc'
-$TESTDIR = 'test'
-
-$PROJECT_NAME = 'ads_common'
-$GEM_NAME = 'google-ads-common'
-
-$CURRENT_VERSION = AdsCommon::ApiConfig::ADS_COMMON_VERSION
-$PKG_VERSION = ENV['REL'] ? ENV['REL'] : $CURRENT_VERSION
-
-# Configure gem details
-$GEM_SUMMARY = "Common code for Google Ads APIs."
-$GEM_DESCRIPTION = "#{$PROJECT_NAME} provides essential utilities shared by " +
-    "all Ads Ruby client libraries."
-$GEM_AUTHORS = ['Sergio Gomes', 'Danial Klimkin']
-$GEM_EMAIL = 'api.sgomes@gmail.com'
-$GEM_HOMEPAGE = 'http://code.google.com/p/google-api-ads-ruby/'
+require 'rdoc/task'
+require './lib/ads_common/api_config'
+
+GEM_NAME = 'google-ads-common'
+
+files = FileList['lib/**/*', 'Rakefile'].to_a
+tests = FileList['test/**/test_*.rb']
+docs = ['README', 'COPYING', 'ChangeLog']
+extra_files = ['test/test_config.yml']
+
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = GEM_NAME
+  s.version = AdsCommon::ApiConfig::ADS_COMMON_VERSION
+  s.summary = 'Common code for Google Ads APIs.'
+  s.description = ("%s provides essential utilities shared by all Ads Ruby " +
+      "client libraries.") % GEM_NAME
+  s.authors = ['Sergio Gomes', 'Danial Klimkin']
+  s.email = 'api.dklimkin@gmail.com'
+  s.homepage = 'http://code.google.com/p/google-api-ads-ruby/'
+  s.require_path = 'lib'
+  s.files = files
+  s.test_files = tests
+  s.has_rdoc = true
+  s.extra_rdoc_files = docs
+  s.add_dependency('savon', '~> 0.9.1')
+  s.add_dependency('soap4r', '= 1.5.8')
+  s.add_dependency('httpclient', '>= 2.1.6')
+  s.add_dependency('httpi', '~> 0.9.2')
+end
 
-# ====================================================================
-# Default task - call package
+desc 'Default target - build'
 task :default => [:package]
 
-# ====================================================================
+# Create a task that will package the Common library into a gem file.
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  pkg.package_files.include(extra_files)
+end
+
 # Create a task to build the RDOC documentation tree.
-Rake::RDocTask.new("rdoc") do |rdoc|
-  # Try to use SDoc to generate the docs
-  begin
-    require 'sdoc'
-    rdoc.options << '--fmt' << 'shtml'
-    rdoc.template = 'direct'
-  rescue LoadError
-    # Do nothing, give up on SDoc and continue with whatever is the default.
-  end
-  rdoc.rdoc_dir = $DOCDIR
-  rdoc.title = "#{$PROJECT_NAME} -- Common code for Google Ads APIs"
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "%s -- Common code for Google Ads APIs" % GEM_NAME
   rdoc.main = 'README'
-  rdoc.rdoc_files.include('README', 'COPYING', 'ChangeLog')
-  rdoc.rdoc_files.include("#{$LIBDIR}/**/*.rb")
+  rdoc.rdoc_files.include(docs)
+  rdoc.rdoc_files.include(files)
 end
 
-# ====================================================================
 # Create a task to perform the unit testing.
-Rake::TestTask.new("test") do |test|
-  test.libs << $TESTDIR
-  test.pattern = "#{$TESTDIR}/**/test_*.rb"
-  test.verbose = true
-end
-
-# ====================================================================
-# Create a task that will package the Rake software into distributable
-# gem files.
-PKG_FILES = FileList[
-  'Rakefile',
-  "#{$LIBDIR}/**/*.rb",
-  "#{$DOCDIR}/**/*.*"
-]
-
-PKG_FILES.exclude(/\._/)
-
-if ! defined?(Gem)
-  puts "Package Target requires RubyGems"
-else
-  spec = Gem::Specification.new do |s|
-
-    # Basic information
-    s.name = $GEM_NAME
-    s.version = $PKG_VERSION
-    s.summary = $GEM_SUMMARY
-    s.description = $GEM_DESCRIPTION
-
-    # Files and dependencies
-    s.files = PKG_FILES.to_a
-    s.require_path = $LIBDIR
-    s.add_dependency('soap4r', '= 1.5.8')
-    s.add_dependency('savon', '~> 0.9.1')
-    s.add_dependency('httpclient', '>= 2.1.6')
-    s.add_dependency('httpi', '~> 0.9.2')
-
-    # RDoc information
-    s.has_rdoc = true
-    s.extra_rdoc_files = ['README', 'ChangeLog', 'COPYING']
-    s.rdoc_options << '--main' << 'README'
-
-    # Metadata
-    s.authors = $GEM_AUTHORS
-    s.email = $GEM_EMAIL
-    s.homepage = $GEM_HOMEPAGE
-    s.rubyforge_project = $GEM_NAME
-    s.requirements << 'soap4r v1.5.8'
-    s.requirements << 'savon v0.9.1 or greater'
-    s.requirements << 'httpclient v2.1.6 or greater'
-    s.requirements << 'httpi v0.9.2 or greater'
-  end
-
-  Rake::GemPackageTask.new(spec) do |t|
-    t.need_tar = true
-  end
+Rake::TestTask.new do |t|
+  t.test_files = tests
 end

data/lib/ads_common/api.rb

@@ -1,8 +1,8 @@
 #!/usr/bin/ruby
 #
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2010, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
 #           you may not use this file except in compliance with the License.
@@ -24,33 +24,39 @@ require 'logger'
 require 'ads_common/errors'
 require 'ads_common/auth/base_handler'
 require 'ads_common/auth/client_login_handler'
-require 'ads_common/soap4r_headers/nested_header_handler'
-require 'ads_common/soap4r_headers/single_header_handler'
-require 'ads_common/soap4r_response_handler'
-require 'ads_common/soap4r_logger'
 
 module AdsCommon
   class Api
 
-    # Methods that return the service configuration and the client library
-    # configuration. They need to be redefined in subclasses.
-    attr_reader :api_config, :config
+    # Methods that return the client library configuration. Needs to be
+    # redefined in subclasses.
+    attr_reader :config
 
-    # Credential handler objects used for authentication
+    # Credential handler objects used for authentication.
     attr_reader :credential_handler
 
-    # The configuration for this Api object
-    attr_reader :config
-
-    # The logger for this Api object.
+    # The logger for this API object.
     attr_reader :logger
 
-    # Constructor for Api.
+    # Constructor for API.
     def initialize(provided_config = nil)
       load_config(provided_config)
       provided_logger = @config.read('library.logger')
       self.logger = (provided_logger.nil?) ?
           create_default_logger() : provided_logger
+
+      # Check for valid environment.
+      env_string = config.read('service.environment')
+      environment = (env_string.nil?) ? api_config.default_environment :
+          env_string.to_s.upcase.to_sym
+      if api_config.environments.include?(environment)
+        config.set('service.environment', environment)
+      else
+        raise AdsCommon::Errors::Error,
+            "Unknown or unspecified environment: \"%s\"" % env_string
+      end
+
+      @wrappers = Hash.new
     end
 
     # Sets the logger to use.
@@ -59,6 +65,11 @@ module AdsCommon
       @config.set('library.logger', @logger)
     end
 
+    # Getter for the API service configurations.
+    def api_config
+      AdsCommon::ApiConfig
+    end
+
     # Obtain an API service, given a version and its name.
     #
     # Args:
@@ -69,34 +80,40 @@ module AdsCommon
     # - the service wrapper for the intended service.
     #
     def service(name, version = nil)
-      version = api_config.default_version if version == nil
-      # Check if version exists
-      if !api_config.versions.include?(version.to_sym)
-        if version.is_a? Integer
-          raise AdsCommon::Errors::Error, "Unknown version '#{version}'. " +
-              "Please note that version numbers should be symbols; check the" +
-              "Readme or the included examples for more information."
-        else
-          raise AdsCommon::Errors::Error, "Unknown version #{version}"
-        end
-      end
-      version = version.to_sym
       name = name.to_sym
-      environment = config.read('service.environment')
-      # Check if the current environment supports the requested version
+      version = (version.nil?) ? api_config.default_version : version.to_sym
+
+      # Check if version exists.
+      if !api_config.versions.include?(version)
+        raise AdsCommon::Errors::Error, "Unknown version '%s'." % version
+      end
+
+      # Check if the current environment supports the requested version.
+      environment = @config.read('service.environment')
       if !api_config.environment_has_version(environment, version)
         raise AdsCommon::Errors::Error,
-          "Environment #{environment} does not support version #{version}"
+            "Environment '%s' does not support version '%s'." %
+            [environment, version]
       end
-      # Check if the specified version has the requested service
+
+      # Check if the specified version has the requested service.
       if !api_config.version_has_service(version, name)
-        raise AdsCommon::Errors::Error, "Version #{version} does not contain " +
-          "service #{name}"
+        raise AdsCommon::Errors::Error,
+            "Version '%s' does not contain service '%s'", [version, name]
+      end
+
+      # Try to re-use the service for this version if it was requested before.
+      wrapper = if @wrappers.include?(version) && @wrappers[version][name]
+        @wrappers[version][name]
+      else
+        @wrappers[version] ||= {}
+        @wrappers[version][name] = prepare_wrapper(version, name)
       end
-      prepare_driver(version, name)
-      return @wrappers[[version, name]]
+      return wrapper
     end
 
+    private
+
     # Retrieve the SOAP header handlers to plug into the drivers. Needs to
     # be implemented on the specific API, because of the different types of
     # SOAP headers (optional parameter specifying API version).
@@ -111,80 +128,37 @@ module AdsCommon
     # Returns:
     # - a list of SOAP header handlers; one per provided header
     #
-    def soap_header_handlers(auth_handler, header_list, version, wrapper = nil)
+    def soap_header_handlers(auth_handler, header_list, version, wrapper)
+      raise NotImplementedError, 'soap_header_handlers not overriden.'
     end
 
-    private
-
     # Auxiliary method to create an authentication handler. Needs to be
     # implemented on the specific API because of the different nesting models
     # used in different APIs and API versions.
     #
     # Args:
-    # - version: intended API version
     # - environment: the current working environment (production, sandbox, etc.)
+    # - version: intended API version
     #
     # Returns:
     # - auth handler
     #
-    def create_auth_handler(version = nil, environment = nil)
+    def create_auth_handler(environment, version)
+      raise NotImplementedError, 'create_auth_handler not overriden.'
     end
 
-    # Handle loading of a single service.
-    # Creates the driver, sets up handlers and logger, declares the appropriate
-    # wrapper class and creates an instance of it.
+    # Handle loading of a single service wrapper. Needs to be implemented on
+    # specific API level.
     #
     # Args:
-    # - version: intended API version. Must be an integer.
-    # - service: name for the intended service
+    # - version: intended API version. Must be a symbol.
+    # - service: name for the intended service. Must be a symbol.
     #
     # Returns:
-    # - the driver for the service
-    # - the simplified wrapper generated for the driver
+    # - a wrapper generated for the service.
     #
-    def prepare_driver(version, service)
-      version = version.to_sym
-      service = service.to_sym
-      environment = config.read('service.environment')
-      api_config.do_require(version, service)
-      endpoint = api_config.endpoint(environment, version, service)
-      # Set endpoint if not using the default
-      if endpoint.nil? then
-        driver = eval("#{api_config.interface_name(version, service)}.new")
-      else
-        endpoint_url = endpoint.to_s + service.to_s
-        driver = eval("#{api_config.interface_name(version, service)}.new" +
-                      "(\"#{endpoint_url}\")")
-      end
-
-      # Create an instance of the wrapper class for this service.
-      wrapper_class = api_config.wrapper_name(version, service)
-      wrapper = eval("#{wrapper_class}.new(driver, self)")
-
-      auth_handler = create_auth_handler(version, environment)
-      header_list =
-          auth_handler.header_list(@credential_handler.credentials(version))
-
-      soap_handlers = soap_header_handlers(auth_handler, header_list, version,
-          wrapper)
-
-      soap_handlers.each do |handler|
-        driver.headerhandler << handler
-      end
-
-      # Add response handler to this driver for API unit usage processing.
-      driver.callbackhandler = create_callback_handler
-      # Plug the wiredump to our XML logger
-      driver.wiredump_dev = AdsCommon::Soap4rLogger.new(@logger, Logger::DEBUG)
-      driver.options['protocol.http.ssl_config.verify_mode'] = nil
-      proxy = config.read('connection.proxy')
-      if proxy
-        driver.options['protocol.http.proxy'] = proxy
-      end
-
-      @drivers[[version, service]] = driver
-      @wrappers[[version, service]] = wrapper
-      return driver, wrapper
+    def prepare_wrapper(version, service)
+      raise NotImplementedError, 'prepare_wrapper not overriden.'
     end
 
     # Auxiliary method to create a default Logger.
@@ -214,7 +188,7 @@ module AdsCommon
       if log_level.is_a?(String)
         result = case log_level.upcase
           when 'FATAL' then Logger::FATAL
-          when 'ERROR' then Logger:ERROR
+          when 'ERROR' then Logger::ERROR
           when 'WARN' then Logger::WARN
           when 'INFO' then Logger::INFO
           when 'DEBUG' then Logger::DEBUG

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.3.0'
+    ADS_COMMON_VERSION = '0.4.0'
 
     # Get the available API versions.
     #
@@ -53,10 +53,8 @@ module AdsCommon
     # given version
     #
     def environment_has_version(environment, version)
-      environment = environment.upcase.to_sym
-      version = version.to_sym
-      !environment_config[environment].nil? and
-          !environment_config[environment][version].nil?
+      return environment_config.include?(environment) &&
+          environment_config[environment].include?(version)
     end
 
     # Does the given version exist and contain the given service?
@@ -66,10 +64,8 @@ module AdsCommon
     # given service
     #
     def version_has_service(version, service)
-      version = version.to_sym
-      service = service.to_sym
-      (!service_config[version].nil? and
-          service_config[version].include?(service))
+      return service_config.include?(version) &&
+          service_config[version].include?(service)
     end
 
     # Get the default API version.
@@ -127,9 +123,6 @@ module AdsCommon
     # The endpoint URL (as a string)
     #
     def endpoint(environment, version, service)
-      environment = environment.upcase.to_sym
-      version = version.to_sym
-      service = service.to_sym
       base = get_wsdl_base(environment, version)
       if !subdir_config().nil?
         base = base.to_s + subdir_config()[[version, service]].to_s
@@ -148,8 +141,6 @@ module AdsCommon
     #
     def subdir(version, service)
       return nil if subdir_config().nil?
-      version = version.to_sym
-      service = service.to_sym
       subdir_config()[[version, service]]
     end
 
@@ -163,39 +154,19 @@ module AdsCommon
     # The full URL for the auth server.
     #
     def auth_server(environment)
-      auth_server_url = ENV['ADSAPI_AUTH_URL']
-      if auth_server_url.nil?
-        environment = environment.upcase.to_sym
-        auth_server_url = auth_server_config[environment]
-      end
-      if auth_server_url.nil?
-        # If we don't have an entry for this environment, we just return the
-        # default server (the same one being used for the default environment)
-        auth_server_url = auth_server_config[default_environment()]
-      end
+      auth_server_url =
+          ENV['ADSAPI_AUTH_URL'] ||
+          auth_server_config[environment] ||
+          auth_server_config[default_environment()]
       return auth_server_url
     end
 
-    # Add a new environment to the list.
-    #
-    # Args:
-    # - name: the name for the new environment
-    # - endpoint_hash: a hash of base endpoint URLs, indexed by version number,
-    #   e.g.:
-    #    { :v13 => 'URL_FOR_v13', :v200906 => 'URL_FOR_v200906' }
-    #
-    def add_environment(name, endpoint_hash)
-      name = name.upcase.to_sym
-      environment_config[name] = endpoint_hash
-    end
-
     # Perform the loading of the necessary source files for a version
     #
     # Args:
     # - version: the API version (as an integer)
     #
     def do_require(version, service)
-      version = version.to_sym
       eval("require '#{api_path}/#{version}/#{service}Wrapper.rb'")
     end
 
@@ -209,8 +180,6 @@ module AdsCommon
     # The full module name for the given service (as a string)
     #
     def module_name(version, service)
-      version = version.to_sym
-      service = service.to_sym
       return "#{api_name}::#{version.to_s.upcase}::#{service}"
     end
 
@@ -224,8 +193,6 @@ module AdsCommon
     # The full interface class name for the given service (as a string)
     #
     def interface_name(version, service)
-      version = version.to_sym
-      service = service.to_sym
       return module_name(version, service) + "::#{service}Interface"
     end
 
@@ -239,8 +206,6 @@ module AdsCommon
     # The full wrapper class name for the given service (as a string)
     #
     def wrapper_name(version, service)
-      version = version.to_sym
-      service = service.to_sym
       return module_name(version, service) + "::#{service}Wrapper"
     end
 
@@ -279,10 +244,8 @@ module AdsCommon
     # Returns:
     #   String containing base URL.
     def get_wsdl_base(environment, version)
-      wsdl_base = ENV['ADSAPI_BASE_URL']
-      if wsdl_base.nil?
-        wsdl_base = environment_config[environment][version]
-      end
+      wsdl_base = ENV['ADSAPI_BASE_URL'] ||
+          wsdl_base = environment_config[environment][version]
       return wsdl_base
     end
   end

data/lib/ads_common/savon_headers/client_login_header_handler.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby
+#
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: 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.
+#
+# Handles SOAP headers and namespaces definition for ClientLogin type header.
+
+require 'ads_common/savon_headers/simple_header_handler'
+
+module AdsCommon
+  module SavonHeaders
+    class ClientLoginHeaderHandler < SimpleHeaderHandler
+      private
+
+      # Generates SOAP request header with login credentials and namespace
+      # definition.
+      #
+      # Args:
+      #  - None.
+      #
+      # Returns:
+      #  - Hash containing a header with filled in credentials.
+      #
+      def generate_request_header()
+        request_header = {}
+        credentials = @credential_handler.credentials(@version)
+        headers = @auth_handler.headers(credentials)
+        headers.each do |header, value|
+          if header == :authToken
+            auth_header = prepend_namespace('authentication')
+            request_header[auth_header] = {
+                prepend_namespace('token') => value
+            }
+            request_header[:attributes!] ||= Hash.new
+            request_header[:attributes!][auth_header] = {
+                'xsi:type' => prepend_namespace('ClientLogin'),
+            }
+          else
+            request_header[prepend_namespace(header)] = value
+          end
+        end
+        return request_header
+      end
+    end
+  end
+end

data/lib/ads_common/savon_service.rb

@@ -78,7 +78,7 @@ module AdsCommon
       in_params = get_service_registry.get_method_signature(action_name)[:input]
       in_params.each_with_index do |in_param, index|
         key = in_param[:name]
-        value = args[index]
+        value = deep_copy(args[index])
         validated_args[key] = (value.nil?) ? nil :
             validate_arg(value, validated_args, key)
       end
@@ -223,14 +223,12 @@ module AdsCommon
     # Converts XML input string into a native format.
     def normalize_type(data, field)
       type_name = field[:type]
-      result = (data.nil?) ? data :
-          case type_name
-            when 'long', 'int' then Integer(data)
-            when 'double' then Float(data)
-            when 'boolean' then data.kind_of?(String) ?
-                data.casecmp('true') == 0 : data
-            else data
-          end
+      result = case data
+        when Array
+          data.map {|item| normalize_item(type_name, item)}
+        else
+          normalize_item(type_name, data)
+      end
       # If field signature allows an array, forcing array structure even for one
       # item.
       if !field[:min_occurs].nil? and
@@ -240,6 +238,18 @@ module AdsCommon
       return result
     end
 
+    # Converts one leaf item to a built-in type.
+    def normalize_item(type_name, item)
+      return (item.nil?) ? item :
+          case type_name
+            when 'long', 'int' then Integer(item)
+            when 'double' then Float(item)
+            when 'boolean' then item.kind_of?(String) ?
+                item.casecmp('true') == 0 : item
+            else item
+          end
+    end
+
     # Finds a field in a list by its name.
     def get_field_by_name(fields_list, name)
       fields_array = arrayize(fields_list)
@@ -271,5 +281,10 @@ module AdsCommon
       end
       return result
     end
+
+    # Returns copy of object and its sub-objects ("deep" copy).
+    def deep_copy(data)
+      return Marshal.load(Marshal.dump(data))
+    end
   end
 end

data/test/test_config.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/ruby
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: 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.
+#
+# Tests the array replies from services.
+
+require 'rubygems'
+require 'test/unit'
+require 'ads_common/config'
+
+class TestConfig < Test::Unit::TestCase
+  DEFAULT_CONFIG_HASH = {
+      :service => {:use_ruby_names => false,
+                   :environment => 'sandbox'},
+      :authentication => {:method => 'ClientLogin',
+                          :email => 'root@example.com'}
+  }
+
+  DEFAULT_CONFIG_FILENAME = 'test/test_config.yml'
+
+  # Test initializer with no arguments.
+  def test_initialize_nil
+    assert_nothing_raised do
+      config = AdsCommon::Config.new
+      assert_nil(config.read('service.use_ruby_names'))
+    end
+  end
+
+  # Test initializer with hash argument.
+  def test_initialize_hash
+    config = AdsCommon::Config.new(DEFAULT_CONFIG_HASH)
+    assert_equal(false, config.read('service.use_ruby_names'))
+    assert_equal('sandbox', config.read('service.environment'))
+    assert_equal('ClientLogin', config.read('authentication.method'))
+    assert_equal('root@example.com', config.read('authentication.email'))
+    assert_nil(config.read('unexisting.entry'))
+  end
+
+  # Test initializer with filename argument.
+  def test_initialize_filename
+    config = AdsCommon::Config.new(DEFAULT_CONFIG_FILENAME)
+    assert_equal(false, config.read('service.use_ruby_names'))
+    assert_equal('sandbox', config.read('service.environment'))
+    assert_equal('ClientLogin', config.read('authentication.method'))
+    assert_equal('root@example.com', config.read('authentication.email'))
+    assert_nil(config.read('unexisting.entry'))
+  end
+
+  # Test default result.
+  def test_read_default_result
+    config = AdsCommon::Config.new(DEFAULT_CONFIG_HASH)
+    assert_nil(config.read('unexisting.entry'))
+    assert_equal('default', config.read('unexisting.entry', 'default'))
+    assert_equal('sandbox', config.read('service.environment', 'production'))
+  end
+
+  # Test setter.
+  def test_set
+    config = AdsCommon::Config.new(DEFAULT_CONFIG_HASH)
+    assert_equal('sandbox', config.read('service.environment'))
+    assert_nil(config.read('unexisting.entry'))
+    config.set('unexisting.entry', 'foobar')
+    assert_equal('sandbox', config.read('service.environment'))
+    assert_equal('foobar', config.read('unexisting.entry'))
+  end
+
+  # Test subhash.
+  def test_set
+    config = AdsCommon::Config.new(DEFAULT_CONFIG_HASH)
+    result = config.read('service')
+    assert_instance_of(Hash, result)
+    assert_equal('sandbox', result[:environment])
+    assert_equal(false, result[:use_ruby_names])
+  end
+end

data/test/test_savon_service.rb

@@ -0,0 +1,231 @@
+#!/usr/bin/ruby
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: 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.
+#
+# Tests the array replies from services.
+
+require 'rubygems'
+require 'test/unit'
+require 'pp'
+require 'ads_common/savon_service'
+
+# SavonService is abstract, defining a child class for the test.
+class SomeService < AdsCommon::SavonService
+  def private_get_service_registry()
+    return get_service_registry
+  end
+  def private_get_module()
+    return get_module
+  end
+  def private_normalize_type(data, field)
+    return normalize_type(data, field)
+  end
+  def private_get_field_by_name(fields_list, name)
+    return get_field_by_name(fields_list, name)
+  end
+  def private_arrayize(object)
+    return arrayize(object)
+  end
+  def private_deep_copy(object)
+    return deep_copy(object)
+  end
+end
+
+class TestSavonService < Test::Unit::TestCase
+  TEST_NAMESPACE = 'namespace'
+  TEST_ENDPOINT = 'endpoint'
+
+  # Initialize tests.
+  def setup
+    @some_service = SomeService.new(TEST_NAMESPACE, TEST_ENDPOINT)
+  end
+
+  def test_initialize_abstract
+    assert_raises(NoMethodError) do
+      AdsCommon::SavonService.new(TEST_NAMESPACE, TEST_ENDPOINT)
+    end
+    assert_nothing_raised do
+      SomeService.new(TEST_NAMESPACE, TEST_ENDPOINT)
+    end
+  end
+
+  def test_get_service_registry_abstract
+    assert_raises(NoMethodError) { @some_service.private_get_service_registry }
+  end
+
+  def test_get_module_abstract
+    assert_raises(NoMethodError) { @some_service.private_get_module }
+  end
+
+  def test_arrayize_empty
+    result1 = @some_service.private_arrayize(nil)
+    assert_instance_of(Array, result1, 'returned object is not an Array')
+    assert_equal(0, result1.size, 'array is not empty')
+
+    result2 = @some_service.private_arrayize([])
+    assert_instance_of(Array, result2, 'returned object is not an Array')
+    assert_equal(0, result2.size, 'array is not empty')
+  end
+
+  def test_arrayize_on_array
+    result1 = @some_service.private_arrayize([nil])
+    assert_instance_of(Array, result1, 'returned object is not an Array')
+    assert_equal(1, result1.size, 'array changed size')
+    assert_equal(nil, result1[0], 'array changed data')
+
+    result2 = @some_service.private_arrayize(['a', 'b'])
+    assert_instance_of(Array, result2, 'returned object is not an Array')
+    assert_equal(2, result2.size, 'array changed size')
+    assert_equal('a', result2[0], 'array changed data')
+    assert_equal('b', result2[1], 'array changed data')
+  end
+
+  def test_normalize_type_int
+    result1 = @some_service.private_normalize_type(5, {:type => 'int'})
+    assert_kind_of(Integer, result1)
+    assert_equal(5, result1, 'bad conversion')
+
+    result2 = @some_service.private_normalize_type(2147483648, {:type => 'int'})
+    assert_kind_of(Integer, result2)
+    assert_equal(2147483648, result2, 'bad conversion')
+  end
+
+  def test_normalize_type_string
+    result1 = @some_service.private_normalize_type('foobar',
+        {:type => 'string'})
+    assert_kind_of(String, result1)
+    assert_equal('foobar', result1, 'bad conversion')
+
+    result2 = @some_service.private_normalize_type('', {:type => 'string'})
+    assert_kind_of(String, result2)
+    assert_equal('', result2, 'bad conversion')
+  end
+
+  def test_normalize_type_long
+    result1 = @some_service.private_normalize_type(2147483648,
+        {:type => 'long'})
+    assert_kind_of(Integer, result1)
+    assert_equal(2147483648, result1, 'bad conversion')
+
+    result2 = @some_service.private_normalize_type(-1, {:type => 'long'})
+    assert_kind_of(Integer, result2)
+    assert_equal(-1, result2, 'bad conversion')
+  end
+
+  def test_normalize_type_boolean
+    result1 = @some_service.private_normalize_type(true, {:type => 'boolean'})
+    assert_kind_of(TrueClass, result1)
+
+    result2 = @some_service.private_normalize_type(false, {:type => 'boolean'})
+    assert_kind_of(FalseClass, result2)
+
+    result3 = @some_service.private_normalize_type('true', {:type => 'boolean'})
+    assert_kind_of(TrueClass, result3)
+
+    result4 = @some_service.private_normalize_type('false',
+        {:type => 'boolean'})
+    assert_kind_of(FalseClass, result4)
+
+    result5 = @some_service.private_normalize_type('True',
+        {:type => 'boolean'})
+    assert_kind_of(TrueClass, result3)
+
+    result6 = @some_service.private_normalize_type('False',
+        {:type => 'boolean'})
+    assert_kind_of(FalseClass, result4)
+  end
+
+  def test_normalize_type_object
+    result1 = @some_service.private_normalize_type({:a => 'b'},
+        {:type => 'SomeClass'})
+    assert_equal('b', result1[:a], 'object corrupted')
+
+    result2 = @some_service.private_normalize_type(@some_service,
+        {:type => 'SavonService'})
+    assert_equal(@some_service.hash, result2.hash, 'object corrupted')
+  end
+
+  def test_normalize_type_double
+    result1 = @some_service.send(:private_normalize_type, 3.14,
+        {:type => 'double'})
+    assert_kind_of(Float, result1)
+    assert_equal(3.14, result1, 'bad conversion')
+
+    result2 = @some_service.send(:private_normalize_type, '-3.14',
+        {:type => 'double'})
+    assert_kind_of(Float, result2)
+    assert_equal(-3.14, result2, 'bad conversion')
+
+    result3 = @some_service.send(:private_normalize_type, '42',
+        {:type => 'double'})
+    assert_kind_of(Float, result3)
+    assert_equal(42.0, result3, 'bad conversion')
+  end
+
+  def test_normalize_type_single_array_item
+    result1 = @some_service.private_normalize_type('42',
+        {:type => 'double', :min_occurs => '0', :max_occurs => 1})
+    assert_kind_of(Float, result1)
+    assert_equal(42.0, result1, 'Float expected for max_occurs 1')
+
+    result2 = @some_service.private_normalize_type('42',
+        {:type => 'double', :min_occurs => '0', :max_occurs => nil})
+    assert_instance_of(Array, result2)
+    assert_equal(42.0, result2[0], 'Array is expected for undefined max_occurs')
+
+    result3 = @some_service.private_normalize_type('42',
+        {:type => 'double', :min_occurs => '0', :max_occurs => 2})
+    assert_instance_of(Array, result3)
+    assert_equal(42.0, result3[0], 'Array is expected for max_occurs > 1')
+  end
+
+  def test_deep_copy_simple
+    result1 = @some_service.private_deep_copy(42)
+    assert_equal(42, result1)
+
+    result2 = @some_service.private_deep_copy('Hello World')
+    assert_equal('Hello World', result2)
+
+    result3 = @some_service.private_deep_copy(nil)
+    assert_nil(result3)
+
+    result4 = @some_service.private_deep_copy([])
+    assert_equal([], result4)
+    assert_not_same([], result4)
+
+    result5 = @some_service.private_deep_copy({})
+    assert_equal({}, result5)
+    assert_not_same({}, result5)
+  end
+
+  def test_deep_copy_complex
+    data = {:ab => 'ab', :cd => ['cd', 'de', 'ef']}
+
+    result1 = @some_service.private_deep_copy(data)
+    assert_equal(data, result1)
+    assert_not_same(data, result1)
+
+    result2 = @some_service.private_deep_copy(data)
+    assert_equal(result2, result1)
+    assert_not_same(result2, result1)
+
+    result2[:cd] = nil
+    assert_not_equal(data, result2)
+    assert_equal(data, result1)
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-ads-common
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Sergio Gomes
@@ -15,44 +16,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-09 00:00:00 +04:00
+date: 2011-06-20 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: soap4r
+  name: savon
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 57
         segments: 
+        - 0
+        - 9
         - 1
-        - 5
-        - 8
-        version: 1.5.8
+        version: 0.9.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: savon
+  name: soap4r
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
-        - 0
-        - 9
         - 1
-        version: 0.9.1
+        - 5
+        - 8
+        version: 1.5.8
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: httpclient
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
         - 1
@@ -64,9 +71,11 @@ dependencies:
   name: httpi
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 63
         segments: 
         - 0
         - 9
@@ -74,76 +83,80 @@ dependencies:
         version: 0.9.2
   type: :runtime
   version_requirements: *id004
-description: ads_common provides essential utilities shared by all Ads Ruby client libraries.
-email: api.sgomes@gmail.com
+description: google-ads-common provides essential utilities shared by all Ads Ruby client libraries.
+email: api.dklimkin@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - README
-- ChangeLog
 - COPYING
+- ChangeLog
 files: 
-- Rakefile
 - lib/ads_common/auth/base_handler.rb
 - lib/ads_common/auth/client_login_handler.rb
-- lib/ads_common/build/savon_abstract_generator.rb
+- lib/ads_common/api_config.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/api.rb
+- lib/ads_common/savon_service.rb
+- lib/ads_common/soap4r_patches.rb
+- lib/ads_common/soap4r_response_handler.rb
 - lib/ads_common/build/rake_common.rb
-- lib/ads_common/build/savon_registry_generator.rb
+- lib/ads_common/build/savon_abstract_generator.rb
 - lib/ads_common/build/savon_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/build/soap4r_generator.rb
 - lib/ads_common/savon_headers/simple_header_handler.rb
+- lib/ads_common/savon_headers/client_login_header_handler.rb
 - lib/ads_common/soap4r_headers/nested_header_handler.rb
 - lib/ads_common/soap4r_headers/single_header_handler.rb
-- lib/ads_common/api_config.rb
-- lib/ads_common/api.rb
-- lib/ads_common/soap4r_response_handler.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/savon_service.rb
-- lib/ads_common/soap4r_patches.rb
 - lib/ads_common/soap4r_logger.rb
+- Rakefile
+- test/test_config.rb
+- test/test_savon_service.rb
 - README
-- ChangeLog
 - COPYING
+- ChangeLog
 has_rdoc: true
 homepage: http://code.google.com/p/google-api-ads-ruby/
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --main
-- README
+rdoc_options: []
+
 require_paths: 
 - lib
 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 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
-requirements: 
-- soap4r v1.5.8
-- savon v0.9.1 or greater
-- httpclient v2.1.6 or greater
-- httpi v0.9.2 or greater
-rubyforge_project: google-ads-common
-rubygems_version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Common code for Google Ads APIs.
-test_files: []
-
+test_files: 
+- test/test_config.rb
+- test/test_savon_service.rb