haproxy_log_parser 0.0.4 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f019630e3a37d631615874f51d00936ade7a58a2
+  data.tar.gz: c95c16a28cfc263e3b5f5b3310836b4afbf30094
+SHA512:
+  metadata.gz: 1d9567c587f66a274e8fa1d829e59c42cb07969094061c0fe5cde805ca322114880c71d62ff18a88f9494f779fc04d4f132105d425d5c22aff3de6e8b95bfef8
+  data.tar.gz: 5d1d021bef436b3651e362a89ca555c1b3a8e3912bec57030a1bd3c76ad54d93f5fd5560df38460f9181bd36d232084e9020d28e254e0b319436735605d7d98b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013, Toby Hsieh
+
+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,10 @@
+# haproxy\_log\_parser
+
+haproxy\_log\_parser is a gem that parses logs in HAProxy's HTTP log format.
+
+Example:
+
+    require 'haproxy_log_parser'
+    result = HAProxyLogParser.parse('Aug  9 20:30:46 localhost haproxy[2022]: 10.0.8.2:34028 [09/Aug/2011:20:30:46.429] proxy-out proxy-out/cache1 1/0/2/126/+128 301 +223 - - ---- 617/523/336/168/0 0/0 {www.sytadin.equipement.gouv.fr||http://trafic.1wt.eu/} {Apache|230|||true} "GET /index.html HTTP/1.1"')
+    result.client_ip # => "10.0.8.2"
+    result.captured_response_headers # => ["Apache", "230", "", "", "true"]

data/VERSION

@@ -1 +1 @@
-0.0.4
+1.0.0

data/haproxy_log_parser.gemspec

@@ -9,10 +9,11 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'treetop'
 
-  s.add_development_dependency 'rspec', '~> 2.13'
+  s.add_development_dependency 'rspec', '~> 3.5.0'
 
   s.files = Dir.glob('lib/**/*') + [
-    'README.rdoc',
+    'LICENSE',
+    'README.md',
     'VERSION',
     'haproxy_log_parser.gemspec'
   ]

data/lib/haproxy_log_parser/entry.rb

@@ -86,7 +86,7 @@ module HAProxyLogParser
     # @return [String]
     attr_accessor :http_request
 
-    # return [true, false] true if and only if request was SSL
+    # return [Boolean] true if and only if request was SSL
     def ssl?
       @transport_mode == '~'
     end

data/lib/haproxy_log_parser.rb

@@ -1,23 +1,28 @@
 require 'treetop'
 
 require 'haproxy_log_parser/entry'
-
-Treetop.load(File.expand_path('haproxy_log_parser/line.treetop', File.dirname(__FILE__)))
+require 'haproxy_log_parser/line'
 
 module HAProxyLogParser
   VERSION = IO.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).chomp.freeze
 
-  @parser = LineParser.new
+  # Exception for failures when parsing lines
+  class ParseError < ::StandardError; end
 
   class << self
     # Returns an Entry object resulting from the given HAProxy HTTP-format log
-    # +line+, or +nil+ if the +line+ appears to be invalid.
+    # +line+.
     #
-    # @param [String] line a line from an HAProxy log
-    # @return [Entry, nil]
+    # @param line [String] a line from an HAProxy log
+    # @return [Entry]
+    # @raise [ParseError] if the line was not parsed successfully
     def parse(line)
-      result = @parser.parse(line)
-      return nil unless result
+      parser = LineParser.new
+      result = parser.parse(line)
+
+      unless result
+        raise ParseError, parser.failure_reason
+      end
 
       entry = Entry.new
       [
@@ -59,8 +64,8 @@ module HAProxyLogParser
     # Returns the given string un-escaped. See the "Logging > Non-printable
     # characters" section in HAProxy documentation.
     #
-    # @param [String] string
-    # @return [String]
+    # @param string [String] string to unescape
+    # @return [String] an unescaped string
     def unescape(string)
       string.gsub(/#[[:xdigit:]]{2}/) do |match|
         match[1..-1].to_i(16).chr
@@ -69,7 +74,7 @@ module HAProxyLogParser
 
     # Converts the value of an accept_date field to a Time object.
     #
-    # @param [String] string
+    # @param string [String] value of an accept_date field
     # @return [Time]
     def parse_accept_date(string)
       parts = string.split(/[\/:.]/)
@@ -78,8 +83,10 @@ module HAProxyLogParser
 
     # Converts a captured cookie string to a Hash.
     #
-    # @param [String] string
+    # @param string [String] a captured cookie string
     # @return [Hash{String => String}]
+    #   a one-entry Hash with the cookie name and value, or an empty Hash if no
+    #   cookie was captured
     def decode_captured_cookie(string)
       if string == '-'
         {}
@@ -91,8 +98,8 @@ module HAProxyLogParser
 
     # Converts a captured headers string to an Array.
     #
-    # @param [String] string
-    # @return [Array<String>]
+    # @param string [String] a captured headers section
+    # @return [Array<String>] array of captured header values
     def decode_captured_headers(string)
       string.split('|', -1).map! { |header| unescape(header) }
     end

data/spec/haproxy_log_parser_spec.rb

@@ -1,6 +1,6 @@
 require 'haproxy_log_parser'
 
-describe HAProxyLogParser do
+RSpec.describe HAProxyLogParser do
   # TODO Use something better instead of LINES[0], LINES[1], ...
   LINES = IO.readlines(File.join(File.dirname(__FILE__), 'sample.log'))
 
@@ -33,7 +33,7 @@ describe HAProxyLogParser do
       expect(entry.backend_queue).to eq(0)
       expect(entry.captured_request_headers).to eq(['www.sytadin.equipement.gouv.fr', '', 'http://trafic.1wt.eu/'])
       expect(entry.captured_response_headers).to eq(['Apache', '230', '', '', 'http://www.sytadin.'])
-      expect(entry.http_request).to eq('GET http://www.sytadin.equipement.gouv.fr/ HTTP/1.1')
+      expect(entry.http_request).to eq('GET / HTTP/1.1')
     end
 
     it 'parses LINES[1] correctly' do
@@ -67,8 +67,10 @@ describe HAProxyLogParser do
       expect(entry.http_request).to eq('GET /images/image.gif HTTP/1.1')
     end
 
-    it 'returns nil if the line is invalid' do
-      expect(HAProxyLogParser.parse('asdf jkl;')).to be_nil
+    it 'raises ParseError if the line is invalid' do
+      line = 'Aug  9 20:30:46 localhost haproxy[2022]: '
+      expect { HAProxyLogParser.parse(line) }.
+        to raise_error(HAProxyLogParser::ParseError)
     end
   end
 end

data/spec/sample.log

@@ -1,2 +1,2 @@
-Aug  9 20:30:46 localhost haproxy[2022]: 10.0.8.2:34028 [09/Aug/2011:20:30:46.429] proxy-out~ proxy-out/cache1 1/0/2/126/+128 301 +223 - - LR-- 617/523/336/168/0 0/0 {www.sytadin.equipement.gouv.fr||http://trafic.1wt.eu/} {Apache|230|||http://www.sytadin.} "GET http://www.sytadin.equipement.gouv.fr/ HTTP/1.1"
+Aug  9 20:30:46 localhost haproxy[2022]: 10.0.8.2:34028 [09/Aug/2011:20:30:46.429] proxy-out~ proxy-out/cache1 1/0/2/126/+128 301 +223 - - LR-- 617/523/336/168/0 0/0 {www.sytadin.equipement.gouv.fr||http://trafic.1wt.eu/} {Apache|230|||http://www.sytadin.} "GET / HTTP/1.1"
 May 21 01:35:46 10.18.237.5 haproxy[26747]: 192.168.1.215:50679 [21/May/2012:01:35:46.146] webapp webapp_backend/web09 27/0/1/0/217 200 1367 session=abc session=xyz ---- 600/529/336/158/0 0/0 {#7C#7C #7B5F41#7D|http://google.com/|} "GET /images/image.gif HTTP/1.1"

metadata

@@ -1,103 +1,82 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: haproxy_log_parser
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Toby Hsieh
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-08-16 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2016-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: treetop
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 2
-        - 13
-        version: "2.13"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 description: Parser for HAProxy logs in the HTTP log format
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/haproxy_log_parser/entry.rb
-- lib/haproxy_log_parser/line.treetop
-- lib/haproxy_log_parser.rb
-- README.rdoc
+files:
+- LICENSE
+- README.md
 - VERSION
 - haproxy_log_parser.gemspec
+- lib/haproxy_log_parser.rb
+- lib/haproxy_log_parser/entry.rb
+- lib/haproxy_log_parser/line.treetop
 - spec/haproxy_log_parser_spec.rb
 - spec/sample.log
-has_rdoc: true
 homepage: https://github.com/tobyhs/haproxy_log_parser
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Parser for HAProxy logs in the HTTP log format
-test_files: 
+test_files:
 - spec/haproxy_log_parser_spec.rb
 - spec/sample.log

data/README.rdoc

@@ -1,11 +0,0 @@
-= haproxy_log_parser
-
-haproxy_log_parser is a gem that uses Treetop to parse HAProxy logs in
-HAProxy's HTTP log format.
-
-== Example
-
-  require 'haproxy_log_parser'
-  result = HAProxyLogParser.parse('Aug  9 20:30:46 localhost haproxy[2022]: 10.0.8.2:34028 [09/Aug/2011:20:30:46.429] proxy-out proxy-out/cache1 1/0/2/126/+128 301 +223 - - ---- 617/523/336/168/0 0/0 {www.sytadin.equipement.gouv.fr||http://trafic.1wt.eu/} {Apache|230|||http://www.sytadin.} "GET http://www.sytadin.equipement.gouv.fr/ HTTP/1.1"')
-  result.client_ip # => "10.0.8.2"
-  result.captured_response_headers # => ["Apache", "230", "", "", "http://www.sytadin."]