google-ads-common 0.6.2 → 0.6.3

data/ChangeLog

@@ -1,3 +1,10 @@
+0.6.3:
+  - Support for CAPTCHA challenge handling.
+  - Added .gemspec and updated packaging process.
+  - Removed explicit require for RubyGems.
+  - Added configuration directive to choose HTTPI adapter (connection.adapter)
+    and read / open timeouts (connection.read_timeout, connection.open_timeout).
+
 0.6.2:
   - Requiring Savon as "~>" now.
   - Updates to file headers.

data/README

@@ -19,7 +19,8 @@ Install it using the gem install command.
 The following gem libraries are required:
  - savon v0.9.7 or greater;
  - httpi v0.9.3 or greater;
- - httpclient v2.2.3 or greater.
+ - httpclient v2.2.3 or greater;
+ - oauth v0.4.5 or greater.
 
 = Docs for Developers
 
@@ -36,8 +37,8 @@ The following gem libraries are required:
 
 == 2 - Commands
 
- $ rake package
-to package the gem and create a release
+ $ gem build google-ads-common.gemspec
+to build the gem
 
  $ rake test
 to run unit tests on the library

data/lib/ads_common/api_config.rb

@@ -21,13 +21,13 @@
 # Helper methods for loading and managing services for an API. Defines methods
 # to be included as class modules in a service class for a specific API.
 
+require 'ads_common/version.rb'
+
 module AdsCommon
 
   # Contains helper methods for loading and managing the available services.
   # This module is meant to be imported into API-specific modules.
   module ApiConfig
-    ADS_COMMON_VERSION = '0.6.2'
-
     # Get the available API versions.
     #
     # Returns:

data/lib/ads_common/auth/client_login_handler.rb

@@ -33,6 +33,7 @@ module AdsCommon
     class ClientLoginHandler < AdsCommon::Auth::BaseHandler
       ACCOUNT_TYPE = 'GOOGLE'
       AUTH_PATH = '/accounts/ClientLogin'
+      CAPTCHA_PATH = '/accounts/'
       IGNORED_FIELDS = [:email, :password, :auth_token]
 
       # Initializes the ClientLoginHandler with all the necessary details.
@@ -139,24 +140,43 @@ module AdsCommon
 
         data = "accountType=%s&Email=%s&Passwd=%s&service=%s" %
             [ACCOUNT_TYPE, email, password, @service_name]
+
+        if credentials[:logintoken] and credentials[:logincaptcha]
+          data += "&logintoken=%s&logincaptcha=%s" %
+            [CGI.escape(credentials[:logintoken]),
+             CGI.escape(credentials[:logincaptcha])]
+        end
+
         headers = {'Content-Type' => 'application/x-www-form-urlencoded'}
 
         response = AdsCommon::Http.post_response(url, data, @config, headers)
         results = parse_token_text(response.body)
 
-        if response.code == 200 and results.include?(:Auth)
-          return results[:Auth]
+        if response.code == 200 and results.include?('Auth')
+          return results['Auth']
         else
-          error_message = "Login failed for email %s: HTTP code %d." %
-              [credentials[:email], 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 AdsCommon::Errors::AuthError.new(error_message, error_str,
-              results[:Info])
+          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 AdsCommon::Errors::CaptchaRequiredError.new(results['Error'],
+              results['CaptchaToken'], captcha_url, results['Url'])
         end
+        # For other errors throwing a generic error.
+        error_message = "ClientLogin failed for email '%s': HTTP code %d." %
+            [credentials[:email], 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 AdsCommon::Errors::AuthError.new(error_message, error_str,
+            results['Info'])
       end
 
       # Extracts key-value pairs from ClientLogin server response.
@@ -168,12 +188,11 @@ module AdsCommon
       #   Hash of key-value pairs
       #
       def parse_token_text(text)
-        result = {}
-        text.split("\n").each do |line|
-          key, value = line.split("=")
-          result[key.to_sym] = value
+        return text.split("\n").inject({}) do |result, line|
+          key, *values = line.split('=')
+          result[key] = values.join('=')
+          result
         end
-        return result
       end
     end
   end

data/lib/ads_common/build/savon_abstract_generator.rb

@@ -50,7 +50,7 @@ module AdsCommon
 
       def prepare_template_strings()
         @generator_stamp = "Code generated by AdsCommon library %s on %s." %
-            [AdsCommon::ApiConfig::ADS_COMMON_VERSION,
+            [AdsCommon::ApiConfig::CLIENT_LIB_VERSION,
              Time.now.strftime("%Y-%m-%d %H:%M:%S")]
         @modules_open_string = 'module ' +
             [@api_name, @version.to_s.upcase, @service_name].join('; module ')

data/lib/ads_common/config.rb

@@ -20,7 +20,6 @@
 # Configuration handler, can load data from a YAML configuration file and
 # rewrite it in memory.
 
-require 'rubygems'
 require 'yaml'
 
 require 'ads_common/errors'

data/lib/ads_common/errors.rb

@@ -48,6 +48,17 @@ module AdsCommon
       end
     end
 
+    # Raised when ClientLogin Captcha challenge occurs.
+    class CaptchaRequiredError < AuthError
+      attr_reader :error, :captcha_token
+      attr_reader :captcha_url, :auth_url
+      def initialize(error, captcha_token, captcha_url, auth_url)
+        super()
+        @error, @captcha_token  = error, captcha_token
+        @captcha_url, @auth_url = captcha_url, auth_url
+      end
+    end
+
     # Raised if a required property on an object is missing.
     class MissingPropertyError < Error
       attr_reader :property, :object_type

data/lib/ads_common/http.rb

@@ -26,6 +26,9 @@ require 'ads_common/errors'
 
 module AdsCommon
   module Http
+    # HTTP read and open timeouts in seconds.
+    HTTP_READ_TIMEOUT = 15 * 60
+    HTTP_OPEN_TIMEOUT = 5 * 60
 
     # Performs a get on a URL, using all of the connection options in the
     # client library, returning a HTTPI::Response.
@@ -45,8 +48,7 @@ module AdsCommon
     # client library, returning a HTTPI::Response.
     def self.post_response(url, data, config = nil, headers = nil)
       request = prepare_request(url, config, headers, data)
-      response = HTTPI.post(request)
-      return response
+      return HTTPI.post(request)
     end
 
     # Performs a post on a URL, using all of the connection options in the
@@ -63,19 +65,32 @@ module AdsCommon
       request = HTTPI::Request.new(url)
       request.headers = headers if headers
       request.body = data if data
+      configure_httpi(config, request)
+      return request
+    end
+
+    # Configures HTTPI request according to the config provided.
+    def self.configure_httpi(config, httpi)
       if config
-        proxy = config.read('connection.proxy', nil)
-        request.proxy = proxy if !proxy.nil?
-        strict_ssl =
-            !(config.read('connection.strict_ssl_verification') == 'false')
-        request.auth.ssl.verify_mode = strict_ssl ? :peer : :none
+        adapter = config.read('connection.adapter')
+        HTTPI.adapter = adapter if adapter
+        proxy = config.read('connection.proxy')
+        httpi.proxy = proxy if proxy
+        enable_gzip = config.read('connection.enable_gzip', false)
+        httpi.gzip if enable_gzip
         logger = config.read('library.logger')
         if logger
           HTTPI.logger = logger
           HTTPI.log_level = :debug
         end
       end
-      return request
+      httpi.read_timeout = (config.nil?) ? HTTP_READ_TIMEOUT :
+          config.read('connection.read_timeout', HTTP_READ_TIMEOUT)
+      httpi.open_timeout = (config.nil?) ? HTTP_OPEN_TIMEOUT :
+          config.read('connection.open_timeout', HTTP_OPEN_TIMEOUT)
+      strict_ssl = config.nil? or
+          config.read('connection.strict_ssl_verification', true)
+      httpi.auth.ssl.verify_mode = strict_ssl ? :peer : :none
     end
   end
 end

data/lib/ads_common/savon_headers/base_header_handler.rb

@@ -89,7 +89,7 @@ module AdsCommon
         app_name = credentials[:userAgent] || credentials[:useragent]
         # We don't know the library version here. A breaking change needs to be
         # introduced. This is scheduled for 0.7.0, using Common version for now.
-        lib_version = '0.6.2'
+        lib_version = '0.6.3'
         soap_user_agent = "Common-Ruby-%s; %s" % [lib_version, app_name]
         user_agent = "Savon/%s (%s)" % [Savon::Version, soap_user_agent]
         user_agent += ' (gzip)' if @config.read('connection.enable_gzip', false)

data/lib/ads_common/savon_service.rb

@@ -22,13 +22,11 @@
 require 'httpi'
 require 'savon'
 
+require 'ads_common/http'
 require 'ads_common/parameters_validator'
 
 module AdsCommon
   class SavonService
-    # HTTP read timeout in seconds.
-    HTTP_READ_TIMEOUT = 15 * 60
-
     attr_accessor :headerhandler
     attr_reader :api
     attr_reader :version
@@ -52,8 +50,6 @@ module AdsCommon
         config.log_level = :debug
         config.logger = logger
       end
-      HTTPI.logger = logger
-      HTTPI.log_level = :debug
     end
 
     # Returns ServiceRegistry for the current service. Has to be overridden.
@@ -68,14 +64,10 @@ module AdsCommon
 
     # Creates and sets up Savon client.
     def create_savon_client(endpoint, namespace)
-      proxy = @api.config.read('connection.proxy')
-      enable_gzip = @api.config.read('connection.enable_gzip', false)
-      client = Savon::Client.new do |wsdl, http|
+      client = Savon::Client.new do |wsdl, httpi|
         wsdl.endpoint = endpoint
         wsdl.namespace = namespace
-        http.read_timeout = HTTP_READ_TIMEOUT
-        http.proxy = proxy if proxy
-        http.gzip if enable_gzip
+        AdsCommon::Http.configure_httpi(@api.config, httpi)
       end
       return client
     end
@@ -92,6 +84,7 @@ module AdsCommon
     end
 
     # Logs response headers.
+    # TODO: this needs to go on http or httpi level.
     def log_headers(headers)
       @api.logger.debug(headers.map {|k, v| [k, v].join(': ')}.join(', '))
     end

data/lib/ads_common/version.rb

@@ -0,0 +1,26 @@
+# Encoding: utf-8
+#
+# Authors:: 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.
+#
+# Module to keep the current library version.
+
+module AdsCommon
+  module ApiConfig
+    CLIENT_LIB_VERSION = '0.6.3'
+  end
+end

data/test/test_client_login_handler.rb

@@ -0,0 +1,98 @@
+#!/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 client login handler methods.
+
+require 'test/unit'
+
+require 'ads_common/config'
+require 'ads_common/auth/client_login_handler'
+
+module AdsCommon
+  module Auth
+    class ClientLoginHandler
+      public :parse_token_text
+      public :handle_login_error
+    end
+  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
+
+class TestParametersValidator < Test::Unit::TestCase
+  def setup
+    config = AdsCommon::Config.new({})
+    @handler = AdsCommon::Auth::ClientLoginHandler.new(
+        config, 'http://www.google.com', nil)
+  end
+
+  def test_handle_login_error_captcha
+    assert_raises (AdsCommon::Errors::CaptchaRequiredError) do
+      response = ResponseStub.new(403, '')
+      results = {
+          'Error' => 'CaptchaRequired',
+          'CaptchaUrl' => '/account/test-captcha'
+      }
+      @handler.handle_login_error({}, response, results)
+    end
+  end
+
+  def test_handle_login_error_other
+    assert_raises (AdsCommon::Errors::AuthError) do
+      response = ResponseStub.new(403, 'Body')
+      results = {'Error' => 'SomeError', 'Info' => 'SomeInfo'}
+      @handler.handle_login_error({}, response, results)
+    end
+  end
+
+  def test_parse_token_text_simple
+    error_str = "BadAuthentication"
+    text = "Error=%s\n" % error_str
+    result = @handler.parse_token_text(text)
+    assert_equal(error_str, result['Error'])
+    assert_equal(['Error'], result.keys)
+  end
+
+  def test_parse_token_text_captcha
+    captcha_token = "3u6_27iOel71j525g2tg252ge6t35g345XJtRuHYEYiTyAxsMPz2222442"
+    captcha_url = "Captcha?ctoken=3u245245rgfwrg5g2fw5x3xGqQBrk_AoXXJtRuHY%3a-V"
+    error_str = "CaptchaRequired"
+    url_str = "https://www.google.com/accounts/ErrorMsg?Email=example%40goog" +
+        "le.com&service=adwords&id=cr&timeStmp=1327400499&secTok=.AG5fkgtw45" +
+        "25gfref25gttrefwwrPeB8Xw%3D%3D"
+    text = "CaptchaToken=%s\nCaptchaUrl=%s\nError=%s\nUrl=%s\n" %
+        [captcha_token, captcha_url, error_str, url_str]
+    result = @handler.parse_token_text(text)
+    assert_equal(captcha_token, result['CaptchaToken'])
+    assert_equal(captcha_url, result['CaptchaUrl'])
+    assert_equal(error_str, result['Error'])
+    assert_equal(url_str, result['Url'])
+    assert_equal(['CaptchaToken', 'CaptchaUrl', 'Error', 'Url'],
+        result.keys.sort)
+  end
+end

data/test/test_config.rb

@@ -20,8 +20,8 @@
 #
 # Tests the array replies from services.
 
-require 'rubygems'
 require 'test/unit'
+
 require 'ads_common/config'
 
 class TestConfig < Test::Unit::TestCase

data/test/test_config.yml

@@ -0,0 +1,11 @@
+---
+# This is a test configuration file for Ads Common library.
+:authentication:
+  :method: ClientLogin
+  :application_name: ruby_test_suit
+  :password: mySecretPassword
+  :email: root@example.com
+  :network_code: 1234567
+:service:
+  :environment: sandbox
+  :use_ruby_names: false

data/test/test_parameters_validator.rb

@@ -20,7 +20,6 @@
 #
 # Tests validator methods.
 
-require 'rubygems'
 require 'test/unit'
 
 require 'ads_common/errors'

data/test/test_savon_service.rb

@@ -20,7 +20,6 @@
 #
 # Tests the array replies from services.
 
-require 'rubygems'
 require 'test/unit'
 
 require 'ads_common/config'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google-ads-common
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Sergio Gomes
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-16 00:00:00 +04:00
+date: 2012-03-13 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,43 +83,44 @@ dependencies:
         version: 0.4.5
   type: :runtime
   version_requirements: *id004
-description: google-ads-common provides essential utilities shared by all Ads Ruby client libraries.
-email: api.dklimkin@gmail.com
+description: Essential utilities shared by all Ads Ruby client libraries
+email: 
+- api.dklimkin@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
-- COPYING
-- ChangeLog
+extra_rdoc_files: []
+
 files: 
-- lib/ads_common/auth/client_login_handler.rb
-- lib/ads_common/auth/base_handler.rb
-- lib/ads_common/auth/oauth_handler.rb
-- lib/ads_common/credential_handler.rb
-- lib/ads_common/build/savon_generator.rb
-- lib/ads_common/build/savon_registry_generator.rb
-- lib/ads_common/build/savon_registry.rb
-- lib/ads_common/build/savon_service_generator.rb
-- lib/ads_common/build/savon_abstract_generator.rb
-- lib/ads_common/api_config.rb
-- lib/ads_common/config.rb
 - lib/ads_common/api.rb
-- lib/ads_common/savon_headers/base_header_handler.rb
-- lib/ads_common/savon_headers/simple_header_handler.rb
-- lib/ads_common/savon_headers/oauth_header_handler.rb
-- lib/ads_common/savon_headers/httpi_request_proxy.rb
+- lib/ads_common/version.rb
+- lib/ads_common/credential_handler.rb
 - lib/ads_common/savon_service.rb
+- lib/ads_common/api_config.rb
+- lib/ads_common/auth/client_login_handler.rb
+- lib/ads_common/auth/oauth_handler.rb
+- lib/ads_common/auth/base_handler.rb
 - lib/ads_common/http.rb
-- lib/ads_common/parameters_validator.rb
 - lib/ads_common/errors.rb
-- Rakefile
-- test/test_config.rb
-- test/test_parameters_validator.rb
+- lib/ads_common/parameters_validator.rb
+- lib/ads_common/savon_headers/oauth_header_handler.rb
+- lib/ads_common/savon_headers/base_header_handler.rb
+- lib/ads_common/savon_headers/httpi_request_proxy.rb
+- lib/ads_common/savon_headers/simple_header_handler.rb
+- lib/ads_common/build/savon_abstract_generator.rb
+- lib/ads_common/build/savon_service_generator.rb
+- lib/ads_common/build/savon_registry.rb
+- lib/ads_common/build/savon_registry_generator.rb
+- lib/ads_common/build/savon_generator.rb
+- lib/ads_common/config.rb
 - test/test_savon_service.rb
-- README
+- test/test_client_login_handler.rb
+- test/test_parameters_validator.rb
+- test/test_config.rb
+- test/test_config.yml
 - COPYING
+- README
 - ChangeLog
 has_rdoc: true
 homepage: http://code.google.com/p/google-api-ads-ruby/
@@ -144,18 +145,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: google-ads-common
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Common code for Google Ads APIs.
+summary: Common code for Google Ads APIs
 test_files: 
-- test/test_config.rb
-- test/test_parameters_validator.rb
 - test/test_savon_service.rb
+- test/test_client_login_handler.rb
+- test/test_parameters_validator.rb
+- test/test_config.rb

data/Rakefile

@@ -1,77 +0,0 @@
-# Encoding: utf-8
-#
-# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2010, 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.
-#
-# Rakefile for the ads_common package.
-
-require 'rubygems'
-require 'rubygems/package_task'
-require 'rake/testtask'
-require 'rdoc/task'
-require './lib/ads_common/api_config'
-
-GEM_NAME = 'google-ads-common'
-
-files = FileList['lib/**/*', 'Rakefile'].to_a
-tests = FileList['test/**/test_*.rb']
-docs = ['README', 'COPYING', 'ChangeLog']
-extra_files = ['test/test_config.yml']
-
-spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = GEM_NAME
-  s.version = AdsCommon::ApiConfig::ADS_COMMON_VERSION
-  s.summary = 'Common code for Google Ads APIs.'
-  s.description = ("%s provides essential utilities shared by all Ads Ruby " +
-      "client libraries.") % GEM_NAME
-  s.authors = ['Sergio Gomes', 'Danial Klimkin']
-  s.email = 'api.dklimkin@gmail.com'
-  s.homepage = 'http://code.google.com/p/google-api-ads-ruby/'
-  s.require_path = 'lib'
-  s.files = files
-  s.test_files = tests
-  s.has_rdoc = true
-  s.extra_rdoc_files = docs
-  s.add_dependency('savon', '~> 0.9.7')
-  s.add_dependency('httpclient', '~> 2.2.3')
-  s.add_dependency('httpi', '~> 0.9.3')
-  s.add_dependency('oauth', '~> 0.4.5')
-end
-
-desc 'Default target - build'
-task :default => [:package]
-
-# Create a task that will package the Common library into a gem file.
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-  pkg.package_files.include(extra_files)
-end
-
-# Create a task to build the RDOC documentation tree.
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title = "%s -- Common code for Google Ads APIs" % GEM_NAME
-  rdoc.main = 'README'
-  rdoc.rdoc_files.include(docs)
-  rdoc.rdoc_files.include(files)
-end
-
-# Create a task to perform the unit testing.
-Rake::TestTask.new do |t|
-  t.test_files = tests
-end