restfully 0.5.1 → 0.5.2

data/CHANGELOG

@@ -1,3 +1,13 @@
+0.5.2
+* support for DELETE requests. Use resource.delete(options)
+* fixed bug in resource.load(:reload => true)
+
+0.5.1
+* fixed bug in resource.reload
+
+0.5.0
+* support for POST requests. Use resource.submit(payload, options)
+
 0.4.1
 * added a require 'yaml' in restfully.rb (priteau);
 * added an introductory message when using the command-line tool;

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/lib/restfully/collection.rb

@@ -38,6 +38,12 @@ module Restfully
         super(property)
       end
     end
+    
+    # Returns the current number of items (not the total number) 
+    # in the collection.
+    def length
+      @items.length
+    end
 
     def populate_object(key, value)
       case key
@@ -68,12 +74,7 @@ module Restfully
     def inspect
       @items.inspect
     end
-    
-    # Returns the current number of items (not the total number) 
-    # in the collection.
-    def length
-      @items.length
-    end
+
     
     def pretty_print(pp)
       super(pp) do |pp|

data/lib/restfully/http/adapters/rest_client_adapter.rb

@@ -23,6 +23,13 @@ module Restfully
           end
         end # def get
         
+
+        def delete(request)
+          in_order_to_get_the_response_to(request) do |resource|
+            resource.delete(request.headers)
+          end
+        end # def delete
+        
         def post(request)
           in_order_to_get_the_response_to(request) do |resource|
             resource.post(request.raw_body, request.headers)

data/lib/restfully/resource.rb

@@ -52,6 +52,10 @@ module Restfully
       @properties[key]
     end
     
+    def respond_to?(method, *args)
+      @links.has_key?(method.to_s) || super(method, *args)
+    end
+    
     def method_missing(method, *args)
       if link = @links[method.to_s]
         session.logger.debug "Loading link #{method}, args=#{args.inspect}"
@@ -77,7 +81,7 @@ module Restfully
     def load(options = {})
       options = options.symbolize_keys
       force_reload = !!options.delete(:reload)
-      stale! unless (request = executed_requests['GET']) && request['options'] == options && request['body']
+      stale! unless !force_reload && (request = executed_requests['GET']) && request['options'] == options && request['body']
       if stale?
         reset
         if !force_reload && options[:body]
@@ -100,10 +104,17 @@ module Restfully
       end
       self
     end
+    
+    # Convenience function to make a resource.load(:reload => true)
+    def reload
+      current_options = executed_requests['GET']['options'] rescue {}
+      stale!
+      self.load(current_options.merge(:reload => true))
+    end
   
     # == Description
     # Executes a POST request on the resource, reload it and returns self if successful.
-    # If the response status is different than 2xx, raises a HTTP::ClientError or HTTP::ServerError.
+    # If the response status is different from 2xx, raises a HTTP::ClientError or HTTP::ServerError.
     # <tt>payload</tt>:: the input body of the request.
     #                    It may be a serialized string, or a ruby object 
     #                    (that will be serialized according to the given or default content-type).
@@ -132,19 +143,27 @@ module Restfully
       end
     end
     
+    # == Description
+    # Executes a DELETE request on the resource, and returns true if successful.
+    # If the response status is different from 2xx or 3xx, raises an HTTP::ClientError or HTTP::ServerError.
+    # <tt>options</tt>:: list of options to pass to the request (see below)
+    # == Options
+    # <tt>:query</tt>:: a hash of query parameters to pass along the request. 
+    #                   E.g. : resource.delete(:query => {:param1 => "value1"})
+    # <tt>:headers</tt>:: a hash of HTTP headers to pass along the request. 
+    #                     E.g. : resource.delete(:headers => {:accept => 'application/json'})
+    def delete(options = {})
+      options = options.symbolize_keys
+      raise NotImplementedError, "The DELETE method is not allowed for this resource." unless http_methods.include?('DELETE')
+      response = session.delete(self.uri, options) # raises an exception if there is an error
+      stale!
+      (200..399).include?(response.status)
+    end
+    
     
     def stale!; @status = :stale;  end
     def stale?; @status == :stale; end
-    
-    def uri_for(path)
-      uri.merge(URI.parse(path.to_s))
-    end
-    
-    def reload
-      current_options = executed_requests['GET']['options'] rescue {}
-      stale!
-      self.load(current_options.merge(:reload => true))
-    end
+
     
     # == Description
     # Returns the list of allowed HTTP methods on the resource.
@@ -157,8 +176,8 @@ module Restfully
       (executed_requests['GET']['headers']['Allow'] || "GET").split(/,\s*/)
     end
     
-    def respond_to?(method, *args)
-      @links.has_key?(method.to_s) || super(method, *args)
+    def uri_for(path)
+      uri.merge(URI.parse(path.to_s))
     end
     
     def inspect(*args)

data/lib/restfully/session.rb

@@ -49,6 +49,12 @@ module Restfully
       transmit :post, HTTP::Request.new(uri_for(path), :body => body, :headers => options.delete(:headers), :query => options.delete(:query))
     end
     
+    # returns an HTTP::Response object or raise a Restfully::HTTP::Error
+    def delete(path, options = {})
+      options = options.symbolize_keys
+      transmit :delete, HTTP::Request.new(uri_for(path), :headers => options.delete(:headers), :query => options.delete(:query))
+    end
+    
     # builds the complete URI, based on the given path and the session's base_uri
     def uri_for(path)
       URI.join(base_uri.to_s, path.to_s)

data/lib/restfully.rb

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

data/restfully.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restfully}
-  s.version = "0.5.1"
+  s.version = "0.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
-  s.date = %q{2009-12-09}
+  s.date = %q{2009-12-14}
   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/http/rest_client_adapter_spec.rb

@@ -19,7 +19,7 @@ describe Restfully::HTTP::Adapters::RestClientAdapter do
   end
   it "should raise a not implemented error when trying to use functions not implemented yet" do
     adapter = Restfully::HTTP::Adapters::RestClientAdapter.new("https://api.grid5000.fr")
-    lambda{adapter.delete(mock("restfully request"))}.should raise_error NotImplementedError, "DELETE is not supported by your adapter."
+    lambda{adapter.put(mock("restfully request"))}.should raise_error NotImplementedError, "PUT is not supported by your adapter."
   end
   it "should rescue any RestClient::Exception and correctly populate the response" do
     res = mock(Net::HTTPResponse, :code => 404, :body => '{"message":"whatever"}', :to_hash => {'Content-Type' => 'application/json;charset=utf-8', 'Content-Length' => 22}, :[] => '')

data/spec/resource_spec.rb

@@ -9,15 +9,16 @@ describe Resource do
   end
   
   describe "accessors" do
+    before(:each) do
+      @resource = Resource.new(@uri, @session=mock("session"))
+    end
     it "should have a reader on the session" do
-      resource = Resource.new("uri", session=mock("session"))
-      resource.should_not respond_to(:session=)
-      resource.session.should == session
+      @resource.should_not respond_to(:session=)
+      @resource.session.should == @session
     end
     it "should have a reader on the uri" do
-      resource = Resource.new("uri", session=mock("session"))
-      resource.should_not respond_to(:uri=)
-      resource.uri.should == URI.parse("uri")
+      @resource.should_not respond_to(:uri=)
+      @resource.uri.should == @uri
     end
   end
   
@@ -177,11 +178,21 @@ describe Resource do
       resource.links.keys.should =~ ['versions', 'clusters', 'environments', 'status', 'parent', 'version']
     end
     
-    it "should reload the resource if user forces reload" do
+    it "should reload the resource if user forces reload [first loading]" do
       resource = Resource.new(@uri, session = mock("session"))
       session.should_receive(:get).and_return(response = mock("response", :headers => {}, :body => {}))
       resource.load(:reload => true, :body => mock("body"))
     end
+    it "should reload the resource when user forces reload [has been loaded at least once before]" do
+      resource = Resource.new(@uri, session = mock("session"))
+      resource.instance_variable_set "@status", :loaded
+      resource.should_not be_stale
+      resource.should_receive(:executed_requests).at_least(1).and_return({
+        'GET' => {'options' => {:query => {:q=>1}}, 'body' => {'a' => 'b'}}
+      })
+      session.should_receive(:get).and_return(response = mock("response", :headers => {}, :body => {}))
+      resource.load(:reload => true, :query => {:q => 1})
+    end
   end
   
   
@@ -241,4 +252,19 @@ describe Resource do
       @resource.submit("whatever").should == @resource
     end
   end
+  
+  describe "deleting" do
+    before do
+      @resource = Resource.new(@uri, @session = mock("session", :logger => @logger))
+      @resource.stub!(:http_methods).and_return(['GET', 'DELETE'])
+    end
+    it "should raise an error if the DELETE method is not supported by the service" do
+      @resource.stub!(:http_methods).and_return(['GET'])
+      lambda{@resource.delete}.should raise_error(NotImplementedError, /DELETE method is not allowed/)
+    end
+    it "should send a DELETE request to the resource URI" do
+      @session.should_receive(:delete).with(@uri, :query => {:q => 'v'}, :headers => {'Accept' => 'application/json'}).and_return(response = mock("http response", :status => 204))
+      @resource.delete(:query => {:q => 'v'}, :headers => {'Accept' => 'application/json'}).should be_true
+    end
+  end
 end

data/spec/session_spec.rb

@@ -153,4 +153,12 @@ describe Session do
     end
   end
   
+  describe "DELETEing resources" do
+    it "should create a new Request object and transmit it" do
+      Restfully::HTTP::Request.should_receive(:new).with(URI.parse('https://api.grid5000.fr/sid/some/path'), :headers => {:accept => 'application/json'}, :query => nil).and_return(@request)
+      @session.should_receive(:transmit).with(:delete, @request)
+      @session.delete('some/path', 'headers' => {:accept => 'application/json'})
+    end
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restfully
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-09 00:00:00 +01:00
+date: 2009-12-14 00:00:00 +01:00
 default_executable: restfully
 dependencies: 
 - !ruby/object:Gem::Dependency