http.rb 0.12.1 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b5868b1582ef96a23021bef26cbfaa4e7ee7a63f28566e20c5f53d6ba91356
-  data.tar.gz: 9af58e51678e5b6ba65d55ffdca2d2382cde427fb7e2db2a5999a1e137344969
+  metadata.gz: 1dde44381215bd0f99a698070bbf0a95ca4178fa8a796ed9de6ca7114d9f4cf1
+  data.tar.gz: 9c2186e4d466a1fa2eedb8ad0c305b1d631e22453c0275ac1309d2b7cafedaa6
 SHA512:
-  metadata.gz: 291e79fc695b67dde10145d69311a79c2529f9cac03a217abbbeb254920c8aa137e0220f0e3f2eba3d46b482757a5c1777197fb4dc758dc0adb67918039a5924
-  data.tar.gz: ec2e4b6caf7878518de41ceec6881ebb957dfcca50bc9e3aaa4295b9893ff825459e374c3ebaaf22c6ec1eadb9c6e762459d833f71fbe71397c6b91fb44a217c
+  metadata.gz: aebcba1e71b81d0c8f02b51fa88c1655f752a37a8ef987d16a53e2ba2459d29a17757225703de090c7beb9d5e938e08224350b4dd844943252811c9c8c339228
+  data.tar.gz: c5110f64b0918ffb3e855b834af2177e99c3efcec4b57ab217c0536fa522359755204ad2a21b24ce62ffbe99d71695e56f9cbc9a48e29dae4e46abf81fff47a9

data/README.md

@@ -19,7 +19,7 @@ Perhaps someone will appreciate its relative simplicity, since it is much smalle
 
 Add this line to your application's Gemfile:
 
-	gem 'http.rb'
+    gem 'HTTP.rb'
 
 And then execute:
 
@@ -27,7 +27,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install http.rb
+    $ gem install HTTP.rb
 
 
 ## Usage
@@ -75,6 +75,56 @@ HTTP.post('http://example.com', {a: 1, b: 2}, {'User-Agent'=>'Custom'}, {use_ssl
   # Do stuff with a subclass of Net::HTTPResponse here...
 end
 
+# Preventing redirections
+
+HTTP.get('http://example.com', {}, {}, {no_redirect: true})
+# => #<Net::HTTPResponse @code=3xx>
+
+# Response status predicate methods
+
+# 1xx
+response = HTTP.get('http://example.com')
+response.informational?
+# => true
+
+# 2xx
+response = HTTP.get('http://example.com')
+response.success?
+# => true
+
+# 3xx
+response = HTTP.get('http://example.com', {}, {}, {no_redirect: true})
+response.redirection?
+# => true
+response.success?
+# => false
+
+response = HTTP.get('http://example.com', {}, {}, {no_redirect: false})
+response.redirection?
+# => false
+response.success?
+# => true
+
+response = HTTP.get('http://example.com')
+response.redirection?
+# => false
+response.success?
+# => true
+
+# 4xx
+response = HTTP.get('http://example.com')
+response.client_error?
+# => true
+response.error?
+# => true
+
+# 5xx
+response = HTTP.get('http://example.com')
+response.server_error?
+# => true
+response.error?
+# => true
+
 # Including it in a class
 
 class A
@@ -93,8 +143,13 @@ end
 
 ```
 
-## Allowed values for the options hash (which passes through to Net::HTTP)
+## Allowed values for the options hash
+#### (These pass through to Net::HTTP, except for `no_redirect`.)
+
 ```Ruby
+no_redirect
+    # Prevents redirection if a 3xx response is encountered.
+
 ca_file
     # Sets path of a CA certification file in PEM format.
     #

data/http.rb.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
-  s.name = 'http.rb' # I would have preferred 'http', but there's a library called http.rb with the gem name of http.  Confusing, eh?
-  s.version = '0.12.1'
-  s.date = '2025-02-07'
+  s.name = 'http.rb'
+  s.version = '0.13.1'
+  s.date = '2025-03-04'
 
   s.summary = "HTTP made easy."
   s.description = "HTTP is the simplest HTTP mezzanine library for Ruby.  Supply a URI, \
@@ -20,6 +20,4 @@ Gem::Specification.new do |s|
   ].flatten
 
   s.require_paths = ['lib']
-
-  s.has_rdoc = false
 end

data/lib/HTTP/get.rb

@@ -11,6 +11,7 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'Hash/x_www_form_urlencode'
 require 'Net/HTTP/set_options'
 require 'Net/HTTP/Get/set_headers'
+require 'Net/HTTPResponse/StatusPredicates'
 require 'URI/Generic/use_sslQ'
 
 module HTTP
@@ -18,6 +19,7 @@ module HTTP
   def get(uri, args = {}, headers = {}, options = {}, &block)
     uri = uri.is_a?(URI) ? uri : URI.parse(uri)
     http = Net::HTTP.new(uri.host, uri.port)
+    no_redirect = options.delete(:no_redirect)
     options[:use_ssl] ||= uri.use_ssl?
     options[:verify_mode] ||= OpenSSL::SSL::VERIFY_NONE
     http.options = options
@@ -26,6 +28,11 @@ module HTTP
     request_object.basic_auth(uri.user, uri.password) if uri.user
     response = http.request(request_object)
     if response.code =~ /^3/
+      if block_given? && no_redirect
+        yield response
+      elsif no_redirect
+        return response
+      end
       redirect_uri = URI.parse(response.header['location'])
       if redirect_uri.scheme
         response = get(response.header['location'], {}, {}, options, &block)

data/lib/HTTP/post.rb

@@ -12,6 +12,7 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'HTTP/get'
 require 'Net/HTTP/set_options'
 require 'Net/HTTP/Post/set_headers'
+require 'Net/HTTPResponse/StatusPredicates'
 require 'URI/Generic/use_sslQ'
 
 module HTTP
@@ -19,6 +20,7 @@ module HTTP
   def post(uri, data = {}, headers = {}, options = {}, &block)
     uri = uri.is_a?(URI) ? uri : URI.parse(uri)
     http = Net::HTTP.new(uri.host, uri.port)
+    no_redirect = options.delete(:no_redirect)
     options[:use_ssl] ||= uri.use_ssl?
     options[:verify_mode] ||= OpenSSL::SSL::VERIFY_NONE
     http.options = options
@@ -32,6 +34,11 @@ module HTTP
     request_object.basic_auth(uri.user, uri.password) if uri.user
     response = http.request(request_object)
     if response.code =~ /^3/
+      if block_given? && no_redirect
+        yield response
+      elsif no_redirect
+        return response
+      end
       redirect_uri = URI.parse(response.header['location'])
       if redirect_uri.scheme
         response = get(response.header['location'], {}, {}, options, &block)

data/lib/Net/HTTPResponse/StatusPredicates.rb

@@ -0,0 +1,33 @@
+module Net
+  class HTTPResponse
+    module StatusPredicates
+      def informational?
+        @code =~ /^1/  ? true : false
+      end
+
+      def successful?
+        @code =~ /^2/ ? true : false
+      end
+      alias_method :success?, :successful?
+      alias_method :ok?, :successful?
+
+      def redirection?
+        @code =~ /^3/ ? true : false
+      end
+
+      def client_error?
+        @code =~ /^4/ ? true : false
+      end
+
+      def server_error?
+        @code =~ /^5/ ? true : false
+      end
+
+      def error?
+        client_error? || server_error?
+      end
+    end
+  end
+end
+
+Net::HTTPResponse.include(Net::HTTPResponse::StatusPredicates)

data/spec/HTTP/get_spec.rb

@@ -21,12 +21,14 @@ describe ".get" do
 
       it "creates an instance of URI" do
         expect(URI).to receive(:parse).with(uri).and_return(parsed_uri)
-        HTTP.get(uri)
+        response = HTTP.get(uri)
+        expect(response.success?).to eq(true)
       end
 
       it "creates a new Net::HTTP object" do
         expect(Net::HTTP).to receive(:new).with(parsed_uri.host, parsed_uri.port).and_return(net_http_object)
-        HTTP.get(uri)
+        response = HTTP.get(uri)
+        expect(response.success?).to eq(true)
       end
     end
 
@@ -42,7 +44,8 @@ describe ".get" do
 
       it "creates a new Net::HTTP object" do
         expect(Net::HTTP).to receive(:new).with(uri.host, uri.port).and_return(net_http_object)
-        HTTP.get(uri)
+        response = HTTP.get(uri)
+        expect(response.success?).to eq(true)
       end
     end
   end
@@ -63,12 +66,14 @@ describe ".get" do
 
     it "x_www_form_urlencode's the args" do
       expect(args).to receive(:x_www_form_urlencode).and_return(x_www_form_urlencoded_arguments)
-      HTTP.get(uri, args)
+      response = HTTP.get(uri, args)
+      expect(response.success?).to eq(true)
     end
 
     it "creates a new Net::HTTP::Get object" do
       expect(Net::HTTP::Get).to receive(:new).with(get_argument).and_return(request_object)
-      HTTP.get(uri, args)
+      response = HTTP.get(uri, args)
+      expect(response.success?).to eq(true)
     end
   end
 
@@ -87,8 +92,9 @@ describe ".get" do
 
     it "sets the headers on the request object" do
       allow(Net::HTTP::Get).to receive(:new).with(get_argument).and_return(request_object)
-      HTTP.get(uri, {}, headers)
+      response = HTTP.get(uri, {}, headers)
       expect(request_object['User-Agent']).to eq('Rspec')
+      expect(response.success?).to eq(true)
     end
   end
 
@@ -106,8 +112,9 @@ describe ".get" do
 
     it "sets the use_ssl option on the Net::HTTP instance" do
       allow(Net::HTTP).to receive(:new).with(parsed_uri.host, parsed_uri.port).and_return(net_http_object)
-      HTTP.get(uri, {}, {}, options)
+      response = HTTP.get(uri, {}, {}, options)
       expect(net_http_object.instance_variable_get(:@use_ssl)).to be_truthy
+      expect(response.success?).to eq(true)
     end
   end
 
@@ -122,7 +129,6 @@ describe ".get" do
 
     it "yields an instance of Net::HTTPResponse" do
       expect{|b| HTTP.get(uri, &b)}.to yield_with_args(Net::HTTPResponse)
-      HTTP.get(uri){|response|}
     end
   end
 
@@ -145,8 +151,9 @@ describe ".get" do
 
       it "does a redirect" do
         expect(HTTP).to receive(:get).once.with(request_uri).and_call_original
-        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
-        HTTP.get(request_uri)
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0}).and_call_original
+        response = HTTP.get(request_uri)
+        expect(response.success?).to eq(true)
       end
     end
 
@@ -159,8 +166,9 @@ describe ".get" do
 
       it "does a redirect" do
         expect(HTTP).to receive(:get).once.with(request_uri).and_call_original
-        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
-        HTTP.get(request_uri)
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0}).and_call_original
+        response = HTTP.get(request_uri)
+        expect(response.success?).to eq(true)
       end
     end
   end
@@ -185,8 +193,9 @@ describe ".get" do
 
       it "does a redirect" do
         expect(HTTP).to receive(:get).once.with(request_uri).and_call_original
-        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
-        HTTP.get(request_uri)
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0}).and_call_original
+        response = HTTP.get(request_uri)
+        expect(response.success?).to eq(true)
       end
     end
 
@@ -199,8 +208,42 @@ describe ".get" do
 
       it "does a redirect" do
         expect(HTTP).to receive(:get).once.with(request_uri).and_call_original
-        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
-        HTTP.get(request_uri)
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0}).and_call_original
+        response = HTTP.get(request_uri)
+        expect(response.success?).to eq(true)
+      end
+    end
+  end
+
+  context "no_redirect true" do
+    let(:request_uri){'http://example.com/path'}
+    let(:redirect_uri){'http://redirected.com'}
+
+    context "via 301" do
+      before do
+        stub_request(:get, request_uri).
+          with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+            to_return(status: 301, body: '', headers: {'location' => redirect_uri})
+      end
+
+      it "doesn't redirect" do
+        expect(HTTP).to receive(:get).once.with(request_uri, {}, {}, {no_redirect: true}).and_call_original
+        response = HTTP.get(request_uri, {}, {}, {no_redirect: true})
+        expect(response.redirection?).to eq(true)
+      end
+    end
+
+    context "via 302" do
+      before do
+        stub_request(:get, request_uri).
+          with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+            to_return(status: 302, body: '', headers: {'location' => redirect_uri})
+      end
+
+      it "doesn't redirect" do
+        expect(HTTP).to receive(:get).once.with(request_uri, {}, {}, {no_redirect: true}).and_call_original
+        response = HTTP.get(request_uri, {}, {}, {no_redirect: true})
+        expect(response.redirection?).to eq(true)
       end
     end
   end

