racknga 0.9.2 → 0.9.4

data/lib/racknga/exception_mail_notifier.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 'time'
 require 'net/smtp'
@@ -132,10 +132,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
@@ -149,7 +149,7 @@ Timestamp: #{Time.now.rfc2822}
 --
 URL: #{request.url}
 --
-#{exception.class}: #{exception}
+#{exception.class}: #{exception.message}
 EOB
     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'
 
@@ -95,6 +95,7 @@ module Racknga
           table.reference("path", "Paths")
           table.reference("user_agent", "UserAgents")
           table.float("runtime")
+          table.float("request_time")
           table.short_text("message", :compress => :zlib)
         end
 

data/lib/racknga/log_entry.rb

@@ -0,0 +1,85 @@
+# -*- 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
+
+module Racknga
+  class LogEntry
+    ATTRIBUTES = [
+      :remote_address,
+      :remote_user,
+      :time_local,
+      :runtime,
+      :request_time,
+      :request,
+      :status,
+      :body_bytes_sent,
+      :http_referer,
+      :http_user_agent,
+    ]
+
+    attr_reader(*ATTRIBUTES)
+    def initialize(options=nil)
+      options ||= {}
+      @remote_address = options[:remote_address]
+      @remote_user = normalize_string_value(options[:remote_user])
+      @time_local = options[:time_local] || Time.at(0)
+      @runtime = normalize_float_value(options[:runtime])
+      @request_time = normalize_float_value(options[:request_time])
+      @request = options[:request]
+      @status = options[:status]
+      @body_bytes_sent = normalize_int_value(options[:body_bytes_sent])
+      @http_referer = normalize_string_value(options[:http_referer])
+      @http_user_agent = normalize_string_value(options[:http_user_agent])
+    end
+
+    def attributes
+      ATTRIBUTES.collect do |attribute|
+        __send__(attribute)
+      end
+    end
+
+    def ==(other)
+      other.is_a?(self.class) and attributes == other.attributes
+    end
+
+    private
+    def normalize_string_value(value)
+      if value.nil? or value == "-"
+        nil
+      else
+        value.to_s
+      end
+    end
+
+    def normalize_float_value(value)
+      if value.nil?
+        value
+      else
+        value.to_f
+      end
+    end
+
+    def normalize_int_value(value)
+      if value.nil? or value == "-"
+        nil
+      else
+        value.to_i
+      end
+    end
+  end
+end

data/lib/racknga/middleware/auth/api-key.rb

@@ -0,0 +1,95 @@
+# -*- 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
+  module Middleware
+    module Auth
+      # This is a middleware that provides an authentication of API key.
+      # This middleware checks whether a URL requests API and
+      # whether API key in its request is authorized.
+      # When a URL requests API with unauthorized API key,
+      # this middleware returns json response with :error_message.
+      # Racknga::APIKeys is used as authorized API keys.
+      # Usage:
+      #   require 'racknga'
+      #
+      #   authorized_api_keys =
+      #     Racknga::APIKeys.new("api-query-parameter", ["key1", "key2"])
+      #   error_response =
+      #   api_key_options = {
+      #     :api_url_prefixes => ["/api"],
+      #     :authorized_api_keys => authorized_api_keys,
+      #     :error_response => {"error" => "this api key is not authorized"}
+      #   }
+      #   use Racknga::Middleware::Auth::APIKey, api_key_options
+      #   run YourApplication
+      class APIKey
+        def initialize(application, options={})
+          @application = application
+          @authorized_api_keys = options[:authorized_api_keys]
+          url_prefixes_option = options[:api_url_prefixes]
+          @api_url_prefixes = url_prefixes_option.collect do |url|
+            /\A#{Regexp.escape(url)}/
+          end
+          @error_response = options[:error_response].to_json
+          @disable_authorization = options[:disable_authorization]
+        end
+
+        # For Rack.
+        def call(environment)
+          if api_url?(environment) and not authorized?(environment)
+            unauthorized_access_response
+          else
+            @application.call(environment)
+          end
+        end
+
+        private
+        def api_url?(environment)
+          @api_url_prefixes.any? do |prefix|
+            environment["PATH_INFO"] =~ prefix
+          end
+        end
+
+        def authorized?(environment)
+          if disable_authorization?
+            true
+          else
+            if @authorized_api_keys
+              @authorized_api_keys.include?(environment)
+            else
+              false
+            end
+          end
+        end
+
+        def disable_authorization?
+          @disable_authorization
+        end
+
+        def unauthorized_access_response
+          [
+            401,
+            {"Content-Type" => "application/json; charset=utf-8"},
+            [@error_response],
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/racknga/middleware/cache.rb

@@ -14,10 +14,11 @@
 #
 # 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 'digest'
 require 'yaml'
+require 'zlib'
 require 'racknga/cache_database'
 
 module Racknga
@@ -168,13 +169,15 @@ module Racknga
         now = Time.now
         headers = Rack::Utils::HeaderHash.new(headers)
         headers["Last-Modified"] ||= now.httpdate
-        stringified_body = ''
+        encoded_body = ''.force_encoding("ASCII-8BIT")
+        deflater = ::Zlib::Deflate.new
         body.each do |data|
-          stringified_body << data
+          encoded_body << deflater.deflate(data)
         end
+        body.close if body.respond_to?(:close)
+        encoded_body << deflater.finish
         headers = headers.to_hash
         encoded_headers = headers.to_yaml
-        encoded_body = stringified_body.force_encoding("ASCII-8BIT")
         cache[key] = {
           :status => status,
           :headers => encoded_headers,
@@ -183,7 +186,7 @@ module Racknga
           :age => age,
           :created_at => now,
         }
-        body = [stringified_body]
+        body = Inflater.new(encoded_body)
         log("store", request)
         [status, headers, body]
       end
@@ -199,7 +202,7 @@ module Racknga
         end
 
         log("hit", request)
-        [status, YAML.load(headers), [body]]
+        [status, YAML.load(headers), Inflater.new(body)]
       end
 
       def compute_checksum(status, encoded_headers, encoded_body)
@@ -221,12 +224,23 @@ module Racknga
       def log(tag, request)
         return unless Middleware.const_defined?(:Log)
         env = request.env
-        logger = env[Middleware::Log::LOGGER_KEY]
+        logger = env[Middleware::Log::LOGGER]
         return if logger.nil?
-        start_time = env[START_TIME_KEY]
+        start_time = env[START_TIME]
         runtime = Time.now - start_time
         logger.log("cache-#{tag}", request.fullpath, :runtime => runtime)
       end
+
+      # @private
+      class Inflater
+        def initialize(deflated_string)
+          @deflated_string = deflated_string
+        end
+
+        def each
+          yield ::Zlib::Inflate.inflate(@deflated_string)
+        end
+      end
     end
   end
 end

data/lib/racknga/middleware/deflater.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-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
@@ -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
 
 module Racknga
   module Middleware
@@ -63,7 +63,7 @@ module Racknga
 
       # For Rack.
       def call(environment)
-        if ie6?(environment)
+        if ie6?(environment) or not valid_accept_encoding?(environment)
           @application.call(environment)
         else
           @deflater.call(environment)
@@ -74,6 +74,16 @@ module Racknga
       def ie6?(environment)
         /MSIE 6.0;/ =~ (environment["HTTP_USER_AGENT"] || '')
       end
+
+      def valid_accept_encoding?(environment)
+        request = Rack::Request.new(environment)
+        begin
+          request.accept_encoding
+          true
+        rescue
+          false
+        end
+      end
     end
   end
 end

data/lib/racknga/middleware/exception_notifier.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 'racknga/exception_mail_notifier'
 
@@ -26,7 +26,6 @@ module Racknga
     #
     # Usage:
     #   require "racknga"
-    #   require "racknga/middleware/exception_notifier"
     #
     #   notifier_options = {
     #     :subject_label => "[YourApplication]",

data/lib/racknga/middleware/instance_name.rb

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2011  Ryo Onodera <onodera@clear-code.com>
+# Copyright (C) 2012  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
@@ -14,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
   module Middleware
@@ -23,12 +24,18 @@ module Racknga
     # server when your Rack applications are deployed behind
     # load balancers.
     #
-    # Usage:
+    # @example A simple usage
     #   require "racknga"
     #   use Racknga::Middleware::InstanceName
     #   run YourApplication
     class InstanceName
       attr_reader :header
+      # @param [application] application rack application.
+      # @param [Hash] options options to create header.
+      # @option options [String] :header_name ("Responsed-By") header name.
+      # @option options [String] :application_name (application.class.name)
+      #   application name.
+      # @option options [Integer] :version application version.
       def initialize(application, options={})
         @application = application
         @options = options
@@ -57,7 +64,14 @@ module Racknga
       end
 
       def revision
-        `git describe --abbrev=7 HEAD`.strip # XXX be SCM-agonostic
+        case using_scm_name
+        when :git
+          `git describe --abbrev=7 HEAD`.strip
+        when :subversion
+          `LANG=C svn info | grep Revision`.strip
+        else
+          nil
+        end
       end
 
       def server
@@ -68,6 +82,21 @@ module Racknga
         `id --user --name`.strip
       end
 
+      def branch
+        case using_scm_name
+        when :git
+          git_branch_name
+        when :subversion
+          subversion_branch_name
+        else
+          nil
+        end
+      end
+
+      def ruby
+        RUBY_DESCRIPTION
+      end
+
       private
       DEFAULT_HEADER_NAME = "X-Responsed-By"
       def header_name
@@ -83,9 +112,10 @@ module Racknga
       def construct_header
         format_header(format_application_name(application_name),
                       format_version(version),
-                      format_revision(revision),
+                      format_revision(branch, revision),
                       format_server(server),
-                      format_user(user))
+                      format_user(user),
+                      format_ruby(ruby))
       end
 
       def format_header(*arguments)
@@ -104,9 +134,15 @@ module Racknga
         end
       end
 
-      def format_revision(revision)
+      def format_revision(branch, revision)
         format_if_possible(revision) do
-          "(at #{revision})"
+          "(at #{revision}#{format_branch(branch)})"
+        end
+      end
+
+      def format_branch(branch)
+        format_if_possible(branch) do
+          " (#{branch})"
         end
       end
 
@@ -122,12 +158,59 @@ module Racknga
         end
       end
 
+      def format_ruby(ruby)
+        format_if_possible(ruby) do
+          "with #{ruby}"
+        end
+      end
+
       def format_if_possible(data)
         if data and (data.respond_to?(:to_s) and not data.to_s.empty?)
-          result = yield
+          yield
+        else
+          nil
+        end
+      end
+
+      SVN_URL_KEY = /\AURL:.*/
+      SVN_REPOSITORY_ROOT_KEY = /\ARepository Root:.*/
+      SVN_KEY = /\A.*:/
+      SVN_BRANCHES_NAME = /\A\/branches\//
+      def subversion_branch_name
+        url = ""
+        repository_root = ""
+
+        `LANG=C svn info`.each_line do |line|
+          case line
+          when SVN_URL_KEY
+            url = line.sub(SVN_KEY, "").strip
+          when SVN_REPOSITORY_ROOT_KEY
+            repository_root = line.sub(SVN_KEY, "").strip
+          end
         end
+        base_path = url.sub(/#{Regexp.escape(repository_root)}/, "")
+        base_path.sub(SVN_BRANCHES_NAME, "")
+      end
 
-        result
+      GIT_CURRENT_BRANCH_MARKER = /\A\* /
+      def git_branch_name
+        `git branch -a`.each_line do |line|
+          case line
+          when GIT_CURRENT_BRANCH_MARKER
+            return line.sub(GIT_CURRENT_BRANCH_MARKER, "").strip
+          end
+        end
+        nil
+      end
+
+      def using_scm_name
+        if File.exist?(".git")
+          :git
+        elsif File.exist?(".svn")
+          :subversion
+        else
+          nil
+        end
       end
     end
   end

data/lib/racknga/middleware/jsonp.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2012  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
@@ -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
 
 module Racknga
   module Middleware
@@ -91,7 +91,7 @@ module Racknga
         header_hash = Rack::Utils::HeaderHash.new(headers)
         return [status, headers, body] unless json_response?(header_hash)
         body = Writer.new(callback, body)
-        update_content_type(header_hash)
+        update_header_hash(header_hash, body)
         [status, header_hash, body]
       end
 
@@ -122,26 +122,46 @@ module Racknga
           media_type == "text/javascript"
       end
 
+      def update_header_hash(header_hash, body)
+        update_content_type(header_hash)
+        update_content_length(header_hash, body)
+      end
+
       def update_content_type(header_hash)
         content_type = header_hash["Content-Type"]
         media_type, parameters = content_type.split(/\s*;\s*/, 2)
+        _ = media_type # FIXME: suppress a warning. :<
         # We should use application/javascript not
         # text/javascript when all IE <= 8 are deprecated. :<
         updated_content_type = ["text/javascript", parameters].compact.join("; ")
         header_hash["Content-Type"] = updated_content_type
       end
 
+      def update_content_length(header_hash, body)
+        return unless header_hash["Content-Length"]
+
+        content_length = header_hash["Content-Length"].to_i
+        updated_content_length = content_length + body.additional_content_length
+        header_hash["Content-Length"] = updated_content_length.to_s
+      end
+
       # @private
       class Writer
         def initialize(callback, body)
           @callback = callback
           @body = body
+          @header = "#{@callback}("
+          @footer = ");"
         end
 
         def each(&block)
-          block.call("#{@callback}(")
+          block.call(@header)
           @body.each(&block)
-          block.call(");")
+          block.call(@footer)
+        end
+
+        def additional_content_length
+          @header.bytesize + @footer.bytesize
         end
       end
     end

data/lib/racknga/middleware/log.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 'racknga/log_database'
 
@@ -70,9 +70,12 @@ module Racknga
       private
       def log(start_time, end_time, request, status, headers, body)
         request_time = end_time - start_time
+        runtime = headers["X-Runtime"]
+        runtime_in_float = nil
+        runtime_in_float = runtime.to_f if runtime
         length = headers["Content-Length"] || "-"
         length = "-" if length == "0"
-        format = "%s - %s [%s] \"%s %s %s\" %s %s \"%s\" \"%s\" %0.8f"
+        format = "%s - %s [%s] \"%s %s %s\" %s %s \"%s\" \"%s\" %s %0.8f"
         message = format % [request.ip || "-",
                             request.env["REMOTE_USER"] || "-",
                             end_time.dup.utc.strftime("%d/%b/%Y:%H:%M:%S %z"),
@@ -83,12 +86,14 @@ module Racknga
                             length,
                             request.env["HTTP_REFERER"] || "-",
                             request.user_agent || "-",
+                            runtime || "-",
                             request_time]
         @logger.log("access",
                     request.fullpath,
                     :message => message,
                     :user_agent => request.user_agent,
-                    :runtime => request_time)
+                    :runtime => runtime_in_float,
+                    :request_time => request_time)
       end
 
       # @private