http.rb 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5f552ac83d2afe5184c79455af215f58e18cc7e0f01e1a8bf684a877f8b9d9a
-  data.tar.gz: 274244f8126d9dbb09b17c1a46be7a7c037ecab83ca8ae5af5bc4d7f3463c07b
+  metadata.gz: 8e8141a5ebd470216fbd373f5a21fa5b96981be7dc2d6ddb7d8131b220b91ef7
+  data.tar.gz: 20a7507d9c92457c23f38970f9d04877c527115d298a07a5c3fe0015c88ff627
 SHA512:
-  metadata.gz: e0fdfcf607047e62db109a3ec414cebf308b270e2757d510f8f337628f0b235a947f4769a5e78a32abd137ce764f63822ca9ff26ccfc5fbc01db39ead0ef1152
-  data.tar.gz: fb725d77aa4f4312803dadd481b62a705dd3286568469a1ae055a609a86d9991583dd69a7110864375b5835eecbba9ab06ad39ffbc4f61e428686787690908c2
+  metadata.gz: 97514595af94da5845f2189b81751838c1c753ee69afaf31cd43d08ab80cfbd623b7da8214e61375a011210ef9dbe330f318e3981b0b5c350f63b12f4526c2a7
+  data.tar.gz: a8828932d5d72ab5348f44b2f0bff95f14a13653682161963fdb3d518f3734805798abf518bd7fe849f70e838225a9229b989147c94a3808e533e1f5d50836cd

data/CHANGELOG

@@ -2,6 +2,31 @@
 
 ## 20260609
 
+1.2.1: Split the request builders into their own files.
+
+request_with_body and request_without_body, added in 1.2.0, each move into their own file, matching the one-method-per-file layout used throughout lib/. Purely internal reorganisation — the methods, their signatures, and their behaviour are unchanged — so it is a patch, not a minor.
+
+1. + lib/HTTP/request_without_body.rb: HTTP.request_without_body, extracted from verbs.rb; requires net/http and the Hash#x_www_form_urlencode extension.
+2. + lib/HTTP/request_with_body.rb: HTTP.request_with_body, extracted from verbs.rb; requires net/http and json.
+3. ~ HTTP/verbs.rb: the request builders are extracted; the file now requires the two new files and keeps the VERBS constant and the named-method generation.
+4. ~ HTTP::VERSION: /1.2.0/1.2.1/
+5. ~ CHANGELOG: + 1.2.1 entry
+
+## 20260609
+
+1.2.0: Extract request_without_body and request_with_body.
+
+The logic for building request objects — constructing the Net::HTTP request class, encoding bodies, and assembling query strings — lived inside the define_method loops and was unreachable except through the eight named methods. Downstream gems needing a method without a named helper (notably webdav's PROPFIND) had to build raw Net::HTTP request objects and bypass that logic entirely. Those two loop bodies are now module functions, callable directly as HTTP.request_without_body(method, ...) and HTTP.request_with_body(method, ...); the named methods delegate to them and behave identically.
+
+1. ~ HTTP/verbs.rb: + request_without_body() and request_with_body() module functions; the WITHOUT_BODY and WITH_BODY define_method loops now delegate to them.
+2. + test/HTTP/request_without_body_test.rb
+3. + test/HTTP/request_with_body_test.rb
+4. ~ README.md: + Constructing requests for other methods section.
+5. ~ HTTP::VERSION: /1.1.0/1.2.0/
+6. ~ CHANGELOG: + 1.2.0 entry
+
+## 20260609
+
 1.1.0: Basic auth via the options hash.
 
 Until now basic authentication was only available through credentials embedded in the URI, which forced callers needing programmatic credentials (notably the webdav gem) to construct their own Net::HTTP request objects and bypass the verb methods entirely. The options hash now accepts username: and password:, extracted the same way no_redirect is, so they never leak through to Net::HTTP. This is additive: URI credentials still work as a fallback, and explicit options take precedence over them.

data/README.md

@@ -182,6 +182,20 @@ class A
 end
 ```
 
+### Constructing requests for other methods
+
+The named methods cover the HTTP methods with a request class in Ruby's `Net::HTTP` stdlib. For anything else — a method without a named helper, such as `PROPFIND` — the same body encoding, query string, and request handling is available directly:
+
+```ruby
+# No body — args become a query string:
+HTTP.request_without_body(:propfind, 'http://example.com/path', {depth: 1})
+
+# With a body — string passthrough, JSON when the content type says so, form data otherwise:
+HTTP.request_with_body(:propfind, 'http://example.com/path', xml, {'Content-Type' => 'application/xml'})
+```
+
+Both take the same `(method, uri, args_or_data, headers, options, &block)` arguments as the named methods, with the method as the first argument, and the named methods delegate to them. For full control over the request object, drop down to `HTTP.request(uri, request_object, headers, options, &block)`.
+
 ## Allowed values for the options hash
 #### (These pass through to Net::HTTP, except for `no_redirect`, `username`, and `password`.)
 

data/lib/HTTP/VERSION.rb

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

data/lib/HTTP/request_with_body.rb

@@ -0,0 +1,25 @@
+# HTTP/request_with_body.rb
+# HTTP.request_with_body
+
+require 'json'
+require 'net/http'
+
+require_relative './request'
+
+module HTTP
+  def request_with_body(method, uri, data = {}, headers = {}, options = {}, &block)
+    uri = uri.is_a?(URI) ? uri : URI.parse(uri)
+    request_object = Net::HTTP.const_get(method.to_s.capitalize).new(uri.request_uri)
+    content_type = headers.find{|k, v| k.downcase == 'content-type'}&.last.to_s
+    if data.is_a?(String)
+      request_object.body = data
+    elsif content_type.start_with?('application/json')
+      request_object.body = JSON.dump(data)
+    else
+      request_object.form_data = data
+    end
+    request(uri, request_object, headers, options, &block)
+  end
+
+  module_function :request_with_body
+end

data/lib/HTTP/request_without_body.rb

@@ -0,0 +1,21 @@
+# HTTP/request_without_body.rb
+# HTTP.request_without_body
+
+require 'net/http'
+
+require_relative '../Hash/x_www_form_urlencode'
+require_relative './request'
+
+module HTTP
+  def request_without_body(method, uri, args = {}, headers = {}, options = {}, &block)
+    uri = uri.is_a?(URI) ? uri : URI.parse(uri)
+    request_uri = uri.request_uri
+    unless args.empty?
+      request_uri += '?' + args.x_www_form_urlencode
+    end
+    request_object = Net::HTTP.const_get(method.to_s.capitalize).new(request_uri)
+    request(uri, request_object, headers, options, &block)
+  end
+
+  module_function :request_without_body
+end

data/lib/HTTP/verbs.rb

@@ -1,11 +1,8 @@
 # HTTP/verbs.rb
 # HTTP.verb
 
-require 'json'
-require 'net/http'
-
-require_relative '../Hash/x_www_form_urlencode'
-require_relative './request'
+require_relative './request_without_body'
+require_relative './request_with_body'
 
 module HTTP
   module VERBS
@@ -15,33 +12,15 @@ module HTTP
 
   VERBS::WITHOUT_BODY.each do |verb|
     define_method(verb) do |uri, args = {}, headers = {}, options = {}, &block|
-      uri = uri.is_a?(URI) ? uri : URI.parse(uri)
-      request_uri = uri.request_uri
-      unless args.empty?
-        request_uri += '?' + args.x_www_form_urlencode
-      end
-      request_object = Net::HTTP.const_get(verb.to_s.capitalize).new(request_uri)
-      request(uri, request_object, 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|
-      uri = uri.is_a?(URI) ? uri : URI.parse(uri)
-      request_object = Net::HTTP.const_get(verb.to_s.capitalize).new(uri.request_uri)
-      content_type = headers.find{|k, v| k.downcase == 'content-type'}&.last.to_s
-      if data.is_a?(String)
-        request_object.body = data
-      elsif content_type.start_with?('application/json')
-        request_object.body = JSON.dump(data)
-      else
-        request_object.form_data = data
-      end
-      request(uri, request_object, headers, options, &block)
+      request_with_body(verb, uri, data, headers, options, &block)
     end
-
     module_function verb
   end
 end

data/test/HTTP/request_with_body_test.rb

@@ -0,0 +1,76 @@
+# test/HTTP/request_with_body_test.rb
+
+require_relative '../helper'
+
+describe ".request_with_body" do
+  let(:uri){'http://example.com/path'}
+  let(:parsed_uri){URI.parse(uri)}
+
+  describe "with a string body" do
+    let(:body){'raw body'}
+
+    before do
+      stub_request(:post, 'http://example.com/path').
+        with(body: body).
+          to_return(status: 200, body: '', headers: {})
+    end
+
+    it "passes the string through unchanged" do
+      request_object = Net::HTTP::Post.new(parsed_uri.request_uri)
+      Net::HTTP::Post.stub(:new, request_object) do
+        response = HTTP.request_with_body(:post, uri, body)
+        _(request_object.body).must_equal(body)
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "with a JSON content type" do
+    let(:data){{a: 1, b: 2}}
+    let(:headers){{'Content-Type' => 'application/json'}}
+
+    before do
+      stub_request(:post, 'http://example.com/path').
+        with(body: JSON.dump(data)).
+          to_return(status: 200, body: '', headers: {})
+    end
+
+    it "JSON-encodes the data" do
+      request_object = Net::HTTP::Post.new(parsed_uri.request_uri)
+      Net::HTTP::Post.stub(:new, request_object) do
+        response = HTTP.request_with_body(:post, uri, data, headers)
+        _(request_object.body).must_equal(JSON.dump(data))
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "with no content type" do
+    let(:data){{a: 1, b: 2}}
+
+    before do
+      stub_request(:post, 'http://example.com/path').
+        with(body: data.x_www_form_urlencode).
+          to_return(status: 200, body: '', headers: {})
+    end
+
+    it "form-encodes the data" do
+      request_object = Net::HTTP::Post.new(parsed_uri.request_uri)
+      Net::HTTP::Post.stub(:new, request_object) do
+        response = HTTP.request_with_body(:post, uri, data)
+        _(request_object.body).must_equal(data.x_www_form_urlencode)
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "delegation from the named method" do
+    it "is reached by HTTP.post with the verb prepended" do
+      received_args = nil
+      HTTP.stub(:request_with_body, ->(*args, &block){received_args = args; nil}) do
+        HTTP.post(uri, {a: 1}, {'User-Agent' => 'Minitest'}, {use_ssl: false})
+      end
+      _(received_args).must_equal([:post, uri, {a: 1}, {'User-Agent' => 'Minitest'}, {use_ssl: false}])
+    end
+  end
+end

data/test/HTTP/request_without_body_test.rb

@@ -0,0 +1,53 @@
+# test/HTTP/request_without_body_test.rb
+
+require_relative '../helper'
+
+describe ".request_without_body" do
+  let(:uri){'http://example.com/path'}
+  let(:parsed_uri){URI.parse(uri)}
+
+  describe "without args" do
+    before do
+      stub_request(:get, 'http://example.com/path').
+        to_return(status: 200, body: '', headers: {})
+    end
+
+    it "builds the request object for the given method" do
+      received_arg = nil
+      request_object = Net::HTTP::Get.new(parsed_uri.request_uri)
+      Net::HTTP::Get.stub(:new, ->(arg){received_arg = arg; request_object}) do
+        response = HTTP.request_without_body(:get, uri)
+        _(received_arg).must_equal(parsed_uri.request_uri)
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "with args" do
+    before do
+      stub_request(:get, 'http://example.com/path?a=1&b=2').
+        to_return(status: 200, body: '', headers: {})
+    end
+
+    it "appends the encoded query string to the request uri" do
+      received_arg = nil
+      request_uri = parsed_uri.request_uri + '?a=1&b=2'
+      request_object = Net::HTTP::Get.new(request_uri)
+      Net::HTTP::Get.stub(:new, ->(arg){received_arg = arg; request_object}) do
+        response = HTTP.request_without_body(:get, uri, {a: 1, b: 2})
+        _(received_arg).must_equal(request_uri)
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "delegation from the named method" do
+    it "is reached by HTTP.get with the verb prepended" do
+      received_args = nil
+      HTTP.stub(:request_without_body, ->(*args, &block){received_args = args; nil}) do
+        HTTP.get(uri, {a: 1}, {'User-Agent' => 'Minitest'}, {use_ssl: false})
+      end
+      _(received_args).must_equal([:get, uri, {a: 1}, {'User-Agent' => 'Minitest'}, {use_ssl: false}])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http.rb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - thoran
@@ -97,6 +97,8 @@ files:
 - 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
@@ -113,6 +115,8 @@ files:
 - test/HTTP/patch_test.rb
 - test/HTTP/post_test.rb
 - test/HTTP/put_test.rb
+- test/HTTP/request_with_body_test.rb
+- test/HTTP/request_without_body_test.rb
 - test/HTTP/trace_test.rb
 - test/Net/HTTPResponse/StatusPredicates_test.rb
 - test/helper.rb