google-dfp-api 0.3.1 → 0.3.2

data/ChangeLog

@@ -1,3 +1,8 @@
+0.3.2:
+  - Require google-ads-common 0.7.3 or later from now on.
+  - Support for OAuth2.0 authentication method.
+  - Updated User-Agent to a single standard.
+
 0.3.1:
   - Now require Savon-0.9.9 (fixes Content-Length bug).
   - Require google-ads-common 0.7.0 or later from now on.

data/README

@@ -208,8 +208,8 @@ respond in gzipped format. All requests are sent uncompressed regardless.
 External dependencies should be pulled automatically on gem install. Here is the
 list though:
 
-  - Google Ads Common library (google-ads-common-0.7.0);
-  - Savon 'the heavy metal Ruby SOAP client' (savon-0.9.9).
+  - Google Ads Common library (google-ads-common);
+  - Savon 'the heavy metal Ruby SOAP client' (savon).
 
 
 = Where do I submit bug reports and feature requests?

data/dfp_api.yml

@@ -2,10 +2,24 @@
 # This is an example configuration file for the Ruby DFP API client library.
 # Please fill in the required fields, and copy it over to your home directory.
 :authentication:
-  # Authentication method, methods currently supported: OAuth, ClientLogin.
+  # Authentication method, methods currently supported:
+  # OAuth2, OAuth, ClientLogin.
   :method: ClientLogin
 
-  # Auth parameters for OAuth method.
+  # Auth parameters for OAuth2.0 method.
+  # Set the OAuth2 client id and secret. Register your application here to
+  # obtain these values:
+  #   https://code.google.com/apis/console#access
+  #:oauth2_client_id: INSERT_OAUTH2_CLIENT_ID_HERE
+  #:oauth2_client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
+  # Optional, see: https://developers.google.com/accounts/docs/OAuth2WebServer
+  #:oauth2_callback: INSERT_OAUTH2_CALLBACK_URL_HERE
+  #:oauth2_state: INSERT_OAUTH2_STATE_HERE
+  #: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

data/examples/v201204/common/oauth2_handling.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#
+# This example shows how to use OAuth2.0 authorization method. It is designed to
+# be run from console and requires user input.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201204
+PAGE_SIZE = 500
+MAX_RETRIES = 3
+
+def oauth2_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::OAuth2VerificationRequired => e
+      if retry_count < MAX_RETRIES
+        verification_code = get_verification_code(e.oauth_url)
+        dfp.credential_handler.set_credential(
+            :oauth2_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
+    oauth2_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/v201204/common/oauth_handling.rb

@@ -18,8 +18,11 @@
 #           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 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
 

data/lib/dfp_api.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+# Encoding: utf-8
 #
 # Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,10 +17,7 @@
 #           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.7.0'
+# Contains the main classes for the client library.
 
 require 'ads_common/api'
 require 'ads_common/savon_headers/oauth_header_handler'
@@ -56,7 +53,7 @@ module DfpApi
       handler = case auth_method
         when :CLIENTLOGIN
           DfpApi::ClientLoginHeaderHandler
-        when :OAUTH
+        when :OAUTH, :OAUTH2
           AdsCommon::SavonHeaders::OAuthHeaderHandler
         else
           raise AdsCommon::Errors::AuthError,

data/lib/dfp_api/credential_handler.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+# Encoding: utf-8
 #
 # Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -36,14 +36,27 @@ module DfpApi
       return result
     end
 
+    # Generates string to user as user agent in HTTP headers.
+    def generate_http_user_agent(extra_ids = [])
+      extra_ids, agent_app = get_user_agent_data(extra_ids)
+      super(extra_ids, agent_app)
+    end
+
     # Generates string to user as user agent in SOAP headers.
     def generate_soap_user_agent(extra_ids = [])
-      extra_ids << ["DfpApi-Ruby-%s" % DfpApi::ApiConfig::CLIENT_LIB_VERSION]
-      super(extra_ids)
+      extra_ids, agent_app = get_user_agent_data(extra_ids)
+      super(extra_ids, agent_app)
     end
 
     private
 
+    # Returns agent name and data for user-agent string generation.
+    def get_user_agent_data(extra_ids)
+      agent_app = @config.read('authentication.application_name')
+      extra_ids << ["DfpApi-Ruby/%s" % DfpApi::ApiConfig::CLIENT_LIB_VERSION]
+      return [extra_ids, agent_app]
+    end
+
     # Validates that the right credentials are being used for the chosen
     # environment.
     # TODO(dklimkin): implement NetworkCode check.

data/lib/dfp_api/version.rb

@@ -21,6 +21,6 @@
 
 module DfpApi
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.3.1'
+    CLIENT_LIB_VERSION = '0.3.2'
   end
 end

data/test/bugs/test_issue_00000016.rb

@@ -0,0 +1,151 @@
+#!/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.
+#
+# Tests issue #16.
+
+require 'nori'
+require 'savon'
+require 'test/unit'
+
+require 'ads_common/results_extractor'
+require 'dfp_api/v201204/line_item_service_registry'
+
+class TestDfpApi < Test::Unit::TestCase
+
+  def setup()
+    @registry = DfpApi::V201204::LineItemService::LineItemServiceRegistry
+  end
+
+  def test_issue_16()
+    data = Nori.parse(get_xml_text())[:envelope][:body]
+    extractor = AdsCommon::ResultsExtractor.new(@registry)
+    result = extractor.extract_result(data, 'get_line_items_by_statement')
+    targeting = result[:results][0][:targeting][:inventory_targeting]
+    assert_equal([1234567, 23456], targeting[:targeted_placement_ids])
+  end
+
+  def get_xml_text()
+    return <<EOT
+<?xml version="1.0"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+ <soap:Header>
+  <ResponseHeader xmlns="https://www.google.com/apis/ads/publisher/v201101">
+   <requestId>dac42656454</requestId>
+   <responseTime>9</responseTime>
+  </ResponseHeader>
+ </soap:Header>
+ <soap:Body>
+  <getLineItemsByStatementResponse
+      xmlns="https://www.google.com/apis/ads/publisher/v201101">
+   <rval>
+    <totalResultSetSize>1</totalResultSetSize>
+    <startIndex>0</startIndex>
+    <results>
+     <orderId>345678</orderId>
+     <id>89012</id>
+     <name>some name</name>
+     <orderName>someOrderName</orderName>
+     <startDateTime>
+      <date>
+       <year>2011</year>
+       <month>1</month>
+       <day>1</day>
+      </date>
+      <hour>0</hour>
+      <minute>0</minute>
+      <second>0</second>
+      <timeZoneID>America/New_York</timeZoneID>
+     </startDateTime>
+     <startDateTimeType>USE_START_DATE_TIME</startDateTimeType>
+     <endDateTime>
+      <date>
+       <year>2011</year>
+       <month>2</month>
+       <day>1</day>
+      </date>
+      <hour>23</hour>
+      <minute>59</minute>
+      <second>0</second>
+      <timeZoneID>America/New_York</timeZoneID>
+     </endDateTime>
+     <unlimitedEndDateTime>false</unlimitedEndDateTime>
+     <creativeRotationType>OPTIMIZED</creativeRotationType>
+     <deliveryRateType>EVENLY</deliveryRateType>
+     <roadblockingType>ONE_OR_MORE</roadblockingType>
+     <lineItemType>STANDARD</lineItemType>
+     <unitType>IMPRESSIONS</unitType>
+     <duration>LIFETIME</duration>
+     <unitsBought>3</unitsBought>
+     <costPerUnit>
+      <currencyCode>USD</currencyCode>
+      <microAmount>0</microAmount>
+     </costPerUnit>
+     <valueCostPerUnit>
+      <currencyCode>USD</currencyCode>
+      <microAmount>0</microAmount>
+     </valueCostPerUnit>
+     <costType>CPM</costType>
+     <discountType>PERCENTAGE</discountType>
+     <discount>0.0</discount>
+     <creativeSizes>
+      <width>160</width>
+      <height>600</height>
+      <isAspectRatio>false</isAspectRatio>
+     </creativeSizes>
+     <creativeSizes>
+      <width>336</width>
+      <height>280</height>
+      <isAspectRatio>false</isAspectRatio>
+     </creativeSizes>
+     <creativeSizes>
+      <width>728</width>
+      <height>90</height>
+      <isAspectRatio>false</isAspectRatio>
+     </creativeSizes>
+     <allowOverbook>false</allowOverbook>
+     <stats>
+      <impressionsDelivered>123</impressionsDelivered>
+      <clicksDelivered>345</clicksDelivered>
+     </stats>
+     <deliveryIndicator>
+      <expectedDeliveryPercentage>11.11111</expectedDeliveryPercentage>
+      <actualDeliveryPercentage>22.222</actualDeliveryPercentage>
+     </deliveryIndicator>
+     <budget>
+      <currencyCode>USD</currencyCode>
+      <microAmount>0</microAmount>
+     </budget>
+     <status>DELIVERING</status>
+     <reservationStatus>RESERVED</reservationStatus>
+     <isArchived>false</isArchived>
+     <LineItemSummary.Type>LineItem</LineItemSummary.Type>
+     <targeting>
+      <inventoryTargeting>
+       <targetedPlacementIds>1234567</targetedPlacementIds>
+       <targetedPlacementIds>23456</targetedPlacementIds>
+      </inventoryTargeting>
+     </targeting>
+    </results>
+   </rval>
+  </getLineItemsByStatementResponse>
+ </soap:Body>
+</soap:Envelope>
+EOT
+  end
+end

data/test/suite_unittests.rb

@@ -27,3 +27,6 @@ require 'test/unit'
 
 # DFP API units tests.
 Dir.glob('./test/dfp_api/test_*.rb').each {|file| require file}
+
+# DFP API bug tests.
+Dir.glob('./test/bugs/test_*.rb').each {|file| require file}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-dfp-api
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Danial Klimkin
@@ -15,41 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-16 00:00:00 +04:00
-default_executable: 
+date: 2012-06-21 00:00:00 Z
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: savon
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 41
-        segments: 
-        - 0
-        - 9
-        - 9
-        version: 0.9.9
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: google-ads-common
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
         - 0
         - 7
-        - 0
-        version: 0.7.0
+        - 3
+        version: 0.7.3
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 description: google-dfp-api is a DFP API client library for Ruby
 email: 
 - api.dklimkin@gmail.com
@@ -172,6 +155,7 @@ files:
 - examples/v201111/line_item_service/get_line_item.rb
 - 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
 - examples/v201204/suggested_ad_unit_service/get_suggested_ad_unit.rb
@@ -774,6 +758,7 @@ files:
 - lib/dfp_api/v201201/creative_service.rb
 - lib/dfp_api/v201201/user_service_registry.rb
 - lib/dfp_api/client_login_header_handler.rb
+- test/bugs/test_issue_00000016.rb
 - test/dfp_api/test_dfp_api.rb
 - test/dfp_api/test_config.yml
 - test/suite_unittests.rb
@@ -781,7 +766,6 @@ files:
 - README
 - ChangeLog
 - dfp_api.yml
-has_rdoc: true
 homepage: http://code.google.com/p/google-api-ads-ruby/
 licenses: []
 
@@ -813,9 +797,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: google-dfp-api
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby Client libraries for DFP API
 test_files: 
+- test/bugs/test_issue_00000016.rb
 - test/dfp_api/test_dfp_api.rb