httpi 1.1.1 → 2.0.0.rc1

data/.gitignore

@@ -7,3 +7,5 @@ tmp
 *.gem
 .bundle
 Gemfile.lock
+.idea/*
+.rbx/

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@httpi --create

data/CHANGELOG.md

@@ -1,6 +1,31 @@
+## 2.0.0.rc1
+
+* Feature: [#63](https://github.com/savonrb/httpi/pull/63) adds support for
+  EventMachine::HttpRequest. Additional information at [#40](https://github.com/savonrb/httpi/pull/40).
+
+* Feature: Added support for custom HTTP methods to clients supporting this feature.
+  It's limited to the `:httpclient` and `:em_http` adapter.
+
+    ``` ruby
+    HTTPI.request(:custom, request)
+    ```
+
+* Improvement: [#64](https://github.com/savonrb/httpi/pull/64) adds support for
+  specifying the SSL version to use.
+
+* Improvement: Log to `$stdout` (instead of `STDOUT`) using a default log level of
+  `:debug` (instead of `:warn`).
+
+* Improvement: In case an adapter doesn't support a general feature, we now raise
+  an `HTTPI::NotSupportedError`.
+
+* Improvement: Added support for adding custom adapters.
+
+* Refactoring: Simplified the adapter interface.
+
 ## 1.1.1 (2012-07-01)
 
-* Fix: [#56](https://github.com/rubiii/httpi/pull/56) ensures that the "Cookie"
+* Fix: [#56](https://github.com/savonrb/httpi/pull/56) ensures that the "Cookie"
   header is not set to nil.
 
 ## 1.1.0 (2012-06-26)
@@ -10,15 +35,15 @@
 
 ## 1.0.0 (2012-06-07)
 
-* Feature: [#48](https://github.com/rubiii/httpi/pull/48) @jheiss added support
+* Feature: [#48](https://github.com/savonrb/httpi/pull/48) @jheiss added support
   for HTTP Negotiate/SPNEGO authentication (curb-specific).
 
-* Fix: [#53](https://github.com/rubiii/httpi/issues/53) fixed an issue where
+* Fix: [#53](https://github.com/savonrb/httpi/issues/53) fixed an issue where
   `HTTPI.log_level` did not do anything at all.
 
 ## 0.9.7 (2012-04-26)
 
-* Fix: Merged [pull request 49](https://github.com/rubiii/httpi/pull/49) so that cert
+* Fix: Merged [pull request 49](https://github.com/savonrb/httpi/pull/49) so that cert
   and cert_key can be manually set.
 
 * Fix: Stop auto-detecting gzipped responses by inspecting the response body to allow
@@ -26,22 +51,22 @@
 
 ## 0.9.6 (2012-02-23)
 
-* Feature: Merged [pull request 46](https://github.com/rubiii/httpi/pull/46) to support
-  request body Hashes. Fixes [issue 45](https://github.com/rubiii/httpi/issues/45).
+* Feature: Merged [pull request 46](https://github.com/savonrb/httpi/pull/46) to support
+  request body Hashes. Fixes [issue 45](https://github.com/savonrb/httpi/issues/45).
 
     ``` ruby
     request.body = { :foo => :bar, :baz => :foo }  # => "foo=bar&baz=foo"
     ```
 
-* Feature: Merged [pull request 43](https://github.com/rubiii/httpi/pull/43) to allow
+* Feature: Merged [pull request 43](https://github.com/savonrb/httpi/pull/43) to allow
   proxy authentication with net/http.
 
-* Feature: Merged [pull request 42](https://github.com/rubiii/httpi/pull/42) which sets up
+* Feature: Merged [pull request 42](https://github.com/savonrb/httpi/pull/42) which sets up
   HTTP basic authentication if user information is present in the URL.
 
-* Fix: Merged [pull request 44](https://github.com/rubiii/httpi/pull/44) to fix
-  [issue 26](https://github.com/rubiii/httpi/issues/26) and probably also
-  [issue 32](https://github.com/rubiii/httpi/issues/32) - SSL client authentication.
+* Fix: Merged [pull request 44](https://github.com/savonrb/httpi/pull/44) to fix
+  [issue 26](https://github.com/savonrb/httpi/issues/26) and probably also
+  [issue 32](https://github.com/savonrb/httpi/issues/32) - SSL client authentication.
 
 ## 0.9.5 (2011-06-30)
 
@@ -51,8 +76,8 @@
 
 ## 0.9.4 (2011-05-15)
 
-* Fix: issues [34](https://github.com/rubiii/httpi/issues/34) and
-  [29](https://github.com/rubiii/httpi/issues/29) - replaced the dependency
+* Fix: issues [34](https://github.com/savonrb/httpi/issues/34) and
+  [29](https://github.com/savonrb/httpi/issues/29) - replaced the dependency
   on `ntlm-http` with a dependency on `pyu-ntlm-http` which comes with quite
   a few bugfixes.
 
@@ -64,22 +89,22 @@
 
 ## 0.9.3 (2011-04-28)
 
-* Fix: [issue 31](https://github.com/rubiii/httpi/issues/31) missing headers when using httpclient.
+* Fix: [issue 31](https://github.com/savonrb/httpi/issues/31) missing headers when using httpclient.
 
-* Fix: [issue 30](https://github.com/rubiii/httpi/issues/30) fix for using SSL with Net::HTTP.
+* Fix: [issue 30](https://github.com/savonrb/httpi/issues/30) fix for using SSL with Net::HTTP.
 
 ## 0.9.2 (2011-04-05)
 
-* Fix: issues [161](https://github.com/rubiii/savon/issues/161) and [165](https://github.com/rubiii/savon/issues/165)
-  reported at [rubiii/savon](https://github.com/rubiii/savon).
+* Fix: issues [161](https://github.com/savonrb/savon/issues/161) and [165](https://github.com/savonrb/savon/issues/165)
+  reported at [savonrb/savon](https://github.com/savonrb/savon).
 
 ## 0.9.1 (2011-04-04)
 
-* Fix: [issue 25](https://github.com/rubiii/httpi/issues/22) problem with HTTPI using the Net::HTTP adapter [hakanensari].
+* Fix: [issue 25](https://github.com/savonrb/httpi/issues/22) problem with HTTPI using the Net::HTTP adapter [hakanensari].
 
 ## 0.9.0 (2011-03-08)
 
-* Feature: improved the adapter loading process ([d4a091](https://github.com/rubiii/httpi/commit/d4a091)) [rubiii].
+* Feature: improved the adapter loading process ([d4a091](https://github.com/savonrb/httpi/commit/d4a091)) [rubiii].
 
   Instead of using HTTPClient as the default and falling back to NetHTTP, the loading process now does the following:
 
@@ -91,21 +116,21 @@
 
   Of course you can still manually specify the adapter to use.
 
-* Fix: [issue 22](https://github.com/rubiii/httpi/issues/22) argument error on logging adapter warning [rubiii].
+* Fix: [issue 22](https://github.com/savonrb/httpi/issues/22) argument error on logging adapter warning [rubiii].
 
-* Fix: [issue 23](https://github.com/rubiii/httpi/issues/23) the HTTPI.log method now works as expected [rubiii].
+* Fix: [issue 23](https://github.com/savonrb/httpi/issues/23) the HTTPI.log method now works as expected [rubiii].
 
 ## 0.8.0 (2011-03-07)
 
-* Feature: added support for NTLM authentication ([96ceb1](https://github.com/rubiii/httpi/commit/96ceb1)) [MattHall].
+* Feature: added support for NTLM authentication ([96ceb1](https://github.com/savonrb/httpi/commit/96ceb1)) [MattHall].
 
   You should now be able to use NTLM authentication by specifying your credentials via `HTTPI::Auth::Config#ntlm`:
 
       request = HTTPI::Request.new
       request.auth.ntlm "username", "password"
 
-* Improvement: changed the default log level to :warn ([d01591](https://github.com/rubiii/httpi/commit/d01591))
-  and log at appropriate levels ([21ee1b](https://github.com/rubiii/httpi/commit/21ee1b)) [ichverstehe].
+* Improvement: changed the default log level to :warn ([d01591](https://github.com/savonrb/httpi/commit/d01591))
+  and log at appropriate levels ([21ee1b](https://github.com/savonrb/httpi/commit/21ee1b)) [ichverstehe].
 
-* Fix: [issue 18](https://github.com/rubiii/httpi/issues/18) don't mask exceptions in decoded_gzip_body
-  ([f3811b](https://github.com/rubiii/httpi/commit/f3811b)) [fj].
+* Fix: [issue 18](https://github.com/savonrb/httpi/issues/18) don't mask exceptions in decoded_gzip_body
+  ([f3811b](https://github.com/savonrb/httpi/commit/f3811b)) [fj].

data/Gemfile

@@ -1,9 +1,11 @@
 source :rubygems
 gemspec
 
-gem "jruby-openssl", :platforms => :jruby
+gem "jruby-openssl",                                :platforms => :jruby
 
 # http clients
-gem "httpclient", "~> 2.1.7"
-gem "curb", "~> 0.7.8", :platforms => :ruby
-gem "mock-server", :git => "https://github.com/djanowski/mock-server.git"
+gem "mock-server",               :git => "https://github.com/djanowski/mock-server.git"
+gem "httpclient",      "~> 2.3", :require => false
+gem "curb",            "~> 0.8", :require => false, :platforms => :ruby
+gem 'em-http-request',           :require => false, :platforms => [:ruby, :jruby]
+gem 'em-synchrony',              :require => false, :platforms => [:ruby, :jruby]

data/README.md

@@ -1,9 +1,10 @@
-HTTPI [![Build Status](https://secure.travis-ci.org/rubiii/httpi.png)](http://travis-ci.org/rubiii/httpi)
+HTTPI [![Build Status](https://secure.travis-ci.org/savonrb/httpi.png)](http://travis-ci.org/savonrb/httpi)
 =====
 
-HTTPI provides a common interface for Ruby HTTP libraries.
+HTTPI provides a common interface for Ruby's HTTP libraries.
 
-[Bugs](http://github.com/rubiii/httpi/issues) | [RDoc](http://rubydoc.info/gems/httpi/frames)
+[Documentation](http://httpirb.com) | [RDoc](http://rubydoc.info/gems/httpi) |
+[Mailing list](https://groups.google.com/forum/#!forum/httpirb)
 
 Installation
 ------------
@@ -15,217 +16,30 @@ $ gem install httpi
 ```
 
 
-Getting started
----------------
-
-In order to provide a common interface, HTTPI provides the `HTTPI::Request` object for you to
-configure your request. Here's a very simple GET request.
+Introduction
+------------
 
 ``` ruby
-request = HTTPI::Request.new("http://example.com")
-HTTPI.get request
-```
-
-To execute a POST request, you may want to specify a payload.
+require "httpi"
 
-``` ruby
+# create a request object
 request = HTTPI::Request.new
-request.url = "http://post.example.com"
-request.body = "some data"
-
-HTTPI.post request
-```
-
-
-HTTPI
------
-
-The `HTTPI` module uses one of the available adapters to execute HTTP requests.
-
-#### GET
-
-``` ruby
-HTTPI.get(request, adapter = nil)
-HTTPI.get(url, adapter = nil)
-```
-
-#### POST
-
-``` ruby
-HTTPI.post(request, adapter = nil)
-HTTPI.post(url, body, adapter = nil)
-```
-
-#### HEAD
-
-``` ruby
-HTTPI.head(request, adapter = nil)
-HTTPI.head(url, adapter = nil)
-```
-
-#### PUT
-
-``` ruby
-HTTPI.put(request, adapter = nil)
-HTTPI.put(url, body, adapter = nil)
-```
-
-#### DELETE
-
-``` ruby
-HTTPI.delete(request, adapter = nil)
-HTTPI.delete(url, adapter = nil)
-```
-
-#### Notice
-
-* You can specify the adapter to use per request
-* And request methods always return an `HTTPI::Response`
-
-#### More control
-
-If you need more control over the request, you can access the HTTP client instance
-represented by your adapter in a block:
-
-``` ruby
-HTTPI.post request do |http|
-  http.use_ssl = true  # Curb example
-end
-```
-
-
-HTTPI::Adapter
---------------
-
-HTTPI uses adapters to support multiple HTTP libraries.
-It currently contains adapters for:
-
-* [httpclient](http://rubygems.org/gems/httpclient) ~> 2.1.5
-* [curb](http://rubygems.org/gems/curb) ~> 0.7.8
-* [net/http](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc)
-
-You can manually specify the adapter to use via:
-
-``` ruby
-HTTPI.adapter = :curb  # or one of [:httpclient, :net_http]
-```
-
-If you don't specify which adapter to use, HTTPI will try to load HTTPClient, then Curb and finally NetHTTP.
-
-#### Notice
-
-HTTPI does not force you to install any of these libraries. If you'd like to use on of the more advanced
-libraries (HTTPClient or Curb), you have to make sure they're in your LOAD_PATH. HTTPI will then load the
-library when executing HTTP requests.
-
-
-HTTPI::Request
---------------
-
-#### URL
-
-``` ruby
 request.url = "http://example.com"
-request.url # => #<URI::HTTP:0x101c1ab18 URL:http://example.com>
-```
 
-#### Proxy
-
-``` ruby
-request.proxy = "http://example.com"
-request.proxy # => #<URI::HTTP:0x101c1ab18 URL:http://example.com>
-```
+# and pass it to a request method
+HTTPI.get(request)
 
-#### Headers
+# use a specific adapter per request
+HTTPI.get(request, :curb)
 
-``` ruby
-request.headers["Accept-Charset"] = "utf-8"
-request.headers = { "Accept-Charset" => "utf-8" }
-request.headers # => { "Accept-Charset" => "utf-8" }
-```
-
-#### Body
-
-``` ruby
-request.body = "some data"
-request.body # => "some data"
-```
+# or specify a global adapter to use
+HTTPI.adapter = :httpclient
 
-#### Open timeout
-
-``` ruby
-request.open_timeout = 30 # sec
-```
-
-#### Read timeout
-
-``` ruby
-request.read_timeout = 30 # sec
-```
-
-
-HTTPI::Auth
------------
-
-`HTTPI::Auth` supports HTTP basic, digest and Negotiate/SPNEGO authentication.
-
-``` ruby
-request.auth.basic("username", "password")   # HTTP basic auth credentials
-request.auth.digest("username", "password")  # HTTP digest auth credentials
-request.auth.gssnegotiate                    # HTTP Negotiate/SPNEGO (aka Kerberos)
+# and execute arbitary requests
+HTTPI.request(:custom, request)
 ```
 
-HTTP Negotiate only works when using Curb.
+Documentation
+-------------
 
-For experimental NTLM authentication, please use the [httpi-ntlm](rubygems.org/gems/httpi-ntml)
-gem and provide feedback.
-
-``` ruby
-request.auth.ntlm("username", "password")    # NTLM auth credentials
-```
-
-HTTPI::Auth::SSL
-----------------
-
-`HTTPI::Auth::SSL` manages SSL client authentication.
-
-``` ruby
-request.auth.ssl.cert_key_file     = "client_key.pem"   # the private key file to use
-request.auth.ssl.cert_key_password = "C3rtP@ssw0rd"     # the key file's password
-request.auth.ssl.cert_file         = "client_cert.pem"  # the certificate file to use
-request.auth.ssl.ca_cert_file      = "ca_cert.pem"      # the ca certificate file to use
-request.auth.ssl.verify_mode       = :none              # or one of [:peer, :fail_if_no_peer_cert, :client_once]
-```
-
-
-HTTPI::Response
----------------
-
-Every request returns an `HTTPI::Response`. It contains the response code, headers and body.
-
-``` ruby
-response = HTTPI.get request
-
-response.code     # => 200
-response.headers  # => { "Content-Encoding" => "gzip" }
-response.body     # => "<!DOCTYPE HTML PUBLIC ...>"
-```
-
-The `response.body` handles gzipped and [DIME](http://en.wikipedia.org/wiki/Direct_Internet_Message_Encapsulation) encoded responses.
-
-#### TODO
-
-* Return the original `HTTPI::Request` for debugging purposes
-* Return the time it took to execute the request
-
-
-Logging
--------
-
-HTTPI by default logs each HTTP request to STDOUT using a log level of :debug.
-
-``` ruby
-HTTPI.log       = false     # disable logging
-HTTPI.logger    = MyLogger  # change the logger
-HTTPI.log_level = :info     # change the log level
-```
+Continue reading at [httpirb.com](http://httpirb.com)

data/httpi.gemspec

@@ -8,21 +8,18 @@ Gem::Specification.new do |s|
   s.version     = HTTPI::VERSION
   s.authors     = ["Daniel Harrington", "Martin Tepper"]
   s.email       = "me@rubiii.com"
-  s.homepage    = "http://github.com/rubiii/#{s.name}"
-  s.summary     = "Interface for Ruby HTTP libraries"
-  s.description = "HTTPI provides a common interface for Ruby HTTP libraries."
+  s.homepage    = "http://github.com/savonrb/#{s.name}"
+  s.summary     = "Common interface for Ruby's HTTP libraries"
+  s.description = "HTTPI provides a common interface for Ruby's HTTP libraries"
 
   s.rubyforge_project = s.name
 
   s.add_dependency "rack"
 
-  s.add_development_dependency "rake",    "~> 0.8.7"
-  s.add_development_dependency "rspec",   "~> 2.7"
-  s.add_development_dependency "mocha",   "~> 0.9.9"
-  s.add_development_dependency "webmock", "~> 1.4.0"
-
-  s.add_development_dependency "autotest"
-  s.add_development_dependency "ZenTest", "4.5.0"
+  s.add_development_dependency "rake",    "~> 0.9"
+  s.add_development_dependency "rspec",   "~> 2.11"
+  s.add_development_dependency "mocha",   "~> 0.12"
+  s.add_development_dependency "webmock", "~> 1.8"
 
   s.files = `git ls-files`.split("\n")
   s.require_path = "lib"