data/spec/HTTP/post_spec.rb

@@ -21,12 +21,14 @@ describe ".post" do
 
       it "creates an instance of URI" do
         expect(URI).to receive(:parse).with(uri).and_return(parsed_uri)
-        HTTP.post(uri)
+        response = HTTP.post(uri)
+        expect(response.success?).to eq(true)
       end
 
       it "creates a new Net::HTTP object" do
         expect(Net::HTTP).to receive(:new).with(parsed_uri.host, parsed_uri.port).and_return(net_http_object)
-        HTTP.post(uri)
+        response = HTTP.post(uri)
+        expect(response.success?).to eq(true)
       end
     end
 
@@ -37,12 +39,14 @@ describe ".post" do
 
       it "returns an instance of URI" do
         expect(uri).to eq(uri)
-        HTTP.post(uri)
+        response = HTTP.post(uri)
+        expect(response.success?).to eq(true)
       end
 
       it "creates a new Net::HTTP object" do
         expect(Net::HTTP).to receive(:new).with(uri.host, uri.port).and_return(net_http_object)
-        HTTP.post(uri)
+        response = HTTP.post(uri)
+        expect(response.success?).to eq(true)
       end
     end
   end
@@ -64,13 +68,15 @@ describe ".post" do
 
     it "sets the form data" do
       allow(Net::HTTP::Post).to receive(:new).with(request_uri).and_return(request_object)
-      HTTP.post(uri, args, headers)
+      response = HTTP.post(uri, args, headers)
       expect(request_object.body).to eq(encoded_form_data)
+      expect(response.success?).to eq(true)
     end
 
     it "creates a new Net::HTTP::Post object" do
       expect(Net::HTTP::Post).to receive(:new).with(request_uri).and_return(request_object)
-      HTTP.post(uri, args, headers)
+      response = HTTP.post(uri, args, headers)
+      expect(response.success?).to eq(true)
     end
   end
 
@@ -91,13 +97,15 @@ describe ".post" do
 
     it "sets the body" do
       allow(Net::HTTP::Post).to receive(:new).with(request_uri).and_return(request_object)
-      HTTP.post(uri, args, headers)
+      response = HTTP.post(uri, args, headers)
       expect(request_object.body).to eq(json_data)
+      expect(response.success?).to eq(true)
     end
 
     it "creates a new Net::HTTP::Post object" do
       expect(Net::HTTP::Post).to receive(:new).with(request_uri).and_return(request_object)
-      HTTP.post(uri, args, headers)
+      response = HTTP.post(uri, args, headers)
+      expect(response.success?).to eq(true)
     end
   end
 
@@ -116,8 +124,9 @@ describe ".post" do
 
     it "sets the headers on the request object" do
       allow(Net::HTTP::Post).to receive(:new).with(request_uri).and_return(request_object)
-      HTTP.post(uri, {}, headers)
+      response = HTTP.post(uri, {}, headers)
       expect(request_object['User-Agent']).to eq('Rspec')
+      expect(response.success?).to eq(true)
     end
   end
 
@@ -135,8 +144,9 @@ describe ".post" do
 
     it "sets the use_ssl option on the Net::HTTP instance" do
       allow(Net::HTTP).to receive(:new).with(parsed_uri.host, parsed_uri.port).and_return(net_http_object)
-      HTTP.post(uri, {}, {}, options)
+      response = HTTP.post(uri, {}, {}, options)
       expect(net_http_object.instance_variable_get(:@use_ssl)).to be_truthy
+      expect(response.success?).to eq(true)
     end
   end
 
@@ -151,7 +161,6 @@ describe ".post" do
 
     it "yields an instance of Net::HTTPResponse" do
       expect{|b| HTTP.post(uri, &b)}.to yield_with_args(Net::HTTPResponse)
-      HTTP.post(uri){|response|}
     end
   end
 
@@ -174,8 +183,9 @@ describe ".post" do
 
       it "does a redirect" do
         expect(HTTP).to receive(:post).once.with(request_uri).and_call_original
-        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
-        HTTP.post(request_uri)
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0}).and_call_original
+        response = HTTP.post(request_uri)
+        expect(response.success?).to eq(true)
       end
     end
 
@@ -188,8 +198,9 @@ describe ".post" do
 
       it "does a redirect" do
         expect(HTTP).to receive(:post).with(request_uri).and_call_original
-        expect(HTTP).to receive(:get).with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
-        HTTP.post(request_uri)
+        expect(HTTP).to receive(:get).with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0}).and_call_original
+        response = HTTP.post(request_uri)
+        expect(response.success?).to eq(true)
       end
     end
   end
@@ -213,9 +224,10 @@ describe ".post" do
       end
 
       it "does a redirect" do
-        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0}).and_call_original
         expect(HTTP).to receive(:post).once.with(request_uri).and_call_original
-        HTTP.post(request_uri)
+        response = HTTP.post(request_uri)
+        expect(response.success?).to eq(true)
       end
     end
 
@@ -227,9 +239,43 @@ describe ".post" do
       end
 
       it "does a redirect" do
-        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0}).and_call_original
         expect(HTTP).to receive(:post).once.with(request_uri).and_call_original
-        HTTP.post(request_uri)
+        response = HTTP.post(request_uri)
+        expect(response.success?).to eq(true)
+      end
+    end
+  end
+
+  context "no_redirect true" do
+    let(:request_uri){'http://example.com/path'}
+    let(:redirect_uri){'http://redirected.com'}
+
+    context "via 301" do
+      before do
+        stub_request(:post, request_uri).
+          with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+            to_return(status: 301, body: '', headers: {'location' => redirect_uri})
+      end
+
+      it "doesn't redirect" do
+        expect(HTTP).to receive(:post).once.with(request_uri, {}, {}, {no_redirect: true}).and_call_original
+        response = HTTP.post(request_uri, {}, {}, {no_redirect: true})
+        expect(response.redirection?).to eq(true)
+      end
+    end
+
+    context "via 302" do
+      before do
+        stub_request(:post, request_uri).
+          with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+            to_return(status: 302, body: '', headers: {'location' => redirect_uri})
+      end
+
+      it "doesn't redirect" do
+        expect(HTTP).to receive(:post).once.with(request_uri, {}, {}, {no_redirect: true}).and_call_original
+        response = HTTP.post(request_uri, {}, {}, {no_redirect: true})
+        expect(response.redirection?).to eq(true)
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: http.rb
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.1
 platform: ruby
 authors:
 - thoran
 bindir: bin
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies: []
 description: HTTP is the simplest HTTP mezzanine library for Ruby.  Supply a URI,     some
   optional query arguments, some optional headers, and some     Net::HTTP options,
@@ -27,6 +27,7 @@ files:
 - lib/Net/HTTP/Get/set_headers.rb
 - lib/Net/HTTP/Post/set_headers.rb
 - lib/Net/HTTP/set_options.rb
+- lib/Net/HTTPResponse/StatusPredicates.rb
 - lib/String/url_encode.rb
 - lib/URI/Generic/use_sslQ.rb
 - spec/HTTP/get_spec.rb
@@ -49,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.5
 specification_version: 4
 summary: HTTP made easy.
 test_files: []