gnib-ads-api 0.3

data/test/report_request_test.rb

@@ -0,0 +1,312 @@
+# -*- encoding : utf-8 -*-
+require 'test_helper'
+
+# Public : Test case for ReportRequest an its subclasses 
+# 
+# Author:: jlopezn@neonline.cl 
+class ReportRequestTest < ActiveSupport::TestCase
+
+	def setup
+		
+		@config = GnibAdsApi::Config.instance
+		@options = {
+			:environment => :sandbox,
+			:username => "desarrollo_neonline",
+			:password => "neonline2013",
+			:developer_token => "BBD37VB98",
+			:customer_id => "21021746",
+			:account_id => "5978083"
+		}
+		@service = GnibAdsApi::Reporting.new(@options)
+
+	end
+
+	test "truth" do
+		assert_kind_of Module, GnibAdsApi
+	end
+	
+	test "initialize report request" do
+		assert_nothing_raised(Exception, "Report request not instantiated") {
+			report_request = GnibAdsApi::ReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:return_only_complete_data => true)
+			puts "report request"
+			puts report_request.to_hash(:camelcase)
+		}
+
+	end
+
+
+	test "should raise exception" do
+		assert_raises(Exception, "Bad format not raised") {
+			report_request = GnibAdsApi::ReportRequest.new(:format => :invalid,
+				:language => :english, :report_name => "My Report",
+				:return_only_complete_data => true)
+		}
+
+		assert_raises(Exception, "Bad language not raised") {
+			report_request = GnibAdsApi::ReportRequest.new(:format => :xml,
+				:language => :swahili, :report_name => "My Report",
+				:return_only_complete_data => true)
+		}
+
+	end
+	
+	
+	test "initialize performance report request" do
+		assert_nothing_raised(Exception, "Performance Report request not instantiated") {
+			performance_report_request = GnibAdsApi::PerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today)
+			puts "performance report request"
+			puts performance_report_request.to_hash(:camelcase)
+		}
+	end
+
+
+	test "should raise aggregation exception" do
+		assert_raises(Exception, "Bad aggregation not raised") {
+			performance_report_request = GnibAdsApi::PerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :invalid_aggregation)
+		}
+
+	end
+
+
+	test "should raise time exception" do
+		assert_raises(Exception, "Bad aggregation not raised") {
+			performance_report_request = GnibAdsApi::PerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :weekly)
+		}
+
+	end
+
+
+	test "initialize campaign performance report request" do
+		assert_nothing_raised(Exception, "CampaignPerformanceReportRequest not instantiated") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:filter => {
+					# String as bing expected
+					:ad_distribution => "Search",
+					:device_os => "Windows",
+					# snake case symbol
+					:device_type => :computer,
+					# nil criteria
+					:status => nil
+				},
+				:scope => {:account_ids => 12345, 
+				:campaigns => [
+					{:account_id => 1234, :campaign_id => 1234},
+					{:account_id => 1234, :campaign_id => 1234},
+					{:account_id => 1234, :campaign_id => 1234}]
+				})
+			puts "campaign performance report request 1"
+			puts performance_report_request.to_hash(:camelcase)
+
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, 
+				:time => {
+					:custom_date_range_start => {
+						:day => 1,
+						:month => 12,
+						:year => 2013
+					}, 
+					:custom_date_range_end => {
+						:day => 31,
+						:month => 12,
+						:year => 2013
+					}
+				}, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:filter => {
+					# String as bing expected
+					:ad_distribution => "Search",
+					:device_os => "Windows",
+					# snake case symbol
+					:device_type => :computer,
+					# nil criteria
+					:status => nil
+				},
+				:scope => {:account_ids => 12345, 
+				:campaigns => []})
+			puts "campaign performance report request 2"
+			puts performance_report_request.to_hash(:camelcase)
+
+
+		}
+	end
+
+
+	test "initialize account performance report request" do
+		assert_nothing_raised(Exception, "AccountPerformanceReportRequest not instantiated") {
+			performance_report_request = GnibAdsApi::AccountPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:filter => {
+					# String as bing expected
+					:ad_distribution => "Search",
+					# snake case symbol
+					:device_os => :windows,
+					# no specified value
+					:device_type => nil
+				},
+				:scope => {:account_ids => 12345}, 
+				:time => :today )
+			puts "account performance report request 1"
+			puts performance_report_request.to_hash(:camelcase)
+
+			performance_report_request = GnibAdsApi::AccountPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:filter => {
+					# String as bing expected
+					:ad_distribution => "Search",
+					# snake case symbol
+					:device_os => :windows,
+					# no specified value
+					:device_type => nil
+				},
+				:scope => {:account_ids => 12345},
+				:time => {
+					:custom_date_range_start => {
+						:day => 1,
+						:month => 12,
+						:year => 2013
+					}, 
+					:custom_date_range_end => {
+						:day => 31,
+						:month => 12,
+						:year => 2013
+					}
+				})
+			puts "account performance report request 2"
+			puts performance_report_request.to_hash(:camelcase)
+
+		}
+	end
+
+
+	test "should raise column exception " do
+		assert_raises(Exception, "Bad column name for CampaignPerformanceReportRequest not raised") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period, :unknown_column ],
+				:scope => {:account_ids => 12345, 
+				:campaigns => []})
+		}
+
+
+		assert_raises(Exception, "Bad column value for CampaignPerformanceReportRequest not raised") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period, "UnknownColumn" ],
+				:scope => {:account_ids => 12345, 
+				:campaigns => []})
+		}
+	end
+
+
+	test "should raise scope exception " do
+		assert_raises(Exception, "Bad scope for account_ids not raised") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:scope => { :campaigns => []})
+		}
+
+		assert_raises(Exception, "Bad scope for campaigns not raised") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:scope => {:account_ids => 12345 })
+		}
+
+	end
+
+
+	test "campaign performance filter " do
+		assert_nothing_raised(Exception, "Bad filter for CampaignPerformanceReportRequest") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:filter => {
+					# String as bing expected
+					:ad_distribution => "Search",
+					:device_os => "Windows",
+					# snake case symbol
+					:device_type => :computer,
+					# nil criteria
+					:status => nil
+				},
+				:scope => {:account_ids => 12345, 
+				:campaigns => []})
+		}
+	end
+
+
+	test "should raise campaign performance filter exception " do
+		assert_raises(Exception, "Bad filter string for CampaignPerformanceReportRequest not raised") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:filter => {
+					# Wrong String as bing expected
+					:ad_distribution => "Searched",
+					:device_os => "Windows",
+					# snake case symbol
+					:device_type => :computer,
+					# nil criteria
+					:status => nil
+				},
+				:scope => {:account_ids => 12345, 
+				:campaigns => []})
+		}
+
+		assert_raises(Exception, "Bad filter symbol for CampaignPerformanceReportRequest not raised") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:filter => {
+					# Wrong String as bing expected
+					:ad_distribution => "Search",
+					:device_os => "Windows",
+					# Wrong snake case symbol
+					:device_type => :notebook,
+					# nil criteria
+					:status => nil
+				},
+				:scope => {:account_ids => 12345, 
+				:campaigns => []})
+		}
+
+		assert_raises(Exception, "Bad filter criteria for CampaignPerformanceReportRequest not raised") {
+			performance_report_request = GnibAdsApi::CampaignPerformanceReportRequest.new(:format => :xml,
+				:language => :english, :report_name => "My Report",
+				:aggregation => :hourly, :time => :today, 
+				:columns => [:account_name, :account_number, :time_period ],
+				:filter => {
+					# Wrong filter criteria. ie: invalid key
+					:not_a_valid_criteria => "Bleh",
+				},
+				:scope => {:account_ids => 12345, 
+				:campaigns => []})
+		}
+
+	end
+
+end

