accept_headers 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e40f6f21dfdede27f8ec870248f903caa24a8207
-  data.tar.gz: 2a4ce23b83c7a92cbb80fffe73fa81b2eb425fe1
+  metadata.gz: a140173043fff3155b04a77f622823cf12838bc5
+  data.tar.gz: 4dc92d7058528b3a06766be6f0e9a3dfb2408b84
 SHA512:
-  metadata.gz: 5c1c66df7d5771a7a8aaf90a411d74c4e3e8ef7c0bb09e595d7898fbc62dcc42847d17bc8e0e79e3a76b97ddea9c9c2c23d18983c2a14c7f0e8db64c30f823cd
-  data.tar.gz: 7b6d214b3c465b5eccb5bb441cdecec1e5e0290596ecd81684d779b896cba6fcccc786ff8dc9394f35a020226e59227598fc315ea28ef52c9d6ab6da7f2660b7
+  metadata.gz: 597d9faad4500046b88f07648c1372120a3c008734c7f100a098c7d2ecc568ec4bb335c1a2d94708729ef0669247a136be62491680655e52bbaae5b22155f13c
+  data.tar.gz: 008ad53a88a1bc15b33564dc68361e116aa19c432ccf09c49529773ca293cb2f5fc7e8804562b594d5a801e2c90750ada349ba74029bf5c27335ee743b5bae02

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3 / November 15, 2014
+
+  * Remove `Accept-Charset` support since it's obsolete.
+
 ## 0.2 / November 15, 2014
 
   * Add `Negotiator`s which can parse and find the best match.

data/README.md

@@ -9,9 +9,9 @@
 Some features of the library are:
 
   * Strict adherence to [RFC 2616][rfc], specifically [section 14][rfc-sec14]
-  * Full support for the [Accept][rfc-sec14-1], [Accept-Charset][rfc-sec14-2],
-    [Accept-Encoding][rfc-sec14-3], and [Accept-Language][rfc-sec14-4] HTTP
-    request headers
+  * 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).
   * 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.
@@ -19,7 +19,6 @@ This library is optimistic when parsing headers. If a specific media type, encod
 [rfc]: http://www.w3.org/Protocols/rfc2616/rfc2616.html
 [rfc-sec14]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
 [rfc-sec14-1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
-[rfc-sec14-2]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2
 [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
 [spec]: http://github.com/kamui/accept_headers/tree/master/spec/
@@ -72,35 +71,6 @@ media_type.negotiate('text/html')
 AcceptHeaders::MediaType.new('text', 'html', params: { 'level' => '1' })
 ```
 
-### Accept-Charset
-
-`AcceptHeader::Charset::Negotiator`:
-
-```ruby
-charsets = AcceptHeaders::Charset::Negotiator.new("us-ascii; q=0.5, iso-8859-1, utf-8; q=0.8, macintosh")
-
-charsets.list
-
-# Returns:
-
-[
-  AcceptHeaders::Charset.new('iso-8859-1'),
-  AcceptHeaders::Charset.new('macintosh'),
-  AcceptHeaders::Charset.new('utf-8', q: 0.8),
-  AcceptHeaders::Charset.new('us-ascii', q: 0.5)
-]
-```
-
-`#negotiate`:
-
-```ruby
-charsets.negotiate('iso-8859-1')
-
-# Returns:
-
-AcceptHeaders::Charset.new('iso-8859-1')
-```
-
 ### Accept-Encoding
 
 `AcceptHeader::Charset::Encoding`:

data/lib/accept_headers.rb

@@ -1,6 +1,4 @@
 require "accept_headers/version"
-require "accept_headers/charset"
-require "accept_headers/charset/negotiator"
 require "accept_headers/encoding"
 require "accept_headers/encoding/negotiator"
 require "accept_headers/media_type"

data/lib/accept_headers/encoding/negotiator.rb

@@ -11,7 +11,7 @@ module AcceptHeaders
         header = original_header.dup
         header.sub!(/\AAccept-Encoding:\s*/, '')
         header.strip!
-        return [Charset.new] if header.empty?
+        return [Encoding.new] if header.empty?
         encodings = []
         header.split(',').each do |entry|
           encoding_arr = entry.split(';', 2)

data/lib/accept_headers/middleware.rb

@@ -0,0 +1,17 @@
+require "accept_headers"
+
+module AcceptHeaders
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env["accept_headers.media_types"] = MediaType::Negotiator.new(env["HTTP_ACCEPT"])
+      env["accept_headers.encodings"] = Encoding::Negotiator.new(env["HTTP_ACCEPT_ENCODING"])
+      env["accept_headers.languages"] = Language::Negotiator.new(env["HTTP_ACCEPT_LANGUAGE"])
+
+      @app.call(env)
+    end
+  end
+end

data/lib/accept_headers/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: accept_headers
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jack Chu
@@ -99,18 +99,15 @@ files:
 - accept_headers.gemspec
 - lib/accept_headers.rb
 - lib/accept_headers/acceptable.rb
-- lib/accept_headers/charset.rb
-- lib/accept_headers/charset/negotiator.rb
 - lib/accept_headers/encoding.rb
 - lib/accept_headers/encoding/negotiator.rb
 - lib/accept_headers/language.rb
 - lib/accept_headers/language/negotiator.rb
 - lib/accept_headers/media_type.rb
 - lib/accept_headers/media_type/negotiator.rb
+- lib/accept_headers/middleware.rb
 - lib/accept_headers/negotiatable.rb
 - lib/accept_headers/version.rb
-- spec/charset/negotiator_spec.rb
-- spec/charset_spec.rb
 - spec/encoding/negotiator_spec.rb
 - spec/encoding_spec.rb
 - spec/language/negotiator_spec.rb
@@ -145,8 +142,6 @@ specification_version: 4
 summary: A ruby library that does content negotiation and parses and sorts http accept
   headers.
 test_files:
-- spec/charset/negotiator_spec.rb
-- spec/charset_spec.rb
 - spec/encoding/negotiator_spec.rb
 - spec/encoding_spec.rb
 - spec/language/negotiator_spec.rb

data/lib/accept_headers/charset.rb

@@ -1,45 +0,0 @@
-require "accept_headers/acceptable"
-
-module AcceptHeaders
-  class Charset
-    include Comparable
-    include Acceptable
-
-    attr_reader :charset
-
-    def initialize(charset = '*', q: 1.0)
-      self.charset = charset
-      self.q = q
-    end
-
-    def <=>(other)
-      q <=> other.q
-    end
-
-    def charset=(value)
-      @charset = value.strip.downcase
-    end
-
-    def to_h
-      {
-        charset: charset,
-        q: q
-      }
-    end
-
-    def to_s
-      qvalue = (q == 0 || q == 1) ? q.to_i : q
-      "#{charset};q=#{qvalue}"
-    end
-
-    def match(other)
-      if charset == other.charset
-        true
-      elsif other.charset == '*'
-        true
-      else
-        false
-      end
-    end
-  end
-end

data/lib/accept_headers/charset/negotiator.rb

@@ -1,27 +0,0 @@
-require "accept_headers/charset"
-require "accept_headers/negotiatable"
-
-module AcceptHeaders
-  class Charset
-    class Negotiator
-      include Negotiatable
-
-      private
-      def parse(original_header)
-        header = original_header.dup
-        header.sub!(/\AAccept-Charset:\s*/, '')
-        header.strip!
-        return [Charset.new('iso-8859-5', q: 1)] if header.empty?
-        charsets = []
-        header.split(',').each do |entry|
-          charset_arr = entry.split(';', 2)
-          next if charset_arr[0].nil?
-          charset = TOKEN_PATTERN.match(charset_arr[0])
-          next if charset.nil?
-          charsets << Charset.new(charset[:token], q: parse_q(charset_arr[1]))
-        end
-        charsets.sort! { |x,y| y <=> x }
-      end
-    end
-  end
-end

data/spec/charset/negotiator_spec.rb

@@ -1,73 +0,0 @@
-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

@@ -1,72 +0,0 @@
-require_relative "spec_helper"
-
-module AcceptHeaders
-  describe Charset do
-    subject do
-      AcceptHeaders::Charset
-    end
-
-    it "defaults charset to *" do
-      subject.new.charset.must_equal '*'
-    end
-
-    it "strips and downcases the charset" do
-      subject.new("\t\nISO-8859-1\s\r").charset.must_equal "iso-8859-1"
-    end
-
-    it "optionally supports a q argument" do
-      subject.new('iso-8859-1', 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 "raises an InvalidQError if q can't be converted to a float" do
-      e = -> do
-        subject.new('iso-8859-1', q: 'a')
-      end.must_raise Charset::InvalidQError
-
-      e.message.must_equal 'invalid value for Float(): "a"'
-
-      subject.new('iso-8859-1', q: '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('iso-8859-1', q: q)
-        end.must_raise Charset::InvalidQError
-
-        e.message.must_equal "q must be between 0 and 1"
-      end
-
-      subject.new('iso-8859-1', q: 1)
-      subject.new('unicode-1-1', q: 0)
-    end
-
-    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::InvalidQError
-
-      e.message.must_equal "q must be at most 3 decimal places"
-
-      subject.new('iso-8859-1', q: 0.123)
-    end
-
-    it "converts to hash" do
-      subject.new('iso-8859-1').to_h.must_equal({
-        charset: 'iso-8859-1',
-        q: 1.0
-      })
-    end
-
-    it "convers to string" do
-      s = subject.new('iso-8859-1', q: 0.9).to_s
-      s.must_equal "iso-8859-1;q=0.9"
-    end
-  end
-end