marcopolo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 273c7f6bc3a4dc54e700b022bf0d079789f23ee2
+  data.tar.gz: c38e36b80fe9b021019a66e6d47ebdbb80553157
+SHA512:
+  metadata.gz: bc4bf97a33318d3df0cfcc456048bf8fd262a728a354c53d244febd31b3b87883dc146a92639f1d84b34f4d2736407d20559eddf5aa7510712d985d4efc8228e
+  data.tar.gz: 42199344fafdb02820dc276bf15f1fe1eb44b064819612690798461595a61de86b3e8ae608dc2fb06c25a97056e45b7c0d801fdaff2d58fd3b9370c1e73f26f7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in marcopolo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Hammond
+
+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,42 @@
+# Marcopolo
+
+Marcopolo is a Rack middleware for use in Rails applications (currently) to aid in debugging HTTP requests and responses by logging them *raw* (including headers and body).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'marcopolo'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+By simply including the gem in your Gemfile, your Rails app will automatically start logging raw incoming HTTP requests and your app's responses to your Rails log. That being said, you can choose a different log location if you wish.
+
+Configure the logger settings in a Rails initializer like so:
+
+    Marcopolo.options[:logger] = Logger.new(File.join(Rails.root, 'log', "#{Rails.env}-http-raw.log"))
+    Marcopolo.options[:severity] = Logger::Severity::DEBUG
+
+Consider adding logrote rules to your application server to prevent these extremely verbose logs from blowing up your storage.
+
+Also, be mindful of cleaning up these logs appropriately, as sensative information like authorization headers and cookies will not be filtered out automatically (hence "raw").
+
+## TODO
+
+* Support for Sinatra?
+* Noise filters?
+* Ability to disable for certain endpoints, etc
+* IP-based log segmenting?
+* Tests?
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/marcopolo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/marcopolo.rb

@@ -0,0 +1,21 @@
+require "marcopolo/version"
+require 'marcopolo/middleware'
+require 'marcopolo/rails' if defined?(Rails)
+
+module Marcopolo
+  DEFAULT_LOGGER  = Logger.new($stdout)
+  DEFAULT_OPTIONS = {
+    logger: DEFAULT_LOGGER,
+    severity: Logger::Severity::DEBUG
+  }
+
+  class << self
+    def options
+      @@options ||= DEFAULT_OPTIONS.clone
+    end
+
+    def log(msg)
+      options[:logger].add(options[:severity]) { msg }
+    end
+  end
+end

data/lib/marcopolo/middleware.rb

@@ -0,0 +1,49 @@
+module Marcopolo
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+
+      req_headers = env.select {|k,v| k.start_with? 'HTTP_'}
+        .collect {|pair| [pair[0].sub(/^HTTP_/, '').split('_').map(&:titleize).join('-'), pair[1]]}
+        .sort
+
+      req_hash = {
+        "REQUEST" => "",
+        "Remote Address" => req.ip,
+        "Request URL" => req.url,
+        "Request Method" => req.request_method,
+        "REQUEST HEADERS" => ""
+      }
+
+      req_headers.to_a.each {|i| req_hash["\t" + i.first] = i.last }
+
+      req_hash.merge!({
+        "Request Body" => req.body.gets
+      })
+
+      Marcopolo.log req_hash.to_a.map {|o| o.join(': ') }.join("\n") + "\n"
+
+      status, headers, response = @app.call(env)
+
+      resp_hash = {
+        "RESPONSE" => "",
+        "Response Status" => response.status,
+        "Response Headers" => ""
+      }
+
+      response.headers.to_a.each {|i| resp_hash["\t" + i.first] = i.last }
+
+      resp_hash.merge!({
+        "Response Body" => response.body
+      })
+
+      Marcopolo.log resp_hash.to_a.map {|o| o.join(': ') }.join("\n") + "\n"
+
+      return [status, headers, response]
+    end
+  end
+end

data/lib/marcopolo/rails.rb

@@ -0,0 +1,7 @@
+module Marcopolo
+  class Marco < Rails::Railtie
+    initializer "marcopolo.configure_rails_initialization" do |app|
+      app.middleware.insert_before ActionDispatch::ParamsParser, "Marcopolo::Middleware"
+    end
+  end
+end

data/lib/marcopolo/version.rb

@@ -0,0 +1,3 @@
+module Marcopolo
+  VERSION = "0.0.1"
+end

data/marcopolo.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marcopolo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "marcopolo"
+  spec.version       = Marcopolo::VERSION
+  spec.authors       = ["Andrew Hammond"]
+  spec.email         = ["andrew@evertrue.com"]
+  spec.summary       = %q{Log raw HTTP requests & responses}
+  spec.description   = %q{Log raw HTTP requests & responses}
+  spec.homepage      = "http://github.com/andrhamm"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: marcopolo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Hammond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Log raw HTTP requests & responses
+email:
+- andrew@evertrue.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/marcopolo.rb
+- lib/marcopolo/middleware.rb
+- lib/marcopolo/rails.rb
+- lib/marcopolo/version.rb
+- marcopolo.gemspec
+homepage: http://github.com/andrhamm
+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.0
+signing_key: 
+specification_version: 4
+summary: Log raw HTTP requests & responses
+test_files: []
+has_rdoc: