apache_log_parser 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joel Watson
+
+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.rdoc

@@ -0,0 +1,49 @@
+= Getting Started
+
+This is a library designed to easily parse and access standard Apache log files.
+
+To get started, require the library:
+
+  require 'apache_log_parser'
+
+From there, you would use it as follows:
+
+  ApacheLogParser.parse(logfile, rules) do |parsed|
+    parsed[:ip]         #=> "12.12.12.12"
+    parsed[:date]       #=> "21/Jan/2010"
+    parsed[:day]        #=> 21
+    parsed[:month]      #=> "Jan"
+    parsed[:year]       #=> 2010
+    parsed[:hour]       #=> 14
+    parsed[:zone]       #=> "-0800"
+    parsed[:method]     #=> "GET"
+    parsed[:resource]   #=> "/some/page.php"
+    parsed[:status]     #=> 200
+    parsed[:size]       #=> "7047"
+    parsed[:referer]    #=> "-"
+    parsed[:user_agent] #=> "Mozilla/5.0 (Macintosh; U; Intel..."
+  end
+
+The logfile parameter is simply the path to the logfile in question and the rules 
+parameter is a hash of rules to filter the logfile with.
+
+= Using Rules
+
+To use rules, simply build a hash with options you want to filter with as follows:
+
+  rules = {}
+  rules[:hour]   = 11..13         # only accept hits between 11:00 and 13:59 hours
+  rules[:day]    = 21             # only accept hits where the day is 21
+  rules[:date]   = "12/Jan/2010"  # only accept hits on Jan 12, 2010
+  rules[:method] = "GET"          # only accept hits where the request method is GET
+  rules[:status] = 404            # only accept hits where the status response is 404
+
+Rules are inclusive, so only hits where ALL rules are met will be kept. From there, 
+you would simply pass the rules hash into the parse method as shown above. The logfile
+is read one line at a time, so the memory footprint is quite small and can easily handle
+large logfiles (sizes as large as 6GB have been tested). The larger the file, the longer
+the parse process will take though.
+
+== Copyright
+
+Copyright (c) 2010 Joel Watson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "apache_log_parser"
+    gem.summary = %Q{Library to easily parse standard Apache log files.}
+    gem.description = %Q{Library to easily parse standard Apache log files.}
+    gem.email = "watsonian@gmail.com"
+    gem.homepage = "http://github.com/watsonian/apache_log_parser"
+    gem.authors = ["watsonian"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "apache_log_parser #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/apache_log_parser.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{apache_log_parser}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["watsonian"]
+  s.date = %q{2010-01-27}
+  s.description = %q{Library to easily parse standard Apache log files.}
+  s.email = %q{watsonian@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "apache_log_parser.gemspec",
+     "lib/apache_log_parser.rb",
+     "spec/apache_log_parser_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/watsonian/apache_log_parser}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Library to easily parse standard Apache log files.}
+  s.test_files = [
+    "spec/apache_log_parser_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    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_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/apache_log_parser.rb

@@ -0,0 +1,54 @@
+class ApacheLogParser
+  def self.parse(filename, rules={}, &block)
+    rules = process_rules(rules)
+    parse_file(filename, rules, &block)
+  end
+  
+  private
+    def self.parse_line(line)
+      m = line.match(/^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}).*?(([0-9]{1,2})\/(.*?)\/([0-9]{4})):(([0-9]{2}):[0-9]{2}:[0-9]{2})\s*(.*?)\]\s*"([\w]*)\s(.*?)\s.*?"\s([0-9]{3})\s(.*?)\s*"(.*?)"\s*"(.*?)"/)
+      if m
+      {:ip         => m[1],
+       :date       => m[2],
+       :day        => m[3].to_i,
+       :month      => m[4],
+       :year       => m[5].to_i,
+       :time       => m[6],
+       :hour       => m[7].to_i,
+       :zone       => m[8],
+       :method     => m[9],
+       :resource   => m[10],
+       :status     => m[11].to_i,
+       :size       => m[12],
+       :referer    => m[13],
+       :user_agent => m[14]}
+      else
+        {}
+      end
+    end
+  
+    def self.parse_file(filename, rules={}, &block)
+      File.foreach(filename) do |line|
+        parsed = parse_line(line)
+        if rules.any?
+          # stop parsing the file if we're past the designated hour range
+          break if rules[:hour] && Array(parsed[:hour]).last > Array(rules[:hour]).last
+          
+          # go to the next line if there are any rules that are not matched by this line
+          next if rules.reject{|k,v| Array(v).include?(parsed[k]) }.any?
+        end
+        yield parsed
+      end
+    end
+
+    def self.process_rules(rules)
+      #default_options = {:date => Time.now.strftime("#{"%02d" % rules[:day] || "%d"}/%h/%Y")}
+      #rules = default_options.merge(rules)
+      if rules[:date]
+        rules[:day], rules[:month], rules[:year] = rules[:date].split("/")
+        rules[:day] = rules[:day].to_i
+        rules[:year] = rules[:year].to_i
+      end
+      rules
+    end
+end

data/spec/apache_log_parser_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ApacheLogParser" do
+  # it "fails" do
+  #   fail "hey buddy, you should probably rename this file and start specing for real"
+  # end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'apache_log_parser'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: apache_log_parser
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- watsonian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-27 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Library to easily parse standard Apache log files.
+email: watsonian@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- apache_log_parser.gemspec
+- lib/apache_log_parser.rb
+- spec/apache_log_parser_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/watsonian/apache_log_parser
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Library to easily parse standard Apache log files.
+test_files: 
+- spec/apache_log_parser_spec.rb
+- spec/spec_helper.rb