http.rb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6cf64d373fd047e68f56e4d612f0aa7569c69e183dde7057c7cef706861d7b0
-  data.tar.gz: e817f97f6747c05c492823dfeea938f45db80fc77fb2ef5adb93e69818a12faa
+  metadata.gz: a5f552ac83d2afe5184c79455af215f58e18cc7e0f01e1a8bf684a877f8b9d9a
+  data.tar.gz: 274244f8126d9dbb09b17c1a46be7a7c037ecab83ca8ae5af5bc4d7f3463c07b
 SHA512:
-  metadata.gz: 466fadc13d04a2333864c0e2c5337454bb6010293f86346d9a8d8ea06f4e577952a3451eb16997f6723882ca4fe8f598784c1675698b56a3f1594a2a39781f0a
-  data.tar.gz: f52d5e6362127c020091e1d8b2317ad909edf1f3a36e4341f8dba1d8ba92a358ff9fab206eb7e276d7e4e670db7e9af55b885ae9e54224d94d05b6d9563f7d84
+  metadata.gz: e0fdfcf607047e62db109a3ec414cebf308b270e2757d510f8f337628f0b235a947f4769a5e78a32abd137ce764f63822ca9ff26ccfc5fbc01db39ead0ef1152
+  data.tar.gz: fb725d77aa4f4312803dadd481b62a705dd3286568469a1ae055a609a86d9991583dd69a7110864375b5835eecbba9ab06ad39ffbc4f61e428686787690908c2

data/CHANGELOG

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 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.
+
+1. ~ HTTP/request.rb: Extract :username and :password from the options hash; basic_auth now prefers the explicit credentials and falls back to the URI credentials.
+2. + test/HTTP/basic_auth_test.rb
+3. ~ README.md: + Basic authentication usage section; document the username and password options.
+4. ~ HTTP::VERSION: /1.0.0/1.1.0/
+5. ~ CHANGELOG: + 1.1.0 entry
+
 ## 20260522
 
 1.0.0: API stability declaration.

data/README.md

@@ -77,6 +77,22 @@ HTTP.post('http://example.com', {a: 1, b: 2}, {'User-Agent'=>'Custom'}, {use_ssl
 end
 ```
 
+### Basic authentication
+
+Pass `username:` and `password:` through the options hash:
+
+```ruby
+HTTP.get('http://example.com', {}, {}, {username: 'alice', password: 'secret'})
+```
+
+Credentials embedded in the URI continue to work and serve as a fallback:
+
+```ruby
+HTTP.get('http://alice:secret@example.com')
+```
+
+When both are supplied, the options hash wins.
+
 ### Preventing redirections
 
 ```ruby
@@ -167,12 +183,19 @@ end
 ```
 
 ## Allowed values for the options hash
-#### (These pass through to Net::HTTP, except for `no_redirect`.)
+#### (These pass through to Net::HTTP, except for `no_redirect`, `username`, and `password`.)
 
 ```Ruby
 no_redirect
     # Prevents redirection if a 3xx response is encountered.
 
+username
+    # Username for HTTP basic authentication. Takes precedence over any
+    # credentials embedded in the URI.
+
+password
+    # Password for HTTP basic authentication, paired with username.
+
 ca_file
     # Sets path of a CA certification file in PEM format.
     #

data/lib/HTTP/VERSION.rb

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

data/lib/HTTP/request.rb

@@ -16,13 +16,19 @@ module HTTP
     uri = uri.is_a?(URI) ? uri : URI.parse(uri)
     http = Net::HTTP.new(uri.host, uri.port)
     no_redirect = options.delete(:no_redirect)
+    username = options.delete(:username)
+    password = options.delete(:password)
     config = retry_config(options)
     http.options = options.merge(
       use_ssl: (options[:use_ssl] || uri.use_ssl?),
       verify_mode: (options[:verify_mode] || OpenSSL::SSL::VERIFY_PEER)
     )
     request_object.headers = headers
-    request_object.basic_auth(uri.user, uri.password) if uri.user
+    if username
+      request_object.basic_auth(username, password)
+    elsif uri.user
+      request_object.basic_auth(uri.user, uri.password)
+    end
     verb = request_object.method.downcase.to_sym
     response = (
       if config[:retries] > 0 && config[:verbs].include?(verb)

data/test/HTTP/basic_auth_test.rb

@@ -0,0 +1,106 @@
+# test/HTTP/basic_auth_test.rb
+
+require_relative '../helper'
+
+describe "basic auth" do
+  describe "via the options hash" do
+    let(:uri){'http://example.com/path'}
+    let(:parsed_uri){URI.parse(uri)}
+
+    before do
+      stub_request(:get, uri).
+        to_return(status: 200, body: '', headers: {})
+    end
+
+    it "sets the Authorization header from the username and password options" do
+      request_object = Net::HTTP::Get.new(parsed_uri.request_uri)
+      Net::HTTP::Get.stub(:new, request_object) do
+        response = HTTP.get(uri, {}, {}, {username: 'alice', password: 'secret'})
+        _(request_object['Authorization']).must_equal("Basic #{['alice:secret'].pack('m0')}")
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "via the URI" do
+    let(:uri){'http://alice:secret@example.com/path'}
+    let(:parsed_uri){URI.parse(uri)}
+
+    before do
+      stub_request(:get, 'http://example.com/path').
+        to_return(status: 200, body: '', headers: {})
+    end
+
+    it "sets the Authorization header from the embedded credentials" do
+      request_object = Net::HTTP::Get.new(parsed_uri.request_uri)
+      Net::HTTP::Get.stub(:new, request_object) do
+        response = HTTP.get(uri)
+        _(request_object['Authorization']).must_equal("Basic #{['alice:secret'].pack('m0')}")
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "with a username but no password" do
+    let(:uri){'http://example.com/path'}
+    let(:parsed_uri){URI.parse(uri)}
+
+    before do
+      stub_request(:get, uri).
+        to_return(status: 200, body: '', headers: {})
+    end
+
+    it "sends an empty password" do
+      request_object = Net::HTTP::Get.new(parsed_uri.request_uri)
+      Net::HTTP::Get.stub(:new, request_object) do
+        response = HTTP.get(uri, {}, {}, {username: 'alice'})
+        _(request_object['Authorization']).must_equal("Basic #{['alice:'].pack('m0')}")
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "with credentials in both the options hash and the URI" do
+    let(:uri){'http://alice:secret@example.com/path'}
+    let(:parsed_uri){URI.parse(uri)}
+
+    before do
+      stub_request(:get, 'http://example.com/path').
+        to_return(status: 200, body: '', headers: {})
+    end
+
+    it "prefers the options credentials over the URI credentials" do
+      request_object = Net::HTTP::Get.new(parsed_uri.request_uri)
+      Net::HTTP::Get.stub(:new, request_object) do
+        response = HTTP.get(uri, {}, {}, {username: 'bob', password: 'hunter2'})
+        _(request_object['Authorization']).must_equal("Basic #{['bob:hunter2'].pack('m0')}")
+        _(response.success?).must_equal(true)
+      end
+    end
+  end
+
+  describe "leakage into Net::HTTP options" do
+    let(:uri){'http://example.com/path'}
+    let(:parsed_uri){URI.parse(uri)}
+
+    before do
+      stub_request(:get, uri).
+        to_return(status: 200, body: '', headers: {})
+    end
+
+    it "does not pass the auth options through to Net::HTTP" do
+      passed_options = nil
+      net_http_object = Net::HTTP.new(parsed_uri.host, parsed_uri.port)
+      original_options_setter = net_http_object.method(:options=)
+      net_http_object.define_singleton_method(:options=) do |options|
+        passed_options = options
+        original_options_setter.call(options)
+      end
+      Net::HTTP.stub(:new, net_http_object) do
+        HTTP.get(uri, {}, {}, {username: 'alice', password: 'secret'})
+      end
+      _(passed_options.key?(:username)).must_equal(false)
+      _(passed_options.key?(:password)).must_equal(false)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http.rb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - thoran
@@ -105,6 +105,7 @@ files:
 - lib/String/url_encode.rb
 - lib/URI/Generic/use_sslQ.rb
 - test/HTTP/RETRY_test.rb
+- test/HTTP/basic_auth_test.rb
 - test/HTTP/delete_test.rb
 - test/HTTP/get_test.rb
 - test/HTTP/head_test.rb
@@ -133,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.12
+rubygems_version: 4.0.13
 specification_version: 4
 summary: HTTP made easy.
 test_files: []