bing_ads_api_v9 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b3aed5be42fde099fa6a30ce66e69835ed547c6
+  data.tar.gz: fc5b869aff5c3da8d8d319433cd56c0cff41b9a8
+SHA512:
+  metadata.gz: c2a05c573391798cd031e405a4f9762db6cc8f823b29a9b79978b7aa70da15566f8d917797755685a88abbd52f47feda71e118a8edd94cea330051ce83fd6b9d
+  data.tar.gz: 18e4da0cfe5b37162539deddb1784d5e35ba49573ed8541649fb18b8e6704320dc3e24175f32d791dc810a6eed63eb524555ada0315107a86cb01070390fcd27

data/README.md

@@ -0,0 +1,74 @@
+Bing Ads Api Client
+=============
+
+Description
+-------------
+A simple ruby wrapper for the Bing Ads API based on the gem "google-ads-common".
+
+Usage
+-------------
+
+    # install in your gem file
+    gem 'bing_ads_api', :git => 'https://github.com/arambert/bing_ads_api.git'
+
+    # initialize the client
+    client = BingAdsApi::Api.new(
+            {
+              :authentication => {
+                :method => 'ClientLogin',
+                :developer_token => 'DEVELOPER_TOKEN',
+                :user_name => 'USERNAME',
+                :password => 'PASSWORD',
+                :customer_id => 'customer_id', # may be optional for some requests
+                :customer_account_id => 'customer_account_id' # may be optional for some requests
+              },
+              :service => {:environment => 'PRODUCTION'},
+              :library => {:log_level => 'DEBUG'}
+            })
+            
+    oauth2_client = BingAdsApi::Api.new(
+            {
+              :authentication => {
+                :method => 'OAUTH2',
+                :developer_token => Developer Token,
+                :oauth2_client_id: Client Id From Bing,
+                :oauth2_client_secret: Secret Client From Bing,
+                :oauth2_callback: http://myservice.com/adcenter_oauth2, #public callback
+                :oauth2_token => {
+                    :access_token => Access Token,
+                    :refresh_token => Refresh Token
+                }
+              },
+              :service => {:environment => 'PRODUCTION'},
+              :library => {:log_level => 'DEBUG'}
+            })     
+
+    # select the service and the API version (:v8 or :v9)
+    administration_service = client.service(:AdministrationService, :v9)
+
+    # send your request
+    result = administration_service.get_assigned_quota()
+
+    # select another service
+    campaign_service = client.service(:CampaignManagementService, :v9)
+
+    # send another request
+    result = campaign_service.get_campaigns_by_account_id({:account_id => 00000})
+
+    # create a campaign
+    result2 = campaign_service.add_campaigns({:account_id => 00000,
+                                            :campaigns => {:campaign => [{:budget_type => "DailyBudgetWithMaximumMonthlySpend",
+                                                                          :conversion_tracking_enabled => false,
+                                                                          :daily_budget => 5,
+                                                                          :daylight_saving => false,
+                                                                          :description => "A perfect new campaign",
+                                                                          :monthly_budget => 50,
+                                                                          :name => "perfectcampaign",
+                                                                          :time_zone => "BrusselsCopenhagenMadridParis"}]
+                                                          }
+                                            })
+
+About the gem
+-------------
+The tests still have to be written.
+Any help is welcome !

data/lib/ads_common_for_bing_ads.rb

@@ -0,0 +1,47 @@
+require 'ads_common/api'
+require 'ads_common/api_config'
+require 'ads_common/credential_handler'
+require 'ads_common/errors'
+require 'ads_common/http'
+require 'ads_common/savon_service'
+require 'ads_common/parameters_validator'
+require 'ads_common/build/savon_generator'
+require 'ads_common/build/savon_registry'
+require 'ads_common/savon_headers/base_header_handler'
+require 'ads_common/savon_headers/oauth_header_handler'
+
+####### AdsCommon Overriden for Bing Ads #########
+module AdsCommonForBingAds
+	class Api < AdsCommon::Api; end
+	module ApiConfig; include AdsCommon::ApiConfig; end
+	class Config < AdsCommon::Config; end
+	class CredentialHandler < AdsCommon::CredentialHandler; end
+	module Errors; include AdsCommon::Errors; end
+	class Http < AdsCommon::Http; end
+	class ParametersValidator < AdsCommon::ParametersValidator; end
+	class ResultsExtractor < AdsCommon::ResultsExtractor; end
+	class SavonService < AdsCommon::SavonService; end
+	module Utils; include AdsCommon::Utils; end
+	module ApiConfig; include AdsCommon::ApiConfig; end
+	# Auth
+	module Auth
+		class BaseHandler < AdsCommon::Auth::BaseHandler; end
+		class ClientLoginHandler < AdsCommon::Auth::ClientLoginHandler; end
+		class OAuth2Handler < AdsCommon::Auth::OAuth2Handler; end
+	end
+	# Build
+	module Build
+		class SavonAbstractGenerator < AdsCommon::Build::SavonAbstractGenerator; end
+		class SavonGenerator < AdsCommon::Build::SavonGenerator; end
+		class SavonRegistry < AdsCommon::Build::SavonRegistry; end
+		class SavonRegistryGenerator < AdsCommon::Build::SavonRegistryGenerator; end
+		class SavonServiceGenerator < AdsCommon::Build::SavonServiceGenerator; end
+	end
+	# SavonHeaders
+	module SavonHeaders
+		class BaseHeaderHandler < AdsCommon::SavonHeaders::BaseHeaderHandler; end
+		class OAuthHeaderHandler < AdsCommon::SavonHeaders::OAuthHeaderHandler; end
+		# httpi_request_proxy is ::OAuth::RequestProxy::HTTPIRequest < OAuth::RequestProxy::Base
+	end
+
+end

data/lib/ads_common_for_bing_ads/api_config.rb

@@ -0,0 +1,41 @@
+####### Overriden for Bing Ads #########
+AdsCommonForBingAds::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_for_bing_ads/auth/client_login_handler.rb

@@ -0,0 +1,161 @@
+####### Overriden for Bing Ads #########
+module AdsCommonForBingAds
+  module Auth
+
+    class ClientLoginHandler
+
+
+      # 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:
+      # - AdsCommonForBingAds::Errors::AuthError if validation fails
+      #
+      def validate_credentials(credentials)
+        if credentials.nil?
+          raise AdsCommonForBingAds::Errors::AuthError, 'No credentials supplied.'
+        end
+
+        if credentials[:auth_token].nil?
+          if credentials[:user_name].nil?
+            raise AdsCommonForBingAds::Errors::AuthError,
+                  'UserName address not included in credentials.'
+          end
+          if credentials[:password].nil?
+            raise AdsCommonForBingAds::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:
+      # - AdsCommonForBingAds::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 = AdsCommonForBingAds::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 AdsCommonForBingAds::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 AdsCommonForBingAds::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
+  end
+end

data/lib/ads_common_for_bing_ads/auth/oauth2_handler.rb

@@ -0,0 +1,33 @@
+####### Overriden for Bing Ads #########
+module AdsCommonForBingAds
+  module Auth
+
+    class OAuth2Handler
+
+      OAUTH2_CONFIG_BING = {
+          :authorization_uri =>
+              'https://login.live.com/oauth20_authorize.srf',
+          :token_credential_uri =>
+              'https://login.live.com/oauth20_token.srf'
+      }
+
+      def auth_string(credentials)
+        token = get_token(credentials)
+        token[:access_token]
+      end
+
+      private
+
+      def create_client(credentials)
+        oauth_options_bing = OAUTH2_CONFIG_BING.merge({
+                                                          :client_id => credentials[:oauth2_client_id],
+                                                          :client_secret => credentials[:oauth2_client_secret],
+                                                          :scope => @scope,
+                                                          :redirect_uri => credentials[:oauth2_callback] || DEFAULT_CALLBACK,
+                                                          :state => credentials[:oauth2_state]
+                                                      }).reject {|k, v| v.nil?}
+        return Signet::OAuth2::Client.new(oauth_options_bing)
+      end
+    end
+  end
+end

data/lib/ads_common_for_bing_ads/build/savon_generator.rb

@@ -0,0 +1,23 @@
+module AdsCommonForBingAds
+  module Build
+
+    class SavonGenerator
+
+      private
+
+      # Generates registry file.
+      def write_registry(wsdl, file_name)
+        registry_file = create_new_file(file_name)
+        generator = SavonRegistryGenerator.new(@generator_args)
+        registry = SavonRegistry.new(wsdl, @generator_args)
+        generator.add_exceptions(registry.soap_exceptions)
+        generator.add_methods(registry.soap_methods)
+        generator.add_namespaces(registry.soap_namespaces)
+        generator.add_types(registry.soap_types)
+        registry_file.write(generator.generate_code())
+        registry_file.close
+      end
+
+    end
+  end
+end

data/lib/ads_common_for_bing_ads/build/savon_registry.rb

@@ -0,0 +1,17 @@
+module AdsCommonForBingAds
+  module Build
+
+    class SavonRegistry
+
+      # 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
+
+  end
+end

data/lib/ads_common_for_bing_ads/parameters_validator.rb

@@ -0,0 +1,36 @@
+module AdsCommonForBingAds
+
+  class ParametersValidator
+    # 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
+end