rack-traffic-logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ca028e1a99d48ccc15d12bbe7173a46b1b10c8c
+  data.tar.gz: 59f69d7fd8ea9ba939d58f9620f68fb7fade8747
+SHA512:
+  metadata.gz: b404dc7d0092b9c5e3945ac38b992e14eb3cbfa2a204cfb6c60c495ae57235be3cca7631a0174914af25a2fd05ab037612523f59b5ff40aba16469d6e9125364
+  data.tar.gz: 3838f643eae3525c4ca23e3a9602634b8f41958f268f2673627c673de07e844ba558faa9e4e8c9c98b9744c47c9d58e5ebe2fc2964643df418e8a23896fa51b3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Neil E. Pearson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Rack::TrafficLogger
+
+TODO: Write a gem description

data/lib/rack/traffic_logger.rb

@@ -0,0 +1,116 @@
+require_relative 'traffic_logger/version'
+require_relative 'traffic_logger/logger'
+
+require 'forwardable'
+require 'rack/nulllogger'
+
+module Rack
+  class TrafficLogger
+    extend Forwardable
+
+    PUBLIC_ATTRIBUTES = {
+        request_headers:  {type: [TrueClass, FalseClass], default: true},
+        request_bodies:   {type: [TrueClass, FalseClass], default: true},
+        response_headers: {type: [TrueClass, FalseClass], default: true},
+        response_bodies:  {type: [TrueClass, FalseClass], default: true},
+        colors: {type: [TrueClass, FalseClass], default: false}
+    }
+
+    PUBLIC_ATTRIBUTES.each do |attr, props|
+      type = props[:type]
+      type = [type] unless Array === type
+      define_method(attr) { @options[attr] }
+      define_method :"#{attr}=" do |value|
+        raise "Expected one of [#{type.map(&:name).join ' | '}], got #{value.class.name}" unless type.find { |t| t === value }
+        @options[attr] = value
+      end
+    end
+
+    delegate %i(info debug warn error fatal) => :@logger
+
+    def initialize(app, logger = nil, options = {})
+      Raise "Expected a Hash, but got #{options.class.name}" unless Hash === options
+      @app = app
+      case logger
+        when nil, false then logger = Logger.new(STDOUT)
+        when String, IO then logger = Logger.new(logger)
+        else logger = Rack::NullLogger.new(nil) unless logger.respond_to? :debug
+      end
+      @logger = logger
+      @options = self.class.default_options.merge(options)
+    end
+
+    def call(env)
+      log_request! env
+      @app.call(env).tap { |response| log_response! env, response }
+    end
+
+    private
+
+    def self.default_options
+      @default_options ||= PUBLIC_ATTRIBUTES.map { |k, v| [k, v[:default]] }.to_h
+    end
+
+    REQUEST_TEMPLATES = {
+        true => "%s %s%s HTTP/%s",
+        false => "%s %s%s HTTP/%s"
+    }
+
+    def log_request!(env)
+      debug REQUEST_TEMPLATES[colors] % [
+        env['REQUEST_METHOD'],
+        env['PATH_INFO'],
+        (q = env['QUERY_STRING']).empty? ? '' : "?#{q}",
+        env['HTTP_VERSION'] || '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
+      end
+    end
+
+    RESPONSE_TEMPLATES = {
+        true => "HTTP/%s %s %s",
+        false => "HTTP/%s %s %s"
+    }
+
+    def log_response!(env, response)
+      debug RESPONSE_TEMPLATES[colors] % [
+          env['HTTP_VERSION'] || '1.1',
+          code = response[0],
+          Rack::Utils::HTTP_STATUS_CODES[code]
+      ]
+      log_headers! response[1] if response_headers
+      log_body! response[2].join if response_bodies
+    end
+
+    def log_body!(body)
+      info body
+    end
+
+    HEADER_TEMPLATES = {
+        true => "%s: %s\n",
+        false => "%s: %s\n"
+    }
+
+    def log_headers!(headers)
+      info headers.map { |k, v| HEADER_TEMPLATES[colors] % [k, v] }.join
+    end
+
+    def env_request_headers(env)
+      env.select do |k, _|
+        k =~ /^(CONTENT|HTTP)_/
+      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
+    end
+
+  end
+end

data/lib/rack/traffic_logger/echo.rb

@@ -0,0 +1,12 @@
+require_relative '../traffic_logger'
+require 'json'
+
+module Rack
+  class TrafficLogger
+    class Echo
+      def call(env)
+        JSON.parse env['rack.input'].tap(&:rewind).read
+      end
+    end
+  end
+end

data/lib/rack/traffic_logger/logger.rb

@@ -0,0 +1,9 @@
+require 'logger'
+
+module Rack
+  class TrafficLogger
+    class Logger < ::Logger
+
+    end
+  end
+end

data/lib/rack/traffic_logger/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class TrafficLogger
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: rack-traffic-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neil E. Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Rack Middleware for logging raw incoming/outgoing HTTP traffic
+email:
+- neil@helium.net.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rack/traffic_logger.rb
+- lib/rack/traffic_logger/echo.rb
+- lib/rack/traffic_logger/logger.rb
+- lib/rack/traffic_logger/version.rb
+homepage: https://github.com/hx/rack-traffic-logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rack Raw HTTP Traffic Logger
+test_files: []
+has_rdoc: