adcenter_api 0.0.1

data/lib/adcenter_api/v8/reporting_service.rb

@@ -0,0 +1,38 @@
+# Encoding: utf-8
+#
+# This is auto-generated code, changes will be overwritten.
+#
+# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+# License:: Licensed under the Apache License, Version 2.0.
+#
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 16:50:32.
+
+require 'ads_common/savon_service'
+require 'adcenter_api/v8/reporting_service_registry'
+
+module AdcenterApi; module V8; module ReportingService
+  class ReportingService < AdsCommon::SavonService
+    def initialize(config, endpoint)
+      namespace = 'https://adcenter.microsoft.com/v8'
+      super(config, endpoint, namespace, :v8)
+    end
+
+    def submit_generate_report(*args, &block)
+      return execute_action('submit_generate_report', args, &block)
+    end
+
+    def poll_generate_report(*args, &block)
+      return execute_action('poll_generate_report', args, &block)
+    end
+
+    private
+
+    def get_service_registry()
+      return ReportingServiceRegistry
+    end
+
+    def get_module()
+      return AdcenterApi::V8::ReportingService
+    end
+  end
+end; end; end

data/lib/adcenter_api/v8/reporting_service_registry.rb

@@ -0,0 +1,30 @@
+# Encoding: utf-8
+#
+# This is auto-generated code, changes will be overwritten.
+#
+# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+# License:: Licensed under the Apache License, Version 2.0.
+#
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 16:50:32.
+
+require 'adcenter_api/errors'
+
+module AdcenterApi; module V8; module ReportingService
+  class ReportingServiceRegistry
+    REPORTINGSERVICE_METHODS = {:submit_generate_report=>{:input=>{:name=>"submit_generate_report_request", :fields=>[]}, :output=>{:name=>"submit_generate_report_response", :fields=>[]}, :original_name=>"SubmitGenerateReport"}, :poll_generate_report=>{:input=>{:name=>"poll_generate_report_request", :fields=>[]}, :output=>{:name=>"poll_generate_report_response", :fields=>[]}, :original_name=>"PollGenerateReport"}}
+    REPORTINGSERVICE_TYPES = {}
+    REPORTINGSERVICE_NAMESPACES = []
+
+    def self.get_method_signature(method_name)
+      return REPORTINGSERVICE_METHODS[method_name.to_sym]
+    end
+
+    def self.get_type_signature(type_name)
+      return REPORTINGSERVICE_TYPES[type_name.to_sym]
+    end
+
+    def self.get_namespace(index)
+      return REPORTINGSERVICE_NAMESPACES[index]
+    end
+  end
+end; end; end

data/lib/adcenter_api/version.rb

@@ -0,0 +1,5 @@
+module AdcenterApi
+  module ApiConfig
+    CLIENT_LIB_VERSION = "0.0.1"
+  end
+end

data/lib/ads_common/api_config_decorator.rb

@@ -0,0 +1,43 @@
+####### Overriden for Adcenter #########
+
+AdsCommon::ApiConfig.module_eval do
+
+  # Get the endpoint for a service on a given environment and API version.
+  #
+  # Args:
+  # - environment: the service environment to be used
+  # - version: the API version
+  # - service: the name of the API service
+  #
+  # Returns:
+  # The endpoint URL
+  #
+  def endpoint(environment, version, service)
+    if !address_config().nil?
+      address_config()[version][service][environment].to_s
+    else
+      ""
+    end
+  end
+  # Generates an array of WSDL URLs based on defined Services and version
+  # supplied. This method is used by generators to determine what service
+  # wrappers to generate.
+  #
+  # Args:
+  #   - version: the API version.
+  #
+  # Returns
+  #   hash of pairs Service => WSDL URL
+  #
+  def get_wsdls(version)
+    res = {}
+    services(version).each do |service|
+      if (!address_config().nil?)
+        path = address_config()[version][service][default_environment()].to_s
+      end
+      res[service.to_s] = path || ""
+    end
+    return res
+  end
+
+end

data/lib/ads_common/auth/client_login_handler_decorator.rb

@@ -0,0 +1,168 @@
+####### Overriden for Adcenter #########
+
+AdsCommon::Auth::ClientLoginHandler.class_eval do
+
+    ACCOUNT_TYPE = 'GOOGLE'
+    AUTH_PATH = '/accounts/ClientLogin'
+    AUTH_PREFIX = 'GoogleLogin auth='
+    CAPTCHA_PATH = '/accounts/'
+
+    # Initializes the ClientLoginHandler with all the necessary details.
+    def initialize(config, auth_server, service_name)
+      super(config)
+      @server = auth_server
+      @service_name = service_name
+    end
+
+    # Invalidates the stored token if the user_name, password or provided auth
+    # token have changed.
+    def property_changed(prop, value)
+      if [:user_name, :password].include?(prop)
+        @token = nil
+      end
+      if :auth_token.eql?(prop)
+        @token = create_token_from_string(value)
+      end
+    end
+
+    # Handle specific ClientLogin errors.
+    def handle_error(error)
+      # TODO: Add support for automatically regenerating auth tokens when they
+      # expire.
+      get_logger().error(error)
+      raise error
+    end
+
+    # Returns authorization string.
+    def auth_string(credentials, request)
+      return [AUTH_PREFIX, get_token(credentials)].join
+    end
+
+    private
+
+    # Auxiliary method to validate the credentials for token generation.
+    #
+    # Args:
+    # - credentials: a hash with the credentials for the account being
+    #   accessed
+    #
+    # Raises:
+    # - AdsCommon::Errors::AuthError if validation fails
+    #
+    def validate_credentials(credentials)
+      if credentials.nil?
+        raise AdsCommon::Errors::AuthError, 'No credentials supplied.'
+      end
+
+      if credentials[:auth_token].nil?
+        if credentials[:user_name].nil?
+          raise AdsCommon::Errors::AuthError,
+              'UserName address not included in credentials.'
+        end
+        if credentials[:password].nil?
+          raise AdsCommon::Errors::AuthError,
+              'Password not included in credentials.'
+        end
+      else
+        if credentials[:user_name] and credentials[:password]
+          get_logger().warn('Both auth_token and login credentials present' +
+              ', preferring auth_token.')
+        end
+      end
+    end
+
+    # Auxiliary method to generate an authentication token for login in via
+    # the ClientLogin API.
+    #
+    # Args:
+    # - credentials: a hash with the credentials for the account being
+    #   accessed
+    #
+    # Returns:
+    # - The auth token for the account
+    #
+    # Raises:
+    # - AdsCommon::Errors::AuthError if authentication fails
+    #
+    def create_token(credentials)
+      token = credentials.include?(:auth_token) ?
+          create_token_from_string(credentials[:auth_token]) :
+          generate_token(credentials)
+      return token
+    end
+
+    # Creates token for provided auth string. Trivial for this handler.
+    def create_token_from_string(token_string)
+      return token_string
+    end
+
+    # Prepares POST data for ClientLogin request.
+    def get_login_data(credentials)
+      user_name = CGI.escape(credentials[:user_name])
+      password = CGI.escape(credentials[:password])
+      service_name = @service_name
+      data = "accountType=%s&Email=%s&Passwd=%s&service=%s" %
+          [ACCOUNT_TYPE, user_name, password, service_name]
+      if credentials[:logintoken] and credentials[:logincaptcha]
+        data += "&logintoken=%s&logincaptcha=%s" %
+          [CGI.escape(credentials[:logintoken]),
+           CGI.escape(credentials[:logincaptcha])]
+      end
+      return data
+    end
+
+    # Generates new client login token based on credentials.
+    def generate_token(credentials)
+      validate_credentials(credentials)
+
+      url = @server + AUTH_PATH
+      data = get_login_data(credentials)
+      headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
+
+      response = AdsCommon::Http.post_response(url, data, @config, headers)
+      results = parse_token_text(response.body)
+
+      if response.code == 200 and results.include?('Auth')
+        return results['Auth']
+      else
+        handle_login_error(credentials, response, results)
+      end
+    end
+
+    # Raises relevant error based on response and parsed results.
+    def handle_login_error(credentials, response, results)
+      # Handling for known errors.
+      if 'CaptchaRequired'.eql?(results['Error'])
+        captcha_url = @server + CAPTCHA_PATH + results['CaptchaUrl']
+        raise AdsCommon::Errors::CaptchaRequiredError.new(results['Error'],
+            results['CaptchaToken'], captcha_url, results['Url'])
+      end
+      # For other errors throwing a generic error.
+      error_message = "ClientLogin failed for user_name '%s': HTTP code %d." %
+          [credentials[:user_name], response.code]
+      error_str = results['Error'] || response.body
+      error_message += " Error: %s." % error_str if error_str
+      if results.include?('Info')
+        error_message += " Info: %s." % results['Info']
+      end
+      raise AdsCommon::Errors::AuthError.new(error_message, error_str,
+          results['Info'])
+    end
+
+    # Extracts key-value pairs from ClientLogin server response.
+    #
+    # Args:
+    # - text: server response string
+    #
+    # Returns:
+    #   Hash of key-value pairs
+    #
+    def parse_token_text(text)
+      return text.split("\n").inject({}) do |result, line|
+        key, *values = line.split('=')
+        result[key] = values.join('=')
+        result
+      end
+    end
+
+end

data/lib/ads_common/build/savon_registry_decorator.rb

@@ -0,0 +1,16 @@
+require 'ads_common/build/savon_registry'
+
+AdsCommon::Build::SavonRegistry.class_eval do
+
+  # Extracts input parameters of given method as an array.
+  def extract_input_parameters(op_node, doc)
+    input_element = REXML::XPath.first(op_node, 'descendant::wsdl:input')
+    input_name = get_element_name(input_element)
+    input_fields = find_sequence_fields(input_name, doc)
+    return {:name => input_name.snakecase, :fields => input_fields}
+  end
+
+
+
+
+end

data/lib/ads_common/parameters_validator_decorator.rb

@@ -0,0 +1,37 @@
+require 'ads_common/parameters_validator'
+
+AdsCommon::ParametersValidator.class_eval do
+
+  # Validates input parameters to:
+  # - add parameter names;
+  # - resolve xsi:type where required;
+  # - convert some native types to XML.
+  def validate_args(action_name, args)
+    in_params = @registry.get_method_signature(action_name)[:input] # Hash like {:name=>"get_accounts_info_request", :fields=>[]}
+    # TODO: compare number of parameters.
+    args_hash = args#{in_params[:name] => deep_copy(args)}
+    #validate_arguments(args_hash, in_params)
+    return args_hash
+  end
+
+  private
+
+   # Validates given arguments based on provided fields list.
+    def validate_arguments(args_hash, fields_list, type_ns = nil)
+      check_extra_fields(args_hash, array_from_named_list(fields_list))
+      add_order_key(args_hash, fields_list)
+      fields_list.each do |field|
+        key = field[:name]
+        item = args_hash[key]
+        check_required_argument_present(item, field)
+        if item
+          item_type = get_full_type_signature(field[:type])
+          item_ns = field[:ns] || type_ns
+          key = handle_namespace_override(args_hash, key, item_ns) if item_ns
+          validate_arg(item, args_hash, key, item_type)
+        end
+      end
+      return args_hash
+    end
+
+end

data/lib/ads_common/savon_headers_base_header_handler_decorator.rb

@@ -0,0 +1,23 @@
+####### Overriden for Adcenter #########
+require 'ads_common/savon_headers/base_header_handler'
+
+AdsCommon::SavonHeaders::BaseHeaderHandler.class_eval do
+
+  # Generates SOAP headers with the default request header element.
+  def generate_headers(request, soap)
+    soap.header.merge!(generate_request_header())
+  end
+  # Generates SOAP default request header with all requested headers.
+  #def generate_request_header()
+  #  credentials = @credential_handler.credentials
+  #  extra_headers = credentials[:extra_headers]
+  #  puts "extra_headers=#{extra_headers}"
+  #  return extra_headers.inject({}) do |result, (header, value)|
+  #    puts "header=#{header}"
+  #    puts "value=#{value}"
+  #    result[prepend_namespace(header)] = value
+  #    result
+  #  end
+  #end
+
+end

data/lib/ads_common/savon_service_decorator.rb

