mongodb_logger 0.2.2 → 0.2.3

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## v0.2.3
+
+* Fix storage log with attachments (save it for search by "original\_filename" and "content\_type")
+* Fix tests for CI
+
+## v0.2.2
+
+* Fix set custom collection in config and add tests on it 
+
+## v0.2.1
+
+* Add show on 'more info' page meta data from log
+
+## v0.2.0
+
+* Public release

data/README.md

@@ -72,7 +72,8 @@ It:
         'request_time'     : date_of_request,
         'runtime'          : elapsed_execution_time_in_milliseconds,
         'url'              : full_url,
-        'method'           : request method (GET, POST, PUT, DELETE, OPTIONS)
+        'method'           : request method (GET, POST, OPTIONS),
+        'is_exception'     : true only for exceptions (in other cases this field miss)
       }
 
   Beyond that, if you want to add extra information to the base of the document (let's say something like user\_id on every request that it's available),
@@ -176,4 +177,4 @@ It:
 
       
       
-Copyright (c) 2009-2011 Phil Burrows, CustomInk and Leopard released under the MIT license
+Copyright (c) 2009-2011 Phil Burrows, CustomInk (based on https://github.com/customink/central_logger) and Leopard released under the MIT license

data/features/step_definitions/rails_application_steps.rb

@@ -47,6 +47,14 @@ end
 Then /^the tests should have run successfully$/ do
   step %{I run "rake test RAILS_ENV=test --trace"}
   @terminal.status.exitstatus.should == 0
+  # show errors
+  output_log = @terminal.output
+  is_pass = false
+  # TODO: fix regexp later, because can PASS in 10 or 100 failures
+  is_pass = true if ((1 == output_log.scan(/([.*]?)fail: 0(\D+)error: 0([\D+]?)/i).size) || (1 == output_log.scan(/(.*)0 failures(.*)0 errors(.*)/i).size))
+  puts @terminal.output unless is_pass
+  # check if have errors
+  is_pass.should == true
 end
 
 When /^I run "([^\"]*)"$/ do |command|

data/features/support/rails.rb

@@ -62,7 +62,14 @@ module RailsHelpers
   def add_routes
     content = File.read(routes_path)
     flag = Regexp.escape("Application.routes.draw do\n")
-    content.gsub!(/#{flag}/m, '\0 resources :order')
+    order_routes = <<STR
+resources :order do
+  collection do
+    post :test_post
+  end
+end
+STR
+    content.gsub!(/#{flag}/m, '\0 ' + order_routes)
     File.open(routes_path, 'wb') { |file| file.write(content) }
   end
   

data/features/support/terminal.rb

@@ -23,7 +23,8 @@ class Terminal
     @environment_variables = {
       "GEM_HOME" => LOCAL_GEM_ROOT,
       "GEM_PATH" => "#{LOCAL_GEM_ROOT}:#{BUILT_GEM_ROOT}",
-      "PATH" => "#{gem_bin_path}:#{ENV['PATH']}"
+      "PATH" => "#{gem_bin_path}:#{ENV['PATH']}",
+      "BUNDLE_GEMFILE" => File.join(LOCAL_RAILS_ROOT, 'Gemfile')
     }
   end
 

data/lib/mongodb_logger/logger.rb

@@ -2,6 +2,7 @@ require 'erb'
 require 'mongo'
 require 'active_support'
 require 'active_support/core_ext'
+require 'action_dispatch/http/upload'
 require 'mongodb_logger/replica_set_helper'
 
 module MongodbLogger
@@ -81,9 +82,15 @@ module MongodbLogger
       begin
         @insert_block.call
       rescue
-        # do extra work to inpect (and flatten)
-        force_serialize @mongo_record
-        @insert_block.call rescue nil
+        begin
+          # try to nice serialize record
+          nice_serialize @mongo_record
+          @insert_block.call
+        rescue
+          # do extra work to inpect (and flatten)
+          force_serialize @mongo_record
+          @insert_block.call rescue nil
+        end
       end
     end
 
@@ -172,18 +179,50 @@ module MongodbLogger
         # Cache it since these ActiveRecord attributes are assigned after logger initialization occurs in Rails boot
         @colorized ||= Object.const_defined?(:ActiveRecord) && ActiveRecord::LogSubscriber.colorize_logging
       end
+      
+      # try to serialyze data by each key and found invalid object
+      def nice_serialize(rec)
+        if msgs = rec[:messages]
+          msgs.each do |i, j|
+            msgs[i] = nice_serialize_object(j)
+          end
+        end
+        if pms = rec[:params]
+          pms.each do |i, j|
+            pms[i] = nice_serialize_object(j)
+          end
+        end
+      end
+      
+      def nice_serialize_object(data)
+        case data
+          when NilClass, String, Fixnum, Bignum, Float, TrueClass, FalseClass, Time, Regexp, Symbol
+            data
+          when Hash
+            hvalues = Hash.new
+            data.each{|k,v| hvalues[k] = nice_serialize_object(v) }
+            hvalues
+          when Array
+            data.map{|v| nice_serialize_object(v) }
+          when ActionDispatch::Http::UploadedFile, Rack::Test::UploadedFile # uploaded files
+            hvalues = {
+              :original_filename => data.original_filename,
+              :content_type => data.content_type
+            }
+          else
+            data.inspect
+        end
+      end
 
       # force the data in the db by inspecting each top level array and hash element
       # this will flatten other hashes and arrays
       def force_serialize(rec)
         if msgs = rec[:messages]
-          LOG_LEVEL_SYM.each do |i|
-            msgs[i].collect! { |j| j.inspect } if msgs[i]
-          end
+          msgs.each { |i, j| msgs[i] = j.inspect }
         end
         if pms = rec[:params]
           pms.each { |i, j| pms[i] = j.inspect }
         end
       end
   end
-end
+end

data/lib/mongodb_logger/server/view_helpers.rb

@@ -11,6 +11,10 @@ module Sinatra::ViewHelpers
     end
   end
   
+  def string_from_log_message(message)
+    message.is_a?(Array) ? message.join("\n") : message.to_s
+  end
+  
   def meta_informations(log)
     meta_data = Hash.new
     log.each do |key, val|

data/lib/mongodb_logger/server/views/shared/_log_info.erb

@@ -5,9 +5,9 @@
   <h2 class="phs mvs"><span class="<%= log_info['is_exception'] ? 'failure' : 'success' %>">Message</span></h2>
   <div class="phs wrap_text">
     <% if log_info['is_exception'] && log_info['messages'] && log_info['messages']['error'] %>
-      Error: <%= log_info['messages']['error'].join("\n").truncate(300, :separator => ' ') %>
+      Error: <%=h string_from_log_message(log_info['messages']['error']).truncate(300, :separator => ' ') %>
     <% elsif log_info['messages'] && log_info['messages']['info'] %>
-      Info: <%= log_info['messages']['info'].join("\n").truncate(300, :separator => ' ') %>
+      Info: <%=h string_from_log_message(log_info['messages']['info']).truncate(300, :separator => ' ') %>
     <% end %>
   </div> <!-- phs -->
   <h2 class="phs mtm mbs">URL (method: <%=h log_info['method'] %>)</h2>

data/lib/mongodb_logger/server/views/shared/_message_tabs.erb

@@ -9,7 +9,7 @@
     <% end %>
     </ul>
     <% message_tabs.each do |key, val| %>
-      <pre class="tab_<%=key %> tab_content <%='hidden' unless key == message_tabs.keys.first %>"><code><%=h (val.is_a?(Array) ? val.join("\n") : val) %></code></pre>
+      <pre class="tab_<%=key %> tab_content <%='hidden' unless key == message_tabs.keys.first %>"><code><%=h string_from_log_message(val) %></code></pre>
     <% end %>
   </div> <!-- unit -->
 </li>

data/lib/mongodb_logger/version.rb

@@ -1,3 +1,3 @@
 module MongodbLogger
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/mongodb_logger.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "i18n",            ">= 0.4.1"
   gem.add_runtime_dependency "json",            "~> 1.6.1"
   gem.add_runtime_dependency "activesupport",   ">= 3.0.0"
+  gem.add_runtime_dependency "actionpack",      ">= 3.0.0"
   gem.add_runtime_dependency "sinatra",         ">= 1.2.0"
   gem.add_runtime_dependency "erubis",          ">= 2.6.6"
   gem.add_runtime_dependency "vegas",           "~> 0.1.2"

data/test/config/samples/database_with_collection.yml

@@ -0,0 +1,8 @@
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+  mongodb_logger:
+    database: system_log
+    collection: log_collection

data/test/rails/app/controllers/order_controller.rb

@@ -5,8 +5,7 @@ class OrderController < ApplicationController
 
   def index
     logger.debug LOG_MESSAGE
-    logger.add_metadata(:application_name_again => Rails.root.basename.to_s)
-    logger.add_metadata(:user_id => LOG_USER_ID)
+    logger.add_metadata(:application_name_again => Rails.root.basename.to_s, :user_id => LOG_USER_ID)
     render :text => "nothing"
   end
 
@@ -17,4 +16,8 @@ class OrderController < ApplicationController
   def create
     render :text => "create"
   end
+  
+  def test_post
+    render :text => "done"
+  end
 end

data/test/rails/test/functional/order_controller_test.rb

@@ -57,6 +57,57 @@ class OrderControllerTest < ActionController::TestCase
     post :create, :activity => {:name =>  some_name}
     assert_equal 1, @collection.find({"params.activity.name" => some_name}).count
   end
+  
+  test "should search any values by params keys" do
+    post :test_post, :data => {
+      :int => 1,
+      :is_true => true,
+      :is_false => false,
+      :string => "string",
+      :push_hash => { :yes => "yes" },
+      :float => 1.22
+    }
+    
+    # such testing down on Rails 3.1.x, because in tests params converte Fixnum values into String
+    # :(
+    # assert_equal 1, @collection.find({"params.data.int" => 1}).count
+    
+    # data types
+    assert_equal 1, @collection.find({"params.data.is_true" => true}).count
+    assert_equal 1, @collection.find({"params.data.is_false" => false}).count
+    assert_equal 1, @collection.find({"params.data.string" => "string"}).count
+    assert_equal 1, @collection.find({"params.data.push_hash.yes" => "yes"}).count
+  end
+  
+  test "should search any values by params keys with attachments" do
+    filepath = "mltest_file.html"
+    content_type = "text/html"
+    tmpfile = File.open("#{ActionController::TestCase.fixture_path}#{filepath}", 'w') {|f| f.write("<html></html>") }
+    
+    uploaded_file = fixture_file_upload(filepath, content_type, :binary)
+    post :test_post, :data => {
+      :some_key => [
+        {:file => uploaded_file}
+      ],
+      :int => 1,
+      :is_true => true,
+      :is_false => false,
+      :string => "string",
+      :push_hash => { :yes => "yes" },
+      :float => 1.22
+    }
+    
+    # data types
+    assert_equal 1, @collection.find({"params.data.is_true" => true}).count
+    assert_equal 1, @collection.find({"params.data.is_false" => false}).count
+    assert_equal 1, @collection.find({"params.data.string" => "string"}).count
+    assert_equal 1, @collection.find({"params.data.push_hash.yes" => "yes"}).count
+    # attachment
+    assert_equal 1, @collection.find({"params.data.some_key.file.content_type" => content_type}).count
+    assert_equal 1, @collection.find({"params.data.some_key.file.original_filename" => filepath}).count
+    
+    File.delete(filepath) if File.exist?(filepath)
+  end
 
   test "should not log passwords" do
     post :create, :order => {:password => OrderController::LOG_MESSAGE }

data/test/test_helper.rb

@@ -23,6 +23,7 @@ class Test::Unit::TestCase
   SAMPLE_CONFIG_DIR = File.join(CONFIG_DIR, "samples")
   DEFAULT_CONFIG = "database.yml"
   DEFAULT_CONFIG_WITH_AUTH = "database_with_auth.yml"
+  DEFAULT_CONFIG_WITH_COLLECTION = "database_with_collection.yml"
   DEFAULT_CONFIG_WITH_NO_FILE_LOGGING = "database_no_file_logging.yml"
   MONGOID_CONFIG = "mongoid.yml"
   REPLICA_SET_CONFIG = "database_replica_set.yml"

data/test/unit/mongodb_logger_test.rb

@@ -249,4 +249,26 @@ class MongodbLogger::LoggerTest < Test::Unit::TestCase
     end
   end
   
+  context "A MongodbLogger::Logger with custom collection" do
+    setup do
+      file_path = File.join(SAMPLE_CONFIG_DIR, DEFAULT_CONFIG_WITH_COLLECTION)
+      FileUtils.cp(file_path,  File.join(CONFIG_DIR, DEFAULT_CONFIG))
+      @mongodb_logger = MongodbLogger::Logger.new
+      common_setup
+      @mongodb_logger.reset_collection
+
+      @file_config = YAML.load(ERB.new(File.new(file_path).read).result)[Rails.env]['mongodb_logger']
+    end
+
+    should "changed collection name" do
+      assert_equal @file_config['collection'], @mongodb_logger.mongo_collection_name
+      assert_equal "#{@file_config['database']}.#{@file_config['collection']}", @collection.stats()['ns']
+    end 
+    
+    teardown do
+      file = File.join(CONFIG_DIR, DEFAULT_CONFIG)
+      File.delete(file) if File.exist?(file)
+    end
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongodb_logger
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-10 00:00:00.000000000 Z
+date: 2011-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70258694621240 !ruby/object:Gem::Requirement
+  requirement: &7406740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70258694621240
+  version_requirements: *7406740
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70258694620360 !ruby/object:Gem::Requirement
+  requirement: &6984860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *70258694620360
+  version_requirements: *6984860
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70258694619600 !ruby/object:Gem::Requirement
+  requirement: &6983620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *70258694619600
+  version_requirements: *6983620
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70258694618680 !ruby/object:Gem::Requirement
+  requirement: &6981880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.2
   type: :development
   prerelease: false
-  version_requirements: *70258694618680
+  version_requirements: *6981880
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &70258694617380 !ruby/object:Gem::Requirement
+  requirement: &6980620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *70258694617380
+  version_requirements: *6980620
 - !ruby/object:Gem::Dependency
   name: uglifier
-  requirement: &70258694616620 !ruby/object:Gem::Requirement
+  requirement: &6978960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70258694616620
+  version_requirements: *6978960
 - !ruby/object:Gem::Dependency
   name: therubyracer
-  requirement: &70258694615720 !ruby/object:Gem::Requirement
+  requirement: &6672600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.9.9
   type: :development
   prerelease: false
-  version_requirements: *70258694615720
+  version_requirements: *6672600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70258694591620 !ruby/object:Gem::Requirement
+  requirement: &6671100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70258694591620
+  version_requirements: *6671100
 - !ruby/object:Gem::Dependency
   name: mongo
-  requirement: &70258694591080 !ruby/object:Gem::Requirement
+  requirement: &6668340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70258694591080
+  version_requirements: *6668340
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70258694590360 !ruby/object:Gem::Requirement
+  requirement: &6663080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70258694590360
+  version_requirements: *6663080
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70258694589720 !ruby/object:Gem::Requirement
+  requirement: &6661080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70258694589720
+  version_requirements: *6661080
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70258694588820 !ruby/object:Gem::Requirement
+  requirement: &6658000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,10 +142,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *70258694588820
+  version_requirements: *6658000
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70258694588000 !ruby/object:Gem::Requirement
+  requirement: &6653380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,21 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70258694588000
+  version_requirements: *6653380
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &6651760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *6651760
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70258694586720 !ruby/object:Gem::Requirement
+  requirement: &6650220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +175,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70258694586720
+  version_requirements: *6650220
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &70258694585960 !ruby/object:Gem::Requirement
+  requirement: &6649140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +186,10 @@ dependencies:
         version: 2.6.6
   type: :runtime
   prerelease: false
-  version_requirements: *70258694585960
+  version_requirements: *6649140
 - !ruby/object:Gem::Dependency
   name: vegas
-  requirement: &70258694585080 !ruby/object:Gem::Requirement
+  requirement: &6648360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -186,7 +197,7 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70258694585080
+  version_requirements: *6648360
 description: MongoDB logger for Rails 3
 email:
 - leopard.not.a@gmail.com
@@ -200,6 +211,7 @@ files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -293,6 +305,7 @@ files:
 - test/config/samples/database_no_file_logging.yml
 - test/config/samples/database_replica_set.yml
 - test/config/samples/database_with_auth.yml
+- test/config/samples/database_with_collection.yml
 - test/config/samples/mongodb_logger.yml
 - test/config/samples/mongoid.yml
 - test/rails.rb
@@ -329,25 +342,4 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: MongoDB logger for Rails 3
-test_files:
-- features/rails.feature
-- features/step_definitions/rails_application_steps.rb
-- features/support/env.rb
-- features/support/rails.rb
-- features/support/terminal.rb
-- test/active_record.rb
-- test/config/samples/database.yml
-- test/config/samples/database_no_file_logging.yml
-- test/config/samples/database_replica_set.yml
-- test/config/samples/database_with_auth.yml
-- test/config/samples/mongodb_logger.yml
-- test/config/samples/mongoid.yml
-- test/rails.rb
-- test/rails/app/controllers/order_controller.rb
-- test/rails/test/functional/order_controller_test.rb
-- test/rails/test/test_helper.rb
-- test/shoulda_macros/log_macros.rb
-- test/test.sh
-- test/test_helper.rb
-- test/unit/mongodb_logger_replica_test.rb
-- test/unit/mongodb_logger_test.rb
+test_files: []