racknga 0.9.3 → 0.9.4

data/test/racknga-test-utils.rb

@@ -12,12 +12,13 @@
 #
 # 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 "test/unit/capybara"
 require 'json'
 
 require 'racknga'
+require 'racknga/middleware/auth/api-key'
 require 'racknga/middleware/cache'
 require 'racknga/middleware/instance_name'
 

data/test/run-test.rb

@@ -14,12 +14,10 @@
 #
 # 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
 
 $VERBOSE = true
 
-$KCODE = "u" if RUBY_VERSION < "1.9"
-
 require 'pathname'
 
 base_dir = Pathname(__FILE__).dirname.parent.expand_path

data/test/test-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 'stringio'
 

data/test/test-api-keys.rb

@@ -0,0 +1,80 @@
+# -*- 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
+
+class APIKeysTest < Test::Unit::TestCase
+  include RackngaTestUtils
+
+  def setup
+    @api_keys = Racknga::APIKeys.new(query_parameter, api_keys)
+  end
+
+  def test_matched_key
+    assert_matched(query_parameter, api_key)
+  end
+
+  def test_not_matched_key
+    assert_not_matched(query_parameter, "notapikey")
+  end
+
+  def test_empty_key
+    assert_not_matched(query_parameter, "")
+  end
+
+  def test_empty_query_parameter
+    assert_not_matched("", api_key)
+  end
+
+  def test_mismatched_query_parameter
+    assert_not_matched("not-api-key", api_key)
+  end
+
+  private
+  def assert_matched(parameter, key)
+    environment = generate_environment(parameter, key)
+    assert_true(@api_keys.include?(environment))
+  end
+
+  def assert_not_matched(parameter, key)
+    environment = generate_environment(parameter, key)
+    assert_false(@api_keys.include?(environment))
+  end
+
+  def generate_environment(parameter, key)
+    url = "http://example.org"
+
+    unless parameter.empty?
+      api_url = "#{url}?#{parameter}=#{key}"
+    else
+      api_url = url
+    end
+
+    Rack::MockRequest.env_for(api_url)
+  end
+
+  def query_parameter
+    "api-key"
+  end
+
+  def api_keys
+    ["key", "key2"]
+  end
+
+  def api_key
+    api_keys.first
+  end
+end

data/test/test-middleware-auth-api-key.rb

@@ -0,0 +1,144 @@
+# Copyright (C) 2012  Haruka Yoshihara <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
+
+class MiddlewareAuthAPIKeyTest < Test::Unit::TestCase
+  include RackngaTestUtils
+
+  def app
+    application = Proc.new do |environment|
+      @environment = environment
+      [
+        200,
+        {"Content-Type" => "application/json"},
+        [@body]
+      ]
+    end
+    authorized_api_keys =
+      Racknga::APIKeys.new(@api_query_parameter, @api_keys)
+    api_key_options = {
+      :api_url_prefixes => [@api_url_prefix],
+      :authorized_api_keys => authorized_api_keys,
+      :error_response => @error_response,
+      :disable_authorization => disable_authorization?
+    }
+    api_key = api_key_authorizer(application, api_key_options)
+    Proc.new do |environment|
+      api_key.call(environment)
+    end
+  end
+
+  def setup
+    @api_query_parameter = "api-key"
+    @api_url_prefix = "/api"
+    @api_keys = ["key1", "key2"]
+    @body = "{}"
+    @error_response = {"error" => "this api key is not authorized"}
+    Capybara.app = app
+  end
+
+  def test_authorized_key
+    url = generate_url(url_prefix, query_parameter, valid_key)
+    visit(url)
+    assert_success_response
+  end
+
+  def test_unauthorized_key
+    url = generate_url(url_prefix, query_parameter, "invalidkey")
+    visit(url)
+    assert_failure_response
+  end
+
+  def test_unmatched_query_parameter
+    url = generate_url(url_prefix, "not-api-key", valid_key)
+    visit(url)
+    assert_failure_response
+  end
+
+  def test_unauthorized_key_and_unmatched_query_parameter
+    url = generate_url(url_prefix, "not-api-key", "invalidkey")
+    visit(url)
+    assert_failure_response
+  end
+
+  def test_not_api_url
+    visit("/not/api/url")
+    assert_success_response
+  end
+
+  private
+  def disable_authorization?
+    false
+  end
+
+  def api_key_authorizer(application, api_key_options)
+    Racknga::Middleware::Auth::APIKey.new(application, api_key_options)
+  end
+
+  def generate_url(path, query_parameter, api_key)
+    url = path
+    if query_parameter
+      url << "?#{query_parameter}=#{api_key}"
+    end
+    url
+  end
+
+  def url_prefix
+    @api_url_prefix
+  end
+
+  def query_parameter
+    @api_query_parameter
+  end
+
+  def valid_key
+    @api_keys.first
+  end
+
+  def assert_success_response
+    assert_equal(200, page.status_code)
+    assert_equal(@body, page.source)
+  end
+
+  def assert_failure_response
+    assert_equal(401, page.status_code)
+    assert_equal(@error_response.to_json, page.source)
+  end
+
+  class DisableAuthorizationTest < self
+    def test_unauthorized_key
+      url = generate_url(url_prefix, query_parameter, "invalidkey")
+      visit(url)
+      assert_success_response
+    end
+
+    def test_unmatched_query_parameter
+      url = generate_url(url_prefix, "not-api-key", valid_key)
+      visit(url)
+      assert_success_response
+    end
+
+    def test_unauthorized_key_and_unmatched_query_parameter
+      url = generate_url(url_prefix, "not-api-key", "invalidkey")
+      visit(url)
+      assert_success_response
+    end
+
+    private
+    def disable_authorization?
+      true
+    end
+  end
+end

data/test/test-middleware-cache.rb

@@ -12,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
 
 class MiddlewareCacheTest < Test::Unit::TestCase
   include RackngaTestUtils

data/test/test-middleware-instance-name.rb

@@ -12,17 +12,31 @@
 #
 # 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
 
 class InstanceNameTest < Test::Unit::TestCase
   include RackngaTestUtils
 
+  DEFAULT_HEADER_NAME = "X-Responsed-By"
+
   def test_no_option
     footer_variables = extract_from_default_instance_name
 
     instance_name_options({}) do
       request
-      assert_header("Proc #{default_footer(*footer_variables)}")
+      assert_equal("Proc #{default_footer(*footer_variables)}",
+                   response_header(DEFAULT_HEADER_NAME))
+    end
+  end
+
+  def test_header_name
+    header_name = "X-header-name"
+    footer_variables = extract_from_default_instance_name
+
+    instance_name_options(:header_name => header_name) do
+      request
+      assert_equal("Proc #{default_footer(*footer_variables)}",
+                   response_header(header_name))
     end
   end
 
@@ -32,8 +46,9 @@ class InstanceNameTest < Test::Unit::TestCase
 
     instance_name_options(:application_name => application_name) do
       request
-      assert_header("#{application_name} " +
-                    "#{default_footer(*footer_variables)}")
+      assert_equal("#{application_name} " +
+                   "#{default_footer(*footer_variables)}",
+                   response_header(DEFAULT_HEADER_NAME))
     end
   end
 
@@ -45,8 +60,9 @@ class InstanceNameTest < Test::Unit::TestCase
     instance_name_options(:application_name => application_name,
                           :version => version) do
       request
-      assert_header("#{application_name} v#{version} " +
-                    "#{default_footer(*footer_variables)}")
+      assert_equal("#{application_name} v#{version} " +
+                   "#{default_footer(*footer_variables)}",
+                   response_header(DEFAULT_HEADER_NAME))
     end
   end
 
@@ -83,7 +99,10 @@ class InstanceNameTest < Test::Unit::TestCase
   end
 
   def default_footer(server, user, revision, branch, ruby)
-    "(at #{revision} (#{branch})) on #{server} by #{user} with #{ruby}"
+    footer = ""
+    footer << "(at #{revision} (#{branch})) " if format_is_possible?(revision)
+    footer << "on #{server} by #{user} with #{ruby}"
+    footer
   end
 
   def create_minimal_application
@@ -103,8 +122,11 @@ class InstanceNameTest < Test::Unit::TestCase
     yield
   end
 
-  def assert_header(expected_header)
-    actual_header = page.response_headers["X-Responsed-By"]
-    assert_equal(expected_header, actual_header)
+  def response_header(name)
+    page.response_headers[name]
+  end
+
+  def format_is_possible?(data)
+    data and (data.respond_to?(:to_s) and not data.to_s.empty?)
   end
 end

data/test/test-middleware-jsonp.rb

@@ -1,4 +1,4 @@
-# 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
@@ -12,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
 
 class MiddlewareJSONPTest < Test::Unit::TestCase
   include RackngaTestUtils
@@ -76,6 +76,18 @@ class MiddlewareJSONPTest < Test::Unit::TestCase
                  @environment[@cache_key_key])
   end
 
+  def test_jsonp_content_length
+    @update_environment = Proc.new do |environment|
+      environment["Content-Length"] = @body.bytesize
+      environment
+    end
+    visit("/?callback=jsonp_callback")
+    expected_response = "jsonp_callback(#{@body});"
+    assert_jsonp_response(expected_response)
+    assert_equal(expected_response.bytesize.to_s,
+                 page.response_headers["Content-Length"])
+  end
+
   private
   def assert_jsonp_response(body)
     assert_equal({

data/test/test-middleware-nginx-raw-uri.rb

@@ -12,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
 
 class NginxRawURITest < Test::Unit::TestCase
   include RackngaTestUtils

data/test/test-middleware-range.rb

@@ -12,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 MiddlewareRangeTests
   include RackngaTestUtils