http 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f54da216279db68481a0dc3dd511c4374863fe66
-  data.tar.gz: 548aff35c682c519ac5e151c90190ac12e463c6c
+  metadata.gz: adf2b0298c33a4f751b0b8ad323e425fbb556dff
+  data.tar.gz: d2a92940efef91c6e5054270d39eed2c46c182d0
 SHA512:
-  metadata.gz: 1abd1170d04a4f953e5c82365f6190bd95cfccd43e74537e399f2f0ace4aa426c9b1ef00ce1ddd0170c1bbdc8f0971ad703b26b8baacd13444b9b77aff6011d6
-  data.tar.gz: 49c1f5a2595230c98c622e2dd976cede768fd3313e9a9a3fad0dfbb26c4d64f02a5d4de8f4f7f16f83642cdc4f7bd6efeaafb866c2d08fe745c0b03c66d3e755
+  metadata.gz: 752ab8075356ebbe1f69d8bddffb0aac8c3f98c2eab868861da6c4ae136730d08165cbf6cc98942e1199c8c515e940a2bc99dc18cd5de6f074ee35248cedd4a2
+  data.tar.gz: 8745c0368a70ef0b7a130f744e62acc952b540712ac44b573d8d4bbbba583eb82f41d6560af971069b46a1611306fe25e268af2540316919310a4b06d8160d48

data/.rubocop.yml

@@ -3,7 +3,7 @@ Metrics/BlockNesting:
 
 Metrics/ClassLength:
   CountComments: false
-  Max: 120
+  Max: 125
 
 Metrics/PerceivedComplexity:
   Max: 8

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.9.1 (2015-08-14)
+
+* Fix params special-chars escaping. See #246. (@ixti)
+
+
 ## 0.9.0 (2015-07-23)
 
 * Support for caching removed. See #240. (@tarcieri)

data/README.md

