rc-rest 1.0.0 → 2.0.0

data/History.txt

@@ -0,0 +1,10 @@
+= 2.0.0
+
+* Added +method+ parameter to RCRest#make_url to add path components
+  to a generic endpoint.
+* Added RCRest#post.
+
+= 1.0.0
+
+* Birthday!
+

data/Manifest.txt

@@ -1,7 +1,9 @@
-LICENSE
+History.txt
+LICENSE.txt
 Manifest.txt
-README
+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

data/{README → README.txt}

@@ -10,8 +10,7 @@ http://dev.robotcoop.com/Libraries/rc-rest/
 
 == About
 
-This is an abstract class for REST web service APIs.  By itself it isn't at all
-useful.
+This is an abstract class for creating wrappers for REST web service APIs.
 
 == Installing rc-rest
 
@@ -25,3 +24,9 @@ rc-rest is used by gems such as yahoo-search, google-geocode and geocoder-us.
 If you'd like to write bindings a web service using rc-rest see RCRest, its
 tests or the above-mentioned gems for examples.
 
+== Upgrading from 1.x
+
+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.
+

data/Rakefile

@@ -1,66 +1,25 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
+require 'hoe'
+require './lib/rc_rest'
 
-$VERBOSE = nil
+DEV_DOC_PATH = 'Libraries/rc_rest'
 
-spec = Gem::Specification.new do |s|
-  s.name = 'rc-rest'
-  s.version = '1.0.0'
-  s.summary = 'Robot Co-op REST web services base class'
-  s.description = 'This library makes it easy to implement REST-like web services APIs.'
-  s.author = 'Eric Hodel'
-  s.email = 'eric@robotcoop.com'
+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.url = "http://dev.robotcoop.com/#{DEV_DOC_PATH}"
+  p.rubyforge_name = 'rctools'
 
-  s.has_rdoc = true
-  s.files = File.read('Manifest.txt').split($/)
-  s.require_path = 'lib'
+  p.changes = File.read('History.txt').scan(/\A(=.*?)^=/m).first.first
 end
 
-desc 'Run tests'
-task :default => [ :test ]
+SPEC = hoe.spec
 
-Rake::TestTask.new('test') do |t|
-  t.libs << 'test'
-  t.pattern = 'test/test_*.rb'
-  t.verbose = true
+begin
+  require '../tasks'
+rescue RuntimeError
 end
 
-desc 'Update Manifest.txt'
-task :update_manifest do
-  sh "find . -type f | sed -e 's%./%%' | egrep -v 'svn|swp|~' | egrep -v '^(doc|pkg)/' | sort > Manifest.txt"
-end
-
-desc 'Generate RDoc'
-Rake::RDocTask.new :rdoc do |rd|
-  rd.rdoc_dir = 'doc'
-  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
-  rd.main = 'README'
-  rd.options << '-d' if `which dot` =~ /\/dot/
-  rd.options << '-t Robot Co-op REST Web Services'
-end
-
-desc 'Generate RDoc for dev.robotcoop.com'
-Rake::RDocTask.new :dev_rdoc do |rd|
-  rd.rdoc_dir = '../../../www/trunk/dev/html/Libraries/rc-rest'
-  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
-  rd.main = 'README'
-  rd.options << '-d' if `which dot` =~ /\/dot/
-  rd.options << '-t Robot Co-op REST Web Services'
-end
-
-desc 'Build Gem'
-Rake::GemPackageTask.new spec do |pkg|
-  pkg.need_tar = true
-end
-
-desc 'Clean up'
-task :clean => [ :clobber_rdoc, :clobber_package ]
-
-desc 'Clean up'
-task :clobber => [ :clean ]
-
 # vim: syntax=Ruby
 

data/lib/rc_rest.rb

@@ -1,3 +1,4 @@
+require 'net/http'
 require 'open-uri'
 require 'rexml/document'
 
@@ -21,16 +22,16 @@ require 'rexml/document'
 #   
 #     def initialize(appid)
 #       @appid = appid
-#       @url = URI.parse 'http://example.com/test'
+#       @url = URI.parse 'http://example.com/api/'
 #     end
 #   
 #     def check_error(xml)
 #       raise Error, xml.elements['error'].text if xml.elements['error']
 #     end
 #   
-#     def make_url(params)
+#     def make_url(method, params)
 #       params[:appid] = @appid
-#       super params
+#       super method, params
 #     end
 #   
 #     def parse_response(xml)
@@ -38,7 +39,7 @@ require 'rexml/document'
 #     end
 #   
 #     def test(query)
-#       get :q => query
+#       get :test, :q => query
 #     end
 #   
 #   end
@@ -46,7 +47,12 @@ require 'rexml/document'
 class RCRest
 
   ##
-  # Error class.
+  # You are using this version of RCRest
+
+  VERSION = '2.0.0'
+
+  ##
+  # Abstract Error class.
 
   class Error < RuntimeError; end
 
@@ -57,24 +63,24 @@ class RCRest
   # variable which must be a URI.
 
   def initialize
-    raise NotImplementedError
+    raise NotImplementedError, 'need to implement #intialize and set @url'
   end
 
   ##
   # Must extract and raise an error from +xml+, an REXML::Document, if any.
-  # Must returns if no error could be found.
+  # Must return if no error could be found.
 
   def check_error(xml)
     raise NotImplementedError
   end
 
   ##
-  # Performs a GET request with +params+.  Calls the parse_response method on
-  # the concrete class with an REXML::Document instance and returns its
-  # result.
+  # 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.
 
-  def get(params = {})
-    url = make_url params
+  def get(method, params = {})
+    url = make_url method, params
 
     url.open do |xml|
       res = REXML::Document.new xml.read
@@ -90,15 +96,53 @@ class RCRest
   end
 
   ##
-  # Creates a URI from the Hash +params+.  Override this then call super if
-  # you need to add extra params like an application id or output type.
+  # Creates a URI for method +method+ and a Hash of parameters +params+.
+  # Override this then call super if you need to add extra params like an
+  # application id, output type, etc.
+  #
+  # If the value of a parameter responds to #each, make_url creates a
+  # key-value pair per value in the param.
+  #
+  # Examples:
+  #
+  # If the URL base is:
+  #
+  #   http://example.com/api/
+  #
+  # then:
+  #
+  #   make_url nil, :a => '1 2', :b => [4, 3]
+  #
+  # creates the URL:
+  #
+  #   http://example.com/api/?a=1%202&b=3&b=4
+  #
+  # and
+  #
+  #   make_url :method, :a => '1'
+  #
+  # creates the URL:
+  #
+  #   http://example.com/api/method?a=1
 
-  def make_url(params)
-    escaped_params = params.sort_by { |k,v| k.to_s }.map do |k,v|
+  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
+    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
 
-    url = @url.dup
+    url = @url + "./#{method}"
     url.query = escaped_params.join '&'
     return url
   end
@@ -111,5 +155,34 @@ class RCRest
     raise NotImplementedError
   end
 
+  ##
+  # 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.
+
+  def post(method, params = {})
+    url = make_url method, params
+    query = url.query
+    url.query = nil
+
+    req = Net::HTTP::Post.new url.path
+    req.body = query
+    req.content_type = 'application/x-www-form-urlencoded'
+
+    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/lib/rc_rest/net_http_stub.rb

@@ -0,0 +1,60 @@
+require 'net/http'
+
+class Net::HTTPResponse
+
+  ##
+  # Setter for body content
+
+  attr_accessor :body
+
+end
+
+class Net::HTTP
+
+  @params = nil
+  @paths = nil
+  @responses = nil
+
+  class << self
+
+    ##
+    # Records submitted POST params
+
+    attr_accessor :params
+
+    ##
+    # Records POST paths
+
+    attr_accessor :paths
+
+    ##
+    # Holds POST body responses
+
+    attr_accessor :responses
+
+    remove_method :start
+
+  end
+
+  ##
+  # Override Net::HTTP::start to not connect
+
+  def self.start(host, port)
+    yield Net::HTTP.new(host)
+  end
+
+  remove_method :request
+
+  ##
+  # Override Net::HTTP#request to fake its results
+
+  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
+  end
+
+end
+

data/test/test_rc_rest.rb

@@ -1,5 +1,8 @@
 require 'test/unit'
+require 'rubygems'
+require 'test/zentest_assertions'
 require 'rc_rest/uri_stub'
+require 'rc_rest/net_http_stub'
 require 'rc_rest'
 
 class FakeService < RCRest
@@ -14,8 +17,12 @@ class FakeService < RCRest
     raise Error, xml.elements['error'].text if xml.elements['error']
   end
 
-  def test
-    get
+  def do_get
+    get :method
+  end
+
+  def do_post
+    post :method, :param => 'value'
   end
 
   def parse_response(xml)
@@ -30,6 +37,10 @@ class TestFakeService < Test::Unit::TestCase
     URI::HTTP.responses = []
     URI::HTTP.uris = []
 
+    Net::HTTP.params = []
+    Net::HTTP.paths = []
+    Net::HTTP.responses = []
+
     @fs = FakeService.new
   end
 
@@ -44,16 +55,17 @@ class TestFakeService < Test::Unit::TestCase
     flunk 'expected an error'
   end
 
-  def test_get
+  def test_do_get
     xml = '<result>stuff</result>'
     URI::HTTP.responses << xml
 
-    result = @fs.test
+    result = @fs.do_get
 
     assert_equal xml, result.to_s
+    assert_equal 'http://example.com/method?', URI::HTTP.uris.first
   end
 
-  def test_get_error
+  def test_do_get_error
     def @fs.make_url(*args) # HACK extend uri_stub with error raising ability
       u = Object.new
       def u.open
@@ -63,7 +75,23 @@ class TestFakeService < Test::Unit::TestCase
       return u
     end
 
-    assert_raise FakeService::Error do @fs.test end
+    assert_raise FakeService::Error do @fs.do_get end
+  end
+
+  def test_do_post
+    xml = '<result>stuff</result>'
+    Net::HTTP.responses << xml
+
+    result = @fs.do_post
+
+    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
+
+    assert_equal 'param=value', Net::HTTP.params.first
+    assert_equal '/method', Net::HTTP.paths.first
   end
 
 end
@@ -71,7 +99,11 @@ end
 class TestRCRest < Test::Unit::TestCase
 
   def test_initialize
-    assert_raise NotImplementedError do RCRest.new end
+    RCRest.new
+  rescue NotImplementedError => e
+    assert_equal 'need to implement #intialize and set @url', e.message
+  else
+    flunk 'expected NotImplementedError'
   end
 
   def test_check_error
@@ -83,9 +115,10 @@ class TestRCRest < Test::Unit::TestCase
     r = RCRest.allocate
     r.instance_variable_set :@url, URI.parse('http://example.com/')
 
-    url = r.make_url :a => 'b c', :x => 'y z'
+    url = r.make_url :method, :a => 'b c', :x => 'y z', :array => ['v2', 'v1']
 
-    assert_equal 'http://example.com/?a=b%20c&x=y%20z', url.to_s
+    assert_equal 'http://example.com/method?a=b%20c&array=v1&array=v2&x=y%20z',
+                 url.to_s
   end
 
   def test_parse_response

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.99
+rubygems_version: 0.9.0.6
 specification_version: 1
 name: rc-rest
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2006-06-15 00:00:00 -07:00
+  version: 2.0.0
+date: 2006-11-27 00:00:00 -08:00
 summary: Robot Co-op REST web services base class
 require_paths: 
 - lib
 email: eric@robotcoop.com
-homepage: 
-rubyforge_project: 
+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: 
 default_executable: 
@@ -29,15 +29,17 @@ post_install_message:
 authors: 
 - Eric Hodel
 files: 
-- LICENSE
+- History.txt
+- LICENSE.txt
 - Manifest.txt
-- README
+- 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_files: 
+- test/test_rc_rest.rb
 rdoc_options: []
 
 extra_rdoc_files: []
@@ -48,5 +50,13 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: