adcenter_api 0.0.2 → 0.0.3

data/lib/adcenter_api.rb

@@ -40,23 +40,19 @@ module AdcenterApi
     # - auth_handler: instance of an AdsCommon::Auth::BaseHandler subclass to
     #   handle authentication
     # - version: intended API version
-    # - namespace: namespace to use as default for body
+    # - header_ns: header namespace
+    # - default_ns: default namespace
     #
     # Returns:
-    # - a list of SOAP header handlers; one per provided header
+    # - SOAP header handler
     #
-    def soap_header_handler(auth_handler, version, namespace)
+    def soap_header_handler(auth_handler, version, header_ns, default_ns)
       auth_method = @config.read('authentication.method', :CLIENTLOGIN)
-      handler =
-          case auth_method
-          when :CLIENTLOGIN
-            #auth_ns = api_config.client_login_config(:AUTH_NAMESPACE_PREAMBLE) + version.to_s
-            #AdcenterApi::ClientLoginHeaderHandler.new(@credential_handler, auth_handler, namespace, auth_ns, version)
-            AdcenterApi::ClientLoginHeaderHandler.new(@credential_handler, auth_handler, namespace, version)
-          when :OAUTH, :OAUTH2
-            AdsCommon::SavonHeaders::OAuthHeaderHandler.new(@credential_handler, auth_handler, namespace, version)
-          end
-      return handler
+      handler_class = case auth_method
+                      when :CLIENTLOGIN then AdcenterApi::ClientLoginHeaderHandler
+                      when :OAUTH, :OAUTH2 then AdsCommon::SavonHeaders::OAuthHeaderHandler
+                      end
+      return handler_class.new(@credential_handler, auth_handler, header_ns, default_ns, version)
     end
 
     # Helper method to provide a simple way of doing an MCC-level operation

data/lib/adcenter_api/api_config.rb

@@ -51,11 +51,13 @@ module AdcenterApi
     @@environment_config = {
       :PRODUCTION => {
         :oauth_scope => '',
+        :header_ns => 'https://adcenter.microsoft.com/api/adcenter/',
         :v7 => '',
         :v8 => ''
       },
       :SANDBOX => {
         :oauth_scope => '',
+        :header_ns => 'https://adcenter.microsoft.com/api/adcenter/',
         :v7 => '',
         :v8 => ''
       }
@@ -91,7 +93,6 @@ module AdcenterApi
     #TODO: remove client_login_config
     @@client_login_config = {
       :AUTH_SERVER => 'https://www.microsoft.com',
-      :AUTH_NAMESPACE_PREAMBLE => 'https://adcenter.microsoft.com/api/adcenter/',
       :LOGIN_SERVICE_NAME => 'adcenter'
     }
 

data/lib/adcenter_api/client_login_header_handler.rb

@@ -3,56 +3,8 @@ require 'ads_common/savon_headers/base_header_handler'
 
 module AdcenterApi
   class ClientLoginHeaderHandler < AdsCommon::SavonHeaders::BaseHeaderHandler
-    # Initializes a header handler.
-    #
-    # Args:
-    #  - credential_handler: a header with credential data
-    #  - auth_handler: a header with auth data
-    #  - element_name: an API-specific name of header element
-    #  - namespace: default namespace to use
-    #  - auth_namespace: namespace to use for auth headers
-    #  - version: services version
-    #
-    #def initialize(credential_handler, auth_handler, namespace, auth_namespace, version)
-    def initialize(credential_handler, auth_handler, namespace, version)
-      super(credential_handler, auth_handler, namespace, version)
-      #@auth_namespace = auth_namespace
-    end
-
-    # Enriches soap object with API-specific headers like namespaces, login
-    # credentials etc. Sets the default namespace for the body to the one
-    # specified in initializer.
-    #
-    # Args:
-    #  - request: a HTTPI Request for extra configuration (unused)
-    #  - soap: a Savon soap object to fill fields in
-    #
-    # Returns:
-    #  - modified soap structure
-    #
-    def prepare_request(request, soap)
-      super(request, soap)
-      soap.header[:attributes!] ||= {}
-      header_name = prepend_namespace(get_header_element_name())
-      soap.header[:attributes!][header_name] ||= {}
-      #soap.header[:attributes!][header_name]['xmlns'] = @auth_namespace
-      return soap
-    end
 
     private
-    # Skips namespace prefixes for all elements except top level. Use default
-    # (inherited) prefixing for the top level key.
-    #
-    # Args:
-    #  - str: String to prepend with a namespace
-    #
-    # Returns:
-    #  - String with a namespace
-    #
-    def prepend_namespace(str)
-      #return get_header_element_name().eql?(str) ? super(str) : str
-      super(str)
-    end
 
     # Generates Adcenter API specific request header with ClientLogin data.
     def generate_request_header()

data/lib/adcenter_api/credential_handler.rb

@@ -25,7 +25,7 @@ module AdcenterApi
       validate_headers_for_server(result)
 
       extra_headers = {
-        'userAgent' => generate_soap_user_agent(),
+        'userAgent' => generate_user_agent(),
         'developerToken' => result[:developer_token]
       }
       if !@use_mcc and result[:client_customer_id]
@@ -38,26 +38,14 @@ module AdcenterApi
       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, 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)
+    # Generates string to use as user agent in headers.
+    def generate_user_agent(extra_ids = [])
       agent_app = @config.read('authentication.user_agent')
       extra_ids << ['AwApi-Ruby/%s' % AdcenterApi::ApiConfig::CLIENT_LIB_VERSION]
-      return [extra_ids, agent_app]
-    end
+       super(extra_ids, agent_app)
+     end
+
+    private
 
     # Validates that the right credentials are being used for the chosen
     # environment.

data/lib/adcenter_api/report_header_handler.rb

@@ -32,7 +32,7 @@ module AdcenterApi
           'Content-Type' => 'application/x-www-form-urlencoded',
           'Authorization' =>
               @auth_handler.auth_string(credentials, HTTPI::Request.new(url)),
-          'User-Agent' => @credential_handler.generate_http_user_agent(),
+          'User-Agent' => @credential_handler.generate_user_agent(),
           'clientCustomerId' => credentials[:client_customer_id].to_s,
           'developerToken' => credentials[:developer_token]
       }

data/lib/adcenter_api/version.rb

@@ -1,5 +1,5 @@
 module AdcenterApi
   module ApiConfig
-    CLIENT_LIB_VERSION = "0.0.2"
+    CLIENT_LIB_VERSION = "0.0.3"
   end
 end

data/lib/ads_common/savon_service_decorator.rb

@@ -27,6 +27,7 @@ AdsCommon::SavonService.class_eval do
     additional_headers = args.delete(:headers) unless args.nil?
     prepend_namespace_to_hash(args, ns)
     prepend_namespace_to_hash(additional_headers, ns)
+    puts "**************************************args = #{args}"
     response = @client.request(ns, original_input_name) do |soap|
       @client.http.headers["SOAPAction"] = original_action_name
       soap.body = args
@@ -39,7 +40,11 @@ AdsCommon::SavonService.class_eval do
     if h.is_a?(Hash)
       h.dup.each do |k,v|
         h.delete(k)
-        h[k.to_s=~ /^#{namespace}:/ ? k : prepend_namespace(k.to_s.camelize, namespace)] = prepend_namespace_to_hash(v, namespace)
+        if k.to_s=~/!$/ || k.to_s=~/:/ #on ne transforme pas les noms finissant par ! ou contenant : (exemple: attributes! ou xsi:type)
+          h[k] = prepend_namespace_to_hash(v, namespace)
+        else
+          h[k.to_s=~ /^#{namespace}:/ ? k : prepend_namespace(k.to_s.camelize, namespace)] = prepend_namespace_to_hash(v, namespace)
+        end
       end
     elsif h.is_a?(Array) # e.g: h = {:campaigns => {:campaign => [{:name => 'foo'}, {:name => 'foofoo'}]}}
       h.map!{|e| prepend_namespace_to_hash(e, namespace)}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adcenter_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-06 00:00:00.000000000 Z
+date: 2012-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2165880020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,31 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2165880020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: google-ads-common
-  requirement: &2165879580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *2165879580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2165879100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165879100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165878560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +69,12 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *2165878560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
 description: Ruby wrapper for Microsoft Adcenter API
 email:
 - arambert@optimeez.com
@@ -128,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for Microsoft Adcenter API