bing-ads-api 0.1.0

data/lib/bing-ads-api/service/reporting.rb

@@ -0,0 +1,101 @@
+# -*- encoding : utf-8 -*-
+module BingAdsApi
+
+	# Public : This class represents the Reporting Services 
+	# defined in the Bing Ads API, to request and download reports
+	# 
+	# Author:: jlopezn@neonline.cl 
+	# 
+	# Examples 
+	#  options = {
+	#    :environment => :sandbox,
+	#    :username => "username",
+	#    :password => "pass",
+	#    :developer_token => "SOME_TOKEN",
+	#    :customer_id => "1234567",
+	#    :account_id => "9876543" }
+	#  service = BingAdsApi::Reporting.new(options)
+	class Reporting < BingAdsApi::Service
+		
+		
+		# Public : Get the status of a report request 
+		# 
+		# Author:: jlopezn@neonline.cl 
+		# 
+		# === Parameters
+		# +report_request_id+ - Identifier of the report request
+		# 
+		# === Examples 
+		#   service.poll_generate_report("12345") 
+		#   # => Hash 
+		# 
+		# Returns:: Hash with the PollGenerateReportResponse structure
+		#
+		# Raises:: exception
+		def poll_generate_report(report_request_id)
+			response = call(:poll_generate_report, 
+				{report_request_id: report_request_id} )
+			response_hash = get_response_hash(response, __method__)
+			report_request_status = BingAdsApi::ReportRequestStatus.new(
+				response_hash[:report_request_status])
+			return report_request_status
+		end
+		
+		# Public : Submits a report request 
+		# 
+		# Author:: jlopezn@neonline.cl 
+		# 
+		# === Parameters
+		# +report_request+ - a BingAdsApi::ReportRequest subclass instance
+		# 
+		# === Examples 
+		# ==== CampaignPerformanceReportRequest
+		#   report_request = BingAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+		#   	:language => :english, 
+		#   	:report_name => "My Report",
+		#   	:aggregation => :hourly, 
+		#   	:columns => [:account_name, :account_number, :time_period, 
+		#   		:campaign_name, :campaign_id, :status, :currency_code, 
+		#   		:impressions, :clicks, :ctr, :average_cpc, :spend, 
+		#   		:conversions, :conversion_rate, :cost_per_conversion, :average_cpm ],
+		#   	:filter => {
+		#   		# String as bing expected
+		#   		:ad_distribution => "Search",
+		#   		:device_os => "Windows",
+		#   		# snake case symbol
+		#   		:device_type => :computer,
+		#   		# nil criteria
+		#   		:status => nil
+		#   	},
+		#   	:scope => {:account_ids => 5978083, 
+		#   		:campaigns => [
+		#   			{:account_id => 5978083, :campaign_id => 1951230156},
+		#   			{:account_id => 5978083, :campaign_id => 1951245412},
+		#   			{:account_id => 5978083, :campaign_id => 1951245474}]
+		#   	},
+		#   	:time => {
+		#   		:custom_date_range_end => {:day => 31, :month => 12, :year => 2013},
+		#   		:custom_date_range_start => {:day => 1, :month => 12, :year => 2013},
+		#   	})
+		#   report_request_id = reporting_service.submit_generate_report(report_request)
+		#   # => "1234567890"
+		# 
+		# Returns:: String with the requested report id
+		#
+		# Raises:: Exception if report_request is invalid or SOAP request failed
+		def submit_generate_report(report_request)
+			response = call(:submit_generate_report, 
+				{report_request: report_request.to_hash(:camelcase)})
+			response_hash = get_response_hash(response, __method__)
+			report_request_id = response_hash[:report_request_id]
+			return report_request_id
+		end
+
+
+		private
+			def get_service_name
+				"reporting"
+			end
+
+	end
+end

data/lib/bing-ads-api/soap_hasheable.rb

