pricehubble 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a6dec9a50e1bc53530adc56e69bccf3c0309b0c38b8819be5862ac01b78aa24
-  data.tar.gz: edb1ce1a5667290d8d8481edfeb41c39cffc09d35efea6a7e6f1d81f38f00095
+  metadata.gz: 708dc6002a8c92bc8cdcebbfd1d580c72d199644f343a650d19d9229dd90e86c
+  data.tar.gz: 59ea57131a818d6fa7af30743963c9e991b167a9e0d364bae6727dc86d91cd72
 SHA512:
-  metadata.gz: 4c02c6a1153849bbad1f2ba7f171a5b526be7fb6d42001f7419099901df2bf80abb61943948e3a2322e92ab202ef96122533f2c4887fd1c385db6fd3c4c897a9
-  data.tar.gz: ee651835c4f91e894a9967d5477cb44a9efb13dc64dbb3cde557b6315c71b8837806f6a9c3c2356e772c3a4b5e202870a8d7f7e399ea972cc336da1647e91386
+  metadata.gz: b416c6035d36d6266ab6968bd445feb5f964d1af09d9feff852cd998f34d5054ae33962e878fc6d1128ef6e19557154da22372a157f3e492a6bb37b936717dbe
+  data.tar.gz: 3511f1a0bdad3da7ce4f58214e59cc34b159b8012441df368193bff5b162ff6d799a49c5a0fbd6abd65c09f875c2ea1e7000d9c1a67c85a4fd034f5e3d28dfe0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.2.0
+
+* Added a configuration for request logging which is enabled by default now
+* Implemented a generic instrumentation facility
+* Improved the instrumentation and request logging facility (logs are colored
+  now to make local development easier and error handling was added to be more
+  robust on response issues)
+
 ### 0.1.0
 
 * Implemented a transparent authentication handling

data/README.md

@@ -65,8 +65,11 @@ PriceHubble.configure do |conf|
   # endpoint we know about)
   conf.base_url = 'https://api.pricehubble.com'
 
-  # Writes to stdout by default
+  # Writes to stdout by default, or use the Rails logger if present
   conf.logger = Logger.new(IO::NULL)
