bunyan 0.4.0 → 0.4.1

data/.gitignore

@@ -1,3 +1,4 @@
 .bundle
 coverage
 pkg
+.rvmrc

data/Gemfile

@@ -1,9 +1,9 @@
-gem 'bson_ext',   '>= 0.20.1'
-gem 'mongo',      '>= 0.20'
+source 'http://rubygems.org'
+
+gemspec
 
 group :test do
   gem 'rspec', '>= 1.3.0'
   gem 'ZenTest'
   gem 'autotest-growl'
-  gem 'autotest-fsevent'
 end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    bunyan (0.4.0)
+      bson_ext (>= 0.20.1)
+      mongo (>= 0.20.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.0)
+    autotest (4.3.2)
+    autotest-growl (0.2.4)
+      autotest (>= 4.2.4)
+    bson (1.0.7)
+    bson_ext (1.0.7)
+    mongo (1.0.8)
+      bson (>= 1.0.5)
+    rspec (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  autotest-growl
+  bson_ext (>= 0.20.1)
+  bunyan!
+  mongo (>= 0.20.1)
+  rspec (>= 1.3.0)

data/README.md

@@ -45,6 +45,19 @@ The Logger class is implemented as a singleton, and you can call any instance
 method on the Logger class. This is implemented with some method_missing magic,
 which is explained in a bit more detail below.
 
+Middleware
+==========
+To make use of Bunyan in your web apps, you need some way to capture request data. 
+I have added an example middleware (which is extremely, extremely ugly) which you
+can find at `examples/middleware.rb`. 
+
+There are plans for a standard middleware API, but it has not yet been implemented.
+If you have interest in helping/collaborating on this feature, please get in touch
+with me. 
+
+Until the middleware API is complete, please use this example middleware at your
+own risk!
+
 Internals
 =========
 Bunyan makes heavy usage of method\_missing both at the class and instance level.

data/Rakefile

@@ -7,11 +7,14 @@ begin
     gemspec.email = "ajsharp@gmail.com"
     gemspec.homepage = "http://github.com/ajsharp/bunyan"
     gemspec.authors = ["Alex Sharp"]
-    gemspec.add_dependency 'mongo',     '>= 0.20.1'
-    gemspec.add_dependency 'bson_ext', '>= 0.20.1'
+    gemspec.add_dependency 'mongo',     '~> 1.0.8'
+    gemspec.add_dependency 'bson_ext',  '~> 1.0.7'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
 end
 
+task :default do
+  system("spec spec")
+end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/bunyan.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bunyan}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Sharp"]
-  s.date = %q{2010-08-14}
+  s.date = %q{2010-09-02}
   s.description = %q{Bunyan is a thin ruby wrapper around a MongoDB capped collection, created with high-performance, flexible logging in mind.}
   s.email = %q{ajsharp@gmail.com}
   s.extra_rdoc_files = [
@@ -19,11 +19,13 @@ Gem::Specification.new do |s|
     ".gitignore",
      "CHANGELOG.md",
      "Gemfile",
+     "Gemfile.lock",
      "MIT-LICENSE",
      "README.md",
      "Rakefile",
      "VERSION",
      "bunyan.gemspec",
+     "examples/middleware.rb",
      "examples/rails.rb",
      "lib/bunyan.rb",
      "lib/bunyan/config.rb",
@@ -37,13 +39,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/ajsharp/bunyan}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A MongoDB-based logging solution.}
   s.test_files = [
     "spec/bunyan_spec.rb",
      "spec/config_spec.rb",
      "spec/integration_spec.rb",
      "spec/spec_helper.rb",
+     "examples/middleware.rb",
      "examples/rails.rb"
   ]
 
@@ -51,16 +54,16 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongo>, [">= 0.20.1"])
-      s.add_runtime_dependency(%q<bson_ext>, [">= 0.20.1"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongo>, ["~> 1.0.8"])
+      s.add_runtime_dependency(%q<bson_ext>, ["~> 1.0.7"])
     else
-      s.add_dependency(%q<mongo>, [">= 0.20.1"])
-      s.add_dependency(%q<bson_ext>, [">= 0.20.1"])
+      s.add_dependency(%q<mongo>, ["~> 1.0.8"])
+      s.add_dependency(%q<bson_ext>, ["~> 1.0.7"])
     end
   else
-    s.add_dependency(%q<mongo>, [">= 0.20.1"])
-    s.add_dependency(%q<bson_ext>, [">= 0.20.1"])
+    s.add_dependency(%q<mongo>, ["~> 1.0.8"])
+    s.add_dependency(%q<bson_ext>, ["~> 1.0.7"])
   end
 end
 

data/examples/middleware.rb

@@ -0,0 +1,67 @@
+# This sample middleware is provided purerly as an example. 
+# It is meant to be used with authlogic.
+# Please use it as your own risk.
+# Once I implement some type of bunyan middleware, this file will be removed.
+# - @ajsharp
+class BunyanMiddleware
+  def initialize(app)
+    @app = app
+  end
+  
+  # there are a number of conditions where we want to bypass and not log anything
+  def call(env)
+    @status, @headers, @response = @app.call(env)
+    if @status != 304 && @response && !@response.body.is_a?(Proc)
+      Bunyan::Logger.insert(prepare_extra_fields) 
+    end
+    [@status, @headers, @response]
+  end
+
+  protected
+    def prepare_extra_fields
+      prepare_additional_response_data.merge(prepare_user_data) || {}
+    end
+
+    def prepare_additional_response_data
+      unless @response.blank?
+        { 'request_method' => @response.request.request_method,
+          'user_agent'     => @response.request.user_agent,
+          'status'         => @status,
+          'request_uri'    => @response.request.request_uri,
+          'request_time'   => Time.now.utc,
+          'controller_action' => format_controller_action } 
+      end || {}
+    end
+
+    def format_controller_action
+      params = @response.request.path_parameters
+      "#{params['controller']}##{params['action']}"
+    end
+
+    def prepare_user_data
+      if user_exists_in_session?
+        begin
+          user = User.find(@response.session[user_credentials_key])
+          { 'user' => { 'email'      => user.email, 
+                        'first_name' => user.first_name,
+                        'last_name'  => user.last_name,
+                        'roles'      => user.role_names
+                      } 
+          }
+        rescue ActiveRecord::RecordNotFound
+          {}
+        end
+      else
+        {}
+      end
+    end
+
+    def user_exists_in_session?
+      !!(@response != [] && @response.session && @response.session[user_credentials_key])
+    end
+
+    def user_credentials_key
+      'user_credentials_id'
+    end
+
+end

data/spec/integration_spec.rb

@@ -15,7 +15,7 @@ describe 'making a mongodb connection with the new configuration syntax' do
   end
     
   it 'should allow inserting documents' do
-    Bunyan::Logger.insert(@params).should be_instance_of BSON::ObjectID
+    Bunyan::Logger.insert(@params).should be_instance_of BSON::ObjectId
   end
   
   it 'should allow querying documents' do
@@ -39,11 +39,11 @@ describe 'making a mongodb connection with the old configuration syntax' do
   end
     
   it 'should allow inserting documents' do
-    Bunyan::Logger.insert(@params).should be_instance_of BSON::ObjectID
+    Bunyan::Logger.insert(@params).should be_instance_of BSON::ObjectId
   end
   
   it 'should allow querying documents' do
     Bunyan::Logger.insert(@params)
     Bunyan::Logger.find(@params).count.should == 1
   end
-end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bunyan
 version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Alex Sharp
@@ -14,35 +15,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-14 00:00:00 -07:00
+date: 2010-09-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mongo
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
-        - 0
-        - 20
         - 1
-        version: 0.20.1
+        - 0
+        - 8
+        version: 1.0.8
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bson_ext
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
-        - 0
-        - 20
         - 1
-        version: 0.20.1
+        - 0
+        - 7
+        version: 1.0.7
   type: :runtime
   version_requirements: *id002
 description: Bunyan is a thin ruby wrapper around a MongoDB capped collection, created with high-performance, flexible logging in mind.
@@ -57,11 +62,13 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
 - VERSION
 - bunyan.gemspec
+- examples/middleware.rb
 - examples/rails.rb
 - lib/bunyan.rb
 - lib/bunyan/config.rb
@@ -81,23 +88,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A MongoDB-based logging solution.
@@ -106,4 +117,5 @@ test_files:
 - spec/config_spec.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
+- examples/middleware.rb
 - examples/rails.rb