http-negotiate 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97e8bcc59dec991c82e9e253b34ab3643ee7b62441b2d890c1988bcd2bd6a941
-  data.tar.gz: 66a3825c19b6ab786a4b1fdca2cd5fff90d03b91d72aea495576f2e3312c2bb1
+  metadata.gz: 6c40df3f0c699e99b0f45c3af71e19e5461878bddecf1a8a28a4125965cc05c9
+  data.tar.gz: 58dfdd11e0a9b119f5e84bdb24e8d2d28145e91d7a8fa3d5d3067572d1c2980e
 SHA512:
-  metadata.gz: 89807147d59bfeadcfa20e4228bbd6de119c2bcadcfcf76c204516e20a47c049c8c0a7d736e05265f5f737d10ce8b1c4a49ee7da4719a0c30abe7e62dba57c2c
-  data.tar.gz: 8f83584309e4a1fb37b46c53b3618bba9a470030414e20d30c8f96bbf09deecc003674fd265262193ea4fecf3053de20927f35fd676a547c46586941e77e8381
+  metadata.gz: 0610a598b694dfa3a147257e160dfbfafcde951715ff7329f489b22e097490e2999f84a8401ef6019183f30fbbdbe01c31c4daf7dd9abcab34402add0a1f96bc
+  data.tar.gz: b3a19ba49afe90cd32aba42046ec57af147bb1a12f7087102fed03e5520c30cc33fecc41785a226cf7a5680298adcb59ea2b14a9bcd6950db3b2148109a070be

data/.yardopts

@@ -0,0 +1,5 @@
+--markup=markdown
+--no-private
+- README.md
+- LICENSE
+- CHANGELOG.md

data/http-negotiate.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   # dev/test dependencies
   spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'rake',    '~> 13.0'
-  spec.add_development_dependency 'rspec',   '~> 3.10'
+  spec.add_development_dependency 'rspec',   '~> 3.12'
 end

data/lib/http/negotiate/version.rb

@@ -1,5 +1,5 @@
 module HTTP
   module Negotiate
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

data/lib/http/negotiate.rb

@@ -13,32 +13,31 @@ module HTTP::Negotiate
 
   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, an integer
+  # Return a parsed representation of the relevant header
+  # set. Translates `Accept-*` (`HTTP_ACCEPT_*`) into lower-case
+  # symbols, so `Accept-Language` or `HTTP_ACCEPT_LANGUAGE` becomes
+  # `:language`. Same for `:charset`, and `:encoding`, etc., save for
+  # plain `Accept` which is translated to `:type`. The parameter
+  # `:add_langs` will supplement `Accept-Language` assertions of
+  # specific languages with their more generic counterparts, if not
+  # already present in the header, with a slightly lower quality
+  # score, e.g. `en-us` adds `en;q=0.999`, `zh-cn;q=0.8` adds
+  # `zh;q=0.799`.
   #
-  # 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 add_langs [false, true] whether to supplement language tags
   #
-  # @param request [Hash,Rack::Request,#env] Anything roughly a hash of headers
-  # @param variants [Hash] the variants, described above
-  # @param add_langs [false, true] whether to supplant language tags
-  # @param all [false, true] whether to return a sorted list or not
-  # @param cmp [Proc] a secondary comparison of variants as a tiebreaker
+  # @return [Hash] the parsed `Accept*` headers
   #
-  def negotiate request, variants, add_langs: false, all: false, cmp: nil
+  def parse_headers request, add_langs: false
     # pull accept headers
     request = request.env if request.respond_to? :env
+
+    # no-op if this is already parsed
+    return request if request.is_a? Hash and
+      request.all? { |k, v| k.is_a? Symbol and v.is_a? Hash }
+
     # 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|
@@ -67,7 +66,7 @@ module HTTP::Negotiate
           params = params.map do |p|
             k, v = p.split(/=+/, 2)
             k = k.downcase.to_sym
-            v = v.to_f if v and k == :q 
+            v = v.to_f if v and k == :q
             [k, v]
           end.to_h
           if params[:q]
@@ -100,6 +99,35 @@ module HTTP::Negotiate
       end
     end
 
+    accept
+  end
+
+  # 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, 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
+  # selected.
+  #
+  # @param request [Hash,Rack::Request,#env] Anything roughly a hash of headers
+  # @param variants [Hash] the variants, described above
+  # @param add_langs [false, true] whether to supplement language tags
+  # @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, add_langs: false, all: false, cmp: nil
+    accept = parse_headers request, add_langs: add_langs
+
     # convert variants to array
     variants = variants.transform_values do |v|
       v.is_a?(Hash) ? v.values_at(*KEYS) : v
@@ -145,24 +173,30 @@ module HTTP::Negotiate
 
       # 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
+      if accept[:language]
+        if language
+          ql = 0.001 # initial value is very low but not zero
+          lang = language.split(/-+/)
+          (0..lang.length).to_a.reverse.each do |i|
+            # apparently there is no wildcard for accept-language? no
+            # wait there is: rfc4647 $2.1 via rfc7231 $5.3.5
+            test = i > 0 ? lang.slice(0, i).join(?-) : ?*
+            if accept[:language][test]
+              al = accept[:language][test][:q]
+              # *;q=0 will override
+              if al == 0 and test != ?*
+                ql = 0
+                break
+              elsif al > ql
+                ql = al
+              end
             end
           end
+        elsif any_lang
+          # XXX not sure if language-less variants in the same pool
+          # with language-y ones
+          ql = 0.5
         end
-        # apparently there is no wildcard for accept-language?
-      elsif accept[:language] and any_lang
-        ql = 0.5
       end
 
       # calculate the type quality

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http-negotiate
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dorian Taylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
 description:
 email:
 - code@doriantaylor.com
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: An implementation of Gisle Aas's HTTP::Negotiate