google-ads-common 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f9fd925b1012604aaedfaba55ac60cd16fed3f3
-  data.tar.gz: 4a27eb4e56b52c99148be41fdcfc98946a9fd947
+  metadata.gz: 3267da5cdfdc5eef0f5653e99c6bd8329addb03f
+  data.tar.gz: 06334b9e716c913d333d49089f30fd2fc2158823
 SHA512:
-  metadata.gz: 1664c58b1bae120d33c4d890d4978c0702cd9caa65dffa39d146a985a42985df7bef92b93447d0c25f9a7158991f5371dce495943f2bc5f61bae5276081bb979
-  data.tar.gz: 71d90e5d480d8f17457261c13f8e61e2e573a72e27d42b1101fa8ba518fbcc920c75fa4fbed9fd3b285845305666e802f8721d6b9889a84de9def2a6e18b3b4d
+  metadata.gz: c1a6a5e280a2897d4443224111473de8f75a7db7550c9372364038418321c475473b50149e4d4f829e7be5f8b32445ed719fbdf39db8fa2b73df8ee57f4a9758
+  data.tar.gz: 9b1612f9cc4b39666296a48be14960801773d401763dceaaee115193b21531bb6462d3a788c43dad93b724cd4c4ca0c57929e3dc0154583309fc10d3a3b1c93a

data/ChangeLog

@@ -1,3 +1,6 @@
+0.14.0:
+  - Standardizing logging format for requests, response, and summary.
+
 0.13.0:
   - Removed support for p12 keyfiles for service accounts.
   - Fixed issue #27. You can now force a refresh when fetching the access token

data/lib/ads_common/credential_handler.rb

@@ -98,6 +98,12 @@ module AdsCommon
       @auth_handler = auth_handler
     end
 
+    # Get the unique identifier for the current account/network context. This
+    # is meant to be overriden by each client library.
+    def identifier()
+      return nil
+    end
+
     private
 
     # Loads the credentials from the config data.

data/lib/ads_common/savon_headers/base_header_handler.rb

@@ -73,6 +73,11 @@ module AdsCommon
         generate_headers(request, soap)
       end
 
+      # Returns the account/network identifier based on the current context.
+      def identifier()
+        return @credential_handler.identifier()
+      end
+
       private
 
       # Returns element name for SOAP header.

data/lib/ads_common/savon_service.rb

@@ -32,6 +32,7 @@ module AdsCommon
     attr_reader :namespace
 
     FALLBACK_API_ERROR_EXCEPTION = "ApiException"
+    MAX_FAULT_LOG_LENGTH = 16000
 
     # Creates a new service.
     def initialize(config, endpoint, namespace, version)
@@ -68,7 +69,7 @@ module AdsCommon
         AdsCommon::Http.configure_httpi(@config, httpi)
       end
       client.config.raise_errors = false
-      client.config.logger.subject = get_logger()
+      client.config.logger.subject = NoopLogger.new
       return client
     end
 
@@ -86,9 +87,9 @@ module AdsCommon
       registry = get_service_registry()
       validator = ParametersValidator.new(registry)
       args = validator.validate_args(action_name, args)
-      response = handle_soap_request(
+      request_info, response = handle_soap_request(
           action_name.to_sym, false, args, validator.extra_namespaces)
-      log_headers(response.http.headers)
+      do_logging(action_name, request_info, response)
       handle_errors(response)
       extractor = ResultsExtractor.new(registry)
       result = extractor.extract_result(response, action_name, &block)
@@ -96,24 +97,20 @@ module AdsCommon
       return result
     end
 
-    # Logs response headers.
-    # TODO: this needs to go on http or httpi level.
-    def log_headers(headers)
-      get_logger().debug(headers.map {|k, v| [k, v].join(': ')}.join(', '))
-    end
-
     # Executes the SOAP request with original SOAP name.
     def handle_soap_request(action, xml_only, args, extra_namespaces)
       original_action_name =
           get_service_registry.get_method_signature(action)[:original_name]
       original_action_name = action if original_action_name.nil?
+      request_info = nil
       response = @client.request(original_action_name) do |soap, wsdl, http|
         soap.body = args
         @header_handler.prepare_request(http, soap)
         soap.namespaces.merge!(extra_namespaces) unless extra_namespaces.nil?
         return soap.to_xml if xml_only
+        request_info = RequestInfo.new(soap.to_xml, http.headers, http.url)
       end
-      return response
+      return request_info, response
     end
 
     # Checks for errors in response and raises appropriate exception.
@@ -166,5 +163,103 @@ module AdsCommon
       end
       return nil
     end
+
+    # Log the request, response, and summary lines.
+    def do_logging(action, request, response)
+      logger = get_logger()
+      return unless should_log_summary(logger.level, response.soap_fault?)
+
+      response_hash = response.hash
+
+      soap_headers = {}
+      begin
+        soap_headers = response_hash[:envelope][:header][:response_header]
+      rescue NoMethodError
+        # If there are no headers, just ignore. We'll log what we know.
+      end
+
+      summary_message = ('ID: %s, URL: %s, Service: %s, Action: %s, Response ' +
+          'time: %sms, Request ID: %s') % [@header_handler.identifier,
+          request.url, self.class.to_s.split("::").last, action,
+          soap_headers[:response_time], soap_headers[:request_id]]
+      if soap_headers[:operations]
+        summary_message += ', Operations: %s' % soap_headers[:operations]
+      end
+      summary_message += ', Is fault: %s' % response.soap_fault?
+
+      request_message = nil
+      response_message = nil
+
+      if should_log_payloads(logger.level, response.soap_fault?)
+        request_message = 'Outgoing request: %s %s' %
+            [format_headers(request.headers), sanitize_request(request.body)]
+        response_message = 'Incoming response: %s %s' %
+            [format_headers(response.http.headers), response.http.body]
+      end
+
+      if response.soap_fault?
+        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
+      else
+        logger.info(summary_message)
+        logger.debug(request_message) if request_message
+        logger.debug(response_message) if response_message
+      end
+    end
+
+    # Format headers, redacting sensitive information.
+    def format_headers(headers)
+      return headers.map do |k, v|
+        v = 'REDACTED' if k == 'Authorization'
+        [k, v].join(': ')
+      end.join(', ')
+    end
+
+    # Sanitize the request body, redacting sensitive information.
+    def sanitize_request(body)
+      body.gsub(/developerToken>[a-zA-Z0-9_\-]+<\//,
+          'developerToken>REDACTED</')
+    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
+    end
+
+    # Check whether or not to log request summaries based on log level.
+    def should_log_summary(level, is_fault)
+      # Fault summaries log at WARN.
+      return level <= Logger::WARN if is_fault
+      # Success summaries log at INFO.
+      return level <= Logger::INFO
+    end
+
+    # Check whether or not to log payloads based on log level.
+    def should_log_payloads(level, is_fault)
+      # Fault payloads log at INFO.
+      return level <= Logger::INFO if is_fault
+      # Success payloads log at DEBUG.
+      return level <= Logger::DEBUG
+    end
+
+    class RequestInfo
+      attr_accessor :body, :headers, :url
+
+      def initialize(body, headers, url)
+        @body, @headers, @url = body, headers, url
+      end
+    end
+
+    class NoopLogger
+      def method_missing(m, *args, &block)
+        nil
+      end
+    end
   end
 end

data/lib/ads_common/version.rb

@@ -19,6 +19,6 @@
 
 module AdsCommon
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.13.0'
+    CLIENT_LIB_VERSION = '0.14.0'
   end
 end

data/test/test_savon_service.rb

@@ -19,6 +19,7 @@
 # Tests the array replies from services.
 
 require 'test/unit'
+require 'logger'
 
 require 'ads_common/config'
 require 'ads_common/savon_service'
@@ -27,6 +28,8 @@ require 'ads_common/savon_service'
 class StubService < AdsCommon::SavonService
 
   public :get_service_registry, :get_module
+  public :format_headers, :sanitize_request, :format_fault
+  public :should_log_summary, :should_log_payloads
 
   def initialize(namespace, endpoint, version)
     @logger = Logger.new(STDERR)
@@ -64,4 +67,59 @@ class TestSavonService < Test::Unit::TestCase
   def test_get_module_abstract()
     assert_raises(NoMethodError) { @stub_service.get_module() }
   end
+
+  def test_format_headers()
+    test1 = {
+      'header1' => 'value1',
+      'header2' => 'value2'
+    }
+    expected1 = "header1: value1, header2: value2"
+    test2 = {
+      'Authorization' => 'Bearer ABCD',
+      'header3' => 'value3'
+    }
+    expected2 = "Authorization: REDACTED, header3: value3"
+    assert_equal(expected1, @stub_service.format_headers(test1))
+    assert_equal(expected2, @stub_service.format_headers(test2))
+  end
+
+  def test_sanitize_request()
+    test1 = "<some_xml><developerToken>ab1cdEF2GH-IJ3KL_mn4OP" +
+        "</developerToken></some_xml>"
+    expected1 = "<some_xml><developerToken>REDACTED</developerToken></some_xml>"
+    test2 = "<xml><element1></element1><element2></element2></xml>"
+    test3 = "<xml><ns1:developerToken>w-x_Y-Z_</ns1:developerToken></xml>"
+    expected3 = "<xml><ns1:developerToken>REDACTED</ns1:developerToken></xml>"
+    assert_equal(expected1, @stub_service.sanitize_request(test1))
+    assert_equal(test2, @stub_service.sanitize_request(test2))
+    assert_equal(expected3, @stub_service.sanitize_request(test3))
+  end
+
+  def test_format_fault()
+    test1 = "fault\nwith\nnewlines\nand\nunicode\n\u2713\n"+
+        "\u3084\u3063\u305F".encode('utf-8')
+    expected1 = "fault with newlines and unicode \u2713 \u3084\u3063\u305F"
+    test2 = "This needs to be more than 16000 characters......." * 1000
+    expected2 = "This needs to be more than 16000 characters......." * 320
+    assert(test2.length > AdsCommon::SavonService::MAX_FAULT_LOG_LENGTH)
+    assert(expected2.length == AdsCommon::SavonService::MAX_FAULT_LOG_LENGTH)
+    assert_equal(expected1, @stub_service.format_fault(test1))
+    assert_equal(expected2, @stub_service.format_fault(test2))
+  end
+
+  def test_log_levels()
+    assert_equal(true, @stub_service.should_log_payloads(Logger::DEBUG, true))
+    assert_equal(true, @stub_service.should_log_payloads(Logger::DEBUG, false))
+    assert_equal(true, @stub_service.should_log_payloads(Logger::INFO, true))
+    assert_equal(false, @stub_service.should_log_payloads(Logger::INFO, false))
+    assert_equal(false, @stub_service.should_log_payloads(Logger::WARN, true))
+    assert_equal(false, @stub_service.should_log_payloads(Logger::WARN, false))
+
+    assert_equal(true, @stub_service.should_log_summary(Logger::INFO, true))
+    assert_equal(true, @stub_service.should_log_summary(Logger::INFO, false))
+    assert_equal(true, @stub_service.should_log_summary(Logger::WARN, true))
+    assert_equal(false, @stub_service.should_log_summary(Logger::WARN, false))
+    assert_equal(false, @stub_service.should_log_summary(Logger::ERROR, true))
+    assert_equal(false, @stub_service.should_log_summary(Logger::ERROR, false))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-ads-common
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Sergio Gomes
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-savon