google-dfp-api 1.3.1 → 1.4.0

data/lib/dfp_api/dfp_api_statement.rb

@@ -1,62 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2014, 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.
-#
-# FilterStatement object to allow for simpler query pagination logic.
-
-module DfpApi
-
-  # Default page size to use with the FilterStatement.
-  SUGGESTED_PAGE_LIMIT = 500
-
-  # A statement object for PQL and get*ByStatement queries.
-  # Deprecated. Use StatementBuilder instead.
-  class FilterStatement
-    # Constructor for a Filter Statement.
-    def initialize(query_statement='', values=[], limit=SUGGESTED_PAGE_LIMIT,
-                   offset=0)
-      @query_statement = query_statement.dup()
-      @values = values
-      @limit = limit
-      @offset = offset
-    end
-
-    attr_accessor :limit
-    attr_accessor :offset
-
-    def toStatement()
-      register_filter_statement_util()
-      statement = @query_statement + ' LIMIT %d OFFSET %d' % [@limit, @offset]
-      return {:query => statement, :values => @values}
-    end
-
-    def toStatementForAction()
-      register_filter_statement_util()
-      return {:query => @query_statement.dup(), :values => @values}
-    end
-
-    def toStatementWithoutOffset()
-      register_filter_statement_util()
-      statement = @query_statement + ' LIMIT %d' % [@limit]
-      return {:query => statement, :values => @values}
-    end
-
-    private
-    def register_filter_statement_util()
-      DfpApi::Utils::UtilityRegistry.instance.add('FilterStatement')
-    end
-  end
-end

data/lib/dfp_api/errors.rb

@@ -1,62 +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 DFP API.
-
-require 'ads_common/errors'
-
-module DfpApi
-  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
-  end
-end

data/lib/dfp_api/pql_statement_utils.rb

@@ -1,192 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2017, 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.
-#
-# StatementBuilder object to allow for simpler PQL statement generation.
-
-require 'dfp_api/dfp_api_datetime'
-
-
-module DfpApi
-  # Query class used by StatementBuilder.
-  class PQLQuery
-    # Create a new query.
-    def initialize(query = nil)
-      @query = (query.nil?) ? nil : query.dup()
-    end
-
-    # Concatenate a new clause onto the current query.
-    def <<(clause)
-      @query = (@query.nil?) ? clause : @query << ' ' << clause
-    end
-
-    # Return the query string for a PQLQuery
-    def to_s()
-      @query.dup()
-    end
-  end
-
-  # Values class used by StatementBuilder.
-  class PQLValues
-    VALUE_TYPES = {
-      Numeric => 'NumberValue',
-      Integer => 'NumberValue',
-      Float => 'NumberValue',
-      String => 'TextValue',
-      TrueClass => 'BooleanValue',
-      FalseClass => 'BooleanValue',
-      Array => 'SetValue',
-      DfpApi::DfpDate => 'DateValue',
-      DfpApi::DfpDateTime => 'DateTimeValue'
-    }
-
-    # Create a new values object.
-    def initialize(values = {})
-      @values = values || {}
-    end
-
-    # Add a value to the current values object on the provided key.
-    def add_value(key, value)
-      @values[key.to_sym] = generate_value_object(value)
-    end
-
-    # Get values as an array, the format the DFP API expects.
-    def values()
-      # values_array is a DFP compliant list of values of the following form:
-      # [:key => ..., :value => {:xsi_type => ..., :value => ...}]
-      values_array = @values.map do |key, value|
-        raise 'Missing value in StatementBuilder.' if value.nil?
-        raise 'Value cannot be nil on StatementBuilder.' if value[:value].nil?
-        raise 'Missing value type for %s.' % key if value[:xsi_type].nil?
-        unless VALUE_TYPES.values.include?(value[:xsi_type])
-          raise 'Unknown value type for %s.' % key
-        end
-        if value[:xsi_type] == 'SetValue'
-          if value[:value].map {|v| v.class}.to_set.size > 1
-            raise 'Cannot pass more than one type in set variable, %s.' % key
-          end
-        end
-        if value[:xsi_type] == 'DateTimeValue'
-          unless value[:value][:time_zone_id]
-            raise 'Missing timezone on DateTimeValue variable, %s.' %key
-          end
-        end
-        {:key => key.to_s(), :value => value}
-      end
-      return values_array
-    end
-
-    # Create an individual value object by inferring the xsi_type. If the value
-    # type isn't recognized, return the original value parameter.
-    def generate_value_object(value)
-      type = VALUE_TYPES[value.class]
-      if [DfpApi::DfpDate, DfpApi::DfpDateTime].include?(value.class)
-        value = value.to_h
-      end
-      return value if type.nil?
-      return {:xsi_type => type, :value => value}
-    end
-  end
-
-  # A utility class for building PQL statements, used by the
-  # PublisherQueryLanguageService and other services' get*ByStatement and
-  # perform*Action requsts.
-  #
-  # Example usage:
-  # sb = DfpApi::StatementBuilder.new do |b|
-  #   b.select = 'ChangeDateTime, EntityId, EntityType, Operation'
-  #   b.from = 'Change_History'
-  #   b.where = 'ChangeDateTime < :start_date_time ' +
-  #             'AND ChangeDateTime > :end_date_time'
-  #   b.with_bind_variable('start_date_time', DfpApi::DfpDate.today-1)
-  #   b.with_bind_variable('end_date_time', DfpApi::Date.today)
-  #   b.order_by = 'ChangeDateTime'
-  #   b.ascending = false
-  # end
-  # sb.to_statement()
-  #
-  class StatementBuilder
-    SUGGESTED_PAGE_LIMIT = 500
-
-    SELECT = 'SELECT %s'
-    FROM = 'FROM %s'
-    WHERE = 'WHERE %s'
-    ORDER = 'ORDER BY %s %s'
-    LIMIT = 'LIMIT %d'
-    OFFSET = 'OFFSET %d'
-
-    attr_accessor :select, :from, :where, :order_by, :ascending, :limit, :offset
-
-    # Create a StatementBuilder object.
-    def initialize(api, &block)
-      @api = api
-      @select = nil
-      @from = nil
-      @where = nil
-      @order_by = nil
-      @ascending = true
-      @limit = SUGGESTED_PAGE_LIMIT
-      @offset = 0
-      @pql_values = PQLValues.new
-      yield self if block_given?
-    end
-
-    # Edit a StatmentBuilder object with a block.
-    def configure(&block)
-      yield self
-    end
-
-    # Add a value to be matched to bind a variable in WHERE conditions.
-    def with_bind_variable(key, value)
-      @pql_values.add_value(key, value)
-      return self
-    end
-
-    # Return a list of validation errors.
-    def validate()
-      if !@select.to_s.strip.empty? and @from.to_s.strip.empty?
-        raise 'FROM clause is required with SELECT'
-      end
-      if !@from.to_s.strip.empty? and @select.to_s.strip.empty?
-        raise 'SELECT clause is required with FROM'
-      end
-      if !@offset.nil? and @limit.nil?
-        raise 'LIMIT clause is required with OFFSET'
-      end
-      unless @limit.is_a? Integer or @limit.nil?
-        raise 'LIMIT must be an integer'
-      end
-      unless @offset.is_a? Integer or @offset.nil?
-        raise 'OFFSET must be an integer'
-      end
-    end
-
-    # Create a statement object that can be sent in a DFP API request.
-    def to_statement()
-      @api.utils_reporter.statement_builder_used()
-      validate()
-      ordering = @ascending ? 'ASC' : 'DESC'
-      pql_query = PQLQuery.new
-      pql_query << SELECT % @select unless @select.to_s.empty?
-      pql_query << FROM % @from unless @from.to_s.empty?
-      pql_query << WHERE % @where unless @where.to_s.empty?
-      pql_query << ORDER % [@order_by, ordering] unless @order_by.to_s.empty?
-      pql_query << LIMIT % @limit unless @limit.nil?
-      pql_query << OFFSET % @offset unless @offset.nil?
-      return {:query => pql_query.to_s(), :values => @pql_values.values}
-    end
-  end
-end

data/lib/dfp_api/utils.rb

@@ -1,56 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2017, 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.
-#
-# Misc DFP utilities.
-
-require 'set'
-require 'thread'
-require 'singleton'
-
-
-module DfpApi
-  module Utils
-    # Class to keep a list of unique utilities used in order to perform tracking
-    # of client library features.
-    class UtilityRegistry
-      include Singleton
-      attr_accessor :enabled
-
-      def initialize
-        @enabled = true
-        @registry = Set.new
-        @lock = Mutex.new
-      end
-
-      def extract!
-        @lock.synchronize do
-          registry = @registry.dup
-          @registry.clear
-          return registry
-        end
-      end
-
-      def length
-        @lock.synchronize { @registry.length }
-      end
-
-      def add(util)
-        @lock.synchronize { @registry.add(util) if @enabled }
-      end
-    end
-  end
-end

data/lib/dfp_api/utils_reporter.rb

@@ -1,52 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2017, 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 'dfp_api/credential_handler'
-
-module DfpApi
-  class UtilsReporter
-    # Default constructor.
-    #
-    # Args:
-    # - credential_handler: The CredentialHandler being used by the current
-    # DfpApi instance.
-    def initialize(credential_handler)
-      @credential_handler = credential_handler
-    end
-
-    # A callback method for StatementBuilder to indicate that it has been
-    # used, and that its usage should be recorded in the next user agent string.
-    def statement_builder_used()
-      @credential_handler.include_in_user_agent("StatementBuilder")
-    end
-
-    # A callback method for DfpDate to indicate that it has been
-    # used, and that its usage should be recorded in the next user agent string.
-    def dfp_date_used()
-      @credential_handler.include_in_user_agent("DfpDate")
-    end
-
-    # A callback method for DfpDateTime to indicate that it has been
-    # used, and that its usage should be recorded in the next user agent string.
-    def dfp_date_time_used()
-      @credential_handler.include_in_user_agent("DfpDateTime")
-    end
-  end
-end

data/lib/dfp_api/v201708/activity_group_service.rb

@@ -1,54 +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 0.14.1 on 2017-08-04 16:04:20.
-
-require 'ads_common/savon_service'
-require 'dfp_api/v201708/activity_group_service_registry'
-
-module DfpApi; module V201708; module ActivityGroupService
-  class ActivityGroupService < AdsCommon::SavonService
-    def initialize(config, endpoint)
-      namespace = 'https://www.google.com/apis/ads/publisher/v201708'
-      super(config, endpoint, namespace, :v201708)
-    end
-
-    def create_activity_groups(*args, &block)
-      return execute_action('create_activity_groups', args, &block)
-    end
-
-    def create_activity_groups_to_xml(*args)
-      return get_soap_xml('create_activity_groups', args)
-    end
-
-    def get_activity_groups_by_statement(*args, &block)
-      return execute_action('get_activity_groups_by_statement', args, &block)
-    end
-
-    def get_activity_groups_by_statement_to_xml(*args)
-      return get_soap_xml('get_activity_groups_by_statement', args)
-    end
-
-    def update_activity_groups(*args, &block)
-      return execute_action('update_activity_groups', args, &block)
-    end
-
-    def update_activity_groups_to_xml(*args)
-      return get_soap_xml('update_activity_groups', args)
-    end
-
-    private
-
-    def get_service_registry()
-      return ActivityGroupServiceRegistry
-    end
-
-    def get_module()
-      return DfpApi::V201708::ActivityGroupService
-    end
-  end
-end; end; end