replace raw net-http calls with faraday, and allow implementors to provide an alternate Faraday configuration

Author: cbeer

lib/oai/client.rb

@@ -1,6 +1,6 @@
 # External dependencies
 require 'uri'
-require 'net/http'
+require 'faraday'
 require 'cgi'
 require 'iconv'
 
@@ -67,6 +67,11 @@ class Client
     # back XML::Node objects
     #
     #   client = OAI::Client.new 'http://example.com', :parser => 'libxml'
+    #   
+    # You can configure the Faraday HTTP client by providing an alternate 
+    # Faraday instance:
+    #
+    #   client = OAI::Client.new 'http://example.com', :http => Faraday.new { |c| }
     #
     # === HIGH PERFORMANCE
     #
@@ -77,7 +82,18 @@ def initialize(base_url, options={})
       @base = URI.parse base_url
       @debug = options.fetch(:debug, false)
       @parser = options.fetch(:parser, 'rexml')
+
       @follow_redirects = options.fetch(:redirects, true)
+      @http_client = options.fetch(:http, Faraday.new(@base))
+
+      if !options.key?(:http) and @follow_redirects
+
+        count = @folow_redirects if @folow_redirects.is_a? Fixnum
+        count ||= 5
+
+        require 'faraday_middleware'
+        @http_client.use FaradayMiddleware::FollowRedirects, :limit => count
+      end
 
       # load appropriate parser
       case @parser
@@ -207,21 +223,8 @@ def load_document(xml)
 
     # Do the actual HTTP get, following any temporary redirects
     def get(uri)
-      response = Net::HTTP.get_response(uri)
-      case response
-      when Net::HTTPSuccess
-        return response.body
-      when Net::HTTPMovedPermanently
-        if @follow_redirects
-          response = get(URI.parse(response['location']))
-        else
-          raise ArgumentError, "Permanently Redirected to [#{response['location']}]"
-        end
-      when Net::HTTPTemporaryRedirect
-        response = get(URI.parse(response['location']))
-      else
-        raise ArgumentError, "#{response.code_type} [#{response.code}]"
-      end
+      response = @http_client.get uri
+      response.body
     end
 
     def debug(msg)

ruby-oai.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |s|
     s.executables = 'oai'
 
     s.add_dependency('builder', '>=2.0.0')
+    s.add_dependency('faraday')
+    s.add_dependency('faraday_middleware')
     s.add_development_dependency('rake')
 
     s.files = %w(README.md Rakefile) +

test/client/tc_http_client.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class HttpClientTest < Test::Unit::TestCase
+
+  def test_pluggable_http_client
+    oai_response = <<-eos
+    <Identify>
+      <repositoryName>Mock OAI Provider</repositoryName>
+      <baseURL>http://nowhere.example.com</baseURL> 
+    </Identify>
+eos
+
+    faraday_stub = Faraday.new do |builder|
+      builder.adapter :test do |stub|
+        stub.get('/oai?verb=Identify') { [200, {}, oai_response] }
+      end
+    end
+    client = OAI::Client.new 'http://localhost:3333/oai', :http => faraday_stub
+    response = client.identify
+
+    assert_kind_of OAI::IdentifyResponse, response
+    assert_equal 'Mock OAI Provider [http://nowhere.example.com]', response.to_s
+    
+  end
+end
+