http-negotiate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd99cf36cd404c834530adbd738b22a485280105cc5e1bc868515f70f08d9549
-  data.tar.gz: aad680c6a7a7f9d627232317b0ef880d801bc65a9dbbf73ff0a9ab2b40c7a005
+  metadata.gz: 37db2775817222cbcb2d1d27845d37011cfec405d7b8ddc9f0030383bc53264c
+  data.tar.gz: 84e031f85bc9d04b8f1ed52213a0c681e5be4bb638e0ab13881f5320a0ad511a
 SHA512:
-  metadata.gz: 7dad74af3b4900b212d17519fc517d54e4d1b8c3b26d7fe527e35c4296a4c27ac1dc4e5776fdde817922e250190bcec1c0f59db9c3ece17fbee58d29686cc4e0
-  data.tar.gz: e628966125eba4f566a151bf91d77d637097977c71e46f9b0fc7d5c734ebdf70b6b39954e354bbfadd1ab7e5854e4464e54586c4d00bd3b4daa6f2d09219db26
+  metadata.gz: bde399e1e18835553bd15b72c9062c98d6560b7ae8e705739f4e4ea3fc96caa70b2db000b93897c5470a71f9f8cdc0a7674fc1afb2952d841a43c652c5a447fe
+  data.tar.gz: 6575f6321b5beac495967b5e42fca6e2c238a4e7171588ef3e653efa925397cf8a8e2d3563ee7ba395e5cb012d4bd12edf06277b0468dc4189c90398a2d9939a

data/Gemfile

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

data/lib/http/negotiate/version.rb

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

data/lib/http/negotiate.rb

@@ -8,18 +8,23 @@ module HTTP::Negotiate
   HEADERS = { type: '' }.merge(
     %i[charset language encoding].map { |k| [k, ?_ + k.to_s.upcase] }.to_h)
 
+  # these are for the hash representation of variant metadata
+  KEYS = %i[weight type encoding charset language size].freeze
+
   public
 
   # The variant mapping takes the following form:
   # { variant => [weight, type, encoding, charset, language, size] }
   #
+  # (Alternatively this array can be a hash with the same keys as symbols.)
+  #
   # * 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
+  # * size is the number of bytes, an integer
   #
   # Returns either the winning variant or all variants if requested,
   # sorted by the algorithm, or nil or the empty array if none are
@@ -27,19 +32,17 @@ module HTTP::Negotiate
   #
   # @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 
+  # @param all [false, true] whether to return a sorted list or not
+  # @param cmp [Proc] a secondary comparison of variants as a tiebreaker
   #
-  def negotiate request, variants, all: false
+  def negotiate request, variants, all: false, cmp: nil
     # 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
+      k = k.to_s.strip
+      /^Accept(-.*)?$/i.match?(k) ? "HTTP_#{k.upcase.tr ?-, ?_}" : k
     end
 
     # the working set
@@ -48,7 +51,10 @@ module HTTP::Negotiate
     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
+        # strip out all the whitespace from the header value;
+        # theoretically you can have quoted-string parameter values
+        # but we don't care (although interestingly according to rfc7231,
+        # accept-language only affords q= and not arbitrary parameters)
         hdr = hdr.dup.gsub(/\s+/, '')
         accept[k] = hdr.split(/,+/).map do |c|
           val, *params = c.split(/;+/)
@@ -71,9 +77,14 @@ module HTTP::Negotiate
       end
     end
 
+    # convert variants to array
+    variants = variants.transform_values do |v|
+      v.is_a?(Hash) ? v.values_at(*KEYS) : v
+    end
+
     # check if any of the variants specify a language, since this will
     # affect the scoring
-    any_lang = variants.values.any? { |v| v[5] }
+    any_lang = variants.values.any? { |v| v[4] }
 
     # chosen will be { variant => value }
     scores = {}
@@ -172,10 +183,16 @@ module HTTP::Negotiate
       scores[var] = qs * qe * qc * ql * qt
     end
 
-    chosen = scores.sort { |a, b| b.last <=> a.last }.map(&:first)
+    # XXX do something smarter here for secondary comparison
+    cmp ||= -> a, b { 0 }
+
+    chosen = scores.sort do |a, b|
+      c = b.last <=> a.last
+      c == 0 ? cmp.call(a.first, b.first) : c
+    end.map(&:first)
     all ? chosen : chosen.first
   end
 
   extend self
 end
-
+3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-negotiate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dorian Taylor
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: 
+description:
 email:
 - code@doriantaylor.com
 executables: []
@@ -78,7 +78,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/doriantaylor/rb-http-negotiate
   source_code_uri: https://github.com/doriantaylor/rb-http-negotiate
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,8 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: An implementation of Gisle Aas's HTTP::Negotiate
 test_files: []