http-accept 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3e639112f0987204fc1c5f221df4a5f5f066742
+  data.tar.gz: 0285743cfe72774a0c92bb7767d5cb0aaf8131c5
+SHA512:
+  metadata.gz: 9e642fbaa9710c53966260df269b7b5c7c21d8b2f702633ab94667c506235656f5a0cdadfc6f3841b35f8cef86b38a5ed6dc4c33c19a19f39943bbae01d563f3
+  data.tar.gz: f0fd1541954d7c65ad388c4e7cb0f7511d2460159281bdbf2273140323cceda56af1a03fe670d8b593a2224400f7895fd6c16db55eff3d79964929c8d7c297ff

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.simplecov

@@ -0,0 +1,9 @@
+
+SimpleCov.start do
+	add_filter "/spec/"
+end
+
+if ENV['TRAVIS']
+	require 'coveralls'
+	Coveralls.wear!
+end

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.3.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in http-accept.gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'http-accept'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install http-accept
+
+## Usage
+
+Here are some examples of how to parse various headers.
+
+### Parsing Accept: headers
+
+	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'}
+
+### Parsing Accept-Language: headers
+
+	languages = HTTP::Accept::Language.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"`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2016, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+	task.rspec_opts = ["--require", "simplecov"] if ENV['COVERAGE']
+end
+
+task :default => :spec

data/http-accept.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http/accept/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "http-accept"
+	spec.version       = HTTP::Accept::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+
+	spec.summary       = %q{Parse Accept and Accept-Language HTTP headers.}
+	spec.homepage      = "https://github.com/ioquatix/http-accept"
+
+	spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	spec.bindir        = "exe"
+	spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1.11"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/http/accept.rb

@@ -0,0 +1,34 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 "http/accept/version"
+
+require_relative 'accept/version'
+
+# Accept: header
+require_relative 'accept/media_types'
+
+# Accept-Language: header
+require_relative 'accept/languages'
+
+module HTTP
+	module Accept
+	end
+end

data/lib/http/accept/languages.rb

@@ -0,0 +1,70 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 'sort'
+
+module HTTP
+	module Accept
+		class Languages
+			LOCALE = /\*|[A-Z]{1,8}(-[A-Z]{1,8})*/i
+			
+			# https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.9
+			QVALUE = /0(\.[0-9]{0,3})?|1(\.[0]{0,3})?/
+			
+			LANGUAGE_RANGE = /(?<locale>#{LOCALE})(;q=(?<q>#{QVALUE}))?/
+			
+			class LanguageRange < Struct.new(:locale, :q)
+				def quality_factor
+					(q || 1.0).to_f
+				end
+				
+				def self.parse(scanner)
+					return to_enum(:parse, scanner) unless block_given?
+					
+					while scanner.scan(LANGUAGE_RANGE)
+						yield self.new(scanner[:locale], scanner[:q])
+						
+						# Are there more?
+						return unless scanner.scan(/\s*,\s*/)
+					end
+					
+					raise ParseError.new("Could not parse entire string!") unless scanner.eos?
+				end
+				
+				# If the user ask for 'en', this satisfies any language that begins with 'en-'
+				def prefix_of? other
+					other.start_with(locale)
+				end
+			end
+			
+			def self.parse(text)
+				scanner = StringScanner.new(text)
+				
+				languages = LanguageRange.parse(scanner)
+				
+				return Sort.by_quality_factor(languages)
+			end
+		end
+	end
+end
+

data/lib/http/accept/media_types.rb

@@ -0,0 +1,77 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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
+		class MediaTypes
+			# According to https://tools.ietf.org/html/rfc7231#section-5.3.2
+			MIME_TYPE = /(#{TOKEN})\/(#{TOKEN})/
+			PARAMETER = /\s*;\s*(?<key>#{TOKEN})=((?<value>#{TOKEN})|(?<quoted_value>#{QUOTED_STRING}))/
+			
+			class MediaRange < Struct.new(:mime_type, :parameters)
+				def quality_factor
+					parameters.fetch('q', 1.0).to_f
+				end
+				
+				def self.parse(scanner)
+					return to_enum(:parse, scanner) unless block_given?
+					
+					while mime_type = scanner.scan(MIME_TYPE)
+						parameters = {}
+						
+						while scanner.scan(PARAMETER)
+							key = scanner[:key]
+							
+							if value = scanner[:value]
+								parameters[key] = value
+							elsif quoted_value = scanner[:quoted_value]
+								parameters[key] = QuotedString.new(quoted_value)
+							else
+								raise ParseError.new("Could not parse parameter!")
+							end
+						end
+						
+						yield self.new(mime_type, parameters)
+						
+						# Are there more?
+						return 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)
+				
+				media_types = MediaRange.parse(scanner)
+				
+				return Sort.by_quality_factor(media_types)
+			end
+		end
+	end
+end
+

data/lib/http/accept/parse_error.rb

@@ -0,0 +1,26 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module HTTP
+	module Accept
+		class ParseError < ArgumentError
+		end
+	end
+end

data/lib/http/accept/quoted_string.rb

@@ -0,0 +1,53 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module HTTP
+	module Accept
+		# According to https://tools.ietf.org/html/rfc7231#appendix-C
+		TOKEN = /[!#$%&'*+\-.^_`|~0-9A-Z]+/i
+		QUOTED_STRING = /"(?:.(?!(?<!\\)"))*.?"/
+		
+		class QuotedString
+			def initialize(value)
+				@value = value
+			end
+			
+			def unquote(normalize_whitespace = false)
+				value = @value[1...-1]
+				
+				value.gsub!(/\\(.)/, '\1') 
+				
+				if normalize_whitespace
+					value = value.gsub!(/[\r\n](\s+)+/, ' ')
+				end
+				
+				return value
+			end
+			
+			def to_str
+				unquote(true)
+			end
+			
+			def to_s
+				to_str
+			end
+		end
+	end
+end

data/lib/http/accept/sort.rb

@@ -0,0 +1,30 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module HTTP
+	module Accept
+		module Sort
+			def self.by_quality_factor(items)
+				# We do this to get a stable sort:
+				items.sort_by.with_index{|object, index| [-object.quality_factor, index]}
+			end
+		end
+	end
+end

data/lib/http/accept/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module HTTP
+	module Accept
+		VERSION = "1.0.0"
+	end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: http-accept
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- http-accept.gemspec
+- lib/http/accept.rb
+- lib/http/accept/languages.rb
+- lib/http/accept/media_types.rb
+- lib/http/accept/parse_error.rb
+- lib/http/accept/quoted_string.rb
+- lib/http/accept/sort.rb
+- lib/http/accept/version.rb
+homepage: https://github.com/ioquatix/http-accept
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Parse Accept and Accept-Language HTTP headers.
+test_files: []