A lightweight framework for doing http-connections in Ruby. Supports cookies, keep-alive, compressing and much more.
Ruby HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
lib
spec
.document
.gitignore
.rspec
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
http2.gemspec
shippable.yml

README.md

Code Climate Code Climate Build Status

http2

A HTTP-framework for Ruby supporting keep-alive, compression, JSON-posting, detailed inspection of responses and much more.

Usage

require "rubygems"
require "http2"

Http2.new(host: "www.google.dk") do |http|
  # Do requests here.
end

Or without using a block for ensuring closing of connection:

http = Http2.new(...)

# Do requests here.

http.destroy # Closes the connection and frees up any variables used

Or through a proxy:

Http2.new(host: "www.google.com", proxy: {host: "myproxy.com", port: 80, user: "myname", passwd: "mypassword"})

You can also use SSL:

Http2.new(host: "myhost.com", ssl: true, ssl_skip_verify: true)

You can make it follow redirects like this:

Http2.new(host: "myhost.com", follow_redirects: true)

Get requests

res = http.get("path/to/something")

Or as a hash:

res = http.get(url: "path/to/something")

Post requests

res = http.post(url: "path/to/something", post: {
  "some_post_val" => "some_value"
})

Extra headers

res = http.post(
  url: "path",
  headers: {"Auth": "123"},
  post: {data: "test"}
)

Post JSON as content

res = http.post(url: "path/to/something", json: {some_argument: true})

Reading JSON from request

res = http.post(url: "something", json: {some_argument: true})
res.json? #=> true (if content-type is application/json)
res.json #=> {"value" => "something"}

Delete requests

res = http.delete(url: "path/to/something")

File upload

res = http.post_multipart(url: "path/to/something", post: {
  "test_file1" => {
    fpath: fpath,
    filename: "specfile"
  }
})

Reading cookies

puts "Cookies until now: #{http.cookies}"

Building URL's

ub = ::Http2::UrlBuilder.new
ub.host = "www.google.com"
ub.port = 80
ub.path = "script.php"
ub.params["some_param"] = 2

ub.build #=> "http://www.google.com/..."
ub.build_params #=> "some_param=2&some_other_param=..."
ub.build_path_and_params #=> "script.php?some_param=2"
ub.params? #=> true
ub.host #=> "www.google.com"
ub.port #=> 80
ub.path #=> "script.php"

Inspecting responses

resp = http.get("path/to/something")
resp.content_type #=> "text/html"
resp.content_length #=> 136
resp.header("content-length") #=> "136"
resp.headers #=> {"content-type" => ["text/html"], "content-length" => ["136"]}
resp.code #=> "200"
resp.charset #=> "utf-8"
resp.http_version #=> "1.1"
resp.body #=> "<html><body>..."
resp.requested_url #=> "http://example.com/maybe/redirected/path/to/something"

Get parameters later.

http.host #=> example.com
http.port #=> 80

Reconnect

Handy when doing retries.

http.reconnect

Basic HTTP authentication for all requests

http = Http2.new(
  host: "www.somehost.com",
  basic_auth: {
    user: "username",
    passwd: "password"
  }
)

Inspect the headers that were sent

response = http.get("some_page")
request = response.request
request.headers_string #=> "GET /some_page\n..."

Contributing to http2

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for further details.