rc-rest 2.1.0 → 2.2.0

data/History.txt

@@ -1,3 +1,13 @@
+= 2.2.0
+
+* Moved to seattlerb rubyforge project
+* Moved to p4
+* Wrap communication errors in RCRest::CommunicationError
+
+= 2.1.1
+
+* Fix dependency on ZenTest for testing
+
 = 2.1.0
 
 * Don't split strings into extra params pairs on newlines
@@ -7,8 +17,8 @@
 = 2.0.0
 
 * Added +method+ parameter to RCRest#make_url to add path components
-  to a generic endpoint.
-* Added RCRest#post.
+  to a generic endpoint
+* Added RCRest#post
 
 = 1.0.0
 

data/Rakefile

@@ -1,24 +1,17 @@
 require 'hoe'
 require './lib/rc_rest'
 
-DEV_DOC_PATH = 'Libraries/rc-rest'
-
-hoe = Hoe.new 'rc-rest', RCRest::VERSION do |p|
+Hoe.new 'rc-rest', RCRest::VERSION do |p|
   p.summary = 'Robot Co-op REST web services base class'
   p.description = 'This library makes it easy to implement REST-like web services APIs.'
   p.author = 'Eric Hodel'
   p.email = 'drbrain@segment7.net'
-  p.url = "http://dev.robotcoop.com/#{DEV_DOC_PATH}"
-  p.rubyforge_name = 'rctools'
+  p.url = "http://seattlerb.rubyforge.org/rc-rest"
+  p.rubyforge_name = 'seattlerb'
 
   p.changes = File.read('History.txt').scan(/\A(=.*?)^=/m).first.first
-end
-
-SPEC = hoe.spec
 
-begin
-  require '../tasks'
-rescue LoadError
+  p.extra_deps << ['ZenTest', '>= 3.4.2']
 end
 
 # vim: syntax=Ruby

data/lib/rc_rest.rb

@@ -49,13 +49,34 @@ class RCRest
   ##
   # You are using this version of RCRest
 
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 
   ##
   # Abstract Error class.
 
   class Error < RuntimeError; end
 
+  ##
+  # Error raised when communicating with the server
+
+  class CommunicationError < Error
+
+    ##
+    # The original exception
+
+    attr_accessor :original_exception
+
+    ##
+    # Creates a new CommunicationError with +message+ and +original_exception+
+
+    def initialize(original_exception)
+      @original_exception = original_exception
+      message = "Communication error: #{original_exception.message}(#{original_exception.class})"
+      super message
+    end
+
+  end
+
   ##
   # Web services initializer.
   #
@@ -103,10 +124,18 @@ class RCRest
 
       return parse_response(res)
     end
+  rescue IOError, SystemCallError, SocketError, Timeout::Error,
+         REXML::ParseException => e
+    raise CommunicationError.new(e)
   rescue OpenURI::HTTPError => e
-    xml = REXML::Document.new e.io.read
-    check_error xml
-    raise
+    begin
+      xml = REXML::Document.new e.io.read
+      check_error xml
+    rescue REXML::ParseException => e
+    end
+    new_e = CommunicationError.new e
+    new_e.message << "\n\nunhandled error:\n#{xml.to_s}"
+    raise new_e
   end
 
   ##
@@ -202,12 +231,15 @@ class RCRest
     xml = REXML::Document.new res.body
 
     check_error xml
-    
-    return parse_response(xml)
+
+    parse_response xml
+  rescue SystemCallError, SocketError, Timeout::Error,
+         REXML::ParseException => e
+    raise CommunicationError.new(e)
   rescue Net::HTTPError => e
     xml = REXML::Document.new e.res.body
     check_error xml
-    raise
+    raise CommunicationError.new(e)
   end
 
   ##
@@ -232,12 +264,15 @@ class RCRest
     xml = REXML::Document.new res.body
 
     check_error xml
-    
-    return parse_response(xml)
+
+    parse_response xml
+  rescue SystemCallError, SocketError, Timeout::Error,
+         REXML::ParseException => e
+    raise CommunicationError.new(e)
   rescue Net::HTTPError => e
     xml = REXML::Document.new e.res.body
     check_error xml
-    raise
+    raise CommunicationError.new(e)
   end
 
 end

data/lib/rc_rest/net_http_stub.rb

@@ -51,9 +51,14 @@ class Net::HTTP
   def request(req)
     self.class.paths << req.path
     self.class.params << req.body
-    res = Net::HTTPResponse.new '1.0', 200, 'OK'
-    res.body = self.class.responses.shift
-    res
+    response = self.class.responses.shift
+    if response.respond_to? :call then
+      response.call req
+    else
+      res = Net::HTTPResponse.new '1.0', 200, 'OK'
+      res.body = response
+      res
+    end
   end
 
 end

data/lib/rc_rest/uri_stub.rb

@@ -44,7 +44,12 @@ class URI::HTTP # :nodoc:
 
   def open
     self.class.uris << self.to_s
-    yield StringIO.new(self.class.responses.shift)
+    response = self.class.responses.shift
+    if response.respond_to? :call then
+      response.call
+    else
+      yield StringIO.new(response)
+    end
   end
 
 end

data/test/test_rc_rest.rb

@@ -71,19 +71,58 @@ class TestFakeService < Test::Unit::TestCase
     assert_equal 'http://example.com/method?', URI::HTTP.uris.first
   end
 
-  def test_do_get_error
-    def @fs.make_url(*args) # HACK extend uri_stub with error raising ability
-      u = Object.new
-      def u.open
-        xml = '<error>you did the bad thing</error>'
-        raise OpenURI::HTTPError.new('400 Bad Request', StringIO.new(xml))
-      end
-      return u
+  def test_do_get_bad_xml
+    xml = '<result>stuff</result><extra/>'
+    URI::HTTP.responses << xml
+
+    assert_raise 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))
     end
 
     assert_raise 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))
+    end
+
+    assert_raise RCRest::CommunicationError do @fs.do_get end
+  end
+
+  def test_do_get_error_unhandled
+    URI::HTTP.responses << proc do
+      xml = '<other_error>you did the bad thing</other_error>'
+      raise OpenURI::HTTPError.new('500 Internal Server Error', StringIO.new(xml))
+    end
+
+    e = assert_raise RCRest::CommunicationError do @fs.do_get end
+
+    expected = <<-EOF.strip
+Communication error: 500 Internal Server Error(OpenURI::HTTPError)
+
+unhandled error:
+<other_error>you did the bad thing</other_error>
+    EOF
+
+    assert_equal expected, e.message
+  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'
+    end
+
+    assert_raise RCRest::CommunicationError do @fs.do_get end
+  end
+
   def test_do_post
     xml = '<result>stuff</result>'
     Net::HTTP.responses << xml
@@ -100,6 +139,13 @@ class TestFakeService < Test::Unit::TestCase
     assert_equal '/method', Net::HTTP.paths.first
   end
 
+  def test_do_post_bad_xml
+    xml = '<result>stuff</result><extra/>'
+    Net::HTTP.responses << xml
+
+    assert_raise RCRest::CommunicationError do @fs.do_post end
+  end
+
   def test_do_post_multipart
     xml = '<result>stuff</result>'
     Net::HTTP.responses << xml
@@ -124,16 +170,23 @@ value\r
     assert_equal '/method', Net::HTTP.paths.first
   end
 
+  def test_do_post_multipart_bad_xml
+    xml = '<result>stuff</result><extra/>'
+    Net::HTTP.responses << xml
+
+    assert_raise RCRest::CommunicationError do @fs.do_post_multipart end
+  end
+
 end
 
 class TestRCRest < Test::Unit::TestCase
 
   def test_initialize
-    RCRest.new
-  rescue NotImplementedError => e
+    e = assert_raise NotImplementedError do
+      RCRest.new
+    end
+
     assert_equal 'need to implement #intialize and set @url', e.message
-  else
-    flunk 'expected NotImplementedError'
   end
 
   def test_check_error

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0.7
+rubygems_version: 0.9.1
 specification_version: 1
 name: rc-rest
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
-date: 2006-11-29 00:00:00 -08:00
+  version: 2.2.0
+date: 2007-01-29 00:00:00 -08:00
 summary: Robot Co-op REST web services base class
 require_paths: 
 - lib
 email: drbrain@segment7.net
-homepage: http://dev.robotcoop.com/Libraries/rc-rest
-rubyforge_project: rctools
+homepage: http://seattlerb.rubyforge.org/rc-rest
+rubyforge_project: seattlerb
 description: This library makes it easy to implement REST-like web services APIs.
 autorequire: 
 default_executable: 
@@ -51,6 +51,15 @@ extensions: []
 requirements: []
 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.4.2
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   version_requirement: 
@@ -58,5 +67,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.5
+        version: 1.1.7
     version: