restfully 0.5.9 → 0.5.10

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.5.10
+* Direct lookup to the resource if it cannot be found in the collection (for APIs that do not return all the items in a collection) (priteau)
+* Automatically load next pages of a collection when iterating through it
+
 0.5.9
 * fixed bug in #http_methods that made a resource not removable unless force reloading it
 

data/VERSION

@@ -1 +1 @@
-0.5.9
+0.5.10

data/lib/restfully.rb

@@ -14,7 +14,7 @@ require 'restfully/collection'
 
 
 module Restfully
-  VERSION = "0.5.9"
+  VERSION = "0.5.10"
   class << self
     attr_accessor :adapter
   end

data/lib/restfully/collection.rb

@@ -26,14 +26,25 @@ module Restfully
     
     # Iterates over the collection of items
     def each(*args, &block)
-      @items.each(*args, &block)
+      @items.each_index{ |i|
+        block.call(@items[i])
+        if i == @items.length-1 && @items.length < self["total"]
+          # load next page
+          next_page = Collection.new(uri, session).load(:query => {:offset => self["offset"]+@items.length}) rescue nil
+          if next_page && next_page['offset'] != self["offset"]
+            @items.push(*next_page.to_a)
+          end
+        end
+      }
     end
     
     # if property is a Symbol, it tries to find the corresponding item whose uid.to_sym is matching the property
     # else, returns the result of calling <tt>[]</tt> on its superclass.
     def [](property)
       if property.kind_of?(Symbol)
-        find{|i| i['uid'] == property.to_s} || find{|i| i['uid'] == property.to_s.to_i}
+        item = find{|i| i['uid'] == property.to_s} || 
+          find{|i| i['uid'] == property.to_s.to_i} ||
+          Resource.new([uri, property].join("/"), session).load rescue nil
       else
         super(property)
       end

data/restfully.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restfully}
-  s.version = "0.5.9"
+  s.version = "0.5.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
-  s.date = %q{2010-03-31}
+  s.date = %q{2010-04-20}
   s.default_executable = %q{restfully}
   s.description = %q{Experimental code for auto-generation of wrappers on top of RESTful APIs that follow HATEOAS principles and provide OPTIONS methods and/or Allow headers.}
   s.email = %q{cyril.rohr@gmail.com}

data/spec/collection_spec.rb

@@ -32,6 +32,31 @@ describe Collection do
       job.class.should == Restfully::Resource
       job['uid'].should == 319482
     end
+    it "should make a direct request to collection_uri/resource_uid when calling [] and the searched item is not in the collection" do
+      Restfully::Resource.should_receive(:new).with('http://api.local/x/y/z/not_in_the_collection', @collection.session).and_return(resource = mock("resource"))
+      resource.should_receive(:load).and_return(resource)
+      @collection[:not_in_the_collection].should == resource
+    end
+    it "should go through the 'next' links (if any) to search for the requested item" do
+      body = JSON.parse(fixture("grid5000-rennes-jobs.json"))
+      body["total"] = 20
+      body1 = JSON.parse(fixture("grid5000-rennes-jobs.json"))
+      body["total"] = 20
+      body1["offset"] = 8
+      body2 = JSON.parse(fixture("grid5000-rennes-jobs.json"))
+      body["total"] = 20
+      body2["offset"] = 16
+      body2["items"][1]["uid"] = "18th item"
+      collection = Collection.new(@uri, session = mock('session')).load(:body => body)
+      session.should_receive(:get).with(@uri, :query => {:offset => 8}).ordered.and_return(response = mock("response", :body => body1, :status => 200, :headers => {}))
+      session.should_receive(:get).with(@uri, :query => {:offset => 16}).ordered.and_return(response = mock("response", :body => body2, :status => 200, :headers => {}))
+      collection.find{|item| item["uid"] == "18th item"}.should_not be_nil
+    end
+    it "should always return nil if the searched item is not in the collection" do
+      Restfully::Resource.should_receive(:new).with('http://api.local/x/y/z/doesnotexist', @collection.session).and_return(resource = mock("resource"))
+      resource.should_receive(:load).and_raise Restfully::HTTP::ClientError.new(mock("response", :body => "Not Found", :status => 404))
+      @collection[:doesnotexist].should be_nil
+    end
   end  
   
   describe "populating collection" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restfully
 version: !ruby/object:Gem::Version 
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-31 00:00:00 +02:00
+date: 2010-04-20 00:00:00 +02:00
 default_executable: restfully
 dependencies: 
 - !ruby/object:Gem::Dependency