google-adwords-api 0.4.4 → 0.4.5

data/ChangeLog

@@ -1,3 +1,8 @@
+0.4.5:
+  - Support for GZip compression.
+  - Support for returnMoneyInMicros header.
+  - Require google-ads-common 0.6.1 or later from now on.
+
 0.4.4:
   - Support for CreateAccountService.
   - Require google-ads-common 0.6.0 or later from now on.

data/README

@@ -28,8 +28,7 @@ which is installed automatically as a dependency.
 
 The following gem libraries are required:
   - savon v0.9.7
-  - httpclient v2.1.2 or greater
-  - google-ads-common v0.6.0 or later.
+  - google-ads-common v0.6.1 or later.
 
 
 == 2 - Using the client library:
@@ -156,6 +155,18 @@ This information can be obtained by passing a user block during method call:
 You can also retrieve the response body as the second block parameter:
   report_def_srv.get(selector) {|header, body| ... }
 
+=== 2.5 - GZip compression
+
+The library offers a transparent compression option which can be enabled in the
+configuration file or by the following setting:
+
+   config[:connection] = {
+     :enable_gzip => true
+   }
+
+Enabling this option will set the headers required to request the server to
+respond in gzipped format. All requests are sent uncompressed regardless.
+
 
 = Docs for Developers
 

data/Rakefile

@@ -25,6 +25,12 @@ require 'rake/testtask'
 require './lib/adwords_api/api_config'
 require './lib/adwords_api/extensions'
 
+# Workaround for the current mess of different yamlers in Ruby world.
+if RUBY_VERSION>='1.9.2'
+  gem 'psych'
+  YAML::ENGINE.yamler = 'psych'
+end
+
 # Google common ads library used for wrapper code generation.
 gem 'google-ads-common'
 require 'ads_common/build/savon_generator'
@@ -48,7 +54,7 @@ spec = Gem::Specification.new do |s|
   s.test_files = tests
   s.has_rdoc = true
   s.extra_rdoc_files = docs
-  s.add_dependency('google-ads-common', '~> 0.6.0')
+  s.add_dependency('google-ads-common', '~> 0.6.1')
   s.add_dependency('savon', '= 0.9.7')
 end
 

data/lib/adwords_api.rb

@@ -20,7 +20,7 @@
 #
 # Contains the main classes for the client library.
 
-gem 'google-ads-common', '~>0.6.0'
+gem 'google-ads-common', '~>0.6.1'
 
 require 'ads_common/api'
 require 'ads_common/auth/oauth_handler'

data/lib/adwords_api/api_config.rb

@@ -41,7 +41,7 @@ module AdwordsApi
 
     # Set other constants
     API_NAME = 'AdwordsApi'
-    CLIENT_LIB_VERSION = '0.4.4'
+    CLIENT_LIB_VERSION = '0.4.5'
     DEFAULT_CONFIG_FILENAME = 'adwords_api.yml'
 
     # Configure the services available to each version

data/lib/adwords_api/extensions.rb

@@ -245,6 +245,11 @@ module AdwordsApi
       elsif credentials[:email]
         headers['clientEmail'] = credentials[:email]
       end
+      money_in_micros =
+          wrapper.api.config.read('library.return_money_in_micros')
+      unless money_in_micros.nil?
+        headers['returnMoneyInMicros'] = money_in_micros
+      end
       return headers
     end
 

data/lib/adwords_api/report_utils.rb

@@ -124,12 +124,22 @@ module AdwordsApi
       auth_string = auth_handler.auth_string(
           credentials, HTTPI::Request.new(url))
       customer_id = validate_cid(cid || credentials[:clientCustomerId])
+      app_name = credentials[:userAgent] || credentials[:useragent]
       headers = {
           'Authorization' => auth_string,
           'ClientCustomerId' => customer_id,
           'Content-Type' => 'multipart/form-data',
-          'developerToken' => credentials[:developerToken]
+          'developerToken' => credentials[:developerToken],
+          'User-Agent' => "HTTPI/%s (%s)" % [HTTPI::VERSION, app_name]
       }
+      if @api.config.read('connection.enable_gzip', false)
+        headers['User-Agent'] += ' (gzip)'
+        headers['Accept-Encoding'] = 'gzip,deflate'
+      end
+      money_in_micros = @api.config.read('library.return_money_in_micros')
+      unless money_in_micros.nil?
+        headers['returnMoneyInMicros'] = money_in_micros
+      end
       return headers
     end
 
@@ -157,7 +167,8 @@ module AdwordsApi
     def check_for_errors(response)
       # Check for error in body.
       report_body = response.body
-      if report_body
+      if report_body and
+          ((RUBY_VERSION < '1.9.1') or report_body.valid_encoding?)
         error_message_regex = '^!!!(-?\d+)\|\|\|(-?\d+)\|\|\|(.*)\?\?\?'
         data = report_body.slice(0, 1024)
         matches = data.match(error_message_regex)

data/lib/adwords_api/utils.rb

@@ -1,8 +1,8 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -46,12 +46,9 @@ module AdwordsApi
     # - index for the source operation, nil if none
     #
     def self.operation_index_for_error(error)
-      if error and error[:field_path]
-        parts = error[:field_path].split('.')
-        if parts.length > 0
-          match = parts.first.match(/operations\[(\d)\]/)
-          return match ? match[1].to_i : nil
-        end
+      if error and error[:field_path] and error[:field_path].kind_of?(String)
+        match = error[:field_path].match(/operations\[(\d+)\]/)
+        return match ? match[1].to_i : nil
       end
       return nil
     end

data/test/adwords_api/test_report_utils.rb

@@ -51,6 +51,7 @@ REPLY_TYPES = [
 ]
 
 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
   # Initialize tests.
@@ -107,4 +108,14 @@ class TestReportUtils < Test::Unit::TestCase
       end
     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
 end

data/test/adwords_api/test_utils.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+#
+# 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 utils.
+
+require 'rubygems'
+require 'test/unit'
+require 'adwords_api/utils'
+
+class TestUtils < Test::Unit::TestCase
+  def test_map
+    param1 = [
+      {:key => 'foo', :value => 'bar'},
+      {:key => 'baz', :value => 'zar'},
+    ]
+    result1 = {'foo' => 'bar', 'baz' => 'zar'}
+    assert_equal(result1, AdwordsApi::Utils::map(param1))
+
+    param2 = []
+    result2 = {}
+    assert_equal(result2, AdwordsApi::Utils::map(param2))
+  end
+
+  def test_operation_index_for_error
+    error1 = {:field_path => 'operations[0].operand.adGroupId'}
+    assert_equal(0, AdwordsApi::Utils::operation_index_for_error(error1))
+
+    error2 = {:field_path => 'operations[10].operand.adGroupId'}
+    assert_equal(10, AdwordsApi::Utils::operation_index_for_error(error2))
+
+    error3 = {:field_path => 'unknown'}
+    assert_equal(nil, AdwordsApi::Utils::operation_index_for_error(error3))
+  end
+
+  def test_format_id
+    assert_equal('123-456-7890', AdwordsApi::Utils::format_id(1234567890))
+    assert_equal('234-567-8901', AdwordsApi::Utils::format_id('2345678901'))
+    assert_equal('345-678-9012', AdwordsApi::Utils::format_id('345-678-9012'))
+    assert_equal('456-789-0123',
+                 AdwordsApi::Utils::format_id('CID: 456-789-0123'))
+    assert_equal('012-345-6789', AdwordsApi::Utils::format_id('0123-4567-89'))
+    assert_equal('123', AdwordsApi::Utils::format_id('123'))
+    assert_equal('234', AdwordsApi::Utils::format_id(234))
+  end
+end

metadata

@@ -1,63 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: google-adwords-api
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 4
-  version: 0.4.4
+version: !ruby/object:Gem::Version
+  version: 0.4.5
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Danial Klimkin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-02 00:00:00 +04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: google-ads-common
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &82715310 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 0
-        version: 0.6.0
+      - !ruby/object:Gem::Version
+        version: 0.6.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: savon
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *82715310
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &82714480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 7
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.9.7
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *82714480
 description: google-adwords-api is a AdWords API client library for Ruby
 email: api.dklimkin@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
 - COPYING
 - ChangeLog
-files: 
+files:
 - lib/adwords_api/v13/account_service_registry.rb
 - lib/adwords_api/v13/report_service_registry.rb
 - lib/adwords_api/v13/account_service.rb
@@ -573,42 +557,36 @@ files:
 - test/bugs/test_issue_00000031.rb
 - test/adwords_api/test_api_config.rb
 - test/adwords_api/test_report_utils.rb
+- test/adwords_api/test_utils.rb
 - README
 - COPYING
 - ChangeLog
-has_rdoc: true
 homepage: http://code.google.com/p/google-api-ads-ruby/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby Client libraries for AdWords API
-test_files: 
+test_files:
 - test/bugs/test_issue_00000031.rb
 - test/adwords_api/test_api_config.rb
 - test/adwords_api/test_report_utils.rb
+- test/adwords_api/test_utils.rb