google-dfp-api 0.2.7 → 0.2.8

data/ChangeLog

@@ -1,3 +1,8 @@
+0.2.8:
+  - Added .gemspec and updated packaging process.
+  - Removed explicit require for RubyGems, see README.
+  - Added support for v201201.
+
 0.2.7:
   - Support for GZip compression.
   - Require google-ads-common 0.6.1 or later from now on.

data/README

@@ -60,10 +60,6 @@ or if you downloaded the gem package manually, use:
 In order to use the library you need to include its modules:
   require 'dfp_api'
 
-Depending on your configuration you might also need to explicitely require
-the rubygems library first:
-  require 'rubygems'
-
 Then, library object could be instantiated:
   dfp = DfpApi::Api.new
 
@@ -84,6 +80,18 @@ constructor:
 
 An example of configuration file is available as part of this library.
 
+*Note*: if you are using Ruby 1.8 you may need to include RubyGems to be able
+to require other gems code. There are several ways to do it, the easiest one is
+to pass '-rubygems' parameter to the ruby interpreter:
+   $ ruby -rubygems my_program_that_uses_gems
+
+you can also set this up in the environment:
+   $ export RUBYOPT="rubygems"
+
+or add it to the bash configuration file:
+   $ echo 'export RUBYOPT="rubygems"' >> ~/.bashrc
+
+
 == Using OAuth
 
 It is recommended to use OAuth authentication method instead of explicit
@@ -106,7 +114,7 @@ Once the library object is created you can request services with a 'service'
 method:
   user_service = dfp.service(:UserService, <API_VERSION>)
 
-where <API_VERSION> is required version of DFP API as symbol, e.g. :v201111.
+where <API_VERSION> is required version of DFP API as symbol, e.g. :v201201.
 
 Then you should be able to execute service methods:
 
@@ -140,7 +148,7 @@ Examples can be run by executing by running:
 
 from the "examples/<version>/<service_name>" directory i.e.
 
-  $ cd examples/v201111/user_service
+  $ cd examples/v201201/user_service
   $ ruby get_all_users.rb
 
 Some examples require modification to be functional, like create_order example
@@ -165,8 +173,8 @@ this, you should create a standard Logger object and pass it to the library:
    require 'logger'
    logger = Logger.new('path/to/log_filename')
    logger.level = Logger::DEBUG
-   adwords = AdwordsApi::Api.new
-   adwords.logger = logger
+   dfp = DfpApi::Api.new
+   dfp.logger = logger
 
 Request details are logged at the INFO log level, while raw HTTP headers and XML
 dumps are logged at the DEBUG log level. For more details on using Logger refer
@@ -221,7 +229,7 @@ Questions can be asked on forum
 
 == License
 
-Copyright 2011, Google Inc. All Rights Reserved.
+Copyright 2011-2012, Google Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 this file except in compliance with the License.

data/dfp_api.yml

@@ -0,0 +1,39 @@
+---
+# 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.
+  :method: ClientLogin
+
+  # Auth parameters for OAuth method.
+  # Set the OAuth consumer key and secret. Anonymous values can be used for
+  # testing, and real values can be obtained by registering your application:
+  # http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html
+  #: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
+  # To manage your auth tokens manually, use the 'auth_token' property.
+  #:auth_token: INSERT_AUTH_TOKEN_HERE
+
+  # Other parameters.
+  :application_name: dfp_ruby_examples
+  :network_code: INSERT_NETWORK_CODE_HERE
+:service:
+  :environment: SANDBOX
+:connection:
+  # Enable to request all responses to be compressed.
+  :enable_gzip: false
+  # If your proxy connection requires authentication, make sure to include it in
+  # the URL, e.g.: http://user:password@proxy_hostname:8080
+  #:proxy: INSERT_PROXY_HERE
+:library:
+  :log_level: INFO

data/examples/v201103/common/error_handling.rb

@@ -21,7 +21,6 @@
 #
 # Tags: UserService.updateUser
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/common/oauth_handling.rb

@@ -22,7 +22,6 @@
 #
 # Tags: UserService.getUsersByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/company_service/create_companies.rb

@@ -22,7 +22,6 @@
 
 # Tags: CompanyService.createCompanies
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/company_service/get_all_companies.rb

@@ -21,7 +21,6 @@
 #
 # Tags: CompanyService.getCompaniesByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/company_service/get_companies_by_statement.rb

@@ -23,7 +23,6 @@
 #
 # Tags: CompanyService.getCompaniesByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/company_service/get_company.rb

@@ -22,7 +22,6 @@
 #
 # Tags: CompanyService.getCompany
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/company_service/update_companies.rb

@@ -23,7 +23,6 @@
 #
 # Tags: CompanyService.getCompaniesByStatement, CompanyService.updateCompanies
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/creative_service/copy_image_creatives.rb

@@ -23,7 +23,6 @@
 #
 # Tags: CreativeService.getCreativesByStatement, CreativeService.createCreatives
 
-require 'rubygems'
 require 'dfp_api'
 
 require 'base64'

data/examples/v201103/creative_service/create_creatives.rb

@@ -23,7 +23,6 @@
 #
 # Tags: CreativeService.createCreatives
 
-require 'rubygems'
 require 'base64'
 require 'dfp_api'
 

data/examples/v201103/creative_service/get_all_creatives.rb

@@ -21,7 +21,6 @@
 #
 # Tags: CreativeService.getCreativesByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/creative_service/get_creative.rb

@@ -22,7 +22,6 @@
 #
 # Tags: CreativeService.getCreative
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/creative_service/get_creatives_by_statement.rb

@@ -23,7 +23,6 @@
 #
 # Tags: CreativeService.getCreativesByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/creative_service/update_creatives.rb

@@ -22,7 +22,6 @@
 #
 # Tags: CreativeService.getCreativesByStatement, CreativeService.updateCreatives
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -25,7 +25,6 @@
 # Tags: CustomTargetingService.createCustomTargetingKeys,
 #       CustomTargetingService.createCustomTargetingValues
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -23,7 +23,6 @@
 # Tags: CustomTargetingService.getCustomTargetingKeysByStatement,
 #       CustomTargetingService.performCustomTargetingKeyAction
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/custom_targeting_service/delete_custom_targeting_values.rb

@@ -24,7 +24,6 @@
 # Tags: CustomTargetingService.getCustomTargetingValuesByStatement,
 #       CustomTargetingService.performCustomTargetingValueAction
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -23,7 +23,6 @@
 # Tags: CustomTargetingService.getCustomTargetingKeysByStatement,
 #       CustomTargetingService.getCustomTargetingValuesByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

@@ -23,7 +23,6 @@
 #
 # Tags: CustomTargetingService.getCustomTargetingKeysByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/custom_targeting_service/get_custom_targeting_values_by_statement.rb

@@ -25,7 +25,6 @@
 #
 # Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/custom_targeting_service/update_custom_targeting_keys.rb

@@ -24,7 +24,6 @@
 # Tags: CustomTargetingService.getCustomTargetingKeysByStatement,
 #       CustomTargetingService.updateCustomTargetingKeys
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/custom_targeting_service/update_custom_targeting_values.rb

@@ -24,7 +24,6 @@
 # Tags: CustomTargetingService.getCustomTargetingValuesByStatement,
 #       CustomTargetingService.updateCustomTargetingValues
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/forecast_service/get_forecast.rb

@@ -22,7 +22,6 @@
 #
 # Tags: ForecastService.getForecast
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/forecast_service/get_forecast_by_id.rb

@@ -22,7 +22,6 @@
 #
 # Tags: ForecastService.getForecastById
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/inventory_service/create_ad_units.rb

@@ -23,7 +23,6 @@
 #
 # Tags: InventoryService.createAdUnits
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/inventory_service/deactivate_ad_units.rb

@@ -23,7 +23,6 @@
 # Tags: InventoryService.getLineItemsByStatement,
 #       InventoryService.performAdUnitAction
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/inventory_service/get_ad_unit.rb

@@ -22,7 +22,6 @@
 #
 # Tags: InventoryService.getAdUnit
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/inventory_service/get_ad_units_by_statement.rb

@@ -22,7 +22,6 @@
 #
 # Tags: InventoryService.getAdUnitsByStatement, NetworkService.getCurrentNetwork
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/inventory_service/get_all_ad_units.rb

@@ -21,7 +21,6 @@
 #
 # Tags: InventoryService.getAdUnitsByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/inventory_service/update_ad_units.rb

@@ -23,7 +23,6 @@
 #
 # Tags: InventoryService.getAdUnitsByStatement, InventoryService.updateAdUnits
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/line_item_creative_association_service/create_licas.rb

@@ -26,7 +26,6 @@
 #
 # Tags: LineItemCreativeAssociationService.createLineItemCreativeAssociations
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/line_item_creative_association_service/deactivate_licas.rb

@@ -24,7 +24,6 @@
 # Tags: InventoryService.getLineItemsByStatement,
 #       InventoryService.performAdUnitAction
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/line_item_creative_association_service/get_all_licas.rb

@@ -22,7 +22,6 @@
 #
 # Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/line_item_creative_association_service/get_lica.rb

@@ -23,7 +23,6 @@
 #
 # Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociation
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/line_item_creative_association_service/get_licas_by_statement.rb

@@ -24,7 +24,6 @@
 #
 # Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/line_item_creative_association_service/update_licas.rb

@@ -24,7 +24,6 @@
 #   LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement,
 #   LineItemCreativeAssociationService.updateLineItemCreativeAssociations
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103

data/examples/v201103/line_item_service/activate_line_items.rb

@@ -27,7 +27,6 @@
 # Tags: LineItemService.getLineItemsByStatement,
 #       LineItemService.performLineItemAction
 
-require 'rubygems'
 require 'dfp_api'
 
 API_VERSION = :v201103