httpi 0.5.0 → 0.6.0

data/lib/httpi/request.rb

@@ -1,4 +1,5 @@
 require "uri"
+require "httpi/auth/config"
 
 module HTTPI
 
@@ -7,17 +8,16 @@ module HTTPI
   # Represents an HTTP request and contains various methods for customizing that request.
   class Request
 
-    # Request accessor methods.
-    ACCESSORS = [:url, :proxy, :headers, :body, :open_timeout, :read_timeout]
+    # Available attribute writers.
+    ATTRIBUTES = [:url, :proxy, :headers, :body, :open_timeout, :read_timeout]
 
-    # Request authentication methods.
-    AUTHENTICATION = [:basic_auth, :digest_auth]
-
-    # Accepts a Hash of +options+ which may contain any number of ACCESSORS and/or
-    # AUTHENTICATION credentials to set.
-    def initialize(options = {})
-      assign_accessors options
-      assign_authentication options
+    # Accepts a Hash of +args+ to mass assign attributes and authentication credentials.
+    def initialize(args = {})
+      if args.kind_of? String
+        self.url = args
+      elsif args.kind_of?(Hash) && !args.empty?
+        mass_assign args
+      end
     end
 
     # Sets the +url+ to access. Raises an +ArgumentError+ unless the +url+ is valid.
@@ -36,6 +36,15 @@ module HTTPI
     # Returns the +proxy+ to use.
     attr_reader :proxy
 
+    # Returns whether to use SSL.
+    def ssl?
+      return @ssl unless @ssl.nil?
+      !!(url.to_s =~ /^https/)
+    end
+
+    # Sets whether to use SSL.
+    attr_writer :ssl
+
     # Returns a Hash of HTTP headers. Defaults to return an empty Hash.
     def headers
       @headers ||= {}
@@ -49,55 +58,30 @@ module HTTPI
       headers["Accept-Encoding"] = "gzip,deflate"
     end
 
-    attr_accessor :body, :open_timeout, :read_timeout, :auth_type
-
-    # Returns whether any authentication credentials were specified.
-    def auth?
-      !!auth_type
-    end
-
-    # Shortcut method for returning the credentials for the authentication specified.
-    # Return +nil+ unless any authentication credentials were specified.
-    def credentials
-      return unless auth?
-      send "#{auth_type}_auth"
-    end
+    attr_accessor :body, :open_timeout, :read_timeout
 
-    # Sets the HTTP basic auth credentials. Accepts an Array or two arguments for the
-    # +username+ and +password+. Resets the credentials when +nil+ is passed and returns
-    # an Array of credentials when no +args+ where given.
-    def basic_auth(*args)
-      self.auth_type = :basic
-      @basic_auth = extract_credentials @basic_auth, args.flatten
+    # Returns the <tt>HTTPI::Authentication</tt> object.
+    def auth
+      @auth ||= Auth::Config.new
     end
 
-    # Sets the HTTP digest auth credentials. Accepts an Array or two arguments for the
-    # +username+ and +password+. Resets the credentials when +nil+ is passed and returns
-    # an Array of credentials when no +args+ where given.
-    def digest_auth(*args)
-      self.auth_type = :digest
-      @digest_auth = extract_credentials @digest_auth, args.flatten
+    # Returns whether any authentication credentials were specified.
+    def auth?
+      !!auth.type
     end
 
- private
-
-    def assign_accessors(options)
-      ACCESSORS.each { |a| send("#{a}=", options[a]) if options[a] }
-    end
- 
-    def assign_authentication(options)
-      AUTHENTICATION.each { |c| send(c, options[c]) if options[c] }
+    # Expects a Hash of +args+ to assign.
+    def mass_assign(args)
+      ATTRIBUTES.each { |key| send("#{key}=", args[key]) if args[key] }
     end
  
+  private
+
+    # Expects a +url+, validates its validity and returns a +URI+ object.
     def normalize_url!(url)
       raise ArgumentError, "Invalid URL: #{url}" unless url.to_s =~ /^http/
       url.kind_of?(URI) ? url : URI(url)
     end
 
-    def extract_credentials(credentials, args)
-      return unless args.empty? || args.first
-      args[1] ? args[0, 2] : credentials
-    end
-
   end
 end

data/lib/httpi/version.rb

@@ -1,5 +1,5 @@
 module HTTPI
 
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 
 end

data/spec/fixtures/client_cert.pem

@@ -0,0 +1,16 @@
+-----BEGIN CERTIFICATE-----
+MIICbTCCAdYCCQDC4v8d04615DANBgkqhkiG9w0BAQUFADB7MQswCQYDVQQGEwJE
+RTEQMA4GA1UECBMHSGFtYnVyZzEQMA4GA1UEBxMHSGFtYnVyZzEOMAwGA1UEChMF
+aHR0cGkxFDASBgNVBAMTC2V4YW1wbGUuY29tMSIwIAYJKoZIhvcNAQkBFhNleGFt
+cGxlQGV4YW1wbGUuY29tMB4XDTEwMTAxNTE4NTg0N1oXDTExMTAxNTE4NTg0N1ow
+ezELMAkGA1UEBhMCREUxEDAOBgNVBAgTB0hhbWJ1cmcxEDAOBgNVBAcTB0hhbWJ1
+cmcxDjAMBgNVBAoTBWh0dHBpMRQwEgYDVQQDEwtleGFtcGxlLmNvbTEiMCAGCSqG
+SIb3DQEJARYTZXhhbXBsZUBleGFtcGxlLmNvbTCBnzANBgkqhkiG9w0BAQEFAAOB
+jQAwgYkCgYEAvJiaojIFQAbFczXkBmjxpxra9LbQm0VIESFSl8uBSjmG/gmCBwKg
+8O94P3tAjDNClC+fEqBLE37KH4qe76yw7upgRruP5jQzUEL1yCaVtA/DoqgaCxZy
+7VhB2A3f71Zw6kQPt3BOME68fnGsTX65x9XAawCGzGmJSk/Z6wvml1MCAwEAATAN
+BgkqhkiG9w0BAQUFAAOBgQCxOyni9LOKf17vUKVG8Y4TBzRYwm8/hlEdVEU3JKG0
+/aCCwIJLHl+z+3L4r81IN3+YKrHilqx9K0emboJbBRQklYsv/AE+J44Bq3llRiro
+0e5zwH61jb1j+kxhcxoGiiy8R7hYho24ljuMgFGqtK3kZSP/t9tBLLVp+ItWQ6xX
+5g==
+-----END CERTIFICATE-----

data/spec/fixtures/client_key.pem

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXQIBAAKBgQC8mJqiMgVABsVzNeQGaPGnGtr0ttCbRUgRIVKXy4FKOYb+CYIH
+AqDw73g/e0CMM0KUL58SoEsTfsofip7vrLDu6mBGu4/mNDNQQvXIJpW0D8OiqBoL
+FnLtWEHYDd/vVnDqRA+3cE4wTrx+caxNfrnH1cBrAIbMaYlKT9nrC+aXUwIDAQAB
+AoGBAKjrGh1KJg+pwPInA5yGJGMil5h1obRgwmKtcPeKi7u6eOFSDMdQoGwMYKyj
+LTYlt21Yleat8XB9sHW9yAstpq5dU8Id2A4wfbJeaBYpek7u5+QwBENO4UrnulTk
+W0d+jECBVYECn8wCStxfoFcQQRhlGrsOn05379cD8e1odMOJAkEA3o/7CsgXqahG
+7L1HaWYtKnpFfTS+EQgdGvSahOolByAKTtMA2TUBU1FdlCk+ggWBGorqmWON5Qnm
+7UDHjOasZQJBANjuPOqa9ubqHccGwHec+72pQz6q5e8f1gf1XPn7EEuXsBzYiMMH
+qEa8zpfF0TmhQ0oWN75Cq709gfVVBfx/bVcCQHan1HN/Ef6FlKqKjxQGQXYwEfQa
+tmpmJP5GAktyeaM+1cAIhp9GvxooeveOtaCkRpxcC48ToIbHrLI4oyrfoHECQQC6
+bAHtmz6TMp5ka2j7Yez1EIC5WiQ/WxyTukgsi5V1YOX35B2jfPEf2SGxTE6BOBSb
+lnxRBPqRpkoIiwiZ9OgBAkBOWKBuHXmXM6wr+0p4KQ/DOeStZiBxUT8rYbX/i1BI
+/9Xo48KNerTx7qoDK+jIslDrilahvcwUz0fuVV7rHy/X
+-----END RSA PRIVATE KEY-----

data/spec/httpi/adapter/curb_spec.rb

@@ -24,8 +24,7 @@ describe HTTPI::Adapter::Curb do
     end
 
     it "should return a valid HTTPI::Response" do
-      request = HTTPI::Request.new :url => "http://example.com"
-      adapter.get(request).should match_response(:body => Fixture.xml)
+      adapter.get(basic_request).should match_response(:body => Fixture.xml)
     end
   end
 
@@ -38,8 +37,7 @@ describe HTTPI::Adapter::Curb do
     end
 
     it "should return a valid HTTPI::Response" do
-      request = HTTPI::Request.new :url => "http://example.com"
-      adapter.post(request).should match_response(:body => Fixture.xml)
+      adapter.post(basic_request).should match_response(:body => Fixture.xml)
     end
   end
 
@@ -52,8 +50,7 @@ describe HTTPI::Adapter::Curb do
     end
 
     it "should return a valid HTTPI::Response" do
-      request = HTTPI::Request.new :url => "http://example.com"
-      adapter.head(request).should match_response(:body => Fixture.xml)
+      adapter.head(basic_request).should match_response(:body => Fixture.xml)
     end
   end
 
@@ -66,8 +63,7 @@ describe HTTPI::Adapter::Curb do
     end
 
     it "should return a valid HTTPI::Response" do
-      request = HTTPI::Request.new :url => "http://example.com"
-      adapter.put(request).should match_response(:body => Fixture.xml)
+      adapter.put(basic_request).should match_response(:body => Fixture.xml)
     end
   end
 
@@ -80,9 +76,139 @@ describe HTTPI::Adapter::Curb do
     end
 
     it "should return a valid HTTPI::Response" do
-      request = HTTPI::Request.new :url => "http://example.com"
-      adapter.delete(request).should match_response(:body => "")
+      adapter.delete(basic_request).should match_response(:body => "")
     end
   end
 
+  describe "settings:" do
+    before { curb.stubs(:http_get) }
+
+    describe "url" do
+      it "should always set the request url" do
+        curb.expects(:url=).with(basic_request.url.to_s)
+        adapter.get(basic_request)
+      end
+    end
+
+    describe "proxy_url" do
+      it "should not be set if not specified" do
+        curb.expects(:proxy_url=).never
+        adapter.get(basic_request)
+      end
+
+      it "should be set if specified" do
+        request = basic_request { |request| request.proxy = "http://proxy.example.com" }
+        
+        curb.expects(:proxy_url=).with(request.proxy.to_s)
+        adapter.get(request)
+      end
+    end
+
+    describe "timeout" do
+      it "should not be set if not specified" do
+        curb.expects(:timeout=).never
+        adapter.get(basic_request)
+      end
+
+      it "should be set if specified" do
+        request = basic_request { |request| request.read_timeout = 30 }
+
+        curb.expects(:timeout=).with(30)
+        adapter.get(request)
+      end
+    end
+
+    describe "connect_timeout" do
+      it "should not be set if not specified" do
+        curb.expects(:connect_timeout=).never
+        adapter.get(basic_request)
+      end
+
+      it "should be set if specified" do
+        request = basic_request { |request| request.open_timeout = 30 }
+
+        curb.expects(:connect_timeout=).with(30)
+        adapter.get(request)
+      end
+    end
+
+    describe "headers" do
+      it "should always be set" do
+        curb.expects(:headers=).with({})
+        adapter.get(basic_request)
+      end
+    end
+
+    describe "verbose" do
+      it "should always be set to false" do
+        curb.expects(:verbose=).with(false)
+        adapter.get(basic_request)
+      end
+    end
+
+    describe "http_auth_types" do
+      it "should be set to :basic for HTTP basic auth" do
+        request = basic_request { |request| request.auth.basic "username", "password" }
+        
+        curb.expects(:http_auth_types=).with(:basic)
+        adapter.get(request)
+      end
+
+      it "should be set to :digest for HTTP digest auth" do
+        request = basic_request { |request| request.auth.digest "username", "password" }
+        
+        curb.expects(:http_auth_types=).with(:digest)
+        adapter.get(request)
+      end
+    end
+
+    describe "username and password" do
+      it "should be set for HTTP basic auth" do
+        request = basic_request { |request| request.auth.basic "username", "password" }
+        
+        curb.expects(:username=).with("username")
+        curb.expects(:password=).with("password")
+        adapter.get(request)
+      end
+
+      it "should be set for HTTP digest auth" do
+        request = basic_request { |request| request.auth.digest "username", "password" }
+        
+        curb.expects(:username=).with("username")
+        curb.expects(:password=).with("password")
+        adapter.get(request)
+      end
+    end
+
+    context "(for SSL client auth)" do
+      let(:ssl_auth_request) do
+        basic_request do |request|
+          request.auth.ssl.cert_key_file = "spec/fixtures/client_key.pem"
+          request.auth.ssl.cert_file = "spec/fixtures/client_cert.pem"
+        end
+      end
+
+      it "cert_key, cert and ssl_verify_peer should be set" do
+        curb.expects(:cert_key=).with(ssl_auth_request.auth.ssl.cert_key_file)
+        curb.expects(:cert=).with(ssl_auth_request.auth.ssl.cert_file)
+        curb.expects(:ssl_verify_peer=).with(true)
+        
+        adapter.get(ssl_auth_request)
+      end
+
+      it "should set the cacert if specified" do
+        ssl_auth_request.auth.ssl.ca_cert_file = "spec/fixtures/client_cert.pem"
+        curb.expects(:cacert=).with(ssl_auth_request.auth.ssl.ca_cert_file)
+        
+        adapter.get(ssl_auth_request)
+      end
+    end
+  end
+
+  def basic_request
+    request = HTTPI::Request.new :url => "http://example.com"
+    yield request if block_given?
+    request
+  end
+
 end

data/spec/httpi/adapter/httpclient_spec.rb

@@ -7,6 +7,7 @@ require "httpclient"
 describe HTTPI::Adapter::HTTPClient do
   let(:adapter) { HTTPI::Adapter::HTTPClient.new }
   let(:httpclient) { HTTPClient.any_instance }
+  let(:ssl_config) { HTTPClient::SSLConfig.any_instance }
 
   describe ".new" do
     it "should require the HTTPClient gem" do
@@ -16,63 +17,128 @@ describe HTTPI::Adapter::HTTPClient do
   end
 
   describe "#get" do
-    before do
-      @request = HTTPI::Request.new :url => "http://example.com"
-      response = HTTP::Message.new_response Fixture.xml
-      httpclient.expects(:get).with(@request.url, nil, @request.headers).returns(response)
-    end
-
     it "should return a valid HTTPI::Response" do
-      adapter.get(@request).should match_response(:body => Fixture.xml)
+      httpclient.expects(:get).with(basic_request.url, nil, basic_request.headers).returns(http_message)
+      adapter.get(basic_request).should match_response(:body => Fixture.xml)
     end
   end
 
   describe "#post" do
-    before do
-      @request = HTTPI::Request.new :url => "http://example.com", :body => Fixture.xml
-      response = HTTP::Message.new_response Fixture.xml
-      httpclient.expects(:post).with(@request.url, @request.body, @request.headers).returns(response)
-    end
-
     it "should return a valid HTTPI::Response" do
-      adapter.post(@request).should match_response(:body => Fixture.xml)
+      request = HTTPI::Request.new :url => "http://example.com", :body => Fixture.xml
+      httpclient.expects(:post).with(request.url, request.body, request.headers).returns(http_message)
+      
+      adapter.post(request).should match_response(:body => Fixture.xml)
     end
   end
 
   describe "#head" do
-    before do
-      @request = HTTPI::Request.new :url => "http://example.com"
-      response = HTTP::Message.new_response Fixture.xml
-      httpclient.expects(:head).with(@request.url, nil, @request.headers).returns(response)
-    end
-
     it "should return a valid HTTPI::Response" do
-      adapter.head(@request).should match_response(:body => Fixture.xml)
+      httpclient.expects(:head).with(basic_request.url, nil, basic_request.headers).returns(http_message)
+      adapter.head(basic_request).should match_response(:body => Fixture.xml)
     end
   end
 
   describe "#put" do
-    before do
-      @request = HTTPI::Request.new :url => "http://example.com", :body => Fixture.xml
-      response = HTTP::Message.new_response Fixture.xml
-      httpclient.expects(:put).with(@request.url, @request.body, @request.headers).returns(response)
+    it "should return a valid HTTPI::Response" do
+      request = HTTPI::Request.new :url => "http://example.com", :body => Fixture.xml
+      httpclient.expects(:put).with(request.url, request.body, request.headers).returns(http_message)
+      
+      adapter.put(request).should match_response(:body => Fixture.xml)
     end
+  end
 
+  describe "#delete" do
     it "should return a valid HTTPI::Response" do
-      adapter.put(@request).should match_response(:body => Fixture.xml)
+      httpclient.expects(:delete).with(basic_request.url, basic_request.headers).returns(http_message(""))
+      adapter.delete(basic_request).should match_response(:body => "")
     end
   end
 
-  describe "#delete" do
-    before do
-      @request = HTTPI::Request.new :url => "http://example.com"
-      response = HTTP::Message.new_response "" 
-      httpclient.expects(:delete).with(@request.url, @request.headers).returns(response)
+  describe "settings:" do
+    before { httpclient.stubs(:get).returns(http_message) }
+
+    describe "proxy" do
+      it "should have specs"
     end
 
-    it "should return a valid HTTPI::Response" do
-      adapter.delete(@request).should match_response(:body => "")
+    describe "connect_timeout" do
+      it "should not be set if not specified" do
+        httpclient.expects(:connect_timeout=).never
+        adapter.get(basic_request)
+      end
+
+      it "should be set if specified" do
+        request = basic_request { |request| request.open_timeout = 30 }
+
+        httpclient.expects(:connect_timeout=).with(30)
+        adapter.get(request)
+      end
     end
+
+    describe "receive_timeout" do
+      it "should not be set if not specified" do
+        httpclient.expects(:receive_timeout=).never
+        adapter.get(basic_request)
+      end
+
+      it "should be set if specified" do
+        request = basic_request { |request| request.read_timeout = 30 }
+
+        httpclient.expects(:receive_timeout=).with(30)
+        adapter.get(request)
+      end
+    end
+
+    describe "set_auth" do
+      it "should be set for HTTP basic auth" do
+        request = basic_request { |request| request.auth.basic "username", "password" }
+
+        httpclient.expects(:set_auth).with(request.url, *request.auth.credentials)
+        adapter.get(request)
+      end
+
+      it "should be set for HTTP digest auth" do
+        request = basic_request { |request| request.auth.digest "username", "password" }
+
+        httpclient.expects(:set_auth).with(request.url, *request.auth.credentials)
+        adapter.get(request)
+      end
+    end
+
+    context "(for SSL client auth)" do
+      let(:ssl_auth_request) do
+        basic_request do |request|
+          request.auth.ssl.cert_key_file = "spec/fixtures/client_key.pem"
+          request.auth.ssl.cert_file = "spec/fixtures/client_cert.pem"
+        end
+      end
+
+      it "client_cert, client_key and verify_mode should be set" do
+        ssl_config.expects(:client_cert=).with(ssl_auth_request.auth.ssl.cert)
+        ssl_config.expects(:client_key=).with(ssl_auth_request.auth.ssl.cert_key)
+        ssl_config.expects(:verify_mode=).with(ssl_auth_request.auth.ssl.openssl_verify_mode)
+        
+        adapter.get(ssl_auth_request)
+      end
+
+      it "should set the client_ca if specified" do
+        ssl_auth_request.auth.ssl.ca_cert_file = "spec/fixtures/client_cert.pem"
+        ssl_config.expects(:client_ca=).with(ssl_auth_request.auth.ssl.ca_cert)
+        
+        adapter.get(ssl_auth_request)
+      end
+    end
+  end
+
+  def http_message(body = Fixture.xml)
+    HTTP::Message.new_response body
+  end
+
+  def basic_request
+    request = HTTPI::Request.new "http://example.com"
+    yield request if block_given?
+    request
   end
 
 end