RubyGems - httpi - Versions diffs - 0.2.0 → 0.3.0 - Mend

httpi 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

data/Gemfile +1 -10
data/Gemfile.lock +6 -0
data/README.md +138 -0
data/Rakefile +2 -1
data/lib/httpi.rb +97 -1
data/lib/httpi/adapter.rb +8 -1
data/lib/httpi/adapter/curb.rb +14 -7
data/lib/httpi/adapter/httpclient.rb +12 -5
data/lib/httpi/request.rb +4 -0
data/lib/httpi/response.rb +4 -0
data/lib/httpi/version.rb +1 -1
data/spec/httpi/{client_spec.rb → httpi_spec.rb} +18 -2
metadata +8 -9
data/README.rdoc +0 -114
data/lib/httpi/client.rb +0 -70

data/Gemfile CHANGED Viewed

@@ -1,11 +1,2 @@
 source :rubygems
-group :development, :test do
-  gem "httpclient", "~> 2.1.5"
-  gem "curb", "~> 0.7.8"
-end
-group :test do
-  gem "rspec", "2.0.0.beta.22"
-  gem "mocha", "~> 0.9.8"
-end
+gemspec

data/Gemfile.lock CHANGED Viewed

@@ -1,3 +1,8 @@
+PATH
+  remote: .
+  specs:
+    httpi (0.2.0)
 GEM
   remote: http://rubygems.org/
   specs:
@@ -24,5 +29,6 @@ PLATFORMS
 DEPENDENCIES
   curb (~> 0.7.8)
   httpclient (~> 2.1.5)
+  httpi!
   mocha (~> 0.9.8)
   rspec (= 2.0.0.beta.22)

data/README.md ADDED Viewed

