resthome 0.6.4 → 0.7.0

data/README.rdoc

@@ -48,13 +48,9 @@ Create a simple lorem lipsum generator, using http://www.lipsum.com.
 
 
  class LoremLipsumService < RESTHome
-   route :generate, '/feed/json', :method => :post, :return => :parse_feed
+   base_uri 'http://www.lipsum.com'
 
-   def initialize
-     self.base_uri = 'http://www.lipsum.com'
-   end
-
-   def parse_feed(res)
+   route :generate, '/feed/json', :method => :post do |res|
      res['feed']['lipsum']
    end
  end
@@ -62,6 +58,30 @@ Create a simple lorem lipsum generator, using http://www.lipsum.com.
  service = LoremLipsumService.new
  words = service.generate(:what => 'words', :amount => 20)
 
+== LastFM Example query arguments
+
+How to use replace query parameters with function arguments.
+
+  class LastFmWebService < RESTHome
+    base_uri 'http://ws.audioscrobbler.com'
+
+    namespace '/2.0' do
+      route :track, '/', :query => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}, :resource => 'track'
+    end
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+  
+    def build_options!(options)
+      options[:query] ||= {}
+      options[:query]['format'] = 'json'
+      options[:query]['api_key'] = @api_key
+    end
+  end
+
+  service = LastFmWebService.new 'xxxxxxxxx'
+  service.track 'cher', 'believe'
 
 == Contributing to RESTHome
  

data/VERSION

@@ -1 +1 @@
-0.6.4
+0.7.0

data/examples/chargify_web_service.rb

@@ -50,4 +50,6 @@ class ChargifyWebService < RESTHome
     super
     options[:body] = options[:body].to_json if options[:body]
   end
+
+  def parse_response!; end
 end

data/examples/last_fm_web_service.rb

@@ -1,30 +1,28 @@
 require 'resthome'
 
 class LastFmWebService < RESTHome
-  route :find_albums, '/2.0/', :query => {'method' => 'library.getalbums'}, :resource => 'albums'
-  # find_albums_by_user
+  base_uri 'http://ws.audioscrobbler.com'
 
-  route :find_neighbors, '/2.0/', :query => {'method' => 'user.getneighbours'} do |res|
-    res['neighbours']['user']
-  end
-  # find_neighbors_by_user
+  namespace '/2.0' do
+    route :user_neighbors, '/', :query => {'method' => 'user.getneighbours', 'user' => :arg1} do |res|
+      res['neighbours']['user']
+    end
 
-  route :find_top_tracks, '/2.0/', :query => {'method' => 'user.gettoptracks'} do |res|
-    res['track']['track']
-  end
-  # find_top_tracks_by_user
+    route :track, '/', :query => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}, :resource => 'track'
+
+    route :user_albums, '/', :query => {'method' => 'library.getalbums', 'user' => :arg1}, :resource => 'albums'
 
-  route :find_track, '/2.0/', :query => {'method' => 'track.getinfo'}, :resource => 'track'
-  # find_track_by_artist_and_track
+    route :user_top_albums, '/', :query => {'method' => 'user.gettopalbums', 'user' => :arg1} do |res|
+      res['topalbums']['album']
+    end
 
-  route :find_top_albums, '/2.0/', :query => {'method' => 'user.gettopalbums'} do |res|
-    res['topalbums']['album']
+    route :user_top_tracks, '/', :query => {'method' => 'user.gettoptracks', 'user' => :arg1} do |res|
+      res['toptracks']['track']
+    end
   end
-  # find_top_albums_by_user
 
   def initialize(api_key)
     @api_key = api_key
-    self.base_uri = "http://ws.audioscrobbler.com"
   end
   
   def build_options!(options)

data/lib/resthome.rb

@@ -40,8 +40,22 @@ class RESTHome
   #   Default set of query arguments
   def self.route(name, path, options={}, &block)
     args = path.scan /:[a-z_]+/
+    path = "#{@path_prefix.join if @path_prefix}#{path}"
     function_args = args.collect{ |arg| arg[1..-1] }
 
+    query_args = []
+    if options[:query]
+      options[:query].each do |n, v|
+        next unless v.is_a?(Symbol)
+        idx = v.to_s.gsub(/[^\d]/, '').to_i
+        query_args[idx] = n.to_s
+        options[:query].delete n
+      end
+      query_args.compact!
+    end
+
+    function_args += query_args
+
     method = options[:method]
     expected_status = options[:expected_status]
     if method.nil?
@@ -79,7 +93,7 @@ class RESTHome
     METHOD
 
     args.each_with_index do |arg, idx|
-      method_src << "path.sub! '#{arg}', #{function_args[idx]}.to_s\n"
+      method_src << "path.sub! '#{arg}', URI.escape(#{function_args[idx]}.to_s)\n"
     end
 
     if options[:no_body].nil?
@@ -94,6 +108,13 @@ class RESTHome
 
     if options[:query]
       method_src << "options[:query] = #{options[:query].inspect}.merge(options[:query] || {})\n"
+    elsif query_args.size > 0
+      method_src << "options[:query] ||= {}\n"
+    end
+
+    query_args.each_with_index do |arg, idx|
+      idx += args.size
+      method_src << "options[:query]['#{arg}'] = #{function_args[idx]}\n"
     end
 
     method_src << "request :#{method}, path, options\n"
@@ -141,6 +162,13 @@ class RESTHome
     self.class.route name, path, options.merge(:instance => self)
   end
 
+  def self.namespace(path_prefix)
+    @path_prefix ||= []
+    @path_prefix.push path_prefix
+    yield
+    @path_prefix.pop
+  end
+
   # Creates routes for a RESTful API
   #
   # *resource_name* is the name of the items returned by the API,
@@ -180,7 +208,7 @@ class RESTHome
 
   # Creates the url
   def build_url(path)
-    "#{self.base_uri}#{path}"
+    "#{self.base_uri || self.class.base_uri}#{path}"
   end
 
   # Adds the basic_auth and cookie options

data/resthome.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resthome}
-  s.version = "0.6.4"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Doug Youch"]
-  s.date = %q{2010-11-30}
+  s.date = %q{2010-12-15}
   s.description = %q{Simple wrapper class generator for consuming RESTful web services}
   s.email = %q{doug@cykod.com}
   s.extra_rdoc_files = [

data/spec/lib/resthome_spec.rb

@@ -404,4 +404,73 @@ describe RESTHome do
     @service.request_url.should == 'http://test.dev/songs.json'
     @service.request_options.should == {:query => {'search' => 'test2'}}
   end
+
+  it "namespaces for convenience" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+
+      namespace '/users/1' do
+        route :find_songs,  '/songs.json'
+        route :find_albums, '/albums.json'
+        namespace '/videos' do
+          route :find_videos, '/search.json'
+        end
+        route :find_tracks, '/tracks.json'
+      end
+      route :tracks, '/tracks.json'
+    end
+
+    @service_class.method_defined?(:find_songs).should be_true
+    @service_class.method_defined?(:find_albums).should be_true
+    @service_class.method_defined?(:tracks).should be_true
+
+    @service = @service_class.new
+
+    fakeweb_response(:get, 'http://test.dev/users/1/songs.json', 200, [])
+    @service.find_songs
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/users/1/songs.json'
+
+    fakeweb_response(:get, 'http://test.dev/users/1/albums.json', 200, [])
+    @service.find_albums
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/users/1/albums.json'
+
+    fakeweb_response(:get, 'http://test.dev/users/1/tracks.json', 200, [])
+    @service.find_tracks
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/users/1/tracks.json'
+
+    fakeweb_response(:get, 'http://test.dev/users/1/videos/search.json', 200, [])
+    @service.find_videos
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/users/1/videos/search.json'
+
+    fakeweb_response(:get, 'http://test.dev/tracks.json', 200, [])
+    @service.tracks
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/tracks.json'
+  end
+
+  it "should support query arguments" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :tracks, '/:version/', :query => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:get, %r|http://test.dev/2.0/|, 200, [])
+    @service.tracks '2.0', 'cher', 'believe'
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/2.0/'
+    @service.request_options[:query]['method'].should == 'track.getinfo'
+    @service.request_options[:query]['artist'].should == 'cher'
+    @service.request_options[:query]['track'].should == 'believe'
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resthome
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 4
-  version: 0.6.4
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Doug Youch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-30 00:00:00 -05:00
+date: 2010-12-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency