ringbarker 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-09-12
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ringbarker
+lib/ringbarker.rb
+lib/ringbarker/parser.rb
+lib/ringbarker/entry.rb
+spec/entry_spec.rb
+spec/parser_spec.rb
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,62 @@
+ringbarker
+    by Lachie Cox
+    http://blog.smartbomb.com.au
+
+== DESCRIPTION:
+  
+A simple parser for Rails logs.
+
+== FEATURES/PROBLEMS:
+  
+* Parses the Rails log.
+* Recognises Processing...Completed blocks.
+* Recognises Processing...exception...Rendering rescue blocks.
+* Collects the fluff between Processing blocks too.
+* Does as little interpretation of the parsed requests as possible. This is left up to the client.
+* Needs better doco.
+
+== SYNOPSIS:
+
+  require 'rubygems'
+  require 'ringbarker'
+
+  @parser = Ringbarker::Parser.new
+  @entries = []
+
+  @log_lines.each do |line|
+    @parser << line
+    @parser.dequeue.each {|entry| @entries << entry}
+  end
+
+== REQUIREMENTS:
+
+* None
+
+== INSTALL:
+
+* sudo gem install ringbarker
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Lachie Cox
+
+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/Rakefile

@@ -0,0 +1,35 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'spec'
+require 'spec/rake/spectask'
+require './lib/ringbarker.rb'
+
+Hoe.new('ringbarker', Ringbarker::VERSION) do |p|
+  p.rubyforge_name = 'rails-oceania'
+  p.author = 'Lachie Cox'
+  p.email = 'lachie@smartbomb.com.au'
+  p.summary = 'simple Rails log parser'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  
+  p.test_globs = ["spec/**/*_spec.rb"]
+end
+
+
+class Hoe
+  def run_testsx(multi=false)
+  
+  end
+end
+
+
+desc "Run the specs under spec"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+
+# vim: syntax=Ruby

data/lib/ringbarker.rb

@@ -0,0 +1,6 @@
+$:.unshift File.dirname(__FILE__)
+require 'ringbarker/parser'
+
+module Ringbarker
+  VERSION = '0.0.1'
+end

data/lib/ringbarker/entry.rb

@@ -0,0 +1,98 @@
+
+
+module Ringbarker
+  module StringHelpers
+    def starts_with?(prefix)
+      to_s[0..(prefix.to_s.length - 1)] == prefix.to_s
+    end
+  end
+end
+
+class String
+  include Ringbarker::StringHelpers
+end
+
+  
+class Ringbarker::Entry
+  attr_reader :lines
+  attr_reader :controller, :action, :verb, :ip
+  attr_reader :session_id, :parameters, :http_code, :complete
+  attr_reader :fluff
+  
+  attr_accessor :requested_at
+  
+  def initialize(lines=[],complete=false,fluff=false)
+    @lines = lines
+    @complete = complete
+    @fluff = fluff
+  end
+  
+  def self.new_from_fluff(lines,requested_at)
+    f = new(lines.dup,true,true)
+    f.requested_at = Time.at(requested_at)
+    f
+  end
+  
+  def << line
+    if @lines.empty?
+      parse_header(line)
+    elsif line.starts_with? 'Completed'
+      parse_completed(line)
+    elsif line.starts_with? 'Rendering'
+      parse_rendering(line)
+    end
+    
+    @lines << line
+  end
+  
+  def requested_at_seconds
+    self.requested_at.to_i
+  end
+  
+  def complete?; @complete; end
+  def fluff?; @fluff; end
+  
+  
+  COMPLETED_RE = /(\d+) \w+ \[http:\/\/[^\]]+\]$/
+  def parse_completed line
+    if m = line.match(COMPLETED_RE)
+      @http_code = m[1].to_i
+      @complete = true
+    end
+  end
+  
+  RENDERING_RE = %r{^Rendering.*rescues/layout\.rhtml \((\d+)}
+  def parse_rendering line
+    if m = line.match(RENDERING_RE)
+      @http_code = m[1].to_i
+      @complete = true
+    end
+  end
+  
+  PROCESSING_RE = /^Processing (\w+)\#(\w+) \(for ([\d\.]+) at ([\d-]{10} [\d:]{8})\) \[([A-Z]+)\]/
+  def parse_header(line)
+    if match = line.match(PROCESSING_RE)
+      _,@controller,@action,@ip,requested_at,verb = *match
+      @verb = verb.downcase.to_sym
+      @requested_at = Time.parse(requested_at)
+    end
+  end
+  
+  SESSION_ID_RE = /\s+Session ID: ([a-zA-Z\d]+)/
+  PARAMS_RE = /^\s+Parameters: (.*)$/
+  
+  def parse_details line
+    case line
+    when SESSION_ID_RE then set_session_id(*$~)
+    when PARAMS_RE     then set_params(*$~)
+    end
+  end
+  
+  def set_session_id(_,id)
+    @session_id = id
+  end
+  
+  def set_params(_,params)
+    @parameters = params
+  end
+end

data/lib/ringbarker/parser.rb

@@ -0,0 +1,56 @@
+require 'ringbarker/entry'
+
+module Ringbarker
+  class Parser
+    attr_reader :entries
+    
+    def initialize
+      @entries = []
+      @fluff = []
+      @last_time = 0
+      @current_entry = false
+    end
+    
+    def <<(line)
+      if line[/^Processing/]
+        collect_fluff
+        
+        @entries << @current_entry = Entry.new
+      elsif !@current_entry && !line.strip.empty?
+        @fluff << line
+      end
+      
+      @current_entry << line if @current_entry
+    end
+    
+    def collect_fluff
+      return if @fluff.empty?
+      @entries << Entry.new_from_fluff(@fluff,@last_time)
+      @fluff = []
+    end
+    
+    def cleanup_dequeue
+      collect_fluff unless @current_entry
+      dequeue
+    end
+    
+    def dequeue
+      deq = if @entries.empty?
+              []
+            elsif @entries.last.complete?
+              deq = @entries.dup
+              @entries = []
+              @current_entry = nil
+              deq
+            else
+              deq = @entries[0..-2]
+              @entries = @entries[-1..-1]
+              deq
+            end
+      
+      @last_time = deq.last.requested_at_seconds unless deq.empty?
+      
+      deq
+    end
+  end
+end

data/spec/entry_spec.rb

@@ -0,0 +1,136 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Ringbarker::Entry, "parsing the header" do
+  before do
+    @entry = Ringbarker::Entry.new
+    @entry.parse_header('Processing LogeyeController#index (for 127.0.0.1 at 2007-09-07 17:52:13) [GET]')
+  end
+  
+  it "should have controller" do
+    @entry.controller.should == 'LogeyeController'
+  end
+  
+  it "should have action" do
+    @entry.action.should == 'index'
+  end
+
+  it "should have ip" do
+    @entry.ip.should == '127.0.0.1'
+  end
+  
+  it "should have verb" do
+    @entry.verb.should == :get
+  end
+  
+  it "should have reqested_at" do
+    @entry.requested_at.should == Time.at(1189151533)
+  end
+  
+  it "should have requested_at_seconds" do
+    @entry.requested_at_seconds.should == 1189151533
+  end
+  
+  it "should not be complete" do
+    @entry.should_not be_complete
+  end
+end
+
+describe Ringbarker::Entry, "created from fluff" do
+  before do
+    fluff = [
+      "fluff 1",
+      "fluff 2"
+    ]
+    @entry = Ringbarker::Entry.new_from_fluff fluff, 0
+  end
+  
+  it "should have 2 lines" do
+    @entry.should have(2).lines
+  end
+  
+  it "should be complete" do
+    @entry.should be_complete
+  end
+end
+
+describe Ringbarker::Entry, "parsing a session id line" do
+  before do
+    @entry = Ringbarker::Entry.new
+    @entry.parse_details '  Session ID: c8a758cf873b429aaf06c4b8832ce241'
+  end
+  
+  it "should have session_id" do
+    @entry.session_id.should == 'c8a758cf873b429aaf06c4b8832ce241'
+  end
+end
+
+describe Ringbarker::Entry, "parsing a parameters line" do
+  before do
+    @entry = Ringbarker::Entry.new
+    @entry.parse_details '  Parameters: {"action"=>"index", "controller"=>"logeye"}'
+  end
+  
+  it "should have parameters" do
+    @entry.parameters.should == '{"action"=>"index", "controller"=>"logeye"}'
+  end
+end
+
+describe Ringbarker::Entry, "parsing a completed line" do
+  before do
+    @entry = Ringbarker::Entry.new
+    @entry.parse_completed 'Completed in 0.00119 (841 reqs/sec) | Rendering: 0.00004 (3%) | 200 OK [http://0.0.0.0/logeye]'
+  end
+  
+  it "should have http code" do
+    @entry.http_code.should == 200
+  end
+  
+  it "should be complete" do
+    @entry.should be_complete
+  end
+end
+
+describe Ringbarker::Entry, "parsing a line beginning with completed" do
+  before do
+    @entry = Ringbarker::Entry.new
+    @entry.parse_completed 'Completed n00by d00beez'
+  end
+  
+  it "should not have http code" do
+    @entry.http_code.should be_nil
+  end
+  
+  it "should not be complete" do
+    @entry.should_not be_complete
+  end
+end
+
+describe Ringbarker::Entry, "parsing a Rendered rescue line" do
+  before do
+    @entry = Ringbarker::Entry.new
+    @entry.parse_rendering 'Rendering /opt/local/lib/ruby/gems/1.8/gems/actionpack-1.13.3/lib/action_controller/templates/rescues/layout.rhtml (404 Page Not Found)'
+  end
+  
+  it "should should have http code" do
+    @entry.http_code.should == 404
+  end
+  
+  it "should be complete" do
+    @entry.should be_complete
+  end
+end
+
+describe Ringbarker::Entry, "parsing a normal Rendered line" do
+  before do
+    @entry = Ringbarker::Entry.new
+    @entry.parse_rendering 'Rendering widgets/show'
+  end
+  
+  it "should should not have http code" do
+    @entry.http_code.should be_nil
+  end
+  
+  it "should not be complete" do
+    @entry.should_not be_complete
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,112 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+
+describe Ringbarker do
+  before do
+    @parser = Ringbarker::Parser.new
+  end
+  
+  it "should have no entries" do
+    @parser.should have(0).entries
+  end
+end
+
+describe Ringbarker, "with one request" do
+  before do
+    @parser = Ringbarker::Parser.new
+    @lines = [
+      'guffle',
+      '',
+      'Processing LogeyeController#index (for 127.0.0.1 at 2007-09-07 17:41:49) [GET]',
+      '  Session ID: c8a758cf873b429aaf06c4b8832ce241',
+      '  Parameters: {"action"=>"index", "controller"=>"logeye"}',
+      '',
+      ''
+    ]
+    
+    @lines.each {|line| @parser << line}
+  end
+
+  
+  it "should have two entry" do
+    @parser.should have(2).entries
+  end
+  
+  it "should have fluff lines as first line" do
+    @parser.entries.first.lines.first.should == 'guffle'
+  end
+  
+  it "should have fluff as first line" do
+    @parser.entries.first.should be_fluff
+  end
+  
+  it "should have processing line as first in first entry" do
+    @parser.entries.last.lines.first.should == 'Processing LogeyeController#index (for 127.0.0.1 at 2007-09-07 17:41:49) [GET]'
+  end
+  
+  it "should have two entry until next Processing line" do
+    @parser << "another line"
+    @parser.should have(2).entries
+  end
+  
+  it "should have three entries after second Processing line" do
+    @parser << "another line"
+    @parser << ''
+    @parser << "Processing LogeyeController#index (for 127.0.0.1 at 2007-09-07 17:52:13) [GET]"
+    @parser.should have(3).entries
+  end
+  
+  it "should still have three entries after second Processing line and more lines" do
+    @parser << "another line"
+    @parser << ''
+    @parser << "Processing LogeyeController#index (for 127.0.0.1 at 2007-09-07 17:52:13) [GET]"
+    @parser << 'some more'
+    @parser.should have(3).entries
+  end
+end
+
+describe Ringbarker, "with 3 entries, after dequeuing" do
+  before do
+    @parser = Ringbarker::Parser.new
+    @parser.entries << @e1 = Ringbarker::Entry.new
+    @parser.entries << @e2 = Ringbarker::Entry.new
+    @parser.entries << @e3 = Ringbarker::Entry.new
+    
+    @e1.instance_variable_set("@complete",true)
+    @e2.instance_variable_set("@complete",true)
+    
+    @deq = @parser.dequeue
+  end
+  
+  it "should should have dequeued 2 entries" do
+    @deq.should == [@e1,@e2]
+  end
+  
+  it "should not dequeue more" do
+    @parser.dequeue.should == []
+  end
+  
+  it "should have 1 entry" do
+    @parser.entries.should == [@e3]
+  end
+  
+  it "should dequeue last entry upon completion" do
+    @e3.instance_variable_set("@complete",true)
+    @parser.dequeue.should == [@e3]
+  end
+end
+
+describe Ringbarker, "with no entries, after dequeuing" do
+  before do
+    @parser = Ringbarker::Parser.new
+    @deq = @parser.dequeue
+  end
+  
+  it "should dequeue nothing" do
+    @deq.should == []
+  end
+  
+  it "should have empty array of entries" do
+    @parser.entries.should == []
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require File.dirname(__FILE__)+'/../lib/ringbarker'

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: ringbarker
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-09-19 00:00:00 +10:00
+summary: simple Rails log parser
+require_paths: 
+- lib
+email: lachie@smartbomb.com.au
+homepage: "    by Lachie Cox"
+rubyforge_project: rails-oceania
+description: "== FEATURES/PROBLEMS:  * Parses the Rails log. * Recognises Processing...Completed blocks. * Recognises Processing...exception...Rendering rescue blocks. * Collects the fluff between Processing blocks too. * Does as little interpretation of the parsed requests as possible. This is left up to the client. * Needs better doco.  == SYNOPSIS:  require 'rubygems' require 'ringbarker'  @parser = Ringbarker::Parser.new @entries = []"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Lachie Cox
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/ringbarker
+- lib/ringbarker.rb
+- lib/ringbarker/parser.rb
+- lib/ringbarker/entry.rb
+- spec/entry_spec.rb
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+test_files: 
+- spec/entry_spec.rb
+- spec/parser_spec.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- ringbarker
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: