http-accept 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7447d3a4ffac6d5fe7dfe4343e3a5311ae23cbd
-  data.tar.gz: 76e13950c937a706f2d5e5ddc46ae45120fa3057
+  metadata.gz: 3b3754be244c82ac53b2ab75fcec39f8d34400fc
+  data.tar.gz: ce62525b629b972c86c0073d567fba3e1690f7d1
 SHA512:
-  metadata.gz: 9a606a9271cc042d8b39be14e46b1bb7de7dbf4c07e40b3c12493e81995b9f42852c5b1962ecafc0f181ea38fa9eb8f6a84764e8de34507f462062b0c25bd4d5
-  data.tar.gz: b9a4904c398b22526717c8463d1d6d9cc79e43cf11681bb9cc73901d8909ba3ef45610b4e9879c0913597cd58f0388d88e91b3167b9113136181a377ce207a25
+  metadata.gz: 50a22597751d2dd3ed17ca4da33badae5c15d9941794763aaa199bdaff055b3edd6098cdc7ee6d932e7785069f57473ae054d6cef0a538703de6a245e949d841
+  data.tar.gz: 3955b2cf2ce082c40fbace1a98fba58e62d01efb92f1f5e4f6e07b4ea87fbe79958d0fe7047a90ae871d7b6c5ceb34483bf676e66fa3615cc34bd43e08169da0

data/README.md

@@ -1,8 +1,6 @@
 # HTTP::Accept
 
-Provides a robust set of parsers for dealing with Accept and Accept-Language HTTP headers.
-
-Current `Accept-Encoding:` and `Accept-Charset:` are not supported. This is because they are not particularly useful headers, but PRs are welcome.
+Provides a robust set of parsers for dealing with HTTP `Accept`, `Accept-Language`, `Accept-Encoding`, `Accept-Charset` headers.
 
 [![Build Status](https://secure.travis-ci.org/ioquatix/http-accept.svg)](http://travis-ci.org/ioquatix/http-accept)
 [![Code Climate](https://codeclimate.com/github/ioquatix/http-accept.svg)](https://codeclimate.com/github/ioquatix/http-accept)
@@ -20,7 +18,9 @@ I am concerned about correctness, security and performance. As such, I implement
 
 Add this line to your application's Gemfile:
 
-	gem 'http-accept'
+```ruby
+gem 'http-accept'
+```
 
 And then execute:
 
@@ -38,59 +38,67 @@ Here are some examples of how to parse various headers.
 
 You can parse the incoming `Accept:` header:
 
-	media_types = HTTP::Accept::MediaTypes.parse("text/html;q=0.5, application/json; version=1")
+```ruby
+media_types = HTTP::Accept::MediaTypes.parse("text/html;q=0.5, application/json; version=1")
 
-	expect(media_types[0].mime_type).to be == "application/json"
-	expect(media_types[0].parameters).to be == {'version' => '1'}
-	expect(media_types[1].mime_type).to be == "text/html"
-	expect(media_types[1].parameters).to be == {'q' => '0.5'}
+expect(media_types[0].mime_type).to be == "application/json"
+expect(media_types[0].parameters).to be == {'version' => '1'}
+expect(media_types[1].mime_type).to be == "text/html"
+expect(media_types[1].parameters).to be == {'q' => '0.5'}
+```
 
 Normally, you'd want to match the media types against some set of available mime types:
 
-	module ToJSON
-		def content_type
-			HTTP::Accept::ContentType.new("application/json", charset: 'utf-8')
-		end
-		
-		# Used for inserting into map.
-		def split(*args)
-			content_type.split(*args)
-		end
-		
-		def convert(object, options)
-			object.to_json
-		end
-	end
-	
-	module ToXML
-		# Are you kidding?
-	end
-	
-	map = HTTP::Accept::MediaTypes::Map.new
-	map << ToJSON
-	map << ToXML
-	
-	object, media_range = map.for(media_types)
-	content = object.convert(model, media_range.parameters)
-	response = [200, {'Content-Type' => object.content_type}, [content]]
+```ruby
+module ToJSON
+  def content_type
+    HTTP::Accept::ContentType.new("application/json", charset: 'utf-8')
+  end
+
+  # Used for inserting into map.
+  def split(*args)
+    content_type.split(*args)
+  end
+
+  def convert(object, options)
+    object.to_json
+  end
+end
+
+module ToXML
+  # Are you kidding?
+end
+
+map = HTTP::Accept::MediaTypes::Map.new
+map << ToJSON
+map << ToXML
+
+object, media_range = map.for(media_types)
+content = object.convert(model, media_range.parameters)
+response = [200, {'Content-Type' => object.content_type}, [content]]
+```
 
 ### Parsing Accept-Language: headers
 
 You can parse the incoming `Accept-Language:` header:
 
-	languages = HTTP::Accept::Language.parse("da, en-gb;q=0.8, en;q=0.7")
+```ruby
+languages = HTTP::Accept::Languages.parse("da, en-gb;q=0.8, en;q=0.7")
 
-	expect(languages[0].locale).to be == "da"
-	expect(languages[1].locale).to be == "en-gb"
-	expect(languages[2].locale).to be == "en"
+expect(languages[0].locale).to be == "da"
+expect(languages[1].locale).to be == "en-gb"
+expect(languages[2].locale).to be == "en"
+```
 
 Normally, you'd want to match the languages against some set of available localizations:
 
-	available_localizations = HTTP::Accept::Languages::Locales.new(["en-nz", "en-us"])
-	
-	# Given the languages that the user wants, and the localizations available, compute the set of desired localizations.
-	desired_localizations = available_localizations & languages
-	
+```ruby
+available_localizations = HTTP::Accept::Languages::Locales.new(["en-nz", "en-us"])
+
+# Given the languages that the user wants, and the localizations available, compute the set of desired localizations.
+desired_localizations = available_localizations & languages
+```
+
 The `desired_localizations` in the example above is a subset of `available_localizations`.
 
 `HTTP::Accept::Languages::Locales` provides an efficient data-structure for matching the Accept-Languages header to set of available localizations according to https://tools.ietf.org/html/rfc7231#section-5.3.5 and https://tools.ietf.org/html/rfc4647#section-2.3
@@ -107,7 +115,8 @@ The `desired_localizations` in the example above is a subset of `available_local
 
 Released under the MIT license.
 
-Copyright, 2016, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+Copyright, 2016, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams). 
+Copyright, 2016, by [Matthew Kerwin](http://kerwin.net.au).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/http/accept.rb

@@ -26,6 +26,9 @@ require_relative 'accept/version'
 require_relative 'accept/media_types'
 require_relative 'accept/content_type'
 
+# Accept-Encoding: header
+require_relative 'accept/encodings'
+
 # Accept-Language: header
 require_relative 'accept/languages'
 

data/lib/http/accept/charsets.rb

@@ -0,0 +1,89 @@
+# Copyright (C) 2016, Matthew Kerwin <matthew@kerwin.net.au>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'strscan'
+
+require_relative 'parse_error'
+require_relative 'quoted_string'
+require_relative 'sort'
+
+module HTTP
+	module Accept
+		module Charsets
+			# https://tools.ietf.org/html/rfc7231#section-5.3.1
+			QVALUE = /0(\.[0-9]{0,3})?|1(\.[0]{0,3})?/
+			
+			# https://tools.ietf.org/html/rfc7231#section-5.3.3
+			CHARSETS = /(?<charset>#{TOKEN})(;q=(?<q>#{QVALUE}))?/
+			
+			Charset = Struct.new(:charset, :q) do
+				def quality_factor
+					(q || 1.0).to_f
+				end
+				
+				def self.parse(scanner)
+					return to_enum(:parse, scanner) unless block_given?
+					
+					while scanner.scan(CHARSETS)
+						yield self.new(scanner[:charset], scanner[:q])
+						
+						# Are there more?
+						break unless scanner.scan(/\s*,\s*/)
+					end
+					
+					raise ParseError.new('Could not parse entire string!') unless scanner.eos?
+				end
+			end
+			
+			def self.parse(text)
+				scanner = StringScanner.new(text)
+				
+				charsets = Charset.parse(scanner)
+				
+				return Sort.by_quality_factor(charsets)
+			end
+			
+			HTTP_ACCEPT_CHARSET = 'HTTP_ACCEPT_CHARSET'.freeze
+			WILDCARD_CHARSET = Charset.new('*', nil).freeze
+			
+			# Parse the list of browser preferred charsets and return ordered by priority.
+			def self.browser_preferred_charsets(env)
+				if accept_charsets = env[HTTP_ACCEPT_CHARSET]
+					accept_charsets.strip!
+					
+					if accept_charsets.empty?
+						# https://tools.ietf.org/html/rfc7231#section-5.3.3 :
+						#
+						#    Accept-Charset = 1#( ( charset / "*" ) [ weight ] )
+						#
+						# Because of the `1#` rule, an empty header value is not considered valid.
+						raise ParseError.new('Could not parse entire string!')
+					else
+						return HTTP::Accept::Charsets.parse(accept_charsets)
+					end
+				end
+				
+				# "A request without any Accept-Charset header field implies that the
+				#  user agent will accept any charset in response."
+				return [WILDCARD_CHARSET]
+			end
+		end
+	end
+end

data/lib/http/accept/encodings.rb

@@ -0,0 +1,94 @@
+# Copyright (C) 2016, Matthew Kerwin <matthew@kerwin.net.au>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'strscan'
+
+require_relative 'parse_error'
+require_relative 'quoted_string'
+require_relative 'sort'
+
+module HTTP
+	module Accept
+		module Encodings
+			# https://tools.ietf.org/html/rfc7231#section-5.3.4
+			CONTENT_CODING = TOKEN
+			
+			# https://tools.ietf.org/html/rfc7231#section-5.3.1
+			QVALUE = /0(\.[0-9]{0,3})?|1(\.[0]{0,3})?/
+			
+			CODINGS = /(?<encoding>#{CONTENT_CODING})(;q=(?<q>#{QVALUE}))?/
+			
+			ContentCoding = Struct.new(:encoding, :q) do
+				def quality_factor
+					(q || 1.0).to_f
+				end
+				
+				def self.parse(scanner)
+					return to_enum(:parse, scanner) unless block_given?
+					
+					while scanner.scan(CODINGS)
+						yield self.new(scanner[:encoding], scanner[:q])
+						
+						# Are there more?
+						break unless scanner.scan(/\s*,\s*/)
+					end
+					
+					raise ParseError.new('Could not parse entire string!') unless scanner.eos?
+				end
+			end
+			
+			def self.parse(text)
+				scanner = StringScanner.new(text)
+				
+				encodings = ContentCoding.parse(scanner)
+				
+				return Sort.by_quality_factor(encodings)
+			end
+			
+			HTTP_ACCEPT_ENCODING = 'HTTP_ACCEPT_ENCODING'.freeze
+			WILDCARD_CONTENT_CODING = ContentCoding.new('*', nil).freeze
+			IDENTITY_CONTENT_CODING = ContentCoding.new('identity', nil).freeze
+			
+			# Parse the list of browser preferred content codings and return ordered by priority. If no
+			# `Accept-Encoding:` header is specified, the behaviour is the same as if
+			# `Accept-Encoding: *` was provided, and if a blank `Accept-Encoding:` header value is
+			# specified, the behaviour is the same as if `Accept-Encoding: identity` was provided
+			# (according to RFC).
+			def self.browser_preferred_content_codings(env)
+				if accept_content_codings = env[HTTP_ACCEPT_ENCODING]
+					accept_content_codings.strip!
+					
+					if accept_content_codings.empty?
+						# "An Accept-Encoding header field with a combined field-value that is
+						# empty implies that the user agent does not want any content-coding in
+						# response."
+						return [IDENTITY_CONTENT_CODING]
+					else
+						return HTTP::Accept::Encodings.parse(accept_content_codings)
+					end
+				end
+				
+				# "If no Accept-Encoding field is in the request, any content-coding
+				#  is considered acceptable by the user agent."
+				return [WILDCARD_CONTENT_CODING]
+			end
+		end
+	end
+end

data/lib/http/accept/version.rb

@@ -20,6 +20,6 @@
 
 module HTTP
 	module Accept
-		VERSION = "1.6.0"
+		VERSION = "1.7.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-accept
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,7 +68,9 @@ files:
 - Rakefile
 - http-accept.gemspec
 - lib/http/accept.rb
+- lib/http/accept/charsets.rb
 - lib/http/accept/content_type.rb
+- lib/http/accept/encodings.rb
 - lib/http/accept/languages.rb
 - lib/http/accept/media_types.rb
 - lib/http/accept/media_types/map.rb
@@ -95,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Parse Accept and Accept-Language HTTP headers.