accept_headers 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b55af3993793d079e27b4b85fd02344b7dbc878b
-  data.tar.gz: 30264067d3cbd349e13169a8592df750c81d06ba
+  metadata.gz: 28f7499031d0c1e01152c3d059446928393d03e9
+  data.tar.gz: 2b2f7c553ed27941005df86490e53364c6037098
 SHA512:
-  metadata.gz: b45c6294fdba63025d7a1fe4d9c860078427d3011b98aa99c8a8b84429fd4454ed18aef2eefdb22d841a32284df4df475449da2787d485b41349b7664b5ca7e1
-  data.tar.gz: 32cbb89fbe0f5b85824a8f8ae9cac9bfa095a5f02de33625511fe7e8c1b8cd5f55de8e6231787dd062f10cfe55e0b409226e2146f7861454ed07952eb8c4dc3f
+  metadata.gz: 3632e3031010af9c2938a49dd71e6461d8ba6d4efb442b04c6146146a2a64a4051a46da92a3e12e1c2ffec1a67cba66b8b1959a65d9d4417e643955f09d8e57d
+  data.tar.gz: 7b2c81b0d7614051d15cd760a95b8489efcc5509ac775dcacd45a71a5e1e0d9e5efc47385ab390eae5f3f037e5421798d0935296e4c7ff63035e2e5948de164b

data/.travis.yml

@@ -1,16 +1,17 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.5
+  - 2.2.6
+  - 2.3.3
   - rbx
   - ruby-head
   - jruby-head
 
 matrix:
   allow_failures:
+    - rvm: rbx
     - rvm: ruby-head
     - rvm: jruby-head
 
 addons:
   code_climate:
-    repo_token: 50c636c924d1aa253e29c57822931c1a172cd65675ad66396bba39d255373a58
+    repo_token: 50c636c924d1aa253e29c57822931c1a172cd65675ad66396bba39d255373a58

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## HEAD
 
+## 0.0.9 / December 1, 2016
+
+  * Require ruby 2.2 minimum.
+  * Add `#to_s` method for all Negotiators
+  * Return no header if parse header is nil
+  * First attempt at rack middleware with simple specs.
+
 ## 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.

data/Gemfile

@@ -4,7 +4,6 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem "ruby_gntp"
   gem "minitest-focus"
   gem "codeclimate-test-reporter", require: false
   gem "simplecov", require: false
@@ -13,4 +12,5 @@ end
 group :development, :test do
   gem "pry"
   gem "awesome_print"
+  gem "rack-test"
 end

data/README.md

@@ -168,11 +168,50 @@ AcceptHeaders::Language.new('en', 'us')
 languages.accept?('en-gb') # true
 ```
 
-## TODO
+## Rack Middleware
 
-* Write rack middleware
-* More edge case tests
-* Add rdoc
+Add the middleware:
+
+```ruby
+require 'accept_headers/middleware'
+use AcceptHeaders::Middleware
+run YourApp
+```
+
+Simple way to set the content response headers based on the request accept headers and the supported media types, encodings, and languages provided by the app or route.
+
+```ruby
+class YourApp
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    # List your arrays of supported media types, encodings, languages. This can be global or per route/controller
+    supported_media_types = %w[application/json application/xml text/html text/plain]
+    supported_encodings = %w[gzip identify]
+    supported_languages = %w[en-US en-GB]
+
+    # Call the Negotiators and pass in the supported arrays and it'll return the best match
+    matched_media_type = env["accept_headers.media_types"].negotiate(supported_media_types)
+    matched_encoding = env["accept_headers.encodings"].negotiate(supported_encodings)
+    matched_language = env["accept_headers.languages"].negotiate(supported_languages)
+
+    # Set a default, in this case an empty string, in case of a bad header that cannot be parsed
+    # The return value is a MediaType, Encoding, or Language depending on the case:
+    # On MediaType, you can call #type ('text'), #subtype ('html'), #media_range ('text/html') to get the stringified parts
+    # On Encoding, you can call #encoding to get the string encoding ('gzip')
+    # On Language, you can call #primary_tag ('en'), #subtag ('us'), or #language_tag ('en-us')
+    headers = {
+      'Content-Type' => matched_media_type ? matched_media_type.media_range : '',
+      'Content-Encoding' => matched_encoding ? matched_encoding.encoding : '',
+      'Content-Language' => matched_language ? matched_language.language_tag : '',
+    }
+
+    [200, headers, ["Hello World!"]]
+  end
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -5,6 +5,6 @@ task default: :test
 
 Rake::TestTask.new do |t|
   t.libs << "spec"
-  t.test_files = FileList['spec/*_spec.rb']
+  t.test_files = FileList['spec/**/*_spec.rb']
   t.verbose = true
 end

data/accept_headers.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/accept_headers/middleware.rb

@@ -4,6 +4,7 @@ module AcceptHeaders
   class Middleware
     def initialize(app)
       @app = app
+      yield self if block_given?
     end
 
     def call(env)

data/lib/accept_headers/negotiatable.rb

@@ -34,6 +34,10 @@ module AcceptHeaders
       negotiate(other) ? true : false
     end
 
+    def to_s
+      list.join(',')
+    end
+
     private
     def no_header
       raise NotImplementedError.new("#no_header is not implemented")
@@ -44,6 +48,7 @@ module AcceptHeaders
     end
 
     def parse(header, &block)
+      return no_header unless header
       header = header.dup
       header.sub!(/\A#{self.class::HEADER_PREFIX}\s*/, '')
       header.strip!

data/lib/accept_headers/version.rb

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

data/spec/encoding/negotiator_spec.rb

@@ -77,6 +77,12 @@ describe AcceptHeaders::Encoding::Negotiator do
     end
   end
 
+  describe "#to_s" do
+    it "returns a string of each encoding #to_s joined by a comma" do
+      subject.new("compress,gzip;q=0.9").to_s.must_equal "compress;q=1,gzip;q=0.9"
+    end
+  end
+
   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')

data/spec/language/negotiator_spec.rb

@@ -69,6 +69,12 @@ describe AcceptHeaders::Language::Negotiator do
     end
   end
 
+  describe "#to_s" do
+    it "returns a string of each language #to_s joined by a comma" do
+      subject.new("en-us, en-gb;q=0.9").to_s.must_equal "en-us;q=1,en-gb;q=0.9"
+    end
+  end
+
   describe "negotiate supported languages" do
     it "returns a best matching language" do
       match = language.new('en', 'us')

data/spec/media_type/negotiator_spec.rb

@@ -106,6 +106,12 @@ describe AcceptHeaders::MediaType::Negotiator do
     end
   end
 
+  describe "#to_s" do
+    it "returns a string of each media type #to_s joined by a comma" do
+      subject.new("text/html;level=1, text/plain;q=0.9").to_s.must_equal "text/html;q=1;level=1,text/plain;q=0.9"
+    end
+  end
+
   describe "#negotiate" do
     it "returns a best matching media type" do
       all_browsers.each do |browser|

data/spec/middleware_spec.rb

@@ -0,0 +1,64 @@
+require_relative "spec_helper"
+require "accept_headers/middleware"
+require "rack/test"
+
+describe AcceptHeaders::Middleware do
+  subject do
+    AcceptHeaders::Middleware
+  end
+
+  def app(
+    supported_media_types: ['application/json'],
+    supported_encodings: ['identity'],
+    supported_languages: ['en-US']
+  )
+    Rack::Builder.new do
+      use AcceptHeaders::Middleware
+      run ->(env) do
+        matched_media_type = env["accept_headers.media_types"].negotiate(supported_media_types)
+        matched_encoding = env["accept_headers.encodings"].negotiate(supported_encodings)
+        matched_language = env["accept_headers.languages"].negotiate(supported_languages)
+        headers = {
+          'Content-Type' => matched_media_type ? matched_media_type.media_range : '',
+          'Content-Encoding' => matched_encoding ? matched_encoding.encoding : '',
+          'Content-Language' => matched_language ? matched_language.language_tag : '',
+        }
+
+        [ 200, headers, [ '' ] ]
+      end
+    end
+  end
+
+  def responds_with_content_type(accept, supported_media_types, expected_content_type)
+    response = Rack::MockRequest.new(app(supported_media_types: supported_media_types)).get('/', { 'HTTP_ACCEPT' => accept } )
+    response.headers['Content-Type'].must_equal expected_content_type
+  end
+
+  def responds_with_encoding(accept_encoding, supported_encodings, expected_encoding)
+    response = Rack::MockRequest.new(app(supported_encodings: supported_encodings)).get('/', { 'HTTP_ACCEPT_ENCODING' => accept_encoding } )
+    response.headers['Content-Encoding'].must_equal expected_encoding
+  end
+
+  def responds_with_languages(accept_language, supported_languages, expected_language)
+    response = Rack::MockRequest.new(app(supported_languages: supported_languages)).get('/', { 'HTTP_ACCEPT_LANGUAGE' => accept_language } )
+    response.headers['Content-Language'].must_equal expected_language
+  end
+
+  it "reads the accept header" do
+    responds_with_content_type("application/json", ['application/json'], 'application/json')
+    responds_with_content_type("application/json;q=0.9,*/*;q0.8", ['application/json'], 'application/json')
+    responds_with_content_type("application/json/error", ['application/json'], '')
+  end
+
+  it "reads the accept encoding header" do
+    responds_with_encoding("gzip,identity", ['gzip', 'identity'], 'gzip')
+    responds_with_encoding("gzip;q=0.8,identity", ['gzip', 'identity'], 'identity')
+    responds_with_encoding("gzip error", ['gzip'], '')
+  end
+
+  it "reads the accept language header" do
+    responds_with_languages("en-us", ['en-us'], 'en-us')
+    responds_with_languages("en-us;q=1,en-gb;q=0.9,en-*;q=0.8", ['en-us'], 'en-us')
+    responds_with_languages("en/us", ['en-us'], '')
+  end
+end

data/wercker.yml

@@ -7,7 +7,7 @@ build:
     steps:
         # Uncomment this to force RVM to use a specific Ruby version
         - rvm-use:
-            version: 2.1.5
+            version: 2.3.1
 
         # A step that executes `bundle install` command
         - bundle-install
@@ -24,4 +24,4 @@ build:
         # Add more steps here:
         - script:
              name: rake
-             code: bundle exec rake
+             code: bundle exec rake

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accept_headers
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,7 @@ files:
 - spec/language_spec.rb
 - spec/media_type/negotiator_spec.rb
 - spec/media_type_spec.rb
+- spec/middleware_spec.rb
 - spec/spec_helper.rb
 - spec/support/encodings/content-coding.csv
 - spec/support/media_types/application.csv
@@ -137,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A ruby library that does content negotiation and parses and sorts http accept
@@ -157,6 +158,7 @@ test_files:
 - spec/language_spec.rb
 - spec/media_type/negotiator_spec.rb
 - spec/media_type_spec.rb
+- spec/middleware_spec.rb
 - spec/spec_helper.rb
 - spec/support/encodings/content-coding.csv
 - spec/support/media_types/application.csv