faraday-detailed_logger 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2977037d8f6588227b30e82bfd0c25e184c35fd
-  data.tar.gz: 26ebc6311679aef4db54a2d3eeeebc1a8415e22a
+  metadata.gz: 39391a10ebf6f5c1e3afd4a16142b4a7a5cf44de
+  data.tar.gz: 7c339da08c5eba109844ec73cc5fe555b7a32f06
 SHA512:
-  metadata.gz: 565f8d0ecb8a9b1e055c89b27e9692298f636fc525b4d077a3b7b08ebfde533294dd9a7b1f21e86425810b3168ef91f7b7e10cf921bbb358345e2d57b34fc0c9
-  data.tar.gz: e2e0d6698cc0681ed37022bb75df70832b0470c7fb4914c09f8101e6caaa2b1f51f730a44ab76af8f204710bf5fc450c1a965b7b1f45f878f478c0220920f6f1
+  metadata.gz: 5c4eb19555cb5d2062e6574f06c20c2104351ea4416912012296e323cc2c6c2b6f5a3342c6771cf350b7ddd5a997cc30a00e29a3d66298ff92e9afabb42834c9
+  data.tar.gz: 04c930843a10137ddccf41c45530519c25eebbd7e38e04e18f19ff207cb1686b449461a23df23ba01855a822502920f693c43ea925cf7c6d8c3babf35579794c

data/CHANGELOG.md

@@ -10,6 +10,18 @@
 
 * No significant changes.
 
+## [2.0.0][] / 2016-07-08
+
+* Remove Logger `progname` support/configuration. Varying the progname appears
+  to make logging in a syslog-like environment unnecessarily more difficult.
+* Add tagging support to the logger. Any number of tags may be given which will
+  be prepended to all lines logged. This is largely follows the
+  ActiveSupport::TaggedLogging log functionality. "Old" usages of this library
+  will treat any previous `progname` strings as a tag and continue to record
+  them to the log. Even though the progname is now logged as a tag, this is
+  still considered a breaking change just in case system configurations were
+  dependent on the progname for log output redirection (syslog).
+
 ## [1.1.0][] / 2016-06-15
 
 * Log HTTP 4XX and HTTP 5XX responses at a WARN level.
@@ -20,4 +32,5 @@
 
 [1.0.0]: https://github.com/envylabs/faraday-detailed_logger/tree/v1.0.0
 [1.1.0]: https://github.com/envylabs/faraday-detailed_logger/compare/v1.0.0...v1.1.0
-[HEAD]: https://github.com/envylabs/faraday-detailed_logger/compare/v1.1.0...master
+[2.0.0]: https://github.com/envylabs/faraday-detailed_logger/compare/v1.1.0...v2.0.0
+[HEAD]: https://github.com/envylabs/faraday-detailed_logger/compare/v2.0.0...master

data/README.md

@@ -75,6 +75,13 @@ Or, perhaps use your Rails logger:
 faraday.response :detailed_logger, Rails.logger
 ```
 
+Further, you might like to tag logged output to make it easily located in your
+logs:
+
+```ruby
+faraday.response :detailed_logger, Rails.logger, "Sushi Request"
+```
+
 ### Example output
 
 Because logs generally work best with a single line of data per entry, the

data/lib/faraday/detailed_logger/middleware.rb

@@ -1,4 +1,5 @@
 require "faraday"
+require "faraday/detailed_logger/tagged_logging"
 
 module Faraday
   module DetailedLogger
@@ -25,14 +26,14 @@ module Faraday
       # app - A Faraday-compatible middleware stack or application.
       # logger - A Logger-compatible object to which the log information will
       #          be recorded.
-      # progname - A String containing a program name to use when logging.
+      # tags - An optional array of tags to apply to the log output.
       #
       # Returns a Logger instance.
       #
-      def initialize(app, logger = nil, progname = nil)
+      def initialize(app, logger = nil, *tags)
         super(app)
-        @logger = logger || self.class.default_logger
-        @progname = progname
+        @logger = TaggedLogging.new(logger || self.class.default_logger)
+        @tags = tags
       end
 
       # Public: Used by Faraday to execute the middleware during the
@@ -43,8 +44,10 @@ module Faraday
       # Returns the result of the parent application execution.
       #
       def call(env)
-        @logger.info(@progname) { "#{env[:method].upcase} #{env[:url]}" }
-        @logger.debug(@progname) { curl_output(env[:request_headers], env[:body]).inspect }
+        logger.tagged(*tags) do
+          logger.info { "#{env[:method].upcase} #{env[:url]}" }
+          logger.debug { curl_output(env[:request_headers], env[:body]).inspect }
+        end
         super
       end
 
@@ -57,25 +60,31 @@ module Faraday
       #
       def on_complete(env)
         status = env[:status]
-        log_response_status(@progname, status) { "HTTP #{status}" }
-        @logger.debug(@progname) { curl_output(env[:response_headers], env[:body]).inspect }
+
+        logger.tagged(*tags) do
+          log_response_status(status) { "HTTP #{status}" }
+          logger.debug { curl_output(env[:response_headers], env[:body]).inspect }
+        end
       end
 
 
       private
 
 
+      attr_reader :logger
+      attr_reader :tags
+
       def curl_output(headers, body)
         string = headers.collect { |k,v| "#{k}: #{v}" }.join("\n")
         string + "\n\n#{body}"
       end
 
-      def log_response_status(progname, status, &block)
+      def log_response_status(status, &block)
         case status
         when 200..399
-          @logger.info(progname, &block)
+          logger.info(&block)
         else
-          @logger.warn(progname, &block)
+          logger.warn(&block)
         end
       end
     end

data/lib/faraday/detailed_logger/tagged_logging.rb

@@ -0,0 +1,75 @@
+require 'logger'
+
+module Faraday
+  module DetailedLogger
+    # This was largely lifted from ActiveSupport::TaggedLogging. Modifications
+    # made to remove ActiveSupport dependencies (blank?, delegation, and
+    # ActiveSupport::Logger).
+    #
+    module TaggedLogging
+      extend Forwardable
+
+      module Formatter
+        BLANK = lambda { |value| value.respond_to?(:empty?) ? !!value.empty? : !value }
+
+        def call(severity, timestamp, progname, msg)
+          super(severity, timestamp, progname, "#{tags_text}#{msg}")
+        end
+
+        def tagged(*tags)
+          new_tags = push_tags(*tags)
+          yield self
+        ensure
+          pop_tags(new_tags.size)
+        end
+
+        def push_tags(*tags)
+          tags.flatten.reject(&BLANK).tap do |new_tags|
+            current_tags.concat new_tags
+          end
+        end
+
+        def pop_tags(size = 1)
+          current_tags.pop size
+        end
+
+        def clear_tags!
+          current_tags.clear
+        end
+
+        def current_tags
+          @thread_key ||= "faraday_detailed_logger_tagged_logging_tags:#{object_id}".freeze
+          Thread.current[@thread_key] ||= []
+        end
+
+        private
+          def tags_text
+            tags = current_tags
+            if tags.any?
+              tags.collect { |tag| "[#{tag}] " }.join
+            end
+          end
+      end
+
+
+      def self.new(logger)
+        unless logger.respond_to?(:tagged)
+          logger.formatter ||= ::Logger::Formatter.new
+          logger.formatter.extend Formatter
+          logger.extend(self)
+        end
+
+        logger
+      end
+
+      def tagged(*tags)
+        formatter.tagged(*tags) { yield self }
+      end
+
+      def flush
+        clear_tags!
+        super if defined?(super)
+      end
+    end
+  end
+end

data/lib/faraday/detailed_logger/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module DetailedLogger
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-detailed_logger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Envy Labs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -119,6 +119,7 @@ files:
 - gemfiles/faraday_release.gemfile
 - lib/faraday/detailed_logger.rb
 - lib/faraday/detailed_logger/middleware.rb
+- lib/faraday/detailed_logger/tagged_logging.rb
 - lib/faraday/detailed_logger/version.rb
 homepage: https://github.com/envylabs/faraday-detailed_logger
 licenses: