google-dfp-api 0.5.0 → 0.6.0

data/ChangeLog

@@ -1,3 +1,8 @@
+0.6.0:
+  - Updated PQL example with paging.
+  - Require google-ads-common 0.9.0 or later from now on.
+  - Added support for AOuth2.0 JWT, removed OAuth1.0a support.
+
 0.5.0:
   - Added support and examples for v201211.
   - Removed support for deprecated v201108, v201111, v201201.

data/README

@@ -90,20 +90,20 @@ or add it to the bash configuration file:
    $ echo 'export RUBYOPT="rubygems"' >> ~/.bashrc
 
 
-== Using OAuth
+== Using OAuth2.0
 
-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:
+It is recommended to use OAuth2.0 authentication method instead of ClientLogin
+(explicit email/password combination). OAuth2.0 support is almost transparent to
+the library user. In order to use OAuth you just need to:
 
-  - set authentication method to 'OAuth' in configuration;
+  - set authentication method to 'OAuth2' in the configuration;
 
-  - include oauth_consumer_key and oauth_consumer_secret;
+  - include oauth2_client_id and oauth2_client_secret;
 
-  - handle OAuthVerificationRequired error and pass verification code to the
+  - handle OAuth2VerificationRequired error and pass verification code to the
     library.
 
-See 'dfp_api.yml' configuration file and 'common/oauth_handling.rb' example for
+See 'dfp_api.yml' configuration file and 'common/oauth2_handling.rb' example for
 more details.
 
 == Accessing services

data/dfp_api.yml

@@ -4,8 +4,7 @@
 # Detailed descriptions of these properties can be found at:
 # https://developers.google.com/doubleclick-publishers/docs/soap_xml
 :authentication:
-  # Authentication method, methods currently supported:
-  # OAuth2, OAuth, ClientLogin.
+  # Authentication method, methods currently supported: OAuth2, ClientLogin.
   :method: ClientLogin
 
   # Auth parameters for OAuth2.0 method.
@@ -20,20 +19,6 @@
   #:oauth2_access_type: INSERT_OAUTH2_ACCESS_TYPE_HERE
   #:oauth2_approval_prompt: INSERT_OAUTH2_APPROVAL_PROMPT_HERE
 
-  # Auth parameters for OAuth1.0a method.
-  # NOTE: OAuth1.0a method is deprecated, use OAuth2.0 instead.
-  # Set the OAuth consumer key and secret. Anonymous values can be used for
-  # testing, and real values can be obtained by registering your application:
-  # https://developers.google.com/accounts/docs/RegistrationForWebAppsAuto
-  #:oauth_consumer_key: anonymous
-  #:oauth_consumer_secret: anonymous
-  # If you manage or store access token manually, you can specify it here.
-  #:oauth_token: INSERT_OAUTH_TOKEN_HERE
-  # If you need to change signature method, specify it here.
-  #:oauth_signature_method: HMAC-SHA1
-  # Token secret for HMAC-SHA1 method.
-  #:oauth_token_secret: INSERT_OAUTH_TOKEN_SECRET_HERE
-
   # Auth parameters for ClientLogin method.
   :password: INSERT_PASSWORD_HERE
   :email: INSERT_EMAIL_HERE

data/examples/{v201203/common/oauth_handling.rb → v201211/common/oauth2_jwt_handling.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -17,18 +18,17 @@
 #           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.
+# This example shows how to use OAuth2.0 authorization method with JWT (Service
+# Account).
 #
 # Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201203
+API_VERSION = :v201211
 PAGE_SIZE = 500
-MAX_RETRIES = 3
 
-def oauth_handling()
+def oauth2_jwt_handling()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,14 +36,19 @@ def oauth_handling()
   # 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
+  # Option 1: provide key filename as authentication -> oauth2_keyfile in the
+  #           configuration file. No additional code is necessary.
+  # To provide a file name at runtime, use authorize:
+  # dfp.authorize({:oauth2_keyfile => key_filename})
+
+  # Option 2: retrieve key manually and create OpenSSL::PKCS12 object.
+  # key_filename = 'INSERT_FILENAME_HERE'
+  # key_secret = 'INSERT_SECRET_HERE'
+  # key_file_data = File.read(key_filename)
+  # key = OpenSSL::PKCS12.new(key_file_data, key_secret).key
+  # dfp.authorize({:oauth2_key => key})
+
+  # Now you can make API calls.
 
   # Get the UserService.
   user_service = dfp.service(:UserService, API_VERSION)
@@ -51,30 +56,13 @@ def oauth_handling()
   # 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
+    # Get users by statement.
+    page = user_service.get_users_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -97,17 +85,9 @@ def oauth_handling()
   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()
+    oauth2_jwt_handling()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201211/publisher_query_language_service/get_all_cities.rb

@@ -30,6 +30,7 @@ require 'dfp_api'
 API_VERSION = :v201211
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
+PAGE_SIZE = 500
 
 def get_all_cities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,29 +43,42 @@ def get_all_cities()
   # Get the PublisherQueryLanguageService.
   pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
 
-  # Create statement to select all targetable cities.
-  # For criteria that do not have a "targetable" property, the predicate may be
-  # left off.
-  statement = {:query => 'SELECT * FROM City WHERE targetable = true LIMIT 500'}
+  # Create a statement to select all targetable cities. For criteria that do not
+  # have a "targetable" property, the predicate may be left off.
+  statement_text =
+      'SELECT * FROM City WHERE targetable = true LIMIT %d' % PAGE_SIZE
 
-  # Get all cities.
-  result_set = pql_service.select(statement)
+  # Set initial values for paging.
+  offset, result_set, all_rows = 0, nil, 0
 
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
+  # Get all cities with paging.
+  begin
+    # Create statement for a page.
+    statement = {
+        :query => statement_text + ' OFFSET %d' % offset
+    }
+    result_set = pql_service.select(statement)
+
+    if result_set
+      # Print out columns header.
+      columns = result_set[:column_types].collect {|col| col[:label_name]}
+      puts columns.join(COLUMN_SEPARATOR)
 
-    # Print out every row.
-    result_set[:rows].each do |row_set|
-        row = row_set[:values].collect {|item| item[:value]}
-        puts row.join(COLUMN_SEPARATOR)
+      # Print out every row.
+      result_set[:rows].each do |row_set|
+          row = row_set[:values].collect {|item| item[:value]}
+          puts row.join(COLUMN_SEPARATOR)
+      end
     end
-  end
+
+    # Update the counters.
+    offset += PAGE_SIZE
+    all_rows += result_set[:rows].size
+  end while result_set[:rows].size == PAGE_SIZE
 
   # Print a footer.
   if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
+    puts "Total number of rows found: %d" % all_rows
   end
 end
 

data/lib/dfp_api.rb

@@ -51,8 +51,10 @@ module DfpApi
     def soap_header_handler(auth_handler, version, header_ns, default_ns)
       auth_method = @config.read('authentication.method', :CLIENTLOGIN)
       handler_class  = case auth_method
-        when :CLIENTLOGIN then DfpApi::ClientLoginHeaderHandler
-        when :OAUTH, :OAUTH2 then AdsCommon::SavonHeaders::OAuthHeaderHandler
+        when :CLIENTLOGIN
+            DfpApi::ClientLoginHeaderHandler
+        when :OAUTH2, :OAUTH2_JWT
+            AdsCommon::SavonHeaders::OAuthHeaderHandler
         else
           raise AdsCommon::Errors::AuthError,
               "Unknown auth method: %s" % auth_method

data/lib/dfp_api/version.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+# Encoding: utf-8
 #
 # Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -21,6 +21,6 @@
 
 module DfpApi
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.5.0'
+    CLIENT_LIB_VERSION = '0.6.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-dfp-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2013-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-common
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 description: google-dfp-api is a DFP API client library for Ruby
 email:
 - api.dklimkin@gmail.com
@@ -35,7 +35,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - examples/v201204/common/error_handling.rb
-- examples/v201204/common/oauth_handling.rb
 - examples/v201204/common/oauth2_handling.rb
 - examples/v201204/suggested_ad_unit_service/get_all_suggested_ad_units.rb
 - examples/v201204/suggested_ad_unit_service/approve_all_suggested_ad_units.rb
@@ -154,7 +153,6 @@ files:
 - examples/v201204/user_team_association_service/get_user_team_associations_by_statement.rb
 - examples/v201204/user_team_association_service/get_user_team_association.rb
 - examples/v201208/common/error_handling.rb
-- examples/v201208/common/oauth_handling.rb
 - examples/v201208/common/oauth2_handling.rb
 - examples/v201208/suggested_ad_unit_service/get_all_suggested_ad_units.rb
 - examples/v201208/suggested_ad_unit_service/approve_all_suggested_ad_units.rb
@@ -279,7 +277,6 @@ files:
 - examples/v201208/user_team_association_service/get_user_team_associations_by_statement.rb
 - examples/v201208/user_team_association_service/get_user_team_association.rb
 - examples/v201203/common/error_handling.rb
-- examples/v201203/common/oauth_handling.rb
 - examples/v201203/suggested_ad_unit_service/get_all_suggested_ad_units.rb
 - examples/v201203/suggested_ad_unit_service/approve_all_suggested_ad_units.rb
 - examples/v201203/suggested_ad_unit_service/get_suggested_ad_unit.rb
@@ -384,7 +381,6 @@ files:
 - examples/v201203/line_item_service/get_line_items_by_statement.rb
 - examples/v201203/line_item_service/get_line_item.rb
 - examples/v201206/common/error_handling.rb
-- examples/v201206/common/oauth_handling.rb
 - examples/v201206/common/oauth2_handling.rb
 - examples/v201206/suggested_ad_unit_service/get_all_suggested_ad_units.rb
 - examples/v201206/suggested_ad_unit_service/approve_all_suggested_ad_units.rb
@@ -506,8 +502,8 @@ files:
 - examples/v201206/user_team_association_service/update_user_team_associations.rb
 - examples/v201206/user_team_association_service/get_user_team_associations_by_statement.rb
 - examples/v201206/user_team_association_service/get_user_team_association.rb
+- examples/v201211/common/oauth2_jwt_handling.rb
 - examples/v201211/common/error_handling.rb
-- examples/v201211/common/oauth_handling.rb
 - examples/v201211/common/oauth2_handling.rb
 - examples/v201211/creative_wrapper_service/create_creative_wrappers.rb
 - examples/v201211/creative_wrapper_service/update_creative_wrappers.rb

data/examples/v201204/common/oauth_handling.rb

@@ -1,131 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 OAuth1.0a authorization method. It is designed
-# to be run from console and requires user input.
-#
-# NOTE: OAuth1.0a authorization method is deprecated, use OAuth2.0 instead.
-#       See oauth2_handling.rb for an example.
-#
-# Tags: UserService.getUsersByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-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/v201206/common/oauth_handling.rb

@@ -1,131 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 OAuth1.0a authorization method. It is designed
-# to be run from console and requires user input.
-#
-# NOTE: OAuth1.0a authorization method is deprecated, use OAuth2.0 instead.
-#       See oauth2_handling.rb for an example.
-#
-# Tags: UserService.getUsersByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-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/v201208/common/oauth_handling.rb

@@ -1,131 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 OAuth1.0a authorization method. It is designed
-# to be run from console and requires user input.
-#
-# NOTE: OAuth1.0a authorization method is deprecated, use OAuth2.0 instead.
-#       See oauth2_handling.rb for an example.
-#
-# Tags: UserService.getUsersByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201208
-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/v201211/common/oauth_handling.rb

@@ -1,131 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 OAuth1.0a authorization method. It is designed
-# to be run from console and requires user input.
-#
-# NOTE: OAuth1.0a authorization method is deprecated, use OAuth2.0 instead.
-#       See oauth2_handling.rb for an example.
-#
-# Tags: UserService.getUsersByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201211
-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