rack-logjam 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3afcec7ffd389b14ebacd722576d00e0925b2c91
+  data.tar.gz: fd6c4bcc7b2fcd6a06679afde498495654a7dd2a
+SHA512:
+  metadata.gz: 25cd7cd84390166d4e5532c9cde283e55eb668279c9636193f50a8d340ba8792699b5105426065ba43104697a942c60d36fe0c5c59cf92eb13fb92a68ff827df
+  data.tar.gz: 5d73f70586ad76410055ac469e8f775395ab4f90952299a870e5f41731eec3cbe61f4247fa4bfc49122e04d57b07eb40516644df6fe7a2beec518ed26f66c75a

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 rack-logjam.gemspec
+gemspec

data/License.markdown

@@ -0,0 +1,9 @@
+# The MIT License
+
+Source code for _rack-logjam_ is Copyright © 2014 [Ninja Loss](mailto:ninja.loss@gmail.com) and [contributors](http://github.com/ninja-loss/rack-logjam/contributors "rack-logjam contributors at GitHub").
+
+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.markdown

@@ -0,0 +1,29 @@
+# Rack::Logjam
+
+Logs helpful HTTP information on Rack requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-logjam'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-logjam
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/ninja-loss/rack-logjam/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/rack/logjam.rb

@@ -0,0 +1,7 @@
+require "rack/logjam/version"
+
+module Rack
+  module Logjam
+    # Your code goes here...
+  end
+end

data/lib/rack/logjam/middleware.rb

@@ -0,0 +1,137 @@
+module Rack; module Logjam; class Middleware
+
+  def initialize( app )
+    @app = app
+  end
+
+  def call( env )
+    before env
+    app.call( env ).tap do |rack_response|
+      after env, *rack_response
+    end
+  end
+
+protected
+
+  attr_reader :app
+
+  def before( env )
+    return unless api_request?( env )
+
+    Rails.logger.info <<-end_info
+[#{ANSI.green { 'api' }}] #{ANSI.cyan { '--- Request Env ---' }}
+#{ANSI.magenta { JSON.pretty_generate( request_log_data( env )) }}
+[#{ANSI.green { 'api' }}] #{ANSI.cyan { '--- Request Body ---' }}
+#{ANSI.cyan { formatted_request_body( env ) }}
+    end_info
+  end
+
+  def after( env, status, headers, response )
+    return unless api_request?( env )
+
+    Rails.logger.info <<-end_info
+[#{ANSI.green { 'api' }}] #{ANSI.cyan { '--- Response ---' }}
+Status: #{status}
+Headers: #{headers.inspect}
+Body:
+#{ANSI.cyan { format_body( response.body, accept( env ), env ) }}
+    end_info
+  end
+
+  def request_log_data( env )
+    request_data = {
+      auth_token:     env['HTTP_X_NCITE_AUTH_TOKEN'],
+      content_type:   content_type( env ),
+      content_length: env['CONTENT_LENGTH'],
+      accept:         accept( env ),
+      accept_version: env['HTTP_ACCEPT_VERSION'],
+      method:         env['REQUEST_METHOD'],
+      path:           path_info( env ),
+      query:          query( env )
+    }
+    #request_data[:user_id] = current_user.id if current_user
+    request_data
+  end
+
+  def api_request?( env )
+    path_info( env ) =~ /^\/api\//
+  end
+
+  def content_type( env )
+    env['CONTENT_TYPE']
+  end
+
+  def accept( env )
+    env['HTTP_ACCEPT']
+  end
+
+  def path_info( env )
+    env['PATH_INFO']
+  end
+
+  def query( env )
+    URI.unescape( env['QUERY_STRING'] )
+  end
+
+  def formatted_request_body( env )
+    format_body( rack_input_content( env ), content_type( env ), env )
+  end
+
+  def format_body( body, format, env )
+    return body if body.strip.nil? || body.strip.empty?
+
+    if format == Mime::JSON.to_s
+      hash = truncate_json_attributes( body )
+      return JSON.pretty_generate( hash )
+    elsif format == Mime::XML.to_s
+      return Nokogiri.XML( body ) do |config|
+        config.default_xml.noblanks
+      end.to_xml( indent: 2 )
+    elsif format == Mime::URL_ENCODED_FORM.to_s
+      return URI.unescape( body )
+    elsif format == Mime::OCTET_STREAM.to_s
+      return "no body b/c content type is #{Mime::OCTET_STREAM}"
+    end
+
+    body
+  end
+
+  def rack_input_content( env )
+    ( rack_input = env['rack.input'] ).read.tap do |content|
+      rack_input.rewind
+    end
+  end
+
+  # Can currently use the following xpath expressions that will translate to json_path:
+  # /some/path -> $.some.path (search from root)
+  # some/path -> some.path (search for any sub-path that matches this, not bound to root)
+  # //path -> $..path (recursive search)
+  #
+  def truncated_attributes_as_xpath
+    %w(
+      //image_as_base64
+      //fingerprint_image_as_base64
+    )
+  end
+
+  def truncate_json_attributes( json )
+    json_path = JsonPath.for( json )
+    truncated_attributes_as_json_paths.each do |j_path|
+      json_path.gsub!( j_path ) { |val| (val.nil? || val.empty?) ? val : "#{val[0..25]} ... [TRUNCATED] ..." }
+    end
+    json_path.to_hash
+  end
+
+  def truncated_attributes_as_json_paths
+    truncated_attributes_as_xpath.map do |xpath|
+      if xpath.start_with?( '//' )
+        xpath.gsub( '//', '$..' )
+      else
+        parts = xpath.split( '/' )
+        parts[0] = '$' if parts[0] == ''
+        parts.join( '.' )
+      end
+    end
+  end
+
+end; end; end

data/lib/rack/logjam/version.rb

@@ -0,0 +1,9 @@
+module Rack
+
+  module Logjam
+
+    VERSION = '0.0.1'
+
+  end
+
+end

data/rack-logjam.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/logjam/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-logjam'
+  spec.version       = Rack::Logjam::VERSION
+  spec.authors       = ['Jason Harrelson', 'Nils Jonsson']
+  spec.email         = ['ninja.loss@gmail.com']
+  spec.summary       = 'Logs helpful HTTP information on Rack requests.'
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) do |f|
+                         File.basename f
+                       end
+  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: rack-logjam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Harrelson
+- Nils Jonsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-09 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: ''
+email:
+- ninja.loss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- License.markdown
+- README.markdown
+- Rakefile
+- lib/rack/logjam.rb
+- lib/rack/logjam/middleware.rb
+- lib/rack/logjam/version.rb
+- rack-logjam.gemspec
+homepage: ''
+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.1
+signing_key: 
+specification_version: 4
+summary: Logs helpful HTTP information on Rack requests.
+test_files: []
+has_rdoc: