Commit ed65b4a4 authored by Nitesh Jain's avatar Nitesh Jain

Imported Upstream version 0.6.1

parent 8ba37aff
--format documentation
--order random
- 'Gemfile'
- 'Rakefile'
- 'http.gemspec'
# Avoid long parameter lists
Max: 3
CountKeywordArgs: true
CountComments: false
Max: 31 # TODO: lower to 15
CountComments: false
Max: 132 # TODO: lower to 100
Max: 13 # TODO: lower to 6
# Avoid more than `Max` levels of nesting.
Max: 3
# Do not force public/protected/private keyword to be indented at the same
# level as the def keyword. My personal preference is to outdent these keywords
# because I think when scanning code it makes it easier to identify the
# sections of code and visually separate them. When the keyword is at the same
# level I think it sort of blends in with the def keywords and makes it harder
# to scan the code and see where the sections are.
Enabled: false
# Limit line length
Enabled: false
# Disable documentation checking until a class needs to be documented once
Enabled: false
# Not all trivial readers/writers can be defined with attr_* methods
Enabled: false
# Enforce Ruby 1.8-compatible hash syntax
EnforcedStyle: hash_rockets
# No spaces inside hash literals
EnforcedStyle: no_space
# Allow dots at the end of lines
Enabled: false
# Don't require magic comment at the top of every file
Enabled: false
# Enforce outdenting of access modifiers (i.e. public, private, protected)
EnforcedStyle: outdent
Enabled: true
# Align ends correctly
AlignWith: variable
# Indentation of when/else
IndentWhenRelativeTo: end
IndentOneStep: false
# Use the old lambda literal syntax
Enabled: false
Enabled: false
'%': ()
'%i': ()
'%q': ()
'%Q': ()
'%r': '{}'
'%s': ()
'%w': '[]'
'%W': '[]'
'%x': ()
- 'spec/support/'
- gem update bundler
- bundle --version
- gem update --system 2.1.11
- gem --version
bundler_args: --without development
language: ruby
- 1.8.7
- 1.9.2
- 1.9.3
- 2.0.0
- ree
- 2.1.0
- rbx-2
- ruby-head
- jruby-18mode
- jruby-19mode
- jruby-head
- rbx-18mode
- rbx-19mode
- rvm: jruby-18mode
env: JRUBY_OPTS="$JRUBY_OPTS --debug"
- rvm: jruby-19mode
env: JRUBY_OPTS="$JRUBY_OPTS --debug"
- rvm: jruby-head
env: JRUBY_OPTS="$JRUBY_OPTS --debug"
- rvm: ruby-head
- rvm: jruby-head
- rvm: ruby-head
fast_finish: true
0.6.1 (2014-05-07)
* Fix request `Content-Length` calculation for Unicode (@challengeechallengee)
* Add `Response#flush` (@ixti)
* Fix `Response::Body#readpartial` default size (@hannesg, @ixti)
* Add missing `CRLF` for chunked bodies (@hannesg)
* Fix forgotten CGI require (@ixti)
* Improve README (@tarcieri)
0.6.0 (2014-04-04)
* 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 ""
raw_body = HTTP.get("").to_s
parsed_body = HTTP.get("").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 "" "/tmp/dummy.bin", "wb" do |io|
while (chunk = res.readpartial)
io << chunk
[Changes discussion](
* Add query string support
source ''
gem 'rake', '~> 10.1.1'
gem 'jruby-openssl' if defined? JRUBY_VERSION
gem 'coveralls', :require => false
# Specify your gem's dependencies in http.gemspec
group :development do
gem 'guard-rspec'
gem 'celluloid-io' if RUBY_VERSION >= "1.9.3"
gem 'pry'
platforms :ruby_19, :ruby_20 do
gem 'pry-debugger'
gem 'pry-stack_explorer'
platforms :ruby_19, :ruby_20, :ruby_21 do
gem 'celluloid-io'
gem 'guard-rspec'
group :test do
gem 'backports'
gem 'coveralls', :require => false
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.0', :platforms => [:ruby_19, :ruby_20, :ruby_21]
gem 'simplecov', :require => false
gem 'yardstick'
# Specify your gem's dependencies in http.gemspec
Copyright (c) 2011 Tony Arcieri, Carl Lerche
Copyright (c) 2014 Tony Arcieri, Erik Michaels-Ober
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
The HTTP Gem*
![The HTTP Gem](
[![Gem Version](](
[![Build Status](](
[![Code Climate](](
[![Coverage Status](](
*NOTE: this gem has the worst name in the history of SEO. But perhaps we can fix
that if we all refer to it as "The HTTP Gem". Entering that phrase into Google
actually pulls it up as #4 for me!
SEO Note
This Gem has the worst name in the history of SEO. But perhaps we can fix that if we
all refer to it as "The HTTP Gem", or even better, the "Ruby HTTP Gem".
The HTTP Gem is an easy-to-use client library for making requests from Ruby. It uses
a simple method chaining system for building requests, similar to libraries
like JQuery or Python's [Requests](
a simple method chaining system for building requests, similar to Python's [Requests]
Under the hood, The HTTP Gem uses [http_parser.rb], a fast HTTP parsing native
extension based on the Node.js parser and a Java port thereof.
Help and Discussion
If you need help or just want to talk about the Ruby HTTP Gem, [visit our Google
Group][googlegroup], or join by email by sending a message to:
If you believe you've found a bug, please report it at:
......@@ -34,24 +58,52 @@ Inside of your Ruby program do: pull it in as a dependency.
Making Requests
[Please see the HTTP Gem Wiki](
for more detailed documentation and usage notes.
Let's start with getting things:
Basic Usage
Here's some simple examples to get you started:
### GET requests
>> HTTP.get("")
>> HTTP.get("").to_s
=> "<html><head><meta http-equiv=\"content-type\" content=..."
That's it! The result is the response body as a string. To obtain an HTTP::Response object
instead of the response body, chain `.response` on the end of the request:
That's all it takes! To obtain an `HTTP::Response` object instead of the response
body, all we have to do is omit the #to_s on the end:
>> HTTP.get("").response
>> HTTP.get("")
=> #<HTTP/1.0 200 OK @headers={"Content-Type"=>"text/html; charset=UTF-8", "Date"=>"Fri, ...>
=> #<HTTP::Response/1.1 200 OK @headers={"Content-Type"=>"text/html; ...>
We can also obtain an `HTTP::ResponseBody` object for this response:
>> HTTP.get("").body
=> #<HTTP::ResponseBody:814d7aac @streaming=false>
The response body can be streamed with `HTTP::ResponseBody#readpartial`:
>> HTTP.get("").body.readpartial
=> "<!doctype html><html "
In practice you'll want to bind the HTTP::ResponseBody to a local variable (e.g.
"body") and call readpartial on it repeatedly until it returns nil.
### POST requests
Making POST requests is simple too. Want to POST a form?
......@@ -66,21 +118,33 @@ HTTP.get "", :params => {:foo => "bar"}
Want to POST with a specific body, JSON for instance?
```ruby "", :body => JSON.dump(:foo => '42') "", :json => { :foo => '42' })
It's easy!
### Proxy Support
Making request behind proxy is as simple as making them directly. Just specify
hostname (or IP address) of your proxy server and it's port, and here you go:
HTTP.via("proxy-hostname.local", 8080)
.get ""
Or have it serialize JSON for you:
Proxy needs authentication? No problem:
```ruby "", :json => {:foo => '42'}
HTTP.via("proxy-hostname.local", 8080, "username", "password")
.get ""
It's easy!
Adding Headers
### Adding Headers
The HTTP library uses the concept of chaining to simplify requests. Let's say
The HTTP gem uses the concept of chaining to simplify requests. Let's say
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:
......@@ -102,7 +166,7 @@ HTTP.with_headers(:accept => 'application/json').
This requests JSON from Github. Github is smart enough to understand our
request and returns a response with Content-Type: application/json. If you
happen to have a library loaded which defines the JSON constant and implements
JSON.parse, the HTTP library will attempt to parse the JSON response.
JSON.parse, the HTTP gem will attempt to parse the JSON response.
Shorter aliases exists for HTTP.with_headers:
......@@ -114,10 +178,9 @@ HTTP[:accept => 'application/json'].
Content Negotiation
### Content Negotiation
As important a concept as content negotiation is HTTP, it sure should be easy,
As important a concept as content negotiation is to HTTP, it sure should be easy,
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:
......@@ -128,15 +191,69 @@ HTTP.accept(:json).get("")
This adds the appropriate Accept header for retrieving a JSON response for the
given resource.
Contributing to HTTP
* Fork HTTP on github
### Celluloid::IO Support
The HTTP Gem makes it simple to make multiple concurrent HTTP requests from a
Celluloid::IO actor. Here's a parallel HTTP fetcher with the HTTP Gem and
require 'celluloid/io'
require 'http'
class HttpFetcher
include Celluloid::IO
def fetch(url)
HTTP.get(url, socket_class: Celluloid::IO::TCPSocket).response
There's a little more to it, but that's the core idea!
* [Full parallel HTTP fetcher example](
* See also: [Celluloid::IO](
Supported Ruby Versions
This library aims to support and is [tested against][travis] the following Ruby
* Ruby 1.8.7
* Ruby 1.9.2
* Ruby 1.9.3
* Ruby 2.0.0
* Ruby 2.1.0
If something doesn't work on one of these versions, it's a bug.
This library may inadvertently work (or seem to work) on other Ruby versions,
however support will only be provided for the versions listed above.
If you would like this library to support another Ruby version or
implementation, you may volunteer to be a maintainer. Being a maintainer
entails making sure all tests run and pass on that implementation. When
something breaks on your implementation, you will be responsible for providing
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
Contributing to The HTTP Gem
* Fork the HTTP gem on github
* Make your changes and send me a pull request
* If I like them I'll merge them
* If I've accepted a patch, feel free to ask for a commit bit!
* If we like them we'll merge them
* If we've accepted a patch, feel free to ask for commit access!
Copyright (c) 2013 Tony Arcieri. See LICENSE.txt for further details.
Copyright (c) 2014 Tony Arcieri, Erik Michaels-Ober. See LICENSE.txt for further details.
......@@ -4,4 +4,26 @@ require 'bundler/gem_tasks'
require 'rspec/core/rake_task'
task :default => :spec
task :test => :spec
require 'rubocop/rake_task'
rescue LoadError
task :rubocop do
$stderr.puts 'Rubocop is disabled'
require 'yardstick/rake/measurement' do |measurement|
measurement.output = 'measurement/report.txt'
require 'yardstick/rake/verify' do |verify|
verify.require_exact_threshold = false
verify.threshold = 58
task :default => [:spec, :rubocop, :verify_measurements]
No preview for this file type
#!/usr/bin/env ruby
# Example of using the HTTP Gem with Celluloid::IO
# Make sure to 'gem install celluloid-io' before running
# Run as: bundle exec examples/celluloid.rb
require 'celluloid/io'
require 'http'
puts HTTP.get("", :socket_class => Celluloid::IO::TCPSocket, :ssl_socket_class => Celluloid::IO::SSLSocket)
#!/usr/bin/env ruby
# Example of using the HTTP Gem with Celluloid::IO
# Make sure to 'gem install celluloid-io' before running
# Run as: bundle exec examples/parallel_requests_with_celluloid.rb
require 'celluloid/io'
require 'http'
class HttpFetcher
include Celluloid::IO
def fetch(url)
# Note: For SSL support specify:
# ssl_socket_class: Celluloid::IO::SSLSocket
HTTP.get(url, :socket_class => Celluloid::IO::TCPSocket).response
fetcher =
urls = %w[]
# Kick off a bunch of future calls to HttpFetcher to grab the URLs in parallel
futures = { |u| [u, fetcher.future.fetch(u)] }
# Consume the results as they come in
futures.each do |url, future|
# Wait for HttpFetcher#fetch to complete for this request
response = future.value
puts "Got #{url}: #{response.inspect}"
# Suppress Celluloid's shutdown messages
# Otherwise the example is a bit noisy :|
# -*- encoding: utf-8 -*-
require File.expand_path('../lib/http/version', __FILE__)
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'http/version' do |gem|
gem.authors = ["Tony Arcieri"] = [""]
gem.description = "HTTP so awesome it will lure Catherine Zeta Jones into your unicorn petting zoo"
gem.summary = "HTTP should be easy"
gem.homepage = ""
gem.authors = %w[Tony Arcieri] = %w[]
gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
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.
gem.summary = 'HTTP should be easy'
gem.homepage = ''
gem.licenses = %w[MIT]
gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
gem.files = `git ls-files`.split("\n")
gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n") = "http"
gem.require_paths = ["lib"] = 'http'
gem.require_paths = %w[lib]
gem.version = HTTP::VERSION
gem.add_runtime_dependency 'http_parser.rb'
gem.add_runtime_dependency 'http_parser.rb', '~> 0.6.0'
gem.add_development_dependency 'rake'
gem.add_development_dependency 'rspec', '>= 2.11'
gem.add_development_dependency 'json'
gem.add_development_dependency 'bundler', '~> 1.0'
require 'http/parser'
require 'http/errors'
require 'http/chainable'
require 'http/client'
require 'http/mime_type'
require 'http/options'
require 'http/request'
require 'http/request_stream'
require 'http/request/writer'
require 'http/response'
require 'http/response_parser'
require 'http/uri_backport' if RUBY_VERSION < "1.9.0"
require 'http/response/body'
require 'http/response/parser'
require 'http/backports'
# HTTP should be easy
module HTTP
module HTTP
# Authorization header value builders
module AuthorizationHeader
class << self
# Associate type with given builder.
# @param [#to_sym] type
# @param [Class] klass
# @return [void]
def register(type, klass)
builders[type.to_sym] = klass
# Builds Authorization header value with associated builder.
# @param [#to_sym] type
# @param [Object] opts
# @return [String]
def build(type, opts)
klass = builders[type.to_sym]
fail Error, "Unknown authorization type #{type}" unless klass opts
# :nodoc:
def builders
@builders ||= {}
# built-in builders
require 'http/authorization_header/basic_auth'
require 'http/authorization_header/bearer_token'
require 'base64'
module HTTP
module AuthorizationHeader
# Basic authorization header builder
# @see
class BasicAuth
# @param [#fetch] opts
# @option opts [#to_s] :user
# @option opts [#to_s] :pass
def initialize(opts)
@user = opts.fetch :user
@pass = opts.fetch :pass
# :nodoc:
def to_s
'Basic ' << Base64.strict_encode64("#{@user}:#{@pass}")
register :basic, BasicAuth