google-dfp-api 0.2.0

data/examples/v201101/user_service/get_user.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/ruby
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#
+# This example gets a user by its ID. To create users, run create_users.rb.
+#
+# Tags: UserService.getUser
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201101
+
+def get_user()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Set the ID of the user to get.
+  user_id = 'INSERT_USER_ID_HERE'.to_i
+
+  # Get the user.
+  user = user_service.get_user(user_id)
+
+  if user
+    puts "User with ID: %d, name: %s, email: %s and role: %s was found." %
+        [user[:id], user[:name], user[:email], user[:role_name]]
+  else
+    puts 'No user found for this ID.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_user()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/v201101/user_service/get_users_by_statement.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/ruby
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#
+# This example gets all users sorted by name. The statement retrieves up to the
+# maximum page size limit of 500. To create new users, run create_users.rb.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201101
+
+def get_users_by_statement()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Create a statement to get all users sorted by name.
+  statement = {:query => 'ORDER BY name LIMIT 500'}
+
+  # Get users by statement.
+  page = user_service.get_users_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |user, index|
+      puts "%d) User ID: %d, name: %s, email: %s, role: %s." % [index,
+          user[:id], user[:name], user[:email], user[:role_name]]
+    end
+  end
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Number of results found: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_users_by_statement()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/v201101/user_service/update_users.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/ruby
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#
+# This example updates all users by adding "Sr." to the end of each name (after
+# a very large baby boom and lack of creativity). To determine which users
+# exist, run get_all_users.rb.
+#
+# Tags: UserService.updateUsers
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201101
+
+def update_users()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Create a statement to get all users.
+  statement = {:query => 'LIMIT 500'}
+
+  # Get users by statement.
+  page = user_service.get_users_by_statement(statement)
+
+  if page[:results]
+    users = page[:results]
+
+    # Update each local users object by changing its name.
+    users.each {|user| user[:name] += ' Sr.'}
+
+    # Update the users on the server.
+    return_users = user_service.update_users(users)
+
+    if return_users
+      return_users.each do |user|
+        puts ("User ID: %d, email: %s was updated with name %s") %
+            [user[:id], user[:email], user[:name]]
+      end
+    else
+      raise 'No users were updated.'
+    end
+  else
+    puts 'No users found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_users()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/lib/dfp_api.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby
+#
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 the main classes for the client library. Takes care of all
+# dependencies.
+
+gem 'google-ads-common', '~>0.3.0'
+require 'logger'
+require 'ads_common/api'
+require 'ads_common/config'
+require 'ads_common/auth/client_login_handler'
+require 'ads_common/savon_headers/simple_header_handler'
+require 'dfp_api/errors'
+require 'dfp_api/api_config'
+require 'dfp_api/extensions'
+require 'dfp_api/credential_handler'
+
+# Main namespace for all the client library's modules and classes.
+module DfpApi
+
+  # Wrapper class that serves as the main point of access for all the API usage.
+  #
+  # Holds all the services, as well as login credentials.
+  #
+  class Api < AdsCommon::Api
+    # TODO move to service.rb
+    HEADER_NAMESPACE_PREAMBLE = 'https://www.google.com/apis/ads/publisher/'
+    REQUEST_HEADER = 'RequestHeader'
+    LOGIN_SERVICE_NAME = 'gam'
+
+    public
+
+    # Getter for the API service configurations
+    def api_config
+      DfpApi::ApiConfig
+    end
+
+    # Constructor for Api
+    def initialize(provided_config = nil)
+      super(provided_config)
+      @credential_handler = DfpApi::CredentialHandler.new(@config)
+      env_string = config.read('service.environment')
+      if env_string.nil? or
+          !api_config.environments.include?(env_string.upcase.to_sym)
+        raise AdsCommon::Errors::Error,
+            "Unknown or unspecified environment: \"%s\"" % env_string
+      end
+      @drivers = Hash.new
+      @wrappers = Hash.new
+    end
+
+    # Sets the logger to use.
+    def logger=(logger)
+      super(logger)
+      Savon.configure do |config|
+        config.log_level = :debug
+        config.logger = logger
+      end
+    end
+
+    private
+
+    # Creates an appropriate authentication handler for each service (reuses the
+    # ClientLogin one to avoid generating multiple tokens unnecessarily).
+    def create_auth_handler(version, environment)
+      if @client_login_handler.nil?
+        auth_server = api_config.auth_server(environment)
+        @client_login_handler =
+            AdsCommon::Auth::ClientLoginHandler.new(config, auth_server,
+                LOGIN_SERVICE_NAME)
+      end
+      return @client_login_handler
+    end
+
+    # Retrieve DFP HeaderHandlers per credential.
+    def soap_header_handlers(auth_handler, header_list, version)
+      ns = HEADER_NAMESPACE_PREAMBLE + version.to_s
+      return [AdsCommon::SavonHeaders::SimpleHeaderHandler.new(
+          @credential_handler, auth_handler, REQUEST_HEADER, ns, version)]
+    end
+
+    # Handle loading of a single service.
+    # Creates the driver, sets up handlers, declares the appropriate wrapper
+    # class and creates an instance of it.
+    #
+    # Args:
+    # - version: intended API version. Must be an integer.
+    # - service: name for the intended service
+    #
+    # Returns:
+    # - the driver for the service
+    # - the simplified wrapper generated for the driver
+    #
+    def prepare_driver(version, service)
+      version = version.to_sym
+      service = service.to_sym
+      environment = config.read('service.environment')
+      api_config.do_require(version, service)
+      endpoint = api_config.endpoint(environment, version, service)
+      interface_class_name = api_config.interface_name(version, service)
+      endpoint_url = endpoint.nil? ? nil : endpoint.to_s + service.to_s
+      driver = class_for_path(interface_class_name).new(endpoint_url)
+
+      auth_handler = create_auth_handler(version, environment)
+      header_list =
+          auth_handler.header_list(@credential_handler.credentials(version))
+
+      soap_handlers = soap_header_handlers(auth_handler, header_list, version)
+
+      soap_handlers.each do |handler|
+        driver.headerhandler << handler
+      end
+
+      @drivers[[version, service]] = driver
+      @wrappers[[version, service]] = driver
+      return driver, driver
+    end
+
+    # Converts complete class path into class object.
+    def class_for_path(path)
+      path.split('::').inject(Kernel) do |scope, const_name|
+        scope.const_get(const_name)
+      end
+    end
+  end
+end

