racknga 0.9.1 → 0.9.2

data/test/test-nginx-log-parser.rb

@@ -0,0 +1,214 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011  Ryo Onodera <onodera@clear-code.com>
+# Copyright (C) 2011  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require 'stringio'
+
+module NginxAccessLogParserTests
+  module Data
+    private
+    def time_log_component
+      times = ["03/Aug/2011:16:58:01 +0900", runtime, request_time].compact
+      "[#{times.join(', ')}]"
+    end
+
+    def usual_log_line
+      "127.0.0.1 - - #{time_log_component}  " +
+        "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+    end
+
+    def usual_log_entry_options
+      {
+        :remote_address => "127.0.0.1",
+        :remote_user => "-",
+        :time_local => Time.local(2011, 8, 3, 16, 58, 1),
+        :runtime => runtime,
+        :request_time => request_time,
+        :request => "GET / HTTP/1.1",
+        :status => 200,
+        :body_bytes_sent => 613,
+        :http_referer => "-",
+        :http_user_agent => "Ruby",
+      }
+    end
+
+    def usual_log_entry
+      create_log_entry(usual_log_entry_options)
+    end
+
+    def not_found_log_line
+      "127.0.0.1 - - #{time_log_component}  " +
+        "\"GET /the-truth.html HTTP/1.1\" 404 613 \"-\" \"Ruby\""
+    end
+
+    def not_found_log_entry
+      options = {
+        :status => 404,
+        :request => "GET /the-truth.html HTTP/1.1",
+      }
+      create_log_entry(usual_log_entry_options.merge(options))
+    end
+
+    def utf8_path
+      "/トップページ.html"
+    end
+
+    def valid_utf8_log_line
+      path = utf8_path
+
+      "127.0.0.1 - - #{time_log_component}  " +
+        "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+    end
+
+    def valid_utf8_log_entry
+      options = {
+        :request => "GET #{utf8_path} HTTP/1.1",
+      }
+      create_log_entry(usual_log_entry_options.merge(options))
+    end
+
+
+    def garbled_path
+      "/#{Random.new.bytes(10)}".force_encoding(Encoding::UTF_8)
+    end
+
+    def invalid_utf8_log_line
+      path = garbled_path
+
+      "127.0.0.1 - - #{time_log_component}  " +
+        "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+    end
+
+    def bad_log_line
+      "bad"
+    end
+  end
+
+  module Environment
+    private
+    def create_log_entry(options)
+      Racknga::LogEntry.new(options)
+    end
+
+    def create_log_file(string)
+      StringIO.new(string)
+    end
+
+    def create_log_parser(file)
+      Racknga::NginxAccessLogParser.new(file)
+    end
+
+    def create_reversed_log_parser(file)
+      Racknga::ReversedNginxAccessLogParser.new(file)
+    end
+
+    def join_lines(*lines)
+      lines.collect do |line|
+        line + "\n"
+      end.join
+    end
+
+    def parse(string)
+      file = create_log_file(string)
+      parser = create_log_parser(file)
+      parser.collect.to_a
+    end
+
+    def reversed_parse(string)
+      file = create_log_file(string)
+      parser = create_reversed_log_parser(file)
+      parser.collect.to_a
+    end
+  end
+
+  module Tests
+    def test_usual_nginx_access_log
+      accesses = parse(join_lines(usual_log_line))
+      access = accesses.first
+      assert_equal(usual_log_entry, access)
+    end
+
+    def test_no_access_log
+      accesses = parse(join_lines())
+      assert_equal([], accesses)
+    end
+
+    def test_multiple_nginx_access_log
+      accesses = parse(join_lines(usual_log_line,
+                                  usual_log_line,
+                                  not_found_log_line))
+      assert_equal([usual_log_entry,
+                    usual_log_entry,
+                    not_found_log_entry],
+                   accesses)
+    end
+
+    def test_reversed_nginx_access_log
+      accesses = reversed_parse(join_lines(usual_log_line,
+                                           usual_log_line,
+                                           not_found_log_line))
+      assert_equal([usual_log_entry,
+                    usual_log_entry,
+                    not_found_log_entry].reverse,
+                   accesses)
+    end
+
+    def test_bad_nginx_access_log
+      assert_raise(Racknga::NginxAccessLogParser::FormatError) do
+        parse(join_lines(bad_log_line))
+      end
+    end
+
+    def test_invalid_utf8_log_line_ignored
+      accesses = parse(join_lines(valid_utf8_log_line,
+                                  invalid_utf8_log_line,
+                                  valid_utf8_log_line))
+      assert_equal([valid_utf8_log_entry,
+                    valid_utf8_log_entry],
+                   accesses)
+    end
+  end
+
+  class CombinedLogTest < Test::Unit::TestCase
+    include Environment
+    include Data
+    include Tests
+
+    def runtime
+      nil
+    end
+
+    def request_time
+      nil
+    end
+  end
+
+  class CombinedWithTimeLogTest < Test::Unit::TestCase
+    include Environment
+    include Data
+    include Tests
+
+    def runtime
+      0.000573
+    end
+
+    def request_time
+      0.001
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: racknga
 version: !ruby/object:Gem::Version 
