http 0.6.0.pre → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b647051e277907433baf4b118a8b63a3d04aa67b
-  data.tar.gz: 30e721ae9be7d37ad8e9359ad0d52dce0f6a8d16
+  metadata.gz: 6c81e2f4f9a7626fd58b225bf69772a47bf361c6
+  data.tar.gz: 31f9bb1e4ceb3494898604e1724de240b8237e43
 SHA512:
-  metadata.gz: 2531298e15fc793c052a03e524875151c91d8eb111fdb9c6886546009cf827dab8d51eb8158052cdaaa1edcb968a63c4be89350fc357cc1972a20c04693429c3
-  data.tar.gz: ecf369955e78188f2d6eff9c159b55beb9d160a9ce36f6acb5472b5d1c9cd5b374b848582901861389da4ba0e0b8ead5d7f92b1d223ec1ed30212839f321aa3f
+  metadata.gz: 637b115774a74b54c7dcede1ab6c4fde01638f329c51dedc83b8ad2cb1129983a888b2aef2442e00a8f68bc36dba614710ec645c009ba3bb47551a8630069add
+  data.tar.gz: b9b86db8e595bc6bb09862bc9e2f8e529e8e2e2b0c0599214ea24f816e8a30cf948bc5f405d143501cdce5475cf1e2971cf376e46b50dc95a3943adebf00f207

data/CHANGES.md

@@ -1,3 +1,68 @@
+0.6.0
+-----
+
+* Rename `HTTP::Request#method` to `HTTP::Request#verb` (@krainboltgreene)
+* Add `HTTP::ResponseBody` class (@tarcieri)
+* Change API of response on `HTTP::Client.request` and "friends" (`#get`, `#post`, etc) (@tarcieri)
+* Add `HTTP::Response#readpartial` (@tarcieri)
+* Add `HTTP::Headers` class (@ixti)
+* Fix and improve following redirects (@ixti)
+* Add `HTTP::Request#redirect` (@ixti)
+* Add `HTTP::Response#content_type` (@ixti)
+* Add `HTTP::Response#mime_type` (@ixti)
+* Add `HTTP::Response#charset` (@ixti)
+* Improve error message upon invalid URI scheme (@ixti)
+* Consolidate errors under common `HTTP::Error` namespace (@ixti)
+* Add easy way of adding Authorization header (@ixti)
+* Fix proxy support (@hundredwatt)
+* Fix and improve query params handing (@jwinter)
+* Change API of custom MIME type parsers (@ixti)
+* Remove `HTTP::Chainable#with_response` (@ixti)
+* Remove `HTTP::Response::BodyDelegator` (@ixti)
+* Remove `HTTP::Response#parsed_body` (@ixti)
+* Bump up input buffer from 4K to 16K (@tarcieri)
+
+``` ruby
+# Main API change you will mention is that `request` method and it's
+# syntax sugar helpers like `get`, `post`, etc. now returns Response
+# object instead of BodyDelegator:
+
+response = HTTP.get "http://example.com"
+raw_body = HTTP.get("http://example.com").to_s
+parsed_body = HTTP.get("http://example.com/users.json").parse
+
+# Second major change in API is work with request/response headers
+# It is now delegated to `HTTP::Headers` class, so you can check it's
+# documentation for details, here we will only outline main difference.
+# Duckface (`[]=`) does not appends headers anymore
+
+request[:content_type] = "text/plain"
+request[:content_type] = "text/html"
+request[:content_type] # => "text/html"
+
+# In order to add multiple header values, you should pass array:
+
+request[:cookie] = ["foo=bar", "woo=hoo"]
+request[:cookie] # => ["foo=bar", "woo=hoo"]
+
+# or call `#add` on headers:
+
+request.headers.add :accept, "text/plain"
+request.headers.add :accept, "text/html"
+request[:accept] # => ["text/plain", "text/html"]
+
+# Also, you can now read body in chunks (stream):
+
+res = HTTP.get "http://example.com"
+File.open "/tmp/dummy.bin", "wb" do |io|
+  while (chunk = res.readpartial)
+    io << chunk
+  end
+end
+```
+
+[Changes discussion](https://github.com/tarcieri/http/issues/116)
+
 0.5.0
 -----
 * Add query string support

data/Gemfile

@@ -21,7 +21,7 @@ group :test do
   gem 'json', '>= 1.8.1', :platforms => [:jruby, :rbx, :ruby_18, :ruby_19]
   gem 'mime-types', '~> 1.25', :platforms => [:jruby, :ruby_18]
   gem 'rspec', '>= 2.14'
-  gem 'rubocop', '>= 0.19', :platforms => [:ruby_19, :ruby_20, :ruby_21]
+  gem 'rubocop', '~> 0.19.0', :platforms => [:ruby_19, :ruby_20, :ruby_21]
   gem 'simplecov', :require => false
   gem 'yardstick'
 end

data/http.gemspec

@@ -5,7 +5,13 @@ require 'http/version'
 Gem::Specification.new do |gem|
   gem.authors       = %w[Tony Arcieri]
   gem.email         = %w[tony.arcieri@gmail.com]
-  gem.description   = 'HTTP so awesome it will lure Catherine Zeta Jones into your unicorn petting zoo'
+
+  gem.description   = <<-DESCRIPTION.strip.gsub(/\s+/, ' ')
+    An easy-to-use client library for making requests from Ruby.
+    It uses a simple method chaining system for building requests,
+    similar to Python's Requests.
+  DESCRIPTION
+
   gem.summary       = 'HTTP should be easy'
   gem.homepage      = 'https://github.com/tarcieri/http'
   gem.licenses      = %w[MIT]

data/lib/http.rb

@@ -9,7 +9,7 @@ require 'http/request/writer'
 require 'http/response'
 require 'http/response/body'
 require 'http/response/parser'
-require 'http/backports' if RUBY_VERSION < '1.9.0'
+require 'http/backports'
 
 # HTTP should be easy
 module HTTP

data/lib/http/backports.rb

@@ -1,2 +1,2 @@
-require 'http/backports/uri'
-require 'http/backports/base64'
+require 'http/backports/uri'    if RUBY_VERSION < '1.9.3'
+require 'http/backports/base64' if RUBY_VERSION < '1.9.0'

data/lib/http/client.rb

@@ -19,49 +19,27 @@ module HTTP
     end
 
     # Make an HTTP request
-    def request(verb, uri, options = {})
-      opts = @default_options.merge(options)
+    def request(verb, uri, opts = {})
+      opts    = @default_options.merge(opts)
+      uri     = make_request_uri(uri, opts)
       headers = opts.headers
-      proxy = opts.proxy
+      proxy   = opts.proxy
+      body    = make_request_body(opts, headers)
 
-      request_body = make_request_body(opts, headers)
-      uri, opts = normalize_get_params(uri, opts) if verb == :get
+      req = HTTP::Request.new(verb, uri, headers, proxy, body)
+      res = perform req, opts
 
-      uri = "#{uri}?#{URI.encode_www_form(opts.params)}" if opts.params && !opts.params.empty?
-
-      request = HTTP::Request.new(verb, uri, headers, proxy, request_body)
-      perform request, opts
-    end
-
-    # Perform the HTTP request (following redirects if needed)
-    def perform(req, options)
-      res = perform_without_following_redirects req, options
-
-      if options.follow
-        res = Redirector.new(options.follow).perform req, res do |request|
-          perform_without_following_redirects request, options
+      if opts.follow
+        res = Redirector.new(opts.follow).perform req, res do |request|
+          perform request, opts
         end
       end
 
       res
     end
 
-    # Read a chunk of the body
-    def readpartial(size = BUFFER_SIZE)
-      return unless @socket
-
-      read_more size
-      chunk = @parser.chunk
-
-      finish_response if @parser.finished?
-
-      chunk
-    end
-
-  private
-
     # Perform a single (no follow) HTTP request
-    def perform_without_following_redirects(req, options)
+    def perform(req, options)
       # finish previous response if client was re-used
       # TODO: this is pretty wrong, as socket shoud be part of response
       #       connection, so that re-use of client will not break multiple
@@ -90,6 +68,20 @@ module HTTP
       res
     end
 
+    # Read a chunk of the body
+    def readpartial(size = BUFFER_SIZE)
+      return unless @socket
+
+      read_more size
+      chunk = @parser.chunk
+
+      finish_response if @parser.finished?
+
+      chunk
+    end
+
+  private
+
     # Initialize TLS connection
     def start_tls(socket, options)
       # TODO: abstract away SSLContexts so we can use other TLS libraries
@@ -100,6 +92,18 @@ module HTTP
       socket
     end
 
+    # Merges query params if needed
+    def make_request_uri(uri, options)
+      uri = URI uri.to_s unless uri.is_a? URI
+
+      if options.params && !options.params.empty?
+        params    = CGI.parse(uri.query.to_s).merge(options.params || {})
+        uri.query = URI.encode_www_form params
+      end
+
+      uri
+    end
+
     # Create the request body object to send
     def make_request_body(opts, headers)
       if opts.body
@@ -124,21 +128,9 @@ module HTTP
     # Feeds some more data into parser
     def read_more(size)
       @parser << @socket.readpartial(size) unless @parser.finished?
-      return true
+      true
     rescue EOFError
-      return false
-    end
-
-    # Moves uri get params into the opts.params hash
-    # @return [Array<URI, Hash>]
-    def normalize_get_params(uri, opts)
-      uri = URI(uri) unless uri.is_a?(URI)
-      if uri.query
-        extracted_params_from_uri = Hash[URI.decode_www_form(uri.query)]
-        opts = opts.with_params(extracted_params_from_uri.merge(opts.params || {}))
-        uri.query = nil
-      end
-      [uri, opts]
+      false
     end
   end
 end

data/lib/http/request.rb

@@ -1,8 +1,9 @@
+require 'http/errors'
 require 'http/headers'
 require 'http/request/writer'
 require 'http/version'
-require 'uri'
 require 'base64'
+require 'uri'
 
 module HTTP
   class Request

data/lib/http/version.rb

@@ -1,3 +1,3 @@
 module HTTP
-  VERSION = '0.6.0.pre'
+  VERSION = '0.6.0'
 end

data/spec/http/backports/uri_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe URI do
+  describe '.encode_www_form' do
+    it 'properly encodes arrays' do
+      expect(URI.encode_www_form :a => [:b, :c]).to eq 'a=b&a=c'
+    end
+  end
+end

data/spec/http/client_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe HTTP::Client do
   StubbedClient = Class.new(HTTP::Client) do
-    def perform_without_following_redirects(request, options)
+    def perform(request, options)
       stubs.fetch(request.uri.to_s) { super(request, options) }
     end
 
@@ -70,27 +70,48 @@ describe HTTP::Client do
   end
 
   describe 'parsing params' do
+    let(:client) { HTTP::Client.new }
+    before { allow(client).to receive :perform }
+
     it 'accepts params within the provided URL' do
-      client = HTTP::Client.new
-      allow(client).to receive(:perform)
       expect(HTTP::Request).to receive(:new) do |_, uri|
-        params = CGI.parse(URI(uri).query)
-        expect(params).to eq('foo' => ['bar'])
+        expect(CGI.parse uri.query).to eq('foo' => %w[bar])
       end
 
       client.get('http://example.com/?foo=bar')
     end
 
     it 'combines GET params from the URI with the passed in params' do
-      client = HTTP::Client.new
-      allow(client).to receive(:perform)
       expect(HTTP::Request).to receive(:new) do |_, uri|
-        params = CGI.parse(URI(uri).query)
-        expect(params).to eq('foo' => ['bar'], 'baz' => ['quux'])
+        expect(CGI.parse uri.query).to eq('foo' => %w[bar], 'baz' => %w[quux])
       end
 
       client.get('http://example.com/?foo=bar', :params => {:baz => 'quux'})
     end
+
+    it 'merges duplicate values' do
+      expect(HTTP::Request).to receive(:new) do |_, uri|
+        expect(CGI.parse uri.query).to eq('a' => %w[1 2])
+      end
+
+      client.get('http://example.com/?a=1', :params => {:a => 2})
+    end
+
+    it 'does not modifies query part if no params were given' do
+      expect(HTTP::Request).to receive(:new) do |_, uri|
+        expect(uri.query).to eq 'deadbeef'
+      end
+
+      client.get('http://example.com/?deadbeef')
+    end
+
+    it 'does not corrupts index-less arrays' do
+      expect(HTTP::Request).to receive(:new) do |_, uri|
+        expect(CGI.parse uri.query).to eq 'a[]' => %w[b c], 'd' => %w[e]
+      end
+
+      client.get('http://example.com/?a[]=b&a[]=c', :params => {:d => 'e'})
+    end
   end
 
   describe 'passing json' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 0.6.0.pre
+  version: 0.6.0
 platform: ruby
 authors:
 - Tony
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-29 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
@@ -39,8 +39,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: HTTP so awesome it will lure Catherine Zeta Jones into your unicorn petting
-  zoo
+description: An easy-to-use client library for making requests from Ruby. It uses
+  a simple method chaining system for building requests, similar to Python's Requests.
 email:
 - tony.arcieri@gmail.com
 executables: []
@@ -89,6 +89,7 @@ files:
 - spec/http/authorization_header/bearer_token_spec.rb
 - spec/http/authorization_header_spec.rb
 - spec/http/backports/base64_spec.rb
+- spec/http/backports/uri_spec.rb
 - spec/http/client_spec.rb
 - spec/http/content_type_spec.rb
 - spec/http/headers/mixin_spec.rb
@@ -125,9 +126,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.0
@@ -139,6 +140,7 @@ test_files:
 - spec/http/authorization_header/bearer_token_spec.rb
 - spec/http/authorization_header_spec.rb
 - spec/http/backports/base64_spec.rb
+- spec/http/backports/uri_spec.rb
 - spec/http/client_spec.rb
 - spec/http/content_type_spec.rb
 - spec/http/headers/mixin_spec.rb