@@ -0,0 +1,143 @@
+# -*- encoding : utf-8 -*-
+
+module BingAdsApi
+	
+	##
+	# Public:: Module to define an object as Hasheable for the SOAP requests
+	# 
+	# Author::  jlopezn@neonline.cl 
+	module SOAPHasheable
+		
+		
+		# Internal: Metodo custom para transformar a hash un objeto.
+		# Se puede indicar si se desean las keys en formato CamelCase o underscore_case
+		#
+		# Author::  asaavedrab@neonline.cl
+		#
+		# === Parameters
+		# * keys_case - indica si las keys del hash deben estar en formato 
+		# ** :camelcase  - CamelCase
+		# ** :underscore - underscore_case
+		# 
+		# === Example
+		#   a=BusinessPartner.new
+		#   a.to_hash
+		#   # => {id => 1, name => "emol"}
+		#
+		# Returns:: Hash
+		def to_hash(keys_case=:underscore)
+			object_to_hash(self, keys_case)
+		end
+		
+		
+		# Internal: Internal method to return an object as a SOAP Request alike hash
+		# If the object is an array, this methods executes object_to_hash for each item.
+		# If the object is a Hash, this methods normalize the keys according to +keys_case+ and executes object_to_hash for each value
+		# If the object is a String or Numeric, returns the object  
+		#
+		# Author::  asaavedrab@neonline.cl, jlopezn@neonline.cl
+		#
+		# === Parameters
+		# * +object+    - object instance to be hashed
+		# * +keys_case+ - specifies the hash keys case, default 'underscore'
+		# ==== keys_case
+		# * :camelcase  - CamelCase
+		# * :underscore - underscore_case
+		# 
+		# === Example:
+		#   a=Person.new
+		#   a.to_hash(:underscore)
+		#   # => {'id' => 1, 'full_name' => "John Doe"}
+		#
+		#   a=Person.new
+		#   a.to_hash(:camelcase)
+		#   # => {'Id' => 1, 'FullName' => "John Doe"}
+		#
+		#   a=[<Person>, <Person>, <Cat>]
+		#   a.to_hash(:underscore)
+		#   # => [{'id' => 1, 'full_name' => "John Doe"}, {'id' => 2, 'full_name' => "Ms Mary"}, {'id' => 3, 'name' => "Mr Whiskers", 'color' => "Gray"}]
+		#
+		# Returns:: Hash
+		def object_to_hash(object, keys_case=:underscore)
+
+			# Nil safe
+			return nil if object.nil?
+			
+			# In case of hash, we only normalize the keys values
+			return normalize_hash_keys(object, keys_case) if object.is_a?(Hash)
+			# In case of array, we make hasheable each element
+			return object.collect{ |item| object_to_hash(item, keys_case) } if object.is_a?(Array)
+			# In case of number or string, this methods return the object
+			return object if object.is_a?(String) || object.is_a?(Numeric)
+
+			hash={}
+			object.instance_variables.each do |var| 
+				if !object.instance_variable_get(var).nil?
+					value = object.instance_variable_get(var)
+					hashed_value = case value.class.to_s
+						when "Hash" then normalize_hash_keys(value, keys_case)
+						when "Array" then value.collect{ |item| object_to_hash(item, keys_case) }
+						else value
+					end
+					hash[get_attribute_key(var, keys_case)] = hashed_value 
+				end 
+			end
+			return hash
+		end
+		
+		
+		def normalize_hash_keys(hash, keys_case)
+			return hash.inject({}) { |h, (k, v)| h[get_attribute_key(k, keys_case)] = object_to_hash(v, keys_case); h }
+		end
+		
+		# Internal : Helper method to determinate the key name in the hash for the SOAP request 
+		# 
+		# Author:: jlopezn@neonline.cl 
+		# 
+		# === Parameters
+		# * attribute - the attribute name
+		# * keys_case - defines the case for the attribute name. 
+		# ==== keys_case
+		# * :camelcase  - CamelCase
+		# * :underscore - underscore_case
+		# 
+		# === Examples 
+		#   get_attribute_key("attribute_name", :underscore) 
+		#   # => "attribute_name" 
+		# 
+		#   get_attribute_key("name", :camelcase) 
+		#   # => "AttributeName" 
+		# 
+		# Returns:: String with the attribute name for the key in the hash
+		def get_attribute_key(attribute, keys_case = :underscore)
+			if keys_case == :underscore
+				return attribute.to_s.delete("@").underscore
+			elsif keys_case == :camelcase
+				return attribute.to_s.delete("@").camelcase
+			end
+		end
+		
+		
+		# Internal : Returns a DateTime as a hash for SOAP requests 
+		# 
+		# Author:: jlopezn@neonline.cl 
+		# 
+		# === Parameters
+		# * date - DateTime to be hashed
+		# * keys_case - defines the case for keys in the hash
+		# ==== keys_case
+		# * :camelcase  - CamelCase
+		# * :underscore - underscore_case
+		# 
+		# Returns:: Hash with the :year, :month, :day keys
+		def date_to_hash(date, keys_case)
+			{
+				get_attribute_key("day", keys_case)   => date.day,
+				get_attribute_key("month", keys_case) => date.month,
+				get_attribute_key("year", keys_case)  => date.year
+			}
+		end
+		
+	end
+	
+end

