google-ads-common 0.11.2 → 0.11.3

data/ChangeLog

@@ -1,3 +1,9 @@
+0.11.3:
+  - Fixes Github Issue 81
+    https://github.com/googleads/google-api-ads-ruby/issues/81
+  - Added support for custom library-specific user agent tags.
+  - Updating signet dependency to 0.7.0.
+
 0.11.2:
   - Updated required version of ads_savon to 1.0.1 to fix issue #74.
   - Updated default adapter for httpi to httpclient, to fix various errors

data/lib/ads_common/credential_handler.rb

@@ -18,6 +18,7 @@
 # Generic class to handle credentials across client libraries.
 
 require 'ads_common/api_config'
+require 'thread'
 
 module AdsCommon
   class CredentialHandler
@@ -26,6 +27,8 @@ module AdsCommon
     def initialize(config)
       @config = config
       @auth_handler = nil
+      @extra_user_agents = {}
+      @extra_user_agents_lock = Mutex.new
       load_from_config(config)
     end
 
@@ -64,6 +67,18 @@ module AdsCommon
       @auth_handler.property_changed(credential, value) if @auth_handler
     end
 
+    # Adds a custom string to the user agent, one time, the next time a user
+    # agent is generated. This will be rendered in the format "name/suffix",
+    # or just "name" if the suffix is nil or omitted.
+    def include_in_user_agent(name, suffix = nil)
+      return if name.nil?
+      unless @config.read('library.include_utilities_in_user_agent') == false
+        @extra_user_agents_lock.synchronize do
+          @extra_user_agents[name] = suffix
+        end
+      end
+    end
+
     # Generates string for UserAgent to put into headers.
     def generate_user_agent(extra_ids = [], agent_app = nil)
       agent_app ||= File.basename($0)
@@ -74,6 +89,7 @@ module AdsCommon
       agent_data << [ruby_engine, RUBY_VERSION].join('/')
       agent_data << 'HTTPI/%s' % HTTPI::VERSION
       agent_data << HTTPI::Adapter.use.to_s
+      agent_data += get_extra_user_agents()
       return '%s (%s)' % [agent_app, agent_data.join(', ')]
     end
 
@@ -88,5 +104,17 @@ module AdsCommon
     def load_from_config(config)
       @credentials = config.read('authentication')
     end
+
+    # Generates an array of extra user agents to include in the user agent
+    # string.
+    def get_extra_user_agents()
+      @extra_user_agents_lock.synchronize do
+        user_agents = @extra_user_agents.collect do |k, v|
+          v.nil? ? k : '%s/%s' % [k, v]
+        end
+        @extra_user_agents.clear
+        return user_agents
+      end
+    end
   end
 end

data/lib/ads_common/savon_service.rb

@@ -31,6 +31,8 @@ module AdsCommon
     attr_reader :version
     attr_reader :namespace
 
+    FALLBACK_API_ERROR_EXCEPTION = "ApiException"
+
     # Creates a new service.
     def initialize(config, endpoint, namespace, version)
       if self.class() == AdsCommon::SavonService
@@ -132,7 +134,9 @@ module AdsCommon
         fault = response[:fault]
         if fault[:detail] and fault[:detail][:api_exception_fault]
           exception_fault = fault[:detail][:api_exception_fault]
-          exception_name = exception_fault[:application_exception_type]
+          exception_name = (
+              exception_fault[:application_exception_type] ||
+              FALLBACK_API_ERROR_EXCEPTION)
           exception_class = get_module().const_get(exception_name)
           return exception_class.new(exception_fault)
         elsif fault[:faultstring]

data/lib/ads_common/version.rb

@@ -19,6 +19,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.11.2'
+    CLIENT_LIB_VERSION = '0.11.3'
   end
 end

data/test/test_credential_handler.rb

@@ -64,6 +64,30 @@ class TestCredentialHandler < Test::Unit::TestCase
     assert_match(/#{Regexp.escape(test_str)}/, result1)
   end
 
+  def test_generate_user_agent_include_simple()
+    test_str = 'Tester'
+    @handler.include_in_user_agent(test_str)
+    result1 = @handler.generate_user_agent()
+    assert_kind_of(String, result1)
+    assert_match(/#{Regexp.escape(test_str)}/, result1)
+    result2 = @handler.generate_user_agent()
+    assert_kind_of(String, result2)
+    assert_no_match(/#{Regexp.escape(test_str)}/, result2)
+  end
+
+  def test_generate_user_agent_include_version()
+    test_str = 'Tester/0.2.0'
+    argument1 = 'Tester'
+    argument2 = '0.2.0'
+    @handler.include_in_user_agent(argument1, argument2)
+    result1 = @handler.generate_user_agent()
+    assert_kind_of(String, result1)
+    assert_match(/#{Regexp.escape(test_str)}/, result1)
+    result2 = @handler.generate_user_agent()
+    assert_kind_of(String, result2)
+    assert_no_match(/#{Regexp.escape(test_str)}/, result2)
+  end
+
   def test_auth_handler_callback_once()
     mock = MiniTest::Mock.new()
     mock.expect(:property_changed,  nil, [:foo, 'bar'])

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-common
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
+  prerelease: 
 platform: ruby
 authors:
 - Sergio Gomes
@@ -10,76 +11,86 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-savon
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: httpi
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
   name: signet
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 10.4.2
 description: Essential utilities shared by all Ads Ruby client libraries
@@ -89,71 +100,72 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- COPYING
-- ChangeLog
-- README.md
 - lib/ads_common/api.rb
-- lib/ads_common/api_config.rb
+- lib/ads_common/version.rb
+- lib/ads_common/errors.rb
 - lib/ads_common/auth/base_handler.rb
-- lib/ads_common/auth/oauth2_handler.rb
 - lib/ads_common/auth/oauth2_service_account_handler.rb
-- lib/ads_common/build/savon_abstract_generator.rb
-- lib/ads_common/build/savon_generator.rb
+- lib/ads_common/auth/oauth2_handler.rb
+- lib/ads_common/credential_handler.rb
+- lib/ads_common/api_config.rb
+- lib/ads_common/utils.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_service_generator.rb
+- lib/ads_common/build/savon_abstract_generator.rb
+- lib/ads_common/build/savon_generator.rb
 - lib/ads_common/config.rb
-- lib/ads_common/credential_handler.rb
-- lib/ads_common/errors.rb
-- lib/ads_common/http.rb
 - lib/ads_common/parameters_validator.rb
-- lib/ads_common/results_extractor.rb
 - lib/ads_common/savon_headers/base_header_handler.rb
 - lib/ads_common/savon_headers/oauth_header_handler.rb
+- lib/ads_common/results_extractor.rb
+- lib/ads_common/http.rb
 - lib/ads_common/savon_service.rb
-- lib/ads_common/utils.rb
-- lib/ads_common/version.rb
-- test/coverage.rb
+- test/test_env.rb
 - test/suite_unittests.rb
+- test/coverage.rb
+- test/test_results_extractor.rb
 - test/test_config.rb
-- test/test_config.yml
+- test/test_utils.rb
 - test/test_credential_handler.rb
-- test/test_env.rb
 - test/test_oauth2_handler.rb
-- test/test_parameters_validator.rb
-- test/test_results_extractor.rb
 - test/test_savon_service.rb
-- test/test_utils.rb
+- test/test_config.yml
+- test/test_parameters_validator.rb
+- COPYING
+- README.md
+- ChangeLog
 homepage: https://github.com/googleads/google-api-ads-ruby
 licenses:
 - Apache-2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: google-ads-common
-rubygems_version: 2.4.8
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Common code for Google Ads APIs
 test_files:
-- test/test_savon_service.rb
+- test/test_env.rb
+- test/test_results_extractor.rb
 - test/test_config.rb
-- test/test_credential_handler.rb
 - test/test_utils.rb
-- test/test_parameters_validator.rb
+- test/test_credential_handler.rb
 - test/test_oauth2_handler.rb
-- test/test_env.rb
-- test/test_results_extractor.rb
+- test/test_savon_service.rb
+- test/test_parameters_validator.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 10caed5a26897a25b34a734be2e882529abc2441
-  data.tar.gz: f6e2f2cc9495b2998e84a4a1e47e3934a354f161
-SHA512:
-  metadata.gz: 31cafd81ea5bb9e67fef47cc9f407d86b1a6e14affc28e1afadf51ca172dd9ffd353d7082bee6ddbd1992332a12d9116957fdf939b784a38cb50b162a66c9ecf
-  data.tar.gz: 3aa55e15e0253bcf914a231bedb054171bc1f99148ab45b6f21bad8ec6b89df94a66b6ba21bbe89f3d9628d3f2d987f87fe0d73bc941c369075ab57e5e34f94f