rack-traffic-logger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb0252e73380f08bce1a1fd885b7d1274efb5ea
-  data.tar.gz: 52c68544ff792ba5a11b98d6eef256f5dedf2bf6
+  metadata.gz: f26f03dcdb7e324d22fe2d1eef5c171d2b0a2a7e
+  data.tar.gz: 4dc100276db42b05d2d57673ec9a633de4ecef8a
 SHA512:
-  metadata.gz: 3d4540743bb8c876d8dda6196b32d548044bfac62f7736704f2aa7cef441749debaced16d1fb62a6988b89e272bb67e542b8f43755dd35d77a13babd925deb31
-  data.tar.gz: e4486d2c17aff30b74771273df3a5095dce62c1621101dad5549aca5cce7ac8d116a0d47c11395e87c617c874074fe82e73638207a1bd835bcc6986044017d09
+  metadata.gz: b03a20d01b1c64ff07d84c450c21e4ecdba97626c0c892cc6c1a331a569c4ab10e64cb3a2e9e47f68c2e408b3c828fb5f01ed0e428670c69a49c1486fa721663
+  data.tar.gz: 6281b3c7a221db00a86e1d4eb6178b75fc53bac6e506922a742580cb823922f06dc7ab04f8a3a35593ff757091d05258f08b0150a10d42bb301c3a916606bc8c

data/README.md

@@ -1,3 +1,25 @@
 # Rack::TrafficLogger
 
-TODO: Write a gem description
+This is simple Rack middleware for logging incoming/outgoing HTTP/S traffic.
+
+## Installation
+
+```bash
+gem install rack-traffic-logger
+```
+
+## Usage
+
+```ruby
+require 'rack/traffic_logger'
+```
+
+Then, in your `config.ru` or wherever you set up your middleware stack:
+
+```ruby
+use Rack::TrafficLogger, 'path/to/file.log', response_bodies: false, colors: true
+```
+
+- If you don't provide a log, everything will go to `STDOUT`.
+- You can supply either the path to a log file, an open file handle, or an instance of `Logger`.
+- See [this file](https://github.com/hx/rack-traffic-logger/blob/develop/lib/rack/traffic_logger.rb) for a list of other options that can affect logging style/filtering.

data/lib/rack/traffic_logger/echo.rb

@@ -6,7 +6,7 @@ module Rack
     class Echo
       def call(env)
         begin
-          JSON.parse env['rack.input'].tap(&:rewind).read
+          [200, {'Content-Type' => 'application/json'}, [JSON.parse(env['rack.input'].tap(&:rewind).read)]]
         rescue JSON::ParserError => error
           [
               500,

data/lib/rack/traffic_logger/header_hash.rb

@@ -0,0 +1,25 @@
+module Rack
+  class TrafficLogger
+    class HeaderHash < Hash
+
+      def initialize(source = nil)
+        source.each { |k, v| self[k] = v } if Hash === source
+      end
+
+      def [](key)
+        super normalize_key key
+      end
+
+      def []=(key, value)
+        super normalize_key(key), value
+      end
+
+      private
+
+      def normalize_key(key)
+        key.to_s.split(/[_ -]/).map { |word| word[0].upcase << word[1..-1].downcase }.join('-')
+      end
+
+    end
+  end
+end

data/lib/rack/traffic_logger/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class TrafficLogger
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/rack/traffic_logger.rb

@@ -1,5 +1,6 @@
 require_relative 'traffic_logger/version'
 require_relative 'traffic_logger/logger'
+require_relative 'traffic_logger/header_hash'
 
 require 'forwardable'
 require 'rack/nulllogger'
@@ -66,11 +67,16 @@ module Rack
                    path: env['PATH_INFO'],
                    qs: (q = env['QUERY_STRING']).empty? ? '' : "?#{q}",
                    http: env['HTTP_VERSION'] || 'HTTP/1.1'
-      log_headers! env_request_headers(env) if request_headers
-      input = env['rack.input']
-      if request_bodies && input
-        log_body! input.read
-        input.rewind
+      if request_headers || request_bodies
+        headers = HeaderHash.new(env_request_headers env)
+        log_headers! headers if request_headers
+        input = env['rack.input']
+        if request_bodies && input
+          log_body! input.read,
+                    type: headers['Content-Type'],
+                    encoding: headers['Content-Encoding']
+          input.rewind
+        end
       end
     end
 
@@ -93,11 +99,23 @@ module Rack
                    code: code = response[0],
                    status: Rack::Utils::HTTP_STATUS_CODES[code],
                    color: status_color(code)
-      log_headers! response[1] if response_headers
-      log_body! response[2].join if response_bodies
+      if response_headers || response_bodies
+        headers = HeaderHash.new(response[1])
+        log_headers! headers if response_headers
+        if response_bodies
+          body = response[2]
+          body = ::File.open(body.path, 'rb') { |f| f.read } if body.respond_to? :path
+          body = body.tap(&:rewind).read if body.respond_to? :read
+          body = body.join if body.respond_to? :join
+          log_body! body,
+                    type: headers['Content-Type'],
+                    encoding: headers['Content-Encoding']
+        end
+      end
     end
 
-    def log_body!(body)
+    def log_body!(body, type: nil, encoding: nil)
+      body = "<#BINARY #{body.bytes.length} bytes>" if body =~ /[^[:print:]]/
       info body
     end
 
@@ -111,16 +129,7 @@ module Rack
     end
 
     def env_request_headers(env)
-      env.select do |k, _|
-        k =~ /^(CONTENT|HTTP)_(?!VERSION)/
-      end.map do |(k, v)|
-        [
-            k.sub(/^HTTP_/, '').split(/[_ -]/).map do |word|
-              word[0].upcase << word[1..-1].downcase
-            end.join('-'),
-            v
-        ]
-      end.to_h
+      env.select { |k, _| k =~ /^(CONTENT|HTTP)_(?!VERSION)/ }.map { |(k, v)| [k.sub(/^HTTP_/, ''), v] }.to_h
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-traffic-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Neil E. Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -35,6 +35,7 @@ files:
 - README.md
 - lib/rack/traffic_logger.rb
 - lib/rack/traffic_logger/echo.rb
+- lib/rack/traffic_logger/header_hash.rb
 - lib/rack/traffic_logger/logger.rb
 - lib/rack/traffic_logger/version.rb
 homepage: https://github.com/hx/rack-traffic-logger