HttpHeaders::Accept

Build Status: master Gem Version MIT license

:nut_and_bolt: Utility to parse and sort the "Accept" HTTP Header

Installation

Add this line to your application's Gemfile:

gem 'http_headers-accept'

And then execute:

$ bundle

Or install it yourself as:

$ gem install http_headers-accept

Usage

You can parse the "Accept" header. As per the RFCs, you should really have one (delimited) value but the current implementation accepts an array of values.

require 'http_headers/accept'

parsed = HttpHeaders::Accept.new('application/json, text/html; q=0.8')
parsed.first.to_s
# => 'application/json' 
parsed.last.q
# => 0.8


parsed = HttpHeaders::Accept.new([
  '*/*; q=0.1', 
  'application/json; foo=bar, text/html; q=0.8'
])
parsed.first[:foo]
# => bar
parsed.last.to_s
# => '*/*; q=0.1'

Each parsed entry exposes the following methods:

  • media_type: the parsed media_type
  • q: the quality parameter as float, or 1.0
  • [](parameter): accessor for the parameter; throws if it does not exist
  • to_s: encode back to an entry to be used in a Accept header

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at XPBytes/http_headers-accept.