google-adwords-api 0.12.1 → 0.13.0

data/test/adwords_api/test_adwords_api.rb

@@ -36,8 +36,7 @@ end
 
 class TestAdwordsApi < Test::Unit::TestCase
 
-  API_VERSION = :v201402
-  LAST_CLIENT_LOGIN_API_VERSION = :v201309
+  API_VERSION = :v201406
 
   def setup()
     @logger = LoggerStub.new
@@ -102,29 +101,14 @@ class TestAdwordsApi < Test::Unit::TestCase
     service = adwords_api.service(:ManagedCustomerService, API_VERSION)
   end
 
-  def test_clientlogin_deprecation_warning()
+  def test_clientlogin_error()
     adwords_api = AdwordsApi::Api.new({
       :library => {:logger => @logger},
       :authentication => {:method => 'ClientLogin'},
       :service => {:environment => 'PRODUCTION'}
     })
-    service = adwords_api.service(:CampaignService,
-        LAST_CLIENT_LOGIN_API_VERSION)
-    assert_not_nil(@logger.last_warning)
-  end
-
-  def test_clientlogin_removal()
-      adwords_api = AdwordsApi::Api.new({
-        :library => {:logger => @logger},
-        :authentication => {:method => 'ClientLogin'},
-        :service => {:environment => 'PRODUCTION'}
-      })
-      assert_nothing_raised do
-        service = adwords_api.service(:CampaignService,
-            LAST_CLIENT_LOGIN_API_VERSION)
-      end
-      assert_raise(AdsCommon::Errors::AuthError) do
-        service = adwords_api.service(:CampaignService, API_VERSION)
-      end
+    assert_raise AdsCommon::Errors::AuthError do
+      service = adwords_api.service(:CampaignService, API_VERSION)
+    end
   end
 end

data/test/adwords_api/test_adwords_api.rb~

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# Tests the AdWords API class features.
+
+require 'test/unit'
+
+require 'ads_common/config'
+require 'ads_common/api_config'
+require 'adwords_api'
+
+
+class LoggerStub
+  attr_reader :last_warning
+  def warn(message)
+    @last_warning = message
+  end
+end
+
+class TestAdwordsApi < Test::Unit::TestCase
+
+  API_VERSION = :v201406
+
+  def setup()
+    @logger = LoggerStub.new
+  end
+
+  def test_initialize()
+    assert_nothing_raised do
+      adwords_api = AdwordsApi::Api.new({})
+    end
+  end
+
+  def test_api_config()
+    assert_nothing_raised do
+      adwords_api = AdwordsApi::Api.new({})
+      api_config = adwords_api.api_config()
+      assert_not_nil(api_config)
+      assert_kind_of(AdsCommon::ApiConfig, api_config)
+    end
+  end
+
+  def test_use_mcc()
+    adwords_api = AdwordsApi::Api.new({})
+    adwords_api.use_mcc = false
+    assert(!adwords_api.use_mcc)
+    adwords_api.use_mcc do
+      assert(adwords_api.use_mcc)
+    end
+  end
+
+  def test_validate_only()
+    adwords_api = AdwordsApi::Api.new({})
+    adwords_api.validate_only = false
+    assert(!adwords_api.validate_only)
+    adwords_api.validate_only do
+      assert(adwords_api.validate_only)
+    end
+  end
+
+  def test_partial_failure()
+    adwords_api = AdwordsApi::Api.new({})
+    adwords_api.partial_failure = false
+    assert(!adwords_api.partial_failure)
+    adwords_api.partial_failure do
+      assert(adwords_api.partial_failure)
+    end
+  end
+
+  def test_no_sandbox_env()
+    adwords_api = AdwordsApi::Api.new({
+      :service => {:environment => 'SANDBOX'}
+    })
+    assert_raise(AdsCommon::Errors::Error) do
+      service = adwords_api.service(:ManagedCustomerService, API_VERSION)
+    end
+  end
+
+  def test_prod_env()
+    adwords_api = AdwordsApi::Api.new({
+      :library => {:logger => @logger},
+      :service => {:environment => 'PRODUCTION'}
+    })
+    service = adwords_api.service(:ManagedCustomerService, API_VERSION)
+  end
+
+  def test_clientlogin_error()
+    adwords_api = AdwordsApi::Api.new({
+      :library => {:logger => @logger},
+      :authentication => {:method => 'ClientLogin'},
+      :service => {:environment => 'PRODUCTION'}
+    })
+    assert_raise do
+      service = adwords_api.service(:CampaignService, API_VERSION)
+    end
+  end
+end

data/test/adwords_api/test_api_config.rb

@@ -32,27 +32,27 @@ class TestApiConfig < Test::Unit::TestCase
 
   # Tests correct require path.
   def test_do_require()
-    name1 = @config.do_require(:v201309, :CampaignService)
-    assert_equal('adwords_api/v201309/campaign_service', name1)
+    name1 = @config.do_require(:v201406, :CampaignService)
+    assert_equal('adwords_api/v201406/campaign_service', name1)
   end
 
   # Tests correct module name.
   def test_module_name()
-    name1 = @config.module_name(:v201309, :CampaignService)
-    assert_equal('AdwordsApi::V201309::CampaignService', name1)
+    name1 = @config.module_name(:v201406, :CampaignService)
+    assert_equal('AdwordsApi::V201406::CampaignService', name1)
   end
 
   # Tests correct interface name.
   def test_interface_name()
-    name1 = @config.interface_name(:v201309, :CampaignService)
-    assert_equal('AdwordsApi::V201309::CampaignService::CampaignService', name1)
+    name1 = @config.interface_name(:v201406, :CampaignService)
+    assert_equal('AdwordsApi::V201406::CampaignService::CampaignService', name1)
   end
 
   # Tests AdHoc report URL generator (prod).
   def test_adhoc_report_download_url_prod()
-    url = AdwordsApi::ApiConfig.adhoc_report_download_url(:PRODUCTION, :v201309)
+    url = AdwordsApi::ApiConfig.adhoc_report_download_url(:PRODUCTION, :v201406)
     expected_url =
-        'https://adwords.google.com/api/adwords/reportdownload/v201309'
+        'https://adwords.google.com/api/adwords/reportdownload/v201406'
     assert_equal(expected_url, url)
   end
 end

data/test/adwords_api/test_report_utils.rb

@@ -30,6 +30,7 @@ module AdwordsApi
     public :check_for_errors
     public :check_for_xml_error
     public :add_report_definition_hash_order
+    public :check_report_definition_hash
   end
 end
 
@@ -55,7 +56,7 @@ GZIPPED_REPORT = "\x1F\x8B\b\x00\x00\x00\x00\x00\x00\x00Sr.-.\xC9\xCFUptq\x0F\xF
 
 class TestReportUtils < Test::Unit::TestCase
 
-  API_VERSION = :v201309
+  API_VERSION = :v201406
 
   # Initialize tests.
   def setup()
@@ -185,4 +186,31 @@ class TestReportUtils < Test::Unit::TestCase
       assert_not_nil(e.message)
     end
   end
+
+  def test_return_money_in_micros_removal()
+    node = {
+      :report_name => 'report_name',
+      :report_type => 'CAMPAIGN_PERFORMANCE_REPORT',
+      :selector => {
+        :date_range => {:max=> '20120405', :min => '20120405'},
+        :predicates => {:operator => 'IN', :field => 'S', :values => ['A']},
+        :fields => ['CampaignId']
+      },
+      :download_format => 'CSV',
+      :date_range_type => 'LAST_7_DAYS'
+    }
+    assert_nothing_raised do
+      @report_utils.check_report_definition_hash(node)
+    end
+
+    node[:return_money_in_micros] = true
+    assert_raise AdwordsApi::Errors::InvalidReportDefinitionError do
+      @report_utils.check_report_definition_hash(node)
+    end
+
+    node[:return_money_in_micros] = false
+    assert_raise AdwordsApi::Errors::InvalidReportDefinitionError do
+      @report_utils.check_report_definition_hash(node)
+    end
+  end
 end

data/test/adwords_api/test_report_utils.rb~

@@ -0,0 +1,216 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# Tests report utils.
+
+require 'test/unit'
+
+require 'adwords_api'
+
+# Overriding default access levels to public for tests.
+module AdwordsApi
+  class ReportUtils
+    public :check_for_errors
+    public :check_for_xml_error
+    public :add_report_definition_hash_order
+    public :check_report_definition_hash
+  end
+end
+
+# Stub class for HTTP response.
+class ResponseStub
+  attr_reader :code
+  attr_reader :body
+
+  def initialize(code, body)
+    @code, @body = code, body
+  end
+end
+
+XML_REPLY = {
+  :reply => '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><reportDownloadError><ApiError><type>ReportDefinitionError.INVALID_FIELD_NAME_FOR_REPORT</type><trigger>foo</trigger><fieldPath>bar</fieldPath></ApiError></reportDownloadError>',
+  :type => 'ReportDefinitionError.INVALID_FIELD_NAME_FOR_REPORT',
+  :trigger => 'foo',
+  :field_path => 'bar'
+}
+
+VALID_REPORT = '"Custom ADGROUP_PERFORMANCE_REPORT (Oct 20, 2011-Oct 26, 2011)"\nCampaign ID,Ad group ID,Impressions,Clicks,Cost\nTotal, --,0,0,0.00'
+GZIPPED_REPORT = "\x1F\x8B\b\x00\x00\x00\x00\x00\x00\x00Sr.-.\xC9\xCFUptq\x0F\xF2\x0F\r\x88\x0Fp\rr\xF3\x0F\xF2u\xF4sv\x8D\x0Fr\r\xF0\x0F\nQ\xD0pIMV0\xD2Q0204\xD4\x05\xB1- lM%.\xE7\xC4\xDC\x82\xC4\xCC\xF4<\x05O\x17\x1D\xC7\x14\x85\xF4\xA2\xFC\xD2\x02\x10\xDB3\xB7\xA0(\xB5\xB883?\xAFX\xC79'39\eH\xE5\x17\x97p\x85\xE4\x97$\xE6\xE8(\xE8\xEA\xEA\x18\x80\xA0\x9E\x81\x01\x17\x00\xBE\x1D\xBE\xAD\x81\x00\x00\x00"
+
+class TestReportUtils < Test::Unit::TestCase
+
+  API_VERSION = :v201406
+
+  # Initialize tests.
+  def setup()
+    @api = AdwordsApi::Api.new
+    @report_utils = @api.report_utils(API_VERSION)
+  end
+
+  # Testing HTTP code 400.
+  def test_check_for_errors_400()
+    begin
+      response = ResponseStub.new(400, XML_REPLY[:reply])
+      @report_utils.check_for_errors(response)
+      assert(false, 'No exception thrown for code 400')
+    rescue AdwordsApi::Errors::ReportXmlError => e
+      assert_equal(400, e.http_code)
+      assert_equal(XML_REPLY[:type], e.type)
+      assert_equal(XML_REPLY[:trigger], e.trigger)
+      assert_equal(XML_REPLY[:field_path], e.field_path)
+      assert_not_nil(e.message)
+    end
+  end
+
+  # Testing HTTP code 500.
+  def test_check_for_errors_500()
+    begin
+      response = ResponseStub.new(500, nil)
+      @report_utils.check_for_errors(response)
+      assert(false, 'No exception thrown for code 500')
+    rescue AdwordsApi::Errors::ReportError => e
+      assert_equal(500, e.http_code)
+    end
+  end
+
+  # Testing HTTP code 200 with success.
+  def test_check_for_errors_200_success()
+    response = ResponseStub.new(200, VALID_REPORT)
+    assert_nothing_raised do
+      @report_utils.check_for_errors(response)
+    end
+  end
+
+  # Testing correct gzipped reply.
+  def test_gzipped_data()
+    report = (RUBY_VERSION >= '1.9.1') ?
+        GZIPPED_REPORT.force_encoding('UTF-8') : GZIPPED_REPORT
+    response = ResponseStub.new(200, report)
+    assert_nothing_raised do
+      @report_utils.check_for_errors(response)
+    end
+  end
+
+  # Tests generated hash order for root (complete set).
+  def test_add_report_definition_hash_order_root1()
+    node = {
+      :include_zero_impressions => false,
+      :download_format => 'CSV',
+      :report_type => 'CRITERIA_PERFORMANCE_REPORT',
+      :selector => {},
+      :report_name => 'report_name',
+      :date_range_type => 'LAST_7_DAYS'
+    }
+    expected = [:selector, :report_name, :report_type, :date_range_type,
+                :download_format, :include_zero_impressions]
+    @report_utils.add_report_definition_hash_order(node)
+    assert_not_nil(node[:order!])
+    assert_equal(expected, node[:order!])
+  end
+
+  # Tests generated hash order for root (incomplete set).
+  def test_add_report_definition_hash_order_root2()
+    node = {
+      :download_format => 'CSV',
+      :report_type => 'CRITERIA_PERFORMANCE_REPORT',
+      :selector => {},
+      :report_name => 'report_name',
+      :date_range_type => 'LAST_7_DAYS'
+    }
+    expected = [:selector, :report_name, :report_type, :date_range_type,
+                :download_format]
+    @report_utils.add_report_definition_hash_order(node)
+    assert_not_nil(node[:order!])
+    assert_equal(expected, node[:order!])
+  end
+
+  # Tests generated hash order for whole structure.
+  def test_add_report_definition_hash_order_deep()
+    node = {
+      :report_name => 'report_name',
+      :report_type => 'CRITERIA_PERFORMANCE_REPORT',
+      :selector => {
+        :date_range => {:max => '20120405', :min => '20120405'},
+        :predicates => {:operator => 'IN', :field => 'S', :values => ['A']},
+        :fields => ['CampaignId']
+      },
+      :include_zero_impressions => false,
+      :download_format => 'CSV',
+      :date_range_type => 'LAST_7_DAYS'
+    }
+    expected1 = [:selector, :report_name, :report_type, :date_range_type,
+                 :download_format, :include_zero_impressions]
+    expected2 = [:fields, :predicates, :date_range]
+    expected3 = [:min, :max]
+    expected4 = [:field, :operator, :values]
+
+    @report_utils.add_report_definition_hash_order(node)
+    assert_not_nil(node[:order!])
+    assert_not_nil(node[:selector][:order!])
+    assert_not_nil(node[:selector][:date_range][:order!])
+    assert_not_nil(node[:selector][:predicates][:order!])
+
+    assert_equal(expected1, node[:order!])
+    assert_equal(expected2, node[:selector][:order!])
+    assert_equal(expected3, node[:selector][:date_range][:order!])
+    assert_equal(expected4, node[:selector][:predicates][:order!])
+  end
+
+  # Testing check_for_xml_error.
+  def check_for_xml_error()
+    begin
+      @report_utils.check_for_xml_error(XML_REPLY[:reply], 42)
+      assert(false, 'No exception thrown for code 42')
+    rescue AdwordsApi::Errors::ReportXmlError => e
+      assert_equal(42, e.http_code)
+      assert_equal(XML_REPLY[:type], e.type)
+      assert_equal(XML_REPLY[:trigger], e.trigger)
+      assert_equal(XML_REPLY[:field_path], e.field_path)
+      assert_not_nil(e.message)
+    end
+  end
+
+  def test_return_money_in_micros_removal()
+    node = {
+      :report_name => 'report_name',
+      :report_type => 'CAMPAIGN_PERFORMANCE_REPORT',
+      :selector => {
+        :date_range => {:max=> '20120405', :min => '20120405'},
+        :predicates => {:operator => 'IN', :field => 'S', :values => ['A']},
+        :fields => ['CampaignId']
+      },
+      :download_format => 'CSV',
+      :date_range_type => 'LAST_7_DAYS'
+    }
+    assert_nothing_raised do
+      @report_utils.check_report_definition_hash(node)
+    end
+
+    node[:return_money_in_micros] = true
+    assert_raise AdwordsApi::Errors::InvalidReportDefinitionError do
+      @report_utils.check_report_definition_hash(node)
+    end
+
+    node[:return_money_in_micros] = false
+    assert_raise AdwordsApi::Errors::InvalidReportDefinitionError do
+      @report_utils.check_report_definition_hash(node)
+    end
+  end
+end