racknga 0.9.3 → 0.9.5

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

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2010  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,10 +12,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
@@ -137,7 +136,7 @@ module Racknga
       def skip_caching_response?(status, headers, body)
         return true if status != 200
 
-        headers = Rack::Utils::HeaderHash.new(headers)
+        headers = Rack::Headers[headers]
         content_type = headers["Content-Type"]
         if /\A(\w+)\/([\w.+\-]+)\b/ =~ content_type
           media_type = $1
@@ -166,15 +165,17 @@ module Racknga
         end
 
         now = Time.now
-        headers = Rack::Utils::HeaderHash.new(headers)
+        headers = Rack::Headers[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 +184,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 +200,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)
@@ -227,6 +228,17 @@ module Racknga
         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

@@ -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

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'
 

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,17 +82,15 @@ module Racknga
         `id --user --name`.strip
       end
 
-      CURRENT_BRANCH_MARKER = /\A\* /
       def branch
-        current_branch = nil
-        `git branch -a`.each_line do |line|
-          case line
-          when CURRENT_BRANCH_MARKER
-            current_branch = line.sub(CURRENT_BRANCH_MARKER, "").strip
-            break
-          end
+        case using_scm_name
+        when :git
+          git_branch_name
+        when :subversion
+          subversion_branch_name
+        else
+          nil
         end
-        current_branch
       end
 
       def ruby
@@ -159,6 +171,47 @@ module Racknga
           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
+
+      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
 end

data/lib/racknga/middleware/jsonp.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2010  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,7 +12,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
@@ -84,14 +82,14 @@ module Racknga
       # For Rack.
       def call(environment)
         request = Rack::Request.new(environment)
-        callback = request["callback"]
+        callback = request.params["callback"]
         update_cache_key(request) if callback
         status, headers, body = @application.call(environment)
         return [status, headers, body] unless callback
-        header_hash = Rack::Utils::HeaderHash.new(headers)
+        header_hash = Rack::Headers[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,6 +120,11 @@ 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)
@@ -132,17 +135,31 @@ module Racknga
         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'
 

data/lib/racknga/middleware/nginx_raw_uri.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
 
 module Racknga
   module Middleware

data/lib/racknga/middleware/range.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2010  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,7 +12,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'
 
@@ -38,7 +36,7 @@ module Racknga
         status, headers, body = @application.call(environment)
         return [status, headers, body] if status != 200
 
-        headers = Rack::Utils::HeaderHash.new(headers)
+        headers = Rack::Headers[headers]
         headers["Accept-Ranges"] = "bytes"
         request = Rack::Request.new(environment)
         range = request.env["HTTP_RANGE"]
@@ -60,7 +58,7 @@ module Racknga
 
         if first_byte.empty? and last_byte.empty?
           headers["Content-Length"] = "0"
-          return [Rack::Utils.status_code(:requested_range_not_satisfiable),
+          return [Rack::Utils.status_code(:range_not_satisfiable),
                   headers,
                   []]
         end

data/lib/racknga/reverse_line_reader.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
 
 module Racknga
   class ReverseLineReader

data/lib/racknga/utils.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
 
 module Racknga
   module Utils

data/lib/racknga/version.rb

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2010-2011  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2023  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,8 +12,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
 
 module Racknga
-  VERSION = '0.9.3'
+  VERSION = "0.9.5"
 end

data/lib/racknga.rb

@@ -14,13 +14,14 @@
 #
 # 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 'rack'
 
 require 'racknga/version'
 require 'racknga/utils'
 require "racknga/access_log_parser"
+require 'racknga/api-keys'
 require 'racknga/middleware/deflater'
 require 'racknga/middleware/exception_notifier'
 require 'racknga/middleware/jsonp'