racknga 0.9.3 → 0.9.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a79351d478e9f65c4a538c46887772e03d50a40ec6184cd293a66c4fd3b17693
+  data.tar.gz: 6063c757219857417651798caa288da2467e891faadaf0ff1699b1ac0f171d0a
+SHA512:
+  metadata.gz: 7b5143554b8e2ded028e10e37f74b6b01064c12a8bfc8fee957bbb0167748cbb043c9ebb0ccbc7e9949239bd095bb971f449dc85e4a4fb7688647b4536fce905
+  data.tar.gz: 902a9509717410a4f9221f7d12b7398485ab7a0ecb2996e80874ffd97f050d52446aca77e20d2a6c2f9365110742d97d55b3704481f6a3debf0070387f82ff50

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.md

@@ -0,0 +1,44 @@
+# README
+
+## Name
+
+Racknga
+
+## Description
+
+Rack middlewares that use Rroonga features and
+middlewares/utilities that don't use Rroonga features.
+
+  * [Rroonga](https://ranguba.org/)
+  * [Rack](https://rack.github.io/)
+
+## Authors
+
+  * Sutou Kouhei `<kou@clear-code.com>`
+
+## License
+
+LGPL 2.1 or later. See license/lgpl-2.1.txt for details.
+
+(Sutou Kouhei has a right to change the license
+including contributed patches.)
+
+## Dependencies
+
+  * Ruby >= 1.9.1
+  * Rroonga
+  * Rack
+
+## Suggested libraries
+
+  * jpmobile
+
+## Install
+
+```console
+$ sudo gem install racknga
+```
+
+## Documents
+
+https://ranguba.org/racknga/en/

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("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 → news.md}

@@ -1,8 +1,25 @@
-h1. NEWS
+# NEWS
 
-h2. 0.9.3: 2011-11-12
+## 0.9.5: 2024-04-08
 
-h3. Improvments
+### Improvments
+
+  * Added `base64` dependency.
+  * Added `net-smtp` dependency.
+  * Removed `nkf` dependency.
+  * Stopped using deprecated APIs of Rack.
+
+## 0.9.4: 2023-09-03
+
+### Improvments
+
+  * [cache] Made Rroonga dependency optional. Users must add Rroonga
+    dependency explicitly.
+  * And more improvements...
+
+## 0.9.3: 2011-11-12
+
+### Improvments
 
   * [access-log-parser] Supported Apache log.
   * [cache] Fixed unknown name errors.
@@ -12,9 +29,9 @@ h3. Improvments
   * [exception-mail-notifier] Used #message instead of #to_s.
   * [logger] Logged also X-Runtime.
 
-h2. 0.9.2: 2011-08-07
+## 0.9.2: 2011-08-07
 
-h3. Improvments
+### Improvments
 
   * [munin] Supported Passenger 3 support.
   * [munin] Removed Passenger 2 support.
@@ -28,7 +45,7 @@ h3. Improvments
   * Added NginixAccessLogParser.
   * Documented middlewares.
 
-h2. 0.9.1: 2010-11-11
+## 0.9.1: 2010-11-11
 
   * Improved cache validation.
   * Supported caches per User-Agent.
@@ -39,6 +56,6 @@ h2. 0.9.1: 2010-11-11
   * Changed license to LGPLv2.1 or later from LGPLv2.1.
   * Supported will_paginate.
 
-h2. 0.9.0: 2010-07-04
+## 0.9.0: 2010-07-04
 
   * Initial release!

data/lib/racknga/access_log_parser.rb

@@ -15,7 +15,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 "racknga/log_entry"
 require "racknga/reverse_line_reader"

data/lib/racknga/api-keys.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2012  Haruka Yoshihara <yoshihara@clear-code.com>
+# Copyright (C) 2024  Sutou Kouhei <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
+
+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.params[@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'
 
@@ -98,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")

data/lib/racknga/exception_mail_notifier.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2010-2011  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2024  Sutou Kouhei <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
@@ -14,15 +12,15 @@
 #
 # 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 'time'
-require 'net/smtp'
-require 'etc'
-require 'socket'
-require 'nkf'
+require "base64"
+require "etc"
+require "net/smtp"
+require "socket"
+require "time"
 
-require 'racknga/utils'
+require "racknga/utils"
 
 module Racknga
   # Ruby 1.9 only. 1.8 isn't supported.
@@ -132,10 +130,10 @@ EOE
     end
 
     def send_summaries
-        subject = "summaries of #{@summaries.size} notifications"
-        mail = create_mail(:subject => subject,
-                           :body => report_body)
-        send(mail)
+      subject = "summaries of #{@summaries.size} notifications"
+      mail = create_mail(:subject => subject,
+                         :body => report_body)
+      send(mail)
     end
 
     def report_body
@@ -198,10 +196,13 @@ EOB
     def encode_subject(subject)
       case charset
       when /\Aiso-2022-jp\z/i
-        NKF.nkf('-Wj -M', subject)
-      else
-        NKF.nkf('-Ww -M', subject)
+        subject = subject.encode("ISO-2022-JP")
+      end
+      base64_subject = Base64.encode64(subject)
+      lines = base64_subject.lines.collect do |line|
+        "=?#{charset}?B?#{line.chomp}?="
       end
+      lines.join("\r\n")
     end
   end
 end

data/lib/racknga/log_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'
 

data/lib/racknga/log_entry.rb

@@ -15,7 +15,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
 
 module Racknga
   class LogEntry