google-adwords-api 1.5.0 → 1.6.0

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

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