mynyml-rack-accept-media-types 0.5

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/Rakefile

@@ -0,0 +1,66 @@
+# --------------------------------------------------
+# based on thin's Rakefile (http://github.com/macournoyer/thin)
+# --------------------------------------------------
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'pathname'
+require 'yaml'
+
+RUBY_1_9  = RUBY_VERSION =~ /^1\.9/
+WIN       = (RUBY_PLATFORM =~ /mswin|cygwin/)
+SUDO      = (WIN ? "" : "sudo")
+
+def gem
+  RUBY_1_9 ? 'gem19' : 'gem'
+end
+
+def all_except(res)
+  Dir['**/*'].reject do |path|
+    Array(res).any? {|re| path.match(re) }
+  end
+end
+
+spec = Gem::Specification.new do |s|
+  s.name            = 'rack-accept-media-types'
+  s.version         = '0.5'
+  s.summary         = "Rack convenience middleware for simplified handling of Accept header."
+  s.description     = "Rack convenience middleware for simplified handling of Accept header."
+  s.author          = "Martin Aumont"
+  s.email           = 'mynyml@gmail.com'
+  s.homepage        = ''
+  s.has_rdoc        = true
+  s.require_path    = "lib"
+  s.files           = all_except([/doc/, /pkg/])
+end
+
+desc "Generate rdoc documentation."
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Rack::AcceptMediaTypes"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc "Remove package products"
+task :clean => :clobber_package
+
+desc "Update the gemspec for GitHub's gem server"
+task :gemspec do
+  Pathname("#{spec.name}.gemspec").open('w') {|f| f << YAML.dump(spec) }
+end
+
+desc "Install gem"
+task :install => [:clobber, :package] do
+  sh "#{SUDO} #{gem} install pkg/#{spec.full_name}.gem"
+end
+
+desc "Uninstall gem"
+task :uninstall => :clean do
+  sh "#{SUDO} #{gem} uninstall -v #{spec.version} -x #{spec.name}"
+end

data/lib/rack/accept_media_types.rb

@@ -0,0 +1,94 @@
+module Rack
+
+  # AcceptMediaTypes is intended for wrapping env['HTTP_ACCEPT'].
+  #
+  # It allows ordering of its values (accepted media types) according to their
+  # "quality" (preference level).
+  #
+  # This wrapper is typically used to determine the request's prefered media
+  # type (see example below).
+  #
+  # ===== Examples
+  #
+  #   env['HTTP_ACCEPT']  #=> 'text/html,application/xml;q=0.8,text/plain;0.9'
+  #
+  #   types = Rack::AcceptMediaTypes.new(env['HTTP_ACCEPT'])
+  #   types               #=> ['text/html', 'text/plain', 'application/xml']
+  #   types.prefered      #=>  'text/html'
+  #
+  # ===== Notes
+  #
+  # For simplicity, media type parameters are striped, as they are seldom used
+  # in practice. Users who need them are excepted to parse the Accept header
+  # manually.
+  #
+  # ===== References
+  #
+  # HTTP 1.1 Specs:
+  # * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
+  # * http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.9
+  #
+  class AcceptMediaTypes < Array
+
+    def initialize(header)
+      replace(order(header.split(',')))
+    end
+
+    # The client's prefered media type.
+    def prefered
+      first
+    end
+
+    private
+
+    # Order media types by quality values, remove invalid types, and return media ranges.
+    #
+    def order(types) #:nodoc:
+      types.map {|type| AcceptMediaType.new(type) }.reverse.sort.reverse.select {|type| type.valid? }.map {|type| type.range }
+    end
+
+    # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
+    #
+    class AcceptMediaType #:nodoc:
+      include Comparable
+
+      # media-range = ( "*/*"
+      #               | ( type "/" "*" )
+      #               | ( type "/" subtype )
+      #               ) *( ";" parameter )
+      attr_accessor :range
+
+      # qvalue = ( "0" [ "." 0*3DIGIT ] )
+      #        | ( "1" [ "." 0*3("0") ] )
+      attr_accessor :quality
+
+      def initialize(type)
+        self.range, *params = type.split(';')
+        self.quality = extract_quality(params)
+      end
+
+      def <=>(type)
+        self.quality <=> type.quality
+      end
+
+      # "A weight is normalized to a real number in the range 0 through 1,
+      # where 0 is the minimum and 1 the maximum value. If a parameter has a
+      # quality value of 0, then content with this parameter is `not
+      # acceptable' for the client."
+      #
+      def valid?
+        self.quality.between?(0.1, 1)
+      end
+
+      private
+        # Extract value from 'q=FLOAT' parameter if present, otherwise assume 1
+        #
+        # "The default value is q=1."
+        #
+        def extract_quality(params)
+          q = params.detect {|p| p.match(/q=\d\.?\d{0,3}/) }
+          q ? q.split('=').last.to_f : 1.0
+        end
+    end
+  end
+end

data/rack-accept-media-types.gemspec

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: rack-accept-media-types
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Rack convenience middleware for simplified handling of Accept header.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- test
+- test/test_accept_media_types.rb
+- test/test_helper.rb
+- rack-accept-media-types.gemspec
+- lib
+- lib/rack
+- lib/rack/accept_media_types.rb
+- LICENSE
+- README
+has_rdoc: true
+homepage: ""
+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: 
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Rack convenience middleware for simplified handling of Accept header.
+test_files: []
+

data/test/test_accept_media_types.rb

@@ -0,0 +1,76 @@
+require 'test/test_helper'
+
+Accept = Rack::AcceptMediaTypes
+
+class AcceptMediaTypesTest < Test::Unit::TestCase
+
+  test "media type list" do
+    header = 'text/html,text/plain'
+    assert_equal %w( text/html text/plain ).to_set, Accept.new(header).to_set
+  end
+
+  test "ordered by quality value (highest first)" do
+    header = 'text/html;q=0.5,text/plain;q=0.9'
+    assert_equal %w( text/plain text/html ), Accept.new(header)
+  end
+
+  test "default quality value is 1" do
+    header = 'text/plain;q=0.1,text/html'
+    assert_equal %w( text/html text/plain ), Accept.new(header)
+  end
+
+  test "equal quality types keep original order" do
+    header = 'text/html,text/plain;q=0.9,application/xml'
+    assert_equal %w( text/html application/xml text/plain ), Accept.new(header)
+  end
+
+  test "prefered type" do
+    header = 'text/html;q=0.2,text/plain;q=0.5'
+    assert_equal 'text/plain', Accept.new(header).prefered
+  end
+
+  test "types with out of range quality values are ignored" do
+    header = 'text/html,text/plain;q=1.1'
+    assert_equal %w( text/html ), Accept.new(header)
+
+    header = 'text/html,text/plain;q=0'
+    assert_equal %w( text/html ), Accept.new(header)
+  end
+
+  test "custom media types are NOT ignored" do
+    # verifying that the media types exist in Rack::Mime::MIME_TYPES is
+    # explicitly outside the scope of this library.
+    header = 'application/x-custom'
+    assert_equal %w( application/x-custom ), Accept.new(header)
+  end
+
+  test "media-range parameters are discarted" do
+    header = 'text/html;version=5;q=0.5,text/plain'
+    assert_equal %w( text/plain text/html ), Accept.new(header)
+  end
+
+  test "accept-extension parameters are discarted" do
+    header = 'text/html;q=0.5;token=value,text/plain'
+    assert_equal %w( text/plain text/html ), Accept.new(header)
+  end
+end
+
+__END__
+http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
+14.1 Accept
+
+  Accept         = "Accept" ":"
+                  #( media-range [ accept-params ] )
+
+  media-range    = ( "*/*"
+                  | ( type "/" "*" )
+                  | ( type "/" subtype )
+                  ) *( ";" parameter )
+  accept-params  = ";" "q" "=" qvalue *( accept-extension )
+  accept-extension = ";" token [ "=" ( token | quoted-string ) ]
+
+http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.9
+3.9 Quality Values
+
+  qvalue = ( "0" [ "." 0*3DIGIT ] )
+         | ( "1" [ "." 0*3("0") ] )

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+require 'pathname'
+require 'test/unit'
+require 'rubygems'
+require 'rack'
+begin
+  require 'ruby-debug'
+  require 'phocus/test_unit'
+  require 'pending'
+rescue LoadError, RuntimeError
+end
+
+root = Pathname(__FILE__).dirname.parent.expand_path
+$:.unshift(root.join('lib'))
+
+require 'rack/accept_media_types'
+
+class Test::Unit::TestCase
+  def self.test(name, &block)
+    name = :"test_#{name.gsub(/\s/,'_')}"
+    define_method(name, &block)
+  end
+end
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: mynyml-rack-accept-media-types
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-04 21:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rack convenience middleware for simplified handling of Accept header.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- test
+- test/test_accept_media_types.rb
+- test/test_helper.rb
+- rack-accept-media-types.gemspec
+- lib
+- lib/rack
+- lib/rack/accept_media_types.rb
+- LICENSE
+- README
+has_rdoc: true
+homepage: ""
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Rack convenience middleware for simplified handling of Accept header.
+test_files: []
+