google-adwords-api 0.2.1 → 0.4.0

data/examples/v201101/update_conversion.rb

@@ -23,7 +23,6 @@
 # Tags: ConversionTrackerService.mutate
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v201101
@@ -70,26 +69,18 @@ if __FILE__ == $0
   begin
     update_conversion()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/v201101/update_user_list.rb

@@ -23,7 +23,6 @@
 # Tags: UserListService.mutate
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v201101
@@ -65,26 +64,18 @@ if __FILE__ == $0
   begin
     update_user_list()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/v201101/upload_image.rb

@@ -22,8 +22,8 @@
 # Tags: MediaService.upload
 
 require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
+require 'adwords_api/utils'
 require 'base64'
 
 API_VERSION = :v201101
@@ -72,26 +72,18 @@ if __FILE__ == $0
   begin
     upload_image()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/lib/adwords_api.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/ruby
 #
 # Authors:: api.sgomes@gmail.com (Sérgio Gomes)
+#           api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -17,27 +18,21 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# Contains the main classes for the client library. Takes care of all
-# dependencies.
+# Contains the main classes for the client library.
 
-require 'rubygems'
-gem 'soap4r', '=1.5.8'
 gem 'google-ads-common', '~>0.5.0'
-require 'thread'
-require 'uri'
+
+require 'savon'
+
 require 'ads_common/api'
-require 'ads_common/auth/client_login_handler'
-require 'adwords_api/auth/v13_login_handler'
-require 'adwords_api/errors'
+require 'ads_common/auth/oauth_handler'
+require 'ads_common/savon_headers/oauth_header_handler'
+require 'ads_common/savon_headers/simple_header_handler'
 require 'adwords_api/api_config'
-require 'adwords_api/extensions'
+require 'adwords_api/client_login_header_handler'
 require 'adwords_api/credential_handler'
-require 'adwords_api/nested_header_handler'
-require 'adwords_api/single_header_handler'
-require 'adwords_api/soap4r/soap4r_logger'
-require 'adwords_api/soap4r/soap4r_patches'
-require 'adwords_api/soap4r/soap4r_response_handler'
-require 'adwords_api/utils'
+require 'adwords_api/errors'
+require 'adwords_api/v13_login_handler'
 
 # Main namespace for all the client library's modules and classes.
 module AdwordsApi
@@ -47,22 +42,24 @@ module AdwordsApi
   # Holds all the services, as well as login credentials.
   #
   class Api < AdsCommon::Api
-    # Mutex object for controlling concurrent access to API object data
-    attr_reader :mutex
-    # Number of units spent on the last operation via this API object
-    attr_accessor :last_units
-    # Number of units spent in total, via this API object
-    attr_accessor :total_units
+    # Constructor for API.
+    def initialize(provided_config = nil)
+      super(provided_config)
+      @credential_handler = AdwordsApi::CredentialHandler.new(@config)
+    end
 
     # Getter for the API service configurations
     def api_config
       AdwordsApi::ApiConfig
     end
 
-    # Auxiliary method to create a new Soap4rResponseHandler, of the type we
-    # want to use for AdWords logging
-    def create_callback_handler
-      AdwordsApi::Soap4r::Soap4rResponseHandler.new(self)
+    # Sets the logger to use.
+    def logger=(logger)
+      super(logger)
+      Savon.configure do |config|
+        config.log_level = :debug
+        config.logger = logger
+      end
     end
 
     # Retrieve single NestedHeaderHandler for v20xx and one SingleHeaderHandler
@@ -79,38 +76,36 @@ module AdwordsApi
     # - a list of SOAP header handlers; one per provided header
     #
     def soap_header_handlers(auth_handler, header_list, version, namespace)
+      auth_method = @config.read('authentication.method',
+          'ClientLogin').to_s.upcase.to_sym
+
+      handlers = []
+
       if version == :v13
-        header_handlers = header_list.map do |header|
-          AdwordsApi::SingleHeaderHandler.new(@credential_handler, auth_handler,
-              header, nil, version)
+        if auth_method == :OAUTH
+          # v13 has no OAuth support, trying to fallback to ClientLogin.
+          auth_handler = client_login_handler()
+        end
+        handlers = header_list.map do |header|
+          AdsCommon::SavonHeaders::SimpleHeaderHandler.new(
+              @credential_handler, auth_handler, header, nil, version)
         end
-        return header_handlers
       else
-        auth_method = @config.read('authentication.method',
-            'ClientLogin').to_s.upcase.to_sym
         handlers = case auth_method
           when :CLIENTLOGIN
-            ns = api_config.headers_config[:HEADER_NAMESPACE_PREAMBLE] +
+            auth_ns = api_config.headers_config[:AUTH_NAMESPACE_PREAMBLE] +
                 version.to_s
-            [AdwordsApi::NestedHeaderHandler.new(@credential_handler,
-                auth_handler, api_config.headers_config[:REQUEST_HEADER],
-                namespace, ns, version)]
+            [AdwordsApi::ClientLoginHeaderHandler.new(
+             @credential_handler, auth_handler,
+             api_config.headers_config[:REQUEST_HEADER], namespace, auth_ns,
+             version)]
           when :OAUTH
-            raise NotImplementedError, 'OAuth authentication method is not ' +
-                'supported for Soap4r backend.'
+            [AdsCommon::SavonHeaders::OAuthHeaderHandler.new(
+             @credential_handler, auth_handler,
+             api_config.headers_config[:REQUEST_HEADER], namespace, version)]
         end
-        return handlers
       end
-    end
-
-    # Constructor for Api.
-    def initialize(provided_config = nil)
-      super(provided_config)
-      @credential_handler = AdwordsApi::CredentialHandler.new(@config)
-      @drivers = {}
-      @total_units = 0
-      @last_units = 0
-      @mutex = Mutex.new
+      return handlers
     end
 
     # Accessor for client login handler, so that we can access the token.
@@ -123,7 +118,7 @@ module AdwordsApi
         environment = @config.read('service.environment')
         if auth_method == :CLIENTLOGIN
           # We use client login, so we can reuse general AuthHandler.
-          @client_login_handler = get_auth_handler(environment, nil)
+          @client_login_handler = get_auth_handler(environment)
         else
           # We are using OAuth or something else and need to generate a handler.
           auth_server = api_config.auth_server(environment)
@@ -140,10 +135,10 @@ module AdwordsApi
     # MCC-level operation and/or returns the current status of the property.
     #
     # Args:
-    # - accepts a block, which it will execute as an MCC-level operation.
+    # - accepts a block, which it will execute as an MCC-level operation
     #
     # Returns:
-    # Boolean indicating whether MCC-level operations are currently enabled or
+    # - Boolean indicating whether MCC-level operations are currently enabled or
     # disabled
     #
     def use_mcc
@@ -175,11 +170,11 @@ module AdwordsApi
     # validate-only operation and/or returns the current status of the property.
     #
     # Args:
-    # - accepts a block, which it will execute as a validate-only operation.
+    # - accepts a block, which it will execute as a validate-only operation
     #
     # Returns:
-    # Boolean indicating whether validate-only operations are currently enabled
-    # or disabled
+    # - Boolean indicating whether validate-only operations are currently
+    #   enabled or disabled
     #
     def validate_only
       if block_given?
@@ -210,10 +205,10 @@ module AdwordsApi
     # enabled and/or returns the current status of the property.
     #
     # Args:
-    # - accepts a block, which it will execute as a partial failure operation.
+    # - accepts a block, which it will execute as a partial failure operation
     #
     # Returns:
-    # Boolean indicating whether partial failure operations are currently
+    # - Boolean indicating whether partial failure operations are currently
     # enabled or disabled
     #
     def partial_failure
@@ -262,61 +257,7 @@ module AdwordsApi
     #
     def create_auth_handler(environment, version = nil)
       return (version == :v13) ?
-          AdwordsApi::Auth::V13LoginHandler.new :
-          super(environment)
-    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.
-    #
-    # Args:
-    # - version: intended API version. Must be a symbol.
-    # - service: name for the intended service
-    #
-    # Returns:
-    # - the simplified wrapper generated for the driver
-    #
-    def prepare_wrapper(version, service)
-      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 = get_auth_handler(environment, version)
-      header_list =
-          auth_handler.header_list(@credential_handler.credentials(version))
-
-      soap_handlers = soap_header_handlers(auth_handler, header_list, version,
-          wrapper.namespace)
-
-      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 =
-          AdwordsApi::Soap4r::Soap4rLogger.new(@logger, Logger::DEBUG)
-      driver.options['protocol.http.ssl_config.verify_mode'] = nil
-      proxy = config.read('connection.proxy')
-      driver.options['protocol.http.proxy'] = proxy if proxy
-
-      @drivers[version] ||= {}
-      @drivers[version][service] = driver
-      return wrapper
+          AdwordsApi::V13LoginHandler.new : super(environment)
     end
   end
 end

data/lib/adwords_api/api_config.rb

@@ -20,6 +20,8 @@
 # Helper methods for loading and managing the available services in the AdWords
 # API.
 
+require 'savon'
+
 require 'ads_common/api_config'
 
 module AdwordsApi
@@ -40,7 +42,7 @@ module AdwordsApi
     # Set other constants
     API_NAME = 'AdwordsApi'
     API_PATH = 'adwords_api'
-    CLIENT_LIB_VERSION = '0.2.1'
+    CLIENT_LIB_VERSION = '0.4.0'
     DEFAULT_CONFIG_FILENAME = 'adwords_api.yml'
 
     # Configure the services available to each version
@@ -198,7 +200,7 @@ module AdwordsApi
 
     @@headers_config = {
       :REQUEST_HEADER => 'RequestHeader',
-      :HEADER_NAMESPACE_PREAMBLE =>
+      :AUTH_NAMESPACE_PREAMBLE =>
           'https://adwords.google.com/api/adwords/cm/',
       :LOGIN_SERVICE_NAME => 'adwords'
     }
@@ -263,7 +265,13 @@ module AdwordsApi
     def self.interface_name(version, service)
       service_str = service.to_s
       service_str = service_str.sub(/Service$/, '') if version == :v13
-      return module_name(version, service) + "::#{service_str}Interface"
+      return module_name(version, service) + "::" + service_str
+    end
+
+    def self.do_require(version, service)
+      service_name = service.to_s.snakecase()
+      filename = "%s/%s/%s" % [api_path, version, service_name]
+      require filename
     end
 
     # Get the download URL for reports.

data/lib/adwords_api/client_login_header_handler.rb

@@ -0,0 +1,76 @@
+#!/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 AdwordsApi
+  class ClientLoginHeaderHandler < AdsCommon::SavonHeaders::SimpleHeaderHandler
+    # Initializes a header handler.
+    #
+    # Args:
+    #  - credential_handler: a header with credential data
+    #  - auth_handler: a header with auth data
+    #  - element_name: an API-specific name of header element
+    #  - namespace: default namespace to use
+    #  - auth_namespace: namespace to use for auth headers
+    #  - version: services version
+    #
+    def initialize(credential_handler, auth_handler, element_name,
+                   namespace, auth_namespace, version)
+      super(credential_handler, auth_handler, element_name, namespace, version)
+      @auth_namespace = auth_namespace
+    end
+
+    # Enriches soap object with API-specific headers like namespaces, login
+    # credentials etc. Sets the default namespace for the body to the one
+    # specified in initializer.
+    #
+    # Args:
+    #  - request: a HTTPI Request for extra configuration (unused)
+    #  - soap: a Savon soap object to fill fields in
+    #  - args: request parameters to adjust for namespaces
+    #
+    # Returns:
+    #  - Modified soap structure
+    #
+    def prepare_request(request, soap, args)
+      super(request, soap, args)
+      soap.header[:attributes!] ||= {}
+      header_name = prepend_namespace(@element_name)
+      soap.header[:attributes!][header_name] ||= {}
+      soap.header[:attributes!][header_name]['xmlns'] = @auth_namespace
+    end
+
+    private
+    # Skips namespace prefixes for all elements except top level. Use default
+    # (inherited) prefixing for the top level key.
+    #
+    # Args:
+    #  - str: String to prepend with a namespace
+    #
+    # Returns:
+    #  - String with a namespace
+    #
+    def prepend_namespace(str)
+      return str.equal?(@element_name) ? super(str) : str
+    end
+  end
+end