accept_headers 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f095a96c5f335db2b23047bac10e48fff764b819
-  data.tar.gz: da3121b83be60d9a41dd7bfcf98ca8925e0d80e8
+  metadata.gz: 1c59b8c10eea7c406d76ca08d6daf1eb25a92f41
+  data.tar.gz: 76b2194684f98c8812f71e32daf84af838a38faa
 SHA512:
-  metadata.gz: 9655d4af6bcb6aab678a5bd5e50f4b2ae312a69e08e2ca7ea8e3a0ddaebd28adef3934f22fe4726f9e815dba0dce1400028fa67b9921ac32c2ecdc546b67e6de
-  data.tar.gz: 082959990b7b5d8bea5d0222fba0aa3e23e72b11e42c27812ff1f940178bded01171de8c8246ef6350b17320e19586b275e0b8061d3e625a76556b629ac2825b
+  metadata.gz: a3da1d44c7090dcd155f4b6f03e6bb6f40b9292d7bdbd9fee8f77cf7d440a1e8b9e3497f7ee0c42ac229b4377fb0c0b1932afa085f3dc0ca23fa452a82c98361
+  data.tar.gz: af9ead68fe19c681981c4a522b4c73cc166fd2e0e1709677232dd5d2f755b5c61d0bce036da997a218818b42297e2d899fdc1dc5324a30049f740ae4141b80e0

data/.travis.yml

@@ -10,7 +10,6 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx
 
 addons:
   code_climate:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## HEAD
 
+## 0.0.7 / November 19, 2014
+
+  * Rename `MediaType` `params` to `extensions`, since params technically includes the `q` value.
+  * Support rbx invalid `Float` exception message.
+  * Only strip accept param keys, values can contain white space if quoted.
+
 ## 0.0.6 / November 17, 2014
 
   * Support parsing params with quoted values.

data/README.md

@@ -12,7 +12,7 @@ Some features of the library are:
   * Full support for the [Accept][rfc-sec14-1], [Accept-Encoding][rfc-sec14-3],
     and [Accept-Language][rfc-sec14-4] HTTP request headers
   * `Accept-Charset` is not supported because it's [obsolete](https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation#The_Accept-Charset.3A_header)
-  * Parser tested against all IANA registered [media types][iana-media-types]
+  * Parser tested against all IANA registered [media types][iana-media-types] and [encodings][iana-encodings]
   * A comprehensive [spec suite][spec] that covers many edge cases
 
 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.
@@ -23,6 +23,7 @@ This library is optimistic when parsing headers. If a specific media type, encod
 [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
 [iana-media-types]: https://www.iana.org/assignments/media-types/media-types.xhtml
+[iana-encodings]: https://www.iana.org/assignments/http-parameters/http-parameters.xml#content-coding
 [spec]: http://github.com/kamui/accept_headers/tree/master/spec/
 
 ## Installation
@@ -45,20 +46,21 @@ Or install it yourself as:
 
 ### Accept
 
-`AcceptHeaders::MediaType::Negotiator` is a class that is initialized with an `Accept` header string and will internally store an array of `MediaType`s in descending order according to the spec, which takes into account `q` value, `type`/`subtype` and `params` specificity.
+`AcceptHeaders::MediaType::Negotiator` is a class that is initialized with an `Accept` header string and will internally store an array of `MediaType`s in descending order according to the spec, which takes into account `q` value, `type`/`subtype` and `extensions` specificity.
 
 ```ruby
-media_types = AcceptHeaders::MediaType::Negotiator.new("text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5")
+accept_header = 'Accept: text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5'
+media_types = AcceptHeaders::MediaType::Negotiator.new(accept_header)
 
 media_types.list
 
 # Returns:
 
 [
-  AcceptHeaders::MediaType.new('text', 'html', params: { 'level' => '1' }),
+  AcceptHeaders::MediaType.new('text', 'html', extensions: { 'level' => '1' }),
   AcceptHeaders::MediaType.new('text', 'html', q: 0.7),
   AcceptHeaders::MediaType.new('*', '*', q: 0.5),
-  AcceptHeaders::MediaType.new('text', 'html', q: 0.4, params: { 'level' => '2' }),
+  AcceptHeaders::MediaType.new('text', 'html', q: 0.4, extensions: { 'level' => '2' }),
   AcceptHeaders::MediaType.new('text', '*', q: 0.3)
 ]
 ```
@@ -75,10 +77,20 @@ media_types.negotiate(['text/html', 'text/plain'])
 
 {
   supported: 'text/html',
-  matched:    AcceptHeaders::MediaType.new('text', 'html', q: 1, params: { 'level' => '1' })
+  matched:    AcceptHeaders::MediaType.new('text', 'html', q: 1, extensions: { 'level' => '1' })
 }
 ```
 
+It returns the matching `MediaType`, so you can see which one matched and also access the `extensions` params. For example, if you wanted to put your API version in the extensions, you could then retrieve the value.
+
+```ruby
+versions_header = 'Accept: application/json;version=2,application/json;version=1;q=0.8'
+media_types = AcceptHeaders::MediaType::Negotiator.new(versions_header)
+
+m = media_types.negotiate('application/json')
+puts m[:match].extensions['version'] # returns '2'
+```
+
 `#accept?`:
 
 ```ruby
@@ -90,7 +102,8 @@ media_types.accept?('text/html') # true
 `AcceptHeader::Encoding::Encoding`:
 
 ```ruby
-encodings = AcceptHeaders::Encoding::Negotiator.new("deflate; q=0.5, gzip, compress; q=0.8, identity")
+accept_encoding = 'Accept-Encoding: deflate; q=0.5, gzip, compress; q=0.8, identity'
+encodings = AcceptHeaders::Encoding::Negotiator.new(accept_encoding)
 
 encodings.list
 
@@ -131,7 +144,8 @@ encodings.accept?('identity') # true
 `Accept::Language::Negotiator`:
 
 ```ruby
-languages = AcceptHeaders::Language::Negotiator.new("en-*, en-us, *;q=0.8")
+accept_language = 'Accept-Language: en-*, en-us, *;q=0.8'
+languages = AcceptHeaders::Language::Negotiator.new(accept_language)
 
 languages.list
 

data/lib/accept_headers/language.rb

@@ -5,7 +5,7 @@ module AcceptHeaders
     include Comparable
     include Acceptable
 
-    attr_reader :primary_tag, :subtag, :params
+    attr_reader :primary_tag, :subtag
 
     LANGUAGE_TAG_PATTERN = /^\s*(?<primary_tag>[\w]{1,8}|\*)(?:\s*\-\s*(?<subtag>[\w]{1,8}|\*))?\s*$/
 

data/lib/accept_headers/media_type/negotiator.rb

@@ -6,9 +6,9 @@ module AcceptHeaders
     class Negotiator
       include Negotiatable
 
-      private
-      PARAM_PATTERN = /(?<attribute>[\w!#$%^&*\-\+{}\\|'.`~]+)\s*\=\s*(?:\"(?<value>[^"]*)\"|\'(?<value>[^']*)\'|(?<value>[\w!#$%^&*\-\+{}\\|\'.`~]*))/
+      PARAMS_PATTERN = /(?<attribute>[\w!#$%^&*\-\+{}\\|'.`~]+)\s*\=\s*(?:\"(?<value>[^"]*)\"|\'(?<value>[^']*)\'|(?<value>[\w!#$%^&*\-\+{}\\|\'.`~]*))/
 
+      private
       def parse(original_header)
         header = original_header.dup
         header.sub!(/\AAccept:\s*/, '')
@@ -16,7 +16,7 @@ module AcceptHeaders
         return [MediaType.new] if header.empty?
         media_types = []
         header.split(',').each do |entry|
-          accept_media_range, accept_params = entry.split(';', 2)
+          accept_media_range, accept_extensions = entry.split(';', 2)
           next if accept_media_range.nil?
           media_range = MediaType::MEDIA_TYPE_PATTERN.match(accept_media_range)
           next if media_range.nil?
@@ -24,8 +24,8 @@ module AcceptHeaders
             media_types << MediaType.new(
               media_range[:type],
               media_range[:subtype],
-              q: parse_q(accept_params),
-              params: parse_params(accept_params)
+              q: parse_q(accept_extensions),
+              extensions: parse_extensions(accept_extensions)
             )
           rescue Error
             next
@@ -34,19 +34,19 @@ module AcceptHeaders
         media_types.sort! { |x,y| y <=> x }
       end
 
-      def parse_params(params_string)
-        return {} if !params_string || params_string.empty?
-        if params_string.match(/['"]/)
-          params = params_string.scan(PARAM_PATTERN).map(&:compact).to_h
+      def parse_extensions(extensions_string)
+        return {} if !extensions_string || extensions_string.empty?
+        if extensions_string.match(/['"]/)
+          extensions = extensions_string.scan(PARAMS_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
+          extensions = {}
+          extensions_string.split(';').each do |part|
+            param = PARAMS_PATTERN.match(part)
+            extensions[param[:attribute]] = param[:value] if param
           end
         end
-        params.delete('q')
-        params
+        extensions.delete('q')
+        extensions
       end
     end
   end

data/lib/accept_headers/media_type.rb

@@ -5,15 +5,15 @@ module AcceptHeaders
     include Comparable
     include Acceptable
 
-    attr_reader :type, :subtype, :params
+    attr_reader :type, :subtype, :extensions
 
     MEDIA_TYPE_PATTERN = /^\s*(?<type>[\w!#$%^&*\-\+{}\\|'.`~]+)(?:\s*\/\s*(?<subtype>[\w!#$%^&*\-\+{}\\|'.`~]+))?\s*$/
 
-    def initialize(type = '*', subtype = '*', q: 1.0, params: {})
+    def initialize(type = '*', subtype = '*', q: 1.0, extensions: {})
       self.type = type
       self.subtype = subtype
       self.q = q
-      self.params = params
+      self.extensions = extensions
     end
 
     def <=>(other)
@@ -25,9 +25,9 @@ module AcceptHeaders
         -1
       elsif (type != '*' && other.type == '*') || (subtype != '*' && other.subtype == '*')
         1
-      elsif params.size < other.params.size
+      elsif extensions.size < other.extensions.size
         -1
-      elsif params.size > other.params.size
+      elsif extensions.size > other.extensions.size
         1
       else
         0
@@ -46,12 +46,12 @@ module AcceptHeaders
       end
     end
 
-    def params=(hash)
-      @params = {}
+    def extensions=(hash)
+      @extensions = {}
       hash.each do |k,v|
-        @params[k.strip] = v.strip
+        @extensions[k.strip] = v
       end
-      @params
+      @extensions
     end
 
     def to_h
@@ -59,15 +59,15 @@ module AcceptHeaders
         type: type,
         subtype: subtype,
         q: q,
-        params: params
+        extensions: extensions
       }
     end
 
     def to_s
       qvalue = (q == 0 || q == 1) ? q.to_i : q
       string = "#{media_range};q=#{qvalue}"
-      if params.size > 0
-        params.each { |k, v| string.concat(";#{k}=#{v}") }
+      if extensions.size > 0
+        extensions.each { |k, v| string.concat(";#{k}=#{v}") }
       end
       string
     end

data/lib/accept_headers/version.rb

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

data/spec/encoding_spec.rb

@@ -1,140 +1,146 @@
 require_relative "spec_helper"
 
-module AcceptHeaders
-  describe Encoding do
-    subject do
-      AcceptHeaders::Encoding
-    end
+describe AcceptHeaders::Encoding do
+  subject do
+    AcceptHeaders::Encoding
+  end
 
-    it "defaults encoding to *" do
-      subject.new.encoding.must_equal '*'
-    end
+  it "defaults encoding to *" do
+    subject.new.encoding.must_equal '*'
+  end
 
-    it "strips and downcases the encoding" do
-      subject.new("\t\nGZIP\s\r").encoding.must_equal "gzip"
-    end
+  it "strips and downcases the encoding" do
+    subject.new("\t\nGZIP\s\r").encoding.must_equal "gzip"
+  end
 
-    it "optionally supports a q argument" do
-      subject.new('gzip', q: 0.8).q.must_equal 0.8
-    end
+  it "optionally supports a q argument" do
+    subject.new('gzip', q: 0.8).q.must_equal 0.8
+  end
 
-    it "compares on q value all other values remaining equal" do
-      subject.new(q: 0.514).must_be :>, subject.new(q: 0.1)
-      subject.new(q: 0).must_be :<, subject.new(q: 1)
-      subject.new(q: 0.9).must_equal subject.new(q: 0.9)
-    end
+  it "compares on q value all other values remaining equal" do
+    subject.new(q: 0.514).must_be :>, subject.new(q: 0.1)
+    subject.new(q: 0).must_be :<, subject.new(q: 1)
+    subject.new(q: 0.9).must_equal subject.new(q: 0.9)
+  end
 
-    it "raises an InvalidQError if q can't be converted to a float" do
-      e = -> do
-        subject.new('gzip', q: 'a')
-      end.must_raise Encoding::InvalidQError
+  it "raises an InvalidQError if q can't be converted to a float" do
+    e = -> do
+      subject.new('gzip', q: 'a')
+    end.must_raise AcceptHeaders::Encoding::InvalidQError
+
+    e.message.must_match INVALID_FLOAT_PATTERN
+
+    subject.new('gzip', q: '1')
+  end
 
-      e.message.must_equal 'invalid value for Float(): "a"'
+  it "raises an InvalidQError unless q value is between 0 and 1" do
+    [-1.0, -0.1, 1.1].each do |q|
+      e = -> do
+        subject.new('gzip', q: q)
+      end.must_raise AcceptHeaders::Encoding::InvalidQError
 
-      subject.new('gzip', q: '1')
+      e.message.must_equal "q must be between 0 and 1"
     end
 
-    it "raises an InvalidQError unless q value is between 0 and 1" do
-      [-1.0, -0.1, 1.1].each do |q|
-        e = -> do
-          subject.new('gzip', q: q)
-        end.must_raise Encoding::InvalidQError
+    subject.new('gzip', q: 1)
+    subject.new('compress', q: 0)
+  end
 
-        e.message.must_equal "q must be between 0 and 1"
-      end
+  it "raises an InvalidQError if q has more than a precision of 3" do
+    e = -> do
+      subject.new('gzip', q: 0.1234)
+    end.must_raise AcceptHeaders::Encoding::InvalidQError
 
-      subject.new('gzip', q: 1)
-      subject.new('compress', q: 0)
-    end
+    e.message.must_equal "q must be at most 3 decimal places"
 
-    it "raises an InvalidQError if q has more than a precision of 3" do
-      e = -> do
-        subject.new('gzip', q: 0.1234)
-      end.must_raise Encoding::InvalidQError
+    subject.new('gzip', q: 0.123)
+  end
+
+  it "converts to hash" do
+    subject.new('gzip').to_h.must_equal({
+      encoding: 'gzip',
+      q: 1.0
+    })
+  end
 
-      e.message.must_equal "q must be at most 3 decimal places"
+  it "converts to string" do
+    s = subject.new('gzip', q: 0.9).to_s
+    s.must_equal "gzip;q=0.9"
+  end
 
-      subject.new('gzip', q: 0.123)
+  describe "#accept?" do
+    it "accepted if the encoding is the same" do
+      a = subject.new('gzip')
+      a.accept?('gzip').must_equal true
+      b = subject.new('gzip', q: 0.001)
+      b.accept?('gzip').must_equal true
     end
 
-    it "converts to hash" do
-      subject.new('gzip').to_h.must_equal({
-        encoding: 'gzip',
-        q: 1.0
-      })
+    it "accepted if the encoding is *" do
+      a = subject.new('*')
+      a.accept?('gzip').must_equal true
+      b = subject.new('*', q: 0.1)
+      b.accept?('gzip').must_equal true
     end
 
-    it "converts to string" do
-      s = subject.new('gzip', q: 0.9).to_s
-      s.must_equal "gzip;q=0.9"
+    it "not accepted if the encoding doesn't match" do
+      a = subject.new('gzip')
+      a.accept?('compress').must_equal false
+      b = subject.new('gzip', q: 0.4)
+      b.accept?('compress').must_equal false
     end
 
-    describe "#accept?" do
-      it "accepted if the encoding is the same" do
-        a = subject.new('gzip')
-        a.accept?('gzip').must_equal true
-        b = subject.new('gzip', q: 0.001)
-        b.accept?('gzip').must_equal true
-      end
+    it "not accepted if q is 0" do
+      a = subject.new('gzip', q: 0)
+      a.accept?('gzip').must_equal false
+      b = subject.new('*', q: 0)
+      b.accept?('gzip').must_equal false
+    end
 
-      it "accepted if the encoding is *" do
-        a = subject.new('*')
-        a.accept?('gzip').must_equal true
-        b = subject.new('*', q: 0.1)
-        b.accept?('gzip').must_equal true
+    it "not accepted compared against nil" do
+      subject.new('gzip').accept?(nil).must_equal false
+    end
+
+    # TODO: test *
+    # it "not accepted if..." do
+    #   a = subject.new('gzip')
+    #   a.accept?('*').must_equal true
+    # end
+  end
+
+  describe "#reject?" do
+    describe "given q is 0" do
+      it "rejected if the encoding is the same" do
+        a = subject.new('gzip', q: 0)
+        a.reject?('gzip').must_equal true
       end
 
-      it "not accepted if the encoding doesn't match" do
-        a = subject.new('gzip')
-        a.accept?('compress').must_equal false
-        b = subject.new('gzip', q: 0.4)
-        b.accept?('compress').must_equal false
+      it "rejected if the encoding is *" do
+        a = subject.new('*', q: 0)
+        a.reject?('gzip').must_equal true
       end
 
-      it "not accepted if q is 0" do
+      it "not rejected if the encoding doesn't match" do
         a = subject.new('gzip', q: 0)
-        a.accept?('gzip').must_equal false
-        b = subject.new('*', q: 0)
-        b.accept?('gzip').must_equal false
+        a.reject?('compress').must_equal false
       end
 
       # TODO: test *
-      # it "not accepted if..." do
-      #   a = subject.new('gzip')
-      #   a.accept?('*').must_equal true
+      # it "not rejected if..." do
+      #   a = subject.new('gzip', q: 0)
+      #   a.reject?('*').must_equal true
       # end
     end
 
-    describe "#reject?" do
-      describe "given q is 0" do
-        it "rejected if the encoding is the same" do
-          a = subject.new('gzip', q: 0)
-          a.reject?('gzip').must_equal true
-        end
-
-        it "rejected if the encoding is *" do
-          a = subject.new('*', q: 0)
-          a.reject?('gzip').must_equal true
-        end
-
-        it "not rejected if the encoding doesn't match" do
-          a = subject.new('gzip', q: 0)
-          a.reject?('compress').must_equal false
-        end
-
-        # TODO: test *
-        # it "not rejected if..." do
-        #   a = subject.new('gzip', q: 0)
-        #   a.reject?('*').must_equal true
-        # end
-      end
+    it "not rejected if q > 0" do
+      a = subject.new('gzip', q: 0.001)
+      a.reject?('gzip').must_equal false
+      b = subject.new('*', q: 0.9)
+      b.reject?('gzip').must_equal false
+    end
 
-      it "not rejected if q > 0" do
-        a = subject.new('gzip', q: 0.001)
-        a.reject?('gzip').must_equal false
-        b = subject.new('*', q: 0.9)
-        b.reject?('gzip').must_equal false
-      end
+    it "not rejected compared against nil" do
+      subject.new('gzip').reject?(nil).must_equal false
     end
   end
 end