muffler 0.0.1

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/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@muffler --create

data/.travis.yml

@@ -0,0 +1,7 @@
+branches:
+  only:
+    - master
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+   watch(%r|^spec/(.*)_spec\.rb|)
+   watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+   watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeremy Israelsen
+
+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,150 @@
+Muffler [![Build Status](https://secure.travis-ci.org/jisraelsen/muffler.png?branch=master)](http://travis-ci.org/jisraelsen/muffler)
+========
+
+Flexible log suppression for Ruby. Compatible with:
+
+ * Rails 3.x
+ * Rack
+ * Ruby 1.9.x
+
+Install
+-------
+
+Just add it to your Gemfile:
+
+```ruby
+gem 'muffler'
+```
+
+Usage
+-----
+
+### Rails
+
+Works as drop-in replacement for `Rails::Rack::Logger`.  Gemfile require
+is all that's needed.
+
+### Rack
+
+Drop-in replacements are provided for `Rack::CommonLogger` and
+`Rack::Logger`.  Just add them to your middleware stack.
+
+```ruby
+use Muffler::Rack::CommonLogger
+use Muffler::Rack::Logger
+
+run MyApp
+```
+
+### Ruby
+
+If not using Rack or Rails you can still muffle log output by manually
+calling the muffle method:
+
+```ruby
+logger = Logger.new('app.log')
+
+Muffler.muffle(logger) do
+  # your custom code here
+end
+```
+
+You can still take advantage of conditional muffling as well:
+
+```ruby
+logger = Logger.new('app.log')
+
+if Muffler.muffle?('REMOTE_ADDR' => '127.0.0.1')
+  Muffler.muffle(logger) do
+    # muffled code here
+  end
+else
+  # unmuffled code
+end
+```
+
+By default, Muffler muffles log output based on the request environment.
+It does comparisons against `REMOTE_ADDR`, `PATH_INFO`, and a custom
+header you can configure.  The default header looked for is: 
+`HTTP_X_MUFFLE_LOGGER`.
+
+Note that when sending the abover header in the request it should be
+named `X-Muffle-Logger` or `X-MUFFLE-LOGGER`.
+
+You can configure which IP addresses, request paths, and headers to look
+for:
+
+```ruby
+Muffler.configure do |config|
+  config.ips += ['10.1.1.3', '10.1.1.4']
+  config.paths << %r{/assets}
+  config.header = 'HTTP_X_MY_CUSTOM_HEADER'
+end
+```
+
+You can also add your own "mufflers" or replace the defaults.  Custom
+mufflers just need to return true (muffle log output) or false (don't
+muffle log output).
+
+If still using Rack or Rails, you could add a params muffler:
+
+```ruby
+Muffler.configure do |config|
+  config.muffle_with :params do |env|
+    request = Rack::Request.new(env)
+    request.params['muffle'].to_i == 1
+  end
+end
+```
+
+Of if just working with Ruby you could clear the default filters and add
+your own:
+
+```ruby
+Muffler.configure do |config|
+  config.mufflers.clear # clear default mufflers
+  config.muffle_with :random do |opts|
+    [true, false].sample
+  end
+end
+```
+
+The default mufflers are:
+
+  * `:header`
+  * `:ip`
+  * `:path`
+
+Contributing
+------------
+
+Pull requests are welcome.  Just make sure to include tests!
+
+To run tests, install some dependencies:
+
+```bash
+bundle install
+```
+
+Then, run tests with:
+
+```bash
+rake test
+```
+
+Or, If you want to check coverage:
+
+```bash
+COVERAGE=true rake test
+```
+
+Issues
+------
+
+Please use GitHub's [issue tracker](http://github.com/jisraelsen/muffler/issues).
+
+Author
+------
+
+[Jeremy Israelsen](http://github.com/jisraelsen)
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/muffler/config.rb

@@ -0,0 +1,20 @@
+module Muffler
+  class Config
+    attr_accessor :header, :ips, :paths, :mufflers
+
+    def initialize
+      @header = 'HTTP_X_MUFFLE_LOGGER' # send in header as X-Muffle-Logger
+      @ips = []
+      @paths = []
+      @mufflers = {}
+
+      muffle_with(:header) { |opts| !opts[@header].nil? }
+      muffle_with(:ip)     { |opts| @ips.any? { |ip| ip === opts['REMOTE_ADDR'] } }
+      muffle_with(:path)   { |opts| @paths.any? { |path| path === opts['PATH_INFO'] } }
+    end
+
+    def muffle_with(name, &block)
+      @mufflers[name] = block
+    end
+  end
+end

data/lib/muffler/rack/commonlogger.rb

@@ -0,0 +1,10 @@
+module Muffler
+  module Rack
+    class CommonLogger < ::Rack::CommonLogger
+      private
+      def log(env, status, header, began_at)
+        super unless Muffler.muffle?(env)
+      end
+    end
+  end
+end

data/lib/muffler/rack/logger.rb

@@ -0,0 +1,18 @@
+module Muffler
+  module Rack
+    class Logger < ::Rack::Logger
+      def call(env)
+        logger = ::Logger.new(env['rack.errors'])
+        logger.level = @level
+
+        env['rack.logger'] = logger
+
+        if Muffler.muffle?(env)
+          Muffler.muffle(logger) { @app.call(env) }
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/muffler/rack.rb

@@ -0,0 +1,2 @@
+require 'muffler/rack/commonlogger'
+require 'muffler/rack/logger'

data/lib/muffler/rails/logger.rb

@@ -0,0 +1,15 @@
+require 'rails/rack/logger'
+
+module Muffler
+  module Rails
+    class Logger < ::Rails::Rack::Logger
+      def call(env)
+        if Muffler.muffle?(env)
+          Muffler.muffle(::Rails.logger) { super }
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/muffler/rails.rb

@@ -0,0 +1,11 @@
+require 'muffler/rails/logger'
+
+module Muffler
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'muffler.middleware' do |app|
+        app.config.middleware.swap ::Rails::Rack::Logger, Muffler::Rails::Logger, app.config.log_tags
+      end
+    end
+  end
+end

data/lib/muffler/version.rb

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

data/lib/muffler.rb

@@ -0,0 +1,34 @@
+require 'logger'
+require 'muffler/config'
+require 'muffler/version'
+
+if defined?(Rails)
+  require 'muffler/rails'
+elsif defined?(Rack)
+  require 'muffler/rack'
+end
+
+module Muffler
+  class << self
+    def muffle?(opts={})
+      config.mufflers.values.any? { |m| m.call(opts) }
+    end
+
+    def muffle(logger, level=Logger::ERROR)
+      original_level = logger.level
+      logger.level = level
+
+      yield
+    ensure
+      logger.level = original_level
+    end
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/muffler.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'muffler/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "muffler"
+  gem.version       = Muffler::VERSION
+  gem.authors       = ["Jeremy Israelsen"]
+  gem.email         = ["jisraelsen@gmail.com"]
+  gem.description   = %q{Flexible log suppression for Ruby, Rack, and Rails.}
+  gem.summary       = %q{Flexible log suppression library.}
+  gem.homepage      = "http://github.com/jisraelsen/muffler"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'bundler',             '~> 1.2'
+  gem.add_development_dependency 'mocha',               '~> 0.13'
+  gem.add_development_dependency 'simplecov',           '~> 0.7'
+  gem.add_development_dependency 'guard-minitest',      '~> 0.5'
+end

data/spec/muffler/config_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+module Muffler
+  describe Config do
+    describe '#initialize' do
+      it 'initializes defaults' do
+        config = Config.new
+        config.header.must_equal 'HTTP_X_MUFFLE_LOGGER'
+        config.ips.must_equal []
+        config.paths.must_equal []
+      end
+
+      it 'adds default mufflers' do
+        muffle_opts = {
+          'HTTP_X_MUFFLE_LOGGER' => '1',
+          'REMOTE_ADDR' => '127.0.0.1',
+          'PATH_INFO' => '/login'
+           
+        }
+        dont_muffle_opts = {
+          'REMOTE_ADDR' => '10.1.1.3',
+          'PATH_INFO' => '/assets'
+        }
+
+        config = Config.new
+        config.ips << '127.0.0.1'
+        config.paths << '/login'
+
+        config.mufflers[:header].call(muffle_opts).must_equal true
+        config.mufflers[:ip].call(muffle_opts).must_equal true
+        config.mufflers[:path].call(muffle_opts).must_equal true
+
+        config.mufflers[:header].call(dont_muffle_opts).must_equal false
+        config.mufflers[:ip].call(dont_muffle_opts).must_equal false
+        config.mufflers[:path].call(dont_muffle_opts).must_equal false
+      end
+    end
+
+    describe '#muffle_with' do
+      it 'adds new muffler to mufflers hash' do
+        config = Config.new
+        config.mufflers.wont_include :test
+
+        config.muffle_with :test do |opts|
+          'this is a test'
+        end
+
+        config.mufflers.must_include :test
+        config.mufflers[:test].call({}).must_equal 'this is a test'
+      end
+
+      it 'replaces an existing muffler in the mufflers hash' do
+        config = Config.new
+        config.muffle_with :test do |opts|
+          'this is a test'
+        end
+
+        config.mufflers[:test].call({}).must_equal 'this is a test'
+
+        config.muffle_with :test do |opts|
+          'this is another test'
+        end
+
+        config.mufflers[:test].call({}).must_equal 'this is another test'
+      end
+    end
+  end
+end

data/spec/muffler_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Muffler do
+  describe '.muffle?' do
+    before do
+      Muffler.configure do |config|
+        config.ips << '127.0.0.1'
+        config.paths << '/assets'
+      end
+    end
+
+    it 'returns true if any mufflers return true' do
+      Muffler.muffle?('REMOTE_ADDR' => '127.0.0.1', 'PATH_INFO' => '/login').must_equal true
+    end
+
+    it 'returns false if all mufflers return false' do
+      Muffler.muffle?('REMOTE_ADDR' => '10.1.1.3', 'PATH_INFO' => '/login').must_equal false
+    end
+  end
+
+  describe '.muffle' do
+    before do
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+    end
+
+    describe 'with a provided log level' do
+      it 'changes log level to provided level in block' do
+        Muffler.muffle(@logger, Logger::WARN) do
+          @logger.level.must_equal Logger::WARN
+        end
+      end
+    end
+
+    describe 'with no provided log level' do
+      it 'changes log level to Logger::ERROR in block' do
+        Muffler.muffle(@logger) do
+          @logger.level.must_equal Logger::ERROR
+        end
+      end
+    end
+
+    it 'reverts log level back to original level after block' do
+      Muffler.muffle(@logger) {}
+      @logger.level.must_equal Logger::INFO
+    end
+  end
+
+  describe '.configure' do
+    it 'yields the config to a block' do
+      Muffler.configure do |config|
+        config.must_equal Muffler.config
+      end
+    end
+  end
+
+  describe '.config' do
+    it 'returns the Muffle config object' do
+      Muffler.config.must_be_instance_of Muffler::Config
+    end
+
+    it 'memoizes the config object' do
+      Muffler.config.object_id.must_equal Muffler.config.object_id
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+
+require 'muffler'

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: muffler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Israelsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Flexible log suppression for Ruby, Rack, and Rails.
+email:
+- jisraelsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/muffler.rb
+- lib/muffler/config.rb
+- lib/muffler/rack.rb
+- lib/muffler/rack/commonlogger.rb
+- lib/muffler/rack/logger.rb
+- lib/muffler/rails.rb
+- lib/muffler/rails/logger.rb
+- lib/muffler/version.rb
+- muffler.gemspec
+- spec/muffler/config_spec.rb
+- spec/muffler_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jisraelsen/muffler
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4000724842151476147
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Flexible log suppression library.
+test_files:
+- spec/muffler/config_spec.rb
+- spec/muffler_spec.rb
+- spec/spec_helper.rb