accept_headers 0.0.1 → 0.0.2

data/spec/language/negotiator_spec.rb

@@ -0,0 +1,78 @@
+require_relative "../spec_helper"
+
+module AcceptHeaders
+  class Language
+    describe Negotiator do
+      subject do
+        AcceptHeaders::Language::Negotiator
+      end
+
+      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
+
+        it "sets media primary tag to */* when the accept header is empty" do
+          subject.new('').list.must_equal [
+            Language.new('*', '*')
+          ]
+        end
+
+        it "sets media primary tag to */* when the primary tag is only *" 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 "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 "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
+
+      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
+    end
+  end
+end

data/spec/language_spec.rb

@@ -51,11 +51,11 @@ module AcceptHeaders
       subject.new('en', 'us', 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('en', 'us', q: q)
-        end.must_raise Language::OutOfRangeError
+        end.must_raise Language::InvalidQError
 
         e.message.must_equal "q must be between 0 and 1"
       end
@@ -64,10 +64,10 @@ module AcceptHeaders
       subject.new('en', 'gb', 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('en', 'us', q: 0.1234)
-      end.must_raise Language::InvalidPrecisionError
+      end.must_raise Language::InvalidQError
 
       e.message.must_equal "q must be at most 3 decimal places"
 
@@ -86,64 +86,5 @@ module AcceptHeaders
       s = subject.new('en', 'us', q: 0.9).to_s
       s.must_equal "en-us;q=0.9"
     end
-
-    describe "parsing an accept header" do
-      it "returns a sorted array of media primary tags" do
-        subject.parse("en-*;q=0.2, en-us").must_equal [
-          Language.new('en', 'us'),
-          Language.new('en', '*', q: 0.2)
-        ]
-
-        subject.parse("en-*, en-us, *;q=0.8").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.parse('').must_equal [
-          Language.new('*', '*')
-        ]
-      end
-
-      it "sets media primary tag to */* when the primary tag is only *" do
-        subject.parse('*').must_equal [
-          Language.new('*', '*')
-        ]
-      end
-
-      it "defaults q to 1 if it's not explicitly specified" do
-        subject.parse("en-us").must_equal [
-          Language.new('en', 'plain', q: 1.0)
-        ]
-      end
-
-      it "strips whitespace from between media primary tags" do
-        subject.parse("\ten-us\r,\nen-gb\s").must_equal [
-          Language.new('en', 'us'),
-          Language.new('en', 'gb')
-        ]
-      end
-
-      it "strips whitespace around q" do
-        subject.parse("en-us;\tq\r=\n1, en-gb").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.parse("en-us;q=x").must_equal [
-          Language.new('en', 'plain', q: 0.001)
-        ]
-      end
-
-      it "skips invalid media primary tags" do
-        subject.parse("en-us, en-us-omg;q=0.9").must_equal [
-          Language.new('en', 'us', q: 1)
-        ]
-      end
-    end
   end
 end

data/spec/media_type/negotiator_spec.rb

@@ -0,0 +1,92 @@
+require_relative "../spec_helper"
+
+module AcceptHeaders
+  class MediaType
+    describe Negotiator do
+      subject do
+        AcceptHeaders::MediaType::Negotiator
+      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 "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 type is only *" do
+          subject.new('*').list.must_equal [
+            MediaType.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 "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 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 "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 "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
+      end
+
+      describe "negotiate supported media types" 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
+      end
+    end
+  end
+end

data/spec/media_type_spec.rb

@@ -59,11 +59,11 @@ module AcceptHeaders
       subject.new('text', 'html', 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('text', 'html', q: q)
-        end.must_raise MediaType::OutOfRangeError
+        end.must_raise MediaType::InvalidQError
 
         e.message.must_equal "q must be between 0 and 1"
       end
@@ -72,10 +72,10 @@ module AcceptHeaders
       subject.new('text', 'html', 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('text', 'html', q: 0.1234)
-      end.must_raise MediaType::InvalidPrecisionError
+      end.must_raise MediaType::InvalidQError
 
       e.message.must_equal "q must be at most 3 decimal places"
 
@@ -95,79 +95,5 @@ module AcceptHeaders
       s = subject.new('text', 'html', q: 0.9, params: { 'level' => '1' }).to_s
       s.must_equal "text/html;q=0.9;level=1"
     end
-
-    describe "parsing an accept header" do
-      it "returns a sorted array of media types" do
-        subject.parse("audio/*; q=0.2, audio/basic").must_equal [
-          MediaType.new('audio', 'basic'),
-          MediaType.new('audio', '*', q: 0.2)
-        ]
-        subject.parse("text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c").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.parse("text/*, text/html, text/html;level=1, */*").must_equal [
-          MediaType.new('text', 'html', params: { 'level' => '1' }),
-          MediaType.new('text', 'html'),
-          MediaType.new('text', '*'),
-          MediaType.new('*', '*')
-        ]
-
-        subject.parse("text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5").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 "sets media type to */* when the accept header is empty" do
-        subject.parse('').must_equal [
-          MediaType.new('*', '*')
-        ]
-      end
-
-      it "sets media type to */* when the type is only *" do
-        subject.parse('*').must_equal [
-          MediaType.new('*', '*')
-        ]
-      end
-
-      it "defaults q to 1 if it's not explicitly specified" do
-        subject.parse("text/plain").must_equal [
-          MediaType.new('text', 'plain', q: 1.0)
-        ]
-      end
-
-      it "strips whitespace from between media types" do
-        subject.parse("\ttext/plain\r,\napplication/json\s").must_equal [
-          MediaType.new('text', 'plain'),
-          MediaType.new('application', 'json')
-        ]
-      end
-
-      it "strips whitespace around q and params" do
-        subject.parse("text/plain;\tq\r=\n1, application/json;q=0.8;\slevel\t\t=\r\n1\n").must_equal [
-          MediaType.new('text', 'plain'),
-          MediaType.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.parse("text/plain;q=x").must_equal [
-          MediaType.new('text', 'plain', q: 0.001)
-        ]
-      end
-
-      it "skips invalid media types" do
-        subject.parse("text/html, text/plain/omg;q=0.9").must_equal [
-          MediaType.new('text', 'html', q: 1)
-        ]
-      end
-    end
   end
 end

data/spec/spec_helper.rb

@@ -1,21 +1,19 @@
 require "minitest/autorun"
 require "minitest/focus"
+require "codeclimate-test-reporter"
+require "simplecov"
 require "awesome_print"
 require "pry"
 
-if defined?(CodeClimate)
-  CodeClimate::TestReporter.configure do |config|
-    config.logger.level = Logger::WARN
-  end
+CodeClimate::TestReporter.configure do |config|
+  config.logger.level = Logger::WARN
+end
 
-  SimpleCov.start do
-    formatter SimpleCov::Formatter::MultiFormatter[
-      SimpleCov::Formatter::HTMLFormatter,
-      CodeClimate::TestReporter::Formatter
-    ]
-  end
-elsif defined?(SimpleCov)
-  SimpleCov.start
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+  ]
 end
 
 require_relative "../lib/accept_headers"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accept_headers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,8 +80,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A ruby library that parses and sorts http accept headers. Adheres to
-  RFC 2616.
+description: a ruby library that does content negotiation and parses and sorts http
+  accept headers. Adheres to RFC 2616.
 email:
 - kamuigt@gmail.com
 executables: []
@@ -100,13 +100,22 @@ files:
 - 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/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
 - spec/language_spec.rb
+- spec/media_type/negotiator_spec.rb
 - spec/media_type_spec.rb
 - spec/spec_helper.rb
 - wercker.yml
@@ -133,10 +142,15 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: A ruby library that parses and sorts http accept headers.
+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
 - spec/language_spec.rb
+- spec/media_type/negotiator_spec.rb
 - spec/media_type_spec.rb
 - spec/spec_helper.rb