data/lib/bing-ads-api/version.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+module BingAdsApi
+	
+	# Gem Version
+	VERSION = "0.1.0"
+end

data/lib/locales/es.yml

@@ -0,0 +1,174 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+es-CL:
+
+bing:
+
+  constants:
+    
+    common:
+      time_zones:
+        abu_dhabi_muscat: 'Abu Dhabi y Muscat'
+        adelaide: 'Adelaide, Australia'
+        alaska: 'Alaska'
+        almaty_novosibirsk: 'Almaty y Novosibirsk'
+        amsterdam_berlin_bern_rome_stockholm_vienna: 'Amsterdam, Berlin, Bern, Rome, Stockholm, y Vienna'
+        arizona: 'Arizona'
+        astana_dhaka: 'Astana y Dhaka'
+        athens_buckarest_istanbul: 'Athens, Istanbul, Beirut, y Minsk'
+        atlantic_time_canada: 'Atlantic Time y Canada'
+        auckland_wellington: 'Auckland y Wellington, New Zealand'
+        azores: 'Azores'
+        baghdad: 'Baghdad'
+        baku_tbilisi_yerevan: 'Baku, Tbilisi, y Yerevan'
+        bangkok_hanoi_jakarta: 'Bangkok, Hanoi, y Jakarta'
+        beijing_chongqing_hong_kong_urumqi: 'Beijing, Chongqing, Hong Kong, y Urumqi'
+        belgrade_bratislava_budapest_ljubljana_prague: 'Belgrade, Bratislava, Budapest, Ljubljana, y Prague'
+        bogota_lima_quito: 'Bogota, Lima, y Quito'
+        brasilia: 'Brasilia'
+        brisbane: 'Brisbane'
+        brussels_copenhagen_madrid_paris: 'Brussels, Copenhagen, Madrid, y Paris'
+        bucharest: 'Bucharest'
+        buenos_aires_georgetown: 'Buenos Aires y Georgetown'
+        cairo: 'Cairo'
+        canberra_melbourne_sydney: 'Canberra, Melbourne, y Sydney'
+        cape_verde_island: 'Cape Verde Island'
+        caracas_la_paz: 'Caracas y La Paz (Bolivia)'
+        casablanca_monrovia: 'Casablanca y Monrovia'
+        central_america: 'Central America'
+        central_time_u_s_canada: 'Central Time U.S. y Canada'
+        chennai_kolkata_mumbai_new_delhi: 'Chennai, Kolkata, Mumbai, y New Delhi'
+        chihuahua_la_paz_mazatlan: 'Chihuahua, La Paz (Mexico), y Mazatlan'
+        darwin: 'Darwin'
+        eastern_time_u_s_canada: 'Eastern Time U.S. y Canada'
+        ekaterinburg: 'Ekaterinburg'
+        fiji_kamchatka_marshall_island: 'Fiji, Kamchatka, y Marshall Island'
+        greenland: 'Greenland'
+        greenwich_mean_time_dublin_edinburgh_lisbon_london: 'Greenwich Mean Time, Dublin, Edinburgh, Lisbon, y London'
+        guadalajara_mexico_city_monterrey: 'Guadalajara, Mexico City, y Monterrey'
+        guam_port_moresby: 'Guam y Port Moresby'
+        harare_pretoria: 'Harare y Pretoria'
+        hawaii: 'Hawaii'
+        helsinki_kyiv_riga_sofia_tallinn_vilnius: 'Helsinki, Kyiv, Riga, Sofia, Tallinn, y Vilnius'
+        hobart: 'Hobart'
+        indiana_east: 'Indiana (East)'
+        international_date_line_west: 'International Date Line (West)'
+        irkutsk_ulaan_bataar: 'Irkutsk y Ulaanbaatar'
+        islandamabad_karachi_tashkent: 'Islamabad, Karachi, y Tashkent'
+        jerusalem: 'Jerusalem'
+        kabul: 'Kabul'
+        kathmandu: 'Kathmandu'
+        krasnoyarsk: 'Krasnoyarsk'
+        kuala_lumpur_singapore: 'Kuala Lumpur y Singapore'
+        kuwait_riyadh: 'Kuwait y Riyadh'
+        magadan_solomon_island_new_caledonia: 'Magadan, Solomon Islands, y New Caledonia'
+        mid_atlantic: 'Mid-Atlantic'
+        midway_islandand_samoa: 'Midway Island y Samoa'
+        moscow_st_petersburg_volgograd: 'Moscow, St Petersburg, y Volgograd'
+        mountain_time_u_s_canada: 'Mountain Time U.S. y Canada'
+        nairobi: 'Nairobi'
+        newfoundland: 'Newfoundland'
+        nukualofa: 'Nuku'alofa'
+        osaka_sapporo_tokyo: 'Osaka, Sapporo, y Tokyo'
+        pacific_time_u_s_canada_tijuana: 'Pacific Time, U.S. y Canada, y Tijuana'
+        perth: 'Perth'
+        rangoon: 'Rangoon'
+        santiago: 'Santiago'
+        sarajevo_skopje_warsaw_zagreb: 'Sarajevo, Skopie, Warsaw, y Zagreb'
+        saskatchewan: 'Saskatchewan'
+        seoul: 'Seoul'
+        sri_jayawardenepura: 'Sri Jayawardenepura'
+        taipei: 'Taipei'
+        tehran: 'Tehran'
+        vladivostok: 'Vladivostok'
+        west_central_africa: 'West Central Africa'
+        yakutsk: 'Yakutsk'
+      ad_languages:
+        danish: 'Danish'
+        dutch: 'Dutch'
+        english: 'English'
+        finnish: 'Finnish'
+        french: 'French'
+        german: 'German'
+        italian: 'Italian'
+        norwegian: 'Norwegian'
+        portuguese: 'Portuguese'
+        spanish: 'Spanish'
+        swedish: 'Swedish'
+        traditional_chinese: 'Traditional Chinese'
+        codes:
+          danish: 'DA'
+          dutch: 'NL'
+          english: 'EN'
+          finnish: 'FI'
+          french: 'FR'
+          german: 'DE'
+          italian: 'IT'
+          norwegian: 'NO'
+          portuguese: 'PT'
+          spanish: 'ES'
+          swedish: 'SV'
+          traditional_chinese: 'ZH'
+        market_country:
+          danish: 'Denmark'
+          dutch: 'Netherlands'
+          english: 'Australia Canada India Indonesia Ireland Malaysia New Zealand Philippines Singapore Thailand United Kingdom United States Vietnam'
+          finnish: 'Finland '
+          french: 'Belgium Canada France'
+          german: 'Austria Germany Switzerland'
+          italian: 'Italy'
+          norwegian: 'Norway'
+          portuguese: 'Brazil'
+          spanish: 'Argentina Chile Colombia Mexico Peru Spain Venezuela'
+          swedish: 'Sweden'
+          traditional_chinese: 'Hong Kong Taiwan'
+    
+    campaign_management:
+      budget_limit_type:
+        monthly_budget_spend_until_depleted: 'MonthlyBudgetSpendUntilDepleted'
+        daily_budget_accelerated: 'DailyBudgetAccelerated'
+        daily_budget_standard: 'DailyBudgetStandard'
+      campaign_status:
+        active: 'Activa'
+        paused: 'Pausada'
+        budget_paused: 'Pausada por presupuesto'
+        budget_and_manual_paused: 'Pausada por presupuesto y manual'
+        deleted: 'Deleted'
+      ad_distribution:
+        search: 'Búsqueda'
+        content: 'Contenido'
+      ad_rotation_type:
+        optimize_for_clicks: 'Optimizado por clicks'
+        rotate_ads_evenly: 'Rotar anuncios parejo'
+      bidding_model:
+        keyword: 'Keywords'
+        site_placement: 'Posición en sitio'
+      pricing_model:
+        cpc: 'Cpc'
+        cpm: 'Cpm'
+      ad_group_status:
+        draft: 'Borrador'
+        active: 'Activo'
+        paused: 'Pausado'
+        deleted: 'Eliminado'
+      ad_status:
+        inactive: 'Inactivo'
+        Active: 'Activo'
+        paused: 'Pausado'
+        deleted: 'Eliminado'
+      ad_type:
+        text: 'Texto'
+        image: 'Imágen'
+        mobile: 'Mobil'
+        rich_search: 'Búsqueda enriquecida'
+        product: 'Producto'
+      keyword_editorial_status:
+        active: 'Activo'
+        disapproved: 'Desaprovado'
+        inactive: 'Inactivo'
+      keyword_status:
+        active: 'Activo'
+        paused: 'Pausado'
+        deleted: 'Borrado'
+        inactive: 'Inactivo'

data/lib/tasks/bing-ads-api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bing-ads-api do
+#   # Task goes here
+# end

data/test/bing-ads-api_test.rb

@@ -0,0 +1,134 @@
+# -*- encoding : utf-8 -*-
+require 'test_helper'
+
+# Public : Test Case for general purpose methods, helper and modules 
+# 
+# Author:: jlopezn@neonline.cl 
+class BingAdsApiTest < ActiveSupport::TestCase
+
+	test "truth" do
+		assert_kind_of Module, BingAdsApi
+	end
+	
+	test "load config" do
+		config = BingAdsApi::Config.instance
+		assert !config.nil?, "Config class not instantiated"
+		assert !config.config.nil?, "Config file not loaded"
+	end
+
+	test "config constants" do
+		config = BingAdsApi::Config.instance
+		
+		assert !config.common_constants.nil?, "No common constants"
+		assert !config.campaign_management_constants.nil?, "No campaign management constants"
+		assert !config.reporting_constants.nil?, "No reporting constants"
+	end
+
+	test "config common constants" do
+		config = BingAdsApi::Config.instance
+		assert !config.common_constants['time_zones'].nil?, "No time_zones common constants"
+		assert !config.common_constants['time_zones']['santiago'].nil?, "No time_zones santiago "
+	end
+
+	test "get sandbox wsdl" do
+		config = BingAdsApi::Config.instance
+		
+		assert !config.service_wsdl(:sandbox, :campaign_management).nil?, 
+			"No wsdl for sandbox and campaign_management"
+		assert !config.service_wsdl(:sandbox, :reporting).nil?, 
+			"No wsdl for sandbox and reporting"
+	end
+
+
+	test "get production wsdl" do
+		config = BingAdsApi::Config.instance
+		
+		assert !config.service_wsdl(:production, :campaign_management).nil?, 
+			"No wsdl for production and campaign_management"
+		assert !config.service_wsdl(:production, :reporting).nil?, 
+			"No wsdl for production and reporting"
+		
+	end
+
+
+	test "create client proxy" do
+		options = {
+			:username => "desarrollo_neonline",
+			:password => "neonline2013",
+			:developer_token => "BBD37VB98",
+			:customer_id => "21021746",
+			:account_id => "5978083",
+			:wsdl_url => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/CampaignManagementService.svc?singleWsdl"
+		}
+		client = BingAdsApi::ClientProxy.new(options)
+		#puts client.inspect
+		assert !client.nil?, "Client proxy not created"
+
+		#puts client.service
+		assert !client.service.nil?, "Service client not created"
+	end
+
+
+	test "create client proxy with additional settings" do
+		options = {
+			:username => "desarrollo_neonline",
+			:password => "neonline2013",
+			:developer_token => "BBD37VB98",
+			:customer_id => "21021746",
+			:account_id => "5978083",
+			:wsdl_url => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/CampaignManagementService.svc?singleWsdl",
+			:proxy => {
+				:logger => Rails.logger, 
+				:encoding => "UTF-8"
+			}
+		}
+		client = BingAdsApi::ClientProxy.new(options)
+		#puts client.inspect
+		assert !client.nil?, "Client proxy not created"
+
+		#puts client.service
+		assert !client.service.nil?, "Service client not created"
+	end
+
+
+	test "call service" do
+		options = {
+			:username => "desarrollo_neonline",
+			:password => "neonline2013",
+			:developer_token => "BBD37VB98",
+			:customer_id => "21021746",
+			:account_id => "5978083",
+			:wsdl_url => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/CampaignManagementService.svc?singleWsdl"
+		}
+		
+		client = BingAdsApi::ClientProxy.new(options)
+		assert !client.nil?, "Client proxy not created"
+		
+		response = client.service.call(:get_campaigns_by_account_id, 
+			message: { Account_id: client.account_id})
+		#puts response.inspect
+		assert response, "No responde received"
+	end
+
+	test "create and call from config" do
+		config = BingAdsApi::Config.instance
+		options = {
+			:username => "desarrollo_neonline",
+			:password => "neonline2013",
+			:developer_token => "BBD37VB98",
+			:customer_id => "21021746",
+			:account_id => "5978083",
+			:wsdl_url => config.service_wsdl(:sandbox, :campaign_management)
+		}
+		
+		client = BingAdsApi::ClientProxy.new(options)
+		assert !client.nil?, "Client proxy not created"
+		
+		response = client.service.call(:get_campaigns_by_account_id, 
+			message: { Account_id: client.account_id})
+		#puts response.inspect
+		assert response, "No responde received"
+		
+	end
+
+end