google-adwords-api 0.5.3 → 0.6.0

data/lib/adwords_api/api_config.rb

@@ -1,6 +1,6 @@
 # Encoding: utf-8
 #
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2010, Google Inc. All Rights Reserved.
 #
@@ -54,6 +54,37 @@ module AdwordsApi
           :AdGroupService,
           :AdParamService,
           :AlertService,
+          :BudgetOrderService,
+          :BulkMutateJobService,
+          :CampaignAdExtensionService,
+          :CampaignCriterionService,
+          :CampaignService,
+          :CampaignTargetService,
+          :ConstantDataService,
+          :ConversionTrackerService,
+          :CreateAccountService,
+          :CustomerSyncService,
+          :DataService,
+          :ExperimentService,
+          :GeoLocationService,
+          :InfoService,
+          :LocationCriterionService,
+          :MediaService,
+          :MutateJobService,
+          :ReportDefinitionService,
+          :ServicedAccountService,
+          :TargetingIdeaService,
+          :TrafficEstimatorService,
+          :UserListService
+      ],
+      :v201109_1 => [
+          :AdExtensionOverrideService,
+          :AdGroupAdService,
+          :AdGroupCriterionService,
+          :AdGroupService,
+          :AdParamService,
+          :AlertService,
+          :BudgetOrderService,
           :BulkMutateJobService,
           :CampaignAdExtensionService,
           :CampaignCriterionService,
@@ -82,11 +113,13 @@ module AdwordsApi
     @@environment_config = {
       :PRODUCTION => {
         :oauth_scope => 'https://adwords.google.com/api/adwords/',
-        :v201109 => 'https://adwords.google.com/api/adwords/'
+        :v201109 => 'https://adwords.google.com/api/adwords/',
+        :v201109_1 => 'https://adwords.google.com/api/adwords/'
       },
       :SANDBOX => {
         :oauth_scope => 'https://adwords-sandbox.google.com/api/adwords/',
-        :v201109 => 'https://adwords-sandbox.google.com/api/adwords/'
+        :v201109 => 'https://adwords-sandbox.google.com/api/adwords/',
+        :v201109_1 => 'https://adwords-sandbox.google.com/api/adwords/'
       }
     }
 
@@ -100,6 +133,7 @@ module AdwordsApi
       [:v201109, :AdGroupService] => 'cm/',
       [:v201109, :AdParamService] => 'cm/',
       [:v201109, :AlertService] => 'mcm/',
+      [:v201109, :BudgetOrderService] => 'billing/',
       [:v201109, :BulkMutateJobService] => 'job/',
       [:v201109, :CampaignAdExtensionService] => 'cm/',
       [:v201109, :CampaignCriterionService] => 'cm/',
@@ -120,17 +154,41 @@ module AdwordsApi
       [:v201109, :ServicedAccountService] => 'mcm/',
       [:v201109, :TargetingIdeaService] => 'o/',
       [:v201109, :TrafficEstimatorService] => 'o/',
-      [:v201109, :UserListService] => 'cm/'
+      [:v201109, :UserListService] => 'cm/',
+      # v201109_1
+      [:v201109_1, :AdExtensionOverrideService] => 'cm/',
+      [:v201109_1, :AdGroupAdService] => 'cm/',
+      [:v201109_1, :AdGroupCriterionService] => 'cm/',
+      [:v201109_1, :AdGroupService] => 'cm/',
+      [:v201109_1, :AdParamService] => 'cm/',
+      [:v201109_1, :AlertService] => 'mcm/',
+      [:v201109_1, :BudgetOrderService] => 'billing/',
+      [:v201109_1, :BulkMutateJobService] => 'job/',
+      [:v201109_1, :CampaignAdExtensionService] => 'cm/',
+      [:v201109_1, :CampaignCriterionService] => 'cm/',
+      [:v201109_1, :CampaignService] => 'cm/',
+      [:v201109_1, :CampaignTargetService] => 'cm/',
+      [:v201109_1, :ConstantDataService] => 'cm/',
+      [:v201109_1, :ConversionTrackerService] => 'cm/',
+      [:v201109_1, :CreateAccountService] => 'mcm/',
+      [:v201109_1, :CustomerSyncService] => 'ch/',
+      [:v201109_1, :DataService] => 'cm/',
+      [:v201109_1, :ExperimentService] => 'cm/',
+      [:v201109_1, :GeoLocationService] => 'cm/',
+      [:v201109_1, :InfoService] => 'info/',
+      [:v201109_1, :LocationCriterionService] => 'cm/',
+      [:v201109_1, :MediaService] => 'cm/',
+      [:v201109_1, :MutateJobService] => 'cm/',
+      [:v201109_1, :ReportDefinitionService] => 'cm/',
+      [:v201109_1, :ServicedAccountService] => 'mcm/',
+      [:v201109_1, :TargetingIdeaService] => 'o/',
+      [:v201109_1, :TrafficEstimatorService] => 'o/',
+      [:v201109_1, :UserListService] => 'cm/'
     }
 
