crohr-restfully 0.1.1 → 0.2.1

data/spec/resource_spec.rb

@@ -7,7 +7,7 @@ describe Resource do
     @logger = Logger.new(STDOUT)
   end
   
-  it "should have all methods of a hash" do
+  it "should have all the methods of a hash" do
     resource = Resource.new("uri", session=mock('session'))
     resource.size.should == 0
     resource['whatever'] = 'thing'
@@ -46,57 +46,78 @@ describe Resource do
     before do
       @raw = {
         'links' => [
-          {'rel' => 'self', 'href' => '/sites/rennes/versions/123'},
-          {'rel' => 'member', 'href' => '/versions/123', 'title' => 'grid'},
+          {'rel' => 'self', 'href' => '/grid5000/sites/rennes'},
+          {'rel' => 'parent', 'href' => '/grid5000'},
           {'rel' => 'invalid_rel', 'href' => '/whatever'},
-          {'rel' => 'member', 'href' => '/sites/rennes/statuses/current', 'title' => 'status'},
-          {'rel' => 'collection', 'href' => '/sites/rennes/versions', 'resolvable' => false, 'title' => 'versions'},
-          {'rel' => 'collection', 'href' => '/sites/rennes/clusters/versions/123', 'resolvable' => true, 'resolved' => true, 'title' => 'clusters'},
-          {'rel' => 'collection', 'href' => '/sites/rennes/environments/versions/123', 'resolvable' => true, 'resolved' => false, 'title' => 'environments'},
+          {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/status', 'title' => 'status'},
+          {'rel' => 'member', 'href' => '/grid5000/sites/rennes/versions/123', 'title' => 'version'},
+          {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/versions', 'resolvable' => false, 'title' => 'versions'},
+          {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/clusters', 'resolvable' => true, 'resolved' => true, 'title' => 'clusters'},
+          {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/environments/versions/123', 'resolvable' => true, 'resolved' => false, 'title' => 'environments'},
           {'rel' => 'collection', 'href' => '/has/no/title'} 
         ],
         'uid' => 'rennes',
         'whatever' => 'whatever',
         'an_array' => [1, 2, 3],
         'clusters' => {
-          '/sites/rennes/clusters/paradent' => {
-            'guid' => '/sites/rennes/clusters/paradent',
+          'paradent' => {
+            'uid' => 'paradent',
             'links' => [
-              {'rel' => 'self', 'href' => '/sites/rennes/clusters/paradent/versions/123'},
-              {'rel' => 'parent', 'href' => '/sites/rennes/versions/123'},
-              {'rel' => 'collection', 'href' => '/sites/rennes/clusters/paradent/nodes/versions/123', 'title' => 'nodes', 'resolvable' => true, 'resolved' => false},
-              {'rel' => 'collection', 'href' => '/sites/rennes/clusters/paradent/versions', 'resolvable' => false, 'title' => 'versions'},
-              {'rel' => 'member', 'href' => '/sites/rennes/clusters/paradent/statuses/current', 'title' => 'status'}
+              {'rel' => 'self', 'href' => '/grid5000/sites/rennes/clusters/paradent'},
+              {'rel' => 'parent', 'href' => '/grid5000/sites/rennes'},
+              {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/clusters/paradent/nodes', 'title' => 'nodes', 'resolvable' => true, 'resolved' => false},
+              {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/clusters/paradent/versions', 'resolvable' => false, 'title' => 'versions'},
+              {'rel' => 'member', 'href' => '/grid5000/sites/rennes/clusters/paradent/versions/123', 'title' => 'version'},
+              {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/clusters/paradent/status', 'title' => 'status'}
             ],
             'model' => 'XYZ'
           },
-          '/sites/rennes/clusters/paramount' => {
-            'guid' => '/sites/rennes/clusters/paramount',
+          'paramount' => {
+            'uid' => 'paramount',
             'links' => [
-              {'rel' => 'self', 'href' => '/sites/rennes/clusters/paramount/versions/123'},
-              {'rel' => 'parent', 'href' => '/sites/rennes/versions/123'},
-              {'rel' => 'collection', 'href' => '/sites/rennes/clusters/paramount/nodes/versions/123', 'title' => 'nodes', 'resolvable' => true, 'resolved' => false},
-              {'rel' => 'collection', 'href' => '/sites/rennes/clusters/paramount/versions', 'resolvable' => false, 'title' => 'versions'},
-              {'rel' => 'member', 'href' => '/sites/rennes/clusters/paramount/statuses/current', 'title' => 'status'}
+              {'rel' => 'self', 'href' => '/grid5000/sites/rennes/clusters/paramount'},
+              {'rel' => 'parent', 'href' => '/grid5000/sites/rennes'},
+              {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/clusters/paramount/nodes', 'title' => 'nodes', 'resolvable' => true, 'resolved' => false},
+              {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/clusters/paramount/versions', 'resolvable' => false, 'title' => 'versions'},
+              {'rel' => 'member', 'href' => '/grid5000/sites/rennes/clusters/paramount/versions/123', 'title' => 'version'},
+              {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/clusters/paramount/status', 'title' => 'status'}
             ],
             'model' => 'XYZ1b'
           }
         }
-      }
+      }.to_json
+      @response_200 = Restfully::HTTP::Response.new(200, {'Content-Type' => 'application/json;utf-8', 'Content-Length' => @raw.length}, @raw)
     end
     it "should not be loaded in its initial state" do
-      resource = Resource.new("uri", mock('session'))
+      resource = Resource.new(mock("uri"), mock('session'))
       resource.should_not be_loaded
     end
     it "should get the raw representation of the resource via the session if it doesn't have it" do
-      resource = Resource.new("uri", session = mock("session", :logger => Logger.new(STDOUT)))
+      resource = Resource.new(uri=mock("uri"), session = mock("session", :logger => Logger.new(STDOUT)))
       resource.stub!(:define_link) # do not define links
       resource.raw.should be_nil
-      session.should_receive(:get).with('uri', {}).and_return(@raw)
+      session.should_receive(:get).with(uri, {}).and_return(@response_200)
       resource.load
+      resource.should be_loaded
+    end
+    it "should get the raw representation of the resource via the session if there are query parameters" do
+      resource = Resource.new(uri=mock("uri"), session = mock("session", :logger => Logger.new(STDOUT)))
+      resource.stub!(:define_link) # do not define links
+      resource.stub!(:loaded?).and_return(true) # should force reload even if already loaded
+      resource.raw.should be_nil
+      session.should_receive(:get).with(uri, {:query => {:q1 => 'v1'}}).and_return(@response_200)
+      resource.load(:query => {:q1 => 'v1'})
+    end
+    it "should get the raw representation of the resource if forced to do so" do
+      resource = Resource.new(uri=mock("uri"), session = mock("session", :logger => Logger.new(STDOUT)))
+      resource.stub!(:define_link) # do not define links
+      resource.stub!(:loaded?).and_return(true) # should force reload even if already loaded
+      resource.raw.should be_nil
+      session.should_receive(:get).with(uri, {}).and_return(@response_200)
+      resource.load(:reload => true)
     end
     it "should correctly define the functions to access simple values" do
-      resource = Resource.new("uri", session = mock("session", :get => @raw, :logger => @logger))
+      resource = Resource.new("uri", session = mock("session", :get => @response_200, :logger => @logger))
       resource.stub!(:define_link) # do not define links
       resource.load
       resource['whatever'].should == 'whatever'
@@ -107,43 +128,71 @@ describe Resource do
       lambda{resource.clusters}.should raise_error(NoMethodError)
     end
     
-    it "should correctly define the functions to access links" do
-      resource = Resource.new("uri", session = mock("session", :get => @raw, :logger => @logger))
+    it "should correctly define a collection association" do
+      resource = Resource.new("uri", session = mock("session", :get => mock("restfully response", :body => {
+        'links' => [
+          {'rel' => 'self', 'href' => '/grid5000/sites/rennes'},
+          {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/versions', 'resolvable' => false, 'title' => 'versions'}
+        ],
+        'uid' => 'rennes'
+      }), :logger => @logger))
+      Collection.should_receive(:new).with('/grid5000/sites/rennes/versions', session, :title => 'versions', :raw => nil).and_return(collection=mock("restfully collection"))
+      resource.load
+      resource.associations['versions'].should == collection
+    end
+    it "should NOT update the URI with the self link" do
+      resource = Resource.new("uri", session = mock("session", :get => mock("restfully response", :body => {
+        'links' => [
+          {'rel' => 'self', 'href' => '/grid5000/sites/rennes'}
+        ],
+        'uid' => 'rennes'
+      }), :logger => @logger))
+      resource.uri.should == "uri"
+      resource.load
+      resource.uri.should == "uri"
+    end
+    it "should correctly define a member association" do
+      resource = Resource.new("uri", session = mock("session", :get => mock("restfully response", :body => {
+        'links' => [
+          {'rel' => 'member', 'href' => '/grid5000/sites/rennes/versions/123', 'title' => 'version'}
+        ],
+        'uid' => 'rennes'
+      }), :logger => @logger))
+      Resource.should_receive(:new).with('/grid5000/sites/rennes/versions/123', session, :title => 'version', :raw => nil).and_return(member=mock("restfully resource"))
+      resource.load
+      resource.associations['version'].should == member
+    end
+    it "should correctly define a parent association" do
+      resource = Resource.new("uri", session = mock("session", :get => mock("restfully response", :body => {
+        'links' => [
+          {'rel' => 'self', 'href' => '/grid5000/sites/rennes'},
+          {'rel' => 'parent', 'href' => '/grid5000'}
+        ],
+        'uid' => 'rennes'
+      }), :logger => @logger))
+      Resource.should_receive(:new).with('/grid5000', session).and_return(parent=mock("restfully resource"))
+      resource.load
+      resource.associations['parent'].should == parent
+    end
+    it "should ignore bad links" do
+      resource = Resource.new("uri", session = mock("session", :get => mock("restfully response", :body => {
+        'links' => [
+          {'rel' => 'self', 'href' => '/grid5000/sites/rennes'},
+          {'rel' => 'invalid_rel', 'href' => '/whatever'},
+          {'rel' => 'collection', 'href' => '/has/no/title'} 
+        ],
+        'uid' => 'rennes'
+      }), :logger => @logger))
+      resource.load
+      resource.associations.should be_empty
+    end
+    
+    it "should correctly define the functions to access links [integration test]" do
+      resource = Resource.new("uri", session = mock("session", :get => @response_200, :logger => @logger))
       @logger.should_receive(:warn).with(/collection \/has\/no\/title has no title/)
       @logger.should_receive(:warn).with(/invalid_rel is not a valid link relationship/)
-      Collection.should_receive(:new).
-        with('/sites/rennes/versions', session, 'raw' => nil, 'title' => 'versions').
-        and_return(versions=mock(Collection))
-      Collection.should_receive(:new).
-        with('/sites/rennes/clusters/versions/123', session, 'raw' => @raw['clusters'], 'title' => 'clusters').
-        and_return(clusters=mock(Collection))
-      Collection.should_receive(:new).
-        with('/sites/rennes/environments/versions/123', session, 'raw' => nil, 'title' => 'environments').
-        and_return(environments=mock(Collection))
-      Resource.should_receive(:new).
-        with('/versions/123', session, 'raw' => nil).
-        and_return(parent=mock(Resource))
-      Resource.should_receive(:new).
-        with('/sites/rennes/statuses/current', session, 'raw' => nil).
-        and_return(status=mock(Resource))
-      # associations should not exist before loading
-      resource.respond_to?(:clusters).should be_false
-      # load the resource so that associations get created
       resource.load
-      # check that functions exist
-      resource.should respond_to(:clusters)
-      clusters.should_receive(:load).and_return(clusters)
-      resource.clusters.should == clusters
-      resource.should respond_to(:environments)
-      environments.should_receive(:load).and_return(environments)
-      resource.environments.should == environments
-      resource.should respond_to(:versions)
-      versions.should_receive(:load).and_return(versions)
-      resource.versions.should == versions
-      resource.should respond_to(:status)
-      status.should_receive(:load).and_return(status)
-      resource.status.should == status
-      resource.uri.should == "/sites/rennes/versions/123" # self link should override the URI attribute
+      resource.associations.keys.should =~ ['versions', 'clusters', 'environments', 'status', 'parent', 'version']
     end
   end
 end

data/spec/restfully_spec.rb

@@ -1,5 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Restfully do
-
+  it "should have a default adapter" do
+    Restfully.adapter.should == Restfully::HTTP::Adapters::RestClientAdapter
+  end
+  
+  it "should allow setting other adapters" do
+    require 'restfully/http/adapters/patron_adapter'
+    Restfully.adapter = Restfully::HTTP::Adapters::PatronAdapter
+    Restfully.adapter.should == Restfully::HTTP::Adapters::PatronAdapter
+  end
 end

data/spec/session_spec.rb

@@ -2,20 +2,104 @@ require File.dirname(__FILE__)+'/spec_helper'
 
 include Restfully
 describe Session do
-
-  it "should have a logger reader" do
-    session = Session.new('https://api.grid5000.fr')
-    session.should_not respond_to(:logger=)
-    session.should respond_to(:logger)
-  end
-  it "should have a base_url reader" do
-    session = Session.new('https://api.grid5000.fr')
-    session.should_not respond_to(:base_url=)
-    session.base_url.should == 'https://api.grid5000.fr'
+  describe "initialization" do
+    it "should have a logger reader" do
+      session = Session.new('https://api.grid5000.fr')
+      session.should_not respond_to(:logger=)
+      session.should respond_to(:logger)
+    end
+    it "should have a base_uri reader" do
+      session = Session.new('https://api.grid5000.fr')
+      session.should_not respond_to(:base_uri=)
+      session.base_uri.should == 'https://api.grid5000.fr'
+    end
+    it "should have a root_path reader that returns the path of the root resource, relative to the base URI" do
+      session = Session.new('https://api.grid5000.fr/sid', 'root_path' => '/grid5000')
+      session.should_not respond_to(:root_path=)
+      session.root_path.should == '/grid5000'
+    end
+    it "should set the default root_path to /" do
+      session = Session.new('https://api.grid5000.fr')
+      session.root_path.should == '/'
+    end
+    it "should log to NullLogger by default" do
+      NullLogger.should_receive(:new).and_return(logger = mock(NullLogger))
+      session = Session.new('https://api.grid5000.fr')
+      session.logger.should == logger
+    end
+    it "should use the given logger" do
+      logger = mock("custom logger")
+      session = Session.new('https://api.grid5000.fr', 'logger' => logger)
+      session.logger.should == logger
+    end
+    it "should set a default Accept HTTP header if no default headers are given" do
+      session = Session.new('https://api.grid5000.fr')
+      session.default_headers.should == {
+        'Accept' => 'application/json'
+      }
+    end
+    it "should use the given default headers" do
+      session = Session.new('https://api.grid5000.fr', :default_headers => {:accept => 'application/xml'})
+      session.default_headers.should == {
+        :accept => 'application/xml'
+      }
+    end
+    it "should correctly initialize the connection" do
+      Restfully.adapter.should_receive(:new).with('https://api.grid5000.fr/sid', :user => 'crohr', :password => 'password').and_return(connection = mock("restfully connection"))
+      session = Session.new('https://api.grid5000.fr/sid', 'root_path' => '/grid5000', :user => 'crohr', :password => 'password')
+      session.connection.should == connection
+    end
+  
+    it "should initialize the root resource" do
+      session = Session.new('https://api.grid5000.fr', 'root_path' => '/grid5000', :user => 'crohr', :password => 'password')
+      session.root.should be_a Restfully::Resource
+      session.root.uri.to_s.should == '/grid5000'
+      session.root.should_not be_loaded
+    end
+  
+    it "should yield the loaded root resource and the session object" do
+      Restfully::Resource.stub!(:new).and_return(root_resource = mock(Restfully::Resource))
+      root_resource.should_receive(:load).and_return(root_resource)
+      Session.new('https://api.grid5000.fr', :root_path => '/grid5000', :user => 'crohr', :password => 'password') do |root, session|
+        session.root.should == root
+        root.should == root_resource
+      end
+    end
   end
   
-  it "should log to NullLogger by default" do
-    NullLogger.should_receive(:new)
-    session = Session.new('https://api.grid5000.fr')
+  describe "Getting resources" do
+    before(:each) do
+      @session = Session.new('https://api.grid5000.fr/sid', :root_path => '/grid5000', :user => 'crohr', :password => 'password', :default_headers => {})
+      @request = mock("restfully http request", :uri => mock("uri"), :headers => mock("headers"))
+      @response = mock("restfully http response", :status => 200, :headers => mock("headers"))
+    end
+    it "should create a new Request object and pass it to the connection" do
+      Restfully::HTTP::Request.should_receive(:new).with(URI.parse('https://api.grid5000.fr/sid/some/path'), :headers => {:cache_control => 'max-age=0'}, :query => {}).and_return(@request)
+      @session.connection.should_receive(:get).with(@request).and_return(@response)
+      @session.get('/some/path', :headers => {:cache_control => 'max-age=0'}).should == @response
+    end
+    it "should not use the base_url if the path is a complete url" do
+      Restfully::HTTP::Request.should_receive(:new).with(URI.parse('http://somehost.com/some/path'), :headers => {}, :query => {}).and_return(@request)
+      @session.connection.should_receive(:get).with(@request).and_return(@response)
+      @session.get('http://somehost.com/some/path').should == @response
+    end
+    it "should add the session's default headers to the request's headers" do
+      Restfully::HTTP::Request.should_receive(:new).with(URI.parse('http://somehost.com/some/path'), :headers => {}, :query => {}).and_return(@request)
+      @session.default_headers['cache-control'] = 'max-age=0'
+      @request.should_receive(:add_headers).with('cache-control' => 'max-age=0')
+      @session.connection.should_receive(:get).with(@request).and_return(@response)
+      @session.get('http://somehost.com/some/path').should == @response
+    end
+    it "should raise a Restfully::HTTP::ClientError error on 4xx errors" do
+      Restfully::HTTP::Request.should_receive(:new).with(URI.parse('http://somehost.com/some/path'), :headers => {}, :query => {}).and_return(@request)
+      @session.connection.should_receive(:get).with(@request).and_return(response = mock("404 response", :status => 404, :body => {'code' => 404, 'message' => 'The requested resource cannot be found.', 'title' => 'Not Found'}, :headers => mock("headers")))
+      lambda{ @session.get('http://somehost.com/some/path') }.should raise_error(Restfully::HTTP::ClientError, "404 Not Found. The requested resource cannot be found.")
+    end
+    it "should raise a Restfully::HTTP::ServerError error on 4xx errors" do
+      Restfully::HTTP::Request.should_receive(:new).with(URI.parse('http://somehost.com/some/path'), :headers => {}, :query => {}).and_return(@request)
+      @session.connection.should_receive(:get).with(@request).and_return(response = mock("404 response", :status => 500, :body => {'code' => 500, 'message' => 'Something went wrong.', 'title' => 'Internal Server Error'}, :headers => mock("headers")))
+      lambda{ @session.get('http://somehost.com/some/path') }.should raise_error(Restfully::HTTP::ServerError, "500 Internal Server Error. Something went wrong.")
+    end
   end
+  
 end

data/spec/spec_helper.rb

@@ -1,10 +1,12 @@
-require 'rubygems'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'restfully'
 require 'spec'
 require 'spec/autorun'
 
+def fixture(filename)
+  File.read(File.join(File.dirname(__FILE__), "fixtures", filename))
+end
 
 Spec::Runner.configure do |config|
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: crohr-restfully
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 -07:00
+date: 2009-09-17 00:00:00 -07:00
 default_executable: restfully
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: "1.0"
     version: 
 description: Experimental code for auto-generation of wrappers on top of RESTful APIs that follow HATEOAS principles and provide OPTIONS methods and/or Allow headers.
 email: cyril.rohr@gmail.com
@@ -37,12 +37,22 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- TODO.rdoc
 - VERSION
 - bin/restfully
 - examples/grid5000.rb
 - lib/restfully.rb
 - lib/restfully/collection.rb
+- lib/restfully/error.rb
 - lib/restfully/extensions.rb
+- lib/restfully/http.rb
+- lib/restfully/http/adapters/abstract_adapter.rb
+- lib/restfully/http/adapters/patron_adapter.rb
+- lib/restfully/http/adapters/rest_client_adapter.rb
+- lib/restfully/http/error.rb
+- lib/restfully/http/headers.rb
+- lib/restfully/http/request.rb
+- lib/restfully/http/response.rb
 - lib/restfully/link.rb
 - lib/restfully/parsing.rb
 - lib/restfully/resource.rb
@@ -51,7 +61,14 @@ files:
 - lib/restfully/special_hash.rb
 - restfully.gemspec
 - spec/collection_spec.rb
+- spec/fixtures/grid5000-sites.json
+- spec/http/error_spec.rb
+- spec/http/headers_spec.rb
+- spec/http/request_spec.rb
+- spec/http/response_spec.rb
+- spec/http/rest_client_adapter_spec.rb
 - spec/link_spec.rb
+- spec/parsing_spec.rb
 - spec/resource_spec.rb
 - spec/restfully_spec.rb
 - spec/session_spec.rb
@@ -78,14 +95,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: restfully
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Experimental code for auto-generation of wrappers on top of RESTful APIs that follow some specific conventions.
 test_files: 
 - spec/collection_spec.rb
+- spec/http/error_spec.rb
+- spec/http/headers_spec.rb
+- spec/http/request_spec.rb
+- spec/http/response_spec.rb
+- spec/http/rest_client_adapter_spec.rb
 - spec/link_spec.rb
+- spec/parsing_spec.rb
 - spec/resource_spec.rb
 - spec/restfully_spec.rb
 - spec/session_spec.rb