logger_ware 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color --format nested

data/Changelog

@@ -0,0 +1,3 @@
+# 0.0.1
+
+  initial version

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'bundler' do
+  watch 'Gemfile'
+  watch 'logger_ware.gemspec'
+end
+
+guard :rspec, cli: '--color --format nested' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vitaly Kushner
+
+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,29 @@
+# LoggerWare
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'logger_ware'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logger_ware
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/logger_ware/collector.rb

@@ -0,0 +1,40 @@
+require 'logger_ware/filter'
+
+module LoggerWare
+  module Collector
+    include Filter
+
+    COLLECT_PARAMS = {
+      request_path:  'REQUEST_PATH',
+      method:        'REQUEST_METHOD',
+      request_uri:   'REQUEST_URI',
+      user_agent:    'HTTP_USER_AGENT',
+      http_accept:   'HTTP_ACCEPT',
+      rack_session:  "rack.session",
+      request_ip:    'REMOTE_ADDR',
+      request_ip_fw: 'HTTP_X_FORWARDED_FOR',
+      referer:       'HTTP_REFERER',
+    }
+    FILTER_PARAMS = {
+      request_parameters: 'action_controller.request.request_parameters',
+      path_parameters:    'action_controller.request.path_parameters',
+      query_parameters:   'action_controller.request.query_parameters',
+    }
+
+    PARAM_FILTERS = [/password/]
+
+    def _collect env, keys, filters = nil, replace_with = nil
+      keys.each_with_object({}) do |(k,v), res|
+        next unless env.has_key?(v)
+        v = env[v]
+        v = filter(v, filters, replace_with) if filters
+        res[k] = v
+      end
+    end
+
+    def collect env, collect_params = COLLECT_PARAMS, filter_params = FILTER_PARAMS, filters = PARAM_FILTERS, replace_with = Filter::REPLACE_WITH
+      _collect(env, collect_params).merge(_collect(env, filter_params, filters, replace_with))
+    end
+
+  end
+end

data/lib/logger_ware/filter.rb

@@ -0,0 +1,25 @@
+module LoggerWare
+  module Filter
+    REPLACE_WITH = '[FILTERED]'
+
+    def match?(param, f)
+      if f.is_a?(Regexp)
+        !!(param.to_s =~ f)
+      else
+        param.to_s == f.to_s
+      end
+    end
+
+    def filter?(param, filters)
+      filters.each { |f| return true if match?(param, f) }
+      false
+    end
+
+    def filter(params, filters, replace_with = REPLACE_WITH)
+      params.each_with_object({}) do |(k,v), res|
+        v = filter(v, filters, replace_with) if v.is_a?(Hash)
+        res[k] = filter?(k, filters) ? replace_with : v
+      end
+    end
+  end
+end

data/lib/logger_ware/rack.rb

@@ -0,0 +1,49 @@
+require 'rack'
+require 'logger_ware/collector'
+
+module LoggerWare
+  class Rack
+    include Collector
+
+    @collect_params = COLLECT_PARAMS
+    @filter_params  = FILTER_PARAMS
+    @replace_with    = REPLACE_WITH
+    @filters = PARAM_FILTERS
+    @handler = ->(_) {raise 'missing handler, please assign'}
+    @error_handler = ->(_) {raise 'missing error_handler, please assign'}
+
+    class << self
+      attr_accessor :collect_params, :filter_params, :replace_with, :filters, :handler, :error_handler
+    end
+
+    [:collect_params, :filter_params, :replace_with, :filters, :handler, :error_handler].each do |m|
+      define_method(m) { |*args| self.class.send(m, *args) }
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      started_at = Time.now.utc
+
+      status, headers, response = @app.call(env)
+
+      handler[{status: status, headers: headers, response: response, started_at: started_at, duration: duration(started_at), data: data(env)}]
+      [status, headers, response]
+
+    rescue => exception
+
+      error_handler[{exception: exception, started_at: started_at, duration: duration(started_at), data: data(env)}]
+      raise exception
+    end
+
+    def data(env)
+      collect(env, collect_params, filter_params, filters, replace_with)
+    end
+
+    def duration(started_at)
+      Time.now.utc - started_at
+    end
+  end
+end

data/lib/logger_ware/version.rb

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

data/lib/logger_ware.rb

@@ -0,0 +1,2 @@
+require "logger_ware/version"
+require 'logger_ware/rack'

data/logger_ware.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logger_ware/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logger_ware"
+  spec.version       = LoggerWare::VERSION
+  spec.authors       = ["Vitaly Kushner"]
+  spec.email         = ["vitaly@astrails.com"]
+  spec.summary       = "middleware to log rails requests"
+  spec.description   = %q{Rails middleware to log requests. Support for parameters and environment filtering. Storage agnostic.}
+  spec.homepage      = "http://github.com/astrails/logger_ware"
+  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{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'debugger'
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency 'terminal-notifier-guard'
+  spec.add_development_dependency 'rb-fchange'
+  spec.add_development_dependency 'rb-fsevent'
+  spec.add_development_dependency 'rb-inotify'
+end

data/spec/lib/logger_ware/collector_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe LoggerWare::Collector do
+  include LoggerWare::Collector
+
+  E = {
+    'A' => 'a',
+    'B' => {'C' => 'c', 'D' => 'd'},
+    'F' => false,
+    'N' => nil,
+  }
+
+  describe :collect do
+    it 'should return empty hash when no params match' do
+      collect(E).should == {}
+    end
+
+    it 'should collect params' do
+      collect(E, {a: 'A'}).should == {a: 'a'}
+    end
+
+    it 'should collect false and nil' do
+      collect(E, {f: 'F', n: 'N'}).should == {f: false, n: nil}
+    end
+
+    it 'should filter' do
+      collect(E, {a: 'A'}, {b: 'B'}, [/D/], 'XXX').should == {
+        a: 'a',
+        b: {'C' => 'c', 'D' => 'XXX'}
+      }
+    end
+  end
+end

data/spec/lib/logger_ware/filter_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe LoggerWare::Filter do
+  include LoggerWare::Filter
+
+  describe :match? do
+    it 'should NOT match nil filter' do
+      match?('foo', nil).should == false
+    end
+
+    describe 'string' do
+      it 'should match string filter' do
+        match?('foo', 'foo').should == true
+      end
+
+      it 'should match symbol filter' do
+        match?('foo', :foo).should == true
+      end
+
+      it 'should match regexp filter' do
+        match?('foo', /o/).should == true
+      end
+    end
+
+    describe :symbol do
+      it 'should match string filter' do
+        match?(:foo, 'foo').should == true
+      end
+
+      it 'should match symbol filter' do
+        match?(:foo, :foo).should == true
+      end
+
+      it 'should match regexp filter' do
+        match?(:foo, /o/).should == true
+      end
+    end
+  end
+
+  describe :filter? do
+    it 'should return arg when filters are empty' do
+      filter?('foo', []).should == false
+    end
+
+    it 'should filter out param by string' do
+      filter?('foo', ['foo']).should == true
+    end
+
+    it 'should filter out symbol param by string' do
+      filter?(:foo, ['foo']).should == true
+    end
+
+    it 'should filter out param by symbol' do
+      filter?('foo', [:foo]).should == true
+    end
+
+    it 'should filter out param by regexp' do
+      filter?('foo', [/fo/]).should == true
+    end
+
+    it 'should filter out symbol param by regexp' do
+      filter?(:foo, [/fo/]).should == true
+    end
+  end
+
+  describe :filter do
+    it 'should return params on empty filters' do
+      filter({foo: 123}, []).should == {foo: 123}
+    end
+
+    it 'should filter 1st level keys' do
+      filter({foo: 123, bar: 456}, [:foo]).should == {foo: '[FILTERED]', bar: 456}
+    end
+
+    it 'should filter 2nd level keys' do
+      filter({foo: 123, bar: 456, baz: {ooo: 1}}, [/o/]).should == {foo: '[FILTERED]', bar: 456, baz: {ooo: '[FILTERED]'}}
+    end
+
+    it 'should use supplied dummy' do
+      filter({foo: 123}, [:foo], 'X').should == {foo: 'X'}
+    end
+  end
+end

data/spec/lib/logger_ware/rack_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe LoggerWare::Rack do
+  class App
+    def call(env)
+      [200, {a: 'b'}, 'ok']
+    end
+  end
+
+  class ErrApp
+    def call(env)
+      raise 'foo'
+    end
+  end
+
+  it 'should allow setting filters' do
+    LoggerWare::Rack.filters.should == [/password/]
+    LoggerWare::Rack.filters << 'qwe'
+    LoggerWare::Rack.filters.should == [/password/, 'qwe']
+  end
+
+  it 'should call handler' do
+    opts = nil
+    LoggerWare::Rack.handler = ->(args) {opts = args}
+    LoggerWare::Rack.new(App.new).call({}).should == [200, {a: 'b'}, 'ok']
+    opts[:status].should == 200
+    opts[:response].should == 'ok'
+    opts.keys.should == [:status, :headers, :response, :started_at, :duration, :data]
+  end
+
+  it 'should call error handler' do
+    opts = nil
+    LoggerWare::Rack.handler = ->(args) {opts = args}
+    err = nil
+    LoggerWare::Rack.error_handler = ->(args) {err = args}
+    -> {
+      LoggerWare::Rack.new(ErrApp.new).call({})
+    }.should raise_error('foo')
+    err[:exception].to_s.should == 'foo'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'debugger'
+require 'logger_ware'
+
+Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: logger_ware
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Vitaly Kushner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: debugger
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rb-fchange
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+description: Rails middleware to log requests. Support for parameters and environment
+  filtering. Storage agnostic.
+email:
+- vitaly@astrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Changelog
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logger_ware.rb
+- lib/logger_ware/collector.rb
+- lib/logger_ware/filter.rb
+- lib/logger_ware/rack.rb
+- lib/logger_ware/version.rb
+- logger_ware.gemspec
+- spec/lib/logger_ware/collector_spec.rb
+- spec/lib/logger_ware/filter_spec.rb
+- spec/lib/logger_ware/rack_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/astrails/logger_ware
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2159498929020429373
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2159498929020429373
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: middleware to log rails requests
+test_files:
+- spec/lib/logger_ware/collector_spec.rb
+- spec/lib/logger_ware/filter_spec.rb
+- spec/lib/logger_ware/rack_spec.rb
+- spec/spec_helper.rb