google-dfp-api 0.2.1 → 0.2.2

data/examples/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/line_item_service/create_line_items.rb

@@ -88,7 +88,7 @@ def create_line_items()
   }
 
   # 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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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/v201104/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.

data/examples/v201104/placement_service/get_all_placements.rb

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

data/examples/v201104/user_service/get_all_users.rb

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

data/lib/dfp_api.rb

@@ -20,17 +20,17 @@
 # Contains the main classes for the client library. Takes care of all
 # dependencies.
 
-gem 'google-ads-common', '~>0.4.0'
-require 'logger'
+gem 'google-ads-common', '~>0.5.0'
+
+require 'savon'
+
 require 'ads_common/api'
-require 'ads_common/config'
-require 'ads_common/auth/client_login_handler'
-require 'ads_common/savon_headers/client_login_header_handler'
+require 'ads_common/savon_headers/oauth_header_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/client_login_header_handler'
 require 'dfp_api/credential_handler'
+require 'dfp_api/errors'
 
 # Main namespace for all the client library's modules and classes.
 module DfpApi
@@ -46,6 +46,11 @@ module DfpApi
       @credential_handler = DfpApi::CredentialHandler.new(@config)
     end
 
+    # Getter for the API service configurations.
+    def api_config
+      DfpApi::ApiConfig
+    end
+
     # Sets the logger to use.
     def logger=(logger)
       super(logger)
@@ -55,75 +60,24 @@ module DfpApi
       end
     end
 
-    # Getter for the API service configurations.
-    def api_config
-      DfpApi::ApiConfig
-    end
-
     private
 
-    # Creates an appropriate authentication handler for each service (reuses the
-    # ClientLogin one to avoid generating multiple tokens unnecessarily).
-    def create_auth_handler(environment, version)
-      if @client_login_handler.nil?
-        auth_server = api_config.auth_server(environment)
-        @client_login_handler =
-            AdsCommon::Auth::ClientLoginHandler.new(config, auth_server,
-                api_config.headers_config[:LOGIN_SERVICE_NAME])
-      end
-      return @client_login_handler
-    end
-
     # Retrieve DFP HeaderHandlers per credential.
-    def soap_header_handlers(auth_handler, header_list, version)
-      ns = api_config.headers_config[:HEADER_NAMESPACE_PREAMBLE] + version.to_s
-      handler = case version
-          when :v201101 then AdsCommon::SavonHeaders::SimpleHeaderHandler
-          when :v201103 then AdsCommon::SavonHeaders::ClientLoginHeaderHandler
-          when :v201104 then AdsCommon::SavonHeaders::ClientLoginHeaderHandler
-          else
-            raise AdsCommon::Errors::Error,
-                "Unknown or unspecified version: \"%s\"" % version.to_s
+    def soap_header_handlers(auth_handler, header_list, version, namespace)
+      handler = nil
+      auth_method = @config.read('authentication.method',
+          'ClientLogin').to_s.upcase.to_sym
+      handler = case auth_method
+        when :CLIENTLOGIN
+          (version == :v201101) ?
+              AdsCommon::SavonHeaders::SimpleHeaderHandler :
+              DfpApi::ClientLoginHeaderHandler
+        when :OAUTH
+          AdsCommon::SavonHeaders::OAuthHeaderHandler
       end
+      ns = api_config.headers_config[:HEADER_NAMESPACE_PREAMBLE] + version.to_s
       return [handler.new(@credential_handler, auth_handler,
           api_config.headers_config[:REQUEST_HEADER], ns, version)]
     end
-
-    # Handle loading of a single service wrapper. Needs to be implemented on
-    # specific API level.
-    #
-    # Args:
-    # - version: intended API version. Must be a symbol.
-    # - service: name for the intended service. Must be a symbol.
-    #
-    # Returns:
-    # - a wrapper generated for the service.
-    #
-    def prepare_wrapper(version, service)
-      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
-      wrapper = class_for_path(interface_class_name).new(endpoint_url)
-
-      auth_handler = create_auth_handler(environment, version)
-      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|
-        wrapper.headerhandler << handler
-      end
-
-      return wrapper
-    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

@@ -40,7 +40,7 @@ module DfpApi
     # Set other constants
     API_NAME = 'DfpApi'
     API_PATH = 'dfp_api'
-    CLIENT_LIB_VERSION = '0.2.1'
+    CLIENT_LIB_VERSION = '0.2.2'
     DEFAULT_CONFIG_FILENAME = 'dfp_api.yml'
 
     # Configure the services available to each version
@@ -65,11 +65,13 @@ module DfpApi
     # Configure the different environments, with the base URL for each one
     @@environment_config = {
       :PRODUCTION => {
+        :oauth_scope => 'https://www.google.com/apis/ads/publisher/',
         :v201101 => 'https://www.google.com/apis/ads/publisher/',
         :v201103 => 'https://www.google.com/apis/ads/publisher/',
         :v201104 => 'https://www.google.com/apis/ads/publisher/'
       },
       :SANDBOX => {
+        :oauth_scope => 'https://sandbox.google.com/apis/ads/publisher/',
         :v201101 => 'https://sandbox.google.com/apis/ads/publisher/',
         :v201103 => 'https://sandbox.google.com/apis/ads/publisher/',
         :v201104 => 'https://sandbox.google.com/apis/ads/publisher/'

data/lib/dfp_api/client_login_header_handler.rb

@@ -0,0 +1,56 @@
+#!/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.
+#
+# Handles SOAP headers and namespaces definition for ClientLogin type header.
+
+require 'ads_common/savon_headers/simple_header_handler'
+
+module DfpApi
+  class ClientLoginHeaderHandler < AdsCommon::SavonHeaders::SimpleHeaderHandler
+    private
+
+    # Generates SOAP request header with login credentials and namespace
+    # definition.
+    #
+    # Args:
+    #  - None
+    #
+    # Returns:
+    #  - Hash containing a header with filled in credentials
+    #
+    def generate_request_header()
+      headers = @auth_handler.headers(@credential_handler.credentials)
+      return headers.inject({}) do |request_header, (header, value)|
+        if header == :authToken
+          auth_header = prepend_namespace('authentication')
+          request_header[auth_header] = {
+              prepend_namespace('token') => value
+          }
+          request_header[:attributes!] ||= {}
+          request_header[:attributes!][auth_header] = {
+              'xsi:type' => prepend_namespace('ClientLogin'),
+          }
+        else
+          request_header[prepend_namespace(header)] = value
+        end
+        request_header
+      end
+    end
+  end
+end