-    # Configure the auth servers to use for each environment
-    @@auth_server_config = {
-      :PRODUCTION => 'https://www.google.com',
-      :SANDBOX => 'https://www.google.com'
-    }
-
-    @@headers_config = {
-      :REQUEST_HEADER => 'RequestHeader',
+    # Auth constants for ClientLogin method.
+    @@client_login_config = {
+      :AUTH_SERVER => 'https://www.google.com',
       :AUTH_NAMESPACE_PREAMBLE =>
           'https://adwords.google.com/api/adwords/cm/',
       :LOGIN_SERVICE_NAME => 'adwords'
@@ -159,16 +217,17 @@ module AdwordsApi
       @@service_config
     end
 
-    def self.environment_config
-      @@environment_config
+    def self.environment_config(environment, key)
+      return @@environment_config.include?(environment) ?
+          @@environment_config[environment][key] : nil
     end
 
     def self.subdir_config
       @@subdir_config
     end
 
-    def self.auth_server_config
-      @@auth_server_config
+    def self.client_login_config(key)
+      return @@client_login_config[key]
     end
 
     def self.default_config_filename
@@ -179,23 +238,6 @@ module AdwordsApi
       @@headers_config
     end
 
-    # Get the download URL for reports.
-    #
-    # Args:
-    # - environment: the service environment to be used
-    # - version: the API version (as a symbol)
-    #
-    # Returns:
-    # - The endpoint URL (as a string)
-    #
-    def self.report_download_url(environment, version)
-      base = get_wsdl_base(environment, version)
-      if base and service_config[version].include?(:ReportDefinitionService)
-        base += 'reportdownload'
-      end
-      return base
-    end
-
     # Get the download URL for Ad Hoc reports.
     #
     # Args:

data/lib/adwords_api/client_login_header_handler.rb

@@ -19,10 +19,10 @@
 #
 # Handles SOAP headers and namespaces definition for ClientLogin type header.
 
-require 'ads_common/savon_headers/simple_header_handler'
+require 'ads_common/savon_headers/base_header_handler'
 
 module AdwordsApi
-  class ClientLoginHeaderHandler < AdsCommon::SavonHeaders::SimpleHeaderHandler
+  class ClientLoginHeaderHandler < AdsCommon::SavonHeaders::BaseHeaderHandler
     # Initializes a header handler.
     #
     # Args:
@@ -33,9 +33,9 @@ module AdwordsApi
     #  - 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)
+    def initialize(credential_handler, auth_handler, namespace, auth_namespace,
+        version)
+      super(credential_handler, auth_handler, namespace, version)
       @auth_namespace = auth_namespace
     end
 
@@ -51,32 +51,15 @@ module AdwordsApi
     # Returns:
     #  - Modified soap structure
     #
-    def prepare_request(request, soap, args)
-      super(request, soap, args)
+    def prepare_request(request, soap)
+      super(request, soap)
       soap.header[:attributes!] ||= {}
-      header_name = prepend_namespace(@element_name)
+      header_name = prepend_namespace(get_header_element_name())
       soap.header[:attributes!][header_name] ||= {}
       soap.header[:attributes!][header_name]['xmlns'] = @auth_namespace
     end
 
     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()
-      headers = @auth_handler.headers(@credential_handler.credentials(@version))
-      return headers.inject({}) do |request_header, (header, value)|
-        request_header[prepend_namespace(header)] = value
-        request_header
-      end
-    end
-
     # Skips namespace prefixes for all elements except top level. Use default
     # (inherited) prefixing for the top level key.
     #
@@ -87,7 +70,15 @@ module AdwordsApi
     #  - String with a namespace
     #
     def prepend_namespace(str)
-      return str.equal?(@element_name) ? super(str) : str
+      return get_header_element_name().eql?(str) ? super(str) : str
+    end
+
+    # Generates AdWords API specific request header with ClientLogin data.
+    def generate_request_header()
+      request_header = super()
+      credentials = @credential_handler.credentials
+      request_header['authToken'] = @auth_handler.get_token(credentials)
+      return request_header
     end
   end
 end

data/lib/adwords_api/credential_handler.rb

@@ -1,7 +1,6 @@
 # Encoding: utf-8
 #
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
-#           api.dklimkin@gmail.com (Danial Klimkin)
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2010, Google Inc. All Rights Reserved.
 #
@@ -41,42 +40,27 @@ module AdwordsApi
 
     # Create the list of credentials to be used by the auth handler for header
     # generation.
-    def credentials(version = nil)
-      validate_headers_for_server(version)
-      result = case @credentials[:method]
-        when :CLIENTLOGIN
-          {:email => @credentials[:email],
-           :password => @credentials[:password],
-           :logintoken => @credentials[:logintoken],
-           :logincaptcha => @credentials[:logincaptcha]}
-        when :OAUTH
-          {:oauth_consumer_key => @credentials[:oauth_consumer_key],
-           :oauth_consumer_secret => @credentials[:oauth_consumer_secret],
-           :oauth_verification_code => @credentials[:oauth_verification_code],
-           :oauth_token => @credentials[:oauth_token],
-           :oauth_token_secret => @credentials[:oauth_token_secret],
-           :oauth_callback => @credentials[:oauth_callback],
-           :oauth_method => @credentials[:oauth_method],
-           :oauth_request_token => @credentials[:oauth_request_token]}
-      end
-      client_lib = 'AwApi-Ruby-%s|' % AdwordsApi::ApiConfig::CLIENT_LIB_VERSION
-      user_agent = @credentials[:user_agent] || $0
-      user_agent = client_lib + user_agent
-      user_agent_symbol = (version == :v13) ? :useragent : :userAgent
-      result[user_agent_symbol] = user_agent
-      result[:developerToken] = @credentials[:developer_token]
-      unless @use_mcc
-        if @credentials[:client_customer_id]
-          result[:clientCustomerId] = @credentials[:client_customer_id]
-        elsif @credentials[:client_email] and version != :v201109
-          result[:clientEmail] = @credentials[:client_email]
-        end
-      end
-      if version != :v13
-        result[:validateOnly] = 'true' if @validate_only
-        result[:partialFailure] = 'true' if @partial_failure
+    def credentials(credentials_override = nil)
+      result = super(credentials_override)
+      validate_headers_for_server(result)
+
+      extra_headers = {
+        'userAgent' => generate_soap_user_agent(),
+        'developerToken' => result[:developer_token]
+      }
+      if !@use_mcc and result[:client_customer_id]
+        extra_headers['clientCustomerId'] = result[:client_customer_id]
       end
-      return result.reject {|k,v| v.nil?}
+      extra_headers['validateOnly'] = 'true' if @validate_only
+      extra_headers['partialFailure'] = 'true' if @partial_failure
+      result[:extra_headers] = extra_headers
+      return result
+    end
+
+    # Generates string to user as user agent in SOAP headers.
+    def generate_soap_user_agent(extra_ids = [])
+      extra_ids << ["AwApi-Ruby-%s" % AdwordsApi::ApiConfig::CLIENT_LIB_VERSION]
+      super(extra_ids)
     end
 
     private
@@ -84,25 +68,19 @@ module AdwordsApi
     # Validates that the right credentials are being used for the chosen
     # environment.
     #
-    # Args:
-    # - version: API version to validate for
-    #
     # Raises:
     # - AdsCommon::Error::EnvironmentMismatchError if sandbox credentials are
     # being used for production or vice-versa.
     # - AdwordsApi::Errors:BadCredentialsError if supplied credentials are not
     # valid.
     #
-    def validate_headers_for_server(version)
-      token = @credentials[:developer_token]
-      client_email = @credentials[:client_email]
-
-      if client_email and version == :v201109
+    def validate_headers_for_server(credentials)
+      if credentials[:client_email]
         raise AdwordsApi::Errors::BadCredentialsError, 'Deprecated header ' +
             'clientEmail is no longer supported, please use clientCustomerId'
       end
 
-      client_customer_id = @credentials[:client_customer_id]
+      client_customer_id = credentials[:client_customer_id]
       if client_customer_id and
           !(client_customer_id.is_a?(Integer) or
             (client_customer_id =~ /^\d+(-\d+-\d+)?$/))
@@ -110,35 +88,21 @@ module AdwordsApi
             'Invalid client customer ID: %s' % client_customer_id.to_s
       end
 
-      (sandbox_token, sandbox_client) = case @credentials[:method]
-        when :CLIENTLOGIN
-          email = @credentials[:email]
-          [(token =~ /#{Regexp.escape(email)}\+\+[a-zA-Z]{3}/),
-           (client_email =~ /client_[1-5]\+#{Regexp.escape(email)}/)]
-        when :OAUTH
-          [(token =~ /.+@.+\+\+[a-zA-Z]{3}/),
-           (client_email =~ /client_[1-5]\+.+@.+/)]
-        else
-          [nil, nil]
-      end
+      token = credentials[:developer_token]
+      sandbox_token = (token =~ /.+@.+\+\+[a-zA-Z]{3}/)
       environment = @config.read('service.environment')
       case environment
         when :PRODUCTION
-          # Only check the token, because 'client_n+x@y.tld' may be a valid
-          # client email for some customers.
           if sandbox_token
             raise AdsCommon::Errors::EnvironmentMismatchError,
                 'Attempting to connect to production with sandbox credentials.'
           end
         when :SANDBOX
-          # Check if either the token or client email do not follow the
-          # correct format. Client email may not exist, though.
-          if (!sandbox_token or (client_email and !sandbox_client))
+          if (!sandbox_token)
             raise AdsCommon::Errors::EnvironmentMismatchError,
                 'Attempting to connect to the sandbox with malformatted ' +
-                'credentials. Please check ' +
-                'http://code.google.com/apis/adwords/docs/developer/' +
-                'adwords_api_sandbox.html#requestheaders for details.'
+                'credentials. Please check http://code.google.com/apis/' +
+                'adwords/docs/sandbox.html#request-headers for details.'
           end
       end
       return nil

data/lib/adwords_api/report_header_handler.rb

@@ -0,0 +1,65 @@
+# Encoding: utf-8
+#
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 HTTP headers for AdHoc reporting requests.
+
+module AdwordsApi
+  class ReportHeaderHandler
+
+    # Initializes a header handler.
+    #
+    # Args:
+    #  - credential_handler: a header with credential data
+    #  - auth_handler: a header with auth data
+    #  - config: API config
+    #
+    def initialize(credential_handler, auth_handler, config)
+      @credential_handler = credential_handler
+      @auth_handler = auth_handler
+      @config = config
+    end
+
+    # Returns the headers set for the report request.
+    #
+    # Args:
+    #  - url: URL for the report requests
+    #  - cid: clientCustomerId to use
+    #
+    # Returns:
+    #  - a Hash with HTTP headers.
+    #
+    def headers(url, cid)
+      override = (cid.nil?) ? nil : {:client_customer_id => cid}
+      credentials = @credential_handler.credentials(override)
+      headers = {
+          'Content-Type' => 'application/x-www-form-urlencoded',
+          'Authorization' =>
+              @auth_handler.auth_string(credentials, HTTPI::Request.new(url)),
+          'clientCustomerId' => credentials[:client_customer_id],
+          'developerToken' => credentials[:developer_token],
+          'userAgent' => @credential_handler.generate_http_user_agent()
+      }
+      money_in_micros = @config.read('library.return_money_in_micros')
+      unless money_in_micros.nil?
+        headers['returnMoneyInMicros'] = money_in_micros
+      end
+      return headers
+    end
+  end
+end

data/lib/adwords_api/report_utils.rb

@@ -21,10 +21,10 @@
 
 require 'cgi'
 require 'gyoku'
-require 'httpi/request'
 
 require 'ads_common/http'
 require 'adwords_api/errors'
+require 'adwords_api/report_header_handler'
 
 module AdwordsApi
   class ReportUtils
@@ -101,6 +101,7 @@ module AdwordsApi
       url = @api.api_config.adhoc_report_download_url(
           @api.config.read('service.environment'), @version)
       headers = get_report_request_headers(url, cid)
+      log_request(url, headers, definition_text)
       response = AdsCommon::Http.post_response(url, data, @api.config, headers)
       check_for_errors(response)
       return response
@@ -121,29 +122,9 @@ module AdwordsApi
 
     # Prepares headers for report request.
     def get_report_request_headers(url, cid)
-      credentials = @api.credential_handler.credentials
-      auth_handler = @api.get_auth_handler(
-          @api.config.read('service.environment'), @version)
-      auth_string = auth_handler.auth_string(
-          credentials, HTTPI::Request.new(url))
-      customer_id = validate_cid(cid || credentials[:clientCustomerId])
-      app_name = credentials[:userAgent] || credentials[:useragent]
-      headers = {
-          'Authorization' => auth_string,
-          'ClientCustomerId' => customer_id,
-          'Content-Type' => 'application/x-www-form-urlencoded',
-          'developerToken' => credentials[:developerToken],
-          'User-Agent' => "HTTPI/%s (%s)" % [HTTPI::VERSION, app_name]
-      }
-      if @api.config.read('connection.enable_gzip', false)
-        headers['User-Agent'] += ' (gzip)'
-        headers['Accept-Encoding'] = 'gzip,deflate'
-      end
-      money_in_micros = @api.config.read('library.return_money_in_micros')
-      unless money_in_micros.nil?
-        headers['returnMoneyInMicros'] = money_in_micros
-      end
-      return headers
+      @header_handler ||= AdwordsApi::ReportHeaderHandler.new(
+          @api.credential_handler, @api.get_auth_handler(), @api.config)
+      return @header_handler.headers(url, cid)
     end
 
     # Saves raw data to a file.
@@ -151,18 +132,13 @@ module AdwordsApi
       open(path, 'wb') { |file| file.write(data) } if path
     end
 
-    # Validates the customer ID specified is correct.
-    def validate_cid(cid)
-      if (cid.kind_of?(Integer) || (
-          cid.kind_of?(String) && (
-              ((/\d{3}-\d{3}-\d{4}/ =~ cid) == 0) ||
-              ((/\d{10}/ =~ cid) == 0)
-          )))
-        return cid
-      else
-        raise AdwordsApi::Errors::BadCredentialsError,
-            "Invalid client customer ID: %s" % cid
-      end
+    # Logs the request on debug level.
+    def log_request(url, headers, body)
+      logger = @api.logger
+      logger.debug("Report request to: '%s'" % url)
+      logger.debug("HTTP headers: [%s]" %
+          (headers.map {|k, v| [k, v].join(': ')}.join(', ')))
+      logger.debug(body)
     end
 
     # Checks downloaded data for error signature. Raises ReportError if it