google-dfp-api 0.2.1 → 0.2.2

data/ChangeLog

@@ -1,3 +1,7 @@
+0.2.2:
+  - Support for OAuth authentication method.
+  - Require google-ads-common 0.5.0 or later from now on.
+
 0.2.1:
   - Ruby1.9 compatible.
   - Fixed issue #16 (deep arrays nesting).

data/README

@@ -84,6 +84,21 @@ constructor:
 
 An example of configuration file is available as part of this library.
 
+== Using OAuth
+
+It is recommended to use OAuth authentication method instead of explicit
+email/password combination. OAuth support is almost transparent to the library
+user. In order to use OAuth you just need to:
+
+  - set authentication method to 'OAuth' in configuration;
+
+  - include oauth_consumer_key and oauth_consumer_secret;
+
+  - handle OAuthVerificationRequired error and pass verification code to the
+    library.
+
+See 'dfp_api.yml' configuration file and 'common/oauth_handling.rb' example for
+more details.
 
 == Accessing services
 
@@ -168,8 +183,8 @@ is planned for next releases.
 External dependencies should be pulled automatically on gem install. Here is the
 list though:
 
-  - Google Ads Common library (google-ads-common-0.4.0);
-  - Savon 'the heavy metal Ruby SOAP client' (savon-0.9.1 or later).
+  - Google Ads Common library (google-ads-common-0.5.0);
+  - Savon 'the heavy metal Ruby SOAP client' (savon-0.9.6).
 
 
 = Where do I submit bug reports and feature requests?

data/Rakefile

@@ -47,8 +47,8 @@ spec = Gem::Specification.new do |s|
   s.test_files = tests
   s.has_rdoc = true
   s.extra_rdoc_files = docs
-  s.add_dependency('google-ads-common', '~> 0.4.0')
-  s.add_dependency('savon', '~> 0.9.1')
+  s.add_dependency('google-ads-common', '~> 0.5.0')
+  s.add_dependency('savon', '= 0.9.6')
 end
 
 package_task = Gem::PackageTask.new(spec) do |pkg|
@@ -74,10 +74,8 @@ task :generate do
     wsdls = DfpApi::ApiConfig.get_wsdls(version)
     wsdls.each do |service_name, wsdl_url|
       logger.info("Processing %s at [%s]..." % [service_name, wsdl_url])
-      module_name = "%s::%s::%s" % [api_config.api_name, version.to_s.upcase,
-                                    service_name]
       generator = AdsCommon::Build::SavonGenerator.new(wsdl_url, code_path,
-                      service_name, module_name)
+          api_config.api_name, version, service_name)
       generator.process_wsdl()
     end
     package_task.package_files.include(FileList[code_path + '/*'].to_a)

data/examples/v201101/common/oauth_handling.rb

@@ -0,0 +1,128 @@
+#!/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 shows how to use OAuth authorization method. It is designed to be
+# run from console and requires user input.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201101
+PAGE_SIZE = 500
+MAX_RETRIES = 3
+
+def oauth_handling()
+  # 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')
+
+  # Forcing authorization. A callback URL and other parameters could be
+  # specified as parameter for OAuth method.
+  token = dfp.authorize({:oauth_callback => 'oob'}) do |oauth_url|
+    # For command-line we ask user to go to URL and type in code.
+    verification_code = get_verification_code(oauth_url)
+    # Return verification code from the block.
+    (verification_code.empty?) ? nil : verification_code
+  end
+
+  # Get the UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = Hash.new
+  retry_count = 0
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    begin
+      # Get users by statement.
+      page = user_service.get_users_by_statement(statement)
+
+    # The second way to do OAuth authentication is to make a request and catch
+    # the OAuthVerificationRequired exception. Add the verification code to the
+    # credentials once acquired.
+    rescue AdsCommon::Errors::OAuthVerificationRequired => e
+      if retry_count < MAX_RETRIES
+        verification_code = get_verification_code(e.oauth_url)
+        dfp.credential_handler.set_credential(
+            :oauth_verification_code, verification_code)
+        retry_count += 1
+        retry
+      else
+        raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
+      end
+    end
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      # Get the start index for printout.
+      start_index = page[:start_index]
+
+      # Print details about each user in results page.
+      page[:results].each_with_index do |user, index|
+        puts "%d) User ID: %d, name: %s, email: %s" %
+            [index + start_index, user[:id], user[:name], user[:email]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of users: %d" % page[:total_result_set_size]
+  end
+end
+
+# Misc util to get the verification code from the console.
+def get_verification_code(url)
+  puts "Hit Auth error, please navigate to URL:\n\t%s" % url
+  print 'Log in and type the verification code: '
+  verification_code = gets.chomp
+  return verification_code
+end
+
+if __FILE__ == $0
+  begin
+    oauth_handling()
+
+  # 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/company_service/create_companies.rb

@@ -41,7 +41,7 @@ def create_companies()
   company_service = dfp.service(:CompanyService, API_VERSION)
 
   # Create an array to store local company objects.
-  companies = Array.new
+  companies = []
   ITEM_COUNT.times do |index|
     companies << {:name => "Advertiser #%d" % index, :type => 'ADVERTISER'}
   end

data/examples/v201101/company_service/get_all_companies.rb

@@ -40,7 +40,7 @@ def get_all_companies()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
+  page = {}
 
   begin
     # Create a statement to get one page with current offset.

data/examples/v201101/creative_service/create_creatives.rb

@@ -53,7 +53,7 @@ def create_creatives()
   image_data_base64 = Base64.encode64(image_data)
 
   # Create an array to store local creative objects.
-  creatives = Array.new
+  creatives = []
   ITEM_COUNT.times do |index|
     creatives << {
         :xsi_type => 'ImageCreative',

data/examples/v201101/creative_service/get_all_creatives.rb

@@ -40,7 +40,7 @@ def get_all_creatives()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
+  page = {}
 
   begin
     # Create a statement to get one page with current offset.

data/examples/v201101/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -48,8 +48,8 @@ def delete_custom_targeting_keys()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
-  custom_target_key_ids = Array.new
+  page = {}
+  custom_target_key_ids = []
   statement = {
       :values => [
           {:key => 'name',

data/examples/v201101/custom_targeting_service/delete_custom_targeting_values.rb

@@ -50,8 +50,8 @@ def delete_custom_targeting_values()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
-  custom_target_value_ids = Array.new
+  page = {}
+  custom_target_value_ids = []
   statement = {
       :values => [
           {:key => 'key_id',

data/examples/v201101/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -42,7 +42,7 @@ def get_all_custom_targeting_keys_and_values()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
+  page = {}
 
   begin
     # Create a statement to get one page with current offset.
@@ -82,7 +82,7 @@ end
 def print_all_values_for_key(custom_targeting_service, custom_targeting_key)
   # Define initial values.
   offset = 0
-  page = Hash.new
+  page = {}
 
   # Create a statement to get values for given key.
   statement_text = "WHERE customTargetingKeyId = :key_id LIMIT %d" % PAGE_SIZE

data/examples/v201101/inventory_service/create_ad_units.rb

@@ -51,7 +51,7 @@ def create_ad_units()
   puts "Using effective root ad unit: %d" % effective_root_ad_unit_id
 
   # Create an array to store local ad unit objects.
-  ad_units = Array.new
+  ad_units = []
   ITEM_COUNT.times do |index|
     ad_units << {
         :name => "Ad_Unit_%d" % index,

data/examples/v201101/inventory_service/deactivate_ad_units.rb

@@ -51,8 +51,8 @@ def deactivate_ad_units()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
-  ad_unit_ids = Array.new
+  page = {}
+  ad_unit_ids = []
 
   begin
     # Create a statement to get one page with current offset.

data/examples/v201101/inventory_service/get_ad_units_by_statement.rb

@@ -61,7 +61,7 @@ def get_ad_units_by_statement()
   page = inventory_service.get_ad_units_by_statement(statement)
 
   if page[:results]
-    # Print details about each creative in results.
+    # Print details about each ad unit in results.
     page[:results].each_with_index do |ad_unit, index|
       puts "%d) Ad unit ID: %d, name: %s, status: %s." %
           [index, ad_unit[:id], ad_unit[:name], ad_unit[:status]]

data/examples/v201101/inventory_service/get_all_ad_units.rb

@@ -40,7 +40,7 @@ def get_all_ad_units()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
+  page = {}
 
   begin
     # Create a statement to get one page with current offset.

data/examples/v201101/line_item_creative_association_service/deactivate_licas.rb

@@ -58,8 +58,8 @@ def deactivate_licas()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
-  creative_ids = Array.new
+  page = {}
+  creative_ids = []
 
   begin
     # Create a statement to get one page with current offset.

data/examples/v201101/line_item_creative_association_service/get_all_licas.rb

@@ -41,7 +41,7 @@ def get_all_licas()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
+  page = {}
 
   begin
     # Create statement for one page with current offset.

data/examples/v201101/line_item_service/activate_line_items.rb

@@ -61,8 +61,8 @@ def activate_line_items()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
-  line_item_ids = Array.new
+  page = {}
+  line_item_ids = []
 
   begin
     # Create a statement to get one page with current offset.

data/examples/v201101/line_item_service/create_line_items.rb

@@ -53,7 +53,7 @@ def create_line_items()
   inventory_targeting = {:targeted_placement_ids => targeted_placement_ids}
 
   # Create geographical targeting.
-  geo_targeting = Hash.new
+  geo_targeting = {}
   # Include the US and Quebec, Canada.
   geo_targeting[:targeted_locations] = [
       {:xsi_type => 'CountryLocation', :country_code => 'US'},
@@ -72,7 +72,7 @@ def create_line_items()
                :inventory_targeting => inventory_targeting}
 
   # Create an array to store local line item objects.
-  line_items = Array.new
+  line_items = []
   ITEM_COUNT.times do |index|
     line_item = {:name => "Line item #%d" % index,
                  :order_id => order_id,

data/examples/v201101/line_item_service/get_all_line_items.rb

@@ -41,7 +41,7 @@ def get_all_line_items()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
+  page = {}
 
   begin
     # Create a statement to get one page with current offset.

data/examples/v201101/order_service/approve_orders.rb

@@ -45,8 +45,8 @@ def approve_orders()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
-  order_ids = Array.new
+  page = {}
+  order_ids = []
 
   begin
     # Create a statement to get one page with current offset.

data/examples/v201101/order_service/create_orders.rb

@@ -49,7 +49,7 @@ def create_orders()
   trafficker_id = 'INSERT_TRAFFICKER_ID_HERE'.to_i
 
   # Create an array to store local order objects.
-  orders = Array.new
+  orders = []
   ITEM_COUNT.times do |index|
     orders << {:name => "Order #%d" % index,
                :advertiser_id => advertiser_id,

data/examples/v201101/order_service/get_all_orders.rb

@@ -40,7 +40,7 @@ def get_all_orders()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
+  page = {}
 
   begin
     # Create statement for one page with current offset.

data/examples/v201101/placement_service/create_placements.rb

@@ -46,21 +46,21 @@ def create_placements()
   skyscraper_ad_unit_placement = {
       :name => "Skyscraper AdUnit Placement #%d" % (Time.new.to_f * 1000),
       :description => 'Contains ad units for creatives of size 120x600',
-      :targeted_ad_unit_ids => Array.new
+      :targeted_ad_unit_ids => []
   }
 
   # Create local placement object to store medium square ad units.
   medium_square_ad_unit_placement = {
       :name => "Medium Square AdUnit Placement #%d" % (Time.new.to_f * 1000),
       :description => 'Contains ad units for creatives of size 300x250',
-      :targeted_ad_unit_ids => Array.new
+      :targeted_ad_unit_ids => []
   }
 
   # Create local placement object to store banner ad units.
   banner_ad_unit_placement = {
       :name => "Banner AdUnit Placement #%d" % (Time.new.to_f * 1000),
       :description => 'Contains ad units for creatives of size 468x60',
-      :targeted_ad_unit_ids => Array.new
+      :targeted_ad_unit_ids => []
   }
 
   # Get the first 500 ad units.

data/examples/v201101/placement_service/deactivate_placements.rb

@@ -51,8 +51,8 @@ def deactivate_placements()
 
   # Define initial values.
   offset = 0
-  page = Hash.new
-  placement_ids = Array.new
+  page = {}
+  placement_ids = []
 
   begin
     # Modify the statement to get one page with current offset.