rc-rest 3.0.1 → 4.0

data/.autotest

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/unit'
+end
+

data/History.txt

@@ -1,3 +1,9 @@
+== 4.0
+
+* rc-rest now depends on Net::HTTP::Persistent.
+* URI::HTTP stubs no longer work.  Use rc_rest/net_http_persistent_stub
+  instead.  See Net::HTTP::Persistent for details.
+
 == 3.0.1
 
 * Fix minitest dependency

data/Manifest.txt

@@ -1,9 +1,10 @@
+.autotest
 History.txt
 LICENSE.txt
 Manifest.txt
 README.txt
 Rakefile
 lib/rc_rest.rb
+lib/rc_rest/net_http_persistent_stub.rb
 lib/rc_rest/net_http_stub.rb
-lib/rc_rest/uri_stub.rb
 test/test_rc_rest.rb

data/Rakefile

@@ -1,11 +1,13 @@
 require 'hoe'
 
 Hoe.plugin :seattlerb
+
 Hoe.spec 'rc-rest' do |p|
   self.rubyforge_name = 'seattlerb'
   developer 'Eric Hodel', 'drbrain@segment7.net'
 
-  extra_deps << ['nokogiri', '>= 1.3.1']
+  extra_deps << ['nokogiri',            '>= 1.3.1']
+  extra_deps << ['net-http-persistent', '~> 1.0']
 end
 
 # vim: syntax=Ruby

data/lib/rc_rest.rb

@@ -1,5 +1,4 @@
-require 'net/http'
-require 'open-uri'
+require 'net/http/persistent'
 require 'nokogiri'
 
 ##
@@ -49,7 +48,7 @@ class RCRest
   ##
   # You are using this version of RCRest
 
-  VERSION = '3.0.1'
+  VERSION = '4.0'
 
   ##
   # Abstract Error class.
@@ -71,6 +70,7 @@ class RCRest
 
     def initialize(original_exception)
       @original_exception = original_exception
+
       message = "Communication error: #{original_exception.message}(#{original_exception.class})"
       super message
     end
@@ -115,27 +115,39 @@ class RCRest
   # instance and returns its result.
 
   def get(method, params = {})
+    @http ||= Net::HTTP::Persistent.new
+
     url = make_url method, params
 
-    url.open do |xml|
-      res = Nokogiri::XML(xml, nil, nil, 0)
+    http_response = @http.request url
+
+    case http_response
+    when Net::HTTPSuccess
+      res = Nokogiri::XML http_response.body, nil, nil, 0
 
       check_error res
 
-      return parse_response(res)
+      parse_response res
+    when Net::HTTPMovedPermanently,
+         Net::HTTPFound,
+         Net::HTTPSeeOther,
+         Net::HTTPTemporaryRedirect then
+      # TODO
+    else
+      begin
+        xml = Nokogiri::XML http_response.body, nil, nil, 0
+        check_error xml
+      rescue Nokogiri::XML::SyntaxError => e
+      end
+
+      e = CommunicationError.new http_response
+      e.message << "\n\nunhandled error:\n#{xml.to_s}"
+
+      raise e
     end
-  rescue IOError, SystemCallError, SocketError, Timeout::Error,
+  rescue Net::HTTP::Persistent::Error, SocketError, Timeout::Error,
          Nokogiri::XML::SyntaxError => e
     raise CommunicationError.new(e)
-  rescue OpenURI::HTTPError => e
-    begin
-      xml = Nokogiri::XML(e.io, nil, nil, 0)
-      check_error xml
-    rescue Nokogiri::XML::SyntaxError => e
-    end
-    new_e = CommunicationError.new e
-    new_e.message << "\n\nunhandled error:\n#{xml.to_s}"
-    raise new_e
   end
 
   ##

data/lib/rc_rest/net_http_persistent_stub.rb

@@ -0,0 +1,74 @@
+require 'net/http/persistent'
+
+##
+# This stub overrides Net::HTTP::Persistent's request method to allow programs
+# that use Net::HTTP::Persistent to be easily tested.
+#
+# == Usage
+#
+#   require 'rc_rest/net_http_persistent_stub'
+#
+#   class TestMyClass < MiniTest::Unit::TestCase
+#
+#     def setup
+#       Net::HTTP::Persistent.responses = []
+#       Net::HTTP::Persistent.uris = []
+#
+#       @obj = MyClass.new
+#     end
+#
+#     def test_my_method
+#       Net::HTTP::Persistent.responses << 'some text request would return'
+#
+#       result = @obj.my_method
+#
+#       assert_equal :something_meaninfgul, result
+#
+#       assert_equal true, Net::HTTP::Persistent.responses.empty?
+#       assert_equal 1, Net::HTTP::Persistent.uris.length
+#       assert_equal 'http://example.com/path', Net::HTTP::Persistent.uris.first
+#     end
+#
+#  end
+
+class Net::HTTP::Persistent
+
+  class << self
+
+    ##
+    # List of responses #request should return.
+    #
+    # If a String is given a Net::HTTPOK is created
+    #
+    # If a proc is given, it is called.  The proc should raise an exception or
+    # return a Net::HTTPResponse subclass.
+    #
+    # Unlike URI::HTTP from rc-rest 3.x and earlier you must return a
+    # Net::HTTPResponse subclass.
+
+    attr_accessor :responses
+
+    ##
+    # URIs recorded
+
+    attr_accessor :uris
+
+  end
+
+  alias original_request request
+
+  def request uri
+    self.class.uris << uri.to_s
+    response = self.class.responses.shift
+
+    response = response.call if response.respond_to? :call
+
+    return response if Net::HTTPResponse === response
+
+    r = Net::HTTPOK.new '1.0', 200, 'OK'
+    r.body = response
+    r
+  end
+
+end
+

data/test/test_rc_rest.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'minitest/autorun'
-require 'rc_rest/uri_stub'
+require 'rc_rest/net_http_persistent_stub'
 require 'rc_rest/net_http_stub'
 require 'rc_rest'
 
@@ -37,8 +37,8 @@ end
 class TestFakeService < MiniTest::Unit::TestCase
 
   def setup
-    URI::HTTP.responses = []
-    URI::HTTP.uris = []
+    Net::HTTP::Persistent.responses = []
+    Net::HTTP::Persistent.uris = []
 
     Net::HTTP.params = []
     Net::HTTP.paths = []
@@ -62,49 +62,53 @@ class TestFakeService < MiniTest::Unit::TestCase
 
   def test_do_get
     xml = "<?xml version=\"1.0\"?>\n<result>stuff</result>\n"
-    URI::HTTP.responses << xml
+    Net::HTTP::Persistent.responses << xml
 
     result = @fs.do_get
 
     assert_equal xml, result.to_s
-    assert_equal 'http://example.com/method?', URI::HTTP.uris.first
+    assert_equal 'http://example.com/method?', Net::HTTP::Persistent.uris.first
   end
 
   def test_do_get_bad_xml
     xml = '<result>stuff</result><extra/>'
-    URI::HTTP.responses << xml
+    Net::HTTP::Persistent.responses << xml
 
     assert_raises RCRest::CommunicationError do @fs.do_get end
   end
 
   def test_do_get_error_400
-    URI::HTTP.responses << proc do
-      xml = '<error>you did the bad thing</error>'
-      raise OpenURI::HTTPError.new('400 Bad Request', StringIO.new(xml))
+    Net::HTTP::Persistent.responses << proc do
+      r = Net::HTTPBadRequest.new '1.0', 400, 'Bad Request'
+      r.body = '<error>you did the bad thing</error>'
+      r
     end
 
     assert_raises FakeService::Error do @fs.do_get end
   end
 
   def test_do_get_error_400_bad_xml
-    URI::HTTP.responses << proc do
-      xml = '<error>you did the bad thing</error><extra/>'
-      raise OpenURI::HTTPError.new('400 Bad Request', StringIO.new(xml))
+    Net::HTTP::Persistent.responses << proc do
+      r = Net::HTTPBadRequest.new '1.0', 400, 'Bad Request'
+      r.body = '<error>you did the bad thing</error><extra/>'
+      r
     end
 
     assert_raises RCRest::CommunicationError do @fs.do_get end
   end
 
   def test_do_get_error_unhandled
