rc-rest 2.0.0 → 2.1.0

data/History.txt

@@ -1,3 +1,9 @@
+= 2.1.0
+
+* Don't split strings into extra params pairs on newlines
+* Added RCRest#post_multipart and RCRest#make_multipart
+* Fixed various query parameter incompatiblities
+
 = 2.0.0
 
 * Added +method+ parameter to RCRest#make_url to add path components

data/Rakefile

@@ -1,13 +1,13 @@
 require 'hoe'
 require './lib/rc_rest'
 
-DEV_DOC_PATH = 'Libraries/rc_rest'
+DEV_DOC_PATH = 'Libraries/rc-rest'
 
 hoe = 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 = 'eric@robotcoop.com'
+  p.email = 'drbrain@segment7.net'
   p.url = "http://dev.robotcoop.com/#{DEV_DOC_PATH}"
   p.rubyforge_name = 'rctools'
 
@@ -18,7 +18,7 @@ SPEC = hoe.spec
 
 begin
   require '../tasks'
-rescue RuntimeError
+rescue LoadError
 end
 
 # vim: syntax=Ruby

data/lib/rc_rest.rb

@@ -14,7 +14,7 @@ require 'rexml/document'
 # +parse_response+:: Extracts information from the server response.
 #
 # If you have extra URL paramaters (application id, output type) or need to
-# perform URL customization, override +make_url+.
+# perform URL customization, override +make_url+ and +make_multipart+.
 #
 #   class FakeService < RCRest
 #   
@@ -49,7 +49,7 @@ class RCRest
   ##
   # You are using this version of RCRest
 
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 
   ##
   # Abstract Error class.
@@ -74,6 +74,20 @@ class RCRest
     raise NotImplementedError
   end
 
+  def expand_params(params) # :nodoc:
+    expanded_params = []
+
+    params.each do |k,v|
+      if v.respond_to? :each and not String === v then
+        v.each { |v| expanded_params << [k, v] }
+      else
+        expanded_params << [k, v]
+      end
+    end
+
+    expanded_params.sort_by { |k,v| [k.to_s, v.to_s] }
+  end
+
   ##
   # Performs a GET request for method +method+ with +params+.  Calls
   # #parse_response on the concrete class with an REXML::Document instance and
@@ -126,27 +140,39 @@ class RCRest
   #   http://example.com/api/method?a=1
 
   def make_url(method, params = nil)
-    expanded_params = []
-
-    params.each do |k,v|
-      if v.respond_to? :each then
-        v.each { |v| expanded_params << [k, v] }
-      else
-        expanded_params << [k, v]
-      end
+    escaped_params = expand_params(params).map do |k,v|
+      k = URI.escape(k.to_s).gsub(';', '%3B').gsub('+', '%2B').gsub('&', '%26')
+      v = URI.escape(v.to_s).gsub(';', '%3B').gsub('+', '%2B').gsub('&', '%26')
+      "#{k}=#{v}"
     end
 
-    sorted_params = expanded_params.sort_by { |k,v| [k.to_s, v.to_s] }
-
-    escaped_params = sorted_params.map do |k,v|
-      "#{URI.escape k.to_s}=#{URI.escape v.to_s}"
-    end
+    query = escaped_params.join '&'
 
     url = @url + "./#{method}"
-    url.query = escaped_params.join '&'
+    url.query = query
     return url
   end
 
+  ##
+  # Creates a multipart form post for the Hash of parameters +params+.
+  # Override this then call super if you need to add extra params like an
+  # application id, output type, etc.
+  #
+  # #make_multipart handles arguments similarly to #make_url.
+
+  def make_multipart(params)
+    boundary = (0...8).map { rand(255).to_s 16 }.join '_'
+    data = expand_params(params).map do |key, value|
+      [ "--#{boundary}",
+        "Content-Disposition: form-data; name=\"#{key}\"",
+        nil,
+        value]
+    end
+
+    data << "--#{boundary}--"
+    return [boundary, data.join("\r\n")]
+  end
+
   ##
   # Must parse results from +xml+, an REXML::Document, into something sensible
   # for the API.
@@ -184,5 +210,35 @@ class RCRest
     raise
   end
 
+  ##
+  # 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.
+
+  def post_multipart(method, params = {})
+    url = make_url method, {}
+    url.query = nil
+
+    boundary, data = make_multipart params
+
+    req = Net::HTTP::Post.new url.path
+    req.content_type = "multipart/form-data; boundary=#{boundary}"
+    req.body = data
+
+    res = Net::HTTP.start url.host, url.port do |http|
+      http.request req
+    end
+
+    xml = REXML::Document.new res.body
+
+    check_error xml
+    
+    return parse_response(xml)
+  rescue Net::HTTPError => e
+    xml = REXML::Document.new e.res.body
+    check_error xml
+    raise
+  end
+
 end
 

data/test/test_rc_rest.rb

@@ -25,6 +25,10 @@ class FakeService < RCRest
     post :method, :param => 'value'
   end
 
+  def do_post_multipart
+    post_multipart :method, :param => 'value'
+  end
+
   def parse_response(xml)
     return xml
   end
@@ -42,6 +46,8 @@ class TestFakeService < Test::Unit::TestCase
     Net::HTTP.responses = []
 
     @fs = FakeService.new
+
+    srand 0
   end
 
   def test_check_error
@@ -94,6 +100,30 @@ class TestFakeService < Test::Unit::TestCase
     assert_equal '/method', Net::HTTP.paths.first
   end
 
+  def test_do_post_multipart
+    xml = '<result>stuff</result>'
+    Net::HTTP.responses << xml
+
+    result = @fs.do_post_multipart
+
+    assert_equal xml, result.to_s
+
+    assert_equal 1, Net::HTTP.params.length
+    assert_equal 1, Net::HTTP.paths.length
+    assert_empty Net::HTTP.responses
+
+    expected = <<-EOF.strip
+--ac_2f_75_c0_43_fb_c3_67\r
+Content-Disposition: form-data; name="param"\r
+\r
+value\r
+--ac_2f_75_c0_43_fb_c3_67--
+    EOF
+
+    assert_equal expected, Net::HTTP.params.first
+    assert_equal '/method', Net::HTTP.paths.first
+  end
+
 end
 
 class TestRCRest < Test::Unit::TestCase
@@ -111,13 +141,52 @@ class TestRCRest < Test::Unit::TestCase
     assert_raise NotImplementedError do r.check_error nil end
   end
 
+  def test_make_multipart
+    srand 0
+
+    r = RCRest.allocate
+    boundary, data = r.make_multipart :a => 'b c', :x => 'y z',
+                                      :array => ['v2', 'v1'],
+                                      :newlines => "a\nb"
+
+    assert_equal 'ac_2f_75_c0_43_fb_c3_67', boundary
+
+    expected = <<-EOF.strip
+--ac_2f_75_c0_43_fb_c3_67\r
+Content-Disposition: form-data; name="a"\r
+\r
+b c\r
+--ac_2f_75_c0_43_fb_c3_67\r
+Content-Disposition: form-data; name="array"\r
+\r
+v1\r
+--ac_2f_75_c0_43_fb_c3_67\r
+Content-Disposition: form-data; name="array"\r
+\r
+v2\r
+--ac_2f_75_c0_43_fb_c3_67\r
+Content-Disposition: form-data; name="newlines"\r
+\r
+a
+b\r
+--ac_2f_75_c0_43_fb_c3_67\r
+Content-Disposition: form-data; name="x"\r
+\r
+y z\r
+--ac_2f_75_c0_43_fb_c3_67--
+    EOF
+
+    assert_equal expected, data
+  end
+
   def test_make_url
     r = RCRest.allocate
     r.instance_variable_set :@url, URI.parse('http://example.com/')
 
-    url = r.make_url :method, :a => 'b c', :x => 'y z', :array => ['v2', 'v1']
+    url = r.make_url :method, :a => 'b c', :x => 'y z', :array => ['v2', 'v1'],
+                              :newlines => "a\nb", :funky => 'a;b+c&d'
 
-    assert_equal 'http://example.com/method?a=b%20c&array=v1&array=v2&x=y%20z',
+    assert_equal 'http://example.com/method?a=b%20c&array=v1&array=v2&funky=a%3Bb%2Bc%26d&newlines=a%0Ab&x=y%20z',
                  url.to_s
   end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0.6
+rubygems_version: 0.9.0.7
 specification_version: 1
 name: rc-rest
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
-date: 2006-11-27 00:00:00 -08:00
+  version: 2.1.0
+date: 2006-11-29 00:00:00 -08:00
 summary: Robot Co-op REST web services base class
 require_paths: 
 - lib
-email: eric@robotcoop.com
-homepage: http://dev.robotcoop.com/Libraries/rc_rest
+email: drbrain@segment7.net
+homepage: http://dev.robotcoop.com/Libraries/rc-rest
 rubyforge_project: rctools
 description: This library makes it easy to implement REST-like web services APIs.
 autorequire: 
@@ -58,5 +58,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.4
+        version: 1.1.5
     version: