racknga 0.9.0

data/AUTHORS

@@ -0,0 +1 @@
+Kouhei Sutou <kou@clear-code.com>

data/NEWS.ja.rdoc

@@ -0,0 +1,5 @@
+= お知らせ
+
+== 0.9.0: 2010-07-04
+
+* 最初のリリース！

data/NEWS.rdoc

@@ -0,0 +1,5 @@
+= NEWS
+
+== 0.9.0: 2010-07-04
+
+* Initial release!

data/README.ja.rdoc

@@ -0,0 +1,44 @@
+= はじめに
+
+== 名前
+
+racknga（らくんが）
+
+== 説明
+
+rroongaの機能を利用したRackのミドルウェアを提供します。
+
+* rroonga: http://groonga.rubyforge.org/
+* Rack: http://rack.rubyforge.org/
+
+== 作者
+
+Kouhei Sutou:: <tt><kou@clear-code.com></tt>
+
+== ライセンス
+
+LGPL 2.1です。詳しくはlicense/LGPLを見てください。
+
+== 依存ソフトウェア
+
+* Ruby >= 1.9.1
+* rroonga
+* Rack
+
+== インストール
+
+  % sudo gem install racknga
+
+== ドキュメント
+
+http://groonga.rubyforge.org/racknga/
+
+== メーリングリスト
+
+質問、要望、バグ報告などはgroongaのMLにお願いします。
+
+http://lists.sourceforge.jp/mailman/listinfo/groonga-dev
+
+== 感謝
+
+* ...

data/README.rdoc

@@ -0,0 +1,44 @@
+= 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. See license/LGPL for details.
+
+== Dependencies
+
+* Ruby >= 1.9.1
+* rroonga
+* Rack
+
+== 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/Rakefile

@@ -0,0 +1,189 @@
+# -*- coding: utf-8; mode: ruby -*-
+#
+# Copyright (C) 2010  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 version 2.1 as published by the Free Software Foundation.
+#
+# 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 'English'
+
+require 'find'
+require 'fileutils'
+require 'pathname'
+require 'erb'
+require 'rubygems'
+gem 'rdoc'
+require 'hoe'
+
+ENV["NODOT"] = "yes"
+
+base_dir = Pathname(__FILE__).dirname
+truncate_base_dir = Proc.new do |path|
+  path.relative_path_from(base_dir)
+end
+
+racknga_lib_dir = base_dir + 'lib'
+$LOAD_PATH.unshift(racknga_lib_dir.to_s)
+
+def guess_version
+  require 'racknga/version'
+  Racknga::VERSION
+end
+
+manifest = base_dir + "Manifest.txt"
+manifest_contents = []
+base_dir_included_components = %w(AUTHORS Rakefile
+                                  README.rdoc README.ja.rdoc
+                                  NEWS.rdoc NEWS.ja.rdoc
+                                  rroonga-build.rb extconf.rb pkg-config.rb)
+excluded_components = %w(.cvsignore .gdb_history CVS depend Makefile doc pkg
+                         .svn .git doc data .test-result tmp)
+excluded_suffixes = %w(.png .ps .pdf .o .so .a .txt .~)
+unless ENV["RUBY_CC_VERSION"]
+  excluded_components << "vendor"
+end
+base_dir.find do |target|
+  target = truncate_base_dir[target]
+  components = target.to_s.split(File::SEPARATOR)
+  if components.size == 1 and !target.directory?
+    next unless base_dir_included_components.include?(components[0])
+  end
+  Find.prune if (excluded_components - components) != excluded_components
+  next if excluded_suffixes.include?(File.extname(target))
+  manifest_contents << target if File.file?(target)
+end
+
+File.open(manifest, "w") do |f|
+  f.puts manifest_contents.sort.join("\n")
+end
+
+# For Hoe's no user friendly default behavior. :<
+File.open("README.txt", "w") {|file| file << "= Dummy README\n== XXX\n"}
+FileUtils.cp("NEWS.rdoc", "History.txt")
+at_exit do
+  FileUtils.rm_f("README.txt")
+  FileUtils.rm_f("History.txt")
+  FileUtils.rm_f(manifest)
+end
+
+def cleanup_white_space(entry)
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+ENV["VERSION"] ||= guess_version
+version = ENV["VERSION"]
+project = nil
+Hoe.spec('racknga') do
+  Hoe::Test::SUPPORTED_TEST_FRAMEWORKS[:testunit2] = "test/run-test.rb"
+  project = self
+  project.version = version.dup
+  project.rubyforge_name = 'groonga'
+  authors = File.join(base_dir, "AUTHORS")
+  project.author = File.readlines(authors).collect do |line|
+    if /\s*<[^<>]*>$/ =~ line
+      $PREMATCH
+    else
+      nil
+    end
+  end.compact
+  project.email = ['groonga-users-en@rubyforge.org',
+                   'groonga-dev@lists.sourceforge.jp']
+  project.url = 'http://groonga.rubyforge.org/'
+  project.testlib = :testunit2
+  project.test_globs = ["test/run-test.rb"]
+  project.extra_deps += [["rroonga"],
+                         ["rack"]]
+  project.spec_extras = {
+    :extra_rdoc_files => Dir.glob("**/*.rdoc"),
+    :licenses => ["LGPL 2.1"]
+  }
+  project.readme_file = "README.ja.rdoc"
+
+  news_of_current_release = File.read("NEWS.rdoc").split(/^==\s.*$/)[1]
+  project.changes = cleanup_white_space(news_of_current_release)
+
+  entries = File.read("README.rdoc").split(/^==\s(.*)$/)
+  description = cleanup_white_space(entries[entries.index("Description") + 1])
+  project.summary, project.description, = description.split(/\n\n+/, 3)
+
+  project.remote_rdoc_dir = "racknga"
+end
+
+ObjectSpace.each_object(Rake::RDocTask) do |rdoc_task|
+  options = rdoc_task.options
+  t_option_index = options.index("--title") || options.index("-t")
+  rdoc_task.options[t_option_index, 2] = [] if t_option_index
+  rdoc_task.title = "racknga - #{version}"
+end
+
+task :publish_docs => [:prepare_docs_for_publishing]
+
+
+include ERB::Util
+
+def apply_template(file, head, header, footer)
+  content = File.read(file)
+  content = content.sub(/lang="en"/, 'lang="ja"')
+
+  title = nil
+  content = content.sub(/<title>(.+?)<\/title>/) do
+    title = $1
+    head.result(binding)
+  end
+
+  content = content.sub(/<body(?:.*?)>/) do |body_start|
+    "#{body_start}\n#{header.result(binding)}\n"
+  end
+
+  content = content.sub(/<\/body/) do |body_end|
+    "\n#{footer.result(binding)}\n#{body_end}"
+  end
+
+  File.open(file, "w") do |file|
+    file.print(content)
+  end
+end
+
+def erb_template(name)
+  file = File.join("html", "#{name}.html.erb")
+  template = File.read(file)
+  erb = ERB.new(template, nil, "-")
+  erb.filename = file
+  erb
+end
+
+task :prepare_docs_for_publishing do
+  head = erb_template("head")
+  header = erb_template("header")
+  footer = erb_template("footer")
+  Find.find("doc") do |file|
+    if /\.html\z/ =~ file and /_(?:c|rb)\.html\z/ !~ file
+      apply_template(file, head, header, footer)
+    end
+  end
+end
+
+task :publish_html do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+
+  rsync_args = "-av --exclude '*.erb' --exclude '*.svg' --exclude .svn"
+  remote_dir = "/var/www/gforge-projects/#{project.rubyforge_name}/"
+  sh "rsync #{rsync_args} html/ #{host}:#{remote_dir}"
+end
+
+task :tag do
+  sh("git tag -a #{version} -m 'release #{version}!!!'")
+end
+
+task(:release).prerequisites.reject! {|name| name == "clean"}

data/html/footer.html.erb

@@ -0,0 +1,28 @@
+    </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-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

@@ -0,0 +1,4 @@
+    <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

@@ -0,0 +1,17 @@
+<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">

data/lib/racknga/cache_database.rb

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2010  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 version 2.1 as published by the Free Software Foundation.
+#
+# 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
+
+module Racknga
+  class CacheDatabase
+    def initialize(database_path)
+      @database_path = database_path
+      @context = Groonga::Context.new(:encoding => :none)
+      ensure_database
+    end
+
+    def responses
+      @context["Responses"]
+    end
+
+    def purge_old_responses(threshold_time_stamp=nil)
+      threshold_time_stamp ||= Time.now
+      responses.each do |response|
+        response.delete if response.created_at < threshold_time_stamp
+      end
+    end
+
+    def ensure_database
+      if File.exist?(@database_path)
+        @database = Groonga::Database.open(@database_path, :context => @context)
+      else
+        create_database
+      end
+      ensure_tables
+    end
+
+    def close_database
+      @database.close
+    end
+
+    private
+    def create_responses_table
+      Groonga::Schema.define(:context => @context) do |schema|
+        schema.create_table("Responses",
+                            :type => :hash,
+                            :key_type => "ShortText") do |table|
+          table.uint32("status")
+          table.short_text("headers")
+          table.text("body")
+          table.time("created_at")
+        end
+      end
+    end
+
+    def create_database
+      FileUtils.mkdir_p(File.dirname(@database_path))
+      @database = Groonga::Database.create(:path => @database_path,
+                                           :context => @context)
+    end
+
+    def ensure_tables
+      return if responses
+      create_responses_table
+    end
+  end
+end

data/lib/racknga/exception_mail_notifier.rb

@@ -0,0 +1,144 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2010  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 version 2.1 as published by the Free Software Foundation.
+#
+# 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 'time'
+require 'net/smtp'
+require 'etc'
+require 'socket'
+
+require 'racknga/utils'
+
+module Racknga
+  # Ruby 1.9 only. 1.8 isn't supported.
+  class ExceptionMailNotifier
+    def initialize(options)
+      @options = Utils.normalize_options(options || {})
+    end
+
+    def notify(exception, environment)
+      host = @options[:host] || "localhost"
+      return if to.empty?
+      mail = format(exception, environment)
+      Net::SMTP.start(host, @options[:port]) do |smtp|
+        smtp.send_message(mail, from, *to)
+      end
+    end
+
+    private
+    def format(exception, environment)
+      header = format_header(exception, environment)
+      body = format_body(exception, environment)
+      mail = "#{header}\r\n#{body}"
+      mail.force_encoding("utf-8")
+      begin
+        mail = mail.encode(charset)
+      rescue EncodingError
+      end
+      mail.force_encoding("ASCII-8BIT")
+    end
+
+    def format_header(exception, environment)
+      <<-EOH
+MIME-Version: 1.0
+Content-Type: Text/Plain; charset=#{charset}
+Content-Transfer-Encoding: #{transfer_encoding}
+From: #{from}
+To: #{to.join(', ')}
+Subject: #{encode_subject(subject(exception, environment))}
+Date: #{Time.now.rfc2822}
+EOH
+    end
+
+    def format_body(exception, environment)
+      request = Rack::Request.new(environment)
+      body = <<-EOB
+URL: #{request.url}
+--
+#{exception.class}: #{exception}
+--
+#{exception.backtrace.join("\n")}
+EOB
+      params = request.params
+      max_key_size = (environment.keys.collect(&:size) +
+                      params.keys.collect(&:size)).max
+      body << <<-EOE
+--
+Environments:
+EOE
+      environment.sort_by {|key, value| key}.each do |key, value|
+        body << "  %*s: <%s>\n" % [max_key_size, key, value]
+      end
+
+      unless params.empty?
+        body << <<-EOE
+--
+Parameters:
+EOE
+        params.sort_by {|key, value| key}.each do |key, value|
+          body << "  %#{max_key_size}s: <%s>\n" % [key, value]
+        end
+      end
+
+      body
+    end
+
+    def subject(exception, environment)
+      [@options[:subject_label], exception.to_s].compact.join(' ')
+    end
+
+    def to
+      @to ||= ensure_array(@options[:to]) || []
+    end
+
+    def ensure_array(maybe_array)
+      maybe_array = [maybe_array] if maybe_array.is_a?(String)
+      maybe_array
+    end
+
+    def from
+      @from ||= @options[:from] || guess_from
+    end
+
+    def guess_from
+      name = Etc.getpwuid(Process.uid).name
+      host = Socket.gethostname
+      "#{name}@#{host}"
+    end
+
+    def charset
+      @options[:charset] || 'utf-8'
+    end
+
+    def transfer_encoding
+      case charset
+      when /\Autf-8\z/i
+        "8bit"
+      else
+        "7bit"
+      end
+    end
+
+    def encode_subject(subject)
+      case charset
+      when /\Aiso-2022-jp\z/i
+        NKF.nkf('-Wj -M', subject)
+      else
+        NKF.nkf('-Ww -M', subject)
+      end
+    end
+  end
+end

data/lib/racknga/middleware/cache.rb

@@ -0,0 +1,122 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2010  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 version 2.1 as published by the Free Software Foundation.
+#
+# 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 'yaml'
+require 'racknga/cache_database'
+
+module Racknga
+  module Middleware
+    class Cache
+      def initialize(application, options={})
+        @application = application
+        @options = Utils.normalize_options(options || {})
+        database_path = @options[:database_path]
+        raise ArgumentError, ":database_path is missing" if database_path.nil?
+        @database = CacheDatabase.new(database_path)
+      end
+
+      def call(environment)
+        request = Rack::Request.new(environment)
+        return @application.call(environment) unless use_cache?(request)
+        key = "#{key_prefix(request)}:#{normalize_path(request.fullpath)}"
+        cache = @database.responses
+        record = cache[key]
+        if record
+          handle_request_with_cache(cache, key, record, request)
+        else
+          handle_request(cache, key, request)
+        end
+      end
+
+      def ensure_database
+        @database.ensure_database
+      end
+
+      def close_database
+        @database.close_database
+      end
+
+      private
+      def use_cache?(requeust)
+        requeust.get? or requeust.head?
+      end
+
+      def key_prefix(request)
+        if request.respond_to?(:mobile?) and request.mobile?
+          last_component = request.mobile.class.name.split(/::/).last
+          "mobile:#{last_component.downcase}"
+        else
+          "pc"
+        end
+      end
+
+      def normalize_path(path)
+        path.gsub(/&callback=jsonp\d+&_=\d+\z/, '')
+      end
+
+      def skip_caching_response?(status, headers, body)
+        return true if status != 200
+        return true if status != 200
+
+        headers = Rack::Utils::HeaderHash.new(headers)
+        content_type = headers["Content-Type"]
+        if /\A(\w+)\/([\w.+\-]+)\b/ =~ content_type
+          media_type = $1
+          sub_type = $2
+          return false if media_type == "text"
+          return false if sub_type == "json"
+          return false if sub_type == "xml"
+          return false if /\+xml\z/ =~ sub_type
+        end
+        true
+      end
+
+      def handle_request(cache, key, request)
+        status, headers, body = @application.call(request.env)
+        if skip_caching_response?(status, headers, body)
+          return [status, headers, body]
+        end
+
+        now = Time.now
+        headers = Rack::Utils::HeaderHash.new(headers)
+        headers["Last-Modified"] ||= now.httpdate
+        stringified_body = ''
+        body.each do |data|
+          stringified_body << data
+        end
+        headers = headers.to_hash
+        cache[key] = {
+          :status => status,
+          :headers => headers.to_yaml,
+          :body => stringified_body.force_encoding("ASCII-8BIT"),
+          :created_at => now,
+        }
+        body = [stringified_body]
+        [status, headers, body]
+      end
+
+      def handle_request_with_cache(cache, key, record, request)
+        body = record["body"]
+        return handle_request(cache, key, request) if body.nil?
+
+        status = record["status"]
+        headers = YAML.load(record["headers"])
+        [status, headers, [body]]
+      end
+    end
+  end
+end