rack-request-tracer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 981c3dab180bcdf4d70577db4a1b107f4b8607ee
+  data.tar.gz: dc683703815bfaf58f040abdf1eb4aab9395f672
+SHA512:
+  metadata.gz: e2549e6a0021f4848cf5731a4cac58408f400e44cf0a1163fccfc832c4eb666c233fe173c72b11b44ec32ec153a3760e1da5a452dfd9ce55bdbb3ba1607efd72
+  data.tar.gz: 9b421cedcd0a4dd2274467d198411b237373da2ab2c49408f28c4584152a14d5e242e61fd05f755fadba9afd1d0a0f41e99537bb0ca4e8bfa607eddb79ceac99

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 request-tracer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nitin Misra
+
+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,82 @@
+# Rack::Request::Tracer
+
+A Rack Middleware to log request's info to any rack app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+  `gem 'rack-request-tracer'`
+
+And then execute:
+
+  `$ bundle`
+
+Or install it yourself as:
+
+  `$ gem install rack-request-tracer`
+
+## Configuration
+
+### Rails 3.x/4.x
+
+Create an initializer `config/initializers/request_tracer.rb` and these lines:
+
+```ruby
+require 'rack/request_tracer'
+
+Rack::RequestTracer.enabled = true if Rails.env.production? # enable for production environment,
+                                                            # disabled for other environments
+
+# Build the Log singleton.
+Rack::RequestTracer::Log.instance(
+  file: '/path/to/log_file.log', # example - /var/log/request_tracer.log
+  level: 'info', # set the log severity
+  rotation: 'weekly' # log rotation period
+)
+
+Rails.application.config.middleware.use Rack::RequestTracer
+```
+
+
+### Rack Apps
+
+In your `config.ru` file add the following lines:
+
+```ruby
+require 'rack/request_tracer'
+
+Rack::RequestTracer.enabled = true
+
+# Build the Log singleton.
+Rack::RequestTracer::Log.instance(
+  file: '/path/to/log_file.log', # example - /var/log/request_tracer.log
+  level: 'info', # set the log severity
+  rotation: 'weekly' # log rotation period
+)
+
+use Rack::RequestTracer
+```
+
+## Download
+
+You can also clone the project with Git by running:
+
+  `$ git clone git://github.com/nitinstp23/rack-request-tracer`
+
+
+## Roadmap
+* Make request's info to be logged, configurable.
+
+
+## Authors
+* Nitin Misra: https://github.com/nitinstp23
+
+
+## Contributing
+
+1. Fork it
+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,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--format d"
+end
+
+task default: :spec

data/lib/rack/request_tracer.rb

@@ -0,0 +1,32 @@
+require 'request_tracer/log'
+
+module Rack
+  class RequestTracer
+
+    @@enabled = false
+
+    def self.enabled=(value)
+      @@enabled = value
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      trace(env) if @@enabled
+      @app.call(env)
+    end
+
+    private
+
+    def log
+      Log.instance
+    end
+
+    def trace(env)
+      log.trace Rack::Request.new(env)
+    end
+
+  end
+end

data/lib/rack/request_tracer/log.rb

@@ -0,0 +1,39 @@
+require 'logger'
+
+module Rack
+  class RequestTracer
+    class Log < ::Logger
+
+      # class variables
+      @@instance = nil
+
+      private_class_method :new
+      private_class_method :allocate
+
+      # instance accessor
+      def self.instance(file: nil, level: 'debug', rotation: 'daily')
+        return @@instance if @@instance
+        raise ArgumentError, 'Missing :file argument' if file.nil?
+        @@instance = new(file, level, rotation)
+      end
+
+      def initialize(file, level, rotation)
+        super(file, rotation)
+        self.level = extract_level!(level)
+      end
+
+      def trace(request)
+        info "| #{request.ip} | #{request.request_method} | #{request.url} | #{request.params}"
+      end
+
+      private
+
+      def extract_level!(level)
+        level = level.to_s.upcase
+        raise StandardError, 'Unkown LOG LEVEL' unless self.class.const_defined?(level)
+        self.class.const_get(level)
+      end
+
+    end
+  end
+end

data/lib/rack/request_tracer/version.rb

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

data/rack-request-tracer.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path('../lib/rack', __FILE__)
+
+# Maintain your gem's version:
+require 'request_tracer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-request-tracer'
+  spec.version       = Rack::RequestTracer::VERSION
+  spec.authors       = ['Nitin Misra']
+  spec.email         = ['nitin.misra23@gmail.com']
+  spec.description   = %q{A Rack Middleware to log request's info to any rack app}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/nitinstp23/rack-request-tracer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rack', '~> 1.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/spec/request_tracer_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper.rb'
+
+describe Rack::RequestTracer do
+
+  subject { Rack::RequestTracer }
+
+  before do
+    app = ->(env) do
+      [200, {'Content-Type' => 'text/html'}, ['It Works!']]
+    end
+
+    # Build Log singleton
+    @log = Rack::RequestTracer::Log.instance(
+      file: '/tmp/request_tracer.log',
+      level: 'info',
+      rotation: 'weekly'
+    )
+
+    @request_mock = Rack::MockRequest.new(subject.new(app))
+  end
+
+  describe '#call' do
+    describe 'Rack::RequestTracer.enabled = true' do
+      it 'log request info' do
+        subject.enabled = true
+
+        @log.stub(:trace) { true }
+
+        @request = @request_mock.get('/dummy_uri', {'HTTP_ACCEPT' => 'text/html'})
+
+        @request.status.should == 200
+        @request.body.should   == 'It Works!'
+      end
+    end
+
+    describe 'Rack::RequestTracer.enabled = false' do
+      it 'does not log request info' do
+        subject.enabled = false
+
+        # Stubbed to raise exception,
+        # but this won't be executed as enabled is false.
+        @log.stub(:trace) { raise StandardError, 'This should not happen!' }
+
+        @request = @request_mock.get('/dummy_uri', {'HTTP_ACCEPT' => 'text/html'})
+        @request.status.should == 200
+        @request.body.should   == 'It Works!'
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rack'
+require 'rack/request_tracer'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rack-request-tracer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nitin Misra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: A Rack Middleware to log request's info to any rack app
+email:
+- nitin.misra23@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/request_tracer.rb
+- lib/rack/request_tracer/log.rb
+- lib/rack/request_tracer/version.rb
+- rack-request-tracer.gemspec
+- spec/request_tracer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nitinstp23/rack-request-tracer
+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: A Rack Middleware to log request's info to any rack app
+test_files:
+- spec/request_tracer_spec.rb
+- spec/spec_helper.rb