rack-traffic-logger 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14b29cb8230446091b0ff4d48a732e4cb907381c
-  data.tar.gz: 28bf54115618158d68942804a366894a3cc59537
+  metadata.gz: d4602c2181807d0305806dda404a27aca2715695
+  data.tar.gz: 5fc0fa9b637279c1be407da67f3af6b7e5667190
 SHA512:
-  metadata.gz: f3deff06a541bab57142e46c2f11a077c4dc9ea662e11585f7f4df00836a8d50a45a65f4d9317c93afca930382ef694be3fa56404553f70079d39b455763ede1
-  data.tar.gz: 71d3bebc92b6b9e4587a25826f18813feb76a901e1c990b3b578dd06945137d5c2e71a632f994882a09fe6b32a8e25a89a56820f531461f881d8050b09de6116
+  metadata.gz: 0c35048dcf21d51d2b727007d0e311dee8cfa4bc42e65fc8302c44c9f6d1b8cf0271da2239cf68e6d54aa7c369292e0b56b048748e2ada9a148ab1e6a5b5a9e7
+  data.tar.gz: 6a7fd9b6535e0976e9bd28b3eed605eda8346c166f421dab5ef1f7b5c06e69e1ecbe0ad273e16ee59ae81f82b1bb0440e56ab547347cd6437647864ea1198722

data/README.md

