negotiator 0.1

data/Readme.md

@@ -0,0 +1,43 @@
+# Negotiator
+
+This library does HTTP content negotiation.
+
+This particular library intends to follow the HTTP
+specification closely.
+
+You give it an Accept header and a list of content types,
+and it'll pick one. In case of a tie, it'll choose the one
+that comes first in the provided Hash (as long as you're
+using ruby >= 1.9). If none match, it'll return nil.
+
+A missing (nil) header is treated the same as `*/*`, as
+required by HTTP.
+
+## Examples
+
+    > header = "text/xml, application/json, text/plain; q=0.8, */*; q=0.5"
+    > available = {"text/plain" => 1.0, "application/json" => 1.0, "text/xml" => 1.0}
+    > Negotiator.pick(header, available)
+    "application/json"
+
+    > header = "audio/*; q=0.5, audio/mp3; q=1.0"
+    > available = {"audio/flac" => 1.0, "audio/ogg" => 0.8, "audio/mp3" => 0.7}
+    > Negotiator.pick(header, available)
+    "audio/mp3"
+
+## Advice
+
+If `Negotiator.pick` returns `nil`, you should send the
+HTTP 406 (not acceptable) response.
+
+## Running Tests
+
+    $ turn test
+
+## The End
+
+Bug reports and pull requests are most welcome!
+
+Thank you!
+
+Have fun!

data/lib/negotiator.rb

@@ -0,0 +1,69 @@
+class Negotiator
+  VERSION = "0.1"
+
+  def self.pick(h, o)
+    r = parse(h)
+    cand = []
+    for s, q in o
+      st = s.split(/\//)[0]
+      case true
+      when r[0].include?(s)
+        q *= r[0][s]
+      when r[1].include?(st)
+        q *= r[1][st]
+      else
+        q *= r[2]
+      end
+      if q > 0
+        cand << [s, q]
+      end
+    end
+
+    if cand.empty?
+      return nil
+    end
+
+    best = cand[0]
+    for s, q in cand
+      if q > best[1]
+        best = [s, q]
+      end
+    end
+    return best[0]
+  end
+
+  def self.parse(h)
+    if !h
+      h = "*/*"
+    end
+
+    qual = [{}, {}, 0.0]
+    p = h.split(/,\s*/)
+    for s in p
+      t, st, q = parse_media_range(s)
+
+      case true
+      when t == "*"
+        qual[2] = q
+      when st == "*"
+        qual[1][t] = q
+      else
+        qual[0]["#{t}/#{st}"] = q
+      end
+    end
+    qual
+  end
+
+  def self.parse_media_range(s)
+    q = 1.0
+    if s[";"]
+      s, qs = s.split(/;\s*/)
+      if qs.index("q=") == 0
+        q = Float(qs[2,qs.length])
+      end
+    end
+
+    t, st = s.split(/\//)
+    return t, st, q
+  end
+end

data/test/test_negotiator.rb

@@ -0,0 +1,133 @@
+$VERBOSE = true
+require 'test/unit'
+require 'fileutils'
+
+require '../negotiator/lib/negotiator'
+
+class TestNegotiator < Test::Unit::TestCase
+  def test_any
+    h = "*/*"
+    a = {"text/plain" => 1.0, "application/json" => 0.9999, "text/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal("text/plain", t)
+  end
+
+  def test_subsume_any
+    h = "text/plain, */*"
+    a = {"text/plain" => 1.0, "application/json" => 0.9999, "text/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal("text/plain", t)
+  end
+
+  def test_part
+    h = "text/*"
+    a = {"text/plain" => 1.0, "application/json" => 0.9999, "text/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal("text/plain", t)
+  end
+
+  def test_subsume_part
+    h = "text/plain, text/*"
+    a = {"text/plain" => 1.0, "application/json" => 0.9999, "text/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal("text/plain", t)
+  end
+
+  def test_full_only
+    h = "application/xml"
+    a = {"application/json" => 1.0, "text/html" => 0.9999, "application/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal("application/xml", t)
+  end
+
+  def test_no_match
+    h = "text/plain"
+    a = {"application/json" => 1.0, "text/html" => 0.9999, "application/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal(nil, t)
+  end
+
+  def test_empty_header
+    h = ""
+    a = {"application/json" => 1.0, "text/html" => 0.9999, "application/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal(nil, t)
+  end
+
+  def test_nil_header
+    h = nil
+    a = {"application/json" => 1.0, "text/html" => 0.9999, "application/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal("application/json", t)
+  end
+
+  def test_3levels
+    h = "application/xml, application/json, text/plain; q=0.8, */*; q=0.5"
+    a = {"text/plain" => 1.0, "application/xml" => 0.9999}
+    t = Negotiator.pick(h, a)
+    assert_equal("application/xml", t)
+  end
+
+  def test_browser
+    h = "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
+    a = {"application/json" => 1.0, "text/html" => 0.9999, "application/xml" => 0.9998}
+    t = Negotiator.pick(h, a)
+    assert_equal("text/html", t)
+  end
+
+  def test_general_markdown_preferred
+    h = "audio/*; q=0.2, audio/basic"
+    a = {"audio/mp3" => 1.0, "audio/basic" => 0.9999}
+    t = Negotiator.pick(h, a)
+    assert_equal("audio/basic", t)
+  end
+
+  def test_general_markdown_nonpreferred
+    h = "audio/*; q=0.2, audio/basic"
+    a = {"audio/mp3" => 1.0, "audio/basic" => 0.1}
+    t = Negotiator.pick(h, a)
+    assert_equal("audio/mp3", t)
+  end
+
+  def test_general_markup_preferred
+    h = "audio/*; q=1.2, audio/basic"
+    a = {"audio/mp3" => 1.0, "audio/basic" => 0.9999}
+    t = Negotiator.pick(h, a)
+    assert_equal("audio/mp3", t)
+  end
+
+  def test_general_markup_nonpreferred
+    h = "audio/*; q=1.2, audio/basic"
+    a = {"audio/mp3" => 1.0, "audio/basic" => 1.3}
+    t = Negotiator.pick(h, a)
+    assert_equal("audio/basic", t)
+  end
+
+  def test_specific_markdown_preferred
+    h = "audio/*, audio/basic; q=0.2"
+    a = {"audio/mp3" => 1.0, "audio/basic" => 0.9999}
+    t = Negotiator.pick(h, a)
+    assert_equal("audio/mp3", t)
+  end
+
+  def test_specific_markdown_nonpreferred
+    h = "audio/*, audio/basic; q=0.2"
+    a = {"audio/mp3" => 0.1, "audio/basic" => 1.0}
+    t = Negotiator.pick(h, a)
+    assert_equal("audio/basic", t)
+  end
+
+  def test_specific_markup_preferred
+    h = "audio/*, audio/basic; q=1.2"
+    a = {"audio/mp3" => 1.0, "audio/basic" => 0.9999}
+    t = Negotiator.pick(h, a)
+    assert_equal("audio/basic", t)
+  end
+
+  def test_specific_markup_nonpreferred
+    h = "audio/*, audio/basic; q=1.2"
+    a = {"audio/mp3" => 1.3, "audio/basic" => 1.0}
+    t = Negotiator.pick(h, a)
+    assert_equal("audio/mp3", t)
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: negotiator
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Keith Rarick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-09 00:00:00.000000000Z
+dependencies: []
+description: Given an HTTP Accept header and a set of available content types, this
+  gem will tell you what to do.
+email: kr@xph.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- lib/negotiator.rb
+- test/test_negotiator.rb
+homepage: https://github.com/kr/negotiator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Correct HTTP Content Negotiation
+test_files: []