google-adwords-api 0.7.2 → 0.8.0

data/lib/adwords_api/credential_handler.rb

@@ -70,8 +70,6 @@ module AdwordsApi
     # environment.
     #
     # Raises:
-    # - AdsCommon::Error::EnvironmentMismatchError if sandbox credentials are
-    # being used for production or vice-versa.
     # - AdwordsApi::Errors:BadCredentialsError if supplied credentials are not
     # valid.
     #
@@ -90,21 +88,9 @@ module AdwordsApi
       end
 
       token = credentials[:developer_token]
-      sandbox_token = (token =~ /.+@.+\+\+[a-zA-Z]{3}/)
-      environment = @config.read('service.environment')
-      case environment
-        when :PRODUCTION
-          if sandbox_token
-            raise AdsCommon::Errors::EnvironmentMismatchError,
-                'Attempting to connect to production with sandbox credentials.'
-          end
-        when :SANDBOX
-          if (!sandbox_token)
-            raise AdsCommon::Errors::EnvironmentMismatchError,
-                'Attempting to connect to the sandbox with malformatted ' +
-                'credentials. Please check http://code.google.com/apis/' +
-                'adwords/docs/sandbox.html#request-headers for details.'
-          end
+      if token.nil? || token.empty?
+        raise AdwordsApi::Errors::BadCredentialsError,
+            'Developer token is missing, check credentials.'
       end
       return nil
     end

data/lib/adwords_api/report_header_handler.rb

@@ -49,8 +49,7 @@ module AdwordsApi
       credentials = @credential_handler.credentials(override)
       headers = {
           'Content-Type' => 'application/x-www-form-urlencoded',
-          'Authorization' =>
-              @auth_handler.auth_string(credentials, HTTPI::Request.new(url)),
+          'Authorization' => @auth_handler.auth_string(credentials),
           'User-Agent' => @credential_handler.generate_user_agent(),
           'clientCustomerId' => credentials[:client_customer_id].to_s,
           'developerToken' => credentials[:developer_token]

data/lib/adwords_api/report_utils.rb

@@ -196,7 +196,7 @@ module AdwordsApi
     def check_for_errors(response)
       # Check for error in body.
       report_body = response.body
-      if report_body and is_legacy_reporting(@version) and
+      if report_body and (@version == :v201206) and
           ((RUBY_VERSION < '1.9.1') or report_body.valid_encoding?)
         check_for_legacy_error(report_body, response.code)
       end
@@ -210,13 +210,6 @@ module AdwordsApi
       return nil
     end
 
-    # Returns true is the provided API version has legacy reporting.
-    def is_legacy_reporting(version)
-      return (version == :v201206 or
-              version == :v201109_1 or
-              version == :v201109)
-    end
-
     # Checks for a legacy error in the response body and raises an exception if
     # it was found.
     def check_for_legacy_error(report_body, response_code)

data/lib/adwords_api/version.rb

@@ -21,6 +21,6 @@
 
 module AdwordsApi
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.7.2'
+    CLIENT_LIB_VERSION = '0.8.0'
   end
 end

data/test/adwords_api/test_adwords_api.rb

@@ -27,20 +27,18 @@ require 'ads_common/api_config'
 require 'adwords_api'
 
 class TestAdwordsApi < Test::Unit::TestCase
-  # Initializes tests.
-  def setup()
-    @config = AdsCommon::Config.new({})
-  end
+
+  API_VERSION = :v201209
 
   def test_initialize()
     assert_nothing_raised do
-      adwords_api = AdwordsApi::Api.new(@config)
+      adwords_api = AdwordsApi::Api.new({})
     end
   end
 
   def test_api_config()
     assert_nothing_raised do
-      adwords_api = AdwordsApi::Api.new(@config)
+      adwords_api = AdwordsApi::Api.new({})
       api_config = adwords_api.api_config()
       assert_not_nil(api_config)
       assert_kind_of(AdsCommon::ApiConfig, api_config)
@@ -48,7 +46,7 @@ class TestAdwordsApi < Test::Unit::TestCase
   end
 
   def test_use_mcc()
-    adwords_api = AdwordsApi::Api.new(@config)
+    adwords_api = AdwordsApi::Api.new({})
     adwords_api.use_mcc = false
     assert(!adwords_api.use_mcc)
     adwords_api.use_mcc do
@@ -57,7 +55,7 @@ class TestAdwordsApi < Test::Unit::TestCase
   end
 
   def test_validate_only()
-    adwords_api = AdwordsApi::Api.new(@config)
+    adwords_api = AdwordsApi::Api.new({})
     adwords_api.validate_only = false
     assert(!adwords_api.validate_only)
     adwords_api.validate_only do
@@ -66,11 +64,27 @@ class TestAdwordsApi < Test::Unit::TestCase
   end
 
   def test_partial_failure()
-    adwords_api = AdwordsApi::Api.new(@config)
+    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({
+      :service => {:environment => 'PRODUCTION'}
+    })
+    service = adwords_api.service(:ManagedCustomerService, API_VERSION)
+  end
 end

data/test/adwords_api/test_api_config.rb

@@ -55,12 +55,4 @@ class TestApiConfig < Test::Unit::TestCase
         'https://adwords.google.com/api/adwords/reportdownload/v201206'
     assert_equal(expected_url, url)
   end
-
-  # Tests AdHoc report URL generator (sandbox).
-  def test_adhoc_report_download_url_sandbox()
-    url = AdwordsApi::ApiConfig.adhoc_report_download_url(:SANDBOX, :v201206)
-    expected_url =
-        'https://adwords-sandbox.google.com/api/adwords/reportdownload/v201206'
-    assert_equal(expected_url, url)
-  end
 end

data/test/adwords_api/test_credential_handler.rb

@@ -38,8 +38,8 @@ end
 class TestCredentialHandler < Test::Unit::TestCase
 
   def setup()
-    logger = Logger.new(STDERR)
-    config = AdsCommon::Config.new({:library => {:logger => logger}})
+    @logger = Logger.new(STDERR)
+    config = AdsCommon::Config.new({:library => {:logger => @logger}})
     @handler = AdwordsApi::CredentialHandler.new(config)
   end
 
@@ -51,35 +51,71 @@ class TestCredentialHandler < Test::Unit::TestCase
   end
 
   def test_validate_headers_for_server_client_customer_id()
-    credentials = {:client_customer_id => '123-456-7890'}
+    credentials = {
+      :client_customer_id => '123-456-7890',
+      :developer_token => 'AbC'
+    }
     assert_nothing_raised {@handler.validate_headers_for_server(credentials)}
   end
 
   def test_validate_headers_for_server_valid_cid()
-    credentials1 = {:client_customer_id => '123-456-7890'}
+    credentials1 = {
+      :client_customer_id => '123-456-7890',
+      :developer_token => 'AbC'
+    }
     assert_nothing_raised {@handler.validate_headers_for_server(credentials1)}
 
-    credentials2 = {:client_customer_id => '1234567890'}
+    credentials2 = {
+      :client_customer_id => '1234567890',
+      :developer_token => 'AbC'
+    }
     assert_nothing_raised {@handler.validate_headers_for_server(credentials2)}
 
-    credentials3 = {:client_customer_id => 1234567890}
+    credentials3 = {
+      :client_customer_id => 1234567890,
+      :developer_token => 'AbC'
+    }
     assert_nothing_raised {@handler.validate_headers_for_server(credentials3)}
   end
 
   def test_validate_headers_for_server_invalid_cid()
-    credentials1 = {:client_customer_id => 'demo@example.com'}
+    credentials1 = {
+      :client_customer_id => 'demo@example.com',
+      :developer_token => 'AbC'
+    }
     assert_raise(AdwordsApi::Errors::BadCredentialsError) do
       @handler.validate_headers_for_server(credentials1)
     end
 
-    credentials2 = {:client_customer_id => 'demo@example.com 1234567890'}
+    credentials2 = {
+      :client_customer_id => 'demo@example.com 1234567890',
+      :developer_token => 'AbC'
+    }
     assert_raise(AdwordsApi::Errors::BadCredentialsError) do
       @handler.validate_headers_for_server(credentials2)
     end
 
-    credentials3 = {:client_customer_id => '123-456-7890-'}
+    credentials3 = {
+      :client_customer_id => '123-456-7890-',
+      :developer_token => 'AbC'
+    }
     assert_raise(AdwordsApi::Errors::BadCredentialsError) do
       @handler.validate_headers_for_server(credentials3)
     end
   end
+
+  def test_validate_headers_for_server_no_developer_token()
+    credentials1 = {:client_customer_id => '123-456-7890'}
+    assert_raise(AdwordsApi::Errors::BadCredentialsError) do
+      @handler.validate_headers_for_server(credentials1)
+    end
+
+    credentials2 = {
+      :client_customer_id => '123-456-7890',
+      :developer_token => ''
+    }
+    assert_raise(AdwordsApi::Errors::BadCredentialsError) do
+      @handler.validate_headers_for_server(credentials2)
+    end
+  end
 end

data/test/adwords_api/test_report_utils.rb

@@ -24,8 +24,6 @@ require 'test/unit'
 
 require 'adwords_api'
 
-API_VERSION = :v201206
-
 # Overriding default access levels to public for tests.
 module AdwordsApi
   class ReportUtils
@@ -65,6 +63,9 @@ VALID_REPORT = '"Custom ADGROUP_PERFORMANCE_REPORT (Oct 20, 2011-Oct 26, 2011)"\
 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 = :v201209
+
   # Initialize tests.
   def setup()
     @api = AdwordsApi::Api.new

data/test/{suite_exampletests_v201109.rb → suite_integration.rb}

@@ -18,20 +18,23 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# Test suite for v201109 example tests.
-
-require 'test/unit'
+# Test suite for integration tests.
 
 $:.unshift File.expand_path('../../lib/', __FILE__)
 $:.unshift File.expand_path('../../', __FILE__)
 
-version = 'v201109'
+require 'test/test_utils'
+
+examples_dir_path =
+    File.expand_path(File.join('..', '..', 'examples'), __FILE__)
 
-examples_path =
-    File.expand_path(File.join('..', '..', 'examples', version), __FILE__)
-$:.unshift(examples_path)
+examples_mask = File.join(examples_dir_path, 'v*/**/*.rb')
 
-tests_path = File.join(File.dirname(__FILE__), 'examples', version)
-require File.join(tests_path, 'utils.rb')
-tests_mask = File.join(tests_path, 'test_*.rb')
-Dir.glob(tests_mask).each {|file| require file}
+Dir.glob(examples_mask).each do |file|
+  method_name = 'test_%s' % File.basename(file)
+  Class.new(Test::Unit::TestCase) do
+    define_method(method_name) do
+      ExampleRunner.new(file).engage(self)
+    end
+  end
+end

data/test/templates/v201209/basic_operations_get_campaigns.def

@@ -0,0 +1,114 @@
+def setup_mocks()
+  $api_config = {
+    :service => {:environment => 'PRODUCTION'},
+    :authentication => {
+      :method => 'ClientLogin',
+      :email => 'noreply@google.com',
+      :password => 'noreply_password',
+      :developer_token => 'dev_token123',
+      :client_customer_id => '123-456-7890',
+      :user_agent => 'ruby-tests'
+    }
+  }
+
+  stub_request(:post, "https://www.google.com/accounts/ClientLogin").
+    with(:body => {"Email"=>"noreply@google.com", "Passwd"=>"noreply_password", "accountType"=>"GOOGLE", "service"=>"adwords"}).
+    to_return(:status => 200, :body => "SID=abcSIDbcd\nLSID=abcLSIDbcd\nAuth=abcAuthbcd\n", :headers => {})
+
+  stub_request(:post, "https://adwords.google.com/api/adwords/cm/v201209/CampaignService").
+    with(
+      :body =>
+      # autogenerated code
+        {"env:Envelope"=>
+          {"env:Header"=>
+            {"wsdl:RequestHeader"=>
+              {"userAgent"=>"ruby-tests (AwApi-Ruby/0.8.0, Common-Ruby/0.8.2, Savon/1.2.0, ruby/1.9.3, HTTPI/1.1.1, net_http)",
+               "developerToken"=>"dev_token123",
+               "clientCustomerId"=>"123-456-7890",
+               "authToken"=>"abcAuthbcd",
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201209"}},
+           "env:Body"=>
+            {"get"=>
+              {"serviceSelector"=>
+                {"fields"=>["Id", "Name", "Status"],
+                 "ordering"=>{"field"=>"Name", "sortOrder"=>"ASCENDING"},
+                 "paging"=>{"startIndex"=>"0", "numberResults"=>"5"}},
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201209"}},
+           "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+           "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+           "xmlns:wsdl"=>"https://adwords.google.com/api/adwords/cm/v201209",
+           "xmlns:env"=>"http://schemas.xmlsoap.org/soap/envelope/"}},
+      # end of auto-generated code.
+      :headers => {
+        'SOAPAction' => '"get"',
+        'Content-Type' => 'text/xml;charset=UTF-8'
+      }
+    ).
+    to_return(
+      :status => 200,
+      :body => '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+                <soap:Header>
+                  <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201209">
+                    <requestId>0004c</requestId>
+                    <serviceName>CampaignService</serviceName>
+                    <methodName>get</methodName>
+                    <operations>42</operations>
+                    <responseTime>84</responseTime>
+                    <units>42</units>
+                  </ResponseHeader>
+                </soap:Header>
+                <soap:Body>
+                  <getResponse xmlns="https://adwords.google.com/api/adwords/cm/v201209">
+                    <rval>
+                      <totalNumEntries>2</totalNumEntries>
+                      <Page.Type>CampaignPage</Page.Type>
+                      <totalBudget>
+                        <period>DAILY</period><amount><ComparableValue.Type>Money</ComparableValue.Type>
+                        <microAmount>0</microAmount></amount>
+                      </totalBudget>
+                      <entries>
+                        <id>15</id><name>Campaign name 1</name><status>PAUSED</status><campaignStats><network>ALL</network>
+                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>0</impressions></frequencyCap>
+                      </entries>
+                      <entries>
+                        <id>16</id><name>Campaign name 2</name><status>ACTIVE</status><campaignStats><network>ALL</network>
+                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>150</impressions></frequencyCap>
+                      </entries>
+                    </rval>
+                  </getResponse>
+                </soap:Body>
+                </soap:Envelope>',
+      :headers => {'content-type' => 'text/xml;'}
+    )
+end
+
+def run_asserts()
+  assert_equal(2, $latest_result[:total_num_entries])
+  assert_equal('CampaignPage', $latest_result[:page_type])
+  entries = $latest_result[:entries]
+  assert_equal(2, entries.size)
+
+  if entries[0][:id] == 15
+    assert_campaign_15(entries[0])
+    assert_campaign_16(entries[1])
+  else
+    assert_campaign_15(entries[1])
+    assert_campaign_16(entries[0])
+  end
+end
+
+def assert_campaign_15(entry)
+  assert_equal(15, entry[:id])
+  assert_equal('Campaign name 1', entry[:name])
+  assert_equal('PAUSED', entry[:status])
+  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
+  assert_equal({:impressions=>0}, entry[:frequency_cap])
+end
+
+def assert_campaign_16(entry)
+  assert_equal(16, entry[:id])
+  assert_equal('Campaign name 2', entry[:name])
+  assert_equal('ACTIVE', entry[:status])
+  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
+  assert_equal({:impressions=>150}, entry[:frequency_cap])
+end

data/test/test_utils.rb

@@ -0,0 +1,105 @@
+#!/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.
+#
+# Test utils.
+
+# We need to require all example deps here for example method detection to work
+# correctly.
+require 'ads_common/savon_service'
+require 'adwords_api'
+require 'webmock/test_unit'
+
+class ExampleRunner < Test::Unit::TestCase
+  PAGE_SIZE = 5
+
+  def initialize(example_file)
+    @version, template_file = extract_strings(example_file)
+
+    begin
+      eval_ruby_file(template_file)
+    rescue Errno::ENOENT => e
+      @template_error = "No template for example: '%s'" % example_file
+    end
+
+    @all_methods = self.methods
+    eval_ruby_file(example_file)
+  end
+
+  def engage(test)
+    test.skip(@template_error) if @template_error
+    reset_state()
+    setup_mocks()
+    self.instance_eval('API_VERSION = :%s' % @version)
+    self.instance_eval('PAGE_SIZE = %d' % PAGE_SIZE)
+    self.send(get_example_method())
+    run_asserts()
+  end
+
+  private
+
+  def reset_state()
+    WebMock.reset!
+    $latest_result = nil
+  end
+
+  def get_example_method()
+    example_methods = self.methods - @all_methods
+    if example_methods.size != 1
+      raise StandardError, 'Unexpected set of methods found, need only one: ' +
+          PP.singleline_pp(example_methods, '')
+    end
+    return example_methods.first()
+  end
+
+  def extract_strings(filename)
+    version = File.basename(File.dirname(File.dirname(filename)))
+    dirname = File.basename(File.dirname(filename))
+    example_name = File.basename(filename, '.rb')
+    template_name = '%s_%s.def' % [dirname, example_name]
+    template_fullpath = File.expand_path(
+        File.join('..', 'templates', version, template_name), __FILE__)
+    return version, template_fullpath
+  end
+
+  def eval_ruby_file(filename)
+    file_body = File.read(filename)
+    self.instance_eval(file_body)
+  end
+end
+
+
+module AdsCommon
+  class Api
+    # Patching original load_config for test credentials.
+    alias :old_load_config :load_config
+    def load_config(provided_config = nil)
+      old_load_config($api_config)
+    end
+  end
+
+  class SavonService
+    # Patching original to capture the latest response.
+    alias :old_execute_action :execute_action
+    def execute_action(action_name, args, &block)
+      $latest_result = old_execute_action(action_name, args, &block)
+      return $latest_result
+    end
+  end
+end