ntail 0.0.10 → 0.0.11

data/README.rdoc

@@ -1,16 +1,19 @@
 = ntail
 
-A tail(1)-like utility for nginx log files that supports parsing, filtering and formatting individual log lines.
+A <tt>tail(1)</tt>-like utility for nginx log files that supports parsing, filtering and formatting of individual 
+log lines (in nginx's so-called {"combined" log format}[http://wiki.nginx.org/NginxHttpLogModule#log_format]).
 
-  > gem install ntail
+== Installation
 
-== Examples
+Installing the gem also installs the <tt>ntail</tt> executable, typically as <tt>/usr/bin/ntail</tt> or <tt>/usr/local/bin/ntail</tt>:
 
-* read from STDIN and print each line to STDOUT <em>(stop with ^D)</em>
+  > gem install ntail
 
-    > ntail
+To ensure easy execution of the <tt>ntail</tt> script, add the actual installation directory to your shell's <tt>$PATH</tt> variable.
+
+== Basic Usage
 
-* process an nginx log file and print each line to STDOUT
+* process an entire nginx log file and print each parsed and formatted line to STDOUT
 
     > ntail /var/log/nginx/access.log
 
@@ -18,11 +21,17 @@ A tail(1)-like utility for nginx log files that supports parsing, filtering and
 
     > tail -f /var/log/nginx/access.log | ntail
 
-* tail STDIN and print out the length of each line <em>(to illustrate -e option)</em>
+== Advanced Examples
+
+* read from STDIN and print each line to STDOUT <em>(stop with ^D)</em>
+
+    > ntail
+
+* read from STDIN and print out the length of each line <em>(to illustrate -e option)</em>
 
     > ntail -e '{ |line| puts line.size }'
 
-* tail STDIN but only print out non-empty lines <em>(to illustrate -f option)</em>
+* read from STDIN but only print out non-empty lines <em>(to illustrate -f option)</em>
 
     > ntail -f '{ |line| line.size > 0 }'
 
@@ -64,19 +73,15 @@ A tail(1)-like utility for nginx log files that supports parsing, filtering and
 
 == TODO
 
-* implement a native <tt>"-f"</tt> option for ntail, similar to that of <tt>tail(1)</tt>
-* implement a <tt>"-i"</tt> option ("ignore exceptions"/"continue processing"), if handling a single line raised an exception
-
-* make <tt>PROXY_IP_ADDRESS</tt> configurable (from command line and/or rc file)
-* make <tt>OFFICE_IP_ADDRESS</tt> configurable (from command line and/or rc file)
-* make <tt>KNOWN_SEARCH_BOTS</tt> configurable (from command line and/or rc file)
-* make <tt>INTERNAL_REFERERS</tt> configurable (from command line and/or rc file)
-* make <tt>AUTOMATED_REQUESTS</tt> configurable (from command line and/or rc file)
-* make <tt>STATIC_REPOS</tt> configurable (from command line and/or rc file)
+* implement a native <tt>"-f"</tt> option for ntail, similar to that of <tt>tail(1)</tt>, using e.g. flori's {file-tail gem}[https://github.com/flori/file-tail]
+* implement a <tt>"-i"</tt> option ("ignore exceptions"/"continue processing"), if handling a single line raises an exception
+* or indeed a reverse <tt>"-r"</tt> option ("re-raise exception"), to immediately stop processing and raising the exception for investigation
+* implement (better) support for custom nginx log formats, in addition to {nginx's default "combined" log format}[http://wiki.nginx.org/NginxHttpLogModule#log_format].
 
 == Acknowledgements
 
-ntail's parsing feature is inspired by an nginx log parser written by {Richard Taylor (moomerman)}[https://github.com/moomerman]
+* ntail's parsing feature is inspired by an nginx log parser written by {Richard Taylor (moomerman)}[https://github.com/moomerman]
+* parsing and expanding ntail's formatting string is done using nathansobo's quite brilliant {treetop gem}[https://github.com/nathansobo/treetop]
 
 == Contributing to ntail
  
@@ -90,5 +95,5 @@ ntail's parsing feature is inspired by an nginx log parser written by {Richard T
 
 == Copyright
 
-Copyright (c) 2010 Peter Vandenberk. See LICENSE.txt for further details.
+Copyright (c) 2011 Peter Vandenberk. See LICENSE.txt for further details.
 

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/ntail/http_user_agent.rb

@@ -25,6 +25,7 @@ class SearchBot < Agent
   # Pingdom.com_bot_version_1.4_(http://www.pingdom.com/)
   # ia_archiver (+http://www.alexa.com/site/help/webmasters; crawler@alexa.com)
   # Mozilla/5.0 (compatible; YandexBot/3.0; +http://yandex.com/bots)
+  # Mozilla/5.0 (compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm)
   #
 
   KNOWN_SEARCH_BOTS = [
@@ -34,6 +35,7 @@ class SearchBot < Agent
     PINGDOM_BOT = Regexp.compile('Pingdom.com_bot_version_'),
       ALEXA_BOT = Regexp.compile('ia_archiver'),
      YANDEX_BOT = Regexp.compile('YandexBot\/'),
+       BING_BOT = Regexp.compile('bingbot\/'),
   ]
 
   def self.search_bot?(http_user_agent)
@@ -57,6 +59,7 @@ class SearchBot < Agent
       when   ALEXA_BOT then :ia_archiver
       when PINGDOM_BOT then :pingdom_bot
       when  YANDEX_BOT then :yandex_bot
+      when    BING_BOT then :bingbot
       else super(string)
     end
   end
@@ -69,6 +72,7 @@ class SearchBot < Agent
       when   ALEXA_BOT then :"alexa.com"
       when PINGDOM_BOT then :"pingdom.com"
       when  YANDEX_BOT then :"yandex.com"
+      when    BING_BOT then :"bing.com"
       else super(string)
     end
   end

data/ntail.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ntail}
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Vandenberk"]
-  s.date = %q{2011-01-11}
+  s.date = %q{2011-01-19}
   s.default_executable = %q{ntail}
   s.description = %q{A tail(1)-like utility for nginx log files. It supports parsing, filtering and formatting individual log lines.}
   s.email = %q{pvandenberk@mac.com}
@@ -66,7 +66,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/pvdb/ntail}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.1}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A tail(1)-like utility for nginx log files}
   s.test_files = [
     "test/helper.rb",
@@ -86,6 +86,7 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ntail
 version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: 
+  hash: 9
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Peter Vandenberk
@@ -15,11 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 +00:00
+date: 2011-01-19 00:00:00 +00:00
 default_executable: ntail
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  prerelease: false
+  name: rainbow
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,10 +31,10 @@ dependencies:
         - 0
         version: "0"
   requirement: *id001
-  prerelease: false
-  name: rainbow
-- !ruby/object:Gem::Dependency 
   type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: user-agent
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -44,10 +45,10 @@ dependencies:
         - 0
         version: "0"
   requirement: *id002
-  prerelease: false
-  name: user-agent
-- !ruby/object:Gem::Dependency 
   type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: treetop
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -60,10 +61,10 @@ dependencies:
         - 9
         version: 1.4.9
   requirement: *id003
-  prerelease: false
-  name: treetop
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  type: :development
+  prerelease: false
+  name: shoulda
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -74,10 +75,10 @@ dependencies:
         - 0
         version: "0"
   requirement: *id004
-  prerelease: false
-  name: shoulda
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -90,10 +91,10 @@ dependencies:
         - 0
         version: 1.0.0
   requirement: *id005
-  prerelease: false
-  name: bundler
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -106,10 +107,10 @@ dependencies:
         - 1
         version: 1.5.1
   requirement: *id006
-  prerelease: false
-  name: jeweler
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -120,10 +121,10 @@ dependencies:
         - 0
         version: "0"
   requirement: *id007
-  prerelease: false
-  name: rcov
-- !ruby/object:Gem::Dependency 
   type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: geoip
   version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -134,8 +135,7 @@ dependencies:
         - 0
         version: "0"
   requirement: *id008
-  prerelease: false
-  name: geoip
+  type: :development
 description: A tail(1)-like utility for nginx log files. It supports parsing, filtering and formatting individual log lines.
 email: pvandenberk@mac.com
 executables: 
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A tail(1)-like utility for nginx log files