data/lib/dfp_api/api_config.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/ruby
+#
+# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#
+# Helper methods for loading and managing the available services in the DFP
+# API.
+
+require 'ads_common/api_config'
+require 'savon'
+
+module DfpApi
+
+  # Contains helper methods for loading and managing the available services.
+  module ApiConfig
+
+    class << ApiConfig
+      include AdsCommon::ApiConfig
+    end
+
+    # Set defaults
+    DEFAULT_VERSION = :v201101
+    DEFAULT_ENVIRONMENT = :PRODUCTION
+    LATEST_VERSION = :v201101
+
+    # Set other constants
+    API_NAME = 'DfpApi'
+    API_PATH = 'dfp_api'
+    CLIENT_LIB_VERSION = '0.2.0'
+    DEFAULT_CONFIG_FILENAME = 'dfp_api.yml'
+
+    # Configure the services available to each version
+    @@service_config = {
+      :v201101 => [:CompanyService, :CreativeService, :ForecastService,
+                   :InventoryService, :LineItemCreativeAssociationService,
+                   :LineItemService, :NetworkService, :OrderService,
+                   :PlacementService, :ReportService, :UserService,
+                   :CustomTargetingService, :PublisherQueryLanguageService]
+    }
+
+    # Configure the different environments, with the base URL for each one
+    @@environment_config = {
+      :PRODUCTION => {
+        :v201101 => 'https://www.google.com/apis/ads/publisher/'
+      },
+      :SANDBOX => {
+        :v201101 => 'https://sandbox.google.com/apis/ads/publisher/'
+      }
+    }
+
+    # Configure the auth servers to use for each environment
+    @@auth_server_config = {
+      :PRODUCTION => 'https://www.google.com',
+      :SANDBOX => 'https://www.google.com'
+    }
+
+    public
+
+    def self.do_require(version, service)
+      service_name = service.to_s.snakecase()
+      filename = "%s/%s/%s" % [api_path, version, service_name]
+      require filename
+    end
+
+    def self.interface_name(version, service)
+      version = version.to_sym
+      service = service.to_sym
+      return module_name(version, service) + "::" + service.to_s
+    end
+
+    # Getters for constants and module variables.
+    def self.default_version
+      DEFAULT_VERSION
+    end
+
+    def self.default_environment
+      DEFAULT_ENVIRONMENT
+    end
+
+    def self.latest_version
+      LATEST_VERSION
+    end
+
+    def self.api_name
+      API_NAME
+    end
+
+    def self.api_path
+      API_PATH
+    end
+
+    def self.service_config
+      @@service_config
+    end
+
+    def self.environment_config
+      @@environment_config
+    end
+
+    def self.subdir_config
+      nil
+    end
+
+    def self.auth_server_config
+      @@auth_server_config
+    end
+
+    def self.default_config_filename
+      DEFAULT_CONFIG_FILENAME
+    end
+  end
+end