-    URI::HTTP.responses << proc do
+    Net::HTTP::Persistent.responses << proc do
       xml = "<?xml version=\"1.0\"?>\n<other_error>you did the bad thing</other_error>\n"
-      raise OpenURI::HTTPError.new('500 Internal Server Error', StringIO.new(xml))
+      r = Net::HTTPInternalServerError.new '1.0', 500, 'Internal Server Error'
+      r.body = xml
+      r
     end
 
     e = assert_raises RCRest::CommunicationError do @fs.do_get end
 
     expected = <<-EOF.strip
-Communication error: 500 Internal Server Error(OpenURI::HTTPError)
+Communication error: Internal Server Error(Net::HTTPInternalServerError)
 
 unhandled error:
 <?xml version=\"1.0\"?>
@@ -114,10 +118,9 @@ unhandled error:
     assert_equal expected, e.message.strip
   end
 
-  def test_do_get_eof_error
-    URI::HTTP.responses << proc do
-      xml = '<error>you did the bad thing</error>'
-      raise EOFError, 'end of file reached'
+  def test_do_get_net_http_persistent_error
+    Net::HTTP::Persistent.responses << proc do
+      raise Net::HTTP::Persistent::Error, 'end of file reached'
     end
 
     assert_raises RCRest::CommunicationError do @fs.do_get end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rc-rest
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
-  - 3
+  - 4
   - 0
-  - 1
-  version: 3.0.1
+  version: "4.0"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -35,16 +35,18 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2010-02-11 00:00:00 -08:00
+date: 2010-05-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
         - 1
         - 3
@@ -53,61 +55,84 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: net-http-persistent
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 2
         - 0
         - 3
         version: 2.0.3
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: gemcutter
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 0
-        - 3
+        - 5
         - 0
-        version: 0.3.0
+        version: 0.5.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: minitest
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 1
         - 5
         - 0
         version: 1.5.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 2
         - 5
         - 0
         version: 2.5.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: |-
   Robot Co-op REST web services base class. This library makes it easy to
   implement REST-like web services APIs.
@@ -123,14 +148,15 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 files: 
+- .autotest
 - History.txt
 - LICENSE.txt
 - Manifest.txt
 - README.txt
 - Rakefile
 - lib/rc_rest.rb
+- lib/rc_rest/net_http_persistent_stub.rb
 - lib/rc_rest/net_http_stub.rb
-- lib/rc_rest/uri_stub.rb
 - test/test_rc_rest.rb
 has_rdoc: true
 homepage: http://seattlerb.rubyforge.org/rc-rest
@@ -143,23 +169,27 @@ 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: seattlerb
-rubygems_version: 1.3.6.pre.2
+rubygems_version: 1.3.7.pre.1
 signing_key: 
 specification_version: 3
 summary: Robot Co-op REST web services base class

data/lib/rc_rest/uri_stub.rb

@@ -1,56 +0,0 @@
-require 'open-uri'
-
-module URI # :nodoc:
-end
-
-##
-# This stub overrides OpenURI's open method to allow programs that use OpenURI
-# to be easily tested.
-#
-# == Usage
-#
-#   require 'rc_rest/uri_stub'
-#   
-#   class TestMyClass < Test::Unit::TestCase
-#     
-#     def setup
-#       URI::HTTP.responses = []
-#       URI::HTTP.uris = []
-#       
-#       @obj = MyClass.new
-#     end
-#     
-#     def test_my_method
-#       URI::HTTP.responses << 'some text open would ordinarily return'
-#       
-#       result = @obj.my_method
-#       
-#       assert_equal :something_meaninfgul, result
-#       
-#       assert_equal true, URI::HTTP.responses.empty?
-#       assert_equal 1, URI::HTTP.uris.length
-#       assert_equal 'http://example.com/path', URI::HTTP.uris.first
-#     end
-#     
-#  end
-
-class URI::HTTP # :nodoc:
-
-  class << self
-    attr_accessor :responses, :uris
-  end
-
-  alias original_open open
-
-  def open
-    self.class.uris << self.to_s
-    response = self.class.responses.shift
-    if response.respond_to? :call then
-      response.call
-    else
-      yield StringIO.new(response)
-    end
-  end
-
-end
-