-  hash: 57
-  prerelease: false
+  hash: 63
+  prerelease: 
   segments: 
   - 0
   - 9
-  - 1
-  version: 0.9.1
+  - 2
+  version: 0.9.2
 platform: ruby
 authors: 
 - Kouhei Sutou
@@ -15,13 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-11 00:00:00 +09:00
-default_executable: 
+date: 2011-08-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   name: rroonga
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +41,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  name: rack
+  prerelease: false
   type: :runtime
-  version_requirements: *id001
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: rack
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: test-unit
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,94 +69,113 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id002
+  name: test-unit-notify
+  prerelease: false
+  type: :development
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: test-unit-capybara
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
-        - 2
         - 0
-        - 4
-        version: 2.0.4
+        version: "0"
+  name: rake
+  prerelease: false
   type: :development
-  version_requirements: *id003
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: jeweler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 3
         segments: 
-        - 2
-        - 6
-        - 2
-        version: 2.6.2
+        - 0
+        version: "0"
+  name: yard
+  prerelease: false
   type: :development
-  version_requirements: *id004
-description: |
-  * rroonga: http://groonga.rubyforge.org/
-  * Rack: http://rack.rubyforge.org/
-
+  requirement: *id008
+description: Racknga is a Rack middlewares that uses rroonga features.
 email: 
-- groonga-users-en@rubyforge.org
-- groonga-dev@lists.sourceforge.jp
+- kou@clear-code.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- NEWS.rdoc
-- NEWS.ja.rdoc
-- README.ja.rdoc
-- README.rdoc
+- README.textile
 files: 
 - AUTHORS
-- NEWS.ja.rdoc
-- NEWS.rdoc
-- README.ja.rdoc
-- README.rdoc
+- Gemfile
+- README.textile
 - Rakefile
-- html/footer.html.erb
-- html/head.html.erb
-- html/header.html.erb
+- doc/text//news.textile
+- lib/racknga.rb
 - lib/racknga/cache_database.rb
 - lib/racknga/exception_mail_notifier.rb
 - lib/racknga/log_database.rb
 - lib/racknga/middleware/cache.rb
 - lib/racknga/middleware/deflater.rb
 - lib/racknga/middleware/exception_notifier.rb
+- lib/racknga/middleware/instance_name.rb
 - lib/racknga/middleware/jsonp.rb
 - lib/racknga/middleware/log.rb
 - lib/racknga/middleware/range.rb
+- lib/racknga/nginx_access_log_parser.rb
+- lib/racknga/reverse_line_reader.rb
 - lib/racknga/utils.rb
 - lib/racknga/version.rb
 - lib/racknga/will_paginate.rb
-- lib/racknga.rb
-- munin/plugins/passenger_domain_
+- license/lgpl-2.1.txt
+- munin/plugins/passenger_application_
 - munin/plugins/passenger_status
-- test/fixtures/rabbit-theme-change.ogv
-- test/racknga-test-utils.rb
-- test/run-test.rb
 - test/test-middleware-jsonp.rb
+- test/racknga-test-utils.rb
 - test/test-middleware-range.rb
-has_rdoc: true
+- test/run-test.rb
+- test/test-middleware-instance-name.rb
+- test/test-middleware-cache.rb
+- test/test-nginx-log-parser.rb
 homepage: http://groonga.rubyforge.org/
 licenses: 
-- LGPL 2.1 or later
+- LGPLv2.1 or later
 post_install_message: 
-rdoc_options: 
-- --main
-- README.ja.rdoc
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -155,9 +199,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: groonga
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: Rack middlewares that uses rroonga features.
+summary: A Rack middleware collection for rroonga features.
 test_files: 
+- test/test-middleware-jsonp.rb
+- test/racknga-test-utils.rb
+- test/test-middleware-range.rb
 - test/run-test.rb
+- test/test-middleware-instance-name.rb
+- test/test-middleware-cache.rb
+- test/test-nginx-log-parser.rb

data/NEWS.ja.rdoc

@@ -1,16 +0,0 @@
-= お知らせ
-
-== 0.9.1: 2010-11-11
-
-* キャッシュの正当性チェックを強化。
-* User-Agent毎のキャッシュをサポート。
-* JSONPをサポートするミドルウェアを追加。
-* HTTPのRangeをサポートするミドルウェアを追加。
-* groongaデータベースにアクセスログを記録するミドルウェアを追加。
-* Passengerの状態を視覚化するMuninプラグインを追加。
-* ライセンスをLGPLv2.1からLGPLv2.1 or laterに変更。
-* will_paginate対応。
-
-== 0.9.0: 2010-07-04
-
-* 最初のリリース！

data/NEWS.rdoc

@@ -1,9 +0,0 @@
-= NEWS
-
-== 0.9.1: 2010-11-11
-
-* Supported will_paginate.
-
-== 0.9.0: 2010-07-04
-
-* Initial release!

data/README.ja.rdoc

@@ -1,80 +0,0 @@
-= はじめに
-
-== 名前
-
-racknga（らくんが）
-
-== 説明
-
-rroongaの機能を利用したRackのミドルウェアとrroongaの機能は利
-用してませんが役に立つミドルウェアを提供します。
-
-* rroonga: http://groonga.rubyforge.org/
-* Rack: http://rack.rubyforge.org/
-
-== 作者
-
-Kouhei Sutou:: <tt><kou@clear-code.com></tt>
-
-== ライセンス
-
-LGPL 2.1またはそれ以降のバージョンです。詳しくは
-license/lgpl-2.1.txtを見てください。
-
-（コントリビュートされたパッチなども含み、Kouhei Sutouが
-ライセンスを変更する権利を持ちます。）
-
-== 依存ソフトウェア
-
-* Ruby >= 1.9.1
-* rroonga
-* Rack
-
-=== あるとよいソフトウェア
-
-* jpmobile
-* will_paginate
-
-== インストール
-
-  % sudo gem install racknga
-
-== メーリングリスト
-
-質問、要望、バグ報告などはgroongaのMLにお願いします。
-
-http://lists.sourceforge.jp/mailman/listinfo/groonga-dev
-
-== ドキュメント
-
-RackngaにはRackアプリケーションに有用なミドルウェアをたくさん
-提供しています。ここでは、オプションなど詳細な情報は
-http://groonga.rubyforge.org/racknga/ を参照してください。
-
-=== Racknga::Middleware::Cache
-
-...
-
-=== Racknga::Middleware::Deflater
-
-...
-
-=== Racknga::Middleware::ExceptionNotifier
-
-...
-
-=== Racknga::Middleware::JSONP
-
-...
-
-=== Racknga::Middleware::Range
-
-...
-
-=== Racknga::Middleware::Log
-
-...
-
-== 感謝
-
-* ...

data/README.rdoc

@@ -1,51 +0,0 @@
-= README
-
-== Name
-
-racknga
-
-== Description
-
-Rack middlewares that uses rroonga features.
-
-* rroonga: http://groonga.rubyforge.org/
-* Rack: http://rack.rubyforge.org/
-
-== Authors
-
-Kouhei Sutou:: <tt><kou@clear-code.com></tt>
-
-== License
-
-LGPL 2.1 or later. See license/lgpl-2.1.txt for details.
-
-(Kouhei Sutou has a right to change the license
-inclidng contributed patches.)
-
-== Dependencies
-
-* Ruby >= 1.9.1
-* rroonga
-* Rack
-
-== Suggested libraries
-
-* will_paginate
-
-== Install
-
-  % sudo gem install racknga
-
-== Documents
-
-Japanese only. Sorry.
-
-http://groonga.rubyforge.org/racknga/
-
-== Mailing list
-
-http://rubyforge.org/mailman/listinfo/groonga-users-en
-
-== Thanks
-
-* ...

data/html/footer.html.erb

@@ -1,33 +0,0 @@
-    </div>
-
-    <div class="sponsors">
-      <p id="sponsor-rubyforge">
-        <a href="http://rubyforge.org/projects/groonga/">
-          <img src="/rubyforge.png" width="120" height="24" border="0" alt="Ruby/groongaプロジェクトはRubyForge.orgにホスティングしてもらっています。" />
-        </a>
-      </p>
-      <p id="sponsor-github">
-        <a href="http://github.com/ranguba/">
-          ラングバプロジェクトはGitHubにホスティングしてもらっています。
-        </a>
-      </p>
-      <p id="sponsor-tango">
-	<a href="http://tango.freedesktop.org/">
-          <img width="120" height="53" border="0" alt="Tango Desktop Projectのアイコンを利用しています。" src="/tango-logo.png" />
-        </a>
-      </p>
-
-<!-- Piwik -->
-<a href="http://piwik.org" title="Web analytics" onclick="window.open(this.href);return(false);">
-<script type="text/javascript">
-var pkBaseURL = (("https:" == document.location.protocol) ? "https://www.clear-code.com/piwik/" : "http://www.clear-code.com/piwik/");
-document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
-</script><script type="text/javascript">
-piwik_action_name = '';
-piwik_idsite = 2;
-piwik_url = pkBaseURL + "piwik.php";
-piwik_log(piwik_action_name, piwik_idsite, piwik_url);
-</script>
-<object><noscript><p>Web analytics <img src="http://www.clear-code.com/piwik/piwik.php?idsite=2" style="border:0" alt=""/></p></noscript></object></a>
-<!-- End Piwik Tag -->
-    </div>

data/html/head.html.erb

@@ -1,4 +0,0 @@
-    <link rel="stylesheet" href="/ranguba.css" type="text/css" />
-    <link rel="shortcut icon" href="/favicon.ico" />
-    <link rel="icon" href="/favicon.png" />
-    <title><%= h(title) %> - ラングバ</title>

data/html/header.html.erb

@@ -1,17 +0,0 @@
-<div class="header">
-  <div class="title">
-    <a href="/">
-      <span class="title"><%= h(title) %></span>
-      <span class="title-separator">-</span>
-      <span class="title-project">ラングバ</span>
-    </a>
-  </div>
-  <ul class="menu">
-    <li id="menu-reference"><a href="/rroonga/">リファレンスマニュアル</a></li>
-    <li id="menu-tutorial"><a href="/rroonga/text/TUTORIAL_ja_rdoc.html">チュートリアル</a></li>
-    <li id="menu-install"><a href="/#install-rroonga">インストール</a></li>
-    <li id="menu-developer"><a href="/developer.html">開発者向け情報</a></li>
-  </ul>
-</div>
-
-<div class="content">