rack-acceptable 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Paul Sadauskas
+
+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/README.mkd

@@ -0,0 +1,22 @@
+rack-acceptable
+===============
+
+Adds a #acceptable_media_types method to Rack::Request objects so that full-featured content-negotiation can be performed.
+
+Examples
+--------
+
+    env['HTTP_ACCEPT']  #=> 'application/xml;q=0.8,text/html,text/plain;q=0.9'
+    
+    req = Rack::Request.new(env)
+    req.acceptable_media_types          #=> ['text/html', 'text/plain', 'application/xml']
+    
+    req.acceptable_media_types.prioritize('application/xml', 'text/html') #=>  ['text/html', application/xml']
+    req.acceptable_media_types.preference_of('text/plain', 'text/html')   #=>  'text/html'
+    req.acceptable_media_types.first_acceptable('image/png', 'text/html') #=>  'text/html'
+
+
+See spec/acceptable_media_types_spec.rb for more.
+
+
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-acceptable"
+    gem.version = "0.1.0"
+    gem.summary = "Rack::Request extension to handle conneg"
+    gem.description = "Ditto"
+    gem.email = "psadauskas@gmail.com"
+    gem.homepage = "http://github.com/paul/rack-acceptable"
+    gem.authors = ["Paul Sadauskas"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    
+    gem.add_dependency "rack", ">= 1.1.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/lib/rack/acceptable.rb

@@ -0,0 +1,175 @@
+# Much of this code was stolen from http://github.com/mynyml/rack-accept-media-types
+#
+# Enhancement added by me to include subtype wildcards and handling for client
+# preferred media type.
+
+module Rack
+  class Request
+    # The media types of the HTTP_ACCEPT header ordered according to their
+    # "quality" (preference level), without any media type parameters.
+    #
+    # ===== Examples
+    #
+    #   env['HTTP_ACCEPT']  #=> 'application/xml;q=0.8,text/html,text/plain;q=0.9'
+    #
+    #   req = Rack::Request.new(env)
+    #   req.acceptable_media_types          #=> ['text/html', 'text/plain', 'application/xml']
+    #
+    #   req.acceptable_media_types.prioritize('application/xml', 'text/html') #=>  ['text/html', application/xml']
+    #   req.acceptable_media_types.preference_of('text/plain', 'text/html')   #=>  'text/html'
+    #   req.acceptable_media_types.first_acceptable('image/png', 'text/html') #=>  'text/html'
+    #
+    # For more information, see:
+    # * Accept header:   http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
+    # * Quality values: http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.9
+    #
+    # ===== Returns
+    #
+    # AcceptableMediaTypes:: ordered list of accept header's media types
+    #
+    def acceptable_media_types
+      @acceptable_media_types ||= AcceptableMediaTypes.new(@env['HTTP_ACCEPT'])
+    end
+
+    class AcceptableMediaTypes < Array
+      #--
+      # NOTE
+      # Reason for special handling of nil accept header:
+      #
+      # "If no Accept header field is present, then it is assumed that the client
+      # accepts all media types."
+      #
+      def initialize(*media_types)
+        media_types = media_types.flatten
+        if media_types.empty?
+          replace(['*/*'])
+        elsif media_types.size == 1
+          replace(media_types.first.split(','))
+        else
+          replace(media_types)
+        end
+      end
+
+      def replace(media_types = [])
+        super(order(media_types))
+      end
+
+      # Prioritize a list of media types in order of client preference
+      def prioritize(*types)
+        types = self.class.new(*types)
+        select { |acceptable_type| types.include?(acceptable_type) }
+      end
+
+      # Pick the first acceptable of a list of media types. This is 
+      # useful for serving html to broken browsers (>_> Safari) that
+      # provide a wrong Accept header.
+      #
+      # Example:
+      # 
+      #   accept = AcceptableMediaTypes.new("application/xml;q=1.0,text/html;q=0.1")
+      #   accept.first_acceptable('text/html,application/xml')
+      #   #=> 'text/html'
+      #
+      def first_acceptable(*types)
+        types = self.class.new(*types)
+        types.detect { |type| include?(type) }
+      end
+
+      # The prefered type out of list of possible media types
+      def preference_of(*types)
+        types = self.class.new(*types)
+        detect { |acceptable_type| types.include?(acceptable_type) }
+      end
+
+      private
+
+      # Order media types by quality values, and remove invalid types
+      def order(media_types = [])
+        media_types.map! { |t| t.is_a?(MediaType) ? t : MediaType.new(t) }
+        media_types.sort!
+        media_types.select { |t| t.valid? }
+      end
+
+      class MediaType
+        include Comparable
+
+        attr_accessor :media_type, :range, :quality
+
+        ANY = "*"
+
+        def initialize(media_type)
+          @media_type = media_type
+        end
+
+        # media-range = ( "*/*"
+        # | ( type "/" "*" )
+        # | ( type "/" subtype )
+        # ) *( ";" parameter )
+        def range
+          @range ||= media_type.split(';').first
+        end
+
+        # qvalue = ( "0" [ "." 0*3DIGIT ] )
+        # | ( "1" [ "." 0*3("0") ] )
+        def quality
+          @quality ||= extract_quality(media_type.split(';')[1..-1])
+        end
+
+        def <=>(other)
+          other.quality <=> quality
+        end
+
+        def ==(other_media_type)
+          return false unless other_media_type.is_a?(String) || other_media_type.is_a?(MediaType)
+          other_media_type = MediaType.new(other_media_type) unless other_media_type.is_a?(MediaType)
+
+          if type == ANY
+            true
+          elsif type == other_media_type.type
+            subtype == ANY || subtype == other_media_type.subtype
+          else 
+            false
+          end
+        end
+
+        def inspect
+          %Q{#<#{self.class}:0x%1x #{to_s}>} % object_id
+        end
+
+        def to_s
+          @media_type
+        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?
+          quality > 0 && quality <= 1
+        end
+
+        def type
+          @type ||= range.split('/').first
+        end
+
+        def subtype
+          @subtype ||= range.split('/').last
+        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
+end

data/rack-acceptable.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-acceptable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Sadauskas"]
+  s.date = %q{2010-02-06}
+  s.description = %q{Ditto}
+  s.email = %q{psadauskas@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.mkd"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.mkd",
+     "Rakefile",
+     "lib/rack/acceptable.rb",
+     "rack-acceptable.gemspec",
+     "spec/acceptable_media_types_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/paul/rack-acceptable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rack::Request extension to handle conneg}
+  s.test_files = [
+    "spec/acceptable_media_types_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<rack>, [">= 1.1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rack>, [">= 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rack>, [">= 1.1.0"])
+  end
+end
+

data/spec/acceptable_media_types_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe "Acceptable media types hander" do
+
+  describe "#include?" do
+    it 'should know if it includes a media type' do
+      mt = Rack::Request::AcceptableMediaTypes.new("text/html")
+      mt.include?("text/html").should be_true
+      mt.include?("application/xml").should be_false
+    end
+
+    it 'should know if */* includes any media type' do
+      mt = Rack::Request::AcceptableMediaTypes.new("*/*")
+      mt.include?("text/html").should be_true
+      mt.include?("application/xml").should be_true
+    end
+
+    it 'should know if text/* includes any media subtype' do
+      mt = Rack::Request::AcceptableMediaTypes.new("text/*")
+      mt.include?("text/html").should be_true
+      mt.include?("application/xml").should be_false
+    end
+  end
+
+  describe "#preference_of?" do
+    it 'should pick the first one by order' do
+      mt = Rack::Request::AcceptableMediaTypes.new("text/html,application/xml")
+      mt.preference_of('application/xml,text/html').should == 'text/html'
+    end
+
+    it 'should pick by quality' do
+      mt = Rack::Request::AcceptableMediaTypes.new("text/html;q=0.9,application/xml;q=1.0")
+      mt.preference_of('application/xml,text/html').should == 'application/xml'
+    end
+  end
+
+  describe "#prioritize" do
+    it 'should order them by client order' do
+      mt = Rack::Request::AcceptableMediaTypes.new("text/html,application/xml")
+      mt.prioritize('application/xml,text/html').should == ["text/html", "application/xml"]
+    end
+
+    it 'should order them by quality' do
+      mt = Rack::Request::AcceptableMediaTypes.new("text/html;q=0.9,application/xml;q=1.0")
+      mt.prioritize('application/xml,text/html').should == ['application/xml', 'text/html']
+    end
+  end
+
+  describe "#first_acceptable" do
+    it 'should pick the first media type that is acceptable' do
+      mt = Rack::Request::AcceptableMediaTypes.new("text/html,application/xml")
+      mt.first_acceptable('image/png,application/xml').should == 'application/xml'
+    end
+
+    it 'should pick the first given media type, even if its not the most preferred by quality' do
+      mt = Rack::Request::AcceptableMediaTypes.new("text/html;q=0.5,application/xml")
+      mt.first_acceptable('text/html,application/xml').should == 'text/html'
+    end
+
+    it 'should serve html to safari\'s broken-ass Accept header' do
+      safari_accept = "application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
+      mt = Rack::Request::AcceptableMediaTypes.new(safari_accept)
+      mt.first_acceptable('text/html,application/xml').should == 'text/html'
+    end
+  end
+
+  describe 'initialization' do
+    it 'should take a http accept header string' do
+      mt = Rack::Request::AcceptableMediaTypes.new("application/xml,text/html")
+      mt.should have(2).items
+    end
+
+    it 'should take an array of media type strings' do
+      mt = Rack::Request::AcceptableMediaTypes.new("application/xml", "text/html")
+      mt.should have(2).items
+    end
+
+    it 'should take an array of MediaType objects' do
+      xml = Rack::Request::AcceptableMediaTypes::MediaType.new("application/xml")
+      html = Rack::Request::AcceptableMediaTypes::MediaType.new("text/html")
+      mt = Rack::Request::AcceptableMediaTypes.new(xml, html)
+      mt.should have(2).items
+    end
+    
+    it 'should not arbitrarily reorder media types with no quality param' do
+      mt = Rack::Request::AcceptableMediaTypes.new("application/xml,text/html")
+      mt.first.should == "application/xml"
+      mt.last.should  == "text/html"
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--color
+--format nested
+--loadby random
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack/acceptable'
+require 'spec'
+require 'spec/autorun'
+require 'pp'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: rack-acceptable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Paul Sadauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+description: Ditto
+email: psadauskas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.mkd
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.mkd
+- Rakefile
+- lib/rack/acceptable.rb
+- rack-acceptable.gemspec
+- spec/acceptable_media_types_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/paul/rack-acceptable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.5
+signing_key: 
+specification_version: 3
+summary: Rack::Request extension to handle conneg
+test_files: 
+- spec/acceptable_media_types_spec.rb
+- spec/spec_helper.rb