http-negotiate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd99cf36cd404c834530adbd738b22a485280105cc5e1bc868515f70f08d9549
+  data.tar.gz: aad680c6a7a7f9d627232317b0ef880d801bc65a9dbbf73ff0a9ab2b40c7a005
+SHA512:
+  metadata.gz: 7dad74af3b4900b212d17519fc517d54e4d1b8c3b26d7fe527e35c4296a4c27ac1dc4e5776fdde817922e250190bcec1c0f59db9c3ece17fbee58d29686cc4e0
+  data.tar.gz: e628966125eba4f566a151bf91d77d637097977c71e46f9b0fc7d5c734ebdf70b6b39954e354bbfadd1ab7e5854e4464e54586c4d00bd3b4daa6f2d09219db26

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in http-negotiate.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,53 @@
+# HTTP::Negotiate
+
+This is literally just a port of Gisle Aas's
+[HTTP::Negotiate](https://metacpan.org/pod/HTTP::Negotiate) written in
+Perl, with a couple tiny changes to the interface. The `negotiate`
+method is accessible as either a class method or instance method, so
+you can take your pick of interface.
+
+## Usage
+
+```ruby
+require 'http/negotiate'
+
+# access it as an ordinary function
+HTTP::Negotiate.negotiate request, variants
+
+# ...or include it as an instance method
+class Foo
+  include HTTP::Negotiate
+  
+  # you now have access to #negotiate
+end
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http-negotiate'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install http-negotiate
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at
+[the Github repository](https://github.com/doriantaylor/rb-http-negotiate).
+
+## Copyright & License
+
+©2020 [Dorian Taylor](https://doriantaylor.com/)
+
+This software is provided under
+the [Apache License, 2.0](https://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "http/negotiate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/http-negotiate.gemspec

@@ -0,0 +1,35 @@
+# -*- mode: enh-ruby -*-
+require_relative 'lib/http/negotiate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'http-negotiate'
+  spec.version       = HTTP::Negotiate::VERSION
+  spec.authors       = ['Dorian Taylor']
+  spec.email         = ['code@doriantaylor.com']
+  spec.license       = 'Apache-2.0'
+  spec.homepage      = 'https://github.com/doriantaylor/rb-http-negotiate'
+  spec.summary       = 'An implementation of Gisle Aas\'s HTTP::Negotiate'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is
+  # released. The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # dev/test dependencies
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake',    '~> 13.0'
+  spec.add_development_dependency 'rspec',   '~> 3.9'
+end

data/lib/http-negotiate.rb

@@ -0,0 +1 @@
+require 'http/negotiate'

data/lib/http/negotiate.rb

@@ -0,0 +1,181 @@
+require "http/negotiate/version"
+
+# We are basically copying Gisle Aas' (Perl) HTTP::Negotiate here,
+# with Ruby characteristics.
+module HTTP::Negotiate
+  private
+
+  HEADERS = { type: '' }.merge(
+    %i[charset language encoding].map { |k| [k, ?_ + k.to_s.upcase] }.to_h)
+
+  public
+
+  # The variant mapping takes the following form:
+  # { variant => [weight, type, encoding, charset, language, size] }
+  #
+  # * the variant can be anything, including the actual variant
+  # * the weight is a number between 0 and 1 denoting the initial
+  #   preference for the variant
+  # * type, encoding, charset, language are all strings containing
+  #   their respective standardized tokens (note "encoding" is like
+  #   `gzip`, not like `utf-8`: that's "charset")
+  # * size is the number of bytes
+  #
+  # Returns either the winning variant or all variants if requested,
+  # sorted by the algorithm, or nil or the empty array if none are
+  # selected.
+  #
+  # @param request [Hash,Rack::Request,#env] Anything roughly a hash of headers
+  # @param variants [Hash] the variants, described above
+  # @param all [false, true] whether to return 
+  #
+  def negotiate request, variants, all: false
+    # pull accept headers
+    request = request.env if request.respond_to? :env
+    # this will ensure that the keys will match irrespective of
+    # whether it's passed in as actual http headers or a cgi-like env
+    request = request.transform_keys do |k|
+      if /^Accept(-.+)?$/i.match? k.to_s
+        'HTTP_' + k.to_s.upcase.tr(?-, ?_)
+      else
+        k
+      end
+    end
+
+    # the working set
+    accept = {}
+
+    HEADERS.each do |k, h|
+      if hdr = request["HTTP_ACCEPT#{h}"]
+        defq = 1.0
+        # theoretically you can have quoted-string parameters but we don't care
+        hdr = hdr.dup.gsub(/\s+/, '')
+        accept[k] = hdr.split(/,+/).map do |c|
+          val, *params = c.split(/;+/)
+          params = params.map do |p|
+            k, v = p.split(/=+/, 2)
+            k = k.downcase.to_sym
+            v = v.to_f if v and k == :q 
+            [k, v]
+          end.to_h
+          if params[:q]
+            params[:q] = 1.0 if params[:q] > 1.0
+            params[:q] = 0.0 if params[:q] < 0.0
+          else
+            params[:q] = defq
+            defq -= 0.0001
+          end
+          # none of the accept header contents are case sensitive
+          [val.downcase, params]
+        end.to_h
+      end
+    end
+
+    # check if any of the variants specify a language, since this will
+    # affect the scoring
+    any_lang = variants.values.any? { |v| v[5] }
+
+    # chosen will be { variant => value }
+    scores = {}
+    variants.keys.each do |var|
+      qs, type, encoding, charset, language, size = variants[var]
+      # some defaults
+      qs   ||= 1
+      type ||= ''
+      size ||= 0
+
+      # coerce encoding
+      encoding = encoding.to_s.strip.downcase if encoding
+      # coerce charset
+      charset = charset.to_s.strip.downcase if charset
+      # coerce language to canonical form
+      language = language.to_s.strip.downcase.tr_s '_-', '-' if language
+
+      # calculate encoding quality
+      qe = 1
+      if accept[:encoding] and encoding
+        qe = 0
+        qe = accept[:encoding][encoding][:q] if accept[:encoding][encoding]
+        qe = accept[:encoding][?*][:q] if accept[:encoding][?*] and
+          accept[:encoding][?*][:q] > qe
+      end
+
+      # calculate charset quality
+      qc = 1
+      if accept[:charset] and charset and charset != 'us-ascii'
+        qc = 0
+        qc = accept[:charset][charset][:q] if accept[:charset][charset]
+        qc = accept[:charset][?*][:q] if accept[:charset][?*] and
+          accept[:charset][?*][:q] > qc
+      end
+
+      # calculate the language quality
+      ql = 1
+      if accept[:language] and language
+        ql = 0.001 # initial value is very low but not zero
+        lang = language.split(/-+/)
+        (1..lang.length).to_a.reverse.each do |i|
+          test = lang.slice(0, i).join ?-
+          if accept[:language][test]
+            al = accept[:language][test][:q]
+            if al == 0
+              ql = 0
+              break
+            elsif al > ql
+              ql = al
+            end
+          end
+        end
+        # apparently there is no wildcard for accept-language?
+      elsif accept[:language] and any_lang
+        ql = 0.5
+      end
+
+      # calculate the type quality
+      qt = 1
+      if accept[:type] and type
+        type = type.to_s
+        qt = 0
+        at = {}
+        accept[:type].each do |k, v|
+          maj, min = k.split(/\//)
+          x = at[maj] ||= {}
+          x[min] = v
+        end
+
+        # XXX we do not actually try to do the params this time
+        mt, *params = type.split(/;+/)
+        maj, min    = mt.split(/\/+/)
+        params = params.map { |p| p.split(/=+/, 2) }
+
+        # warn maj.inspect, min.inspect
+
+        # XXX match params at some point
+        if at[maj]
+          if at[maj][min]
+            qt = at[maj][min][:q]
+          elsif at[maj][?*]
+            qt = at[maj][?*][:q]
+          else
+            qt = 0.1
+          end
+        elsif at[?*]
+          # ???
+          qt = at[?*].fetch(?*, { q: 0.1 })[:q]
+        else
+          # ???
+          qt = 0.1
+        end
+
+      end
+
+      scores[var] = qs * qe * qc * ql * qt
+    end
+
+    chosen = scores.sort { |a, b| b.last <=> a.last }.map(&:first)
+    all ? chosen : chosen.first
+  end
+
+  extend self
+end
+

data/lib/http/negotiate/version.rb

@@ -0,0 +1,5 @@
+module HTTP
+  module Negotiate
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: http-negotiate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dorian Taylor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: 
+email:
+- code@doriantaylor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- http-negotiate.gemspec
+- lib/http-negotiate.rb
+- lib/http/negotiate.rb
+- lib/http/negotiate/version.rb
+homepage: https://github.com/doriantaylor/rb-http-negotiate
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/doriantaylor/rb-http-negotiate
+  source_code_uri: https://github.com/doriantaylor/rb-http-negotiate
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: An implementation of Gisle Aas's HTTP::Negotiate
+test_files: []