@@ -1,9 +1,9 @@
 # ![http.rb](https://raw.github.com/httprb/http.rb/master/logo.png)
 
 [![Gem Version](https://badge.fury.io/rb/http.svg)](http://rubygems.org/gems/http)
-[![Build Status](https://secure.travis-ci.org/httprb/http.rb.svg?branch=master)](http://travis-ci.org/httprb/http.rb)
-[![Code Climate](https://codeclimate.com/github/httprb/http.rb.svg?branch=master)](https://codeclimate.com/github/httprb/http.rb)
-[![Coverage Status](https://coveralls.io/repos/httprb/http.rb/badge.svg?branch=master)](https://coveralls.io/r/httprb/http.rb)
+[![Build Status](https://secure.travis-ci.org/httprb/http.svg?branch=master)](http://travis-ci.org/httprb/http)
+[![Code Climate](https://codeclimate.com/github/httprb/http.svg?branch=master)](https://codeclimate.com/github/httprb/http)
+[![Coverage Status](https://coveralls.io/repos/httprb/http/badge.svg?branch=master)](https://coveralls.io/r/httprb/http)
 
 
 ## About
@@ -20,6 +20,41 @@ natively and outsources the parsing to native extensions.
 [http_parser.rb]: https://github.com/tmm1/http_parser.rb
 
 
+## Another Ruby HTTP library? Why should I care?
+
+There are a lot of HTTP libraries to choose from in the Ruby ecosystem.
+So why would you choose this one?
+
+Top three reasons:
+
+1. **Clean API**: http.rb offers an easy-to-use API that should be a
+   breath of fresh air after using something like Net::HTTP.
+
+2. **Maturity**: http.rb is one of the most mature Ruby HTTP clients, supporting
+   features like persistent connections and fine-grained timeouts.
+
+3. **Performance**: using native parsers and a clean, lightweight implementation,
+   http.rb achieves the best performance of any Ruby HTTP library which
+   implements the HTTP protocol in Ruby instead of C:
+
+  | HTTP client              | time      |
+  |--------------------------|-----------|
+  | curb (persistent)        | 2.519088  |
+  | em-http-request          | 2.731645  |
+  | Typhoeus                 | 2.851911  |
+  | StreamlyFFI (persistent) | 2.853786  |
+  | http.rb (persistent)     | 2.970702  |
+  | http.rb                  | 3.588964  |
+  | HTTParty                 | 3.931913  |
+  | Net::HTTP                | 3.959342  |
+  | Net::HTTP (persistent)   | 4.043674  |
+  | open-uri                 | 4.479817  |
+  | Excon (persistent)       | 4.618361  |
+  | Excon                    | 4.701262  |
+  | RestClient               | 26.832668 |
+
+Benchmarks performed using excon's benchmarking tool
+
 ## Help and Discussion
 
 If you need help or just want to talk about the http.rb,
@@ -59,7 +94,7 @@ Inside of your Ruby program do:
 
 ## Documentation
 
-[Please see the http.rb wiki](https://github.com/httprb/http.rb/wiki)
+[Please see the http.rb wiki](https://github.com/httprb/http/wiki)
 for more detailed documentation and usage notes.
 
 
@@ -164,7 +199,7 @@ you want to get the latest commit of this library from GitHub in JSON format.
 One way we could do this is by tacking a filename on the end of the URL:
 
 ```ruby
-HTTP.get("https://github.com/httprb/http.rb/commit/HEAD.json")
+HTTP.get("https://github.com/httprb/http/commit/HEAD.json")
 ```
 
 The GitHub API happens to support this approach, but really this is a bit of a
@@ -175,7 +210,7 @@ intends us to, by using the Accept header:
 
 ```ruby
 HTTP.headers(:accept => "application/json")
-  .get("https://github.com/httprb/http.rb/commit/HEAD")
+  .get("https://github.com/httprb/http/commit/HEAD")
 ```
 
 This requests JSON from GitHub. GitHub is smart enough to understand our
@@ -185,7 +220,7 @@ Shorter alias exists for `HTTP.headers`:
 
 ```ruby
 HTTP[:accept => "application/json"]
-  .get("https://github.com/httprb/http.rb/commit/HEAD")
+  .get("https://github.com/httprb/http/commit/HEAD")
 ```
 
 
@@ -222,7 +257,7 @@ right? But usually it's not, and so we end up adding ".json" onto the ends of
 our URLs because the existing mechanisms make it too hard. It should be easy:
 
 ```ruby
-HTTP.accept(:json).get("https://github.com/httprb/http.rb/commit/HEAD")
+HTTP.accept(:json).get("https://github.com/httprb/http/commit/HEAD")
 ```
 
 This adds the appropriate Accept header for retrieving a JSON response for the
@@ -236,7 +271,7 @@ reuse the same connection again and again:
 ```ruby
 contents = []
 targets = %w(Hypertext_Transfer_Protocol Git GitHub Linux Hurd)
-HTTP.persistent('http://en.wikipedia.org').do |http|
+HTTP.persistent('http://en.wikipedia.org') do |http|
   targets.each { |target| contents << http.get("/wiki/#{target}") }
 end
 ```
@@ -262,7 +297,7 @@ end
 
 There's a little more to it, but that's the core idea!
 
-* [Full parallel HTTP fetcher example](https://github.com/httprb/http.rb/wiki/Parallel-requests-with-Celluloid%3A%3AIO)
+* [Full parallel HTTP fetcher example](https://github.com/httprb/http/wiki/Parallel-requests-with-Celluloid%3A%3AIO)
 * See also: [Celluloid::IO](https://github.com/celluloid/celluloid-io)
 
 ### Timeouts
@@ -305,6 +340,7 @@ versions:
 * Ruby 2.1.x
 * Ruby 2.2.x
 * JRuby 1.7.x
+* JRuby 9000
 
 If something doesn't work on one of these versions, it's a bug.
 
@@ -319,7 +355,7 @@ patches in a timely fashion. If critical issues for a particular implementation
 exist at the time of a major release, support for that Ruby version may be
 dropped.
 
-[travis]: http://travis-ci.org/httprb/http.rb
+[travis]: http://travis-ci.org/httprb/http
 
 
 ## Contributing to http.rb
@@ -334,5 +370,5 @@ dropped.
 
 ## Copyright
 
-Copyright (c) 2011-2015 Tony Arcieri, Erik Michaels-Ober, Alexey V. Zapparov, Zachary Anker
+Copyright (c) 2011-2015 Tony Arcieri, Erik Michaels-Ober, Alexey V. Zapparov, Zachary Anker.
 See LICENSE.txt for further details.

data/lib/http/client.rb

@@ -1,8 +1,5 @@
 require "forwardable"
 
-require "cgi"
-require "uri"
-
 require "http/form_data"
 require "http/options"
 require "http/headers"
@@ -109,7 +106,7 @@ module HTTP
     #
     # @param [#to_s] uri
     # @return [URI]
-    def make_request_uri(uri, options)
+    def make_request_uri(uri, opts)
       uri = uri.to_s
 
       if default_options.persistent? && uri !~ HTTP_OR_HTTPS_RE
@@ -118,9 +115,8 @@ module HTTP
 
       uri = HTTP::URI.parse uri
 
-      if options.params && !options.params.empty?
-        params    = CGI.parse(uri.query.to_s).merge(options.params || {})
-        uri.query = ::URI.encode_www_form params
+      if opts.params && !opts.params.empty?
+        uri.query = [uri.query, HTTP::URI.form_encode(opts.params)].compact.join("&")
       end
 
       # Some proxies (seen on WEBRick) fail if URL has

data/lib/http/connection.rb

@@ -77,11 +77,10 @@ module HTTP
     def readpartial(size = BUFFER_SIZE)
       return unless @pending_response
 
-      begin
-        read_more size
-        finished = @parser.finished?
-      rescue EOFError
+      if read_more(size) == :eof
         finished = true
+      else
+        finished = @parser.finished?
       end
 
       chunk = @parser.chunk
@@ -94,10 +93,17 @@ module HTTP
     # Reads data from socket up until headers are loaded
     # @return [void]
     def read_headers!
-      read_more BUFFER_SIZE until @parser.headers
+      loop do
+        if read_more(BUFFER_SIZE) == :eof
+          fail EOFError unless @parser.headers?
+          break
+        else
+          break if @parser.headers?
+        end
+      end
+
       set_keep_alive
     rescue IOError, Errno::ECONNRESET, Errno::EPIPE => e
-      return if e.is_a?(EOFError) && @parser.headers
       raise IOError, "problem making HTTP request: #{e}"
     end
 
@@ -199,7 +205,12 @@ module HTTP
     # Feeds some more data into parser
     # @return [void]
     def read_more(size)
-      @parser << @socket.readpartial(size) unless @parser.finished?
+      return if @parser.finished?
+
+      value = @socket.readpartial(size)
+      @parser << value unless value == :eof
+
+      nil
     end
   end
 end

data/lib/http/headers.rb

@@ -47,7 +47,7 @@ module HTTP
     # @param [Array<#to_s>, #to_s] value header value(s) to be appended
     # @return [void]
     def add(name, value)
-      name  = normalize_header name.to_s
+      name = normalize_header name.to_s
       Array(value).each { |v| @pile << [name, v.to_s] }
     end
 

data/lib/http/options.rb

@@ -91,8 +91,13 @@ module HTTP
       !persistent.nil?
     end
 
+    # @deprecated
     def [](option)
-      send(option) rescue nil
+      send(option)
+    rescue
+      warn "[DEPRECATED] `HTTP::Options#[:#{option}]` was deprecated. " \
+        "Use `HTTP::Options##{option}` instead."
+      nil
     end
 
     def merge(other)

data/lib/http/response/status.rb

@@ -43,7 +43,7 @@ module HTTP
         # @param [#to_s] str
         # @return [Symbol]
         def symbolize(str)
-          str.to_s.downcase.gsub(/-/, " ").gsub(/[^a-z ]/, "").gsub(/\s+/, "_").to_sym
+          str.to_s.downcase.tr("-", " ").gsub(/[^a-z ]/, "").gsub(/\s+/, "_").to_sym
         end
       end
 

data/lib/http/timeout/global.rb

@@ -6,11 +6,8 @@ module HTTP
       def initialize(*args)
         super
 
-        reset_counter
-      end
-
-      def reset_counter
-        @time_left = @total_timeout = connect_timeout + read_timeout + write_timeout
+        @time_left = connect_timeout + read_timeout + write_timeout
+        @total_timeout = time_left
       end
 
       def connect(socket_class, host, port)
@@ -38,29 +35,65 @@ module HTTP
         end
       end
 
-      # Read from the socket
-      def readpartial(size)
-        reset_timer
+      # NIO with exceptions
+      if RUBY_VERSION < "2.1.0"
+        # Read from the socket
+        def readpartial(size)
+          reset_timer
+
+          begin
+            socket.read_nonblock(size)
+          rescue IO::WaitReadable
+            IO.select([socket], nil, nil, time_left)
+            log_time
+            retry
+          end
+        rescue EOFError
+          :eof
+        end
 
-        begin
-          socket.read_nonblock(size)
-        rescue IO::WaitReadable
-          IO.select([socket], nil, nil, time_left)
-          log_time
-          retry
+        # Write to the socket
+        def write(data)
+          reset_timer
+
+          begin
+            socket.write_nonblock(data)
+          rescue IO::WaitWritable
+            IO.select(nil, [socket], nil, time_left)
+            log_time
+            retry
+          end
+        rescue EOFError
+          :eof
         end
-      end
 
-      # Write to the socket
-      def write(data)
-        reset_timer
+      # NIO without exceptions
+      else
 
-        begin
-          socket << data
-        rescue IO::WaitWritable
-          IO.select(nil, [socket], nil, time_left)
-          log_time
-          retry
+        # Read from the socket
+        def readpartial(size)
+          reset_timer
+
+          loop do
+            result = socket.read_nonblock(size, :exception => false)
+            break result unless result == :wait_readable
+
+            IO.select([socket], nil, nil, time_left)
+            log_time
+          end
+        end
+
+        # Write to the socket
+        def write(data)
+          reset_timer
+
+          loop do
+            result = socket.write_nonblock(data, :exception => false)
+            break unless result == :wait_writable
+
+            IO.select(nil, [socket], nil, time_left)
+            log_time
+          end
         end
       end
 

data/lib/http/timeout/per_operation.rb

@@ -29,19 +29,53 @@ module HTTP
         end
       end
 
-      # Read data from the socket
-      def readpartial(size)
-        rescue_readable do
-          socket.read_nonblock(size)
+      # NIO with exceptions
+      if RUBY_VERSION < "2.1.0"
+        # Read data from the socket
+        def readpartial(size)
+          rescue_readable do
+            socket.read_nonblock(size)
+          end
+        rescue EOFError
+          :eof
+        end
+
+        # Write data to the socket
+        def write(data)
+          rescue_writable do
+            socket.write_nonblock(data)
+          end
+        rescue EOFError
+          :eof
         end
-      end
 
-      # Write data to the socket
-      def write(data)
-        rescue_writable do
-          socket.write_nonblock(data)
+      # NIO without exceptions
+      else
+        # Read data from the socket
+        def readpartial(size)
+          loop do
+            result = socket.read_nonblock(size, :exception => false)
+            break result unless result == :wait_readable
+
+            unless IO.select([socket], nil, nil, read_timeout)
+              fail TimeoutError, "Read timed out after #{read_timeout} seconds"
+            end
+          end
+        end
+
+        # Write data to the socket
+        def write(data)
+          loop do
+            result = socket.write_nonblock(data, :exception => false)
+            break unless result == :wait_writable
+
+            unless IO.select(nil, [socket], nil, write_timeout)
+              fail TimeoutError, "Read timed out after #{write_timeout} seconds"
+            end
+          end
         end
       end
+      # rubocop:enable Metrics/BlockNesting
     end
   end
 end

data/lib/http/version.rb

@@ -1,3 +1,3 @@
 module HTTP
-  VERSION = "0.9.0".freeze
+  VERSION = "0.9.1".freeze
 end

data/spec/lib/http/client_spec.rb

@@ -138,6 +138,14 @@ RSpec.describe HTTP::Client do
 
       client.get("http://example.com/?a[]=b&a[]=c", :params => {:d => "e"})
     end
+
+    it "properly encodes colons" do
+      expect(HTTP::Request).to receive(:new) do |_, uri|
+        expect(uri.query).to eq "t=1970-01-01T00%3A00%3A00Z"
+      end
+
+      client.get("http://example.com/", :params => {:t => "1970-01-01T00:00:00Z"})
+    end
   end
 
   describe "passing json" do
@@ -156,7 +164,7 @@ RSpec.describe HTTP::Client do
   describe "#request" do
     context "with non-ASCII URLs" do
       it "theoretically works like a charm" do
-        client =  described_class.new
+        client = described_class.new
         expect { client.get "#{dummy.endpoint}/könig" }.not_to raise_error
       end
 
@@ -240,63 +248,6 @@ RSpec.describe HTTP::Client do
       end
     end
 
-    context "when server closes connection unexpectedly" do
-      before do
-        socket_spy = double
-
-        allow(socket_spy).to receive(:close) { nil }
-        allow(socket_spy).to receive(:closed?) { true }
-        allow(socket_spy).to receive(:readpartial) { chunks.shift.call }
-        allow(socket_spy).to receive(:<<) { nil }
-
-        allow(TCPSocket).to receive(:open) { socket_spy }
-      end
-
-      context "during headers reading" do
-        let :chunks do
-          [
-            proc { "HTTP/1.1 200 OK\r\n" },
-            proc { "Content-Type: text/html\r" },
-            proc { fail EOFError }
-          ]
-        end
-
-        it "raises IOError" do
-          expect { client.get dummy.endpoint }.to raise_error IOError
-        end
-      end
-
-      context "after headers were flushed" do
-        let :chunks do
-          [
-            proc { "HTTP/1.1 200 OK\r\n" },
-            proc { "Content-Type: text/html\r\n\r\n" },
-            proc { "unexpected end of f" },
-            proc { fail EOFError }
-          ]
-        end
-
-        it "reads partially arrived body" do
-          res = client.get(dummy.endpoint).to_s
-          expect(res).to eq "unexpected end of f"
-        end
-      end
-
-      context "when body and headers were flushed in one chunk" do
-        let :chunks do
-          [
-            proc { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\nunexpected end of f" },
-            proc { fail EOFError }
-          ]
-        end
-
-        it "reads partially arrived body" do
-          res = client.get(dummy.endpoint).to_s
-          expect(res).to eq "unexpected end of f"
-        end
-      end
-    end
-
     context "when server fully flushes response in one chunk" do
       before do
         socket_spy = double

data/spec/lib/http/options/merge_spec.rb

@@ -18,43 +18,43 @@ RSpec.describe HTTP::Options, "merge" do
 
     foo = HTTP::Options.new(
       :response  => :body,
-      :params      => {:baz => "bar"},
+      :params    => {:baz => "bar"},
       :form      => {:foo => "foo"},
       :body      => "body-foo",
       :json      => {:foo => "foo"},
-      :headers   => {:accept  => "json",  :foo => "foo"},
+      :headers   => {:accept => "json", :foo => "foo"},
       :proxy     => {})
 
     bar = HTTP::Options.new(
-      :response  => :parsed_body,
-      :persistent  => "https://www.googe.com",
-      :params      => {:plop => "plip"},
-      :form      => {:bar => "bar"},
-      :body      => "body-bar",
-      :json      => {:bar => "bar"},
+      :response   => :parsed_body,
+      :persistent => "https://www.googe.com",
+      :params     => {:plop => "plip"},
+      :form       => {:bar => "bar"},
+      :body       => "body-bar",
+      :json       => {:bar => "bar"},
       :keep_alive_timeout => 10,
-      :headers   => {:accept  => "xml", :bar => "bar"},
-      :timeout_options => {:foo => :bar},
-      :ssl       => {:foo => "bar"},
-      :proxy     => {:proxy_address => "127.0.0.1", :proxy_port => 8080})
+      :headers            => {:accept => "xml", :bar => "bar"},
+      :timeout_options    => {:foo => :bar},
+      :ssl        => {:foo => "bar"},
+      :proxy      => {:proxy_address => "127.0.0.1", :proxy_port => 8080})
 
     expect(foo.merge(bar).to_hash).to eq(
-      :response  => :parsed_body,
-      :timeout_class  => described_class.default_timeout_class,
+      :response        => :parsed_body,
+      :timeout_class   => described_class.default_timeout_class,
       :timeout_options => {:foo => :bar},
-      :params    => {:plop => "plip"},
-      :form      => {:bar => "bar"},
-      :body      => "body-bar",
-      :json      => {:bar => "bar"},
-      :persistent  => "https://www.googe.com",
+      :params     => {:plop => "plip"},
+      :form       => {:bar => "bar"},
+      :body       => "body-bar",
+      :json       => {:bar => "bar"},
+      :persistent => "https://www.googe.com",
       :keep_alive_timeout => 10,
       :ssl       => {:foo => "bar"},
-      :headers   => {"Foo" => "foo", "Accept"  => "xml", "Bar" => "bar"},
+      :headers   => {"Foo" => "foo", "Accept" => "xml", "Bar" => "bar"},
       :proxy     => {:proxy_address => "127.0.0.1", :proxy_port => 8080},
       :follow => nil,
       :socket_class     => described_class.default_socket_class,
       :ssl_socket_class => described_class.default_ssl_socket_class,
       :ssl_context      => nil,
-      :cookies    => {})
+      :cookies          => {})
   end
 end

data/spec/support/dummy_server/servlet.rb

@@ -36,7 +36,7 @@ class DummyServer < WEBrick::HTTPServer
         res.body = '{"json": true}'
       else
         res["Content-Type"] = "text/html"
-        res.body   = "<!doctype html>"
+        res.body = "<!doctype html>"
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Tony Arcieri
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
@@ -183,39 +183,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: HTTP should be easy
-test_files:
-- spec/lib/http/client_spec.rb
-- spec/lib/http/content_type_spec.rb
-- spec/lib/http/headers/mixin_spec.rb
-- spec/lib/http/headers_spec.rb
-- spec/lib/http/options/body_spec.rb
-- spec/lib/http/options/form_spec.rb
-- spec/lib/http/options/headers_spec.rb
-- spec/lib/http/options/json_spec.rb
-- spec/lib/http/options/merge_spec.rb
-- spec/lib/http/options/new_spec.rb
-- spec/lib/http/options/proxy_spec.rb
-- spec/lib/http/options_spec.rb
-- spec/lib/http/redirector_spec.rb
-- spec/lib/http/request/writer_spec.rb
-- spec/lib/http/request_spec.rb
-- spec/lib/http/response/body_spec.rb
-- spec/lib/http/response/status_spec.rb
-- spec/lib/http/response_spec.rb
-- spec/lib/http_spec.rb
-- spec/spec_helper.rb
-- spec/support/black_hole.rb
-- spec/support/capture_warning.rb
-- spec/support/connection_reuse_shared.rb
-- spec/support/dummy_server.rb
-- spec/support/dummy_server/servlet.rb
-- spec/support/http_handling_shared.rb
-- spec/support/proxy_server.rb
-- spec/support/servers/config.rb
-- spec/support/servers/runner.rb
-- spec/support/ssl_helper.rb
+test_files: []
 has_rdoc: