http.rb 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbf011f369bb382e03c0ec192cb6ab4d0cad2f0e
-  data.tar.gz: 0f6803e5073848ba81088f019cd70e3d10be1f66
+  metadata.gz: 751b8b4052533b0498e04222713234378e7a0eb2
+  data.tar.gz: f14d21a8c49ac437c252f03be490a139e5551126
 SHA512:
-  metadata.gz: 0e2584ee7057eebefe3bea61cc7946b92e0a8b11032aceb3c512dff88c62069924233ef82384199f0eb82785d53df3a1b04499c584ac6e8fda2e150f394b9745
-  data.tar.gz: ec8300cb750bc3afd170a29a99de366b6d821a52d7f1ae26ff5d9ae5cd394dab0094cb90b8f866d7dbb2af43b4a94cf0bdd93b17da5b7bbd43531f39f672f7fc
+  metadata.gz: 6ac92d7be20b5d4e260ed369a974b36c988f6f059eefeb6eddb04cbeb3fc6bd67c325ebd02093660deb6201f799ae028a13fed64f4ce1e0289199742d4b0afe1
+  data.tar.gz: 0b4abaec5371343017d3d42c2d24b9f3e84fcc2b0a29feef493a8f695bd9f3f1b4162dde3522cd4b26cd508790db4145a08a94e04e254c9bdb28c8df87bd4686

data/README.md

@@ -89,6 +89,92 @@ end
 
 ```
 
+## Allowed values for the options hash (which passes through to Net::HTTP)
+```Ruby
+ca_file
+    # Sets path of a CA certification file in PEM format.
+    #
+    # The file can contain several CA certificates.
+
+ca_path
+    # Sets path of a CA certification directory containing certifications in
+    # PEM format.
+
+cert
+    # Sets an OpenSSL::X509::Certificate object as client certificate.
+    # (This method is appeared in Michal Rokos's OpenSSL extension).
+
+cert_store
+    # Sets the X509::Store to verify peer certificate.
+
+ciphers
+    # Sets the available ciphers.  See OpenSSL::SSL::SSLContext#ciphers=
+
+close_on_empty_response
+
+continue_timeout
+    # Number of seconds to wait for one block to be read (via one read(2)
+    # call). Any number may be used, including Floats for fractional
+    # seconds. If the HTTP object cannot read data in this many seconds,
+    # it raises a Net::ReadTimeout exception. The default value is 60 seconds.
+
+keep_alive_timeout
+    # Seconds to reuse the connection of the previous request.
+    # If the idle time is less than this Keep-Alive Timeout,
+    # Net::HTTP reuses the TCP/IP socket used by the previous communication.
+    # The default value is 2 seconds.
+
+key
+    # Sets an OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
+    # (This method is appeared in Michal Rokos's OpenSSL extension.)
+
+local_host
+    # The local host used to establish the connection.
+
+local_port
+    # The local port used to establish the connection.
+
+open_timeout
+    # Number of seconds to wait for the connection to open. Any number
+    # may be used, including Floats for fractional seconds. If the HTTP
+    # object cannot open a connection in this many seconds, it raises a
+    # Net::OpenTimeout exception. The default value is 60 seconds.
+
+proxy_address
+proxy_from_env
+proxy_pass
+proxy_port
+proxy_user
+
+read_timeout
+    # Seconds to wait for 100 Continue response. If the HTTP object does not
+    # receive a response in this many seconds it sends the request body. The
+    # default value is +nil+.
+
+ssl_timeout
+    # Sets the SSL timeout seconds.
+
+ssl_version
+    # Sets the SSL version.  See OpenSSL::SSL::SSLContext#ssl_version=
+
+use_ssl
+    # Turn on/off SSL.
+    # This flag must be set before starting session.
+    # If you change use_ssl value after session started,
+    # a Net::HTTP object raises IOError.
+
+verify_callback
+    # Sets the verify callback for the server certification verification.
+
+verify_depth
+    # Sets the maximum depth for the certificate chain verification.
+
+verify_mode
+    # Sets the flags for server the certification verification at beginning of
+    # SSL/TLS session.
+    #
+    # OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER are acceptable.
+```
 
 ## Contributing
 

data/http.rb.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
-  s.name = 'http.rb'
-  s.version = '0.11.1'
-  s.date = '2015-05-18'
+  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.0'
+  s.date = '2017-10-07'
 
   s.summary = "HTTP made easy."
   s.description = "HTTP is the simplest HTTP mezzanine library for Ruby.  Supply a URI, \
-    some optional query arguments, some optional headers, and some other SSL or \
+    some optional query arguments, some optional headers, and some \
     Net::HTTP options, and that's it!"
   s.author = 'thoran'
   s.email = 'code@thoran.com'

data/lib/HTTP/get.rb

@@ -9,6 +9,7 @@ lib_dir = File.expand_path(File.join(__FILE__, '..', '..'))
 $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 'URI/Generic/use_sslQ'
 
@@ -17,15 +18,21 @@ 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)
-    http.use_ssl = options[:use_ssl] || uri.use_ssl?
-    http.verify_mode = options[:verify_mode] || OpenSSL::SSL::VERIFY_NONE
-    options.each{|k,v| http.send("#{k}=", v)}
+    options[:use_ssl] ||= uri.use_ssl?
+    options[:verify_mode] ||= OpenSSL::SSL::VERIFY_NONE
+    http.options = options
     request_object = Net::HTTP::Get.new(uri.request_uri + '?' + args.x_www_form_urlencode)
     request_object.headers = headers
     request_object.basic_auth(uri.user, uri.password) if uri.user
     response = http.request(request_object)
     if response.code =~ /^3/
-      response = get(response.header['location'], {}, {}, options, &block)
+      redirect_uri = URI.parse(response.header['location'])
+      if redirect_uri.scheme
+        response = get(response.header['location'], {}, {}, options, &block)
+      else
+        new_location = "http://#{uri.host}:#{uri.port}#{response.header['location']}"
+        response = get(new_location, {}, {}, options, &block)
+      end
     end
     if block_given?
       yield response

data/lib/HTTP/post.rb

@@ -9,6 +9,7 @@ lib_dir = File.expand_path(File.join(__FILE__, '..', '..'))
 $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 'URI/Generic/use_sslQ'
 
@@ -17,16 +18,22 @@ module HTTP
   def post(uri, form_data = {}, headers = {}, options = {}, &block)
     uri = uri.is_a?(URI) ? uri : URI.parse(uri)
     http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = options[:use_ssl] || uri.use_ssl?
-    http.verify_mode = options[:verify_mode] || OpenSSL::SSL::VERIFY_NONE
-    options.each{|k,v| http.send("#{k}=", v)}
+    options[:use_ssl] ||= uri.use_ssl?
+    options[:verify_mode] ||= OpenSSL::SSL::VERIFY_NONE
+    http.options = options
     request_object = Net::HTTP::Post.new(uri.request_uri)
     request_object.form_data = form_data
     request_object.headers = headers
     request_object.basic_auth(uri.user, uri.password) if uri.user
     response = http.request(request_object)
     if response.code =~ /^3/
-      response = get(response.header['location'], {}, {}, options, &block)
+      redirect_uri = URI.parse(response.header['location'])
+      if redirect_uri.scheme
+        response = get(response.header['location'], {}, {}, options, &block)
+      else
+        new_location = "http://#{uri.host}:#{uri.port}#{response.header['location']}"
+        response = get(new_location, {}, {}, options, &block)
+      end
     end
     if block_given?
       yield response

data/lib/Net/HTTP/set_options.rb

@@ -0,0 +1,16 @@
+# Net/HTTP/set_options.rb
+# Net::HTTP#set_options
+
+# 20171007
+# 0.0.0
+
+module Net
+  class HTTP
+
+    def set_options(options = {})
+      options.each{|k,v| self.send("#{k}=", v)}
+    end
+    alias_method :options=, :set_options
+
+  end
+end

data/spec/HTTP/get_spec.rb

@@ -6,9 +6,6 @@ $LOAD_PATH.unshift(spec_dir) unless $LOAD_PATH.include?(spec_dir)
 require 'spec_helper'
 require 'HTTP/get'
 
-WebMock.enable!
-WebMock.disable_net_connect!(allow_localhost: true)
-
 describe ".get" do
 
   context "with uri-only supplied" do
@@ -144,12 +141,12 @@ describe ".get" 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})
+            to_return(status: 301, body: '', headers: {'location' => redirect_uri})
       end
 
       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, {}, {}, {}).and_call_original
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
         HTTP.get(request_uri)
       end
     end
@@ -158,12 +155,52 @@ describe ".get" 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})
+            to_return(status: 302, body: '', headers: {'location' => redirect_uri})
       end
 
       it "does a redirect" do
-        expect(HTTP).to receive(:get).with(request_uri).and_call_original
-        expect(HTTP).to receive(:get).with(redirect_uri, {}, {}, {}).and_call_original
+        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)
+      end
+    end
+  end
+
+  context "with path only redirection" do
+    let(:request_uri){'http://example.com/path'}
+    let(:redirect_path){'/new_path'}
+    let(:redirect_uri){"http://example.com:80#{redirect_path}"}
+
+    before do
+      stub_request(:get, redirect_uri).
+        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+          to_return(status: 200, body: '', headers: {})
+    end
+
+    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_path})
+      end
+
+      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)
+      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_path})
+      end
+
+      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)
       end
     end

data/spec/HTTP/post_spec.rb

@@ -6,15 +6,12 @@ $LOAD_PATH.unshift(spec_dir) unless $LOAD_PATH.include?(spec_dir)
 require 'spec_helper'
 require 'HTTP/post'
 
-WebMock.enable!
-WebMock.disable_net_connect!(allow_localhost: true)
-
 describe ".post" do
 
   context "with uri-only supplied" do
     before do
       stub_request(:post, 'http://example.com/path').
-        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Ruby'}).
           to_return(status: 200, body: '', headers: {})
     end
 
@@ -61,7 +58,7 @@ describe ".post" do
 
     before do
       stub_request(:post, "http://example.com/path").
-        with(body: {"a"=>"1", "b"=>"2"}, headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+        with(body: {"a"=>"1", "b"=>"2"}, headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Ruby'}).
           to_return(status: 200, body: '', headers: {})
     end
 
@@ -86,7 +83,7 @@ describe ".post" do
 
     before do
       stub_request(:post, 'http://example.com/path').
-        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Rspec'}).
+        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Rspec'}).
           to_return(status: 200, body: '', headers: {})
     end
 
@@ -105,7 +102,7 @@ describe ".post" do
 
     before do
       stub_request(:post, 'https://example.com:80/path').
-        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Ruby'}).
           to_return(status: 200, body: '', headers: {})
     end
 
@@ -121,7 +118,7 @@ describe ".post" do
 
     before do
       stub_request(:post, 'http://example.com/path').
-        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Ruby'}).
           to_return(status: 200, body: '', headers: {})
     end
 
@@ -145,12 +142,12 @@ describe ".post" 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})
+            to_return(status: 301, body: '', headers: {'location' => redirect_uri})
       end
 
       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, {}, {}, {}).and_call_original
+        expect(HTTP).to receive(:get).once.with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
         HTTP.post(request_uri)
       end
     end
@@ -159,12 +156,52 @@ describe ".post" 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})
+            to_return(status: 302, body: '', headers: {'location' => redirect_uri})
       end
 
       it "does a redirect" do
         expect(HTTP).to receive(:post).with(request_uri).and_call_original
-        expect(HTTP).to receive(:get).with(redirect_uri, {}, {}, {}).and_call_original
+        expect(HTTP).to receive(:get).with(redirect_uri, {}, {}, {use_ssl: false, verify_mode: 0})
+        HTTP.post(request_uri)
+      end
+    end
+  end
+
+  context "with path only redirection" do
+    let(:request_uri){'http://example.com/path'}
+    let(:redirect_path){'/new_path'}
+    let(:redirect_uri){"http://example.com:80#{redirect_path}"}
+
+    before do
+      stub_request(:get, redirect_uri).
+        with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}).
+          to_return(status: 200, body: '', headers: {})
+    end
+
+    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_path})
+      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(:post).once.with(request_uri).and_call_original
+        HTTP.post(request_uri)
+      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', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Ruby'}).
+            to_return(status: 302, body: '', headers: {'location' => redirect_path})
+      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(:post).once.with(request_uri).and_call_original
         HTTP.post(request_uri)
       end
     end

data/spec/spec_helper.rb

@@ -4,4 +4,3 @@ lib_dir = File.expand_path(File.join(__FILE__, '..', '..', 'lib'))
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'webmock/rspec'
-WebMock.allow_net_connect!

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: http.rb
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - thoran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2017-10-07 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 other SSL or     Net::HTTP
-  options, and that's it!
+  optional query arguments, some optional headers, and some     Net::HTTP options,
+  and that's it!
 email: code@thoran.com
 executables: []
 extensions: []
@@ -27,9 +27,9 @@ files:
 - lib/Hash/x_www_form_urlencode.rb
 - lib/Net/HTTP/Get/set_headers.rb
 - lib/Net/HTTP/Post/set_headers.rb
+- lib/Net/HTTP/set_options.rb
 - lib/String/url_encode.rb
 - lib/URI/Generic/use_sslQ.rb
-- spec/HTTP.rb
 - spec/HTTP/get_spec.rb
 - spec/HTTP/post_spec.rb
 - spec/spec_helper.rb
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: HTTP made easy.

data/spec/HTTP.rb

@@ -1,12 +0,0 @@
-# spec/HTTP.rb
-
-spec_dir = File.expand_path(File.join(__FILE__, '..'))
-$LOAD_PATH.unshift(spec_dir) unless $LOAD_PATH.include?(spec_dir)
-
-require 'spec_helper'
-
-require 'HTTP/get'
-require 'HTTP/post'
-
-require 'HTTP/get_spec'
-require 'HTTP/post_spec'