RubyGems - http - Versions diffs - 0.7.4 → 0.8.0.pre - Mend

http 0.7.4 → 0.8.0.pre

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

checksums.yaml +4 -4
data/.rspec +0 -1
data/.rubocop.yml +5 -2
data/CHANGES.md +24 -7
data/CONTRIBUTING.md +25 -0
data/Gemfile +24 -22
data/Guardfile +2 -2
data/README.md +34 -4
data/Rakefile +7 -7
data/examples/parallel_requests_with_celluloid.rb +2 -2
data/http.gemspec +12 -12
data/lib/http.rb +11 -10
data/lib/http/cache.rb +146 -0
data/lib/http/cache/headers.rb +100 -0
data/lib/http/cache/null_cache.rb +13 -0
data/lib/http/chainable.rb +14 -3
data/lib/http/client.rb +64 -80
data/lib/http/connection.rb +139 -0
data/lib/http/content_type.rb +2 -2
data/lib/http/errors.rb +7 -1
data/lib/http/headers.rb +21 -8
data/lib/http/headers/mixin.rb +1 -1
data/lib/http/mime_type.rb +2 -2
data/lib/http/mime_type/adapter.rb +2 -2
data/lib/http/mime_type/json.rb +4 -4
data/lib/http/options.rb +65 -74
data/lib/http/redirector.rb +3 -3
data/lib/http/request.rb +20 -13
data/lib/http/request/caching.rb +95 -0
data/lib/http/request/writer.rb +5 -5
data/lib/http/response.rb +15 -9
data/lib/http/response/body.rb +21 -8
data/lib/http/response/caching.rb +142 -0
data/lib/http/response/io_body.rb +63 -0
data/lib/http/response/parser.rb +1 -1
data/lib/http/response/status.rb +4 -12
data/lib/http/response/status/reasons.rb +53 -53
data/lib/http/response/string_body.rb +53 -0
data/lib/http/version.rb +1 -1
data/spec/lib/http/cache/headers_spec.rb +77 -0
data/spec/lib/http/cache_spec.rb +182 -0
data/spec/lib/http/client_spec.rb +123 -95
data/spec/lib/http/content_type_spec.rb +25 -25
data/spec/lib/http/headers/mixin_spec.rb +8 -8
data/spec/lib/http/headers_spec.rb +213 -173
data/spec/lib/http/options/body_spec.rb +5 -5
data/spec/lib/http/options/form_spec.rb +3 -3
data/spec/lib/http/options/headers_spec.rb +7 -7
data/spec/lib/http/options/json_spec.rb +3 -3
data/spec/lib/http/options/merge_spec.rb +26 -22
data/spec/lib/http/options/new_spec.rb +10 -10
data/spec/lib/http/options/proxy_spec.rb +8 -8
data/spec/lib/http/options_spec.rb +2 -2
data/spec/lib/http/redirector_spec.rb +32 -32
data/spec/lib/http/request/caching_spec.rb +133 -0
data/spec/lib/http/request/writer_spec.rb +26 -26
data/spec/lib/http/request_spec.rb +63 -58
data/spec/lib/http/response/body_spec.rb +13 -13
data/spec/lib/http/response/caching_spec.rb +201 -0
data/spec/lib/http/response/io_body_spec.rb +35 -0
data/spec/lib/http/response/status_spec.rb +25 -25
data/spec/lib/http/response/string_body_spec.rb +35 -0
data/spec/lib/http/response_spec.rb +64 -45
data/spec/lib/http_spec.rb +103 -76
data/spec/spec_helper.rb +10 -12
data/spec/support/connection_reuse_shared.rb +100 -0
data/spec/support/create_certs.rb +12 -12
data/spec/support/dummy_server.rb +11 -11
data/spec/support/dummy_server/servlet.rb +43 -31
data/spec/support/proxy_server.rb +31 -25
metadata +57 -8
data/spec/support/example_server.rb +0 -30
data/spec/support/example_server/servlet.rb +0 -102

data/spec/spec_helper.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 # coding: utf-8
-require 'simplecov'
-require 'coveralls'
+require "simplecov"
+require "coveralls"
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
@@ -9,22 +9,20 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 ]
 SimpleCov.start do
-  add_filter '/spec/'
+  add_filter "/spec/"
   minimum_coverage 80
 end
-require 'http'
-require 'rspec/its'
-require 'support/example_server'
-require 'support/proxy_server'
-require 'support/capture_warning'
+require "http"
+require "rspec/its"
+require "support/capture_warning"
 # Allow testing against a SSL server
 def certs_dir
-  Pathname.new File.expand_path('../../tmp/certs', __FILE__)
+  Pathname.new File.expand_path("../../tmp/certs", __FILE__)
 end
-require 'support/create_certs'
+require "support/create_certs"
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
@@ -62,7 +60,7 @@ RSpec.configure do |config|
   # This setting enables warnings. It's recommended, but in some cases may
   # be too noisy due to issues in dependencies.
-  config.warnings = true
+  config.warnings = 0 == ENV["GUARD_RSPEC"].to_i
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
@@ -71,7 +69,7 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+    config.default_formatter = "doc"
   end
   # Print the 10 slowest examples and example groups at the

data/spec/support/connection_reuse_shared.rb ADDED Viewed

@@ -0,0 +1,100 @@
+RSpec.shared_context "handles shared connections" do
+  describe "connection reuse" do
+    let(:sockets_used) do
+      [
+        client.get("#{server.endpoint}/socket/1").body.to_s,
+        client.get("#{server.endpoint}/socket/2").body.to_s
+      ]
+    end
+    context "when enabled" do
+      let(:reuse_conn) { server.endpoint }
+      context "without a host" do
+        it "infers host from persistent config" do
+          expect(client.get("/").body.to_s).to eq("<!doctype html>")
+        end
+      end
+      it "re-uses the socket" do
+        expect(sockets_used).to_not include("")
+        expect(sockets_used.uniq.length).to eq(1)
+      end
+      context "when trying to read a stale body" do
+        it "errors" do
+          first_res = client.get(server.endpoint)
+          second_res = client.get(server.endpoint)
+          # This should work, because it's the last request we made
+          expect(second_res.body.to_s).to eq("<!doctype html>")
+          # This should not work because we've not read anything
+          expect { first_res.body.to_s }.to raise_error(HTTP::StateError, /Sequence ID 1 does not match 2/i)
+        end
+      end
+      context "when reading a cached body" do
+        it "succeeds" do
+          first_res = client.get(server.endpoint)
+          first_res.body.to_s
+          second_res = client.get(server.endpoint)
+          expect(first_res.body.to_s).to eq("<!doctype html>")
+          expect(second_res.body.to_s).to eq("<!doctype html>")
+        end
+      end
+      context "when streaming" do
+        it "errors with a stale response" do
+          first_res = client.get(server.endpoint)
+          second_res = client.get(server.endpoint)
+          # This should work, because it's the last request we made
+          expect(second_res.body.to_s).to eq("<!doctype html>")
+          # This should not work because we've not read anything
+          expect { first_res.body.each(&:to_s) }.to raise_error(HTTP::StateError, /Sequence ID 1 does not match 2/i)
+        end
+      end
+      context "with a socket issue" do
+        it "transparently reopens" do
+          first_socket = client.get("#{server.endpoint}/socket").body.to_s
+          expect(first_socket).to_not eq("")
+          # Kill off the sockets we used
+          # rubocop:disable Style/RescueModifier
+          DummyServer::Servlet.sockets.each do |socket|
+            socket.close rescue nil
+          end
+          DummyServer::Servlet.sockets.clear
+          # rubocop:enable Style/RescueModifier
+          # Should error because we tried to use a bad socket
+          expect { client.get("#{server.endpoint}/socket").body.to_s }.to raise_error(IOError)
+          # Should succeed since we create a new socket
+          second_socket = client.get("#{server.endpoint}/socket").body.to_s
+          expect(second_socket).to_not eq(first_socket)
+        end
+      end
+      context "with a change in host" do
+        it "errors" do
+          expect { client.get("https://invalid.com/socket") }.to raise_error(/Persistence is enabled/i)
+        end
+      end
+    end
+    context "when disabled" do
+      let(:reuse_conn) { nil }
+      it "opens new sockets" do
+        expect(sockets_used).to_not include("")
+        expect(sockets_used.uniq.length).to eq(2)
+      end
+    end
+  end
+end

data/spec/support/create_certs.rb CHANGED Viewed

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'certificate_authority'
+require "fileutils"
+require "certificate_authority"
 FileUtils.mkdir_p(certs_dir)
@@ -9,15 +9,15 @@ FileUtils.mkdir_p(certs_dir)
 ca = CertificateAuthority::Certificate.new
-ca.subject.common_name  = 'honestachmed.com'
+ca.subject.common_name  = "honestachmed.com"
 ca.serial_number.number = 1
 ca.key_material.generate_key
 ca.signing_entity = true
-ca.sign! 'extensions' => {'keyUsage' => {'usage' => %w(critical keyCertSign)}}
+ca.sign! "extensions" => {"keyUsage" => {"usage" => %w(critical keyCertSign)}}
-ca_cert_path = File.join(certs_dir, 'ca.crt')
-ca_key_path  = File.join(certs_dir, 'ca.key')
+ca_cert_path = File.join(certs_dir, "ca.crt")
+ca_key_path  = File.join(certs_dir, "ca.key")
 File.write ca_cert_path, ca.to_pem
 File.write ca_key_path,  ca.key_material.private_key.to_pem
@@ -27,14 +27,14 @@ File.write ca_key_path,  ca.key_material.private_key.to_pem
 #
 server_cert = CertificateAuthority::Certificate.new
-server_cert.subject.common_name  = '127.0.0.1'
+server_cert.subject.common_name  = "127.0.0.1"
 server_cert.serial_number.number = 1
 server_cert.key_material.generate_key
 server_cert.parent = ca
 server_cert.sign!
-server_cert_path = File.join(certs_dir, 'server.crt')
-server_key_path  = File.join(certs_dir, 'server.key')
+server_cert_path = File.join(certs_dir, "server.crt")
+server_key_path  = File.join(certs_dir, "server.key")
 File.write server_cert_path, server_cert.to_pem
 File.write server_key_path,  server_cert.key_material.private_key.to_pem
@@ -44,14 +44,14 @@ File.write server_key_path,  server_cert.key_material.private_key.to_pem
 #
 client_cert = CertificateAuthority::Certificate.new
-client_cert.subject.common_name  = '127.0.0.1'
+client_cert.subject.common_name  = "127.0.0.1"
 client_cert.serial_number.number = 1
 client_cert.key_material.generate_key
 client_cert.parent = ca
 client_cert.sign!
-client_cert_path = File.join(certs_dir, 'client.crt')
-client_key_path  = File.join(certs_dir, 'client.key')
+client_cert_path = File.join(certs_dir, "client.crt")
+client_key_path  = File.join(certs_dir, "client.key")
 File.write client_cert_path, client_cert.to_pem
 File.write client_key_path,  client_cert.key_material.private_key.to_pem

data/spec/support/dummy_server.rb CHANGED Viewed

@@ -1,16 +1,16 @@
-require 'webrick'
-require 'webrick/ssl'
+require "webrick"
+require "webrick/ssl"
-require 'support/black_hole'
-require 'support/dummy_server/servlet'
-require 'support/servers/config'
-require 'support/servers/runner'
+require "support/black_hole"
+require "support/dummy_server/servlet"
+require "support/servers/config"
+require "support/servers/runner"
 class DummyServer < WEBrick::HTTPServer
   include ServerConfig
   CONFIG = {
-    :BindAddress  => '127.0.0.1',
+    :BindAddress  => "127.0.0.1",
     :Port         => 0,
     :AccessLog    => BlackHole,
     :Logger       => BlackHole
@@ -28,7 +28,7 @@ class DummyServer < WEBrick::HTTPServer
     super CONFIG.merge(override_config)
-    mount('/', Servlet)
+    mount("/", Servlet)
   end
   def endpoint
@@ -40,12 +40,12 @@ class DummyServer < WEBrick::HTTPServer
       context = OpenSSL::SSL::SSLContext.new
       context.verify_mode = OpenSSL::SSL::VERIFY_PEER
       context.key = OpenSSL::PKey::RSA.new(
-        File.read(File.join(certs_dir, 'server.key'))
+        File.read(File.join(certs_dir, "server.key"))
       )
       context.cert = OpenSSL::X509::Certificate.new(
-        File.read(File.join(certs_dir, 'server.crt'))
+        File.read(File.join(certs_dir, "server.crt"))
       )
-      context.ca_file = File.join(certs_dir, 'ca.crt')
+      context.ca_file = File.join(certs_dir, "ca.crt")
       context
     end
   end

data/spec/support/dummy_server/servlet.rb CHANGED Viewed

@@ -1,8 +1,12 @@
 class DummyServer < WEBrick::HTTPServer
   class Servlet < WEBrick::HTTPServlet::AbstractServlet
+    def self.sockets
+      @sockets ||= []
+    end
     def not_found(_req, res)
       res.status = 404
-      res.body   = 'Not Found'
+      res.body   = "Not Found"
     end
     def self.handlers
@@ -23,78 +27,86 @@ class DummyServer < WEBrick::HTTPServer
       RUBY
     end
-    get '/' do |req, res|
+    get "/" do |req, res|
       res.status = 200
-      case req['Accept']
-      when 'application/json'
-        res['Content-Type'] = 'application/json'
+      case req["Accept"]
+      when "application/json"
+        res["Content-Type"] = "application/json"
         res.body = '{"json": true}'
       else
-        res['Content-Type'] = 'text/html'
-        res.body   = '<!doctype html>'
+        res["Content-Type"] = "text/html"
+        res.body   = "<!doctype html>"
+      end
+    end
+    ["", "/1", "/2"].each do |path|
+      get "/socket#{path}" do |req, res|
+        self.class.sockets << req.instance_variable_get(:@socket)
+        res.status  = 200
+        res.body    = req.instance_variable_get(:@socket).object_id.to_s
       end
     end
-    get '/params' do |req, res|
-      next not_found unless 'foo=bar' == req.query_string
+    get "/params" do |req, res|
+      next not_found unless "foo=bar" == req.query_string
       res.status = 200
-      res.body   = 'Params!'
+      res.body   = "Params!"
     end
-    get '/multiple-params' do |req, res|
+    get "/multiple-params" do |req, res|
       params = CGI.parse req.query_string
-      next not_found unless {'foo' => ['bar'], 'baz' => ['quux']} == params
+      next not_found unless {"foo" => ["bar"], "baz" => ["quux"]} == params
       res.status = 200
-      res.body   = 'More Params!'
+      res.body   = "More Params!"
     end
-    get '/proxy' do |_req, res|
+    get "/proxy" do |_req, res|
       res.status = 200
-      res.body   = 'Proxy!'
+      res.body   = "Proxy!"
     end
-    get '/not-found' do |_req, res|
+    get "/not-found" do |_req, res|
       res.status = 404
-      res.body   = 'not found'
+      res.body   = "not found"
     end
-    get '/redirect-301' do |_req, res|
+    get "/redirect-301" do |_req, res|
       res.status      = 301
-      res['Location'] = "http://#{@server.config[:BindAddress]}:#{@server.config[:Port]}/"
+      res["Location"] = "http://#{@server.config[:BindAddress]}:#{@server.config[:Port]}/"
     end
-    get '/redirect-302' do |_req, res|
+    get "/redirect-302" do |_req, res|
       res.status      = 302
-      res['Location'] = "http://#{@server.config[:BindAddress]}:#{@server.config[:Port]}/"
+      res["Location"] = "http://#{@server.config[:BindAddress]}:#{@server.config[:Port]}/"
     end
-    post '/form' do |req, res|
-      if 'testing-form' == req.query['example']
+    post "/form" do |req, res|
+      if "testing-form" == req.query["example"]
         res.status = 200
-        res.body   = 'passed :)'
+        res.body   = "passed :)"
       else
         res.status = 400
-        res.body   = 'invalid! >:E'
+        res.body   = "invalid! >:E"
       end
     end
-    post '/body' do |req, res|
-      if 'testing-body' == req.body
+    post "/body" do |req, res|
+      if "testing-body" == req.body
         res.status = 200
-        res.body   = 'passed :)'
+        res.body   = "passed :)"
       else
         res.status = 400
-        res.body   = 'invalid! >:E'
+        res.body   = "invalid! >:E"
       end
     end
-    head '/' do |_req, res|
+    head "/" do |_req, res|
       res.status          = 200
-      res['Content-Type'] = 'text/html'
+      res["Content-Type"] = "text/html"
     end
   end
 end

data/spec/support/proxy_server.rb CHANGED Viewed

@@ -1,31 +1,37 @@
-require 'webrick/httpproxy'
+require "webrick/httpproxy"
-handler = proc { |_, res| res['X-PROXIED'] = true }
+require "support/black_hole"
+require "support/servers/config"
+require "support/servers/runner"
-ProxyServer = WEBrick::HTTPProxyServer.new(
-  :Port => 8080,
-  :AccessLog => [],
-  :RequestCallback => handler
-)
+class ProxyServer < WEBrick::HTTPProxyServer
+  include ServerConfig
-AuthenticatedProxyServer = WEBrick::HTTPProxyServer.new(
-  :Port => 8081,
-  :ProxyAuthProc => proc do | req, res |
-    WEBrick::HTTPAuth.proxy_basic_auth(req, res, 'proxy') do | user, pass |
-      user == 'username' && pass == 'password'
-    end
-  end,
-  :RequestCallback => handler
-)
-Thread.new  { ProxyServer.start }
-trap('INT') do
-  ProxyServer.shutdown
-  exit
+  CONFIG = {
+    :BindAddress     => "127.0.0.1",
+    :Port            => 0,
+    :AccessLog       => BlackHole,
+    :Logger          => BlackHole,
+    :RequestCallback => proc { |_, res| res["X-PROXIED"] = true }
+  }.freeze
+  def initialize
+    super CONFIG
+  end
 end
-Thread.new  { AuthenticatedProxyServer.start }
-trap('INT') do
-  AuthenticatedProxyServer.shutdown
-  exit
+class AuthProxyServer < WEBrick::HTTPProxyServer
+  include ServerConfig
+  AUTHENTICATOR = proc do |req, res|
+    WEBrick::HTTPAuth.proxy_basic_auth(req, res, "proxy") do |user, pass|
+      user == "username" && pass == "password"
+    end
+  end
+  CONFIG = ProxyServer::CONFIG.merge :ProxyAuthProc => AUTHENTICATOR
+  def initialize
+    super CONFIG
+  end
 end