google-adwords-api 1.4.0 → 1.6.0

data/lib/adwords_api/report_header_handler.rb

@@ -1,80 +0,0 @@
-# Encoding: utf-8
-#
-# 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),
-          'User-Agent' => @credential_handler.generate_user_agent(),
-          'clientCustomerId' => credentials[:client_customer_id].to_s,
-          'developerToken' => credentials[:developer_token]
-      }
-      skip_report_header = @config.read('library.skip_report_header')
-      unless skip_report_header.nil?
-        headers['skipReportHeader'] = skip_report_header.to_s
-      end
-      skip_report_summary = @config.read('library.skip_report_summary')
-      unless skip_report_summary.nil?
-        headers['skipReportSummary'] = skip_report_summary.to_s
-      end
-      skip_column_header = @config.read('library.skip_column_header')
-      unless skip_column_header.nil?
-        headers['skipColumnHeader'] = skip_column_header.to_s
-      end
-      include_zero_impressions =
-          @config.read('library.include_zero_impressions')
-      unless include_zero_impressions.nil?
-        headers['includeZeroImpressions'] = include_zero_impressions.to_s
-      end
-      use_raw_enum_values =
-          @config.read('library.use_raw_enum_values')
-      unless use_raw_enum_values.nil?
-        headers['useRawEnumValues'] = use_raw_enum_values.to_s
-      end
-      return headers
-    end
-  end
-end

data/lib/adwords_api/report_stream.rb

@@ -1,70 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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.
-#
-# Includes a way to iterate over a report stream by line, rather than in
-# arbitrary chunks.
-
-module AdwordsApi
-  class ReportStream
-    def initialize(report_utils, report_definition, cid = nil, format = nil,
-        is_awql = false)
-      @report_utils = report_utils
-      @report_definition = report_definition
-      @format = format
-      @cid = cid
-      @is_awql = is_awql
-    end
-
-    def self.set_up(report_utils, report_definition, cid = nil)
-      return ReportStream.new(report_utils, report_definition, cid)
-    end
-
-    def self.set_up_with_awql(
-        report_utils, report_query, format, cid = nil)
-      return ReportStream.new(
-          report_utils, report_query, cid, format, true)
-    end
-
-    def each_line()
-      # Determine which method and arguments to use depending on whether
-      # this is an AWQL request or not.
-      method = 'download_report_as_stream'
-      method += '_with_awql' if @is_awql
-      args = [@report_definition]
-      args << @format if @is_awql
-      args << @cid
-
-      leftover_data = ''
-      @report_utils.send(method, *args) do |batch|
-        data_to_process = leftover_data + batch
-        leftover_data = ''
-        while !data_to_process.valid_encoding?
-          leftover_data = data_to_process[-1] + leftover_data
-          data_to_process = data_to_process[0, data_to_process.length - 1]
-        end
-        lines = data_to_process.each_line.map {|line| line}
-        remainder = lines.pop
-        leftover_data = remainder + leftover_data unless remainder.nil?
-        lines.each do |line|
-          yield line.chomp
-        end
-      end
-      yield leftover_data.chomp unless
-          leftover_data.nil? || leftover_data.empty?
-    end
-  end
-end

data/lib/adwords_api/report_utils.rb

@@ -1,383 +0,0 @@
-# Encoding: utf-8
-#
-# 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.
-#
-# Contains utility methods specific to reporting.
-
-require 'cgi'
-require 'gyoku'
-require 'nori'
-
-require 'ads_common/http'
-require 'adwords_api/errors'
-require 'adwords_api/report_header_handler'
-require 'adwords_api/report_stream'
-
-module AdwordsApi
-  class ReportUtils
-    # Default constructor.
-    #
-    # Args:
-    # - api: AdwordsApi object
-    # - version: API version to use
-    #
-    def initialize(api, version)
-      @api, @version = api, version
-    end
-
-    # Downloads and returns a report.
-    #
-    # Args:
-    # - report_definition: definition of the report in XML text or hash
-    # - cid: optional customer ID to run against
-    #
-    # Returns:
-    # - report body
-    #
-    # Raises:
-    # - AdwordsApi::Errors::InvalidReportDefinitionError if the report
-    #   definition is invalid
-    # - AdwordsApi::Errors::ReportError if server-side error occurred
-    #
-    def download_report(report_definition, cid = nil)
-      return get_report_response(report_definition, cid).body
-    end
-
-    # Downloads a report and saves it to a file.
-    #
-    # Args:
-    # - report_definition: definition of the report in XML text or hash
-    # - path: path to save report to
-    # - cid: optional customer ID to run against
-    #
-    # Returns:
-    # - nil
-    #
-    # Raises:
-    # - AdwordsApi::Errors::InvalidReportDefinitionError if the report
-    #   definition is invalid
-    # - AdwordsApi::Errors::ReportError if server-side error occurred
-    #
-    def download_report_as_file(report_definition, path, cid = nil)
-      report_body = download_report(report_definition, cid)
-      save_to_file(report_body, path)
-      return nil
-    end
-
-    # Streams a report as a string to the given block. This method will not do
-    # error checking on returned values.
-    #
-    # Args:
-    # - report_definition: definition of the report in XML text or hash
-    # - path: path to save report to
-    # - cid: optional customer ID to run against
-    #
-    # Returns:
-    # - nil
-    #
-    # Raises:
-    # - AdwordsApi::Errors::InvalidReportDefinitionError if the report
-    #   definition is invalid
-    #
-    def download_report_as_stream(report_definition, cid = nil, &block)
-      return get_report_response(report_definition, cid, &block)
-    end
-
-    # Returns a helper object that can manage breaking the streamed report
-    # results into individual lines.
-    #
-    # Args:
-    # - report_definition: definition of the report in XML text or hash
-    # - path: path to save report to
-    # - cid: optional customer ID to run against
-    #
-    # Returns:
-    # - ReportStream object initialized to begin streaming.
-    #
-    # Raises:
-    # - AdwordsApi::Errors::InvalidReportDefinitionError if the report
-    #   definition is invalid
-    #
-    def get_stream_helper(report_definition, cid = nil)
-      return AdwordsApi::ReportStream.set_up(
-          self, report_definition, cid)
-    end
-
-    # Downloads and returns a report with AWQL.
-    #
-    # Args:
-    # - report_query: query for the report as string
-    # - format: format for the report as string
-    # - cid: optional customer ID to run report against
-    #
-    # Returns:
-    # - report body
-    #
-    # Raises:
-    # - AdwordsApi::Errors::ReportError if a server-side error has occurred
-    #
-    def download_report_with_awql(report_query, format, cid = nil)
-      return get_report_response_with_awql(report_query, format, cid).body
-    end
-
-    # Downloads a report with AWQL and saves it to a file.
-    #
-    # Args:
-    # - report_query: query for the report as string
-    # - format: format for the report as string
-    # - path: path to save report to
-    # - cid: optional customer ID to run report against
-    #
-    # Returns:
-    # - nil
-    #
-    # Raises:
-    # - AdwordsApi::Errors::ReportError if server-side error occurred
-    #
-    def download_report_as_file_with_awql(report_query, format, path, cid = nil)
-      report_body = download_report_with_awql(report_query, format, cid)
-      save_to_file(report_body, path)
-      return nil
-    end
-
-    # Streams a report with AWQL as a string to the given block.  This method
-    # will not do error checking on returned values.
-    #
-    # Args:
-    # - report_query: query for the report as string
-    # - format: format for the report as string
-    # - cid: optional customer ID to run report against
-    #
-    # Returns:
-    # - nil
-    #
-    def download_report_as_stream_with_awql(
-        report_query, format, cid = nil, &block)
-      return get_report_response_with_awql(report_query, format, cid, &block)
-    end
-
-    # Returns a helper object that can manage breaking the streamed report
-    # results into individual lines.
-    #
-    # Args:
-    # - report_query: query for the report as string
-    # - format: format for the report as string
-    # - cid: optional customer ID to run report against
-    #
-    # Returns:
-    # - ReportStream object initialized to begin streaming.
-    #
-    def get_stream_helper_with_awql(report_query, format, cid = nil)
-      return AdwordsApi::ReportStream.set_up_with_awql(
-          self, report_query, format, cid)
-    end
-
-    private
-
-    # Minimal set of required fields for report definition.
-    REQUIRED_FIELDS = [:selector, :report_name, :report_type, :date_range_type]
-
-    # Definition fields have to be in particular order in the XML. Here is its
-    # specification.
-    REPORT_DEFINITION_ORDER = {
-      :root => [:selector, :report_name, :report_type, :date_range_type,
-          :download_format],
-      :selector => [:fields, :predicates, :date_range, :ordering, :paging],
-      :predicates => [:field, :operator, :values],
-      :ordering => [:field, :sort_order],
-      :paging => [:start_index, :number_results],
-      :date_range => [:min, :max]
-    }
-
-    # Send POST request for a report and returns Response object.
-    def get_report_response(report_definition, cid, &block)
-      definition_text = get_report_definition_text(report_definition)
-      data = '__rdxml=%s' % CGI.escape(definition_text)
-      return make_adhoc_request(data, cid, &block)
-    end
-
-    # Send POST request for a report with AWQL and returns Response object.
-    def get_report_response_with_awql(report_query, format, cid, &block)
-      data = '__rdquery=%s&__fmt=%s' %
-          [CGI.escape(report_query), CGI.escape(format)]
-      return make_adhoc_request(data, cid, &block)
-    end
-
-    # Makes request and AdHoc service and returns response.
-    def make_adhoc_request(data, cid, &block)
-      @api.utils_reporter.report_utils_used()
-      url = @api.api_config.adhoc_report_download_url(@version)
-      headers = get_report_request_headers(url, cid)
-      log_request(url, headers, data)
-      # A given block indicates that we should make a stream request and yield
-      # the results, rather than return a full response.
-      if block_given?
-        AdsCommon::Http.post_stream(url, data, @api.config, headers, &block)
-        return nil
-      else
-        response = AdsCommon::Http.post_response(
-            url, data, @api.config, headers)
-        log_headers(response.headers)
-        check_for_errors(response)
-        return response
-      end
-    end
-
-    # Converts passed object to XML text. Currently support String (no changes)
-    # and Hash (renders XML).
-    def get_report_definition_text(report_definition)
-      return case report_definition
-        when String then report_definition
-        when Hash then report_definition_to_xml(report_definition)
-        else
-          raise AdwordsApi::Errors::InvalidReportDefinitionError,
-              'Unknown object for report definition: %s' %
-              report_definition.class
-      end
-    end
-
-    # Prepares headers for report request.
-    def get_report_request_headers(url, cid)
-      @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.
-    def save_to_file(data, path)
-      open(path, 'wb') { |file| file.write(data) } if path
-    end
-
-    # Logs the request on debug level.
-    def log_request(url, headers, body)
-      @api.logger.debug("Report request to: '%s'" % url)
-      log_headers(headers)
-      @api.logger.debug(body)
-    end
-
-    # Logs HTTP headers on debug level.
-    def log_headers(headers)
-      @api.logger.debug('HTTP headers: [%s]' %
-          (headers.map { |k, v| [k, v].join(': ') }.join(', ')))
-    end
-
-    # Checks downloaded data for error signature. Raises ReportError if it
-    # detects an error.
-    def check_for_errors(response)
-      # Check for error code.
-      if response.code != 200
-        # Check for error in body.
-        report_body = response.body
-        check_for_xml_error(report_body, response.code)
-        # No XML error found nor raised, falling back to a default message.
-        raise AdwordsApi::Errors::ReportError.new(response.code,
-            'HTTP code: %d, body: %s' % [response.code, response.body])
-      end
-      return nil
-    end
-
-    # Checks for an XML error in the response body and raises an exception if
-    # it was found.
-    def check_for_xml_error(report_body, response_code)
-      unless report_body.nil?
-        error_response = get_nori().parse(report_body)
-        if error_response.include?(:report_download_error) and
-            error_response[:report_download_error].include?(:api_error)
-          api_error = error_response[:report_download_error][:api_error]
-          raise AdwordsApi::Errors::ReportXmlError.new(response_code,
-              api_error[:type], api_error[:trigger], api_error[:field_path])
-        end
-      end
-    end
-
-    # Renders a report definition hash into XML text.
-    def report_definition_to_xml(report_definition)
-      check_report_definition_hash(report_definition)
-      add_report_definition_hash_order(report_definition)
-      begin
-        return Gyoku.xml({:report_definition => report_definition})
-      rescue ArgumentError => e
-        if e.message.include?("order!")
-          unknown_fields =
-              e.message.slice(e.message.index('['), e.message.length)
-          raise AdwordsApi::Errors::InvalidReportDefinitionError,
-              "Unknown report definition field(s): %s" % unknown_fields
-        end
-        raise e
-      end
-    end
-
-    # Checks if the report definition looks correct.
-    def check_report_definition_hash(report_definition)
-      # Minimal set of fields required.
-      REQUIRED_FIELDS.each do |field|
-        unless report_definition.include?(field)
-          raise AdwordsApi::Errors::InvalidReportDefinitionError,
-              "Required field '%s' is missing in the definition" % field
-        end
-      end
-      # Fields list is also required.
-      unless report_definition[:selector].include?(:fields)
-        raise AdwordsApi::Errors::InvalidReportDefinitionError,
-            'Fields list is required'
-      end
-      # 'Fields' must be an Array.
-      unless report_definition[:selector][:fields].kind_of?(Array)
-        raise AdwordsApi::Errors::InvalidReportDefinitionError,
-            'Fields list must be an array'
-      end
-      # We should request at least one field.
-      if report_definition[:selector][:fields].empty?
-        raise AdwordsApi::Errors::InvalidReportDefinitionError,
-            'At least one field needs to be requested'
-      end
-    end
-
-    # Adds fields order hint to generator based on specification.
-    def add_report_definition_hash_order(node, name = :root)
-      def_order = REPORT_DEFINITION_ORDER[name]
-      var_order = def_order.reject { |field| !node.include?(field) }
-      node.keys.each do |key|
-        if REPORT_DEFINITION_ORDER.include?(key)
-          case node[key]
-            when Hash
-              add_report_definition_hash_order(node[key], key)
-            when Array
-              node[key].each do |item|
-                add_report_definition_hash_order(item, key)
-              end
-          end
-        end
-      end
-      node[:order!] = var_order
-      return nil
-    end
-
-    def get_nori()
-      return @nori if @nori
-
-      nori_options = {
-        :strip_namespaces      => true,
-        :convert_tags_to       => lambda { |tag| tag.snakecase.to_sym },
-        :advanced_typecasting  => false
-      }
-
-      @nori = Nori.new(nori_options)
-
-      return @nori
-    end
-  end
-end

