http.rb 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e8141a5ebd470216fbd373f5a21fa5b96981be7dc2d6ddb7d8131b220b91ef7
-  data.tar.gz: 20a7507d9c92457c23f38970f9d04877c527115d298a07a5c3fe0015c88ff627
+  metadata.gz: 9c256751d9a000319b5c01326141fab71034662d85cf2393e47170ef73ff3272
+  data.tar.gz: e707ce4ff95cab59c75f66a2d29100483da32ad9c3df3e384455be00a202bf2b
 SHA512:
-  metadata.gz: 97514595af94da5845f2189b81751838c1c753ee69afaf31cd43d08ab80cfbd623b7da8214e61375a011210ef9dbe330f318e3981b0b5c350f63b12f4526c2a7
-  data.tar.gz: a8828932d5d72ab5348f44b2f0bff95f14a13653682161963fdb3d518f3734805798abf518bd7fe849f70e838225a9229b989147c94a3808e533e1f5d50836cd
+  metadata.gz: f9b47e3129188137bb30018f85cee74b8d2d8f1daa42a00b0aabf68133286416432f53f107ffe5c8370e6184875f29cef3ffdc48fa113a3bdce8ca2a03cbbb8f
+  data.tar.gz: 63edff9c0ec8b79d348de5a6a49737a7683fd74958dc2d33ce99433fc170010600e2477957ae355c6426fc8c725aa6b4a6fee2134136292eb2d7be942e70c94a

data/CHANGELOG

@@ -1,6 +1,36 @@
 # CHANGELOG
 
-## 20260609
+## 20260713
+
+1.3.1: Use Thoran Namespace for URL-encoding extensions.
+
+The String#url_encode and Hash#x_www_form_urlencode extensions reopened the core classes directly. Both now live in named modules under the Thoran:: namespace — Thoran::String::Urlencode and Thoran::Hash::XWwwFormUrlencode — mixed into String and Hash.
+
+1. + Thoran::String::Urlencode#urlencode
+2. - String#url_encode
+3. + Thoran::Hash::XWwwFormUrlencode#x_www_form_urlencode
+4. ~ Hash#x_www_form_urlencode: Requires the Thoran namespaced equivalent.
+5. ~ HTTP::VERSION: /1.3.0/1.3.1/
+6. ~ CHANGELOG: + 1.3.1 entry
+
+## 20260610
+
+1.3.0: Rename VERBS to METHODS; VERBS retained as a deprecated alias.
+
+RFC 9110 calls these "methods", not "verbs". HTTP::VERBS becomes HTTP::METHODS and HTTP::RETRY::VERBS becomes HTTP::RETRY::METHODS, with the old names kept as deprecated aliases (via deprecate_constant) so nothing breaks. The call surface — the named methods, the options hash, HTTP.request, request_with_body/request_without_body — is unchanged. The aliases are scheduled for removal in 2.0.0; that removal is the breaking change the major bump is reserved for.
+
+1. /lib/HTTP/verbs.rb/lib/HTTP/METHODS.rb/: the file is now named for the METHODS module it defines, matching RETRY.rb and VERSION.rb.
+2. ~ HTTP/METHODS.rb: /VERBS/METHODS/ for the WITHOUT_BODY/WITH_BODY container; + VERBS deprecated alias; /verb/request_method/ in the block variable.
+3. ~ HTTP.rb: require 'HTTP/METHODS' in place of require 'HTTP/verbs'.
+4. ~ HTTP/RETRY.rb: /VERBS/METHODS/ for the default retry method list; + VERBS deprecated alias. retry_config now accepts the :retry_methods option (preferred) and still honours :retry_verbs as a backwards-compatible alias; its internal config key is /verbs/methods/.
+5. ~ HTTP/request.rb: the 307/308 redirect handler now references METHODS::WITH_BODY, and the retry guard reads config[:methods]; /verb/request_method/.
+6. ~ test/HTTP/RETRY_test.rb: + retry_methods opt-in and retry_methods-over-retry_verbs precedence cases; the option-leak test now covers both :retry_methods and :retry_verbs.
+7. + test/HTTP/METHODS_test.rb
+8. ~ README.md: retry_methods documented as the option key, with retry_verbs noted as still accepted; the retry default is shown as HTTP::RETRY::METHODS.
+9. ~ HTTP::VERSION: /1.2.1/1.3.0/
+10. ~ CHANGELOG: + 1.3.0 entry
+
+## 20260610
 
 1.2.1: Split the request builders into their own files.
 
@@ -12,7 +42,7 @@ request_with_body and request_without_body, added in 1.2.0, each move into their
 4. ~ HTTP::VERSION: /1.2.0/1.2.1/
 5. ~ CHANGELOG: + 1.2.1 entry
 
-## 20260609
+## 20260610
 
 1.2.0: Extract request_without_body and request_with_body.
 

data/README.md

@@ -110,10 +110,10 @@ HTTP.get('http://example.com', {}, {}, {retries: 3})
 
 When enabled, transient network exceptions and retry-worthy HTTP status codes (429, 502, 503, 504) are retried with exponential backoff and jitter. If the response carries a `Retry-After` header, it is honoured in place of the calculated delay.
 
-Only idempotent verbs (`get`, `head`, `options`, `put`, `delete`, `trace`) are retried by default. POST and PATCH are not — retrying a non-idempotent write can create duplicate resources against APIs that don't deduplicate. Opt in per-call via `retry_verbs:`.
+Only idempotent methods (`get`, `head`, `options`, `put`, `delete`, `trace`) are retried by default. POST and PATCH are not — retrying a non-idempotent write can create duplicate resources against APIs that don't deduplicate. Opt in per-call via `retry_methods:` (the older `retry_verbs:` is still accepted).
 
 ```ruby
-HTTP.post('http://example.com', {a: 1}, {}, {retries: 3, retry_verbs: %i{get post}})
+HTTP.post('http://example.com', {a: 1}, {}, {retries: 3, retry_methods: %i{get post}})
 ```
 
 Configurable options:
@@ -124,7 +124,7 @@ options = {
   retry_delay: 1.0,                             # base delay (seconds) for exponential backoff
   retry_status_codes: [429, 502, 503, 504],     # HTTP status codes to retry
   retry_exceptions: HTTP::RETRY::EXCEPTIONS,    # exceptions to retry
-  retry_verbs: HTTP::RETRY::VERBS               # verbs that retry by default
+  retry_methods: HTTP::RETRY::METHODS           # methods that retry by default (retry_verbs still accepted)
 }
 ```
 

data/lib/HTTP/METHODS.rb

@@ -0,0 +1,29 @@
+# HTTP/METHODS.rb
+# HTTP::METHODS
+
+require_relative './request_without_body'
+require_relative './request_with_body'
+
+module HTTP
+  module METHODS
+    WITHOUT_BODY = %i{get delete head options trace}
+    WITH_BODY = %i{post put patch}
+  end
+
+  VERBS = METHODS # Deprecated alias for METHODS; to be removed in 2.0.0.
+  deprecate_constant :VERBS
+
+  METHODS::WITHOUT_BODY.each do |request_method|
+    define_method(request_method) do |uri, args = {}, headers = {}, options = {}, &block|
+      request_without_body(request_method, uri, args, headers, options, &block)
+    end
+    module_function request_method
+  end
+
+  METHODS::WITH_BODY.each do |request_method|
+    define_method(request_method) do |uri, data = {}, headers = {}, options = {}, &block|
+      request_with_body(request_method, uri, data, headers, options, &block)
+    end
+    module_function request_method
+  end
+end

data/lib/HTTP/RETRY.rb

@@ -19,7 +19,9 @@ module HTTP
       EOFError
     ].freeze
     STATUS_CODES = [429, 502, 503, 504].freeze
-    VERBS = %i{get head options put delete trace}.freeze
+    METHODS = %i{get head options put delete trace}.freeze
+    VERBS = METHODS # Deprecated alias for METHODS; to be removed in 2.0.0.
+    deprecate_constant :VERBS
 
     def self.sleep(seconds)
       Kernel.sleep(seconds)
@@ -32,7 +34,7 @@ module HTTP
       delay: options.delete(:retry_delay) || 1.0,
       status_codes: options.delete(:retry_status_codes) || RETRY::STATUS_CODES,
       exceptions: options.delete(:retry_exceptions) || RETRY::EXCEPTIONS,
-      verbs: options.delete(:retry_verbs) || RETRY::VERBS
+      methods: [options.delete(:retry_methods), options.delete(:retry_verbs)].compact.first || RETRY::METHODS
     }
   end
   module_function :retry_config

data/lib/HTTP/VERSION.rb

@@ -2,5 +2,5 @@
 # HTTP::VERSION
 
 module HTTP
-  VERSION = '1.2.1'
+  VERSION = '1.3.1'
 end

data/lib/HTTP/request.rb

@@ -29,9 +29,9 @@ module HTTP
     elsif uri.user
       request_object.basic_auth(uri.user, uri.password)
     end
-    verb = request_object.method.downcase.to_sym
+    request_method = request_object.method.downcase.to_sym
     response = (
-      if config[:retries] > 0 && config[:verbs].include?(verb)
+      if config[:retries] > 0 && config[:methods].include?(request_method)
         with_retries(http, request_object, config)
       else
         http.request(request_object)
@@ -45,8 +45,8 @@ module HTTP
       end
       redirect_uri = uri.merge(response['location'])
       if response.code =~ /^30[78]$/
-        data = VERBS::WITH_BODY.include?(verb) ? request_object.body : {}
-        response = send(verb, redirect_uri.to_s, data, headers, options, &block)
+        data = METHODS::WITH_BODY.include?(request_method) ? request_object.body : {}
+        response = send(request_method, redirect_uri.to_s, data, headers, options, &block)
       else
         response = get(redirect_uri.to_s, {}, {}, options, &block)
       end

data/lib/Hash/x_www_form_urlencode.rb

@@ -1,10 +1,7 @@
 # Hash/x_www_form_urlencode.rb
 # Hash#x_www_form_urlencode
 
-require_relative '../String/url_encode'
+# 20260713
+# 0.2.0
 
-class Hash
-  def x_www_form_urlencode(joiner = '&')
-    inject([]){|a,e| a << "#{e.first.to_s.url_encode.gsub(/ /, '+')}=#{e.last.to_s.url_encode.gsub(/ /, '+')}" unless e.last.nil?; a}.join(joiner)
-  end
-end
+require 'Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode'

data/lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb

@@ -0,0 +1,27 @@
+# Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb
+# Thoran::Hash::XWwwFormUrlencode#x_www_form_urlencode
+
+# 20260713
+# 0.3.0
+
+# Changes since 0.2:
+# -/0: (The class name and the snake case name really are consistent now.)
+# 1. /XWwwFormUrlEncode/XWwwFormUrlencode/
+# 2. /url_encode/urlencode/
+
+require 'Thoran/String/Urlencode/urlencode'
+
+module Thoran
+  module Hash
+    module XWwwFormUrlencode
+
+      def x_www_form_urlencode(joiner = '&')
+        inject([]){|a,e| a << "#{e.first.to_s.urlencode}=#{e.last.to_s.urlencode}" unless e.last.nil?; a}.join(joiner)
+      end
+      alias_method :x_www_form_url_encode, :x_www_form_urlencode
+
+    end
+  end
+end
+
+Hash.send(:include, Thoran::Hash::XWwwFormUrlencode)

data/lib/Thoran/String/Urlencode/urlencode.rb

@@ -0,0 +1,29 @@
+# Thoran/String/Urlencode/urlencode.rb
+# Thoran::String::Urlencode#urlencode
+
+# 20260713
+# 0.4.0
+
+# Acknowledgements: I've simply ripped off and refashioned the code from the CGI module!...
+
+# Changes since 0.3:
+# -/0: More consistent naming.
+# 1. /UrlEncode/Urlencode/
+# 2. /url_encode/urlencode/
+
+module Thoran
+  module String
+    module Urlencode
+
+      def urlencode
+        self.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+          '%' + $1.unpack('H2' * $1.size).join('%').upcase
+        end.tr(' ', '+')
+      end
+      alias_method :url_encode, :urlencode
+
+    end
+  end
+end
+
+String.send(:include, Thoran::String::Urlencode)

data/lib/http.rb

@@ -0,0 +1,4 @@
+# HTTP.rb
+# HTTP
+
+require 'HTTP/METHODS'

data/test/HTTP/METHODS_test.rb

@@ -0,0 +1,39 @@
+# test/HTTP/METHODS_test.rb
+
+require_relative '../helper'
+
+def without_deprecation_warnings
+  original = Warning[:deprecated]
+  Warning[:deprecated] = false
+  yield
+ensure
+  Warning[:deprecated] = original
+end
+
+describe "HTTP::METHODS" do
+  it "groups the methods sent without a body" do
+    _(HTTP::METHODS::WITHOUT_BODY).must_equal(%i{get delete head options trace})
+  end
+
+  it "groups the methods sent with a body" do
+    _(HTTP::METHODS::WITH_BODY).must_equal(%i{post put patch})
+  end
+
+  it "remains reachable under the deprecated VERBS name" do
+    without_deprecation_warnings do
+      _(HTTP::VERBS).must_equal(HTTP::METHODS)
+    end
+  end
+end
+
+describe "HTTP::RETRY::METHODS" do
+  it "lists the idempotent methods retried by default" do
+    _(HTTP::RETRY::METHODS).must_equal(%i{get head options put delete trace})
+  end
+
+  it "remains reachable under the deprecated VERBS name" do
+    without_deprecation_warnings do
+      _(HTTP::RETRY::VERBS).must_equal(HTTP::RETRY::METHODS)
+    end
+  end
+end

data/test/HTTP/RETRY_test.rb

@@ -177,6 +177,7 @@ describe "retry behaviour" do
           retry_delay: 0.1,
           retry_status_codes: [500],
           retry_exceptions: [Errno::ECONNRESET],
+          retry_methods: %i{get},
           retry_verbs: %i{get}
         })
       end
@@ -184,6 +185,7 @@ describe "retry behaviour" do
       _(received_opts).wont_include(:retry_delay)
       _(received_opts).wont_include(:retry_status_codes)
       _(received_opts).wont_include(:retry_exceptions)
+      _(received_opts).wont_include(:retry_methods)
       _(received_opts).wont_include(:retry_verbs)
     end
   end
@@ -240,6 +242,24 @@ describe "retry behaviour" do
         assert_requested(:post, uri, times: 2)
       end
     end
+
+    it "retries POST when opted in via retry_methods" do
+      HTTP::RETRY.stub(:sleep, nil) do
+        stub_request(:post, uri).to_return({status: 503}, {status: 200, body: ''})
+        response = HTTP.post(uri, {}, {}, {retries: 3, retry_methods: %i{get post}})
+        _(response.success?).must_equal(true)
+        assert_requested(:post, uri, times: 2)
+      end
+    end
+
+    it "prefers retry_methods over retry_verbs when both are given" do
+      HTTP::RETRY.stub(:sleep, nil) do
+        stub_request(:post, uri).to_return({status: 503}, {status: 200, body: ''})
+        response = HTTP.post(uri, {}, {}, {retries: 3, retry_methods: %i{get post}, retry_verbs: %i{get}})
+        _(response.success?).must_equal(true)
+        assert_requested(:post, uri, times: 2)
+      end
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http.rb
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - thoran
@@ -93,19 +93,21 @@ files:
 - README.md
 - Rakefile
 - http.rb.gemspec
-- lib/HTTP.rb
+- lib/HTTP/METHODS.rb
 - lib/HTTP/RETRY.rb
 - lib/HTTP/VERSION.rb
 - lib/HTTP/request.rb
 - lib/HTTP/request_with_body.rb
 - lib/HTTP/request_without_body.rb
-- lib/HTTP/verbs.rb
 - lib/Hash/x_www_form_urlencode.rb
 - lib/Net/HTTP/set_options.rb
 - lib/Net/HTTPRequest/set_headers.rb
 - lib/Net/HTTPResponse/StatusPredicates.rb
-- lib/String/url_encode.rb
+- lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb
+- lib/Thoran/String/Urlencode/urlencode.rb
 - lib/URI/Generic/use_sslQ.rb
+- lib/http.rb
+- test/HTTP/METHODS_test.rb
 - test/HTTP/RETRY_test.rb
 - test/HTTP/basic_auth_test.rb
 - test/HTTP/delete_test.rb
@@ -138,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.13
+rubygems_version: 4.0.16
 specification_version: 4
 summary: HTTP made easy.
 test_files: []

data/lib/HTTP/verbs.rb

@@ -1,26 +0,0 @@
-# HTTP/verbs.rb
-# HTTP.verb
-
-require_relative './request_without_body'
-require_relative './request_with_body'
-
-module HTTP
-  module VERBS
-    WITHOUT_BODY = %i{get delete head options trace}
-    WITH_BODY = %i{post put patch}
-  end
-
-  VERBS::WITHOUT_BODY.each do |verb|
-    define_method(verb) do |uri, args = {}, headers = {}, options = {}, &block|
-      request_without_body(verb, uri, args, headers, options, &block)
-    end
-    module_function verb
-  end
-
-  VERBS::WITH_BODY.each do |verb|
-    define_method(verb) do |uri, data = {}, headers = {}, options = {}, &block|
-      request_with_body(verb, uri, data, headers, options, &block)
-    end
-    module_function verb
-  end
-end

data/lib/HTTP.rb

@@ -1,4 +0,0 @@
-# HTTP.rb
-# HTTP
-
-require 'HTTP/verbs'

data/lib/String/url_encode.rb

@@ -1,24 +0,0 @@
-# String/url_encode.rb
-# String#url_encode
-
-# 20130310
-# 0.2.1
-
-# Description: When I went looking for a means to url encode and decode strings, I wanted something which used extensions to the String class.  Of course there are other means to do url encoding and decoding including using the CGI class, but I liked the approach of having this 'built-in' to strings, rather than the string being passed as a parameter as does CGI.  Hence this String extender...  
-
-# Acknowledgements: I've simply ripped off and refashioned the code from the CGI module!...  
-
-# Changes since 0.1:
-# 1. The url_encode and url_decode methods now are strictly demarcated.  
-# 0/1
-# 2. A small reformat.  
-
-class String
-
-  def url_encode
-    self.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
-      '%' + $1.unpack('H2' * $1.size).join('%').upcase
-    end.tr(' ', '+')
-  end
-
-end