better_logs 0.0.1.alpha1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 940d8126bd51e74118baef158662a95dbd33a4fd
-  data.tar.gz: 70081daa195b06a3e2ddec056ecb17ab54b65151
+  metadata.gz: ece6d96bc5daf1b196109b2c1c2862ea7a148a77
+  data.tar.gz: c109e15ba3a254740b285505310bdfbde6bb6037
 SHA512:
-  metadata.gz: 194c0bf6cf9b3aa7ce6916e454fb3c8d57e7962960615bb9893cdd5a2297d31b047a95fd98f77a63aef4028f2344af4e9bbc38727a6cf9e47604e6010ccc726c
-  data.tar.gz: 35ef1df79a8915caa6d5cdb9c201fab2ba2d3f4a8ea716e1a6d9fd86abf64c94a470ecc5a7e7c90d3be1cbc13b2e01e2f989f06d0415818f76fe7a55b03f1ef6
+  metadata.gz: 485eadc726d53f1b691872d19ccab0cb33ddb17f4352eb2883ca64f0b82eeb6da0d83c67f4e91407a719efa4982c9f1f384985c045104f116a264b01e67608e1
+  data.tar.gz: 59655ca7c6337bc82ca761c0fe69dbcbcbb62ead6b416c24e064c1571502724b23731e6356ff001a25920d6ee53d12d5b004ca1561f7ae57ded6638e70b5f894

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: 1RYbSf31ZCua8YV3evfPN7s21wM1ddTZs

data/.travis.yml

@@ -1,5 +1,12 @@
-language: ruby
+language:
+  - ruby
+cache:
+  - bundler
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+addons:
+  code_climate:
+    repo_token:
+      secure: IBQdXqdWdfTPduZhn4GJ/K0gcPY+1pJRH8AQvnoRTHWFrtOUAiLjPDycoyGA46BG4Zp5OOLeOloPvgctN80I7utVlg43bqZUgykCuBQRhW2yVN1eoBMDhhQ1zhDAuTCmI4Cpnj2ly1xQF4sKNxTOZNZmk+MTtEurFbewju+a518=

data/Gemfile

@@ -6,11 +6,11 @@ gem 'railties',      '~> 4.0'
 gem 'flat_keys',     '~> 0.0'
 
 group :development do
-  gem 'rdoc',                     '~> 3.12'
-  gem 'bundler',                  '~> 1.0'
-  gem 'jeweler',                  '~> 2.0'
-  gem 'simplecov',                '~> 0.8'
-  gem 'rspec',                    '~> 2.14'
-  gem 'guard-rspec',              '~> 4.2'
-  gem 'terminal-notifier-guard',  '~> 1.5'
+  gem 'rdoc',                      '~> 4.1'
+  gem 'bundler',                   '~> 1.0'
+  gem 'jeweler',                   '~> 2.0'
+  gem 'rspec',                     '~> 2.14'
+  gem 'guard-rspec',               '~> 4.2'
+  gem 'terminal-notifier-guard',   '~> 1.5'
+  gem 'codeclimate-test-reporter', '~> 0.3', require: nil
 end

data/Gemfile.lock

@@ -23,6 +23,8 @@ GEM
     celluloid-io (0.15.0)
       celluloid (>= 0.15.0)
       nio4r (>= 0.5.0)
+    codeclimate-test-reporter (0.3.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
@@ -43,9 +45,9 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.0)
       oauth2
-    guard (2.5.1)
+    guard (2.6.0)
       formatador (>= 0.2.4)
-      listen (~> 2.6)
+      listen (~> 2.7)
       lumberjack (~> 1.0)
       pry (>= 0.9.12)
       thor (>= 0.18.1)
@@ -67,12 +69,12 @@ GEM
     json (1.8.1)
     jwt (0.1.11)
       multi_json (>= 1.5)
-    listen (2.7.0)
+    listen (2.7.2)
       celluloid (>= 0.15.2)
       celluloid-io (>= 0.15.0)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-    lumberjack (1.0.4)
+    lumberjack (1.0.5)
     method_source (0.8.2)
     mini_portile (0.5.3)
     minitest (5.3.3)
@@ -104,7 +106,7 @@ GEM
     rb-fsevent (0.9.4)
     rb-inotify (0.9.3)
       ffi (>= 0.5.0)
-    rdoc (3.12.2)
+    rdoc (4.1.1)
       json (~> 1.4)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
@@ -119,7 +121,7 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    slop (3.4.7)
+    slop (3.5.0)
     terminal-notifier-guard (1.5.3)
     thor (0.19.1)
     thread_safe (0.3.3)
@@ -134,11 +136,11 @@ DEPENDENCIES
   actionpack (~> 4.0)
   activesupport (~> 4.0)
   bundler (~> 1.0)
+  codeclimate-test-reporter (~> 0.3)
   flat_keys (~> 0.0)
   guard-rspec (~> 4.2)
   jeweler (~> 2.0)
   railties (~> 4.0)
-  rdoc (~> 3.12)
+  rdoc (~> 4.1)
   rspec (~> 2.14)
-  simplecov (~> 0.8)
   terminal-notifier-guard (~> 1.5)

data/Guardfile

@@ -1,24 +1,5 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :rspec do
+guard :rspec, cmd: 'clear; bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})
-  #      { |m| "spec/lib/#{m[1]}_spec.rb" }
-  # watch('spec/spec_helper.rb')  { "spec" }
-  #
-  # # Rails example
-  # watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  # watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  # watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  # watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  # watch('config/routes.rb')                           { "spec/routing" }
-  # watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-  #
-  # # Capybara features specs
-  # watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
-  #
-  # # Turnip features and steps
-  # watch(%r{^spec/acceptance/(.+)\.feature$})
-  # watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
 end

data/README.rdoc

@@ -1,5 +1,7 @@
 {<img src="https://travis-ci.org/techthumb/better_logs.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/techthumb/better_logs]
-
+{<img src="https://badge.fury.io/rb/better_logs.svg" alt="Gem Version" />}[http://badge.fury.io/rb/better_logs]
+{<img src="https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/badges/1196b8f5d38c79f87546/gpa.png" />}[https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/feed]
+{<img src="https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/badges/1196b8f5d38c79f87546/coverage.png" />}[https://codeclimate.com/repos/535a5dcae30ba03fdc00efe2/feed]
 = BetterLogs
 
 Logging for Rails request/response lifecycle in a machine readable format (starting with Splunk) — Edit

data/VERSION

@@ -1 +1 @@
-0.0.1.alpha1
+0.1.0

data/better_logs.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: better_logs 0.0.1.alpha1 ruby lib
+# stub: better_logs 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "better_logs"
-  s.version = "0.0.1.alpha1"
+  s.version = "0.1.0"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Kunal Parikh"]
-  s.date = "2014-04-25"
+  s.date = "2014-04-27"
   s.description = "Logging for Rails request/response lifecycle in a machine readable format (starting with Splunk)"
   s.email = "kunal@techthumb.in"
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
+    ".coveralls.yml",
     ".document",
     ".travis.yml",
     "Gemfile",
@@ -37,11 +38,10 @@ Gem::Specification.new do |s|
     "lib/better_logs/formatters/key_value_formatter.rb",
     "lib/better_logs/initializer.rb",
     "lib/better_logs/railtie.rb",
-    "spec/action_controller/payload_spec.rb",
-    "spec/formatters/key_value_formatter_spec.rb",
-    "spec/spec_helper.rb",
-    "test/helper.rb",
-    "test/test_better_logging.rb"
+    "spec/lib/better_logs/action_controller/log_subscriber_spec.rb",
+    "spec/lib/better_logs/action_controller/payload_spec.rb",
+    "spec/lib/better_logs/formatters/key_value_formatter_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/techthumb/better_logs"
   s.licenses = ["MIT"]
@@ -56,38 +56,38 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<actionpack>, ["~> 4.0"])
       s.add_runtime_dependency(%q<railties>, ["~> 4.0"])
       s.add_runtime_dependency(%q<flat_keys>, ["~> 0.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.1"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
-      s.add_development_dependency(%q<simplecov>, ["~> 0.8"])
       s.add_development_dependency(%q<rspec>, ["~> 2.14"])
       s.add_development_dependency(%q<guard-rspec>, ["~> 4.2"])
       s.add_development_dependency(%q<terminal-notifier-guard>, ["~> 1.5"])
+      s.add_development_dependency(%q<codeclimate-test-reporter>, ["~> 0.3"])
     else
       s.add_dependency(%q<activesupport>, ["~> 4.0"])
       s.add_dependency(%q<actionpack>, ["~> 4.0"])
       s.add_dependency(%q<railties>, ["~> 4.0"])
       s.add_dependency(%q<flat_keys>, ["~> 0.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rdoc>, ["~> 4.1"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0"])
-      s.add_dependency(%q<simplecov>, ["~> 0.8"])
       s.add_dependency(%q<rspec>, ["~> 2.14"])
       s.add_dependency(%q<guard-rspec>, ["~> 4.2"])
       s.add_dependency(%q<terminal-notifier-guard>, ["~> 1.5"])
+      s.add_dependency(%q<codeclimate-test-reporter>, ["~> 0.3"])
     end
   else
     s.add_dependency(%q<activesupport>, ["~> 4.0"])
     s.add_dependency(%q<actionpack>, ["~> 4.0"])
     s.add_dependency(%q<railties>, ["~> 4.0"])
     s.add_dependency(%q<flat_keys>, ["~> 0.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rdoc>, ["~> 4.1"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0"])
-    s.add_dependency(%q<simplecov>, ["~> 0.8"])
     s.add_dependency(%q<rspec>, ["~> 2.14"])
     s.add_dependency(%q<guard-rspec>, ["~> 4.2"])
     s.add_dependency(%q<terminal-notifier-guard>, ["~> 1.5"])
+    s.add_dependency(%q<codeclimate-test-reporter>, ["~> 0.3"])
   end
 end
 

data/lib/better_logs.rb

@@ -2,6 +2,7 @@ module ::BetterLogs
 end
 
 require 'flat_keys'
+require 'rails'
 require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'action_pack'

data/lib/better_logs/action_controller/log_subscriber.rb

@@ -1,14 +1,13 @@
 class ::BetterLogs::ActionController::LogSubscriber < ActiveSupport::LogSubscriber
-  def process_action(event)
-    logger.info formatter.format(::BetterLogs::ActionController::Payload.new(event.payload))
-  end
+  attr_reader :formatter, :logger
 
-  private
-  def logger
-    Rails.logger
+  def initialize(formatter = ::BetterLogs::Formatters::KeyValueFormatter.new,
+                 logger    = ::Rails.logger)
+    @formatter = formatter
+    @logger    = logger
   end
 
-  def formatter
-    @formatter ||= ::BetterLogs::Formatters::KeyValueFormatter.new
+  def process_action(event)
+    logger.info formatter.format(::BetterLogs::ActionController::Payload.new(event.payload))
   end
 end

data/lib/better_logs/action_controller/payload.rb

@@ -3,6 +3,7 @@ class ::BetterLogs::ActionController::Payload < DelegateClass(ActiveSupport::Has
   def initialize(payload)
     payload = payload.with_indifferent_access
     data = payload.except(*IGNORED_KEYS)
+    data[:status] = 500 if data.has_key?(:exception)
     if data.has_key?(:params)
       data[:controller] = data[:params].delete(:controller)
       data[:action] = data[:params].delete(:action)

data/spec/lib/better_logs/action_controller/log_subscriber_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe ::BetterLogs::ActionController::LogSubscriber do
+  context 'formatter' do
+    subject { described_class.new.formatter }
+
+    it "defaults to '#{::BetterLogs::Formatters::KeyValueFormatter.name}'" do
+      should be_an_instance_of ::BetterLogs::Formatters::KeyValueFormatter
+    end
+  end
+
+  context 'logger' do
+    before              { Rails.stub(:logger).and_return(rails_logger) }
+    let(:rails_logger)  { double(ActiveSupport::Logger) }
+    subject             { described_class.new.logger }
+
+    it "defaults to 'Rails.logger'" do
+      should === rails_logger
+    end
+  end
+end

data/spec/{action_controller → lib/better_logs/action_controller}/payload_spec.rb

@@ -1,15 +1,24 @@
 require 'spec_helper'
 describe ::BetterLogs::ActionController::Payload do
-  let(:payload) { {nested: {keys: {should: {be: {flattened: 'with dots'}}}}} }
 
   subject { ::BetterLogs::ActionController::Payload.new(payload) }
 
   describe 'when payload is a nested hash' do
+    let(:payload) { {nested: {keys: {should: {be: {flattened: 'with dots'}}}}} }
     it 'flattens nested keys' do
       subject.should == { 'nested.keys.should.be.flattened' => 'with dots' }
     end
   end
 
+  describe 'when payload includes key :exception' do
+    let(:payload) { {exception: 'some exception'} }
+    it 'should add a status of 500' do
+      subject.should include('status')
+      subject['status'].should == 500
+    end
+  end
+
+
   %w(action controller).each do | key |
     describe "when payload includes key :#{key}" do
       let(:payload) { {"#{key}" => :some_value} }

data/spec/lib/better_logs/formatters/key_value_formatter_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe BetterLogs::Formatters::KeyValueFormatter do
+  describe '#format' do
+
+    let(:payload) do
+      BetterLogs::ActionController::Payload.new(key_one: 'value_one', key_two: 'value_two')
+    end
+
+    subject { BetterLogs::Formatters::KeyValueFormatter.new.format(payload) }
+
+    it { should == 'key_one=value_one key_two=value_two' }
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,3 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
 require_relative '../lib/better_logs'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_logs
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha1
+  version: 0.1.0
 platform: ruby
 authors:
 - Kunal Parikh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,61 +109,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: terminal-notifier-guard
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0.3'
 description: Logging for Rails request/response lifecycle in a machine readable format
   (starting with Splunk)
 email: kunal@techthumb.in
@@ -173,6 +173,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files:
+- .coveralls.yml
 - .document
 - .travis.yml
 - Gemfile
@@ -191,11 +192,10 @@ files:
 - lib/better_logs/formatters/key_value_formatter.rb
 - lib/better_logs/initializer.rb
 - lib/better_logs/railtie.rb
-- spec/action_controller/payload_spec.rb
-- spec/formatters/key_value_formatter_spec.rb
+- spec/lib/better_logs/action_controller/log_subscriber_spec.rb
+- spec/lib/better_logs/action_controller/payload_spec.rb
+- spec/lib/better_logs/formatters/key_value_formatter_spec.rb
 - spec/spec_helper.rb
-- test/helper.rb
-- test/test_better_logging.rb
 homepage: http://github.com/techthumb/better_logs
 licenses:
 - MIT
@@ -211,9 +211,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.1

data/spec/formatters/key_value_formatter_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-describe BetterLogs::Formatters::KeyValueFormatter do
-  let(:payload) { BetterLogs::ActionController::Payload.new({key_one: 'value_one', key_two: 'value_two'}) }
-
-  subject { BetterLogs::Formatters::KeyValueFormatter.new.format(payload) }
-  it { should == 'key_one=value_one key_two=value_two' }
-end

data/test/helper.rb

@@ -1,34 +0,0 @@
-require 'simplecov'
-
-module SimpleCov::Configuration
-  def clean_filters
-    @filters = []
-  end
-end
-
-SimpleCov.configure do
-  clean_filters
-  load_adapter 'test_frameworks'
-end
-
-ENV["COVERAGE"] && SimpleCov.start do
-  add_filter "/.rvm/"
-end
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'better_logs'
-
-class Test::Unit::TestCase
-end

data/test/test_better_logging.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestBetterLogging < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end