accept_headers 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4df1427bbf8cc170c8d3eb303c6978f4c03d4b3e
-  data.tar.gz: 7efc9d1f82cfd666507f72fae4b09e7020516970
+  metadata.gz: f095a96c5f335db2b23047bac10e48fff764b819
+  data.tar.gz: da3121b83be60d9a41dd7bfcf98ca8925e0d80e8
 SHA512:
-  metadata.gz: 339ce5ee8e97554e7d890179f6362e279d1933deec79f351c617ada281415d1f30e80f92080cb4eebe20e56a5436b2b5cd5ecc663940a65b77ee9697252dd165
-  data.tar.gz: 899d66e7efd0d9479adbc800de51d6abc3f3cb8d4c7950bf0ce1de344f7218757b5936d0d7814bbbdeb640daaa4faaf068b3a7fa39b879e1a4a6c0770040563c
+  metadata.gz: 9655d4af6bcb6aab678a5bd5e50f4b2ae312a69e08e2ca7ea8e3a0ddaebd28adef3934f22fe4726f9e815dba0dce1400028fa67b9921ac32c2ecdc546b67e6de
+  data.tar.gz: 082959990b7b5d8bea5d0222fba0aa3e23e72b11e42c27812ff1f940178bded01171de8c8246ef6350b17320e19586b275e0b8061d3e625a76556b629ac2825b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## HEAD
 
+## 0.0.6 / November 17, 2014
+
+  * Support parsing params with quoted values.
+  * Fix bug in `#negotiate` returning nil on first q=0 match, it should skip this match and move on to the next one in the array input.
+  * Fix Charset typos in README.
+  * Add specs for ignoring accept header prefixes.
+
 ## 0.0.5 / November 16, 2014
 
   * Add `#accept?` and `#reject?` methods to all negotiators.

data/README.md

@@ -15,7 +15,7 @@ Some features of the library are:
   * Parser tested against all IANA registered [media types][iana-media-types]
   * A comprehensive [spec suite][spec] that covers many edge cases
 
-This library is optimistic when parsing headers. If a specific media type, encoding, charset, or language can't be parsed, is in an invalid format, or contains invalid characters, it will skip that specific entry when constructing the sorted list. If a `q` value can't be read or is in the wrong format (more than 3 decimal places), it will default it to `0.001` so it still has a chance to match. Lack of an explicit `q` value of course defaults to 1.
+This library is optimistic when parsing headers. If a specific media type, encoding, or language can't be parsed, is in an invalid format, or contains invalid characters, it will skip that specific entry when constructing the sorted list. If a `q` value can't be read or is in the wrong format (more than 3 decimal places), it will default it to `0.001` so it still has a chance to match. Lack of an explicit `q` value of course defaults to 1.
 
 [rfc]: http://www.w3.org/Protocols/rfc2616/rfc2616.html
 [rfc-sec14]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
@@ -63,14 +63,20 @@ media_types.list
 ]
 ```
 
-`#negotiate` takes a string of media types supported (by your API or route/controller) and returns the best match as a `MediaType`. This will first check the available list for any matching media types with a `q` of 0 and return `nil` if there is a match. Then it'll look to the highest `q` values and look for matches in descending `q` value order and return the first match (accounting for wildcards). Finally, if there are no matches, it returns `nil`.
+`#negotiate` takes an array of media range strings supported (by your API or route/controller) and returns a hash where the `supported` key contains the array element matched and the `matched` key containing a `MediaType` that was matched in the `Negotiator`s internal list.
+
+This will first check the available list for any matching media types with a `q` of 0 and skip any matches. It does this because the RFC specifies that if the `q` value is 0, then content with this parameter is `not acceptable`. Then it'll look to the highest `q` values and look for matches in descending `q` value order and return the first match (accounting for wildcards). Finally, if there are no matches, it returns `nil`.
 
 ```ruby
-media_types.negotiate('text/html')
+# The same media_types variable as above
+media_types.negotiate(['text/html', 'text/plain'])
 
 # Returns:
 
-AcceptHeaders::MediaType.new('text', 'html', params: { 'level' => '1' })
+{
+  supported: 'text/html',
+  matched:    AcceptHeaders::MediaType.new('text', 'html', q: 1, params: { 'level' => '1' })
+}
 ```
 
 `#accept?`:
@@ -81,7 +87,7 @@ media_types.accept?('text/html') # true
 
 ### Accept-Encoding
 
-`AcceptHeader::Charset::Encoding`:
+`AcceptHeader::Encoding::Encoding`:
 
 ```ruby
 encodings = AcceptHeaders::Encoding::Negotiator.new("deflate; q=0.5, gzip, compress; q=0.8, identity")
@@ -100,11 +106,14 @@ encodings.list
 `#negotiate`:
 
 ```ruby
-encodings.negotiate('gzip')
+encodings.negotiate(['gzip', 'compress'])
 
 # Returns:
 
-AcceptHeaders::Encoding.new('gzip')
+{
+  supported: 'gzip',
+  matched:    AcceptHeaders::Encoding.new('gzip'))
+}
 ```
 
 `#accept?`:
@@ -138,11 +147,14 @@ languages.list
 `#negotiate`:
 
 ```ruby
-languages.negotiate('en-us')
+languages.negotiate(['en-us', 'zh-Hant'])
 
 # Returns:
 
-AcceptHeaders::Language.new('en', 'us')
+{
+  supported: 'en-us',
+  matched:    AcceptHeaders::Language.new('en', 'us'))
+}
 ```
 
 `#accept?`:

data/accept_headers.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 

data/lib/accept_headers/acceptable.rb

@@ -36,7 +36,6 @@ module AcceptHeaders
       @q = q_float
     end
 
-    private
     def match(other)
       raise NotImplementedError.new("#match is not implemented")
     end

data/lib/accept_headers/encoding.rb

@@ -34,7 +34,6 @@ module AcceptHeaders
       "#{encoding};q=#{qvalue}"
     end
 
-    private
     def match(encoding_string)
       match_data = ENCODING_PATTERN.match(encoding_string)
       if !match_data

data/lib/accept_headers/language.rb

@@ -62,7 +62,6 @@ module AcceptHeaders
       end
     end
 
-    private
     def match(language_tag_string)
       match_data = LANGUAGE_TAG_PATTERN.match(language_tag_string)
       if !match_data

data/lib/accept_headers/media_type.rb

@@ -76,7 +76,6 @@ module AcceptHeaders
       "#{type}/#{subtype}"
     end
 
-    private
     def match(media_range_string)
       match_data = MEDIA_TYPE_PATTERN.match(media_range_string)
       if !match_data

data/lib/accept_headers/media_type/negotiator.rb

@@ -35,11 +35,15 @@ module AcceptHeaders
       end
 
       def parse_params(params_string)
-        params = {}
-        return params if !params_string || params_string.empty?
-        params_string.split(';').each do |part|
-          param = PARAM_PATTERN.match(part)
-          params[param[:attribute]] = param[:value] if param
+        return {} if !params_string || params_string.empty?
+        if params_string.match(/['"]/)
+          params = params_string.scan(PARAM_PATTERN).map(&:compact).to_h
+        else
+          params = {}
+          params_string.split(';').each do |part|
+            param = PARAM_PATTERN.match(part)
+            params[param[:attribute]] = param[:value] if param
+          end
         end
         params.delete('q')
         params

data/lib/accept_headers/negotiatable.rb

@@ -12,20 +12,18 @@ module AcceptHeaders
     end
 
     def negotiate(supported)
-      return nil if @list.empty?
+      return nil if list.empty?
       supported = [*supported]
-      rejects, acceptable = @list.partition { |m| m.q == 0.0 }
-      rejects.each do |reject|
+      # TODO: Maybe q=0 should be first by default when sorting
+      rejects, acceptable = list.partition { |m| m.q == 0.0 }
+      (rejects + acceptable).each do |part|
         supported.each do |support|
-          if reject.reject?(support)
-            return nil
-          end
-        end
-      end
-      acceptable.sort { |x,y| y <=> x }.each do |accepted|
-        supported.each do |support|
-          if accepted.accept?(support)
-            return accepted
+          if part.match(support)
+            if part.q == 0.0
+              next
+            else
+              return { supported: support, matched: part }
+            end
           end
         end
       end

data/lib/accept_headers/version.rb

@@ -1,3 +1,3 @@
 module AcceptHeaders
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/encoding/negotiator_spec.rb

@@ -1,86 +1,89 @@
 require_relative "../spec_helper"
 
-module AcceptHeaders
-  class Encoding
-    describe Negotiator do
-      subject do
-        AcceptHeaders::Encoding::Negotiator
-      end
+describe AcceptHeaders::Encoding::Negotiator do
+  subject { AcceptHeaders::Encoding::Negotiator }
+  let(:encoding) { AcceptHeaders::Encoding }
 
-      describe "parsing an accept header" do
-        it "returns a sorted array of encodings" do
-          subject.new("*; q=0.2, compress").list.must_equal [
-            Encoding.new('compress'),
-            Encoding.new('*', q: 0.2)
-          ]
+  describe "parsing an accept header" do
+    it "returns a sorted array of encodings" do
+      subject.new("*; q=0.2, compress").list.must_equal [
+        encoding.new('compress'),
+        encoding.new('*', q: 0.2)
+      ]
 
-          subject.new("deflate; q=0.5, gzip, compress; q=0.8, identity").list.must_equal [
-            Encoding.new('gzip'),
-            Encoding.new('identity'),
-            Encoding.new('compress', q: 0.8),
-            Encoding.new('deflate', q: 0.5)
-          ]
-        end
+      subject.new("deflate; q=0.5, gzip, compress; q=0.8, identity").list.must_equal [
+        encoding.new('gzip'),
+        encoding.new('identity'),
+        encoding.new('compress', q: 0.8),
+        encoding.new('deflate', q: 0.5)
+      ]
+    end
 
-        it "supports all registered IANA encodings" do
-          require 'csv'
-          # https://www.iana.org/assignments/http-parameters/http-parameters.xml#content-coding
-          CSV.foreach("spec/support/encodings/content-coding.csv", headers: true) do |row|
-            encoding = row['Name']
+    it "ignores the 'Accept-Encoding:' prefix" do
+      subject.new('Accept-Encoding: gzip').list.must_equal [
+        encoding.new('gzip')
+      ]
+    end
 
-            if encoding
-              subject.new(encoding).list.size.must_equal 1
-              subject.new(encoding).list.first.encoding.must_equal encoding.downcase
-            end
-          end
-        end
+    it "supports all registered IANA encodings" do
+      require 'csv'
+      # https://www.iana.org/assignments/http-parameters/http-parameters.xml#content-coding
+      CSV.foreach("spec/support/encodings/content-coding.csv", headers: true) do |row|
+        encoding = row['Name']
 
-        it "sets encoding to * when the accept-encoding header is empty" do
-          subject.new('').list.must_equal [
-            Encoding.new('*')
-          ]
+        if encoding
+          subject.new(encoding).list.size.must_equal 1
+          subject.new(encoding).list.first.encoding.must_equal encoding.downcase
         end
+      end
+    end
 
-        it "defaults q to 1 if it's not explicitly specified" do
-          subject.new("gzip").list.must_equal [
-            Encoding.new('gzip', q: 1.0)
-          ]
-        end
+    it "sets encoding to * when the accept-encoding header is empty" do
+      subject.new('').list.must_equal [
+        encoding.new('*')
+      ]
+    end
 
-        it "strips whitespace from between encodings" do
-          subject.new("\tcompress\r,\ngzip\s").list.must_equal [
-            Encoding.new('compress'),
-            Encoding.new('gzip')
-          ]
-        end
+    it "defaults q to 1 if it's not explicitly specified" do
+      subject.new("gzip").list.must_equal [
+        encoding.new('gzip', q: 1.0)
+      ]
+    end
 
-        it "strips whitespace around q" do
-          subject.new("gzip;\tq\r=\n1, compress;q=0.8\n").list.must_equal [
-            Encoding.new('gzip'),
-            Encoding.new('compress', q: 0.8)
-          ]
-        end
+    it "strips whitespace from between encodings" do
+      subject.new("\tcompress\r,\ngzip\s").list.must_equal [
+        encoding.new('compress'),
+        encoding.new('gzip')
+      ]
+    end
 
-        it "has a q value of 0.001 when parsed q is invalid" do
-          subject.new("gzip;q=x").list.must_equal [
-            Encoding.new('gzip', q: 0.001)
-          ]
-        end
+    it "strips whitespace around q" do
+      subject.new("gzip;\tq\r=\n1, compress;q=0.8\n").list.must_equal [
+        encoding.new('gzip'),
+        encoding.new('compress', q: 0.8)
+      ]
+    end
 
-        it "skips invalid encodings" do
-          subject.new("gzip, @blah").list.must_equal [
-            Encoding.new('gzip', q: 1.0)
-          ]
-        end
-      end
+    it "has a q value of 0.001 when parsed q is invalid" do
+      subject.new("gzip;q=x").list.must_equal [
+        encoding.new('gzip', q: 0.001)
+      ]
+    end
 
-      describe "negotiate supported encodings" do
-        it "returns a best matching encoding" do
-          match =
-          n = subject.new("deflate; q=0.5, gzip, compress; q=0.8, identity")
-          n.negotiate("identity").must_equal Encoding.new('identity')
-        end
-      end
+    it "skips invalid encodings" do
+      subject.new("gzip, @blah").list.must_equal [
+        encoding.new('gzip', q: 1.0)
+      ]
+    end
+  end
+
+  describe "negotiate supported encodings" do
+    it "returns a best matching encoding" do
+      n = subject.new('deflate; q=0.5, gzip, compress; q=0.8, identity')
+      n.negotiate(['identity', 'deflate']).must_equal({
+        supported: 'identity',
+        matched: encoding.new('identity')
+      })
     end
   end
 end

data/spec/language/negotiator_spec.rb

@@ -1,78 +1,82 @@
 require_relative "../spec_helper"
 
-module AcceptHeaders
-  class Language
-    describe Negotiator do
-      subject do
-        AcceptHeaders::Language::Negotiator
-      end
+describe AcceptHeaders::Language::Negotiator do
+  subject { AcceptHeaders::Language::Negotiator }
+  let(:language) { AcceptHeaders::Language }
 
-      describe "parsing an accept header" do
-        it "returns a sorted array of media primary tags" do
-          subject.new("en-*;q=0.2, en-us").list.must_equal [
-            Language.new('en', 'us'),
-            Language.new('en', '*', q: 0.2)
-          ]
+  describe "parsing an accept header" do
+    it "returns a sorted array of media primary tags" do
+      subject.new("en-*;q=0.2, en-us").list.must_equal [
+        language.new('en', 'us'),
+        language.new('en', '*', q: 0.2)
+      ]
 
-          subject.new("en-*, en-us, *;q=0.8").list.must_equal [
-            Language.new('en', 'us'),
-            Language.new('en', '*'),
-            Language.new('*', '*', q: 0.8)
-          ]
-        end
+      subject.new("en-*, en-us, *;q=0.8").list.must_equal [
+        language.new('en', 'us'),
+        language.new('en', '*'),
+        language.new('*', '*', q: 0.8)
+      ]
+    end
 
-        it "sets media primary tag to */* when the accept header is empty" do
-          subject.new('').list.must_equal [
-            Language.new('*', '*')
-          ]
-        end
+    it "ignores the 'Accept-Language:' prefix" do
+      subject.new('Accept-Language: en-us').list.must_equal [
+        language.new('en', 'us')
+      ]
+    end
 
-        it "sets media primary tag to */* when the primary tag is only *" do
-          subject.new('*').list.must_equal [
-            Language.new('*', '*')
-          ]
-        end
+    it "sets media primary tag to */* when the accept header is empty" do
+      subject.new('').list.must_equal [
+        language.new('*', '*')
+      ]
+    end
 
-        it "defaults q to 1 if it's not explicitly specified" do
-          subject.new("en-us").list.must_equal [
-            Language.new('en', 'plain', q: 1.0)
-          ]
-        end
+    it "sets media primary tag to */* when the primary tag is only *" do
+      subject.new('*').list.must_equal [
+        language.new('*', '*')
+      ]
+    end
 
-        it "strips whitespace from between media primary tags" do
-          subject.new("\ten-us\r,\nen-gb\s").list.must_equal [
-            Language.new('en', 'us'),
-            Language.new('en', 'gb')
-          ]
-        end
+    it "defaults q to 1 if it's not explicitly specified" do
+      subject.new("en-us").list.must_equal [
+        language.new('en', 'plain', q: 1.0)
+      ]
+    end
 
-        it "strips whitespace around q" do
-          subject.new("en-us;\tq\r=\n1, en-gb").list.must_equal [
-            Language.new('en', 'us'),
-            Language.new('en', 'gb')
-          ]
-        end
+    it "strips whitespace from between media primary tags" do
+      subject.new("\ten-us\r,\nen-gb\s").list.must_equal [
+        language.new('en', 'us'),
+        language.new('en', 'gb')
+      ]
+    end
 
-        it "has a q value of 0.001 when parsed q is invalid" do
-          subject.new("en-us;q=x").list.must_equal [
-            Language.new('en', 'plain', q: 0.001)
-          ]
-        end
+    it "strips whitespace around q" do
+      subject.new("en-us;\tq\r=\n1, en-gb").list.must_equal [
+        language.new('en', 'us'),
+        language.new('en', 'gb')
+      ]
+    end
+
+    it "has a q value of 0.001 when parsed q is invalid" do
+      subject.new("en-us;q=x").list.must_equal [
+        language.new('en', 'plain', q: 0.001)
+      ]
+    end
 
-        it "skips invalid media primary tags" do
-          subject.new("en-us, en-us-omg;q=0.9").list.must_equal [
-            Language.new('en', 'us', q: 1)
-          ]
-        end
-      end
+    it "skips invalid media primary tags" do
+      subject.new("en-us, en-us-omg;q=0.9").list.must_equal [
+        language.new('en', 'us', q: 1)
+      ]
+    end
+  end
 
-      describe "negotiate supported languages" do
-        it "returns a best matching language" do
-          match = Language.new('en', 'us')
-          n = subject.new('en-*, en-us, *;q=0.8')
-          n.negotiate('en-us').must_equal match
-        end
-      end
+  describe "negotiate supported languages" do
+    it "returns a best matching language" do
+      match = language.new('en', 'us')
+      n = subject.new('en-*, en-us, *;q=0.8')
+      n.negotiate('en-us').must_equal({
+        supported: 'en-us',
+        matched: match
+      })
     end
   end
 end

data/spec/media_type/negotiator_spec.rb

@@ -1,122 +1,197 @@
 require_relative "../spec_helper"
 
-module AcceptHeaders
-  class MediaType
-    describe Negotiator do
-      subject do
-        AcceptHeaders::MediaType::Negotiator
-      end
+describe AcceptHeaders::MediaType::Negotiator do
+  subject { AcceptHeaders::MediaType::Negotiator }
+  let(:media_type) { AcceptHeaders::MediaType }
+
+  describe "parsing an accept header" do
+    it "returns a sorted array of media types" do
+      subject.new("audio/*; q=0.2, audio/basic").list.must_equal [
+        media_type.new('audio', 'basic'),
+        media_type.new('audio', '*', q: 0.2)
+      ]
+      subject.new("text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c").list.must_equal [
+        media_type.new('text', 'html'),
+        media_type.new('text', 'x-c'),
+        media_type.new('text', 'x-dvi', q: 0.8),
+        media_type.new('text', 'plain', q: 0.5)
+      ]
+
+      subject.new("text/*, text/html, text/html;level=1, */*").list.must_equal [
+        media_type.new('text', 'html', params: { 'level' => '1' }),
+        media_type.new('text', 'html'),
+        media_type.new('text', '*'),
+        media_type.new('*', '*')
+      ]
+
+      subject.new("text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5").list.must_equal [
+        media_type.new('text', 'html', params: { 'level' => '1' }),
+        media_type.new('text', 'html', q: 0.7),
+        media_type.new('*', '*', q: 0.5),
+        media_type.new('text', 'html', q: 0.4, params: { 'level' => '2' }),
+        media_type.new('text', '*', q: 0.3)
+      ]
+    end
 
-      describe "parsing an accept header" do
-        it "returns a sorted array of media types" do
-          subject.new("audio/*; q=0.2, audio/basic").list.must_equal [
-            MediaType.new('audio', 'basic'),
-            MediaType.new('audio', '*', q: 0.2)
-          ]
-          subject.new("text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c").list.must_equal [
-            MediaType.new('text', 'html'),
-            MediaType.new('text', 'x-c'),
-            MediaType.new('text', 'x-dvi', q: 0.8),
-            MediaType.new('text', 'plain', q: 0.5)
-          ]
-
-          subject.new("text/*, text/html, text/html;level=1, */*").list.must_equal [
-            MediaType.new('text', 'html', params: { 'level' => '1' }),
-            MediaType.new('text', 'html'),
-            MediaType.new('text', '*'),
-            MediaType.new('*', '*')
-          ]
-
-          subject.new("text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5").list.must_equal [
-            MediaType.new('text', 'html', params: { 'level' => '1' }),
-            MediaType.new('text', 'html', q: 0.7),
-            MediaType.new('*', '*', q: 0.5),
-            MediaType.new('text', 'html', q: 0.4, params: { 'level' => '2' }),
-            MediaType.new('text', '*', q: 0.3)
-          ]
-        end
+    it "ignores the 'Accept:' prefix" do
+      subject.new('Accept: text/html').list.must_equal [
+        media_type.new('text', 'html')
+      ]
+    end
+
+    it "supports all registered IANA media types" do
+      require 'csv'
+      # https://www.iana.org/assignments/media-types/media-types.xhtml
+      %w[application audio image message model multipart text video].each do |filename|
+        CSV.foreach("spec/support/media_types/#{filename}.csv", headers: true) do |row|
+          media_range = row['Template']
 
-        it "supports all registered IANA media types" do
-          require 'csv'
-          # https://www.iana.org/assignments/media-types/media-types.xhtml
-          %w[application audio image message model multipart text video].each do |filename|
-            CSV.foreach("spec/support/media_types/#{filename}.csv", headers: true) do |row|
-              media_type = row['Template']
-
-              if media_type
-                subject.new(media_type).list.size.must_equal 1
-                subject.new(media_type).list.first.media_range.must_equal media_type.downcase
-              end
-            end
+          if media_range
+            subject.new(media_range).list.size.must_equal 1
+            subject.new(media_range).list.first.media_range.must_equal media_range.downcase
           end
         end
+      end
+    end
 
-        it "sets media type to */* when the accept header is empty" do
-          subject.new('').list.must_equal [
-            MediaType.new('*', '*')
-          ]
-        end
+    it "sets media type to */* when the accept header is empty" do
+      subject.new('').list.must_equal [
+        media_type.new('*', '*')
+      ]
+    end
 
-        it "sets media type to */* when the type is only *" do
-          subject.new('*').list.must_equal [
-            MediaType.new('*', '*')
-          ]
-        end
+    it "sets media type to */* when the type is only *" do
+      subject.new('*').list.must_equal [
+        media_type.new('*', '*')
+      ]
+    end
 
-        it "defaults q to 1 if it's not explicitly specified" do
-          subject.new("text/plain").list.must_equal [
-            MediaType.new('text', 'plain', q: 1.0)
-          ]
-        end
+    it "defaults q to 1 if it's not explicitly specified" do
+      subject.new("text/plain").list.must_equal [
+        media_type.new('text', 'plain', q: 1.0)
+      ]
+    end
 
-        it "strips whitespace from between media types" do
-          subject.new("\ttext/plain\r,\napplication/json\s").list.must_equal [
-            MediaType.new('text', 'plain'),
-            MediaType.new('application', 'json')
-          ]
-        end
+    it "strips whitespace from between media types" do
+      subject.new("\ttext/plain\r,\napplication/json\s").list.must_equal [
+        media_type.new('text', 'plain'),
+        media_type.new('application', 'json')
+      ]
+    end
 
-        it "strips whitespace around q and params" do
-          subject.new("text/plain;\tq\r=\n1, application/json;q=0.8;\slevel\t\t=\r\n1\n").list.must_equal [
-            MediaType.new('text', 'plain'),
-            MediaType.new('application', 'json', q: 0.8, params: { "level" => "1" })
-          ]
-        end
+    it "strips whitespace around q and params" do
+      subject.new("text/plain;\tq\r=\n1, application/json;q=0.8;\slevel\t\t=\r\n1\n").list.must_equal [
+        media_type.new('text', 'plain'),
+        media_type.new('application', 'json', q: 0.8, params: { "level" => "1" })
+      ]
+    end
 
-        it "has a q value of 0.001 when parsed q is invalid" do
-          subject.new("text/plain;q=x").list.must_equal [
-            MediaType.new('text', 'plain', q: 0.001)
-          ]
-        end
+    it "has a q value of 0.001 when parsed q is invalid" do
+      subject.new("text/plain;q=x").list.must_equal [
+        media_type.new('text', 'plain', q: 0.001)
+      ]
+    end
 
-        it "skips invalid media types" do
-          subject.new("text/html, text/plain/omg;q=0.9").list.must_equal [
-            MediaType.new('text', 'html', q: 1)
-          ]
-        end
+    it "parses params with quoted values" do
+      subject.new('text/html;q=1;version="2";level="a;b;cc\'cd", text/html;version=\'1\';level=\'\blah;x;1;;\'').list.must_equal [
+        media_type.new('text', 'html', params: { 'version' => '2', 'level' => 'a;b;cc\'cd'}),
+        media_type.new('text', 'html', params: { 'version' => '1', 'level' => '\'\blah;x;1;;\''})
+      ]
+    end
+
+    it "skips invalid media types" do
+      subject.new("text/html, text/plain/omg;q=0.9").list.must_equal [
+        media_type.new('text', 'html', q: 1)
+      ]
+    end
+  end
+
+  describe "#negotiate" do
+    it "returns a best matching media type" do
+      all_browsers.each do |browser|
+        browser = subject.new(browser[:accept])
+
+        browser.negotiate('text/html').must_equal({
+          supported: 'text/html',
+          matched: media_type.new('text', 'html')
+        })
+
+        browser.negotiate(['text/html', 'application/xhtml+xml']).must_equal({
+          supported: 'text/html',
+          matched: media_type.new('text', 'html')
+        })
+
+        browser.negotiate(['application/xhtml+xml', 'application/json']).must_equal({
+          supported: 'application/xhtml+xml',
+          matched: media_type.new('application', 'xhtml+xml')
+        })
       end
 
-      describe "#negotiate" do
-        it "returns a best matching media type" do
-          n = subject.new("text/*, text/html, text/html;level=1, */*")
-          n.negotiate("text/html").must_equal MediaType.new('text', 'html', params: { 'level' => '1' })
-        end
+      [chrome, firefox, safari].each do| browser|
+        browser = subject.new(browser[:accept])
+
+        browser.negotiate(['application/xml']).must_equal({
+          supported: 'application/xml',
+          matched: media_type.new('application', 'xml', q: 0.9)
+        })
+
+        browser.negotiate(['application/json']).must_equal({
+          supported: 'application/json',
+          matched: media_type.new('*', '*', q: 0.8)
+        })
       end
 
-      describe "#accept?" do
-        it "returns whether specific media type is accepted" do
-          n = subject.new("video/*, text/html, text/html;level=1;q:0.8")
-          n.accept?("text/html").must_equal true
-          n.accept?("application/json").must_equal false
-          n.accept?("video/ogg").must_equal true
-        end
+      api = subject.new('application/json;q=1;version=2,application/json;q=0.9;version=1')
+      api.negotiate('text/html').must_be_nil
+      api.negotiate('application/xml').must_be_nil
+      api.negotiate(['application/xml', 'application/json']).must_equal({
+        supported: 'application/json',
+        matched: media_type.new('application', 'json', params: { 'version' => '2' })
+      })
+
+      q0 = subject.new('application/json,application/xml;q=0')
+      q0.negotiate('application/json').must_equal({
+        supported: 'application/json',
+        matched: media_type.new('application', 'json')
+      })
+      q0.negotiate('application/xml').must_be_nil
+      q0.negotiate(['application/json', 'application/xml']).must_equal({
+        supported: 'application/json',
+        matched: media_type.new('application', 'json')
+      })
+    end
 
-        it "returns false if accepted but q=0" do
-          n = subject.new("video/*, text/html;q=0")
-          n.accept?("text/html").must_equal false
-          n.accept?("video/ogg").must_equal true
-        end
-       end
+    it "rejects matching q=0 even if it matches media ranges where q > 0" do
+      n = subject.new('application/xml;q=0;*/*')
+      n.negotiate('application/xml').must_be_nil
+
+      n2 = subject.new('application/xml;q=0;application/xml;q=1')
+      n2.negotiate('application/xml').must_be_nil
+    end
+  end
+
+  describe "#accept?" do
+    it "returns whether specific media type is accepted" do
+      n = subject.new('video/*, text/html, text/html;level=1;q:0.8')
+      n.accept?('text/html').must_equal true
+      n.accept?('application/json').must_equal false
+      n.accept?('video/ogg').must_equal true
+      n.accept?(['text/html','application/json']).must_equal true
+      n.accept?(['application/xml','application/json']).must_equal false
+    end
+
+    it "returns false if accepted but q=0" do
+      n = subject.new('video/*, text/html;q=0')
+      n.accept?('text/html').must_equal false
+      n.accept?('video/ogg').must_equal true
+    end
+
+    it "returns false when q=0 even if it matches media ranges where q > 0" do
+      n = subject.new('application/xml;q=0;*/*')
+      n.accept?('application/xml').must_equal false
+
+      n2 = subject.new('application/xml;q=0;application/xml;q=1')
+      n2.accept?('application/xml').must_equal false
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -19,3 +19,33 @@ require "awesome_print"
 require "pry"
 
 require_relative "../lib/accept_headers"
+
+class Minitest::Spec
+  def chrome
+    {
+      accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8'
+    }
+  end
+
+  def firefox
+    {
+      accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'
+    }
+  end
+
+  def safari
+    {
+      accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'
+    }
+  end
+
+  def ie
+    {
+      accept: 'text/html, application/xhtml+xml, */*'
+    }
+  end
+
+  def all_browsers
+    [chrome, firefox, safari, ie]
+  end
+end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: accept_headers
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.4'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A ruby library that does content negotiation and parses and sorts http
@@ -88,8 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -135,17 +135,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A ruby library that does content negotiation and parses and sorts http accept