@@ -0,0 +1,138 @@
+HTTPI
+=====
+HTTPI provides a common interface for Ruby HTTP libraries.
+Installation
+------------
+The gem is available through [Rubygems](http://rubygems.org/gems/httpi) and can be installed via:
+    $ gem install httpi
+Some examples
+-------------
+Let's create the most basic request object and execute a GET request:
+    request = HTTPI::Request.new :url => "http://example.com"
+    HTTPI.get request
+A POST request with a request object:
+    request = HTTPI::Request.new
+    request.url = "http://post.example.com"
+    request.body = "send me"
+    HTTPI.post request
+And a GET request using HTTP basic auth and the Curb adapter:
+    request = HTTPI::Request.new
+    request.url = "http://auth.example.com"
+    request.basic_auth "username", "password"
+    HTTPI.get request, :curb
+HTTPI also comes with some shortcuts. This executes a GET request:
+    HTTPI.get "http://example.com"
+And here's a POST:
+    HTTPI.post "http://example.com", "<some>xml</some>"
+HTTPI
+-------------
+The `HTTPI` module uses one of the available adapters to execute HTTP requests.
+It currently supports GET and POST requests:
+### GET
+    .get(request, adapter = nil)
+    .get(url, adapter = nil)
+### POST
+    .post(request, adapter = nil)
+    .post(url, body, 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:
+    HTTPI.post request do |http|
+      http.use_ssl = true  # Curb example
+    end
+### TODO
+* Add support for HEAD, PUT and DELETE requests
+HTTPI::Request
+--------------
+The `HTTPI::Request` serves as a common denominator of options that HTTPI adapters need to support.
+It represents an HTTP request and lets you customize various settings through these accessors:
+    #url           # the URL to access
+    #proxy         # the proxy server to use
+    #headers       # a Hash of HTTP headers
+    #body          # the HTTP request body
+    #open_timeout  # the open timeout (sec)
+    #read_timeout  # the read timeout (sec)
+It also contains methods for setting up authentication:
+    #basic_auth(username, password)  # HTTP basic auth credentials
+### TODO
+* Add support for HTTP digest authentication
+* Add support for SSL client authentication
+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
+By default, HTTPI uses the `HTTPClient`. But changing the default is fairly easy:
+    HTTPI::Adapter.use = :curb
+You can find a list of supported adapters via:
+    HTTPI::Adapter.adapters  # returns a Hash of supported adapters
+HTTPI::Response
+---------------
+As mentioned before, every request method return an `HTTPI::Response`.
+It contains the response code, headers and body.
+    response = HTTPI.get request
+    response.code     # => 200
+    response.headers  # => { "Content-Encoding" => "gzip" }
+    response.body     # => "<!DOCTYPE HTML PUBLIC ..."
+### TODO
+* Return the original `HTTPI::Request` for debugging purposes
+* Return the time it took to execute the request
+Participate
+-----------
+We appreciate any help and feedback, so please get in touch!

data/Rakefile CHANGED Viewed

@@ -4,7 +4,7 @@ begin
   require "yard"
   YARD::Rake::YardocTask.new do |t|
-    t.files = ["README.rdoc", "lib/**/*.rb"]
+    t.files = ["README.md", "lib/**/*.rb"]
   end
 rescue LoadError
   desc message = %{"gem install yard" to generate documentation}
@@ -17,6 +17,7 @@ begin
   MetricFu::Configuration.run do |c|
     c.metrics = [:churn, :flog, :flay, :reek, :roodi, :saikuro] # :rcov seems to be broken
     c.graphs = [:flog, :flay, :reek, :roodi]
+    c.flay = { :dirs_to_flay => ["lib"], :minimum_score => 20 }
     c.rcov[:rcov_opts] << "-Ilib -Ispec"
   end
 rescue LoadError

data/lib/httpi.rb CHANGED Viewed

@@ -1,2 +1,98 @@
 require "httpi/version"
-require "httpi/client"
+require "httpi/request"
+require "httpi/adapter"
+# = HTTPI
+#
+# Executes HTTP requests using a predefined adapter.
+module HTTPI
+  class << self
+    # Executes an HTTP GET request and returns an <tt>HTTPI::Response</tt>.
+    #
+    # ==== Example
+    #
+    # Accepts an <tt>HTTPI::Request</tt> and an optional adapter:
+    #
+    #   request = HTTPI::Request.new :url => "http://example.com"
+    #   HTTPI.get request, :httpclient
+    #
+    # ==== Shortcut
+    #
+    # You can also just pass a URL and an optional adapter if you don't
+    # need to configure the request:
+    #
+    #   HTTPI.get "http://example.com", :curb
+    #
+    # ==== More control
+    #
+    # If you need more control over the request, you can access the HTTP
+    # client instance represented by your adapter in a block.
+    #
+    #   HTTPI.get request do |http|
+    #     http.follow_redirect_count = 3  # HTTPClient example
+    #   end
+    def get(request, adapter = nil)
+      request = Request.new :url => request if request.kind_of? String
+      with adapter do |adapter|
+        yield adapter.client if block_given?
+        adapter.get request
+      end
+    end
+    # Executes an HTTP POST request and returns an <tt>HTTPI::Response</tt>.
+    #
+    # ==== Example
+    #
+    # Accepts an <tt>HTTPI::Request</tt> and an optional adapter:
+    #
+    #   request = HTTPI::Request.new
+    #   request.url = "http://example.com"
+    #   request.body = "<some>xml</some>"
+    #
+    #   HTTPI.post request, :httpclient
+    #
+    # ==== Shortcut
+    #
+    # You can also just pass a URL, a request body and an optional adapter
+    # if you don't need to configure the request:
+    #
+    #   HTTPI.post "http://example.com", "<some>xml</some>", :curb
+    #
+    # ==== More control
+    #
+    # If you need more control over the request, you can access the HTTP
+    # client instance represented by your adapter in a block.
+    #
+    #   HTTPI.post request do |http|
+    #     http.use_ssl = true  # Curb example
+    #   end
+    def post(*args)
+      request, adapter = extract_post_args(args)
+      with adapter do |adapter|
+        yield adapter.client if block_given?
+        adapter.post request
+      end
+    end
+    private
+    # Checks whether +args+ contains of an <tt>HTTPI::Request</tt> or a URL
+    # and a request body plus an optional adapter and returns an Array with
+    # an <tt>HTTPI::Request</tt> and (if given) an adapter.
+    def extract_post_args(args)
+      return args if args[0].kind_of? Request
+      [Request.new(:url => args[0], :body => args[1]), args[2]]
+    end
+    # Accepts an +adapter+ (defaults to <tt>Adapter.use</tt>) and yields a
+    # new instance of the adapter to a given block.
+    def with(adapter)
+      adapter ||= Adapter.use
+      yield Adapter.find(adapter).new
+    end
+  end
+end

data/lib/httpi/adapter.rb CHANGED Viewed

@@ -2,9 +2,16 @@ require "httpi/adapter/httpclient"
 require "httpi/adapter/curb"
 module HTTPI
+  # = HTTPI::Adapter
+  #
+  # Manages the adapter classes. Currently supports:
+  #
+  # * httpclient
+  # * curb
   module Adapter
-    # The def self.ault adapter.
+    # The default adapter.
     DEFAULT = :httpclient
     # Returns the adapter to use. Defaults to <tt>HTTPI::Adapter::DEFAULT</tt>.

data/lib/httpi/adapter/curb.rb CHANGED Viewed

@@ -2,12 +2,21 @@ require "httpi/response"
 module HTTPI
   module Adapter
+    # = HTTPI::Adapter::Curb
+    #
+    # Adapter for the Curb client.
+    # http://rubygems.org/gems/curb
     class Curb
       def initialize
         require "curb"
       end
+      def client
+        @client ||= Curl::Easy.new
+      end
       def get(request)
         get_request(request) { |client| client.http_get }
       end
@@ -19,27 +28,25 @@ module HTTPI
     private
       def get_request(request)
-        client = client_for request
+        setup_client request
         yield client
         respond_with client
       end
       def post_request(request)
-        request.url = request.url.to_s
-        request.url.gsub!('?wsdl', '') if request.url =~ /\?wsdl$/
+        request.url.query = nil if request.url.query == "wsdl"
-        client = client_for request
+        setup_client request
         yield client, request.body
         respond_with client
       end
-      def client_for(request)
-        client = Curl::Easy.new request.url.to_s
+      def setup_client(request)
+        client.url = request.url.to_s
         client.timeout = request.read_timeout
         client.connect_timeout = request.open_timeout
         client.headers = request.headers
         client.verbose = false
-        client
       end
       def respond_with(client)

data/lib/httpi/adapter/httpclient.rb CHANGED Viewed

@@ -2,12 +2,21 @@ require "httpi/response"
 module HTTPI
   module Adapter
+    # = HTTPI::Adapter::HTTPClient
+    #
+    # Adapter for the HTTPClient client.
+    # http://rubygems.org/gems/httpclient
     class HTTPClient
       def initialize
         require "httpclient"
       end
+      def client
+        @client ||= ::HTTPClient.new
+      end
       def get(request)
         get_request request do |client, url, headers|
           client.get url, nil, headers
@@ -23,21 +32,19 @@ module HTTPI
     private
       def get_request(request)
-        client = client_for request
+        setup_client request
         respond_with yield(client, request.url, request.headers)
       end
       def post_request(request)
-        client = client_for request
+        setup_client request
         respond_with yield(client, request.url, request.headers, request.body)
       end
-      def client_for(request)
-        client = ::HTTPClient.new
+      def setup_client(request)
         client.proxy = request.proxy if request.proxy
         client.connect_timeout = request.open_timeout
         client.receive_timeout = request.read_timeout
-        client
       end
       def respond_with(response)

data/lib/httpi/request.rb CHANGED Viewed

@@ -1,6 +1,10 @@
 require "uri"
 module HTTPI
+  # = HTTPI::Request
+  #
+  # Represents an HTTP request and contains various methods for customizing that request.
   class Request
     # Request accessor methods.

data/lib/httpi/response.rb CHANGED Viewed

@@ -2,6 +2,10 @@ require "zlib"
 require "stringio"
 module HTTPI
+  # = HTTPI::Response
+  #
+  # Represents an HTTP response and contains various response details.
   class Response
     # Range of HTTP response codes considered to be successful.

data/lib/httpi/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module HTTPI
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/httpi/{client_spec.rb → httpi_spec.rb} RENAMED Viewed

@@ -1,8 +1,8 @@
 require "spec_helper"
 require "httpi"
-describe HTTPI::Client do
-  let(:client) { HTTPI::Client }
+describe HTTPI do
+  let(:client) { HTTPI }
   let(:default_adapter) { HTTPI::Adapter.find HTTPI::Adapter.use }
   let(:curb) { HTTPI::Adapter.find :curb }
@@ -43,6 +43,14 @@ describe HTTPI::Client do
   end
   describe ".get" do
+    context "(with a block)" do
+      it "should yield the HTTP client instance used for the request" do
+        client.get "http://example.com" do |http|
+          http.should be_an(HTTPClient)
+        end
+      end
+    end
     it "should raise an ArgumentError in case of an invalid adapter" do
       lambda { client.get HTTPI::Request.new, :invalid }.should raise_error(ArgumentError)
     end
@@ -91,6 +99,14 @@ describe HTTPI::Client do
   end
   describe ".post" do
+    context "(with a block)" do
+      it "should yield the HTTP client instance used for the request" do
+        client.get "http://example.com", :curb do |http|
+          http.should be_a(Curl::Easy)
+        end
+      end
+    end
     it "should raise an ArgumentError in case of an invalid adapter" do
       lambda { client.post HTTPI::Request.new, :invalid }.should raise_error(ArgumentError)
     end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: httpi
 version: !ruby/object:Gem::Version
-  hash: 23
+  hash: 19
   prerelease: false
   segments:
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Harrington
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-09-23 00:00:00 +02:00
+date: 2010-09-24 00:00:00 +02:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -97,12 +97,12 @@ files:
 - Gemfile
 - Gemfile.lock
 - Rakefile
-- README.rdoc
+- README.md
+- .rspec
 - autotest/discover.rb
 - lib/httpi/adapter/curb.rb
 - lib/httpi/adapter/httpclient.rb
 - lib/httpi/adapter.rb
-- lib/httpi/client.rb
 - lib/httpi/request.rb
 - lib/httpi/response.rb
 - lib/httpi/version.rb
@@ -112,13 +112,12 @@ files:
 - spec/httpi/adapter/curb_spec.rb
 - spec/httpi/adapter/httpclient_spec.rb
 - spec/httpi/adapter_spec.rb
-- spec/httpi/client_spec.rb
+- spec/httpi/httpi_spec.rb
 - spec/httpi/request_spec.rb
 - spec/httpi/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture.rb
 - spec/support/matchers.rb
-- .rspec
 has_rdoc: true
 homepage: http://github.com/rubiii/httpi
 licenses: []
@@ -152,6 +151,6 @@ rubyforge_project: httpi
 rubygems_version: 1.3.7
 signing_key:
 specification_version: 3
-summary: Common interface for Ruby HTTP libraries
+summary: Interface for Ruby HTTP libraries
 test_files: []

data/README.rdoc DELETED Viewed

@@ -1,114 +0,0 @@
-= HTTPI
-HTTPI provides a common interface for Ruby HTTP libraries.
-== Installation
-The gem is available through {Rubygems}[http://rubygems.org/gems/httpi] and can be installed via:
-  $ gem install httpi
-== Basic examples
-Let's create the most basic request object and execute a GET request:
-  request = HTTPI::Request.new :url => "http://example.com"
-  HTTPI::Client.get request
-And a POST request with a request object:
-  request = HTTPI::Request.new
-  request.url = "http://post.example.com"
-  request.body = "send me"
-  HTTPI::Client.post request
-Or a GET request using HTTP basic auth and the Curb adapter:
-  request = HTTPI::Request.new
-  request.url = "http://auth.example.com"
-  request.basic_auth "username", "password"
-  HTTPI::Client.get request, :curb
-HTTPI also comes with some shortcuts. This executes a GET request:
-  HTTPI::Client.get "http://example.com"
-And here's a POST:
-  HTTPI::Client.post "http://example.com", "<some>xml</some>"
-== HTTPI::Request
-The HTTPI::Request serves as a common denominator of options that HTTPI adapters need to support. It represents an HTTP request and lets you customize various settings:
-* [url]           the URL to access
-* [proxy]         the proxy server to use
-* [headers]       a Hash of HTTP headers
-* [body]          the HTTP request body
-* [open_timeout]  the open timeout (sec)
-* [read_timeout]  the read timeout (sec)
-It also contains methods for setting up authentication:
-* [basic_auth]  HTTP basic auth credentials
-==== TODO:
-* Add support for HTTP digest authentication
-* Add support for SSL client authentication
-== HTTPI::Client
-The HTTPI::Client uses one of the available adapters to execute HTTP requests. It currently supports GET and POST requests:
-=== GET
-* get(request, adapter = nil)
-* get(url, adapter = nil)
-=== POST
-* post(request, adapter = nil)
-* post(url, body, adapter = nil)
-You can specify the adapter to use per request. Request methods always returns an HTTPI::Response.
-==== TODO:
-* Add support for HEAD, PUT and DELETE requests
-== 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
-By default, HTTPI uses the HTTPClient. But changing the default is fairly easy:
-  HTTPI::Adapter.use = :curb
-You can find a list of supported adapters via:
-  HTTPI::Adapter.adapters  # returns a Hash of supported adapters
-== HTTPI::Response
-As mentioned before, every request method return an HTTPI::Response. It contains the response code, headers and body.
-  response = HTTPI::Client.get request
-  response.code     # => 200
-  response.headers  # => { "Content-Encoding" => "gzip" }
-  response.body     # => "<!DOCTYPE HTML PUBLIC ..."
-==== TODO
-* Return the original HTTPI::Request for debugging purposes
-* Return the time it took to execute the request
-== Participate
-We appreciate any help and feedback, so please get in touch!

data/lib/httpi/client.rb DELETED Viewed

@@ -1,70 +0,0 @@
-require "httpi/request"
-require "httpi/adapter"
-module HTTPI
-  class Client
-    class << self
-      # Executes an HTTP GET request and returns an <tt>HTTPI::Response</tt>.
-      #
-      # ==== Example
-      #
-      # Accepts an <tt>HTTPI::Request</tt> and an optional adapter:
-      #
-      #   request = HTTPI::Request.new :url => "http://example.com"
-      #   HTTPI::Client.get request, :httpclient
-      #
-      # ==== Shortcut
-      #
-      # You can also just pass a URL and an optional adapter if you don't
-      # need to configure the request:
-      #
-      #   HTTPI::Client.get "http://example.com", :curb
-      def get(request, adapter = nil)
-        request = Request.new :url => request if request.kind_of? String
-        find_adapter(adapter).get request
-      end
-      # Executes an HTTP POST request and returns an <tt>HTTPI::Response</tt>.
-      #
-      # ==== Example
-      #
-      # Accepts an <tt>HTTPI::Request</tt> and an optional adapter:
-      #
-      #   request = HTTPI::Request.new
-      #   request.url = "http://example.com"
-      #   request.body = "<some>xml</some>"
-      #
-      #   HTTPI::Client.post request, :httpclient
-      #
-      # ==== Shortcut
-      #
-      # You can also just pass a URL, a request body and an optional adapter
-      # if you don't need to configure the request:
-      #
-      #   HTTPI::Client.post "http://example.com", "<some>xml</some>", :curb
-      def post(*args)
-        request, adapter = extract_post_args(args)
-        find_adapter(adapter).post request
-      end
-    private
-      # Checks whether +args+ contains of an <tt>HTTPI::Request</tt> or a URL
-      # and a request body plus an optional adapter and returns an Array with
-      # an <tt>HTTPI::Request</tt> and (if given) an adapter.
-      def extract_post_args(args)
-        return args if args.first.kind_of? Request
-        [Request.new(:url => args[0], :body => args[1]), args[2]]
-      end
-      # Accepts an +adapter+ (defaults to <tt>Adapter.use</tt>) and returns
-      # a new instance of the adapter to use.
-      def find_adapter(adapter)
-        adapter ||= Adapter.use
-        Adapter.find(adapter).new
-      end
-    end
-  end
-end