RubyGems - httpi - Versions diffs - 0.1.0 - Mend

httpi 0.1.0

Files changed (26) hide show

data/.rspec +1 -0
data/Gemfile +11 -0
data/README.rdoc +85 -0
data/Rakefile +13 -0
data/autotest/discover.rb +1 -0
data/lib/httpi.rb +2 -0
data/lib/httpi/adapter.rb +40 -0
data/lib/httpi/adapter/base.rb +16 -0
data/lib/httpi/adapter/curb.rb +59 -0
data/lib/httpi/adapter/httpclient.rb +51 -0
data/lib/httpi/client.rb +12 -0
data/lib/httpi/interface.rb +21 -0
data/lib/httpi/response.rb +47 -0
data/lib/httpi/version.rb +5 -0
data/spec/fixtures/gzip.gz +0 -0
data/spec/fixtures/xml.xml +0 -0
data/spec/httpi/adapter/curb_spec.rb +89 -0
data/spec/httpi/adapter/httpclient_spec.rb +86 -0
data/spec/httpi/adapter_spec.rb +46 -0
data/spec/httpi/client_spec.rb +22 -0
data/spec/httpi/interface_spec.rb +33 -0
data/spec/httpi/response_spec.rb +33 -0
data/spec/spec_helper.rb +9 -0
data/spec/support/helper_methods.rb +41 -0
data/spec/support/matchers.rb +8 -0
metadata +156 -0

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --color

data/Gemfile ADDED Viewed

@@ -0,0 +1,11 @@
+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.19"
+  gem "mocha", "~> 0.9.8"
+end

data/README.rdoc ADDED Viewed

@@ -0,0 +1,85 @@
+= HTTPI
+HTTPI provides a common interface for different HTTP libraries.
+== Installation
+The gem is available through {Rubygems}[http://rubygems.org/gems/httpi] and can be installed via:
+  $ gem install httpi
+== Supported libraries
+* {httpclient}[http://rubygems.org/gems/httpclient] ~> 2.1.5
+* {curb}[http://rubygems.org/gems/curb] ~> 0.7.8
+== Getting started
+To get started, simply create a new HTTPI::Client:
+  client = HTTPI::Client.new :curb
+Notice that when you're not passing a library to use, HTTPI will default to use the HTTPClient library:
+  HTTPI::Adapter.use  # => :httpclient
+Changing the default is fairly easy:
+  HTTPI::Adapter.use = :curb
+== Settings
+=== #headers
+Accessor for the HTTP request headers:
+  client.headers = { "Accept-Encoding" => "gzip" }
+  client.headers  # => { "Accept-Encoding" => "gzip" }
+=== #proxy
+Accessor for the proxy server to use:
+  client.proxy = "http://proxy.example.com"
+  client.proxy  # => #<URI::HTTP:0x1026240f0 URL:http://proxy.example.com>
+=== #auth(username, password)
+Setting authentication credentials:
+  client.auth "username", "password"
+== Request methods
+=== #get(url)
+Sending an HTTP GET request:
+  client.get "http://example.com"
+=== #post(url, body)
+Sending an HTTP POST request:
+  client.post "http://example.com", "<some>xml</xml>"
+== HTTPI::Response
+Every HTTP request method is supposed to return an HTTPI::Response containing the response code, headers and body.
+  response = client.get "http://example.com"
+  response.code     # => 200
+  response.headers  # => { "Content-Encoding" => "gzip" }
+  response.body     # => "<!DOCTYPE HTML PUBLIC ..."
+== Participate
+I would appreciate any help to support additional libraries and methods!
+== TODO
+Implement methods for:
+* add SSL configuration method
+* add timeout methods

data/Rakefile ADDED Viewed

@@ -0,0 +1,13 @@
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new do |t|
+    t.spec_opts = %w(-fd -c)
+  end
+rescue LoadError
+  task :spec do
+    abort "Run 'gem install rspec' to be able to run specs"
+  end
+end
+task :default => :spec

data/autotest/discover.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ Autotest.add_discovery { "rspec2" }

data/lib/httpi.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require "httpi/version"
2	+ require "httpi/client"

data/lib/httpi/adapter.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require "httpi/adapter/httpclient"
+require "httpi/adapter/curb"
+module HTTPI
+  module Adapter
+    # The default adapter.
+    DEFAULT = :httpclient
+    # Returns the adapter to use. Defaults to <tt>HTTPI::Adapter::DEFAULT</tt>.
+    def self.use
+      @use ||= DEFAULT
+    end
+    # Sets the +adapter+ to use. Raises an +ArgumentError+ unless the +adapter+ exists.
+    def self.use=(adapter)
+      validate_adapter! adapter
+      @use = adapter
+    end
+    # Returns a memoized +Hash+ of adapters.
+    def self.adapters
+      @adapters ||= { :httpclient => HTTPClient, :curb => Curb }
+    end
+    # Returns an +adapter+. Raises an +ArgumentError+ unless the +adapter+ exists.
+    def self.find(adapter)
+      validate_adapter! adapter
+      adapters[adapter]
+    end
+  private
+    # Raises an +ArgumentError+ unless the +adapter+ exists.
+    def self.validate_adapter!(adapter)
+      raise ArgumentError, "Invalid HTTPI adapter: #{adapter}" unless adapters[adapter]
+    end
+  end
+end

data/lib/httpi/adapter/base.rb ADDED Viewed

@@ -0,0 +1,16 @@
+module HTTPI
+  module Adapter
+    module Base
+      # List of methods expected to be implemented by an adapter.
+      METHODS = %w(setup client headers headers= proxy proxy= get post auth)
+      METHODS.each do |method|
+        define_method method do |*args|
+          raise NotImplementedError, "#{Adapter.use} does not implement a #{method} method"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require "httpi/response"
+require "httpi/adapter/base"
+module HTTPI
+  module Adapter
+    module Curb
+      include Base
+      def setup
+        require "curb"
+      end
+      def client
+        @client ||= Curl::Easy.new
+      end
+      def headers
+        client.headers
+      end
+      def headers=(headers)
+        client.headers = headers
+      end
+      def proxy
+        proxy = client.proxy_url
+        proxy.kind_of?(URI) ? proxy : URI(proxy)
+      end
+      def proxy=(proxy)
+        client.proxy_url = proxy
+      end
+      def auth(username, password)
+        client.username = username
+        client.password = password
+      end
+      def get(url)
+        client.url = url.to_s
+        client.http_get
+        respond
+      end
+      def post(url, body)
+        client.url = url.to_s
+        client.http_post body
+        respond
+      end
+    private
+      def respond
+        Response.new client.response_code, client.headers, client.body_str
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+require "httpi/response"
+require "httpi/adapter/base"
+module HTTPI
+  module Adapter
+    module HTTPClient
+      include Base
+      def setup
+        require "httpclient"
+      end
+      def client
+        @client ||= ::HTTPClient.new
+      end
+      def headers
+        @headers ||= {}
+      end
+      attr_writer :headers
+      def proxy
+        client.proxy
+      end
+      def proxy=(proxy)
+        client.proxy = proxy
+      end
+      def auth(username, password)
+        client.set_auth nil, username, password
+      end
+      def get(url)
+        respond_with client.get(url)
+      end
+      def post(url, body)
+        respond_with client.post(url, body, headers)
+      end
+    private
+      def respond_with(response)
+        Response.new response.code, Hash[response.header.all], response.content
+      end
+    end
+  end
+end

data/lib/httpi/client.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require "httpi/interface"
+module HTTPI
+  class Client
+    include Interface
+    def initialize(adapter = nil)
+      load! adapter
+    end
+  end
+end

data/lib/httpi/interface.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require "httpi/adapter"
+module HTTPI
+  module Interface
+    # Loads a given +adapter+. Defaults to load <tt>HTTPI::Adapter::DEFAULT</tt>.
+    def load!(adapter = nil)
+      adapter ||= Adapter.use
+      include_adapter Adapter.find(adapter)
+      setup
+    end
+  private
+    # Includes a given +adapter+ into the current class.
+    def include_adapter(adapter)
+      self.class.send :include, adapter
+    end
+  end
+end

data/lib/httpi/response.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require "zlib"
+require "stringio"
+module HTTPI
+  class Response
+    # Range of HTTP response codes considered to be successful.
+    SuccessfulResponseCodes = 200..299
+    # Initializer expects an HTTP response +code+, +headers+ and +body+.
+    def initialize(code, headers, body)
+      self.code = code
+      self.headers = headers
+      self.raw_body = body
+    end
+    attr_accessor :code, :headers, :raw_body
+    # Returns whether the HTTP response is considered successful.
+    def error?
+      !SuccessfulResponseCodes.include? code.to_i
+    end
+    # Returns the HTTP response body.
+    def body
+      @body ||= gzipped_response? ? decoded_body : raw_body
+    end
+    attr_writer :body
+  private
+    # Returns whether the response is gzipped.
+    def gzipped_response?
+      headers["Content-Encoding"] == "gzip" || raw_body[0..1] == "\x1f\x8b"
+    end
+    # Returns the gzip decoded response body.
+    def decoded_body
+      gzip = Zlib::GzipReader.new StringIO.new(raw_body)
+      gzip.read
+    ensure
+      gzip.close
+    end
+  end
+end

data/lib/httpi/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module HTTPI
+  VERSION = "0.1.0"
+end

data/spec/fixtures/gzip.gz ADDED Viewed

Binary file

data/spec/fixtures/xml.xml ADDED Viewed

File without changes

data/spec/httpi/adapter/curb_spec.rb ADDED Viewed

@@ -0,0 +1,89 @@
+require "spec_helper"
+require "httpi/adapter/curb"
+describe HTTPI::Adapter::Curb do
+  before do
+    @adapter = Class.new { include HTTPI::Adapter::Curb }.new
+  end
+  describe "#setup" do
+    it "should require the Curb gem" do
+      @adapter.expects(:require).with("curb")
+      @adapter.setup
+    end
+  end
+  context "after #setup:" do
+    before { @adapter.setup }
+    describe "#client" do
+      it "should return a memoized Curl::Easy instance" do
+        client = @adapter.client
+        client.should be_an(Curl::Easy)
+        client.should equal(@adapter.client)
+      end
+    end
+    describe "#headers" do
+      it "should default to return an empty Hash" do
+        @adapter.headers.should == {}
+      end
+    end
+    describe "#headers=" do
+      it "should set a given Hash of HTTP headers" do
+        @adapter.headers = Some.headers
+        @adapter.headers.should == Some.headers
+      end
+    end
+    describe "#proxy" do
+      it "should set the proxy server to use" do
+        @adapter.proxy = Some.proxy_url
+        @adapter.proxy.should == URI(Some.proxy_url)
+      end
+      it "should accept a URI" do
+        @adapter.proxy = URI(Some.proxy_url)
+        @adapter.proxy.should == URI(Some.proxy_url)
+      end
+    end
+    describe "#auth" do
+      it "should set authentication credentials" do
+        @adapter.client.expects(:username=).with("username")
+        @adapter.client.expects(:password=).with("password")
+        @adapter.auth "username", "password"
+      end
+    end
+    describe "#get" do
+      before do
+        @adapter.client.expects(:http_get)
+        @adapter.client.expects(:response_code).returns(Some.response_code)
+        @adapter.client.expects(:headers).returns(Some.headers)
+        @adapter.client.expects(:body_str).returns(Fixture.xml)
+      end
+      it "should return a valid HTTPI::Response" do
+        @adapter.get(Some.url).should be_a_valid_httpi_response
+      end
+    end
+   describe "#post" do
+     before do
+       @adapter.client.expects(:http_post)
+       @adapter.client.expects(:response_code).returns(Some.response_code)
+       @adapter.client.expects(:headers).returns(Some.headers)
+       @adapter.client.expects(:body_str).returns(Fixture.xml)
+     end
+     it "should return a valid HTTPI::Response" do
+       @adapter.post(Some.url, Fixture.xml).should be_a_valid_httpi_response
+     end
+   end
+  end
+end

data/spec/httpi/adapter/httpclient_spec.rb ADDED Viewed

@@ -0,0 +1,86 @@
+require "spec_helper"
+require "httpi/adapter/httpclient"
+describe HTTPI::Adapter::HTTPClient do
+  before do
+    @adapter = Class.new { include HTTPI::Adapter::HTTPClient }.new
+  end
+  describe "#setup" do
+    it "should require the HTTPClient gem" do
+      @adapter.expects(:require).with("httpclient")
+      @adapter.setup
+    end
+  end
+  context "after #setup:" do
+    before { @adapter.setup }
+    describe "#client" do
+      it "should return a memoized HTTPClient instance" do
+        client = @adapter.client
+        client.should be_an(HTTPClient)
+        client.should equal(@adapter.client)
+      end
+    end
+    describe "#headers" do
+      it "should default to return an empty Hash" do
+        @adapter.headers.should == {}
+      end
+    end
+    describe "#headers=" do
+      it "should set a given Hash of HTTP headers" do
+        @adapter.headers = Some.headers
+        @adapter.headers.should == Some.headers
+      end
+    end
+    describe "#proxy" do
+      it "should set the proxy server to use" do
+        @adapter.proxy = Some.proxy_url
+        @adapter.proxy.should == URI(Some.proxy_url)
+      end
+      it "should accept a URI" do
+        @adapter.proxy = URI(Some.proxy_url)
+        @adapter.proxy.should == URI(Some.proxy_url)
+      end
+    end
+    describe "#auth" do
+      it "should set authentication credentials" do
+        @adapter.client.expects(:set_auth).with(nil, "username", "password")
+        @adapter.auth "username", "password"
+      end
+    end
+    describe "#get" do
+      before do
+        response = HTTP::Message.new_response Fixture.xml
+        response.header.add *Some.headers.to_a.first
+        @adapter.client.expects(:get).with(Some.url).returns(response)
+      end
+      it "should return a valid HTTPI::Response" do
+        @adapter.get(Some.url).should be_a_valid_httpi_response
+      end
+    end
+    describe "#post" do
+      before do
+        response = HTTP::Message.new_response Fixture.xml
+        response.header.add *Some.headers.to_a.first
+        @adapter.headers = Some.headers
+        @adapter.client.expects(:post).with(Some.url, Fixture.xml, Some.headers).returns(response)
+      end
+      it "should return a valid HTTPI::Response" do
+        @adapter.post(Some.url, Fixture.xml).should be_a_valid_httpi_response
+      end
+    end
+  end
+end

data/spec/httpi/adapter_spec.rb ADDED Viewed

@@ -0,0 +1,46 @@
+require "spec_helper"
+require "httpi/adapter"
+describe HTTPI::Adapter do
+  describe ".use" do
+    it "should default to HTTPClient" do
+      HTTPI::Adapter.use.should == :httpclient
+    end
+  end
+  describe ".use=" do
+    it "should accept an adapter to use" do
+      HTTPI::Adapter.use = :curb
+      HTTPI::Adapter.use.should == :curb
+      # reset to default
+      HTTPI::Adapter.use = HTTPI::Adapter::DEFAULT
+    end
+    it "should raise an ArgumentError in case of an invalid adapter" do
+      lambda { HTTPI::Adapter.use = :unknown }.should raise_error(ArgumentError)
+    end
+  end
+  describe ".adapters" do
+    it "should return a memoized Hash of adapters" do
+      HTTPI::Adapter.adapters.should have(2).items
+      HTTPI::Adapter.adapters.should include(
+        :httpclient => HTTPI::Adapter::HTTPClient,
+        :curb => HTTPI::Adapter::Curb
+      )
+    end
+  end
+  describe ".find" do
+    it "should return the adapter for a given Symbol" do
+      HTTPI::Adapter.find(:httpclient).should == HTTPI::Adapter::HTTPClient
+    end
+    it "should raise an ArgumentError in case of an invalid adapter" do
+      lambda { HTTPI::Adapter.find :unknown }.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/httpi/client_spec.rb ADDED Viewed

@@ -0,0 +1,22 @@
+require "spec_helper"
+require "httpi"
+describe HTTPI::Client do
+  describe ".new" do
+    it "should default to use HTTPI::Adapter::DEFAULT" do
+      @httpi = HTTPI::Client.new
+      @httpi.client.should be_an(HTTPClient)
+    end
+    it "should accept an adapter to use" do
+      @httpi = HTTPI::Client.new :curb
+      @httpi.client.should be_a(Curl::Easy)
+    end
+    it "should raise an ArgumentError in case of an invalid adapter" do
+      lambda { HTTPI::Client.new :unknown }.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/httpi/interface_spec.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require "spec_helper"
+require "httpi/interface"
+describe HTTPI::Interface do
+  context "when included" do
+    before do
+      @httpi = Class.new { include HTTPI::Interface }.new
+    end
+    it "should offer a #load! method for loading an adapter" do
+      @httpi.load!
+      @httpi.client.should be_an(HTTPClient)
+    end
+    describe "#load!" do
+      it "should accept an adapter to use" do
+        @httpi.load! :curb
+        @httpi.client.should be_a(Curl::Easy)
+      end
+      it "should raise an ArgumentError in case of an invalid adapter" do
+        lambda { @httpi.load! :unknown }.should raise_error(ArgumentError)
+      end
+      it "should call the adapter's #setup method" do
+        @httpi.expects(:setup)
+        @httpi.load!
+      end
+    end
+  end
+end

data/spec/httpi/response_spec.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require "spec_helper"
+require "httpi/response"
+describe HTTPI::Response do
+  before do
+    @response = HTTPI::Response.new Some.response_code, Some.headers, Fixture.gzip
+  end
+  describe "#code" do
+    it "should return the HTTP response code" do
+      @response.code.should == Some.response_code
+    end
+  end
+  describe "#code" do
+    it "should return the HTTP response headers" do
+      @response.headers.should == Some.headers
+    end
+  end
+  describe "#body" do
+    it "should return the (gzip decoded) HTTP response body" do
+      @response.body.should == "A short gzip encoded message\n"
+    end
+  end
+  describe "#raw_body" do
+    it "should return the raw HTML response body" do
+      @response.raw_body.should == Fixture.gzip
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require "rspec"
+require "mocha"
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+require "support/helper_methods"
+require "support/matchers"

data/spec/support/helper_methods.rb ADDED Viewed

@@ -0,0 +1,41 @@
+class Some
+  class << self
+    def url
+      @url ||= "http://example.com"
+    end
+    def proxy_url
+      @proxy_url ||= "http://proxy.example.com"
+    end
+    def headers
+      @headers ||= { "Content-Type" => "text/html; charset=utf-8" }
+    end
+    def response_code
+      @code ||= 200
+    end
+  end
+end
+class Fixture
+  class << self
+    def xml
+      @xml ||= load :xml
+    end
+    def gzip
+      @gzip ||= load :gzip, :gz
+    end
+  private
+    def load(fixture, type = :xml)
+      File.read File.expand_path("../../fixtures/#{fixture}.#{type}", __FILE__)
+    end
+  end
+end

data/spec/support/matchers.rb ADDED Viewed

@@ -0,0 +1,8 @@
+RSpec::Matchers.define :be_a_valid_httpi_response do
+  match do |actual|
+    actual.should be_an(HTTPI::Response)
+    actual.code.should == Some.response_code
+    actual.headers.should == Some.headers
+    actual.body.should == Fixture.xml
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: httpi
+version: !ruby/object:Gem::Version
+  hash: 27
+  prerelease: false
+  segments:
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Harrington
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-09-12 00:00:00 +02:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 1
+        segments:
+        - 2
+        - 1
+        - 5
+        version: 2.1.5
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: curb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 19
+        segments:
+        - 0
+        - 7
+        - 8
+        version: 0.7.8
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "="
+      - !ruby/object:Gem::Version
+        hash: 62196421
+        segments:
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 43
+        segments:
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id004
+description: HTTPI provides a common interface for different HTTP libraries.
+email: me@rubiii.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- README.rdoc
+- autotest/discover.rb
+- lib/httpi/adapter/base.rb
+- lib/httpi/adapter/curb.rb
+- lib/httpi/adapter/httpclient.rb
+- lib/httpi/adapter.rb
+- lib/httpi/client.rb
+- lib/httpi/interface.rb
+- lib/httpi/response.rb
+- lib/httpi/version.rb
+- lib/httpi.rb
+- spec/fixtures/gzip.gz
+- spec/fixtures/xml.xml
+- spec/httpi/adapter/curb_spec.rb
+- spec/httpi/adapter/httpclient_spec.rb
+- spec/httpi/adapter_spec.rb
+- spec/httpi/client_spec.rb
+- spec/httpi/interface_spec.rb
+- spec/httpi/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/helper_methods.rb
+- spec/support/matchers.rb
+- .rspec
+has_rdoc: true
+homepage: http://github.com/rubiii/httpi
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project: httpi
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Common interface for Ruby HTTP libraries
+test_files: []