rack-supported-media-types 0.9.4

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/
+doc/
+*.gem

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

data/Manifest

@@ -0,0 +1,11 @@
+.gitignore
+LICENSE
+Manifest
+README
+Rakefile
+examples/recommended.ru
+examples/simple.ru
+lib/rack/supported_media_types.rb
+rack-supported-media-types.gemspec
+test/test_helper.rb
+test/test_supported_media_types.rb

data/README

@@ -0,0 +1,67 @@
+===== Summary
+
+Rack middleware to specify an app's supported media types.
+Returns '406 Not Acceptable' status when unsuported type is requested.
+
+===== Install
+
+  gem install rack-supported-media-types
+
+===== Example
+
+  require 'rack'
+  require 'rack/supported_media_types'
+
+  use Rack::SupportedMediaTypes, %w( application/xml application/json )
+  run App.new
+
+  # will give you:
+
+  GET /foo
+  Accept: text/html,text/plain
+  #=> 406 Not Acceptable
+
+  GET /foo
+  Accept: application/xml,text/html
+  #=> 200 OK
+
+  GET /foo
+  Accept: application/json,text/html
+  #=> 200 OK
+
+see examples/simple.ru for example code.
+
+===== Tip
+
+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 rack-abstract-format
+
+  require 'rack'
+  require 'rack/abstract_format'
+  require 'rack/supported_media_types'
+
+  use Rack::AbstractFormat
+  use Rack::SupportedMediaTypes, %w( application/xml application/json )
+  run App.new
+
+  # will result in:
+
+  GET /foo.html
+  #=> 406 Not Acceptable
+
+  GET /foo.xml
+  #=> 200 OK
+
+  GET /foo.json
+  #=> 200 OK
+
+see examples/recommended.ru for example code.
+
+===== Links
+
+code:: http://github.com/mynyml/rack-supported-media-types
+docs:: http://docs.github.com/mynyml/rack-supported-media-types
+

data/Rakefile

@@ -0,0 +1,26 @@
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end
+
+# --------------------------------------------------
+# Tests
+# --------------------------------------------------
+task(:default => :test)
+
+desc "Run tests"
+task(:test) do
+  exit system("ruby #{gem_opt} test/test_supported_media_types.rb")
+end
+
+# --------------------------------------------------
+# Docs
+# --------------------------------------------------
+desc "Generate YARD Documentation"
+task(:yardoc) do
+  require 'yard'
+  files   = %w( lib/**/*.rb )
+  options = %w( -o doc/yard --readme README --files LICENSE )
+  YARD::CLI::Yardoc.run *(options + files)
+end
+
+

data/examples/recommended.ru

@@ -0,0 +1,40 @@
+# install required dependency:
+#   $ gem install rack-abstract-format
+#
+# run with:
+#   $ rackup examples/recommended.ru -p 3000
+#
+# and point your web browser to:
+#   localhost:3000/foo.html
+#
+require 'pathname'
+require 'rack'
+require 'rack/abstract_format'
+
+$:.unshift(Pathname(__FILE__).dirname.parent + 'lib')
+require 'rack/supported_media_types'
+
+class App
+  def call(env)
+    body = <<-BODY
+<pre>
+try using extensions:
+
+  - /foo.html
+  - /foo.xml
+  - /foo.json
+  - /foo.txt
+  - ...
+
+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]]
+  end
+end
+
+use Rack::AbstractFormat
+use Rack::SupportedMediaTypes, %w( text/html application/xml )
+run App.new
+

data/examples/simple.ru

@@ -0,0 +1,36 @@
+# run me with:
+#   $ rackup examples/simple.ru -p 3000
+#
+# then point your browser to:
+#   localhost:3000/
+#   localhost:3000/foo
+#
+# and look for the server's output in the console
+# (pay attention to status codes)
+#
+require 'pathname'
+require 'rack'
+
+$:.unshift(Pathname(__FILE__).dirname.parent + 'lib')
+require 'rack/supported_media_types'
+
+class App
+  def call(env)
+    [200, {'Content-Type' => 'text/html'}, ['now try <strong>/foo</strong> (will return 406)']]
+  end
+end
+
+# 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
+  use Rack::SupportedMediaTypes, %w( text/html application/xml )
+  run App.new
+end
+
+map '/foo' do
+  # ... this will abort the request and return 406 Not Acceptable
+  use Rack::SupportedMediaTypes, %w( application/json )
+  run App.new
+end

data/lib/rack/supported_media_types.rb

@@ -0,0 +1,36 @@
+require 'rack/accept_media_types'
+
+module Rack
+  class SupportedMediaTypes
+
+    def initialize(app, mime_types)
+      @app, @mime_types = app, mime_types
+    end
+
+    #--
+    # return any headers with 406?
+    def call(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
+      #--
+      # 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)
+        Rack::AcceptMediaTypes.new(env['HTTP_ACCEPT']).prefered.to_s.gsub(/\*/, '.*')
+      end
+  end
+end

data/rack-supported-media-types.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name                = 'rack-supported-media-types'
+  s.version             = "0.9.4"
+  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              = "mynyml"
+  s.email               = "mynyml@gmail.com"
+  s.homepage            = "http://github.com/mynyml/rack-supported-media-types"
+  s.rubyforge_project   = "rack-supported-media-types"
+  s.has_rdoc            =  false
+  s.require_path        = "lib"
+  s.files               =  File.read("Manifest").strip.split("\n")
+
+  s.add_dependency 'rack-accept-media-types', '>= 0.6'
+  s.add_development_dependency 'rack'
+  s.add_development_dependency 'nanotest'
+end
+

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'pathname'
+
+require 'rack'
+require 'nanotest'
+begin
+  require 'ruby-debug'
+  require 'redgreen'
+  require 'nanotest/stats'
+  require 'nanotest/focus'
+rescue LoadError, RuntimeError
+end
+
+$:.unshift Pathname(__FILE__).dirname.parent + 'lib'
+require 'rack/supported_media_types'
+
+include Nanotest
+

data/test/test_supported_media_types.rb

@@ -0,0 +1,53 @@
+require 'test/test_helper'
+
+App = lambda {|env| [200, {'Content-Type' => 'text/html'}, ['content']] }
+SMT = Rack::SupportedMediaTypes
+
+
+# test: returns 406 Not Acceptable
+app      = SMT.new(App, %w( application/xml application/json ))
+response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => 'text/html')
+
+assert { response.status == 406 }
+assert { response.body.empty? }
+
+
+# test: lets request through when media type is supported
+app = SMT.new(App, %w( text/html application/xml ))
+response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => 'text/html')
+
+assert { response.status == 200 }
+
+
+# test: requested type is assumed to be highest ranking type in Accept header's list
+app = SMT.new(App, %w( text/html ))
+client = Rack::MockRequest.new(app)
+
+response = client.get('/', 'HTTP_ACCEPT' => 'text/html,application/xml')
+assert { response.status == 200 }
+
+response = client.get('/', 'HTTP_ACCEPT' => 'text/html;q=0.8,application/xml;q=0.9')
+assert { response.status == 406 }
+
+
+# test: matches wildcard media-range subtypes
+app = SMT.new(App, %w( text/html application/json ))
+
+begin
+  response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => 'text/*')
+  assert { response.status == 200 }
+rescue Exception => e
+  assert("Expected not to raise error, got:\n#{e.message}") { false }
+end
+
+
+# test: empty Accept header
+app = SMT.new(App, %w( application/xml application/json ))
+
+begin
+  response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => '')
+  assert { response.status == 406 }
+rescue Exception => e
+  assert("Expected not to raise error, got:\n#{e.message}") { false }
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: rack-supported-media-types
+version: !ruby/object:Gem::Version 
+  version: 0.9.4
+platform: ruby
+authors: 
+- mynyml
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack-accept-media-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nanotest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    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: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- Manifest
+- README
+- Rakefile
+- examples/recommended.ru
+- examples/simple.ru
+- lib/rack/supported_media_types.rb
+- rack-supported-media-types.gemspec
+- test/test_helper.rb
+- test/test_supported_media_types.rb
+has_rdoc: false
+homepage: http://github.com/mynyml/rack-supported-media-types
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rack-supported-media-types
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware to specify an app's supported media types.
+test_files: []
+