google-adwords-api 0.1.2 → 0.2.0

data/examples/v201101/handle_partial_failures.rb

@@ -31,6 +31,11 @@ def handle_partial_failures()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
@@ -101,11 +106,6 @@ def handle_partial_failures()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     handle_partial_failures()
 

data/examples/v201101/handle_policy_violation_error.rb

@@ -32,6 +32,11 @@ def handle_policy_violation_error()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
   ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
@@ -112,11 +117,6 @@ def handle_policy_violation_error()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     handle_policy_violation_error()
 

data/examples/v201101/perform_bulk_mutate_job.rb

@@ -32,6 +32,11 @@ def perform_bulk_mutate_job()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
 
   campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
@@ -187,11 +192,6 @@ def perform_bulk_mutate_job()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     perform_bulk_mutate_job()
 

data/examples/v201101/promote_experiment.rb

@@ -33,6 +33,11 @@ def promote_experiment()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   experiment_srv = adwords.service(:ExperimentService, API_VERSION)
 
   experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
@@ -54,11 +59,6 @@ def promote_experiment()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     promote_experiment()
 

data/examples/v201101/set_ad_params.rb

@@ -33,6 +33,11 @@ def set_ad_params()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
   ad_param_srv = adwords.service(:AdParamService, API_VERSION)
 
@@ -90,11 +95,6 @@ def set_ad_params()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     set_ad_params()
 

data/examples/v201101/set_campaign_targets.rb

@@ -32,6 +32,11 @@ def set_campaign_targets()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   campaign_target_srv = adwords.service(:CampaignTargetService, API_VERSION)
 
   campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
@@ -77,11 +82,6 @@ def set_campaign_targets()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     set_campaign_targets()
 

data/examples/v201101/update_ad.rb

@@ -32,6 +32,11 @@ def update_ad()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
   ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
@@ -61,11 +66,6 @@ def update_ad()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     update_ad()
 

data/examples/v201101/update_ad_group.rb

@@ -32,6 +32,11 @@ def update_ad_group()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
 
   ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
@@ -56,11 +61,6 @@ def update_ad_group()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     update_ad_group()
 

data/examples/v201101/update_ad_group_criterion.rb

@@ -32,6 +32,11 @@ def update_ad_group_criterion()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
@@ -74,11 +79,6 @@ def update_ad_group_criterion()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     update_ad_group_criterion()
 

data/examples/v201101/update_campaign.rb

@@ -32,6 +32,11 @@ def update_campaign()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   campaign_srv = adwords.service(:CampaignService, API_VERSION)
 
   campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
@@ -59,11 +64,6 @@ def update_campaign()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     update_campaign()
 

data/examples/v201101/update_conversion.rb

@@ -32,6 +32,11 @@ def update_conversion()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
 
   conversion_id = 'INSERT_CONVERSION_ID_HERE'.to_i
@@ -62,11 +67,6 @@ def update_conversion()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     update_conversion()
 

data/examples/v201101/update_user_list.rb

@@ -32,6 +32,11 @@ def update_user_list()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   user_list_srv = adwords.service(:UserListService, API_VERSION)
 
   user_list_id = 'INSERT_USER_LIST_ID_HERE'.to_i
@@ -57,11 +62,6 @@ def update_user_list()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     update_user_list()
 

data/examples/v201101/upload_image.rb

@@ -32,10 +32,16 @@ def upload_image()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
   media_srv = adwords.service(:MediaService, API_VERSION)
 
   # Create image.
-  image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
+  image_url =
+      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
   # This utility method retrieves the contents of a URL using all of the config
   # options provided to the Api object.
   image_data = AdsCommon::Http.get(image_url, adwords.config)
@@ -63,11 +69,6 @@ def upload_image()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     upload_image()
 

data/lib/adwords_api.rb

@@ -22,14 +22,16 @@
 
 require 'rubygems'
 gem 'soap4r', '=1.5.8'
-gem 'google-ads-common', '~>0.2.1'
+gem 'google-ads-common', '~>0.4.0'
 require 'thread'
 require 'uri'
-require 'ads_common/logger'
 require 'ads_common/soap4r_patches'
 require 'ads_common/api'
 require 'ads_common/config'
 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_logger'
 require 'adwords_api/auth/v13_login_handler'
 require 'adwords_api/errors'
 require 'adwords_api/api_config'
@@ -46,11 +48,6 @@ module AdwordsApi
   # Holds all the services, as well as login credentials.
   #
   class Api < AdsCommon::Api
-
-    REQUEST_HEADER = 'RequestHeader'
-    HEADER_NAMESPACE_PREAMBLE = 'https://adwords.google.com/api/adwords/cm/'
-    LOGIN_SERVICE_NAME = 'adwords'
-
     # 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
@@ -96,31 +93,23 @@ module AdwordsApi
         end
         return header_handlers
       else
-        ns = HEADER_NAMESPACE_PREAMBLE + version.to_s
+        ns =
+            api_config.headers_config[:HEADER_NAMESPACE_PREAMBLE] + version.to_s
         top_ns = wrapper.namespace
         return [AdsCommon::Soap4rHeaders::NestedHeaderHandler.new(
-            @credential_handler, auth_handler, REQUEST_HEADER, top_ns, ns,
-            version)]
+            @credential_handler, auth_handler,
+            api_config.headers_config[:REQUEST_HEADER],
+            top_ns, ns, version)]
       end
     end
 
     # Constructor for Api.
     def initialize(provided_config = nil)
-      load_config(provided_config)
+      super(provided_config)
       @credential_handler = AdwordsApi::CredentialHandler.new(@config)
-      environment = config.read('service.environment').upcase.to_sym
-      if !api_config.environments.include? environment
-        raise AdsCommon::Errors::Error,
-            "Unknown environment #{environment}"
-      end
       @drivers = Hash.new
-      @wrappers = Hash.new
       @total_units = 0
       @last_units = 0
-      log_to_console = !ENV['ADWORDSAPI_DEBUG'].nil? &&
-          ENV['ADWORDSAPI_DEBUG'].upcase == 'TRUE'
-      @xml_logger = AdsCommon::Logger.new('soap_xml', log_to_console)
-      @request_logger = AdsCommon::Logger.new('request_info')
       @mutex = Mutex.new
     end
 
@@ -240,7 +229,7 @@ module AdwordsApi
     # Returns:
     # - auth handler
     #
-    def create_auth_handler(version, environment)
+    def create_auth_handler(environment, version)
       if version == :v13
         return AdwordsApi::Auth::V13LoginHandler.new
       else
@@ -248,22 +237,62 @@ module AdwordsApi
           auth_server = api_config.auth_server(environment)
           @client_login_handler =
               AdsCommon::Auth::ClientLoginHandler.new(config, auth_server,
-                  LOGIN_SERVICE_NAME)
+                  api_config.headers_config[:LOGIN_SERVICE_NAME])
         end
         return @client_login_handler
       end
     end
 
-    # Helper method to load the default configuration file or a given config.
+    # 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:
-    # - provided_config: a configuration hash, if you wish to use a specific
-    #   configuration rather than use the default
+    # - version: intended API version. Must be a symbol.
+    # - service: name for the intended service
     #
-    def load_config(provided_config = nil)
-      @config = (provided_config.nil?) ?
-          AdsCommon::Config.new(File.join(ENV['HOME'], 'adwords_api.yml')) :
-          AdsCommon::Config.new(provided_config)
+    # 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 = create_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)
+
+      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')
+      driver.options['protocol.http.proxy'] = proxy if proxy
+
+      @drivers[version] ||= {}
+      @drivers[version][service] = driver
+      return wrapper
     end
   end
 end