accept_headers 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c59b8c10eea7c406d76ca08d6daf1eb25a92f41
-  data.tar.gz: 76b2194684f98c8812f71e32daf84af838a38faa
+  metadata.gz: b55af3993793d079e27b4b85fd02344b7dbc878b
+  data.tar.gz: 30264067d3cbd349e13169a8592df750c81d06ba
 SHA512:
-  metadata.gz: a3da1d44c7090dcd155f4b6f03e6bb6f40b9292d7bdbd9fee8f77cf7d440a1e8b9e3497f7ee0c42ac229b4377fb0c0b1932afa085f3dc0ca23fa452a82c98361
-  data.tar.gz: af9ead68fe19c681981c4a522b4c73cc166fd2e0e1709677232dd5d2f755b5c61d0bce036da997a218818b42297e2d899fdc1dc5324a30049f740ae4141b80e0
+  metadata.gz: b45c6294fdba63025d7a1fe4d9c860078427d3011b98aa99c8a8b84429fd4454ed18aef2eefdb22d841a32284df4df475449da2787d485b41349b7664b5ca7e1
+  data.tar.gz: 32cbb89fbe0f5b85824a8f8ae9cac9bfa095a5f02de33625511fe7e8c1b8cd5f55de8e6231787dd062f10cfe55e0b409226e2146f7861454ed07952eb8c4dc3f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## HEAD
 
+## 0.0.8 / November 23, 2014
+
+  * Change `#negotiate` to return the type instead of a hash. In the case of `MediaType` it'll also populate `extensions` from the matching accept header media type.
+
 ## 0.0.7 / November 19, 2014
 
   * Rename `MediaType` `params` to `extensions`, since params technically includes the `q` value.

data/README.md

@@ -65,7 +65,7 @@ media_types.list
 ]
 ```
 
-`#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.
+`#negotiate` takes an array of media range strings supported (by your API or route/controller) and returns the best supported `MediaType` and the `extensions` params from the matching internal media type.
 
 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`.
 
@@ -73,12 +73,9 @@ This will first check the available list for any matching media types with a `q`
 # The same media_types variable as above
 media_types.negotiate(['text/html', 'text/plain'])
 
-# Returns:
+# Returns this equivalent:
 
-{
-  supported: 'text/html',
-  matched:    AcceptHeaders::MediaType.new('text', 'html', q: 1, extensions: { 'level' => '1' })
-}
+AcceptHeader::MediaType.new('text', 'html', 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.
@@ -88,7 +85,7 @@ versions_header = 'Accept: application/json;version=2,application/json;version=1
 media_types = AcceptHeaders::MediaType::Negotiator.new(versions_header)
 
 m = media_types.negotiate('application/json')
-puts m[:match].extensions['version'] # returns '2'
+puts m.extensions['version'] # returns '2'
 ```
 
 `#accept?`:
@@ -121,12 +118,9 @@ encodings.list
 ```ruby
 encodings.negotiate(['gzip', 'compress'])
 
-# Returns:
+# Returns this equivalent:
 
-{
-  supported: 'gzip',
-  matched:    AcceptHeaders::Encoding.new('gzip'))
-}
+AcceptHeader::Encoding.new('gzip')
 ```
 
 `#accept?`:
@@ -163,12 +157,9 @@ languages.list
 ```ruby
 languages.negotiate(['en-us', 'zh-Hant'])
 
-# Returns:
+# Returns this equivalent:
 
-{
-  supported: 'en-us',
-  matched:    AcceptHeaders::Language.new('en', 'us'))
-}
+AcceptHeaders::Language.new('en', 'us')
 ```
 
 `#accept?`:

data/lib/accept_headers/encoding.rb

@@ -7,8 +7,6 @@ module AcceptHeaders
 
     attr_reader :encoding
 
-    ENCODING_PATTERN = /^\s*(?<encoding>[\w!#$%^&*\-\+{}\\|'.`~]+)\s*$/
-
     def initialize(encoding = '*', q: 1.0)
       self.encoding = encoding
       self.q = q
@@ -35,7 +33,7 @@ module AcceptHeaders
     end
 
     def match(encoding_string)
-      match_data = ENCODING_PATTERN.match(encoding_string)
+      match_data = Negotiator::ENCODING_PATTERN.match(encoding_string)
       if !match_data
         false
       elsif encoding == match_data[:encoding]

data/lib/accept_headers/encoding/negotiator.rb

@@ -6,21 +6,32 @@ module AcceptHeaders
     class Negotiator
       include Negotiatable
 
+      ENCODING_PATTERN = /^\s*(?<encoding>[\w!#$%^&*\-\+{}\\|'.`~]+)\s*$/
+      HEADER_PREFIX = 'Accept-Encoding:'
+
+      def negotiate(supported)
+        support, match = super(supported)
+        return nil if support.nil? && match.nil?
+        begin
+          return parse(support).first
+        rescue Encoding::Error
+          return nil
+        end
+      end
+
       private
-      def parse(original_header)
-        header = original_header.dup
-        header.sub!(/\AAccept-Encoding:\s*/, '')
+      def no_header
+        [Encoding.new]
+      end
+
+      def parse_item(header)
+        return nil if header.nil?
         header.strip!
-        return [Encoding.new] if header.empty?
-        encodings = []
-        header.split(',').each do |entry|
-          encoding_arr = entry.split(';', 2)
-          next if encoding_arr[0].nil?
-          encoding = Encoding::ENCODING_PATTERN.match(encoding_arr[0])
-          next if encoding.nil?
-          encodings << Encoding.new(encoding[:encoding], q: parse_q(encoding_arr[1]))
-        end
-        encodings.sort! { |x,y| y <=> x }
+        encoding_string, q_string = header.split(';', 2)
+        raise Error if encoding_string.nil?
+        encoding = ENCODING_PATTERN.match(encoding_string)
+        raise Error if encoding.nil?
+        Encoding.new(encoding[:encoding], q: parse_q(q_string))
       end
     end
   end

data/lib/accept_headers/language.rb

@@ -7,8 +7,6 @@ module AcceptHeaders
 
     attr_reader :primary_tag, :subtag
 
-    LANGUAGE_TAG_PATTERN = /^\s*(?<primary_tag>[\w]{1,8}|\*)(?:\s*\-\s*(?<subtag>[\w]{1,8}|\*))?\s*$/
-
     def initialize(primary_tag = '*', subtag = nil, q: 1.0)
       self.primary_tag = primary_tag
       self.subtag = subtag
@@ -63,7 +61,7 @@ module AcceptHeaders
     end
 
     def match(language_tag_string)
-      match_data = LANGUAGE_TAG_PATTERN.match(language_tag_string)
+      match_data = Negotiator::LANGUAGE_TAG_PATTERN.match(language_tag_string)
       if !match_data
         false
       elsif primary_tag == match_data[:primary_tag] && subtag == match_data[:subtag]

data/lib/accept_headers/language/negotiator.rb

@@ -6,29 +6,36 @@ module AcceptHeaders
     class Negotiator
       include Negotiatable
 
+      LANGUAGE_TAG_PATTERN = /^\s*(?<primary_tag>[\w]{1,8}|\*)(?:\s*\-\s*(?<subtag>[\w]{1,8}|\*))?\s*$/
+      HEADER_PREFIX = 'Accept-Language:'
+
+      def negotiate(supported)
+        support, match = super(supported)
+        return nil if support.nil? && match.nil?
+        begin
+          return parse(support).first
+        rescue Language::Error
+          return nil
+        end
+      end
+
       private
-      def parse(original_header)
-        header = original_header.dup
-        header.sub!(/\AAccept-Language:\s*/, '')
+      def no_header
+        [Language.new]
+      end
+
+      def parse_item(header)
+        return nil if header.nil?
         header.strip!
-        return [Language.new] if header.empty?
-        languages = []
-        header.split(',').each do |entry|
-          language_arr = entry.split(';', 2)
-          next if language_arr[0].nil?
-          language_range = Language::LANGUAGE_TAG_PATTERN.match(language_arr[0])
-          next if language_range.nil?
-          begin
-            languages << Language.new(
-              language_range[:primary_tag],
-              language_range[:subtag],
-              q: parse_q(language_arr[1])
-            )
-          rescue Error
-            next
-          end
-        end
-        languages.sort! { |x,y| y <=> x }
+        language_string, q_string = header.split(';', 2)
+        raise Error if language_string.nil?
+        language_range = LANGUAGE_TAG_PATTERN.match(language_string)
+        raise Error if language_range.nil?
+        Language.new(
+          language_range[:primary_tag],
+          language_range[:subtag],
+          q: parse_q(q_string)
+        )
       end
     end
   end

data/lib/accept_headers/media_type.rb

@@ -7,8 +7,6 @@ module AcceptHeaders
 
     attr_reader :type, :subtype, :extensions
 
-    MEDIA_TYPE_PATTERN = /^\s*(?<type>[\w!#$%^&*\-\+{}\\|'.`~]+)(?:\s*\/\s*(?<subtype>[\w!#$%^&*\-\+{}\\|'.`~]+))?\s*$/
-
     def initialize(type = '*', subtype = '*', q: 1.0, extensions: {})
       self.type = type
       self.subtype = subtype
@@ -77,7 +75,7 @@ module AcceptHeaders
     end
 
     def match(media_range_string)
-      match_data = MEDIA_TYPE_PATTERN.match(media_range_string)
+      match_data = Negotiator::MEDIA_TYPE_PATTERN.match(media_range_string)
       if !match_data
         false
       elsif type == match_data[:type] && subtype == match_data[:subtype]

data/lib/accept_headers/media_type/negotiator.rb

@@ -6,32 +6,40 @@ module AcceptHeaders
     class Negotiator
       include Negotiatable
 
+      MEDIA_TYPE_PATTERN = /^\s*(?<type>[\w!#$%^&*\-\+{}\\|'.`~]+)(?:\s*\/\s*(?<subtype>[\w!#$%^&*\-\+{}\\|'.`~]+))?\s*$/
       PARAMS_PATTERN = /(?<attribute>[\w!#$%^&*\-\+{}\\|'.`~]+)\s*\=\s*(?:\"(?<value>[^"]*)\"|\'(?<value>[^']*)\'|(?<value>[\w!#$%^&*\-\+{}\\|\'.`~]*))/
+      HEADER_PREFIX = 'Accept:'
+
+      def negotiate(supported)
+        support, match = super(supported)
+        return nil if support.nil? && match.nil?
+        begin
+          media_type = parse(support).first
+          media_type.extensions = match.extensions
+          return media_type
+        rescue MediaType::Error
+          return nil
+        end
+      end
 
       private
-      def parse(original_header)
-        header = original_header.dup
-        header.sub!(/\AAccept:\s*/, '')
+      def no_header
+        [MediaType.new]
+      end
+
+      def parse_item(header)
+        return nil if header.nil?
         header.strip!
-        return [MediaType.new] if header.empty?
-        media_types = []
-        header.split(',').each do |entry|
-          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?
-          begin
-            media_types << MediaType.new(
-              media_range[:type],
-              media_range[:subtype],
-              q: parse_q(accept_extensions),
-              extensions: parse_extensions(accept_extensions)
-            )
-          rescue Error
-            next
-          end
-        end
-        media_types.sort! { |x,y| y <=> x }
+        accept_media_range, accept_extensions = header.split(';', 2)
+        raise Error if accept_media_range.nil?
+        media_range = MEDIA_TYPE_PATTERN.match(accept_media_range)
+        raise Error if media_range.nil?
+        MediaType.new(
+          media_range[:type],
+          media_range[:subtype],
+          q: parse_q(accept_extensions),
+          extensions: parse_extensions(accept_extensions)
+        )
       end
 
       def parse_extensions(extensions_string)

data/lib/accept_headers/negotiatable.rb

@@ -3,10 +3,10 @@ module AcceptHeaders
     class Error < StandardError; end
     class ParseError < Error; end
 
-    Q_PATTERN = /(?:\A|;)\s*(?<exists>qs*\=)\s*(?:(?<q>0\.\d{1,3}|[01])|(?:[^;]*))\s*(?:\z|;)/
-
     attr_reader :list
 
+    Q_PATTERN = /(?:\A|;)\s*(?<exists>qs*\=)\s*(?:(?<q>0\.\d{1,3}|[01])|(?:[^;]*))\s*(?:\z|;)/
+
     def initialize(header)
       @list = parse(header)
     end
@@ -22,7 +22,7 @@ module AcceptHeaders
             if part.q == 0.0
               next
             else
-              return { supported: support, matched: part }
+              return [support, part]
             end
           end
         end
@@ -35,8 +35,30 @@ module AcceptHeaders
     end
 
     private
-    def parse(header)
-      raise NotImplementedError.new("#parse(header) is not implemented")
+    def no_header
+      raise NotImplementedError.new("#no_header is not implemented")
+    end
+
+    def parse_item(entry)
+      raise NotImplementedError.new("#parse_item(entry) is not implemented")
+    end
+
+    def parse(header, &block)
+      header = header.dup
+      header.sub!(/\A#{self.class::HEADER_PREFIX}\s*/, '')
+      header.strip!
+      return no_header if header.empty?
+      list = []
+      header.split(',').each do |entry|
+        begin
+          item = parse_item(entry)
+          next if item.nil?
+          list << item
+        rescue Error
+          next
+        end
+      end
+      list.sort! { |x,y| y <=> x }
     end
 
     def parse_q(header)

data/lib/accept_headers/version.rb

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

data/spec/encoding/negotiator_spec.rb

@@ -80,10 +80,7 @@ describe AcceptHeaders::Encoding::Negotiator do
   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')
-      })
+      n.negotiate(['identity', 'deflate']).must_equal encoding.new('identity')
     end
   end
 end

data/spec/language/negotiator_spec.rb

@@ -73,10 +73,7 @@ describe AcceptHeaders::Language::Negotiator 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
-      })
+      n.negotiate('en-us').must_equal language.new('en', 'us')
     end
   end
 end

data/spec/media_type/negotiator_spec.rb

@@ -111,54 +111,57 @@ describe AcceptHeaders::MediaType::Negotiator 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')
-        })
+        browser.negotiate('text/html').must_equal media_type.new(
+          'text',
+          'html'
+        )
+
+        browser.negotiate(['text/html', 'application/xhtml+xml']).must_equal media_type.new(
+          'text',
+          'html'
+        )
+
+        browser.negotiate(['application/xhtml+xml', 'application/json']).must_equal media_type.new(
+          'application',
+          'xhtml+xml'
+        )
       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/xml']).must_equal media_type.new(
+          'application',
+          'xml'
+        )
 
-        browser.negotiate(['application/json']).must_equal({
-          supported: 'application/json',
-          matched: media_type.new('*', '*', q: 0.8)
-        })
+        browser.negotiate(['application/json']).must_equal media_type.new(
+          'application',
+          'json'
+        )
       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', extensions: { 'version' => '2' })
-      })
+      api.negotiate(['application/xml', 'application/json']).must_equal media_type.new(
+        'application',
+        'json',
+        extensions: {
+          'version' => '1'
+        }
+      )
 
       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/json').must_equal 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')
-      })
+      q0.negotiate(['application/json', 'application/xml']).must_equal media_type.new(
+        'application',
+        'json'
+      )
     end
 
     it "rejects matching q=0 even if it matches media ranges where q > 0" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accept_headers
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler