accept_headers 0.0.1 → 0.0.2

data/lib/accept_headers/language/negotiator.rb

@@ -0,0 +1,37 @@
+require "accept_headers/language"
+require "accept_headers/negotiatable"
+
+module AcceptHeaders
+  class Language
+    class Negotiator
+      include Negotiatable
+
+      LANGUAGE_PATTERN = /^\s*(?<primary_tag>[\w]{1,8}|\*)(?:\s*\-\s*(?<subtag>[\w]{1,8}|\*))?\s*$/
+
+      private
+      def parse(original_header)
+        header = original_header.dup
+        header.sub!(/\AAccept-Language:\s*/, '')
+        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_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 }
+      end
+    end
+  end
+end

data/lib/accept_headers/media_type.rb

@@ -70,45 +70,16 @@ module AcceptHeaders
       string
     end
 
-    MEDIA_TYPE_PATTERN = /^\s*(?<type>[\w!#$%^&*\-\+{}\\|'.`~]+)(?:\s*\/\s*(?<subtype>[\w!#$%^&*\-\+{}\\|'.`~]+))?\s*$/
-    PARAM_PATTERN = /(?<attribute>[\w!#$%^&*\-\+{}\\|'.`~]+)\s*\=\s*(?:\"(?<value>[^"]*)\"|\'(?<value>[^']*)\'|(?<value>[\w!#$%^&*\-\+{}\\|\'.`~]*))/
-
-    def self.parse(original_header)
-      header = original_header.dup
-      header.sub!(/\AAccept:\s*/, '')
-      header.strip!
-      return [MediaType.new] if header.empty?
-      media_types = []
-      header.split(',').each do |entry|
-        accept_media_range, accept_params = entry.split(';', 2)
-        next if accept_media_range.nil?
-        media_range = 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_params),
-            params: parse_params(accept_params)
-          )
-        rescue Error
-          next
-        end
-      end
-      media_types.sort! { |x,y| y <=> x }
-    end
-
-    private
-
-    def self.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
+    def match(other)
+      if type == other.type && subtype == other.subtype
+        true
+      elsif type == other.type && subtype == '*'
+        true
+      elsif other.type == '*' && other.subtype == '*'
+        true
+      else
+        false
       end
-      params.delete('q')
-      params
     end
   end
 end

data/lib/accept_headers/media_type/negotiator.rb

@@ -0,0 +1,50 @@
+require "accept_headers/media_type"
+require "accept_headers/negotiatable"
+
+module AcceptHeaders
+  class MediaType
+    class Negotiator
+      include Negotiatable
+
+      private
+      MEDIA_TYPE_PATTERN = /^\s*(?<type>[\w!#$%^&*\-\+{}\\|'.`~]+)(?:\s*\/\s*(?<subtype>[\w!#$%^&*\-\+{}\\|'.`~]+))?\s*$/
+      PARAM_PATTERN = /(?<attribute>[\w!#$%^&*\-\+{}\\|'.`~]+)\s*\=\s*(?:\"(?<value>[^"]*)\"|\'(?<value>[^']*)\'|(?<value>[\w!#$%^&*\-\+{}\\|\'.`~]*))/
+
+      def parse(original_header)
+        header = original_header.dup
+        header.sub!(/\AAccept:\s*/, '')
+        header.strip!
+        return [MediaType.new] if header.empty?
+        media_types = []
+        header.split(',').each do |entry|
+          accept_media_range, accept_params = entry.split(';', 2)
+          next if accept_media_range.nil?
+          media_range = 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_params),
+              params: parse_params(accept_params)
+            )
+          rescue Error
+            next
+          end
+        end
+        media_types.sort! { |x,y| y <=> x }
+      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
+        end
+        params.delete('q')
+        params
+      end
+    end
+  end
+end

data/lib/accept_headers/negotiatable.rb

@@ -0,0 +1,54 @@
+module AcceptHeaders
+  module Negotiatable
+    class Error < StandardError; end
+    class ParseError < Error; end
+
+    TOKEN_PATTERN = /^\s*(?<token>[\w!#$%^&*\-\+{}\\|'.`~]+)\s*$/
+    Q_PATTERN = /(?:\A|;)\s*(?<exists>qs*\=)\s*(?:(?<q>0\.\d{1,3}|[01])|(?:[^;]*))\s*(?:\z|;)/
+
+    attr_reader :list
+
+    def initialize(header)
+      @list = parse(header)
+    end
+
+    def negotiate(supported_string)
+      supported = parse(supported_string)
+      return nil if @list.empty?
+      rejects, acceptable = @list.partition { |m| m.q == 0.0 }
+      rejects.each do |reject|
+        supported.each do |support|
+          if support.match(reject)
+            return nil
+          end
+        end
+      end
+      acceptable.sort { |x,y| y <=> x }.each do |accepted|
+        supported.each do |support|
+          if support.match(accepted)
+            return accepted
+          end
+        end
+      end
+    end
+
+    private
+    def parse(header)
+      raise NotImplementedError.new("#parse(header) is not implemented")
+    end
+
+    def parse_q(header)
+      q = 1
+      return q unless header
+      q_match = Q_PATTERN.match(header)
+      if q_match && q_match[:exists]
+        if q_match[:q]
+          q = q_match[:q]
+        else
+          q = 0.001
+        end
+      end
+      q
+    end
+  end
+end

data/lib/accept_headers/version.rb

@@ -1,3 +1,3 @@
 module AcceptHeaders
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/charset/negotiator_spec.rb

@@ -0,0 +1,73 @@
+require_relative "../spec_helper"
+
+module AcceptHeaders
+  class Charset
+    describe Negotiator do
+      subject do
+        AcceptHeaders::Charset::Negotiator
+      end
+
+      describe "parsing an accept header" do
+        it "returns a sorted array of charsets" do
+          subject.new("*; q=0.2, unicode-1-1").list.must_equal [
+            Charset.new('unicode-1-1'),
+            Charset.new('*', q: 0.2)
+          ]
+
+          subject.new("us-ascii; q=0.5, iso-8859-1, utf-8; q=0.8, macintosh").list.must_equal [
+            Charset.new('iso-8859-1'),
+            Charset.new('macintosh'),
+            Charset.new('utf-8', q: 0.8),
+            Charset.new('us-ascii', q: 0.5)
+          ]
+        end
+
+        it "sets charset to * when the accept-charset header is empty" do
+          subject.new('').list.must_equal [
+            Charset.new('*')
+          ]
+        end
+
+        it "defaults q to 1 if it's not explicitly specified" do
+          subject.new("iso-8859-1").list.must_equal [
+            Charset.new('iso-8859-1', q: 1.0)
+          ]
+        end
+
+        it "strips whitespace from between charsets" do
+          subject.new("\tunicode-1-1\r,\niso-8859-1\s").list.must_equal [
+            Charset.new('unicode-1-1'),
+            Charset.new('iso-8859-1')
+          ]
+        end
+
+        it "strips whitespace around q" do
+          subject.new("iso-8859-1;\tq\r=\n1, unicode-1-1;q=0.8\n").list.must_equal [
+            Charset.new('iso-8859-1'),
+            Charset.new('unicode-1-1', q: 0.8)
+          ]
+        end
+
+        it "has a q value of 0.001 when parsed q is invalid" do
+          subject.new("iso-8859-1;q=x").list.must_equal [
+            Charset.new('iso-8859-1', q: 0.001)
+          ]
+        end
+
+        it "skips invalid character sets" do
+          subject.new("iso-8859-1, @unicode-1-1").list.must_equal [
+            Charset.new('iso-8859-1', q: 1)
+          ]
+        end
+      end
+
+      describe "negotiate supported charsets" do
+        it "returns a best matching charset" do
+          match = Charset.new('iso-8859-1')
+          n = subject.new('us-ascii; q=0.5, iso-8859-1, utf-8; q=0.8, macintosh')
+          n.negotiate('iso-8859-1').must_equal match
+        end
+      end
+    end
+  end
+end

data/spec/charset_spec.rb

@@ -34,11 +34,11 @@ module AcceptHeaders
       subject.new('iso-8859-1', q: '1')
     end
 
-    it "raises an OutOfRangeError unless q value is between 0 and 1" do
+    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('iso-8859-1', q: q)
-        end.must_raise Charset::OutOfRangeError
+        end.must_raise Charset::InvalidQError
 
         e.message.must_equal "q must be between 0 and 1"
       end
@@ -47,10 +47,10 @@ module AcceptHeaders
       subject.new('unicode-1-1', q: 0)
     end
 
-    it "raises an InvalidPrecisionError if q has more than a precision of 3" do
+    it "raises an InvalidQError if q has more than a precision of 3" do
       e = -> do
         subject.new('iso-8859-1', q: 0.1234)
-      end.must_raise Charset::InvalidPrecisionError
+      end.must_raise Charset::InvalidQError
 
       e.message.must_equal "q must be at most 3 decimal places"
 
@@ -68,59 +68,5 @@ module AcceptHeaders
       s = subject.new('iso-8859-1', q: 0.9).to_s
       s.must_equal "iso-8859-1;q=0.9"
     end
-
-    describe "parsing an accept header" do
-      it "returns a sorted array of charsets" do
-        subject.parse("*; q=0.2, unicode-1-1").must_equal [
-          Charset.new('unicode-1-1'),
-          Charset.new('*', q: 0.2)
-        ]
-
-        subject.parse("us-ascii; q=0.5, iso-8859-1, utf-8; q=0.8, macintosh").must_equal [
-          Charset.new('iso-8859-1'),
-          Charset.new('macintosh'),
-          Charset.new('utf-8', q: 0.8),
-          Charset.new('us-ascii', q: 0.5)
-        ]
-      end
-
-      it "sets charset to * when the accept-charset header is empty" do
-        subject.parse('').must_equal [
-          Charset.new('*')
-        ]
-      end
-
-      it "defaults q to 1 if it's not explicitly specified" do
-        subject.parse("iso-8859-1").must_equal [
-          Charset.new('iso-8859-1', q: 1.0)
-        ]
-      end
-
-      it "strips whitespace from between charsets" do
-        subject.parse("\tunicode-1-1\r,\niso-8859-1\s").must_equal [
-          Charset.new('unicode-1-1'),
-          Charset.new('iso-8859-1')
-        ]
-      end
-
-      it "strips whitespace around q" do
-        subject.parse("iso-8859-1;\tq\r=\n1, unicode-1-1;q=0.8\n").must_equal [
-          Charset.new('iso-8859-1'),
-          Charset.new('unicode-1-1', q: 0.8)
-        ]
-      end
-
-      it "has a q value of 0.001 when parsed q is invalid" do
-        subject.parse("iso-8859-1;q=x").must_equal [
-          Charset.new('iso-8859-1', q: 0.001)
-        ]
-      end
-
-      it "skips invalid character sets" do
-        subject.parse("iso-8859-1, @unicode-1-1").must_equal [
-          Charset.new('iso-8859-1', q: 1)
-        ]
-      end
-    end
   end
 end

data/spec/encoding/negotiator_spec.rb

@@ -0,0 +1,73 @@
+require_relative "../spec_helper"
+
+module AcceptHeaders
+  class Encoding
+    describe Negotiator do
+      subject do
+        AcceptHeaders::Encoding::Negotiator
+      end
+
+      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
+
+        it "sets encoding to * when the accept-encoding header is empty" do
+          subject.new('').list.must_equal [
+            Encoding.new('*')
+          ]
+        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 from between encodings" do
+          subject.new("\tcompress\r,\ngzip\s").list.must_equal [
+            Encoding.new('compress'),
+            Encoding.new('gzip')
+          ]
+        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 "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 "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
+          match =
+          n = subject.new("deflate; q=0.5, gzip, compress; q=0.8, identity")
+          n.negotiate("identity").must_equal Encoding.new('identity')
+        end
+      end
+    end
+  end
+end

data/spec/encoding_spec.rb

@@ -34,11 +34,11 @@ module AcceptHeaders
       subject.new('gzip', q: '1')
     end
 
-    it "raises an OutOfRangeError unless q value is between 0 and 1" do
+    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::OutOfRangeError
+        end.must_raise Encoding::InvalidQError
 
         e.message.must_equal "q must be between 0 and 1"
       end
@@ -47,10 +47,10 @@ module AcceptHeaders
       subject.new('compress', q: 0)
     end
 
-    it "raises an InvalidPrecisionError if q has more than a precision of 3" do
+    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::InvalidPrecisionError
+      end.must_raise Encoding::InvalidQError
 
       e.message.must_equal "q must be at most 3 decimal places"
 
@@ -68,59 +68,5 @@ module AcceptHeaders
       s = subject.new('gzip', q: 0.9).to_s
       s.must_equal "gzip;q=0.9"
     end
-
-    describe "parsing an accept header" do
-      it "returns a sorted array of encodings" do
-        subject.parse("*; q=0.2, compress").must_equal [
-          Encoding.new('compress'),
-          Encoding.new('*', q: 0.2)
-        ]
-
-        subject.parse("deflate; q=0.5, gzip, compress; q=0.8, identity").must_equal [
-          Encoding.new('gzip'),
-          Encoding.new('identity'),
-          Encoding.new('compress', q: 0.8),
-          Encoding.new('deflate', q: 0.5)
-        ]
-      end
-
-      it "sets encoding to * when the accept-encoding header is empty" do
-        subject.parse('').must_equal [
-          Encoding.new('*')
-        ]
-      end
-
-      it "defaults q to 1 if it's not explicitly specified" do
-        subject.parse("gzip").must_equal [
-          Encoding.new('gzip', q: 1.0)
-        ]
-      end
-
-      it "strips whitespace from between encodings" do
-        subject.parse("\tcompress\r,\ngzip\s").must_equal [
-          Encoding.new('compress'),
-          Encoding.new('gzip')
-        ]
-      end
-
-      it "strips whitespace around q" do
-        subject.parse("gzip;\tq\r=\n1, compress;q=0.8\n").must_equal [
-          Encoding.new('gzip'),
-          Encoding.new('compress', q: 0.8)
-        ]
-      end
-
-      it "has a q value of 0.001 when parsed q is invalid" do
-        subject.parse("gzip;q=x").must_equal [
-          Encoding.new('gzip', q: 0.001)
-        ]
-      end
-
-      it "skips invalid encodings" do
-        subject.parse("gzip, @blah").must_equal [
-          Encoding.new('gzip', q: 1.0)
-        ]
-      end
-    end
   end
 end