rc-rest 2.2.1 → 3.0.0

data/History.txt

@@ -1,3 +1,8 @@
+= 3.0.0
+
+* Upgrade to Nokogiri from REXML.  This is incompatible with 2.x and older.
+  Thanks Aaron Patterson!
+
 = 2.2.1
 
 * Turn IOError into RCRest::CommunicationError for #post and #post_multipart.

data/README.txt

@@ -1,16 +1,12 @@
 = rc-rest
 
-Rubyforge Project:
+* http://seattlerb.rubyforge.org/rc-rest
+* http://rubyforge.org/projects/rctools/
 
-http://rubyforge.org/projects/rctools/
+== DESCRIPTION:
 
-Documentation:
-
-http://dev.robotcoop.com/Libraries/rc-rest/
-
-== About
-
-This is an abstract class for creating wrappers for REST web service APIs.
+Robot Co-op REST web services base class. This library makes it easy to
+implement REST-like web services APIs.
 
 == Installing rc-rest
 
@@ -30,3 +26,7 @@ RCRest#get and RCRest#make_url now accept a method argument as the
 first parameter.  To use 2.x, pass the last component of the path to
 RCRest#get or RCRest#make_url.
 
+== Upgrading from 2.x
+
+RCRest now uses Nokogiri instead of REXML.
+

data/Rakefile

@@ -1,17 +1,12 @@
 require 'hoe'
-require './lib/rc_rest'
 
-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://seattlerb.rubyforge.org/rc-rest"
-  p.rubyforge_name = 'seattlerb'
+Hoe.plugin :seattlerb
+Hoe.spec 'rc-rest' do |p|
+  self.rubyforge_name = 'seattlerb'
+  developer 'Eric Hodel', 'drbrain@segment7.net'
 
-  p.changes = File.read('History.txt').scan(/\A(=.*?)^=/m).first.first
-
-  p.extra_deps << ['ZenTest', '>= 3.4.2']
+  extra_deps << ['nokogiri', '>= 1.3.1']
+  extra_deps << ['minitest', '~> 1.4']
 end
 
 # vim: syntax=Ruby

data/lib/rc_rest.rb

@@ -1,6 +1,6 @@
 require 'net/http'
 require 'open-uri'
-require 'rexml/document'
+require 'nokogiri'
 
 ##
 # Abstract class for implementing REST APIs.
@@ -49,7 +49,7 @@ class RCRest
   ##
   # You are using this version of RCRest
 
-  VERSION = '2.2.1'
+  VERSION = '3.0.0'
 
   ##
   # Abstract Error class.
@@ -88,8 +88,8 @@ class RCRest
   end
 
   ##
-  # Must extract and raise an error from +xml+, an REXML::Document, if any.
-  # Must return if no error could be found.
+  # Must extract and raise an error from +xml+, an Nokogiri::XML::Document, if
+  # any. Must return if no error could be found.
 
   def check_error(xml)
     raise NotImplementedError
@@ -100,7 +100,7 @@ class RCRest
 
     params.each do |k,v|
       if v.respond_to? :each and not String === v then
-        v.each { |v| expanded_params << [k, v] }
+        v.each { |s| expanded_params << [k, s] }
       else
         expanded_params << [k, v]
       end
@@ -111,27 +111,27 @@ class RCRest
 
   ##
   # Performs a GET request for method +method+ with +params+.  Calls
-  # #parse_response on the concrete class with an REXML::Document instance and
-  # returns its result.
+  # #parse_response on the concrete class with an Nokogiri::XML::Document
+  # instance and returns its result.
 
   def get(method, params = {})
     url = make_url method, params
 
     url.open do |xml|
-      res = REXML::Document.new xml.read
+      res = Nokogiri::XML(xml, nil, nil, 0)
 
       check_error res
 
       return parse_response(res)
     end
   rescue IOError, SystemCallError, SocketError, Timeout::Error,
-         REXML::ParseException => e
+         Nokogiri::XML::SyntaxError => e
     raise CommunicationError.new(e)
   rescue OpenURI::HTTPError => e
     begin
-      xml = REXML::Document.new e.io.read
+      xml = Nokogiri::XML(e.io, nil, nil, 0)
       check_error xml
-    rescue REXML::ParseException => e
+    rescue Nokogiri::XML::SyntaxError => e
     end
     new_e = CommunicationError.new e
     new_e.message << "\n\nunhandled error:\n#{xml.to_s}"
@@ -203,8 +203,8 @@ class RCRest
   end
 
   ##
-  # Must parse results from +xml+, an REXML::Document, into something sensible
-  # for the API.
+  # Must parse results from +xml+, an Nokogiri::XML::Document, into something
+  # sensible for the API.
 
   def parse_response(xml)
     raise NotImplementedError
@@ -212,8 +212,8 @@ class RCRest
 
   ##
   # Performs a POST request for method +method+ with +params+.  Calls
-  # #parse_response on the concrete class with an REXML::Document instance and
-  # returns its result.
+  # #parse_response on the concrete class with an Nokogiri::XML::Document
+  # instance and returns its result.
 
   def post(method, params = {})
     url = make_url method, params
@@ -228,16 +228,16 @@ class RCRest
       http.request req
     end
 
-    xml = REXML::Document.new res.body
+    xml = Nokogiri::XML(res.body, nil, nil, 0)
 
     check_error xml
 
     parse_response xml
   rescue SystemCallError, SocketError, Timeout::Error, IOError,
-         REXML::ParseException => e
+         Nokogiri::XML::SyntaxError => e
     raise CommunicationError.new(e)
   rescue Net::HTTPError => e
-    xml = REXML::Document.new e.res.body
+    xml = Nokogiri::XML(e.res.body) { |cfg| cfg.strict }
     check_error xml
     raise CommunicationError.new(e)
   end
@@ -245,7 +245,7 @@ class RCRest
   ##
   # Performs a POST request for method +method+ with +params+, submitting a
   # multipart form.  Calls #parse_response on the concrete class with an
-  # REXML::Document instance and returns its result.
+  # Nokogiri::XML::Document instance and returns its result.
 
   def post_multipart(method, params = {})
     url = make_url method, {}
@@ -261,16 +261,16 @@ class RCRest
       http.request req
     end
 
-    xml = REXML::Document.new res.body
+    xml = Nokogiri::XML(res.body, nil, nil, 0)
 
     check_error xml
 
     parse_response xml
   rescue SystemCallError, SocketError, Timeout::Error, IOError,
-         REXML::ParseException => e
+         Nokogiri::XML::SyntaxError => e
     raise CommunicationError.new(e)
   rescue Net::HTTPError => e
-    xml = REXML::Document.new e.res.body
+    xml = Nokogiri::XML(e.res.body, nil, nil, 0)
     check_error xml
     raise CommunicationError.new(e)
   end

data/lib/rc_rest/net_http_stub.rb

@@ -2,6 +2,9 @@ require 'net/http'
 
 class Net::HTTPResponse
 
+  undef_method :body  if method_defined? :body
+  undef_method :body= if method_defined? :body=
+
   ##
   # Setter for body content
 

data/test/test_rc_rest.rb

@@ -1,6 +1,5 @@
-require 'test/unit'
 require 'rubygems'
-require 'test/zentest_assertions'
+require 'minitest/autorun'
 require 'rc_rest/uri_stub'
 require 'rc_rest/net_http_stub'
 require 'rc_rest'
@@ -14,7 +13,7 @@ class FakeService < RCRest
   end
 
   def check_error(xml)
-    raise Error, xml.elements['error'].text if xml.elements['error']
+    raise Error, xml.at('error').text if xml.at('error')
   end
 
   def do_get
@@ -35,7 +34,7 @@ class FakeService < RCRest
 
 end
 
-class TestFakeService < Test::Unit::TestCase
+class TestFakeService < MiniTest::Unit::TestCase
 
   def setup
     URI::HTTP.responses = []
@@ -51,7 +50,7 @@ class TestFakeService < Test::Unit::TestCase
   end
 
   def test_check_error
-    xml = REXML::Document.new '<error>you broked it</error>'
+    xml = Nokogiri::XML '<error>you broked it</error>'
     @fs.check_error xml
 
   rescue FakeService::Error => e
@@ -62,7 +61,7 @@ class TestFakeService < Test::Unit::TestCase
   end
 
   def test_do_get
-    xml = '<result>stuff</result>'
+    xml = "<?xml version=\"1.0\"?>\n<result>stuff</result>\n"
     URI::HTTP.responses << xml
 
     result = @fs.do_get
@@ -75,7 +74,7 @@ class TestFakeService < Test::Unit::TestCase
     xml = '<result>stuff</result><extra/>'
     URI::HTTP.responses << xml
 
-    assert_raise RCRest::CommunicationError do @fs.do_get end
+    assert_raises RCRest::CommunicationError do @fs.do_get end
   end
 
   def test_do_get_error_400
@@ -84,7 +83,7 @@ class TestFakeService < Test::Unit::TestCase
       raise OpenURI::HTTPError.new('400 Bad Request', StringIO.new(xml))
     end
 
-    assert_raise FakeService::Error do @fs.do_get end
+    assert_raises FakeService::Error do @fs.do_get end
   end
 
   def test_do_get_error_400_bad_xml
@@ -93,25 +92,26 @@ class TestFakeService < Test::Unit::TestCase
       raise OpenURI::HTTPError.new('400 Bad Request', StringIO.new(xml))
     end
 
-    assert_raise RCRest::CommunicationError do @fs.do_get end
+    assert_raises 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>'
+      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))
     end
 
-    e = assert_raise RCRest::CommunicationError do @fs.do_get end
+    e = assert_raises RCRest::CommunicationError do @fs.do_get end
 
     expected = <<-EOF.strip
 Communication error: 500 Internal Server Error(OpenURI::HTTPError)
 
 unhandled error:
+<?xml version=\"1.0\"?>
 <other_error>you did the bad thing</other_error>
     EOF
 
-    assert_equal expected, e.message
+    assert_equal expected, e.message.strip
   end
 
   def test_do_get_eof_error
@@ -120,11 +120,11 @@ unhandled error:
       raise EOFError, 'end of file reached'
     end
 
-    assert_raise RCRest::CommunicationError do @fs.do_get end
+    assert_raises RCRest::CommunicationError do @fs.do_get end
   end
 
   def test_do_post
-    xml = '<result>stuff</result>'
+    xml = "<?xml version=\"1.0\"?>\n<result>stuff</result>\n"
     Net::HTTP.responses << xml
 
     result = @fs.do_post
@@ -143,7 +143,7 @@ unhandled error:
     xml = '<result>stuff</result><extra/>'
     Net::HTTP.responses << xml
 
-    assert_raise RCRest::CommunicationError do @fs.do_post end
+    assert_raises RCRest::CommunicationError do @fs.do_post end
   end
 
   def test_do_post_eof_error
@@ -151,11 +151,11 @@ unhandled error:
       raise IOError, 'end of file reached'
     end
 
-    assert_raise RCRest::CommunicationError do @fs.do_post end
+    assert_raises RCRest::CommunicationError do @fs.do_post end
   end
 
   def test_do_post_multipart
-    xml = '<result>stuff</result>'
+    xml = "<?xml version=\"1.0\"?>\n<result>stuff</result>\n"
     Net::HTTP.responses << xml
 
     result = @fs.do_post_multipart
@@ -183,22 +183,22 @@ value\r
       raise EOFError, 'end of file reached'
     end
 
-    assert_raise RCRest::CommunicationError do @fs.do_post_multipart end
+    assert_raises RCRest::CommunicationError do @fs.do_post_multipart end
   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
+    assert_raises RCRest::CommunicationError do @fs.do_post_multipart end
   end
 
 end
 
-class TestRCRest < Test::Unit::TestCase
+class TestRCRest < MiniTest::Unit::TestCase
 
   def test_initialize
-    e = assert_raise NotImplementedError do
+    e = assert_raises NotImplementedError do
       RCRest.new
     end
 
@@ -207,7 +207,7 @@ class TestRCRest < Test::Unit::TestCase
 
   def test_check_error
     r = RCRest.allocate
-    assert_raise NotImplementedError do r.check_error nil end
+    assert_raises NotImplementedError do r.check_error nil end
   end
 
   def test_make_multipart
@@ -261,7 +261,7 @@ y z\r
 
   def test_parse_response
     r = RCRest.allocate
-    assert_raise NotImplementedError do r.parse_response nil end
+    assert_raises NotImplementedError do r.parse_response nil end
   end
 
 end

metadata

@@ -1,71 +1,120 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.1
-specification_version: 1
 name: rc-rest
 version: !ruby/object:Gem::Version 
-  version: 2.2.1
-date: 2007-01-31 00:00:00 -08:00
-summary: Robot Co-op REST web services base class
-require_paths: 
-- lib
-email: drbrain@segment7.net
-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: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 3.0.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Eric Hodel
-files: 
-- History.txt
-- LICENSE.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- lib/rc_rest.rb
-- lib/rc_rest/net_http_stub.rb
-- lib/rc_rest/uri_stub.rb
-- test/test_rc_rest.rb
-test_files: 
-- test/test_rc_rest.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
+  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
+  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
+  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
+  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
+  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
+  x52qPcexcYZR7w==
+  -----END CERTIFICATE-----
 
+date: 2009-07-10 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ZenTest
+  name: nokogiri
+  type: :runtime
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.4.2
+        version: 1.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.4"
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.7
+        version: 2.3.2
     version: 
+description: |-
+  Robot Co-op REST web services base class. This library makes it easy to
+  implement REST-like web services APIs.
+email: 
+- drbrain@segment7.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/rc_rest.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
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: seattlerb
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Robot Co-op REST web services base class
+test_files: 
+- test/test_rc_rest.rb