server_log_parser 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 174e076ac740e1a63f57d94615a20cddda8bcfe9
+  data.tar.gz: d909fc0142439bcb563bca4162f8a7f872fb6cbd
+SHA512:
+  metadata.gz: 5336fafef49466bce811718e31d332588076084f949cecec63ea8c633a85476a7e8027c1f8ae9a6e90bb99ff47698c4ea11bc5c90bb7caa46497ef492946bbdc
+  data.tar.gz: 8defc3398fe35189011fc6975c11ac8cddec1801cd69a7ce259ff7dc3ba88fcfbf545b167bb9bfe7ac906f8ee05cc774cb6e81ee3adec4fd85626503d905a631

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.idea
+pkg
+vendor/bundle
+.bundle
+tmp
+*.lock
+*.tmp
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.3.0 (2016-02-16)
+
+Initial version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in server_log_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2008, 2009 Simone Carletti <weppos@weppos.net>
+Copyright (c) 2013 Nick Charlton
+Copyright (c) 2016 Alexander Kurakin <kuraga333@mail.ru
+
+MIT License
+
+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.md

@@ -0,0 +1,76 @@
+# ServerLogParser
+
+ServerLogParser provides a high-level Ruby library for parsing apache server log files
+(common log format, with or without virtual hosts and combined log format) as used
+by Apache, Nginx and others.
+
+It's a fork of [ApacheLogRegex](https://github.com/weppos/apachelogregex),
+which was in turn a port of [Apache::LogRegex 1.4 Perl module](http://search.cpan.org/~akira/Apache-ParseLog-1.02/ParseLog.pm).
+where much of the regex parts come from.
+
+## Installation
+
+```sh
+gem install server_log_parser
+```
+
+## Usage
+
+### Initialization
+
+```ruby
+require 'server_log_parser'
+
+parser = ServerLogParser::Parser(ServerLogParser::COMBINED_VIRTUAL_HOST)
+# or:
+# parser = ServerLogParser::Parser.new('%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"')
+```
+
+### Parsing
+
+```ruby
+File.foreach('/var/log/apache/access.log') do |line|
+  parsed = parser.parse(line)
+  # {
+  #   '%h'  => '212.74.15.68',
+  #   '%l'  => '-',
+  #   '%u'  => '-',
+  #   '%t'  => '[23/Jan/2004:11:36:20 +0000]',
+  #   '%r'  => 'GET /images/previous.png HTTP/1.1',
+  #   '%>s' => '200',
+  #   '%b'  => '2607',
+  #   '%{Referer}i'     => 'http://peterhi.dyndns.org/bandwidth/index.html',
+  #   '%{User-Agent}i'  => 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.2) Gecko/20021202'
+  # }
+end
+```
+
+`ServerLogParser#parse` will silently ignore errors, but if you'd prefer,
+`ServerLogParser#parse!` will raise a  `ParseError` exception.
+
+Apache log files use "-" to mean no data is present and these are replaced with nil,
+like the "identity" and "user" values above. Request is split into a nested hash.
+
+### Log Formats
+
+The log format is specified using a rather verbose constant, which map out like:
+
+Name                                 | Constant                                          | Apache Format
+------------------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------
+Common Log Format                    | `ServerLogParser::COMMON_LOG_FORMAT`              | `%h %l %u %t \"%r\" %>s %b`
+Common Log Format with virtual hosts | `ServerLogParser::COMMON_LOG_FORMAT_VIRTUAL_HOST` | `%v %h %l %u %t \"%r\" %>s %b`
+Combined                             | `ServerLogParser::COMBINED`                       | `%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"`
+Combined with virtual hosts          | `ServerLogParser::COMBINDED_VIRTUAL_HOST`         | `%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"`
+
+
+## Author
+
+Alexander Kurakin <<kuraga333@mail.ru>>
+
+## Feedback and contribute
+
+<https://github.com/kuraga/server_log_parser/issues>
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+require "bundler/gem_tasks"
+
+task :default => [:test]

data/lib/server_log_parser/parser.rb

@@ -0,0 +1,93 @@
+module ServerLogParser
+
+  class Parser
+
+    # Regexp instance used for parsing a log line.
+    attr_reader :regexp
+
+    # The list of field names that extracted from log format.
+    attr_reader :names
+
+
+    # Initializes a new parser instance with given log <tt>format</tt>.
+    def initialize(format)
+      @regexp = nil
+      @names  = []
+      @format = parse_format(format)
+    end
+
+    # Parses <tt>line</tt> according to current log <tt>format</tt>
+    # and returns an hash of log field => value on success.
+    # Returns <tt>nil</tt> if <tt>line</tt> doesn't match current log <tt>format</tt>.
+    def parse(line)
+      row = line.to_s
+      row.chomp!
+      row.strip!
+      return unless match = regexp.match(row)
+
+      data = {}
+      names.each_with_index { |field, index| data[field] = match[index + 1] } # [0] == line
+      data
+    end
+
+    # Same as <tt>ServerLogParser#parse</tt> but raises a <tt>ParseError</tt>
+    # if <tt>line</tt> doesn't match current <tt>format</tt>.
+    #
+    # ==== Raises
+    #
+    # ParseError:: if <tt>line</tt> doesn't match current <tt>format</tt>
+    #
+    def parse!(line)
+      parse(line) || raise(ParseError, "Invalid format `%s` for line `%s`" % [@format, line])
+    end
+
+
+    protected
+
+      # Overwrite this method if you want to use some human-readable name for log fields.
+      # This method is called only once at <tt>parse_format</tt> time.
+      def rename_this_name(name)
+        name
+      end
+
+      # Parse log <tt>format</tt> into a suitable Regexp instance.
+      def parse_format(format)
+        format = format.to_s
+        format.chomp!                # remove carriage return
+        format.strip!                # remove leading and trailing space
+        format.gsub!(/[ \t]+/, ' ')  # replace tabulations or spaces with a space
+
+        strip_quotes = proc { |string| string.gsub(/^\\"/, '').gsub(/\\"$/, '') }
+        find_quotes  = proc { |string| string =~ /^\\"/ }
+        find_percent = proc { |string| string =~ /^%.*t$/ }
+        find_referrer_or_useragent = proc { |string| string =~ /Referer|User-Agent/ }
+
+        pattern = format.split(' ').map do |element|
+          has_quotes = !!find_quotes.call(element)
+          element = strip_quotes.call(element) if has_quotes
+
+          self.names << rename_this_name(element)
+
+          case
+            when has_quotes
+              if element == '%r' or find_referrer_or_useragent.call(element)
+                /"([^"\\]*(?:\\.[^"\\]*)*)"/
+              else
+                '\"([^\"]*)\"'
+              end
+            when find_percent.call(element)
+                '(\[[^\]]+\])'
+            when element == '%U'
+                '(.+?)'
+            else
+                '(\S*)'
+          end
+        end.join(' ')
+
+        @regexp = Regexp.new("^#{pattern}$")
+        format
+      end
+
+  end
+
+end

data/lib/server_log_parser/version.rb

@@ -0,0 +1,5 @@
+module ServerLogParser
+
+  VERSION = "0.3.0"
+
+end

data/lib/server_log_parser.rb

@@ -0,0 +1,18 @@
+module ServerLogParser
+
+  COMMON_LOG_FORMAT = '%h %l %u %t \"%r\" %>s %b'
+  COMMON_LOG_FORMAT_VIRTUAL_HOST = '%v %h %l %u %t \"%r\" %>s %b'
+  COMBINED = '%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"'
+  COMBINED_VIRTUAL_HOST = '%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"'
+
+  #
+  # = ParseError
+  #
+  # Raised in case the parser can't parse a log line with current +format+.
+  #
+  class ParseError < RuntimeError; end
+
+end
+
+require 'server_log_parser/version'
+require 'server_log_parser/parser'

data/server_log_parser.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path("../lib/server_log_parser/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "server_log_parser"
+  spec.version       = ServerLogParser::VERSION
+  spec.authors       = ["Alexander Kurakin"]
+  spec.email         = ["kuraga333@mail.ru"]
+  spec.summary       = %q{Ruby library to parse server server log files using regular expressions.}
+  spec.description   = %q{ServerLogParser provides a high-level Ruby library for parsing server server log files (common log format, with or without virtual hosts and combined log format) as used by Server, Nginx and others.}
+  spec.homepage      = "https://github.com/kuraga/server_log_parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "minitest", "~> 5.8"
+end

data/test/fixtures/line-with-slash-quote-in-referer.log

@@ -0,0 +1 @@
+4.224.234.46 - - [20/Jul/2004:13:18:55 -0700] "GET /core/listing/pl_boat_detail.jsp?&units=Feet&checked_boats=1176818&slim=broker&&hosturl=giffordmarine&&ywo=giffordmarine& HTTP/1.1" 200 2888 "http://search.yahoo.com/bin/search?p=\"grady%20white%20306%20bimini\"" "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; YPC 3.0.3; yplus 4.0.00d)"

data/test/fixtures/line-with-slash-quote-in-request.log

@@ -0,0 +1 @@
+212.74.15.68 - - [23/Jan/2004:11:36:20 +0000] "GET /images/previous.png=\" HTTP/1.1" 200 2607 "http://peterhi.dyndns.org/bandwidth/index.html" "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.2) Gecko/20021202"

data/test/fixtures/line.log

@@ -0,0 +1 @@
+212.74.15.68 - - [23/Jan/2004:11:36:20 +0000] "GET /images/previous.png HTTP/1.1" 200 2607 "http://peterhi.dyndns.org/bandwidth/index.html" "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.2) Gecko/20021202"

data/test/fixtures/log.log

@@ -0,0 +1,5 @@
+87.18.183.252 - - [13/Aug/2008:00:50:49 -0700] "GET /blog/index.xml HTTP/1.1" 302 527 "-" "Feedreader 3.13 (Powered by Newsbrain)" 
+79.28.16.191 - - [13/Aug/2008:00:50:55 -0700] "GET /blog/public/2008/08/gmail-offline-dati-a-rischio/gmaildown.png HTTP/1.1" 304 283 "-" "FeedDemon/2.7 (http://www.newsgator.com/; Microsoft Windows XP)" 
+79.28.16.191 - - [13/Aug/2008:00:50:55 -0700] "GET /blog/public/2008/08/nuovo-microsoft-webmaster-center/overview.png HTTP/1.1" 304 283 "-" "FeedDemon/2.7 (http://www.newsgator.com/; Microsoft Windows XP)" 
+69.150.40.169 - - [13/Aug/2008:00:51:06 -0700] "POST http://www.simonecarletti.com/mt4/mt-ttb.cgi/563 HTTP/1.1" 404 610 "-" "-" 
+217.220.110.75 - - [13/Aug/2008:00:51:02 -0700] "GET /blog/2007/05/microsoft-outlook-pst.php HTTP/1.1" 200 82331 "http://www.google.it/search?hl=it&q=outlook+pst+file+4+GB&meta=" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1) ; .NET CLR 1.1.4322; .NET CLR 2.0.50727)" 

data/test/parse_test.rb

@@ -0,0 +1,109 @@
+require 'test_helper'
+
+describe ServerLogParser::Parser do
+
+  describe "regular expression" do
+
+    it "should be correct" do
+      regexp = '(?-mix:^(\\S*) (\\S*) (\\S*) (\\[[^\\]]+\\]) (?-mix:"([^"\\\\]*(?:\\\\.[^"\\\\]*)*)") (\\S*) (\\S*) (?-mix:"([^"\\\\]*(?:\\\\.[^"\\\\]*)*)") (?-mix:"([^"\\\\]*(?:\\\\.[^"\\\\]*)*)")$)'
+
+      assert_equal(@parser.regexp.to_s, regexp)
+    end
+
+  end
+
+  before do
+    @format = '%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"'
+    @parser = ServerLogParser::Parser.new(@format)
+  end
+
+  describe "#parse" do
+
+    it "should parse line" do
+      expected = { '%h'  => '212.74.15.68',
+                   '%l'  => '-',
+                   '%u'  => '-',
+                   '%t'  => '[23/Jan/2004:11:36:20 +0000]',
+                   '%r'  => 'GET /images/previous.png HTTP/1.1',
+                   '%>s' => '200',
+                   '%b'  => '2607',
+                   '%{Referer}i'     => 'http://peterhi.dyndns.org/bandwidth/index.html',
+                   '%{User-Agent}i'  => 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.2) Gecko/20021202' }
+      results = @parser.parse(read_testcase('line.log'))
+
+      assert_kind_of(Hash, results)
+      assert_match_expected_hash(expected, results)
+    end
+
+    it "should parse line with slash quote in request" do
+      expected = { '%h'  => '212.74.15.68',
+                   '%l'  => '-',
+                   '%u'  => '-',
+                   '%t'  => '[23/Jan/2004:11:36:20 +0000]',
+                   '%r'  => 'GET /images/previous.png=\" HTTP/1.1',
+                   '%>s' => '200',
+                   '%b'  => '2607',
+                   '%{Referer}i'     => 'http://peterhi.dyndns.org/bandwidth/index.html',
+                   '%{User-Agent}i'  => 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.2) Gecko/20021202' }
+      results = @parser.parse(read_testcase('line-with-slash-quote-in-request.log'))
+
+      assert_kind_of(Hash, results)
+      assert_match_expected_hash(expected, results)
+    end
+
+    it "should parse line with slash quote in referer" do
+      expected = {  '%h'  => '4.224.234.46',
+                   '%l'  => '-',
+                   '%u'  => '-',
+                   '%t'  => '[20/Jul/2004:13:18:55 -0700]',
+                   '%r'  => 'GET /core/listing/pl_boat_detail.jsp?&units=Feet&checked_boats=1176818&slim=broker&&hosturl=giffordmarine&&ywo=giffordmarine& HTTP/1.1',
+                   '%>s' => '200',
+                   '%b'  => '2888',
+                   '%{Referer}i'     => 'http://search.yahoo.com/bin/search?p=\"grady%20white%20306%20bimini\"',
+                   '%{User-Agent}i'  => 'Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; YPC 3.0.3; yplus 4.0.00d)' }
+      results = @parser.parse(read_testcase('line-with-slash-quote-in-referer.log'))
+
+      assert_kind_of(Hash, results)
+      assert_match_expected_hash(expected, results)
+    end
+
+    it "return nil on invalid format" do
+      results = @parser.parse('foobar')
+
+      assert_nil(results)
+    end
+
+  end
+
+  describe "#parse!" do
+
+    it "should work" do
+      testcase = read_testcase('line.log')
+
+      expected = @parser.parse(testcase)
+      results = @parser.parse!(testcase)
+
+      assert_equal(expected, results)
+    end
+
+    it "should raise on invalid format" do
+      error = assert_raises(ServerLogParser::ParseError) { @parser.parse!('foobar') }
+      assert_match(/Invalid format/, error.message)
+    end
+
+  end
+
+
+  protected
+
+    def read_testcase(filename)
+      File.read("#{FIXTURES_PATH}/#{filename}")
+    end
+
+    def assert_match_expected_hash(expected, current)
+      expected.each do |key, value|
+        assert_equal(value, current[key], "Expected `#{key}` to match value `#{value}` but `#{current[:key]}`")
+      end
+    end
+
+end

data/test/server_log_parser_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+describe ServerLogParser do
+
+  describe "constants" do
+
+    it "should be correct" do
+      assert_equal(ServerLogParser::COMMON_LOG_FORMAT, '%h %l %u %t \"%r\" %>s %b')
+      assert_equal(ServerLogParser::COMMON_LOG_FORMAT_VIRTUAL_HOST, '%v %h %l %u %t \"%r\" %>s %b')
+      assert_equal(ServerLogParser::COMBINED, '%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"')
+      assert_equal(ServerLogParser::COMBINED_VIRTUAL_HOST, '%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"')
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+FIXTURES_PATH = File.dirname(__FILE__) + '/fixtures'
+
+require 'server_log_parser'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: server_log_parser
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Alexander Kurakin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: ServerLogParser provides a high-level Ruby library for parsing server
+  server log files (common log format, with or without virtual hosts and combined
+  log format) as used by Server, Nginx and others.
+email:
+- kuraga333@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/server_log_parser.rb
+- lib/server_log_parser/parser.rb
+- lib/server_log_parser/version.rb
+- server_log_parser.gemspec
+- test/fixtures/line-with-slash-quote-in-referer.log
+- test/fixtures/line-with-slash-quote-in-request.log
+- test/fixtures/line.log
+- test/fixtures/log.log
+- test/parse_test.rb
+- test/server_log_parser_test.rb
+- test/test_helper.rb
+homepage: https://github.com/kuraga/server_log_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby library to parse server server log files using regular expressions.
+test_files:
+- test/fixtures/line-with-slash-quote-in-referer.log
+- test/fixtures/line-with-slash-quote-in-request.log
+- test/fixtures/line.log
+- test/fixtures/log.log
+- test/parse_test.rb
+- test/server_log_parser_test.rb
+- test/test_helper.rb