depthcharge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 235a7a642129d8b9f86e52cd86fd294cc718d262
+  data.tar.gz: 4996859bcd5553e324c3139b3d4b15bb6dd4f162
+SHA512:
+  metadata.gz: 0732f212694d995817e970d5377499f53ff9a608186d4592f9b3708c1c64965e8c02fe73f4deb306f0552f197a227f9db102040e798c673335bef2ed901a3677
+  data.tar.gz: d26b3f29e94c22d2c5b8e673ec65f145091391a0cd1810984ecd7522763012004dc2929da0a2a13518b5320c5c539d80d8c5d7f05b292c1d7a289bc4a50b2ea5

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aaron Gough
+
+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,71 @@
+# Depthcharge
+
+Depthcharge is a piece of Rack middleware that enables extra visibility into the requests going through an application. The primary use case for this is to see the requests that are coming and going from a local server to a connected client app (like iOS simulator for example). Additionally it will automatically detect JSON responses and pretty print them to enhance readability.
+
+## Example log output
+
+
+	GET 200 "/example.json" at 2017-04-30 23:32:16 -0400
+	  | PARAMS:
+	  |   test: "foo"
+	  |
+	  | REQUEST HEADERS:
+	  |   HTTP_HOST: "localhost:4567"
+	  |   HTTP_CONNECTION: "keep-alive"
+	  |   HTTP_CACHE_CONTROL: "max-age=0"
+	  |   HTTP_VERSION: "HTTP/1.1"
+	  |
+	  | RESPONSE STATUS: 200
+	  |
+	  | RESPONSE HEADERS:
+	  |   Content-Type: "application/json"
+	  |   Content-Length: "25"
+	  |
+	  | BODY:
+	  |   {
+	  |     "a": 1,
+	  |     "b": 2,
+	  |     "c": 3,
+	  |     "d": 4
+	  |   }
+	  |
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'depthcharge'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install depthcharge
+
+## Usage
+
+Just add `gem 'depthcharge'` to your app's Gemfile, then add the middleware to your app like so:
+
+Sinatra:
+```ruby
+use Depthcharge::Middleware, STDOUT, "depthcharge.log"
+```
+
+Rails:
+```ruby
+# config/application.rb (or) config/environments/development.rb
+config.middleware.use Depthcharge::Middleware, Rails.root.join("log", "depthcharge.log")
+```
+
+You can pass multiple outputs to Depthcharge::Middleware and it will write to each one for each request. Logging to `STDOUT` and a log file simultaneously is a handy use of this as demonstrated above with the Sinatra setup.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/depthcharge.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'depthcharge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "depthcharge"
+  spec.version       = Depthcharge::VERSION
+  spec.authors       = ["Aaron Gough"]
+  spec.email         = ["aaron@aarongough.com"]
+
+  spec.summary       = %q{A rack middleware layer that logs the full request cycle.}
+  spec.description   = %q{A rack middleware layer that logs the full request cycle.}
+  spec.homepage      = "https://github.com/aarongough/depthcharge"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+  spec.add_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sinatra", "~> 1.4.8"
+  spec.add_development_dependency "rails", "~> 4.2"
+end

data/lib/depthcharge.rb

@@ -0,0 +1,10 @@
+require "rack"
+require "json"
+
+module Depthcharge
+  require "depthcharge/version"
+  require "depthcharge/middleware"
+  require "depthcharge/formatters"
+  require "depthcharge/filters"
+  require "depthcharge/request_logger"
+end

data/lib/depthcharge/filters.rb

@@ -0,0 +1,14 @@
+module Depthcharge
+  module Filters
+
+    def request_headers(env)
+      env.select {|k,v| k.to_s.include?("HTTP") }
+    end
+
+    def request_params(env)
+      request = Rack::Request.new(env)
+      request.params
+    end
+
+  end
+end

data/lib/depthcharge/formatters.rb

@@ -0,0 +1,53 @@
+module Depthcharge
+  module Formatters
+
+    MAIN_INDENT = "  | "
+    SUB_INDENT = "  "
+    NEWLINE = "\n"
+
+    def format_body(headers, body, level = 1)
+      content_type = headers["Content-Type"]
+      body = body.join if body.respond_to?(:join)
+      body = body.body if body.respond_to?(:body)
+
+      if !content_type.nil? && content_type.include?("json")
+        format_lines(JSON.pretty_generate(JSON.parse(body)), level)
+      else
+        format_lines(body, level)
+      end
+    end
+
+    def format_hash(name, hash, level = 1)
+      output = format_line(name.to_s.upcase + ":", level)
+
+      hash.each do |key, value|
+        output << format_line("#{key.to_s}: #{value.inspect}", level + 1)
+      end
+
+      output
+    end
+
+    def format_lines(lines, level = 1)
+      lines = lines.split($/).map do |line|
+        format_line(line, level)
+      end
+
+      lines.join
+    end
+
+    def blank_line(level = 1)
+      format_line("", level)
+    end
+
+    def format_line(line, level = 1)
+      indent(level) + line + NEWLINE
+    end
+
+    def indent(level)
+      return "" if level == 0
+
+      MAIN_INDENT + (SUB_INDENT * (level - 1))
+    end
+
+  end
+end

data/lib/depthcharge/middleware.rb

@@ -0,0 +1,23 @@
+module Depthcharge
+  class Middleware
+
+    attr_reader :app, :outputs
+
+    def initialize(app, *outputs)
+      @app = app
+      @outputs = outputs.flatten.map do |output|
+        if output.is_a?(String) || output.is_a?(Pathname)
+          File.open(output, "w")
+        else
+          output
+        end
+      end
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      RequestLogger.new(env, status, headers, body).log(outputs)
+      [status, headers, body]
+    end
+  end
+end

data/lib/depthcharge/request_logger.rb

@@ -0,0 +1,44 @@
+module Depthcharge
+  class RequestLogger
+
+    include Formatters
+    include Filters
+
+    attr_reader :env, :status, :headers, :body
+
+    def initialize(env, status, headers, body)
+      @env = env
+      @status = status
+      @headers = headers
+      @body = body
+    end
+
+    def log(*outputs)
+      log_entry = construct_log_entry
+
+      outputs.flatten.each do |output|
+        output.puts(log_entry)
+        output.flush
+      end
+    end
+
+    def construct_log_entry
+      output = ""
+      output << blank_line(0)
+      output << format_line("#{env["REQUEST_METHOD"]} #{status} #{env["PATH_INFO"].inspect} at #{Time.now}", 0)
+      output << format_hash("PARAMS", request_params(env))
+      output << blank_line
+      output << format_hash("REQUEST HEADERS", request_headers(env))
+      output << blank_line
+      output << format_line("RESPONSE STATUS: #{status}")
+      output << blank_line
+      output << format_hash("RESPONSE HEADERS", headers)
+      output << blank_line
+      output << format_line("BODY:")
+      output << format_body(headers, body, 2)
+      output << blank_line
+      output << blank_line(0)
+    end
+
+  end
+end

data/lib/depthcharge/version.rb

@@ -0,0 +1,3 @@
+module Depthcharge
+  VERSION = "0.1.0"
+end

data/test_apps/rails.rb

@@ -0,0 +1,29 @@
+# Run this app with: `ruby rails.rb`
+
+require "bundler/setup"
+require "depthcharge"
+require "rails"
+require "webrick"
+require "json"
+require "action_controller/railtie"
+
+class MyApp < Rails::Application
+  routes.append do
+    get "/example.json" => "example#json"
+  end
+
+  config.eager_load = true
+  config.secret_key_base = "538f51b191c9c2c35496d55804ddeddf"
+
+  config.middleware.use Depthcharge::Middleware, STDOUT, Rails.root.join("rails-depthcharge.log")
+end
+
+class ExampleController < ActionController::Base
+  def json
+    render json: { a: 1, b: 2, c: 3, d: 4 }
+  end
+end
+
+MyApp.initialize!
+
+Rack::Handler::WEBrick.run(MyApp, :Port => 3000)

data/test_apps/sinatra.rb

@@ -0,0 +1,21 @@
+# Run this app with: `ruby sinatra.rb`
+
+require "bundler/setup"
+require "depthcharge"
+require "sinatra/base"
+require "json"
+
+class SinartraTestApp < Sinatra::Base
+  use Depthcharge::Middleware, STDOUT, File.open("sinatra-depthcharge.log", "w")
+
+  get "/example.json" do
+    content_type :json
+    { a: 1, b: 2, c: 3, d: 4 }.to_json
+  end
+
+  get "/example.html" do
+    "<head><head/><body><span>Example text</span></body>"
+  end
+
+  run!
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: depthcharge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Gough
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.8
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: A rack middleware layer that logs the full request cycle.
+email:
+- aaron@aarongough.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/.gitkeep
+- depthcharge.gemspec
+- lib/depthcharge.rb
+- lib/depthcharge/filters.rb
+- lib/depthcharge/formatters.rb
+- lib/depthcharge/middleware.rb
+- lib/depthcharge/request_logger.rb
+- lib/depthcharge/version.rb
+- test_apps/rails.rb
+- test_apps/sinatra.rb
+homepage: https://github.com/aarongough/depthcharge
+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.6.10
+signing_key: 
+specification_version: 4
+summary: A rack middleware layer that logs the full request cycle.
+test_files: []