google-adwords-api 1.4.0 → 1.6.0

data/lib/adwords_api/credential_handler.rb

@@ -1,96 +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.
-#
-# AdWords-specific credential handler.
-
-require 'ads_common/credential_handler'
-require 'adwords_api/api_config'
-
-module AdwordsApi
-  class CredentialHandler < AdsCommon::CredentialHandler
-    # Whether we're making validate-only requests.
-    attr_accessor :validate_only
-    # Whether we're making partial failure requests.
-    attr_accessor :partial_failure
-
-    def initialize(config)
-      super(config)
-      @validate_only = false
-      @partial_failure = false
-    end
-
-    # Create the list of credentials to be used by the auth handler for header
-    # generation.
-    def credentials(credentials_override = nil)
-      result = super(credentials_override)
-      validate_headers_for_server(result)
-
-      extra_headers = {
-        'userAgent' => generate_user_agent(),
-        'developerToken' => result[:developer_token]
-      }
-      extra_headers['clientCustomerId'] = result[:client_customer_id] if
-          result[:client_customer_id]
-      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 use as user agent in headers.
-    def generate_user_agent(extra_ids = [])
-      agent_app = @config.read('authentication.user_agent')
-      if !agent_app.nil? && !agent_app.ascii_only?
-        raise AdwordsApi::Errors::InvalidUserAgentError.new(
-            'User agent contains non-ASCII characters.', agent_app)
-      end
-      extra_ids << ['AwApi-Ruby/%s' % AdwordsApi::ApiConfig::CLIENT_LIB_VERSION]
-      super(extra_ids, agent_app)
-    end
-
-    # Returns the client customer ID specified in the current credentials.
-    def identifier()
-      return credentials[:extra_headers]['clientCustomerId']
-    end
-
-    private
-
-    # Validates that the right credentials are being used for the chosen
-    # environment.
-    #
-    # Raises:
-    # - AdwordsApi::Errors:BadCredentialsError if supplied credentials are not
-    # valid.
-    #
-    def validate_headers_for_server(credentials)
-      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+)?$/)))
-        raise AdwordsApi::Errors::BadCredentialsError,
-            'Invalid client customer ID: %s' % client_customer_id.to_s
-      end
-
-      token = credentials[:developer_token]
-      if token.nil? || token.empty?
-        raise AdwordsApi::Errors::BadCredentialsError,
-            'Developer token is missing, check credentials.'
-      end
-      return nil
-    end
-  end
-end

data/lib/adwords_api/errors.rb

@@ -1,110 +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.
-#
-# Specific error handling for the AdWords API.
-
-require 'ads_common/errors'
-require 'ads_common/results_extractor'
-
-module AdwordsApi
-  module Errors
-
-    # This class encapsulates base class for API exceptions. More specific
-    # exceptions are generated based on Service WSDL.
-    class ApiException < AdsCommon::Errors::ApiException
-      attr_reader :array_fields
-
-      def initialize(exception_fault, registry)
-        @array_fields ||= []
-        extractor = AdsCommon::ResultsExtractor.new(registry)
-        exception_type = exception_fault[:application_exception_type]
-        exception_data = (exception_type.nil?) ? exception_fault :
-            extractor.extract_exception_data(exception_fault, exception_type)
-        exception_data.each { |key, value| set_field(key, value) }
-        super(exception_data[:message])
-      end
-
-      private
-
-      # Sets instance's property to a value if it is defined
-      def set_field(field, value)
-        if respond_to?(field)
-          value = arrayize(value) if is_array_field(field)
-          instance_variable_set("@#{field}", value)
-        end
-      end
-
-      # Makes sure object is an array
-      def arrayize(object)
-        return [] if object.nil?
-        return object.is_a?(Array) ? object : [object]
-      end
-
-      # Should a field be forced to be an array
-      def is_array_field(field)
-        return @array_fields.include?(field.to_s)
-      end
-    end
-
-    # Error for invalid credentials sush as malformed ID.
-    class BadCredentialsError < AdsCommon::Errors::ApiException
-    end
-
-    # Error for malformed report definition.
-    class InvalidReportDefinitionError < AdsCommon::Errors::ApiException
-    end
-
-    # Error for server-side report error.
-    class ReportError < AdsCommon::Errors::ApiException
-      attr_reader :http_code
-
-      def initialize(http_code, message)
-        super(message)
-        @http_code = http_code
-      end
-    end
-
-    # Error for server-side report XML error.
-    class ReportXmlError < ReportError
-      attr_reader :type, :trigger, :field_path
-
-      def initialize(http_code, error_type, error_trigger, error_field_path)
-        message =
-            "HTTP code: %d, error type: '%s', trigger: '%s', field path: '%s'" %
-            [http_code, error_type, error_trigger, error_field_path]
-        super(http_code, message)
-        @type = error_type
-        @trigger = error_trigger
-        @field_path = error_field_path
-      end
-    end
-
-    # Error for use an unsupported operation in a batch job.
-    class InvalidBatchJobOperationError < AdsCommon::Errors::ApiException
-    end
-
-    # Error for using an invalid user agent string.
-    class InvalidUserAgentError < AdsCommon::Errors::Error
-      attr_reader :user_agent
-
-      def initialize(message, user_agent)
-        super(message)
-        @user_agent = user_agent
-      end
-    end
-  end
-end

data/lib/adwords_api/incremental_upload_helper.rb

@@ -1,75 +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.
-#
-# Contains helper methods to allow incremental uploads with the
-# BatchJobService.
-
-module AdwordsApi
-  class IncrementalUploadHelper
-    attr_reader :upload_url, :uploaded_bytes
-
-    # Default constructor.
-    #
-    # Args:
-    # - batch_job_service: The instance of BatchJobService that is providing
-    # this helper
-    # - uploaded_bytes: The number of bytes that have already been uploaded
-    # as part of this incremental process.
-    # - upload_url: The URL that should be used to upload incremental
-    # operations for this job.
-    #
-    def initialize(batch_job_utils, uploaded_bytes, upload_url)
-      @batch_job_utils = batch_job_utils
-      @uploaded_bytes = uploaded_bytes
-      if @uploaded_bytes == 0
-        @upload_url = @batch_job_utils.initialize_url(upload_url)
-      else
-        @upload_url = upload_url
-      end
-      @finished = false
-    end
-
-    # Takes an array of operations and puts it to the batch job incrementally.
-    #
-    # Args:
-    # - hash_operations: An array of operations to put, represented in hashes
-    # like you would normally pass to services.
-    # - is_last_request: Whether this request is the last request of the
-    # incremental job.
-    #
-    # Raises:
-    # - InvalidBatchJobOperationError: If this incremental upload is already
-    # finished or if there is an error converting the hash operations to
-    # soap operations.
-    #
-    def upload(operations, is_last_request = false)
-      check_status()
-      @uploaded_bytes = @batch_job_utils.put_incremental_operations(
-        operations, @upload_url, @uploaded_bytes, is_last_request)
-      @finished = true if is_last_request
-    end
-
-    private
-
-    def check_status()
-      if @finished
-        raise AdwordsApi::Errors::InvalidBatchJobOperationError,
-            'Cannot put new operations to completed incremental upload.'
-      end
-    end
-  end
-end

data/lib/adwords_api/query_utils/query_builder.rb

@@ -1,41 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2018, 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.
-#
-# Base class with common methods used across both report and service queries.
-
-require 'adwords_api/query_utils/where_builder'
-
-module AdwordsApi
-  class QueryBuilder
-    def initialize(api)
-      @api = api
-      @where = []
-    end
-
-    def where(field)
-      clause = WhereBuilder.new(field)
-      @where << clause
-      return clause
-    end
-
-    def build_where()
-      return '' if @where.empty?
-      wheres = @where.map {|w| w.awql}
-      return sprintf(' WHERE %s', wheres.join(' AND '))
-    end
-  end
-end

data/lib/adwords_api/query_utils/report_query.rb

@@ -1,30 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2018, 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.
-#
-# Class to hold a generated AWQL query for reports.
-
-module AdwordsApi
-  class ReportQuery
-    def initialize(query)
-      @query = query
-    end
-
-    def to_s()
-      return @query
-    end
-  end
-end

data/lib/adwords_api/query_utils/report_query_builder.rb

@@ -1,82 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2018, 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.
-#
-# Class with methods to aid in building AWQL for reports.
-
-require 'adwords_api/query_utils/query_builder'
-require 'adwords_api/query_utils/report_query'
-
-module AdwordsApi
-  class ReportQueryBuilder < QueryBuilder
-    def initialize(api)
-      super(api)
-      @select = nil
-      @from = nil
-      @during_range = nil
-      @during_start = nil
-      @during_end = nil
-      yield self if block_given?
-    end
-
-    def configure()
-      yield self
-    end
-
-    def select(*fields)
-      @select = fields
-    end
-
-    def from(report_name)
-      @from = report_name
-    end
-
-    def during_date_range(date_range)
-      @during_range = date_range
-    end
-
-    def during(start_date, end_date)
-      @during_start = start_date
-      @during_end = end_date
-    end
-
-    def build()
-      raise ArgumentError,
-          'Must specify SELECT clause for valid AWQL' if @select.nil?
-      raise ArgumentError,
-          'Must specify FROM clause for valid AWQL' if @from.nil?
-      if !@during_range.nil? && (!@during_start.nil? || !@during_end.nil?)
-        raise ArgumentError,
-            'Cannot specify both date range and start/end dates.'
-      end
-      result = sprintf('SELECT %s', @select.join(', '))
-      result += sprintf(' FROM %s', @from)
-      result += build_where()
-      if !@during_range.nil?
-        result += sprintf(' DURING %s', @during_range)
-      elsif !@during_start.nil? || !@during_end.nil?
-        if @during_start.nil?
-          raise ArgumentError, 'Cannot specify end date without start date.'
-        elsif @during_end.nil?
-          raise ArgumentError, 'Cannot specify start date without end date.'
-        end
-        result += sprintf(' DURING %s,%s', @during_start, @during_end)
-      end
-      @api.utils_reporter.report_query_builder_used()
-      return ReportQuery.new(result)
-    end
-  end
-end

data/lib/adwords_api/query_utils/service_query.rb

@@ -1,62 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2018, 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.
-#
-# Class to hold a generated AWQL query and aid in paging for services.
-
-module AdwordsApi
-  class ServiceQuery
-    def initialize(query, start_index, page_size)
-      @query = query
-      @start_index = start_index
-      @page_size = page_size
-    end
-
-    def has_next(page)
-      raise ArgumentError,
-          'Cannot page through query with no LIMIT clause.' if @start_index.nil?
-      return @start_index + @page_size < page[:total_num_entries]
-    end
-
-    # Determining whether another page exists when dealing with bid landscapes
-    # is different from other types of queries. Use this method for those cases.
-    def has_next_landscape_page(page)
-      raise ArgumentError,
-          'Cannot page through query with no LIMIT clause.' if @start_index.nil?
-      return false unless page[:entries]
-      total_landscape_points_in_page = 0
-      page[:entries].each do |landscape|
-        total_landscape_points_in_page += landscape[:landscape_points].size
-      end
-      return total_landscape_points_in_page >= @page_size
-    end
-
-    def next_page()
-      raise ArgumentError,
-          'Cannot page through query with no LIMIT clause.' if @start_index.nil?
-      @start_index += @page_size
-      return self
-    end
-
-    def to_s()
-      query = @query
-      unless @start_index.nil?
-        query += sprintf(' LIMIT %s,%s', @start_index, @page_size)
-      end
-      return query
-    end
-  end
-end

data/lib/adwords_api/query_utils/service_query_builder.rb

@@ -1,83 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2018, 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.
-#
-# Class with methods to aid in building AWQL for services.
-
-require 'adwords_api/query_utils/query_builder'
-require 'adwords_api/query_utils/service_query'
-require 'set'
-
-module AdwordsApi
-  class ServiceQueryBuilder < QueryBuilder
-    def initialize(api)
-      super(api)
-      @select = nil
-      @order = []
-      @start_index = nil
-      @page_size = nil
-      yield self if block_given?
-    end
-
-    def configure()
-      yield self
-    end
-
-    def select(*fields)
-      @select = Set[*fields]
-    end
-
-    def order_by_asc(field)
-      @order << {
-        :field => field,
-        :direction => 'ASC'
-      }
-    end
-
-    def order_by_desc(field)
-      @order << {
-        :field => field,
-        :direction => 'DESC'
-      }
-    end
-
-    def limit(start_index, page_size)
-      @start_index = start_index
-      @page_size = page_size
-    end
-
-    def build()
-      raise ArgumentError,
-          'Must specify SELECT clause for valid AWQL' if @select.nil?
-      if !@start_index.nil? && @page_size.nil?
-        raise ArgumentError, 'Cannot specify start index without page size.'
-      end
-      if !@page_size.nil? && @start_index.nil?
-        raise ArgumentError, 'Cannot specify page size without start index.'
-      end
-      result = sprintf('SELECT %s', @select.to_a.join(', '))
-      result += build_where()
-      unless @order.empty?
-        orders = @order.map do |o|
-          sprintf('%s %s', o[:field], o[:direction])
-        end
-        result += sprintf(' ORDER BY %s', orders.join(', '))
-      end
-      @api.utils_reporter.service_query_builder_used()
-      return ServiceQuery.new(result, @start_index, @page_size)
-    end
-  end
-end

data/lib/adwords_api/query_utils/where_builder.rb

@@ -1,97 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2018, 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.
-#
-# Class to aid in constructing where clauses for reporting and service queries.
-
-module AdwordsApi
-  class WhereBuilder
-    attr_reader :awql
-
-    def initialize(field)
-      @field = field
-      @awql = nil
-    end
-
-    def equal_to(value)
-      @awql = sprintf("%s = %s", @field, value)
-    end
-
-    def not_equal_to(value)
-      @awql = sprintf("%s != %s", @field, value)
-    end
-
-    def greater_than(value)
-      @awql = sprintf("%s > %s", @field, value)
-    end
-
-    def greater_than_or_equal_to(value)
-      @awql = sprintf("%s >= %s", @field, value)
-    end
-
-    def less_than(value)
-      @awql = sprintf("%s < %s", @field, value)
-    end
-
-    def less_than_or_equal_to(value)
-      @awql = sprintf("%s <= %s", @field, value)
-    end
-
-    def starts_with(value)
-      @awql = sprintf("%s STARTS_WITH %s", @field, value)
-    end
-
-    def starts_with_ignore_case(value)
-      @awql = sprintf("%s STARTS_WITH_IGNORE_CASE %s", @field, value)
-    end
-
-    def contains(value)
-      @awql = sprintf("%s CONTAINS %s", @field, value)
-    end
-
-    def contains_ignore_case(value)
-      @awql = sprintf("%s CONTAINS_IGNORE_CASE %s", @field, value)
-    end
-
-    def does_not_contain(value)
-      @awql = sprintf("%s DOES_NOT_CONTAIN %s", @field, value)
-    end
-
-    def does_not_contain_ignore_case(value)
-      @awql = sprintf("%s DOES_NOT_CONTAIN_IGNORE_CASE %s", @field, value)
-    end
-
-    def in(*values)
-      @awql = sprintf("%s IN [%s]", @field, values.join(','))
-    end
-
-    def not_in(*values)
-      @awql = sprintf("%s NOT_IN [%s]", @field, values.join(','))
-    end
-
-    def contains_any(*values)
-      @awql = sprintf("%s CONTAINS_ANY [%s]", @field, values.join(','))
-    end
-
-    def contains_none(*values)
-      @awql = sprintf("%s CONTAINS_NONE [%s]", @field, values.join(','))
-    end
-
-    def contains_all(*values)
-      @awql = sprintf("%s CONTAINS_ALL [%s]", @field, values.join(','))
-    end
-  end
-end