racknga 0.9.2 → 0.9.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd550e89e845e0e90ccac2ef34bf3823e03639b0d61e71fe75ee02bb9ad63e2a
+  data.tar.gz: 4365f32450b7b0a9fc95b77cfbe3403119b8f2623824f3b4be199ec594255011
+SHA512:
+  metadata.gz: a1d84e5281d56bd2f520d0483f1a9ba6cdd1dafbc363268e466b4fea860dd832892d7b5d84ec9ba6d38ebc74d5d356603e7857543ea21029a512fa0b1cd438ae
+  data.tar.gz: f983eab4c092d7d2215d2d52310ff51dc3568be0fb197444f4a5f0a8a7c36ef806cb45a2451b38636994d9fac6d53cda6ca07008d91f0d18557cf5f2d8ff0fc9

data/Gemfile

@@ -1,6 +1,7 @@
 # -*- mode: ruby; coding: utf-8 -*-
 #
 # Copyright (C) 2011  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2013  Haruka Yoshihara <yoshihara@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
@@ -13,18 +14,8 @@
 #
 # 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
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 source "http://rubygems.org/"
 
-gem "rroonga"
-gem "rack"
-
-group :development, :test do
-  gem "test-unit"
-  gem "test-unit-notify"
-  gem "test-unit-capybara"
-  gem "rake"
-  gem "jeweler"
-  gem "yard"
-end
+gemspec

data/README.textile

@@ -2,15 +2,15 @@ h1. README
 
 h2. Name
 
-racknga
+Racknga
 
 h2. Description
 
-Rack middlewares that use rroonga features and
-middlewares/utilities that don't use rroonga features.
+Rack middlewares that use Rroonga features and
+middlewares/utilities that don't use Rroonga features.
 
-  * "rroonga":http://groonga.rubyforge.org/
-  * "Rack":http://rack.rubyforge.org/
+  * "Rroonga":http://ranguba.org/
+  * "Rack":http://rack.github.io/
 
 h2. Authors
 
@@ -26,7 +26,7 @@ including contributed patches.)
 h2. Dependencies
 
   * Ruby >= 1.9.1
-  * rroonga
+  * Rroonga
   * Rack
 
 h2. Suggested libraries
@@ -41,11 +41,12 @@ h2. Install
 
 h2. Documents
 
-http://groonga.rubyforge.org/racknga/en/
+http://ranguba.org/racknga/en/
 
 h2. Mailing list
 
-http://rubyforge.org/mailman/listinfo/groonga-users-en
+  * English: "groonga-talk":http://lists.sourceforge.net/mailman/listinfo/groonga-talk
+  * Japanese: "groonga-dev":http://lists.sourceforge.jp/mailman/listinfo/groonga-dev
 
 h2. Thanks
 

data/Rakefile

@@ -13,7 +13,7 @@
 #
 # 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
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 require 'English'
 
@@ -21,289 +21,36 @@ require 'fileutils'
 require 'pathname'
 require 'erb'
 require 'rubygems'
-require 'jeweler'
-require "rake/clean"
-require "yard"
+require 'rubygems/package_task'
+require 'bundler/gem_helper'
+require "packnga"
 
 base_dir = Pathname.new(__FILE__).dirname
 racknga_lib_dir = base_dir + 'lib'
 $LOAD_PATH.unshift(racknga_lib_dir.to_s)
 
-def guess_version
-  require 'racknga/version'
-  Racknga::VERSION
+helper = Bundler::GemHelper.new(base_dir)
+def helper.version_tag
+  version
 end
+helper.install
+spec = helper.gemspec
 
-ENV["VERSION"] ||= guess_version
-version = ENV["VERSION"].dup
-project = nil
-spec = nil
-Jeweler::Tasks.new do |_spec|
-  spec = _spec
-  spec.name = 'racknga'
-  spec.version = version
-  spec.rubyforge_project = 'groonga'
-  spec.homepage = "http://groonga.rubyforge.org/"
-  authors_file = File.join(base_dir, "AUTHORS")
-  authors = []
-  emails = []
-  File.readlines(authors_file).each do |line|
-    if /\s*<([^<>]*)>$/ =~ line
-      authors << $PREMATCH
-      emails << $1
-    end
-  end
-  spec.authors = authors
-  spec.email = emails
-  spec.summary = "A Rack middleware collection for rroonga features."
-  spec.description = <<-EOD.gsub(/\n/, ' ').strip
-Racknga is a Rack middlewares that uses rroonga features.
-EOD
-  spec.license = "LGPLv2.1 or later"
-  spec.files = FileList["lib/**/*.rb",
-                        "{license,munin,doc/text/}/**/*",
-                        "example/*.rb",
-                        "AUTHORS",
-                        "Rakefile",
-                        "Gemfile",
-                        "README*"]
-  spec.test_files = FileList["test/**/*.rb"]
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_tar_gz = true
 end
 
-Rake::Task["release"].prerequisites.clear
-Jeweler::RubygemsDotOrgTasks.new do
+Packnga::DocumentTask.new(spec) do |task|
+  task.original_language = "en"
+  task.translate_languages = ["ja"]
 end
 
-reference_base_dir = Pathname.new("doc/reference")
-doc_en_dir = reference_base_dir + "en"
-html_base_dir = Pathname.new("doc/html")
-html_reference_dir = html_base_dir + spec.name
-YARD::Rake::YardocTask.new do |task|
-  task.options += ["--title", spec.name]
-  task.options += ["--readme", "README.textile"]
-  task.options += ["--files", "doc/text/**/*"]
-  task.options += ["--output-dir", doc_en_dir.to_s]
-  task.options += ["--charset", "utf-8"]
+Packnga::ReleaseTask.new(spec) do
 end
 
-task :yard do
-  doc_en_dir.find do |path|
-    next if path.extname != ".html"
-    html = path.read
-    html = html.gsub(/<div id="footer">.+<\/div>/m,
-                     "<div id=\"footer\"></div>")
-    path.open("w") do |html_file|
-      html_file.print(html)
-    end
-  end
+desc "Run test"
+task :test do
+  ruby("-rubygems", "test/run-test.rb")
 end
 
-include ERB::Util
-
-def apply_template(content, paths, templates, language)
-  content = content.sub(/lang="en"/, "lang=\"#{language}\"")
-
-  title = nil
-  content = content.sub(/<title>(.+?)<\/title>/m) do
-    title = $1
-    templates[:head].result(binding)
-  end
-
-  content = content.sub(/<body(?:.*?)>/) do |body_start|
-    "#{body_start}\n#{templates[:header].result(binding)}\n"
-  end
-
-  content = content.sub(/<\/body/) do |body_end|
-    "\n#{templates[:footer].result(binding)}\n#{body_end}"
-  end
-
-  content
-end
-
-def erb_template(name)
-  file = File.join("doc/templates", "#{name}.html.erb")
-  template = File.read(file)
-  erb = ERB.new(template, nil, "-")
-  erb.filename = file
-  erb
-end
-
-def rsync_to_rubyforge(spec, source, destination, options={})
-  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-  host = "#{config["username"]}@rubyforge.org"
-
-  rsync_args = "-av --exclude '*.erb' --chmod=ug+w"
-  rsync_args << " --delete" if options[:delete]
-  remote_dir = "/var/www/gforge-projects/#{spec.rubyforge_project}/"
-  sh("rsync #{rsync_args} #{source} #{host}:#{remote_dir}#{destination}")
-end
-
-def rake(*arguments)
-  ruby($0, *arguments)
-end
-
-namespace :reference do
-  translate_languages = [:ja]
-  supported_languages = [:en, *translate_languages]
-  html_files = FileList[doc_en_dir + "**/*.html"].to_a
-
-  directory reference_base_dir.to_s
-  CLOBBER.include(reference_base_dir.to_s)
-
-  po_dir = "doc/po"
-  pot_file = "#{po_dir}/#{spec.name}.pot"
-  namespace :pot do
-    directory po_dir
-    file pot_file => [po_dir, *html_files] do |t|
-      sh("xml2po", "--keep-entities", "--output", t.name, *html_files)
-    end
-
-    desc "Generates pot file."
-    task :generate => pot_file
-  end
-
-  namespace :po do
-    translate_languages.each do |language|
-      namespace language do
-        po_file = "#{po_dir}/#{language}.po"
-
-        if File.exist?(po_file)
-          file po_file => html_files do |t|
-            sh("xml2po", "--keep-entities", "--update", t.name, *html_files)
-          end
-        else
-          file po_file => pot_file do |t|
-            sh("msginit",
-               "--input=#{pot_file}",
-               "--output=#{t.name}",
-               "--locale=#{language}")
-          end
-        end
-
-        desc "Updates po file for #{language}."
-        task :update => po_file
-      end
-    end
-
-    desc "Updates po files."
-    task :update do
-      rake("clobber")
-      rake("yard")
-      translate_languages.each do |language|
-        rake("reference:po:#{language}:update")
-      end
-    end
-  end
-
-  namespace :translate do
-    translate_languages.each do |language|
-      po_file = "#{po_dir}/#{language}.po"
-      translate_doc_dir = "#{reference_base_dir}/#{language}"
-
-      desc "Translates documents to #{language}."
-      task language => [po_file, reference_base_dir, *html_files] do
-        doc_en_dir.find do |path|
-          base_path = path.relative_path_from(doc_en_dir)
-          translated_path = "#{translate_doc_dir}/#{base_path}"
-          if path.directory?
-            mkdir_p(translated_path)
-            next
-          end
-          case path.extname
-          when ".html"
-            sh("xml2po --keep-entities " +
-               "--po-file #{po_file} --language #{language} " +
-               "#{path} > #{translated_path}")
-          else
-            cp(path.to_s, translated_path, :preserve => true)
-          end
-        end
-      end
-    end
-  end
-
-  translate_task_names = translate_languages.collect do |language|
-    "reference:translate:#{language}"
-  end
-  desc "Translates references."
-  task :translate => translate_task_names
-
-  desc "Generates references."
-  task :generate => [:yard, :translate]
-
-  namespace :publication do
-    task :prepare do
-      supported_languages.each do |language|
-        raw_reference_dir = reference_base_dir + language.to_s
-        prepared_reference_dir = html_reference_dir + language.to_s
-        rm_rf(prepared_reference_dir.to_s)
-        head = erb_template("head.#{language}")
-        header = erb_template("header.#{language}")
-        footer = erb_template("footer.#{language}")
-        raw_reference_dir.find do |path|
-          relative_path = path.relative_path_from(raw_reference_dir)
-          prepared_path = prepared_reference_dir + relative_path
-          if path.directory?
-            mkdir_p(prepared_path.to_s)
-          else
-            case path.basename.to_s
-            when /(?:file|method|class)_list\.html\z/
-              cp(path.to_s, prepared_path.to_s)
-            when /\.html\z/
-              relative_dir_path = relative_path.dirname
-              current_path = relative_dir_path + path.basename
-              if current_path.basename.to_s == "index.html"
-                current_path = current_path.dirname
-              end
-              top_path = html_base_dir.relative_path_from(prepared_path.dirname)
-              package_path = top_path + spec.name
-              paths = {
-                :top => top_path,
-                :current => current_path,
-                :package => package_path,
-              }
-              templates = {
-                :head => head,
-                :header => header,
-                :footer => footer
-              }
-              content = apply_template(File.read(path.to_s),
-                                       paths,
-                                       templates,
-                                       language)
-              File.open(prepared_path.to_s, "w") do |file|
-                file.print(content)
-              end
-            else
-              cp(path.to_s, prepared_path.to_s)
-            end
-          end
-        end
-      end
-      File.open("#{html_reference_dir}/.htaccess", "w") do |file|
-        file.puts("RedirectMatch permanent ^/#{spec.name}/$ " +
-                  "#{spec.homepage}#{spec.name}/en/")
-      end
-    end
-  end
-
-  desc "Upload document to rubyforge."
-  task :publish => [:generate, "reference:publication:prepare"] do
-    rsync_to_rubyforge(spec, "#{html_reference_dir}/", spec.name)
-  end
-end
-
-namespace :html do
-  desc "Publish HTML to Web site."
-  task :publish do
-    rsync_to_rubyforge(spec, "#{html_base_dir}/", "")
-  end
-end
-
-desc "Upload document to rubyforge."
-task :publish => ["reference:publish"]
-
-desc "Tag the current revision."
-task :tag do
-  sh("git tag -a #{version} -m 'release #{version}!!!'")
-end
+task :default => :test

data/doc/text/news.textile

@@ -1,5 +1,25 @@
 h1. NEWS
 
+h2. 0.9.4: 2023-09-03
+
+h3. Improvments
+
+  * [cache] Made Rroonga dependency optional. Users must add Rroonga
+    dependency explicitly.
+  * And more improvements...
+
+h2. 0.9.3: 2011-11-12
+
+h3. Improvments
+
+  * [access-log-parser] Supported Apache log.
+  * [cache] Fixed unknown name errors.
+  * [cache] Fixed max age.
+  * [nginx] Added NginxRawURI middleware.
+  * [instance-name] Added branch name and Ruby version.
+  * [exception-mail-notifier] Used #message instead of #to_s.
+  * [logger] Logged also X-Runtime.
+
 h2. 0.9.2: 2011-08-07
 
 h3. Improvments

data/lib/racknga/access_log_parser.rb

@@ -0,0 +1,147 @@
+# -*- 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "racknga/log_entry"
+require "racknga/reverse_line_reader"
+
+module Racknga
+  # Supported formats:
+  #  * combined (nginx's default format)
+  #  * combined (Apache's predefined format)
+  #  * combined_with_time_nginx (custom format with runtime)
+  #  * combined_with_time_apache (custom format with runtime)
+  #
+  # Configurations:
+  #  * combined
+  #    * nginx
+  #      log_format combined '$remote_addr - $remote_user [$time_local]  '
+  #                          '"$request" $status $body_bytes_sent '
+  #                          '"$http_referer" "$http_user_agent"';
+  #      access_log log/access.log combined
+  #    * Apache
+  #      CustomLog ${APACHE_LOG_DIR}/access.log combined
+  #
+  #  * combined_with_time_nginx
+  #    * nginx
+  #      log_format combined_with_time '$remote_addr - $remote_user '
+  #                                    '[$time_local, $upstream_http_x_runtime, $request_time]  '
+  #                                    '"$request" $status $body_bytes_sent '
+  #                                    '"$http_referer" "$http_user_agent"';
+  #      access_log log/access.log combined_with_time
+  #
+  #  * combined_with_time_apache
+  #    * Apache
+  #      LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\" %{X-Runtime}o %D" combined_with_time
+  #      CustomLog ${APACHE_LOG_DIR}/access.log combined_with_time
+  class AccessLogParser
+    include Enumerable
+
+    class FormatError < StandardError
+    end
+
+    def initialize(line_reader)
+      @line_reader = line_reader
+    end
+
+    def each
+      @line_reader.each do |line|
+        line.force_encoding("UTF-8")
+        yield(parse_line(line)) if line.valid_encoding?
+      end
+    end
+
+    private
+    REMOTE_ADDRESS = "[^\\x20]+"
+    REMOTE_USER = "[^\\x20]+"
+    TIME_LOCAL = "[^\\x20]+\\x20\\+\\d{4}"
+    RUNTIME = "(?:[\\d.]+|-)"
+    REQUEST_TIME = "[\\d.]+"
+    REQUEST = ".*?"
+    STATUS = "\\d{3}"
+    BODY_BYTES_SENT = "(?:\\d+|-)"
+    HTTP_REFERER = ".*?"
+    HTTP_USER_AGENT = "(?:\\\"|[^\"])*?"
+    COMBINED_FORMAT =
+      /^(#{REMOTE_ADDRESS})\x20
+        -\x20
+        (#{REMOTE_USER})\x20
+        \[(#{TIME_LOCAL})(?:,\x20(.+))?\]\x20+
+        "(#{REQUEST})"\x20
+        (#{STATUS})\x20
+        (#{BODY_BYTES_SENT})\x20
+        "(#{HTTP_REFERER})"\x20
+        "(#{HTTP_USER_AGENT})"
+        (?:\x20(.+))?$/x
+    def parse_line(line)
+      case line
+      when COMBINED_FORMAT
+        last_match = Regexp.last_match
+        options = {}
+        options[:remote_address] = last_match[1]
+        options[:remote_user] = last_match[2]
+        options[:time_local] = parse_local_time(last_match[3])
+        if last_match[4]
+          if /\A(#{RUNTIME}), (#{REQUEST_TIME})\z/ =~ last_match[4]
+            time_match = Regexp.last_match
+            options[:runtime] = time_match[1]
+            options[:request_time] = time_match[2]
+          else
+            message = "expected 'RUNTIME, REQUEST_TIME' time format: " +
+                      "<#{last_match[4]}>: <#{line}>"
+            raise FormatError.new(message)
+          end
+        end
+        options[:request] = last_match[5]
+        options[:status] = last_match[6].to_i
+        options[:body_bytes_sent] = last_match[7]
+        options[:http_referer] = last_match[8]
+        options[:http_user_agent] = last_match[9]
+        if last_match[10]
+          if /\A(#{RUNTIME}) (#{REQUEST_TIME})\z/ =~ last_match[10]
+            time_match = Regexp.last_match
+            runtime = time_match[1]
+            request_time = time_match[2]
+            request_time = request_time.to_i * 0.000_001 if request_time
+            options[:runtime] = runtime
+            options[:request_time] = request_time
+          else
+            message = "expected 'RUNTIME REQUEST_TIME' time format: " +
+                      "<#{last_match[10]}>: <#{line}>"
+            raise FormatError.new(message)
+          end
+        end
+        LogEntry.new(options)
+      else
+        raise FormatError.new("unsupported format log entry: <#{line}>")
+      end
+    end
+
+    def parse_local_time(token)
+      day, month, year, hour, minute, second, _time_zone = token.split(/[\/: ]/)
+      _ = _time_zone # FIXME: suppress a warning. :<
+      Time.local(year, month, day, hour, minute, second)
+    end
+  end
+
+  class ReversedAccessLogParser < AccessLogParser
+    def initialize(line_reader)
+      @line_reader = ReverseLineReader.new(line_reader)
+    end
+  end
+end

data/lib/racknga/api-keys.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Haruka Yoshihara <yoshihara@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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module Racknga
+  # This is a store for API keys. It is used with
+  # Racknga::Middleware::Auth::APIKeys.
+  class APIKeys
+    # @param [String] query_parameter query parameter to specify an API key.
+    # @param [Array] api_keys stored API keys.
+    def initialize(query_parameter, api_keys)
+      @query_parameter = query_parameter
+      @api_keys = api_keys
+    end
+
+    # Checks whether stored API keys includes an API key in a request.
+    # @param [Hash] environment an environment for Rack.
+    # @return [Boolean] true if an API key is included, or false if not.
+    def include?(environment)
+      request = Rack::Request.new(environment)
+      key = request[@query_parameter]
+
+      @api_keys.include?(key)
+    end
+  end
+end

data/lib/racknga/cache_database.rb

@@ -14,7 +14,7 @@
 #
 # 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
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 require 'fileutils'
 
@@ -53,17 +53,27 @@ module Racknga
     # process from your Rack application
     # process. (e.g. cron.) It's multi process safe.
     def purge_old_responses
-      age_modulo = 2 ** 32
+      age_modulo = 2 ** 31 - 1
       age = configuration.age
       previous_age = (age - 1).modulo(age_modulo)
-      configuration.age = (age + 1).modulo(age_modulo)
+      next_age = (age + 1).modulo(age_modulo)
 
       target_responses = responses.select do |record|
-        record.age == previous_age
+        record.age == next_age
       end
       target_responses.each do |response|
         response.key.delete
       end
+      configuration.age = next_age
+
+      target_responses = responses.select do |record|
+        record.age <= previous_age
+      end
+      target_responses.each do |response|
+        response.key.delete
+      end
+
+      responses.defrag if responses.respond_to?(:defrag)
     end
 
     def ensure_database
@@ -88,7 +98,7 @@ module Racknga
                             :key_type => "ShortText") do |table|
           table.uint32("status")
           table.short_text("headers")
-          table.text("body", :compress => :zlib)
+          table.text("body")
           table.short_text("checksum")
           table.uint32("age")
           table.time("created_at")