+
+  # Enable request logging or not
+  conf.request_logging = true
 end
 ```
 

data/lib/pricehubble.rb

@@ -25,6 +25,7 @@ module PriceHubble
   autoload :ConfigurationHandling, 'pricehubble/configuration_handling'
   autoload :Client, 'pricehubble/client'
   autoload :Identity, 'pricehubble/identity'
+  autoload :Instrumentation, 'pricehubble/instrumentation'
 
   # Entities
   autoload :BaseEntity, 'pricehubble/entity/base_entity'
@@ -46,6 +47,11 @@ module PriceHubble
     autoload :Bangers, 'pricehubble/utils/bangers'
   end
 
+  # Instrumentation
+  module Instrumentation
+    autoload :LogSubscriber, 'pricehubble/instrumentation/log_subscriber'
+  end
+
   # Dedicated application HTTP (low level) client
   module Client
     # All our utilities used for the low level client
@@ -100,4 +106,5 @@ module PriceHubble
   include PriceHubble::ConfigurationHandling
   include PriceHubble::Client
   include PriceHubble::Identity
+  include PriceHubble::Instrumentation
 end

data/lib/pricehubble/configuration.rb

@@ -22,5 +22,8 @@ module PriceHubble
 
       Logger.new($stdout)
     end
+
+    # Enable request logging or not
+    config_accessor(:request_logging) { true }
   end
 end

data/lib/pricehubble/instrumentation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PriceHubble
+  # Some instrumentation and logging facility helpers.
+  module Instrumentation
+    extend ActiveSupport::Concern
+
+    included do
+      # Add the log subscriber to the faraday namespace
+      PriceHubble::Instrumentation::LogSubscriber.attach_to :faraday
+    end
+  end
+end

data/lib/pricehubble/instrumentation/log_subscriber.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module PriceHubble
+  module Instrumentation
+    # Produce logs for requests.
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      # Return the PriceHubble SDK configured logger when logging is enabled.
+      # Otherwise +nil+ is returned and the subscriber is never started.
+      #
+      # @return [Logger, nil] the logger to use
+      def logger
+        return unless PriceHubble.configuration.request_logging
+
+        PriceHubble.configuration.logger
+      end
+
+      # Log request statistics and debugging details.
+      #
+      # @param event [ActiveSupport::Notifications::Event] the subscribed event
+      def request(event)
+        log_action_summary(event)
+        log_request_details(event)
+        log_response_details(event)
+      end
+
+      private
+
+      # Print some top-level request/action details.
+      #
+      # @param event [ActiveSupport::Notifications::Event] the subscribed event
+      def log_action_summary(event)
+        env = event.payload
+        info do
+          "[#{req_id(env)}] #{req_origin(env)} -> #{res_result(env)} " \
+            "(#{event.duration.round(1)}ms)"
+        end
+      end
+
+      # Print details about the request.
+      #
+      # @param event [ActiveSupport::Notifications::Event] the subscribed event
+      def log_request_details(event)
+        env = event.payload
+        debug do
+          "[#{req_id(env)}] #{req_dest(env)} > " \
+            "#{env.request_headers.sort.to_h.to_json}"
+        end
+      end
+
+      # When no response is available (due to timeout, DNS resolve issues, etc)
+      # we just can log an error without details. Otherwise print details about
+      # the response.
+      #
+      # @param event [ActiveSupport::Notifications::Event] the subscribed event
+      def log_response_details(event)
+        env = event.payload
+
+        if env.response.nil?
+          return error do
+            "[#{req_id(env)}] #{req_dest(env)} < #{res_result(env)}"
+          end
+        end
+
+        debug do
+          "[#{req_id(env)}] #{req_dest(env)} < " \
+            "#{env.response_headers.sort.to_h.to_json}"
+        end
+      end
+
+      # Format the request identifier.
+      #
+      # @param env [Faraday::Env] the request/response environment
+      # @return [String] the request identifier
+      def req_id(env)
+        env.request.context[:request_id].to_s
+      end
+
+      # Format the request/action origin.
+      #
+      # @param env [Faraday::Env] the request/response environment
+      # @return [String] the request identifier
+      def req_origin(env)
+        req = env.request.context
+        action = req[:action]
+        action = color(action, color_method(action), true)
+        client = req[:client].to_s.gsub('PriceHubble::Client', 'PriceHubble')
+        "#{client.underscore}##{action}"
+      end
+
+      # Format the request destination.
+      #
+      # @param env [Faraday::Env] the request/response environment
+      # @return [String] the request identifier
+      def req_dest(env)
+        method = env[:method].to_s.upcase
+        method = color(method, color_method(method), true)
+        url = env[:url].to_s.gsub(/access_token=[^&]+/,
+                                  'access_token=[FILTERED]')
+        "#{method} #{url}"
+      end
+
+      # Format the request result.
+      #
+      # @param env [Faraday::Env] the request/response environment
+      # @return [String] the request identifier
+      def res_result(env)
+        return color('no response', RED, true).to_s if env.response.nil?
+
+        status = env[:status]
+        color("#{status}/#{env[:reason_phrase]}", color_status(status), true)
+      end
+
+      # Decide which color to use for the given HTTP status code.
+      #
+      # @param status [Integer] the HTTP status code
+      # @return [String] the ANSI color code
+      def color_status(status)
+        case status
+        when 0..199 then MAGENTA
+        when 200..299 then GREEN
+        when 300..399 then YELLOW
+        when 400..599 then RED
+        else WHITE
+        end
+      end
+
+      # Decide which color to use for the given HTTP/client method.
+      #
+      # @param method [String] the method to inspect
+      # @return [String] the ANSI color code
+      def color_method(method)
+        case method
+        when /delete/i then RED
+        when /get|search|reload|find/i then BLUE
+        when /post|create/i then GREEN
+        when /put|patch|update/i then YELLOW
+        when /login|logout|download|query/i then CYAN
+        else MAGENTA
+        end
+      end
+    end
+  end
+end

data/lib/pricehubble/version.rb

@@ -2,5 +2,5 @@
 
 module PriceHubble
   # The version of the +price-hubble+ gem
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pricehubble
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -402,6 +402,8 @@ files:
 - lib/pricehubble/errors.rb
 - lib/pricehubble/faraday.rb
 - lib/pricehubble/identity.rb
+- lib/pricehubble/instrumentation.rb
+- lib/pricehubble/instrumentation/log_subscriber.rb
 - lib/pricehubble/railtie.rb
 - lib/pricehubble/utils/bangers.rb
 - lib/pricehubble/utils/decision.rb