@@ -215,3 +215,26 @@ use Rack::TrafficLogger, 'file.log', Rack::TrafficLogger::Formatter::JSON.new(pr
 ```
 
 Note that if you do, log parsers may have a hard time understanding your logs if they expect each event to be on a single line. If you think this could be an issue, use the first method instead.
+
+## Usage with Faraday
+
+If you use [Faraday](https://github.com/lostisland/faraday), you can log outbound HTTP traffic using the included middleware adapter.
+
+```ruby
+Faraday.new(url: 'http://localhost') do |builder|
+    builder.use Rack::TrafficLogger::FaradayAdapter, Rails.root.join('log/http_out.log').to_s
+    builder.adapter Faraday.default_adapter
+end
+```
+
+You can also use express setup:
+
+```ruby
+Faraday.new(url: 'http://localhost') do |builder|
+  Rack::TrafficLogger::FaradayAdapter.use on: builder,
+                                          filter: ENV['LOG_OUTBOUND_HTTP'],
+                                          formatter: Rack::TrafficLogger::Formatter::JSON.new,
+                                          log_path: Rails.root.join('log/http_out.log').to_s
+  builder.adapter Faraday.default_adapter
+end
+```

data/lib/rack/traffic_logger.rb

@@ -5,6 +5,8 @@ require_relative 'traffic_logger/stream_simulator'
 require_relative 'traffic_logger/formatter'
 require_relative 'traffic_logger/reader'
 require_relative 'traffic_logger/express_setup'
+require_relative 'traffic_logger/request'
+require_relative 'traffic_logger/faraday_adapter'
 
 require 'json'
 require 'securerandom'
@@ -25,7 +27,7 @@ module Rack
         REMOTE_ADDR
       ]
 
-    attr_reader :app, :options
+    attr_reader :options
 
     def initialize(app, log_path, *options)
       @app = app
@@ -35,7 +37,15 @@ module Rack
     end
 
     def call(env)
-      Request.new(self).call env
+      request = Request.new(self)
+      request.start env
+      response = nil
+      begin
+        response = @app.call(env)
+      ensure
+        request.finish response
+      end
+      response
     end
 
     def log(hash)
@@ -50,108 +60,5 @@ module Rack
       end
     end
 
-    private
-
-    class Request
-
-      def initialize(logger)
-        @logger = logger
-        @id = SecureRandom.hex 4
-        @started_at = Time.now
-      end
-
-      def call(env)
-        @verb = env['REQUEST_METHOD']
-        @env = env
-        begin
-          response = @logger.app.call(env)
-        ensure
-          @code = Array === response ? response.first.to_i : 0
-          @options = @logger.options.for(@verb, @code)
-          if @options.basic?
-            log_request env
-            log_response env, response if @code > 0
-          end
-        end
-      end
-
-      private
-
-      BASIC_AUTH_PATTERN = /^basic ([a-z\d+\/]+={0,2})$/i
-
-      def log_request(env)
-        log 'request' do |hash|
-          if @options.request_headers?
-            hash.merge! env.reject { |_, v| v.respond_to? :read }
-          else
-            hash.merge! env.select { |k, _| BASIC_ENV_PROPERTIES.include? k }
-          end
-
-          hash['BASIC_AUTH_USERINFO'] = $1.unpack('m').first.split(':', 2) if hash['HTTP_AUTHORIZATION'] =~ BASIC_AUTH_PATTERN
-
-          input = env['rack.input']
-          if input && @options.request_bodies?
-            add_body_to_hash input.tap(&:rewind).read, env['CONTENT_ENCODING'] || env['HTTP_CONTENT_ENCODING'], hash
-            input.rewind
-          end
-        end
-      end
-
-      def log_response(env, response)
-        code, headers, body = response
-        code = code.to_i
-        headers = HeaderHash.new(headers) if @options.response_headers? || @options.response_bodies?
-        log 'response' do |hash|
-          hash['http_version'] = env['HTTP_VERSION'] || 'HTTP/1.1'
-          hash['status_code'] = code
-          hash['status_name'] = Utils::HTTP_STATUS_CODES[code]
-          hash['headers'] = headers if @options.response_headers?
-          add_body_to_hash get_real_body(body), headers['Content-Encoding'], hash if @options.response_bodies?
-        end
-      end
-
-      # Rack allows response bodies to be a few different things. This method
-      # ensures we get a string back.
-      def get_real_body(body)
-
-        # For bodies representing temporary files
-        body = File.open(body.path, 'rb') { |f| f.read } if body.respond_to? :path
-
-        # For bodies representing streams
-        body = body.read.tap { body.rewind } if body.respond_to? :read
-
-        # When body is an array (the common scenario)
-        body = body.join if body.respond_to? :join
-
-        # When body is a proxy
-        body = body.body while Rack::BodyProxy === body
-
-        # It should be a string now. Just in case it's not...
-        body.to_s
-
-      end
-
-      def add_body_to_hash(body, encoding, hash)
-        body = Zlib::GzipReader.new(StringIO.new body).read if encoding == 'gzip'
-        body.force_encoding 'UTF-8'
-        if body.valid_encoding?
-          hash['body'] = body
-        else
-          hash['body_base64'] = [body].pack 'm0'
-        end
-      end
-
-      def log(event)
-        hash = {
-            timestamp: Time.now,
-            request_log_id: @id,
-            event: event
-        }
-        yield hash rescue hash.merge! error: $!
-        @logger.log hash
-      end
-
-    end
-
   end
 end

data/lib/rack/traffic_logger/express_setup.rb

@@ -1,10 +1,10 @@
 module Rack
   class TrafficLogger
 
-    def self.use(on: nil, filter: '', log_path: '/dev/stdout', formatter: nil)
+    def self.use(on: nil, filter: true, log_path: '/dev/stdout', formatter: nil)
       filter = (filter || '').to_s.downcase.strip
       unless ['0', 'no', 'false', 'nil', 'none', '', 'off'].include? filter
-        args = [Rack::TrafficLogger, log_path]
+        args = [self, log_path]
         args << formatter if formatter
         begin
           raise if %w[1 yes true normal basic minimal on].include? filter

data/lib/rack/traffic_logger/faraday_adapter.rb

@@ -0,0 +1,50 @@
+module Rack
+  class TrafficLogger
+    # noinspection RubyStringKeysInHashInspection
+    class FaradayAdapter < TrafficLogger
+
+      def call(request_env)
+        rack_env = convert_request(request_env)
+        request = Request.new(self)
+        request.start rack_env
+        @app.call(request_env).on_complete do |response_env|
+          rack_response = convert_response(response_env)
+          request.finish rack_response
+        end
+      end
+
+      private
+
+      def convert_request(faraday_env)
+        url = faraday_env.url
+        {
+            'REQUEST_METHOD' => faraday_env.method.to_s.upcase,
+            'SERVER_NAME' => url.host,
+            'SERVER_PORT' => url.port,
+            'PATH_INFO' => url.path,
+            'HTTP_VERSION' => 'HTTP/1.1', # TODO: can this be obtained?
+            'REMOTE_HOST' => 'localhost',
+            'REMOTE_ADDR' => '127.0.0.1'
+        }.tap do |hash|
+          hash['HTTPS'] = 'on' if url.scheme == 'https'
+          hash['QUERY_STRING'] = url.query if url.query
+          hash.merge!(faraday_env.request_headers.map do |k, v|
+            k = k.gsub('-', '_').upcase
+            k = "HTTP_#{k}" unless k.start_with? 'CONTENT_'
+            [k, v]
+          end.to_h)
+          hash['rack.input'] = StringIO.new(faraday_env.body) if faraday_env.body
+        end
+      end
+
+      def convert_response(faraday_env)
+        [
+            faraday_env.status,
+            faraday_env.response_headers,
+            [faraday_env.body]
+        ]
+      end
+
+    end
+  end
+end

data/lib/rack/traffic_logger/formatter/json.rb

@@ -3,7 +3,7 @@ require 'json'
 module Rack
   class TrafficLogger
     class Formatter
-      class JSON < self
+      class JSON < Formatter
 
         def initialize(pretty_print: false)
           formatter = pretty_print ?

data/lib/rack/traffic_logger/formatter/stream.rb

@@ -1,16 +1,17 @@
+require 'time'
+
 module Rack
   class TrafficLogger
     class Formatter
-      class Stream < self
+      class Stream < Formatter
 
         def initialize(**options)
           @simulator = StreamSimulator.new(**options)
         end
 
         def format(hash)
-          time = hash[:timestamp]
-          id = hash[:request_log_id]
-          "@ #{time.strftime '%a %d %b \'%y %T'}.#{'%d' % (time.usec / 1e4)} ##{id}\n#{@simulator.format(hash)}\n\n"
+          time = Time.parse(hash['timestamp'])
+          "@ #{time.strftime '%a %d %b \'%y %T.%3N'} ##{hash['request_log_id']}\n#{@simulator.format(hash)}\n\n"
         end
 
       end

data/lib/rack/traffic_logger/reader.rb

@@ -35,9 +35,6 @@ module Rack
       def writeline(line)
         begin
           hash = JSON.parse(line)
-          hash[:timestamp] = Time.parse(hash['timestamp'])
-          hash[:request_log_id] = hash['request_log_id']
-          hash[:event] = hash['event']
           @output << @formatter.format(hash)
         rescue
           @output << line

data/lib/rack/traffic_logger/request.rb

@@ -0,0 +1,104 @@
+module Rack
+  class TrafficLogger
+    class Request
+
+      def initialize(logger)
+        @logger = logger
+        @id = SecureRandom.hex 4
+        @started_at = Time.now
+      end
+
+      def start(env)
+        @verb = env['REQUEST_METHOD']
+        @env = env
+      end
+
+      def finish(response)
+        @code = Array === response ? response.first.to_i : 0
+        @options = @logger.options.for(@verb, @code)
+        if @options.basic?
+          log_request @env
+          log_response @env, response if @code > 0
+        end
+      end
+
+      private
+
+      BASIC_AUTH_PATTERN = /^basic ([a-z\d+\/]+={0,2})$/i
+
+      def log_request(env)
+        log 'request' do |hash|
+          if @options.request_headers?
+            hash.merge! env.reject { |_, v| v.respond_to? :read }
+          else
+            hash.merge! env.select { |k, _| BASIC_ENV_PROPERTIES.include? k }
+          end
+
+          hash['BASIC_AUTH_USERINFO'] = $1.unpack('m').first.split(':', 2) if hash['HTTP_AUTHORIZATION'] =~ BASIC_AUTH_PATTERN
+
+          input = env['rack.input']
+          if input && @options.request_bodies?
+            add_body_to_hash input.tap(&:rewind).read, env['CONTENT_ENCODING'] || env['HTTP_CONTENT_ENCODING'], hash
+            input.rewind
+          end
+        end
+      end
+
+      def log_response(env, response)
+        code, headers, body = response
+        code = code.to_i
+        headers = HeaderHash.new(headers) if @options.response_headers? || @options.response_bodies?
+        log 'response' do |hash|
+          hash['http_version'] = env['HTTP_VERSION'] || 'HTTP/1.1'
+          hash['status_code'] = code
+          hash['status_name'] = Utils::HTTP_STATUS_CODES[code]
+          hash['headers'] = headers if @options.response_headers?
+          add_body_to_hash get_real_body(body), headers['Content-Encoding'], hash if @options.response_bodies?
+        end
+      end
+
+      # Rack allows response bodies to be a few different things. This method
+      # ensures we get a string back.
+      def get_real_body(body)
+
+        # For bodies representing temporary files
+        body = File.open(body.path, 'rb') { |f| f.read } if body.respond_to? :path
+
+        # For bodies representing streams
+        body = body.read.tap { body.rewind } if body.respond_to? :read
+
+        # When body is an array (the common scenario)
+        body = body.join if body.respond_to? :join
+
+        # When body is a proxy
+        body = body.body while Rack::BodyProxy === body
+
+        # It should be a string now. Just in case it's not...
+        body.to_s
+
+      end
+
+      def add_body_to_hash(body, encoding, hash)
+        body = Zlib::GzipReader.new(StringIO.new body).read if encoding == 'gzip'
+        body.force_encoding 'UTF-8'
+        if body.valid_encoding?
+          hash['body'] = body
+        else
+          hash['body_base64'] = [body].pack 'm0'
+        end
+      end
+
+      def log(event)
+        # noinspection RubyStringKeysInHashInspection
+        hash = {
+            'timestamp' => Time.now.strftime('%FT%T.%3N%:z'),
+            'request_log_id' => @id,
+            'event' => event
+        }
+        yield hash rescue hash.merge! error: $!
+        @logger.log hash
+      end
+
+    end
+  end
+end

data/lib/rack/traffic_logger/stream_simulator.rb

@@ -8,7 +8,7 @@ module Rack
       end
 
       def format(input)
-        case input[:event]
+        case input['event']
           when 'request' then format_request input
           when 'response' then format_response input
           else nil
@@ -38,7 +38,7 @@ module Rack
         result = render REQUEST_TEMPLATES[@color],
                         verb: input['REQUEST_METHOD'],
                         path: input['PATH_INFO'],
-                        qs: (q = input['QUERY_STRING']).empty? ? '' : "?#{q}",
+                        qs: (q = input['QUERY_STRING'] || '').empty? ? '' : "?#{q}",
                         http: input['HTTP_VERSION'] || 'HTTP/1.1'
         result << format_headers(env_request_headers input)
         result << format_body(input, input['CONTENT_TYPE'] || input['HTTP_CONTENT_TYPE'])

data/lib/rack/traffic_logger/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class TrafficLogger
-    VERSION = '0.2.4'
+    VERSION = '0.2.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-traffic-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Neil E. Pearson
@@ -38,6 +38,7 @@ files:
 - lib/rack/traffic_logger.rb
 - lib/rack/traffic_logger/echo.rb
 - lib/rack/traffic_logger/express_setup.rb
+- lib/rack/traffic_logger/faraday_adapter.rb
 - lib/rack/traffic_logger/formatter.rb
 - lib/rack/traffic_logger/formatter/json.rb
 - lib/rack/traffic_logger/formatter/stream.rb
@@ -45,6 +46,7 @@ files:
 - lib/rack/traffic_logger/option_interpreter.rb
 - lib/rack/traffic_logger/option_interpreter/shorthand.rb
 - lib/rack/traffic_logger/reader.rb
+- lib/rack/traffic_logger/request.rb
 - lib/rack/traffic_logger/stream_simulator.rb
 - lib/rack/traffic_logger/version.rb
 homepage: https://github.com/hx/rack-traffic-logger