mynyml-rack-supported-media-types 0.9.2 → 0.9.3

data/README

@@ -5,6 +5,10 @@ Returns '406 Not Acceptable' status when unsuported type is requested.
 
 The requested type is assumed to be the first content-type in the Accept header's list.
 
+===== Install
+
+  gem install mynyml-rack-supported-media-types --source=http://gems.github.com/
+
 ===== Example
 
   require 'rack'
@@ -35,6 +39,8 @@ To read the requested type from the url's extension instead of the Accept
 header (which is a more realistic use case), use Rack::AbstractFormat before
 Rack::SupportedMediaTypes.
 
+  # gem install mynyml-rack-abstract-format --source=http://gems.github.com/
+
   require 'rack'
   require 'rack/abstract_format'
   require 'rack/supported_media_types'

data/Rakefile

@@ -22,7 +22,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name            = 'rack-supported-media-types'
-  s.version         = '0.9.2'
+  s.version         = '0.9.3'
   s.summary         = "Rack middleware to specify an app's supported media types."
   s.description     = "Rack middleware to specify an app's supported media types. Returns '406 Not Acceptable' status when unsuported type is requested."
   s.author          = "Martin Aumont"
@@ -31,6 +31,8 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc        = true
   s.require_path    = "lib"
   s.files           = all_except([/doc/, /pkg/])
+
+  s.add_dependency 'mynyml-rack-accept-media-types', '>= 0.6'
 end
 
 desc "Generate rdoc documentation."

data/examples/recommended.ru

@@ -1,10 +1,13 @@
 # run me with:
 #   $rackup examples/recommended.ru -p 3000
 #
+# and point your web browser to:
+#   localhost:3000/foo.html
+#
 require 'pathname'
 require 'rubygems'
 require 'rack'
-require 'rack/abstract_format'
+require 'rack/abstract_format' #gem install mynyml-rack-abstract-format --source=http://gems.github.com/
 
 root = Pathname(__FILE__).dirname.parent.expand_path
 require root + 'lib/rack/supported_media_types'
@@ -21,8 +24,8 @@ try using extensions:
   - /foo.txt
   - ...
 
-app will only accept .html and .xml requests. others will return 406
-(check server's output in console to see it)
+app will only accept html and xml requests. others will return 406 (check
+server's output in console to see it).
 </pre>
     BODY
     [200, {'Content-Type' => 'text/html'}, [body]]

data/examples/simple.ru

@@ -21,8 +21,8 @@ class App
   end
 end
 
-# given that the request comes from a webbrowser, and that it's Accept header's
-# first value is text/html...
+# given that the request comes from a web browser, and that it's Accept
+# header's highest value is text/html...
 
 map '/' do
   # ... this will allow it through to the app

data/lib/rack/supported_media_types.rb

@@ -1,36 +1,37 @@
+gem 'rack-accept-media-types', '>= 0.6'
+require 'rack/accept_media_types'
+
 module Rack
   class SupportedMediaTypes
 
-    #--
-    # NOTE
-    # Ths reason for adding nil to the list of accepted mime types:
-    #
-    #   "If no Accept header field is present, then it is assumed that the client accepts all media types"
-    #    http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
-    #
-    # Counter intuitive?
-    #
     def initialize(app, mime_types)
-      @app, @mime_types = app, mime_types.push(nil)
+      @app, @mime_types = app, mime_types
     end
 
     #--
     # return any headers with 406?
     def call(env)
-      @mime_types.include?(accept(env)) ?
+      req_type = accept(env)
+      !req_type.empty? && @mime_types.any? {|type| type.match(/#{req_type}/) } ?
         @app.call(env) :
         Rack::Response.new([], 406).finish
     end
 
     private
       #--
-      # First content-type in Accept header's list, without params
+      # Client's prefered media type.
+      #
+      # NOTE
+      # glob patterns are replaced with regexp.
+      #
+      #   */*     ->  .*/.*
+      #   text/*  ->  text/.*
+      #
+      # NOTE
+      # Rack::AcceptMediaTypes.prefered is */* if Accept header is nil
+      #
       def accept(env)
-        header = env['HTTP_ACCEPT']
-
-        (header.nil? || header.empty?) ?
-          header :
-          header.split(',').first.split(';').first
+        Rack::AcceptMediaTypes.new(env['HTTP_ACCEPT']).prefered.to_s.gsub(/\*/, '.*')
       end
   end
 end

data/rack-supported-media-types.gemspec

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-supported-media-types
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-05 00:00:00 -04:00
+date: 2009-06-08 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mynyml-rack-accept-media-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
 description: Rack middleware to specify an app's supported media types. Returns '406 Not Acceptable' status when unsuported type is requested.
 email: mynyml@gmail.com
 executables: []

data/test/test_supported_media_types.rb

@@ -20,29 +20,31 @@ class SupportedMediaTypesTest < Test::Unit::TestCase
     assert_equal 200, response.status
   end
 
-  test "requested type is assumed to be first type in Accept header's list" do
+  test "requested type is assumed to be highest ranking type in Accept header's list" do
     app = SMT.new(App, %w( text/html ))
     client = Rack::MockRequest.new(app)
 
     response = client.get('/', 'HTTP_ACCEPT' => 'text/html,application/xml')
     assert_equal 200, response.status
 
-    response = client.get('/', 'HTTP_ACCEPT' => 'application/xml,text/html')
+    response = client.get('/', 'HTTP_ACCEPT' => 'text/html;q=0.8,application/xml;q=0.9')
     assert_equal 406, response.status
   end
 
-  test "ignores content-type params" do
+  test "matches wildcard media-range" do
     app = SMT.new(App, %w( application/xml application/json ))
 
-    response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => 'application/xml;q=0.9')
-    assert_equal 200, response.status
+    assert_nothing_raised do
+      response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => '*/*')
+      assert_equal 200, response.status
+    end
   end
 
-  test "nil Accept header means all types accepted" do
-    app = SMT.new(App, %w( application/xml application/json ))
+  test "matches wildcard media-range subtypes" do
+    app = SMT.new(App, %w( text/html application/json ))
 
     assert_nothing_raised do
-      response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => nil)
+      response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => 'text/*')
       assert_equal 200, response.status
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mynyml-rack-supported-media-types
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-04 21:00:00 -07:00
+date: 2009-06-07 21:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mynyml-rack-accept-media-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
 description: Rack middleware to specify an app's supported media types. Returns '406 Not Acceptable' status when unsuported type is requested.
 email: mynyml@gmail.com
 executables: []