rack-accept 0.4.4 → 0.4.5

data/README.md

@@ -0,0 +1,144 @@
+# Rack::Accept
+
+**Rack::Accept** is a suite of tools for Ruby/Rack applications that eases the
+complexity of building and interpreting the Accept* family of [HTTP request headers][rfc].
+
+Some features of the library are:
+
+  * Strict adherence to [RFC 2616][rfc], specifically [section 14][rfc-sec14]
+  * Full support for the [Accept][rfc-sec14-1], [Accept-Charset][rfc-sec14-2],
+    [Accept-Encoding][rfc-sec14-3], and [Accept-Language][rfc-sec14-4] HTTP
+    request headers
+  * May be used as [Rack][rack] middleware or standalone
+  * A comprehensive [test suite][test] that covers many edge cases
+
+[rfc]: http://www.w3.org/Protocols/rfc2616/rfc2616.html
+[rfc-sec14]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
+[rfc-sec14-1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
+[rfc-sec14-2]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2
+[rfc-sec14-3]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3
+[rfc-sec14-4]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
+[rack]: http://rack.rubyforge.org/
+[test]: http://github.com/mjijackson/rack-accept/tree/master/test/
+
+## Installation
+
+**Using [RubyGems](http://rubygems.org/):**
+
+    $ sudo gem install rack-accept
+
+**From a local copy:**
+
+    $ git clone git://github.com/mjijackson/rack-accept.git
+    $ cd rack-accept
+    $ rake package && sudo rake install
+
+## Usage
+
+**Rack::Accept** implements the Rack middleware interface and may be used with any
+Rack-based application. Simply insert the `Rack::Accept` module in your Rack
+middleware pipeline and access the `Rack::Accept::Request` object in the
+`rack-accept.request` environment key, as in the following example.
+
+```ruby
+require 'rack/accept'
+
+use Rack::Accept
+
+app = lambda do |env|
+  accept = env['rack-accept.request']
+  response = Rack::Response.new
+
+  if accept.media_type?('text/html')
+    response['Content-Type'] = 'text/html'
+    response.write "<p>Hello. You accept text/html!</p>"
+  else
+    response['Content-Type'] = 'text/plain'
+    response.write "Apparently you don't accept text/html. Too bad."
+  end
+
+  response.finish
+end
+
+run app
+```
+
+**Rack::Accept** can also construct automatic [406][406] responses if you set up
+the types of media, character sets, encoding, or languages your server is able
+to serve ahead of time. If you pass a configuration block to your `use`
+statement it will yield the `Rack::Accept::Context` object that is used for that
+invocation.
+
+[406]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
+
+```ruby
+require 'rack/accept'
+
+use(Rack::Accept) do |context|
+  # We only ever serve content in English or Japanese from this site, so if
+  # the user doesn't accept either of these we will respond with a 406.
+  context.languages = %w< en jp >
+end
+
+app = ...
+
+run app
+```
+
+**Note:** _You should think carefully before using Rack::Accept in this way.
+Many user agents are careless about the types of Accept headers they send, and
+depend on apps not being too picky. Instead of automatically sending a 406, you
+should probably only send one when absolutely necessary._
+
+Additionally, **Rack::Accept** may be used outside of a Rack context to provide
+any Ruby app the ability to construct and interpret Accept headers.
+
+```ruby
+require 'rack/accept'
+
+mtype = Rack::Accept::MediaType.new
+mtype.qvalues = { 'text/html' => 1, 'text/*' => 0.8, '*/*' => 0.5 }
+mtype.to_s # => "Accept: text/html, text/*;q=0.8, */*;q=0.5"
+
+cset = Rack::Accept::Charset.new('unicode-1-1, iso-8859-5;q=0.8')
+cset.best_of(%w< iso-8859-5 unicode-1-1 >)  # => "unicode-1-1"
+cset.accept?('iso-8859-1')                  # => true
+```
+
+The very last line in this example may look like a mistake to someone not
+familiar with the intricacies of [the spec][rfc-sec14-3], but it's actually
+correct. It just puts emphasis on the convenience of using this library so you
+don't have to worry about these kinds of details.
+
+## Four-letter Words
+
+  - Spec: [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html][rfc-sec14]
+  - Code: [http://github.com/mjijackson/rack-accept][code]
+  - Bugs: [http://github.com/mjijackson/rack-accept/issues][bugs]
+  - Docs: [http://mjijackson.github.com/rack-accept][docs]
+
+[code]: http://github.com/mjijackson/rack-accept
+[bugs]: http://github.com/mjijackson/rack-accept/issues
+[docs]: http://mjijackson.github.com/rack-accept
+
+## License
+
+Copyright 2012 Michael Jackson
+
+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/lib/rack/accept/header.rb

@@ -14,7 +14,7 @@ module Rack::Accept
         m = /^([^\s,]+?)(?:\s*;\s*q\s*=\s*(\d+(?:\.\d+)?))?$/.match(part)
 
         if m
-          qvalues[m[1]] = normalize_qvalue((m[2] || 1).to_f)
+          qvalues[m[1].downcase] = normalize_qvalue((m[2] || 1).to_f)
         else
           raise "Invalid header value: #{part.inspect}"
         end

data/lib/rack/accept/language.rb

@@ -6,6 +6,7 @@ module Rack::Accept
   # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
   class Language
     include Header
+    attr_writer :first_level_match
 
     # The name of this header.
     def name
@@ -24,6 +25,7 @@ module Rack::Accept
     # +language+, ordered by precedence.
     def matches(language)
       values.select {|v|
+        v = v.match(/^(.+?)-/) ? $1 : v if @first_level_match
         v == language || v == '*' || (language.match(/^(.+?)-/) && v == $1)
       }.sort {|a, b|
         # "*" gets least precedence, any others are compared based on length.

data/lib/rack/accept/version.rb

@@ -1,6 +1,6 @@
 module Rack
   module Accept
-    VERSION = [0, 4, 4]
+    VERSION = [0, 4, 5]
 
     # Returns the current version of Rack::Accept as a string.
     def self.version

data/rack-accept.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.files = Dir['doc/**/*'] +
     Dir['lib/**/*.rb'] +
     Dir['test/*.rb'] +
-    %w< CHANGES rack-accept.gemspec Rakefile README >
+    %w< CHANGES rack-accept.gemspec Rakefile README.md >
 
   s.test_files = s.files.select {|path| path =~ /^test\/.*_test.rb/ }
 
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
 
   s.has_rdoc = true
   s.rdoc_options = %w< --line-numbers --inline-source --title Rack::Accept --main Rack::Accept >
-  s.extra_rdoc_files = %w< CHANGES README >
+  s.extra_rdoc_files = %w< CHANGES README.md >
 
-  s.homepage = 'http://mjijackson.com/rack-accept'
+  s.homepage = 'http://mjijackson.github.com/rack-accept'
 end

data/test/language_test.rb

@@ -31,5 +31,17 @@ class LanguageTest < Test::Unit::TestCase
     assert_equal('en', l.best_of(%w< en da >))
     assert_equal('en-us', l.best_of(%w< en-us en-au >))
     assert_equal(nil, l.best_of(%w< da >))
+
+    l = L.new('en;q=0.5, en-GB, fr-CA')
+    assert_equal('en-gb', l.best_of(%w< en en-gb >))
+
+    l = L.new('en-gb;q=0.5, EN, fr-CA')
+    assert_equal('en', l.best_of(%w< en en-gb >))
+
+    l = L.new('en;q=0.5, fr-ca')
+    assert_equal('en', l.best_of(%w< en fr >))
+
+    l.first_level_match = true
+    assert_equal('fr', l.best_of(%w< en fr >))
   end
 end

data/test/media_type_test.rb

@@ -36,6 +36,10 @@ class MediaTypeTest < Test::Unit::TestCase
     m = M.new('text/*')
     assert_equal('text/html', m.best_of(%w< text/html text/xml >))
     assert_equal('text/xml', m.best_of(%w< text/xml text/html >))
+
+    m = M.new('TEXT/*')
+    assert_equal('text/html', m.best_of(%w< text/html text/xml >))
+    assert_equal('text/xml', m.best_of(%w< text/xml text/html >))
   end
 
   def test_extension

metadata

@@ -1,53 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-accept
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.4.5
   prerelease: 
-  version: 0.4.4
 platform: ruby
-authors: 
+authors:
 - Michael Jackson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-03 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70171348874000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.4"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.4'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70171348874000
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70171348873580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: HTTP Accept, Accept-Charset, Accept-Encoding, and Accept-Language for Ruby/Rack
+  prerelease: false
+  version_requirements: *70171348873580
+description: HTTP Accept, Accept-Charset, Accept-Encoding, and Accept-Language for
+  Ruby/Rack
 email: mjijackson@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGES
-- README
-files: 
-- doc/index.markdown
-- doc/license.markdown
-- doc/usage.markdown
+- README.md
+files:
 - lib/rack/accept/charset.rb
 - lib/rack/accept/context.rb
 - lib/rack/accept/encoding.rb
@@ -69,41 +63,38 @@ files:
 - CHANGES
 - rack-accept.gemspec
 - Rakefile
-- README
-has_rdoc: true
-homepage: http://mjijackson.com/rack-accept
+- README.md
+homepage: http://mjijackson.github.com/rack-accept
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Rack::Accept
 - --main
 - Rack::Accept
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: HTTP Accept* for Ruby/Rack
-test_files: 
+test_files:
 - test/charset_test.rb
 - test/context_test.rb
 - test/encoding_test.rb

data/README

@@ -1,127 +0,0 @@
-Rack::Accept
-============
-
-Rack::Accept is a suite of tools for Ruby/Rack applications that eases the
-complexity of building and interpreting the Accept* family of HTTP request
-headers.
-
-Some features of the library are:
-
-  * Strict adherence to RFC 2616, specifically section 14
-  * Full support for the Accept, Accept-Charset, Accept-Encoding, and
-    Accept-Language HTTP request headers
-  * May be used as Rack middleware or standalone
-  * A comprehensive test suite that covers many edge cases
-
-Installation
-------------
-
-Using RubyGems:
-
-    $ sudo gem install rack-accept
-
-From a local copy:
-
-    $ git clone git://github.com/mjijackson/rack-accept.git
-    $ cd rack-accept
-    $ rake package && sudo rake install
-
-Usage
------
-
-Rack::Accept implements the Rack middleware interface and may be used with any
-Rack-based application. Simply insert the Rack::Accept module in your Rack
-middleware pipeline and access the Rack::Accept::Request object in the
-"rack-accept.request" environment key, as in the following example.
-
-    require 'rack/accept'
-
-    use Rack::Accept
-
-    app = lambda do |env|
-      accept = env['rack-accept.request']
-      response = Rack::Response.new
-
-      if accept.media_type?('text/html')
-        response['Content-Type'] = 'text/html'
-        response.write "<p>Hello. You accept text/html!</p>"
-      else
-        response['Content-Type'] = 'text/plain'
-        response.write "Apparently you don't accept text/html. Too bad."
-      end
-
-      response.finish
-    end
-
-    run app
-
-Rack::Accept can also construct automatic 406 responses if you set up the types
-of media, character sets, encoding, or languages your server is able to serve
-ahead of time. If you pass a configuration block to your `use` statement it will
-yield the Rack::Accept::Context object that is used for that invocation.
-
-    require 'rack/accept'
-
-    use(Rack::Accept) do |context|
-      # We only ever serve content in English or Japanese from this site, so if
-      # the user doesn't accept either of these we will respond with a 406.
-      context.languages = %w< en jp >
-    end
-
-    app = ...
-
-    run app
-
-Note: You should think carefully before using Rack::Accept in this way.
-Many user agents are careless about the types of Accept headers they send, and
-depend on apps not being too picky. Instead of automatically sending a 406, you
-should probably only send one when absolutely necessary.
-
-Additionally, Rack::Accept may be used outside of a Rack context to provide
-any Ruby app the ability to construct and interpret Accept headers.
-
-    require 'rack/accept'
-
-    mtype = Rack::Accept::MediaType.new
-    mtype.qvalues = { 'text/html' => 1, 'text/*' => 0.8, '*/*' => 0.5 }
-    mtype.to_s # => "Accept: text/html, text/*;q=0.8, */*;q=0.5"
-
-    cset = Rack::Accept::Charset.new('unicode-1-1, iso-8859-5;q=0.8')
-    cset.best_of(%w< iso-8859-5 unicode-1-1 >)  # => "unicode-1-1"
-    cset.accept?('iso-8859-1')                  # => true
-
-The very last line in this example may look like a mistake to someone not
-familiar with the intricacies of the spec, but it's actually correct. It
-just puts emphasis on the convenience of using this library so you don't
-have to worry about these kinds of details.
-
-Four-letter Words
------------------
-
-  Spec: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
-  Code: http://github.com/mjijackson/rack-accept
-  Bugs: http://github.com/mjijackson/rack-accept/issues
-  Docs: http://mjijackson.com/rack-accept
-
-License
--------
-
-Copyright 2010 Michael Jackson
-
-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/doc/index.markdown

@@ -1,35 +0,0 @@
-__Rack::Accept__ is a suite of tools for Ruby/Rack applications that eases the
-complexity of building and interpreting the Accept* family of [HTTP request
-headers][rfc].
-
-Some features of the library are:
-
-  * Strict adherence to [RFC 2616][rfc], specifically [section 14][sec14]
-  * Full support for the [Accept][sec14-1], [Accept-Charset][sec14-2],
-    [Accept-Encoding][sec14-3], and [Accept-Language][sec14-4] HTTP request
-    headers
-  * May be used as [Rack][rack] middleware or standalone
-  * A comprehensive [test suite][test] that covers many edge cases
-
-Installation
-------------
-
-Using [RubyGems][rubygems]:
-
-    $ sudo gem install rack-accept
-
-From a local copy:
-
-    $ git clone git://github.com/mjijackson/rack-accept.git
-    $ cd rack-accept
-    $ rake package && sudo rake install
-
-[rfc]: http://www.w3.org/Protocols/rfc2616/rfc2616.html
-[sec14]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
-[sec14-1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
-[sec14-2]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2
-[sec14-3]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3
-[sec14-4]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
-[rack]: http://rack.rubyforge.org/
-[test]: http://github.com/mjijackson/rack-accept/tree/master/test/
-[rubygems]: http://rubygems.org/

data/doc/license.markdown

@@ -1,22 +0,0 @@
-License
--------
-
-Copyright 2010 Michael Jackson
-
-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/doc/usage.markdown

@@ -1,74 +0,0 @@
-Usage
------
-
-Rack::Accept implements the Rack middleware interface and may be used with any
-Rack-based application. Simply insert the Rack::Accept module in your Rack
-middleware pipeline and access the [Request][req] object in the
-"rack-accept.request" environment key, as in the following example.
-
-    require 'rack/accept'
-
-    use Rack::Accept
-
-    app = lambda do |env|
-      accept = env['rack-accept.request']
-      response = Rack::Response.new
-
-      if accept.media_type?('text/html')
-        response['Content-Type'] = 'text/html'
-        response.write "<p>Hello. You accept text/html!</p>"
-      else
-        response['Content-Type'] = 'text/plain'
-        response.write "Apparently you don't accept text/html. Too bad."
-      end
-
-      response.finish
-    end
-
-    run app
-
-Rack::Accept can also construct automatic [406][406] responses if you set up
-the types of media, character sets, encoding, or languages your server is able
-to serve ahead of time. If you pass a configuration block to your `use`
-statement it will yield the [Context][ctx] object that is used for that
-invocation.
-
-    require 'rack/accept'
-
-    use(Rack::Accept) do |context|
-      # We only ever serve content in English or Japanese from this site, so if
-      # the user doesn't accept either of these we will respond with a 406.
-      context.languages = %w< en jp >
-    end
-
-    app = ...
-
-    run app
-
-__Note:__ You should think carefully before using Rack::Accept in this way.
-Many user agents are careless about the types of Accept headers they send, and
-depend on apps not being too picky. Instead of automatically sending a 406, you
-should probably only send one when absolutely necessary.
-
-Additionally, Rack::Accept may be used outside of a Rack context to provide
-any Ruby app the ability to construct and interpret Accept headers.
-
-    require 'rack/accept'
-
-    mtype = Rack::Accept::MediaType.new
-    mtype.qvalues = { 'text/html' => 1, 'text/*' => 0.8, '*/*' => 0.5 }
-    mtype.to_s # => "Accept: text/html, text/*;q=0.8, */*;q=0.5"
-
-    cset = Rack::Accept::Charset.new('unicode-1-1, iso-8859-5;q=0.8')
-    cset.best_of(%w< iso-8859-5 unicode-1-1 >)  # => "unicode-1-1"
-    cset.accept?('iso-8859-1')                  # => true
-
-The very last line in this example may look like a mistake to someone not
-familiar with the intricacies of [the spec][sec14-3], but it's actually
-correct. It just puts emphasis on the convenience of using this library so you
-don't have to worry about these kinds of details.
-
-[req]: api/classes/Rack/Accept/Request.html
-[406]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
-[ctx]: api/classes/Rack/Accept/Context.html
-[sec14-3]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3