google-ads-common 0.14.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 991111457e7120b976a506c037b0fd935aa5c6f9
-  data.tar.gz: 0a769071c1c36367d1b5f484290584f43401bf72
+  metadata.gz: 3323c13c66ba24618874eabc9af72432dbc1aba7
+  data.tar.gz: 8e7c3178e7f7dfb61a04a406e904cd7880babb5d
 SHA512:
-  metadata.gz: 95974d42f490a7b4395089032f09afd8e570289831120fd51a95cad0fec249150e0a89a26cf4dbfe5286cd886c622ab9ba6f4ff695a74c403ee61e3cfda8a19f
-  data.tar.gz: 3bcc749b38ab140d2b994bdd2ae01bbf13a34947574412f49498b64f5c83d488bd355503bc399c5b76e49106d048e218099d0132e49a64afc8baa32973062a2b
+  metadata.gz: 760fcea64ff72ae3f9e5bc7ba2af0bb73937174a6b6287753685557c20a460b5f53c7798e9e9382d5e4cebe44904220e6e6e1bc53f73a5f48c959e1749987aef
+  data.tar.gz: 58d901837aee9ba0a8d5c322232c88dda558567b4e1450fd2e072d783dcda421e2854af51dbe17298318b591007fad9a5d112a00ddd5b02c40ab2bdfe9cbc548

data/ChangeLog

@@ -1,3 +1,11 @@
+1.0.0:
+  - Major version bump. The library has been stable and feature complete for
+    some time, and this is more accurately reflected by this version number.
+  - Throw explicit warning for disabled SSL peer verification.
+  - Small performance improvements for large requests.
+  - No longer include test files in the built gem.
+  - Removing support for multiple environments.
+
 0.14.1:
   - Scrubbing an additional sensitive field present in some AdWords requests.
 

data/README.md

@@ -68,7 +68,7 @@ Google Ads Developers Plus page:
 
 # Copyright/License Info
 
-Copyright 2010-2015, Google Inc. All Rights Reserved.
+Copyright 2010-2017, Google Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/ads_common/api.rb

@@ -70,10 +70,9 @@ module AdsCommon
     def service(name, version = nil)
       name = name.to_sym
       version = (version.nil?) ? api_config.default_version : version.to_sym
-      environment = @config.read('service.environment')
 
       # Check if the combination is available.
-      validate_service_request(environment, version, name)
+      validate_service_request(version, name)
 
       # Try to re-use the service for this version if it was requested before.
       wrapper = if @wrappers.include?(version) && @wrappers[version][name]
@@ -150,12 +149,11 @@ module AdsCommon
     private
 
     # Auxiliary method to test parameters correctness for the service request.
-    def validate_service_request(environment, version, service)
-      # Check if the current environment supports the requested version.
-      unless api_config.environment_has_version(environment, version)
+    def validate_service_request(version, service)
+      # Check if the current config supports the requested version.
+      unless api_config.has_version(version)
         raise AdsCommon::Errors::Error,
-            "Environment '%s' does not support version '%s'" %
-            [environment.to_s, version.to_s]
+            "Version '%s' not recognized" % version.to_s
       end
 
       # Check if the specified version has the requested service.
@@ -196,18 +194,14 @@ module AdsCommon
           raise AdsCommon::Errors::Error,
               'OAuth authorization method is deprecated, use OAuth2 instead.'
         when :OAUTH2
-          environment = @config.read('service.environment',
-              api_config.default_environment())
           AdsCommon::Auth::OAuth2Handler.new(
               @config,
-              api_config.environment_config(environment, :oauth_scope)
+              api_config.config(:oauth_scope)
           )
         when :OAUTH2_SERVICE_ACCOUNT
-          environment = @config.read('service.environment',
-              api_config.default_environment())
           AdsCommon::Auth::OAuth2ServiceAccountHandler.new(
               @config,
-              api_config.environment_config(environment, :oauth_scope)
+              api_config.config(:oauth_scope)
           )
         else
           raise AdsCommon::Errors::Error,
@@ -226,15 +220,13 @@ module AdsCommon
     # - a simplified wrapper generated for the service
     #
     def prepare_wrapper(version, service)
-      environment = config.read('service.environment')
       api_config.do_require(version, service)
-      endpoint = api_config.endpoint(environment, version, service)
+      endpoint = api_config.endpoint(version, service)
       interface_class_name = api_config.interface_name(version, service)
 
       wrapper = class_for_path(interface_class_name).new(@config, endpoint)
       auth_handler = get_auth_handler()
-      header_ns =
-          api_config.environment_config(environment, :header_ns) + version.to_s
+      header_ns = api_config.config(:header_ns) + version.to_s
       soap_handler = soap_header_handler(auth_handler, version, header_ns,
                                          wrapper.namespace)
       wrapper.header_handler = soap_handler
@@ -270,10 +262,8 @@ module AdsCommon
       provided_adapter = @config.read('connection.adapter')
       @config.set('connection.adapter', :httpclient) if provided_adapter.nil?
 
-      # Validating most important parameters.
-      ['service.environment', 'authentication.method'].each do |parameter|
-        symbolize_config_value(parameter)
-      end
+      # Make sure Auth param is a symbol.
+      symbolize_config_value('authentication.method')
     end
 
     # Converts value of a config key to uppercase symbol.

data/lib/ads_common/api_config.rb

@@ -42,14 +42,13 @@ module AdsCommon
       service_config.keys.select { |service| service.is_a? Integer }.max
     end
 
-    # Does the given environment exist and contain the given version?
+    # Does the current config contain the given version?
     #
     # Returns:
-    # Boolean indicating whether the given environment exists and contains the
-    # given version
+    # Boolean indicating whether the current config contains the given version
     #
-    def environment_has_version(environment, version)
-      return !environment_config(environment, version).nil?
+    def has_version(version)
+      return !config(version).nil?
     end
 
     # Does the given version exist and contain the given service?
@@ -94,32 +93,22 @@ module AdsCommon
       return api_name.to_s.snakecase
     end
 
-    # Get the default environment.
-    #
-    # Returns:
-    # Default environment
-    #
-    def default_environment
-      raise NotImplementedError, 'default_environment not overriden.'
-    end
-
     # Get the default filename for the config file.
     def default_config_filename
       raise NotImplementedError, 'default_config_filename not overriden.'
     end
 
-    # Get the endpoint for a service on a given environment and API version.
+    # Get the endpoint for a service on a given API version.
     #
     # Args:
-    # - environment: the service environment to be used
     # - version: the API version
     # - service: the name of the API service
     #
     # Returns:
     # The endpoint URL
     #
-    def endpoint(environment, version, service)
-      base = get_wsdl_base(environment, version)
+    def endpoint(version, service)
+      base = get_wsdl_base(version)
       # TODO(dklimkin): Unflatten subdir constants. Cross-API refactor 0.9.0.
       if !subdir_config().nil?
         base = base.to_s + subdir_config()[[version, service]].to_s
@@ -142,19 +131,6 @@ module AdsCommon
       subdir_config()[[version, service]]
     end
 
-    # Get the authentication server details for an environment. Allows to
-    # override the auth URL via environmental variable.
-    #
-    # Args:
-    # - environment: the service environment to be used
-    #
-    # Returns:
-    # The full URL for the auth server
-    #
-    def auth_server(environment)
-      return ENV['ADSAPI_AUTH_URL'] || auth_server_config[environment]
-    end
-
     # Perform the loading of the necessary source files for a version.
     #
     # Args:
@@ -208,7 +184,7 @@ module AdsCommon
     #
     def get_wsdls(version)
       res = {}
-      wsdl_base = get_wsdl_base(default_environment(), version)
+      wsdl_base = get_wsdl_base(version)
       postfix = wsdl_base.start_with?('http') ? '?wsdl' : '.wsdl'
       services(version).each do |service|
         path = wsdl_base
@@ -226,15 +202,13 @@ module AdsCommon
     # the base URL via environmental variable.
     #
     # Args:
-    #   - environment: environment to use like :SANDBOX or :PRODUCTION
     #   - version: the API version
     #
     # Returns:
     #   String containing base URL
     #
-    def get_wsdl_base(environment, version)
-      return ENV['ADSAPI_BASE_URL'] ||
-          environment_config(environment, version)
+    def get_wsdl_base(version)
+      return ENV['ADSAPI_BASE_URL'] || config(version)
     end
   end
 end

data/lib/ads_common/http.rb

@@ -120,6 +120,10 @@ module AdsCommon
       strict_ssl =
           config.read('connection.strict_ssl_verification', true)
       httpi.auth.ssl.verify_mode = strict_ssl ? :peer : :none
+      if logger && !strict_ssl
+        logger.warn('HTTPS peer validation is disabled. This is NOT ' +
+            'secure and NOT recommended.')
+      end
     end
   end
 end

data/lib/ads_common/savon_service.rb

@@ -33,6 +33,7 @@ module AdsCommon
 
     FALLBACK_API_ERROR_EXCEPTION = "ApiException"
     MAX_FAULT_LOG_LENGTH = 16000
+    REDACTED_STR = 'REDACTED'
 
     # Creates a new service.
     def initialize(config, endpoint, namespace, version)
@@ -201,38 +202,35 @@ module AdsCommon
         summary_message += ', Fault message: %s' % format_fault(
             response_hash[:envelope][:body][:fault][:faultstring])
         logger.warn(summary_message)
-        logger.info(request_message) if request_message
-        logger.info(response_message) if response_message
+        logger.info(request_message) unless request_message.nil?
+        logger.info(response_message) unless response_message.nil?
       else
         logger.info(summary_message)
-        logger.debug(request_message) if request_message
-        logger.debug(response_message) if response_message
+        logger.debug(request_message) unless request_message.nil?
+        logger.debug(response_message) unless response_message.nil?
       end
     end
 
     # Format headers, redacting sensitive information.
     def format_headers(headers)
       return headers.map do |k, v|
-        v = 'REDACTED' if k == 'Authorization'
+        v = REDACTED_STR if k == 'Authorization'
         [k, v].join(': ')
       end.join(', ')
     end
 
     # Sanitize the request body, redacting sensitive information.
     def sanitize_request(body)
-      body = body.gsub(/developerToken>[^<]+<\//,
-          'developerToken>REDACTED</')
-      body = body.gsub(/httpAuthorizationHeader>[^<]+<\//,
-          'httpAuthorizationHeader>REDACTED</')
-      return body
+      return body.gsub(/(developerToken>|httpAuthorizationHeader>)[^<]+(<\/)/,
+          '\1' + REDACTED_STR + '\2')
     end
 
     # Format the fault message by capping length and removing newlines.
     def format_fault(message)
-      message = message[0...MAX_FAULT_LOG_LENGTH] if
-          message.length > MAX_FAULT_LOG_LENGTH
-      message = message.gsub("\n", " ")
-      return message
+      if message.length > MAX_FAULT_LOG_LENGTH
+        message = message[0, MAX_FAULT_LOG_LENGTH]
+      end
+      return message.gsub("\n", ' ')
     end
 
     # Check whether or not to log request summaries based on log level.

data/lib/ads_common/utils.rb

@@ -23,8 +23,7 @@ module AdsCommon
 
       # Returns the String in lowerCamelCase.
       def lower_camelcase()
-        result = dup()
-        result.gsub!(/^([A-Z])/) {$1.downcase()}
+        result = gsub(/^([A-Z])/) {$1.downcase()}
         result.gsub!(/(?:_)([a-zA-Z\d])/) {$1.upcase()}
         return result
       end

data/lib/ads_common/version.rb

@@ -19,6 +19,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.14.1'
+    CLIENT_LIB_VERSION = '1.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-common
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sergio Gomes
@@ -10,13 +10,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
   type: :runtime
@@ -24,6 +27,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
 - !ruby/object:Gem::Dependency
@@ -60,18 +66,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 10.4.2
@@ -79,6 +88,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 10.4.2
@@ -114,18 +126,6 @@ files:
 - lib/ads_common/savon_service.rb
 - lib/ads_common/utils.rb
 - lib/ads_common/version.rb
-- test/coverage.rb
-- test/suite_unittests.rb
-- test/test_config.rb
-- test/test_config.yml
-- test/test_credential_handler.rb
-- test/test_env.rb
-- test/test_oauth2_handler.rb
-- test/test_oauth2_service_account_handler.rb
-- test/test_parameters_validator.rb
-- test/test_results_extractor.rb
-- test/test_savon_service.rb
-- test/test_utils.rb
 homepage: https://github.com/googleads/google-api-ads-ruby
 licenses:
 - Apache-2.0
@@ -146,17 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: google-ads-common
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Common code for Google Ads APIs
-test_files:
-- test/test_savon_service.rb
-- test/test_config.rb
-- test/test_oauth2_service_account_handler.rb
-- test/test_credential_handler.rb
-- test/test_utils.rb
-- test/test_parameters_validator.rb
-- test/test_oauth2_handler.rb
-- test/test_env.rb
-- test/test_results_extractor.rb
+test_files: []

data/test/coverage.rb

@@ -1,33 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-#
-# Runs test with coverage tool.
-
-require 'simplecov'
-
-SimpleCov.start
-
-$:.unshift File.expand_path('../../', __FILE__)
-require File.join(File.dirname(__FILE__), 'suite_unittests.rb')
-
-# Now loading all files in the library to make sure we hit all untested files.
-lib_base_path = File.expand_path('../../lib', __FILE__)
-$:.unshift lib_base_path
-
-code_files_mask = File.join(lib_base_path, '**/*.rb')
-Dir.glob(code_files_mask).each {|file| require file}

data/test/suite_unittests.rb

@@ -1,28 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 suite for unit tests.
-
-require 'test/unit'
-
-$:.unshift File.expand_path('../../lib/', __FILE__)
-$:.unshift File.expand_path('../../', __FILE__)
-
-# Ads Common units tests.
-test_files_mask = File.join(File.dirname(__FILE__), 'test_*.rb')
-Dir.glob(test_files_mask).each {|file| require file}