data/lib/adwords_api/utils.rb

@@ -1,56 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2010, 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.
-#
-# Contains global utility methods.
-
-module AdwordsApi
-  module Utils
-
-    # Returns the source operation index for an error.
-    #
-    # Args:
-    # - error: the error to be analyzed
-    #
-    # Returns:
-    # - index for the source operation, nil if none
-    #
-    def self.operation_index_for_error(error)
-      if error and error[:field_path] and error[:field_path].kind_of?(String)
-        match = error[:field_path].match(/operations\[(\d+)\]/)
-        return match ? match[1].to_i : nil
-      end
-      return nil
-    end
-
-    # Auxiliary method to format an ID to the pattern ###-###-####.
-    #
-    # Args:
-    # - id: ID in unformatted form
-    #
-    # Returns:
-    # - string containing the formatted ID
-    #
-    def self.format_id(id)
-      str_id = id.to_s.gsub(/\D/, '')
-      if str_id.size >= 7
-        str_array = str_id.scan(/(\d{3})(\d{3})(\d+)/)
-        str_id = str_array.join('-') unless str_array.empty?
-      end
-      return str_id
-    end
-  end
-end

data/lib/adwords_api/utils_reporter.rb

@@ -1,58 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2016, 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.
-#
-# Contains methods to help configure the user agent string to report on utility
-# usage.
-
-require 'adwords_api/credential_handler'
-
-module AdwordsApi
-  class UtilsReporter
-    # Default constructor.
-    #
-    # Args:
-    # - credential_handler: The CredentialHandler being used by the current
-    # AdwordsApi instance.
-    def initialize(credential_handler)
-      @credential_handler = credential_handler
-    end
-
-    # A callback method from report utils to indicate that it has been used,
-    # and that its usage should be recorded in the next user agent string.
-    def report_utils_used()
-      @credential_handler.include_in_user_agent("ReportDownloader")
-    end
-
-    # A callback method from batch job utils to indicate that it has been used,
-    # and that its usage should be recorded in the next user agent string.
-    def batch_job_utils_used()
-      @credential_handler.include_in_user_agent("BatchJobHelper")
-    end
-
-    # A callback method from report query builder to indicate that it has been
-    # used, and that its usage should be recorded in the next user agent string.
-    def report_query_builder_used()
-      @credential_handler.include_in_user_agent("ReportQueryBuilder")
-    end
-
-    # A callback method from service query builder to indicate that it has been
-    # used, and that its usage should be recorded in the next user agent string.
-    def service_query_builder_used()
-      @credential_handler.include_in_user_agent("ServiceQueryBuilder")
-    end
-  end
-end

data/lib/adwords_api/v201710/account_label_service.rb

@@ -1,46 +0,0 @@
-# Encoding: utf-8
-#
-# This is auto-generated code, changes will be overwritten.
-#
-# Copyright:: Copyright 2017, Google Inc. All Rights Reserved.
-# License:: Licensed under the Apache License, Version 2.0.
-#
-# Code generated by AdsCommon library 1.0.0 on 2017-10-11 08:45:02.
-
-require 'ads_common/savon_service'
-require 'adwords_api/v201710/account_label_service_registry'
-
-module AdwordsApi; module V201710; module AccountLabelService
-  class AccountLabelService < AdsCommon::SavonService
-    def initialize(config, endpoint)
-      namespace = 'https://adwords.google.com/api/adwords/mcm/v201710'
-      super(config, endpoint, namespace, :v201710)
-    end
-
-    def get(*args, &block)
-      return execute_action('get', args, &block)
-    end
-
-    def get_to_xml(*args)
-      return get_soap_xml('get', args)
-    end
-
-    def mutate(*args, &block)
-      return execute_action('mutate', args, &block)
-    end
-
-    def mutate_to_xml(*args)
-      return get_soap_xml('mutate', args)
-    end
-
-    private
-
-    def get_service_registry()
-      return AccountLabelServiceRegistry
-    end
-
-    def get_module()
-      return AdwordsApi::V201710::AccountLabelService
-    end
-  end
-end; end; end