accept_headers 0.0.1

data/spec/media_type_spec.rb

@@ -0,0 +1,173 @@
+require_relative "spec_helper"
+
+module AcceptHeaders
+  describe MediaType do
+    subject do
+      AcceptHeaders::MediaType
+    end
+
+    it "defaults type to *" do
+      subject.new.type.must_equal '*'
+    end
+
+    it "defaults subtype to *" do
+      subject.new('text').subtype.must_equal '*'
+    end
+
+    it "strips and downcases the type" do
+      subject.new("\t\nTEXt\s\r", '*').type.must_equal "text"
+    end
+
+    it "strips and downcases the subtype" do
+      subject.new("text", "\s\npLAIn\r\t").subtype.must_equal "plain"
+    end
+
+    it "sets subtype to * if value passed in is nil and type is *" do
+      subject.new('*', nil).subtype.must_equal '*'
+    end
+
+    it "strips the keys and values in the params hash" do
+      subject.new('*', '*', params: { "\s\nLEVEL\r\t" => "\t\nX\s\n"}).params['LEVEL'].must_equal 'X'
+    end
+
+    it "optionally supports a q argument" do
+      subject.new('text', 'html', q: 0.8).q.must_equal 0.8
+    end
+
+    it "optionally supports a params argument" do
+      subject.new('text', 'html', params: { 'level' => '1' }).params['level'].must_equal '1'
+    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 subtype then type all other values remaining equal" do
+      subject.new('text', 'html').must_be :>, subject.new('text', '*')
+      subject.new('*', '*').must_be :<, subject.new('text', '*')
+    end
+
+    it "raises an InvalidQError if q can't be converted to a float" do
+      e = -> do
+        subject.new('text', 'html', q: 'a')
+      end.must_raise MediaType::InvalidQError
+
+      e.message.must_equal 'invalid value for Float(): "a"'
+
+      subject.new('text', 'html', q: '1')
+    end
+
+    it "raises an OutOfRangeError 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
+
+        e.message.must_equal "q must be between 0 and 1"
+      end
+
+      subject.new('text', 'html', q: 1)
+      subject.new('text', 'html', q: 0)
+    end
+
+    it "raises an InvalidPrecisionError if q has more than a precision of 3" do
+      e = -> do
+        subject.new('text', 'html', q: 0.1234)
+      end.must_raise MediaType::InvalidPrecisionError
+
+      e.message.must_equal "q must be at most 3 decimal places"
+
+      subject.new('text', 'html', q: 0.123)
+    end
+
+    it "converts to hash" do
+      subject.new('text', 'html').to_h.must_equal({
+        type: 'text',
+        subtype: 'html',
+        q: 1.0,
+        params: {}
+      })
+    end
+
+    it "convers to string" do
+      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

@@ -0,0 +1,21 @@
+require "minitest/autorun"
+require "minitest/focus"
+require "awesome_print"
+require "pry"
+
+if defined?(CodeClimate)
+  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
+end
+
+require_relative "../lib/accept_headers"

data/wercker.yml

@@ -0,0 +1,27 @@
+box: wercker/rvm
+# Build definition
+build:
+    # The steps that will be executed on build
+    # See the Ruby section on the wercker devcenter:
+    # http://devcenter.wercker.com/articles/languages/ruby.html
+    steps:
+        # Uncomment this to force RVM to use a specific Ruby version
+        - rvm-use:
+            version: 2.1.5
+
+        # A step that executes `bundle install` command
+        - bundle-install
+
+        # A custom script step, name value is used in the UI
+        # and the code value contains the command that get executed
+        - script:
+            name: echo ruby information
+            code: |
+                echo "ruby version $(ruby --version) running"
+                echo "from location $(which ruby)"
+                echo -p "gem list: $(gem list)"
+
+        # Add more steps here:
+        - script:
+             name: rake
+             code: bundle exec rake

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: accept_headers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack Chu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library that parses and sorts http accept headers. Adheres to
+  RFC 2616.
+email:
+- kamuigt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- accept_headers.gemspec
+- lib/accept_headers.rb
+- lib/accept_headers/acceptable.rb
+- lib/accept_headers/charset.rb
+- lib/accept_headers/encoding.rb
+- lib/accept_headers/language.rb
+- lib/accept_headers/media_type.rb
+- lib/accept_headers/version.rb
+- spec/charset_spec.rb
+- spec/encoding_spec.rb
+- spec/language_spec.rb
+- spec/media_type_spec.rb
+- spec/spec_helper.rb
+- wercker.yml
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A ruby library that parses and sorts http accept headers.
+test_files:
+- spec/charset_spec.rb
+- spec/encoding_spec.rb
+- spec/language_spec.rb
+- spec/media_type_spec.rb
+- spec/spec_helper.rb