data/test/reporting_test.rb

@@ -0,0 +1,145 @@
+# -*- encoding : utf-8 -*-
+require 'test_helper'
+
+# Public : Test case for Reporting services 
+# 
+# Author:: jlopezn@neonline.cl 
+class ReportingTest < ActiveSupport::TestCase
+
+	def setup
+		
+		@config = GnibAdsApi::Config.instance
+		@options = {
+			:environment => :sandbox,
+			:username => "desarrollo_neonline",
+			:password => "neonline2013",
+			:developer_token => "BBD37VB98",
+			:customer_id => "21021746",
+			:account_id => "5978083"
+		}
+		@service = GnibAdsApi::Reporting.new(@options)
+
+	end
+
+	test "truth" do
+		assert_kind_of Module, GnibAdsApi
+	end
+	
+	test "initialize" do
+		@service = GnibAdsApi::Reporting.new(@options)
+		puts @service.client_proxy.wsdl_url
+		assert !@service.nil?, "Reporting service not instantiated"
+	end
+
+
+	test "should submit campaign performance report" do
+		
+		report_request = GnibAdsApi::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 = nil
+		assert_nothing_raised(Exception, "Submit generate report raised exception") {
+			report_request_id = @service.submit_generate_report(report_request)
+		}
+		
+		
+		assert !report_request_id.nil?, "No report requeset id received"
+		puts "report_request_id #{report_request_id}"
+		
+	end
+
+
+	test "should submit account performance report" do
+		
+		report_request = GnibAdsApi::AccountPerformanceReportRequest.new(:format => :xml,
+			:language => :english, 
+			:report_name => "My Report",
+			:aggregation => :hourly, 
+			:columns => [:account_name, :account_number, :time_period, 
+				:currency_code, :impressions, :clicks, :ctr, :average_cpc, :spend, 
+				:conversions, :cost_per_conversion, :average_cpm ],
+			:filter => {
+				# String as bing expected
+				:ad_distribution => "Search",
+				# snake case symbol
+				:device_os => :windows,
+				# nil criteria
+				:device_type => nil
+			},
+			:scope => {:account_ids => 5978083 },
+			:time => {
+				:custom_date_range_end => {:day => 31, :month => 12, :year => 2013},
+				:custom_date_range_start => {:day => 1, :month => 12, :year => 2013},
+			})
+		
+		report_request_id = nil
+		assert_nothing_raised(Exception, "Submit generate report raised exception") {
+			report_request_id = @service.submit_generate_report(report_request)
+		}
+		
+		
+		assert !report_request_id.nil?, "No report request id received"
+		puts "report_request_id #{report_request_id}"
+		
+	end
+
+
+	test "initialize report request status" do
+		report_request_status = GnibAdsApi::ReportRequestStatus.new(:report_download_url => "http://some.url.com",
+			:status => "Success")
+		assert !report_request_status.nil?, "ReportRequestStatus not initialized"
+	end
+	
+	
+	test "should poll generate report" do
+		report_request_id = 21265212
+		report_request_status = nil
+		assert_nothing_raised(Exception, "Poll generate report raised exception") {
+			report_request_status = @service.poll_generate_report(report_request_id)
+		}
+		
+		assert !report_request_status.nil?, "No report request status received"
+		puts "report_request_status"
+		puts report_request_status
+
+		assert report_request_status.error?, "report request status should not be error"
+	end
+
+
+	test "should not poll generate report" do
+		report_request_id = 5555555
+		report_request_status = nil
+		assert_nothing_raised(Exception, "Poll generate report raised exception") {
+			report_request_status = @service.poll_generate_report(report_request_id)
+		}
+		
+		assert !report_request_status.error?, "report request status should be error"
+
+	end
+
+end