@@ -0,0 +1,109 @@
+####### Overriden for Adcenter #########
+require 'ads_common/savon_service'
+
+AdsCommon::SavonService.class_eval do
+
+  private
+
+  # Adds namespace to the given string.
+  #
+  # Args:
+  #  - str: String to prepend with a namespace
+  #
+  # Returns:
+  #  - String with a namespace
+  #
+  def prepend_namespace(str, namespace = AdsCommon::SavonHeaders::BaseHeaderHandler::DEFAULT_NAMESPACE)
+    return "%s:%s" % [namespace, str]
+  end
+
+  # Executes the SOAP request with original SOAP name.
+  def execute_soap_request(action, args, extra_namespaces)
+    ns = AdsCommon::SavonHeaders::BaseHeaderHandler::DEFAULT_NAMESPACE
+    original_input_name = get_service_registry.get_method_signature(action)[:input][:name].to_s.camelize
+    original_action_name = get_service_registry.get_method_signature(action)[:original_name].to_s.camelize
+    original_action_name = action if original_action_name.nil?
+    args = args.first if args.is_a?(Array)
+    additional_headers = args.delete(:headers) unless args.nil?
+    prepend_namespace_to_hash(args, ns)
+    prepend_namespace_to_hash(additional_headers, ns)
+    response = @client.request(ns, original_input_name) do |soap|
+      @client.http.headers["SOAPAction"] = original_action_name
+      soap.body = args
+      set_headers(soap, extra_namespaces)
+      soap.header.merge!(additional_headers) if additional_headers.is_a?(Hash)
+    end
+    return response
+  end
+  def prepend_namespace_to_hash h, namespace
+    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)
+      end
+    elsif h.is_a?(Array) # e.g: h = {:campaigns => {:campaign => [{:name => 'foo'}, {:name => 'foofoo'}]}}
+      h.map!{|e| prepend_namespace_to_hash(e, namespace)}
+    end
+    return h
+  end
+
+  # Creates and sets up Savon client.
+  def create_savon_client(endpoint, namespace)
+    Nori.advanced_typecasting = false
+    client = Savon::Client.new do |wsdl, httpi|
+      wsdl.endpoint = endpoint
+      wsdl.namespace = namespace
+      wsdl.element_form_default = :qualified
+      AdsCommon::Http.configure_httpi(@config, httpi)
+    end
+    client.config.raise_errors = false
+    client.config.logger.subject = get_logger()
+    return client
+  end
+
+  # Finds an exception object for a given response.
+  def exception_for_soap_fault(response)
+    begin
+      fault = response[:fault]
+      if fault[:detail] and fault[:detail][:api_exception_fault]
+        exception_fault = fault[:detail][:api_exception_fault]
+        exception_name = exception_fault[:application_exception_type]
+        exception_class = get_module().const_get(exception_name)
+        return exception_class.new(exception_fault)
+      # Specific to AdCenter
+      elsif fault[:detail] and fault[:detail][:api_fault]
+        operation_error = fault[:detail][:api_fault][:operation_errors][:operation_error]
+        operation_error = operation_error.first if operation_error.is_a?(Array) # if we get several errors, we only raise the first one
+        if exception_name = AdcenterApi::Errors::CODES[operation_error[:code]]
+          exception_class = AdcenterApi::Errors.const_get(exception_name)
+        else
+          raise Exception.new("code #{operation_error[:code]}")
+        end
+        return exception_class.new("#{operation_error[:message]} (#{operation_error[:details]})")
+      # Specific to AdCenter (batches)
+      elsif fault[:detail] and fault[:detail][:api_fault_detail]
+        operation_error = fault[:detail][:api_fault_detail][:batch_errors][:batch_error]
+        operation_error = operation_error.first if operation_error.is_a?(Array) # if we get several errors, we only raise the first one
+        if exception_name = AdcenterApi::Errors::CODES[operation_error[:code]]
+          exception_class = AdcenterApi::Errors.const_get(exception_name)
+        else
+          raise Exception.new("code #{operation_error[:code]}")
+        end
+        return exception_class.new("#{operation_error[:message]} (#{operation_error[:details]})")
+      elsif fault[:faultstring]
+        fault_message = fault[:faultstring]
+        return AdsCommon::Errors::ApiException.new(
+            "Unknown exception with error: %s" % fault_message)
+      else
+        raise ArgumentError.new(fault.to_s)
+      end
+    rescue Exception => e
+      operation_error ||= response[:fault][:detail][:api_fault][:operation_errors][:operation_error] rescue {}
+      return AdsCommon::Errors::ApiException.new(
+          "Failed to resolve exception (%s), details: %s, SOAP fault: %s" %
+          [e.message, "#{operation_error[:message]} (#{operation_error[:details]})", response.soap_fault])
+    end
+  end
+
+
+end