restfully 0.7.0.pre → 0.7.1.pre

data/bin/restfully

@@ -9,6 +9,13 @@ require 'optparse'
 require 'logger'
 require 'pp'
 
+# Behaviour of pp in IRB is different on ruby1.9:
+# * pp(object) returns object#inspect.
+# * we prefer the behaviour of ruby1.8 where pp returns nil.
+alias :old_pp :pp 
+def pp(*args)
+  old_pp(*args); nil
+end
 
 logger = Logger.new(STDERR)
 logger.level = Logger::WARN
@@ -67,13 +74,12 @@ end
 if given_uri = ARGV.shift
   @options["uri"] = given_uri
 end
-# p @options
+
 # Compatibility with restfully < 0.6
 @options["uri"] ||= @options.delete("base_uri")
 
 @session = Restfully::Session.new(@options)
 
-
 def session
   @session
 end

data/lib/restfully/collection.rb

@@ -45,6 +45,7 @@ module Restfully
         end
         block.call @items[hash]
       end
+      self
     end
 
     def length
@@ -79,12 +80,7 @@ module Restfully
     #     resource.uri == uri_to_find
     #   }
     # end
-    
-    protected
-    def reload_if_empty(resource)
-      resource.reload if resource && !resource.media_type.complete?
-      resource
-    end
+
 
   end
 

data/lib/restfully/http/request.rb

@@ -49,10 +49,36 @@ module Restfully
         end
       end
       
+      def inspect
+        [
+          "#{method.to_s.upcase} #{uri.to_s}",
+          head.map{|(k,v)| "#{k}: #{v}"}.join("\n"),
+          body
+        ].compact.join("\n")
+      end
+      
       def no_cache?
         head['Cache-Control'] && head['Cache-Control'].include?('no-cache')
       end
       
+      def no_cache!
+        @forced_cache = true
+        head['Cache-Control'] = 'no-cache'
+      end
+      
+      def forced_cache?
+        !!@forced_cache
+      end
+      
+      def remove_no_cache!
+        @forced_cache = false
+        if head['Cache-Control']
+          head['Cache-Control'] = head['Cache-Control'].split(/\s+,\s+/).reject{|v| 
+            v =~ /no-cache/i
+          }.join(",")
+        end
+      end
+      
       protected
       def build_head(options = {})
         sanitize_head(
@@ -67,7 +93,7 @@ module Restfully
             type = MediaType.find('application/x-www-form-urlencoded')
             options[:head]['Content-Type'] = type.default_type
           end
-          type.serialize(options[:body], :uri => options[:uri])
+          type.serialize(options[:body], :serialization => options[:serialization])
         else
           nil
         end

data/lib/restfully/media_type/application_vnd_bonfire_xml.rb

@@ -17,19 +17,30 @@ module Restfully
               io = io.read
             end
             xml = XML::Document.string(io.to_s)
-            load_xml(xml.root).merge(HIDDEN_TYPE_KEY => xml.root.name)
+            h = load_xml(xml.root)
+            h[HIDDEN_TYPE_KEY] = if h['items']
+              if xml.root.attributes["href"]
+                xml.root.attributes["href"].
+                split("/").last.gsub(/s$/,'')+"_collection"
+              elsif h['items'].length > 0
+                h['items'][0][HIDDEN_TYPE_KEY]
+              else
+                nil
+              end
+            else
+              xml.root.name
+            end
+            h
           end
 
 
           def dump(object, opts = {})
-            root_name = if object[HIDDEN_TYPE_KEY]
+            root_name = if opts[:serialization]
+              opts[:serialization][HIDDEN_TYPE_KEY].gsub(/\_collection$/,'')
+            elsif object[HIDDEN_TYPE_KEY]
               object[HIDDEN_TYPE_KEY]
-            elsif opts[:uri]
-              # OK, this is ugly
-              opts[:uri].path.to_s.split("/").last.gsub(/s$/,'')
-            else
-              fail "Can't infer a name for the root element for object: #{object.inspect}"
             end
+            fail "Can't infer a root element name for object: #{object.inspect}" if root_name.nil?
             xml = XML::Document.new
             xml.root = XML::Node.new(root_name)
             xml.root["xmlns"] = NS
@@ -41,6 +52,8 @@ module Restfully
 
           def load_xml(element)
             h = {}
+
+
             element.each_element do |e|
               next if e.empty?
               if e.name == 'items' && element.name == 'collection'
@@ -66,7 +79,8 @@ module Restfully
             h
           end
 
-          # We use <tt>HIDDEN_TYPE_KEY</tt> property to keep track of the root name.
+          # We use <tt>HIDDEN_TYPE_KEY</tt> property to keep track of the root
+          # name.
           def load_xml_element(element, h)
             if element.attributes? && href = element.attributes.find{|attr|
               attr.name == "href"
@@ -75,7 +89,20 @@ module Restfully
               #build_resource(href.value))
             else
               if element.children.any?(&:element?)
-                single_or_array(h, element.name, load_xml(element))
+                # This includes ["computes", "networks", "storages"] section
+                # of an experiment.
+                if element.children.select(&:element?).map{|c|
+                   c.name
+                }.all?{|n| 
+                  "#{n}s" == element.name
+                }
+                  element.each_element {|e| 
+                    e.name = element.name
+                    load_xml_element(e, h)
+                  }
+                else
+                  single_or_array(h, element.name, load_xml(element))
+                end
               else
                 value = element.content.strip
                 unless value.empty?
@@ -92,7 +119,7 @@ module Restfully
               else
                 h[key] = [h[key], value]
               end
-            elsif ["disk", "nic", "link"].include?(key)
+            elsif ["disk", "nic", "link", "computes", "networks", "storages"].include?(key)
               h[key] = [value]
             else
               h[key] = value

data/lib/restfully/resource.rb

@@ -8,6 +8,8 @@ module Restfully
   class Resource
     attr_reader :response, :request, :session
 
+    HIDDEN_PROPERTIES_REGEXP = /^\_\_(.+)\_\_$/
+
     def initialize(session, response, request)
       @session = session
       @response = response
@@ -23,6 +25,7 @@ module Restfully
     #   resource["uid"]
     #   => "rennes"
     def [](key)
+      reload_if_empty(self)
       media_type.property(key)
     end
 
@@ -53,6 +56,7 @@ module Restfully
       # Send a GET request only if given a different set of options
       if @request.update!(options) || @request.no_cache?
         @response = session.execute(@request)
+        @request.remove_no_cache! if @request.forced_cache?
         if session.process(@response, @request)
           @associations.clear
         else
@@ -64,22 +68,29 @@ module Restfully
     end
     
     def relationships
-      @associations.keys
+      response.links.map(&:id).sort
     end
     
     def properties
       media_type.property.reject{|k,v|        
         # do not return keys used for internal use
-        k.to_s =~ /^\_\_(.+)\_\_$/
+        k.to_s =~ HIDDEN_PROPERTIES_REGEXP
       }
     end
     
+    # For the following methods, maybe it's better to always go through the
+    # cache instead of explicitly saying @request.no_cache! (and update the
+    # #load method accordingly)
+    
+    # Force reloading of the request
     def reload
-      load(:head => {'Cache-Control' => 'no-cache'})      
+      @request.no_cache!
+      load
     end
 
     def submit(*args)
       if allow?(:post)
+        @request.no_cache!
         payload, options = extract_payload_from_args(args)
         session.post(request.uri, payload, options)
       else
@@ -89,6 +100,7 @@ module Restfully
 
     def delete(options = {})
       if allow?(:delete)
+        @request.no_cache!
         session.delete(request.uri)
       else
         raise MethodNotAllowed
@@ -97,6 +109,7 @@ module Restfully
 
     def update(*args)
       if allow?(:put)
+        @request.no_cache!
         payload, options = extract_payload_from_args(args)
         session.put(request.uri, payload, options)
       else
@@ -150,26 +163,26 @@ module Restfully
         yield pp if block_given?
       end
       pp.text ">"
+      nil
     end
 
+    
+
     def build
+      metaclass = class << self; self; end
       # only build once
-      if @associations.empty?
+      # if @associations.empty?
         extend Collection if collection?
 
         response.links.each do |link|
-          @associations[link.id] = nil
-          
-          self.class.class_eval do
-            define_method link.id do |*args|
-              @associations[link.id] ||= session.get(link.href, :head => {
-                'Accept' => link.type
-              }).load(*args)
-            end
+          metaclass.send(:define_method, link.id.to_sym) do |*args|
+            session.get(link.href, :head => {
+              'Accept' => link.type
+            }).load(*args)
           end
           
         end
-      end
+      # end
       self
     end
 
@@ -182,12 +195,18 @@ module Restfully
       payload = args.shift || options
       
       options = {
-        :head => head, :query => query
+        :head => head, :query => query,
+        :serialization => media_type.property.reject{|k,v| 
+          k !~ HIDDEN_PROPERTIES_REGEXP
+        }
       }
       
       [payload, options]
     end
     
-
+    def reload_if_empty(resource)
+      resource.reload if resource && !resource.media_type.complete?
+      resource
+    end
   end
 end

data/lib/restfully/session.rb

@@ -115,6 +115,7 @@ module Restfully
         :headers => request.head
       )
 
+      logger.debug request.inspect
       code, head, body = resource.send(request.method, request.body || {})
 
       response = Restfully::HTTP::Response.new(self, code, head, body)

data/lib/restfully/version.rb

@@ -1,3 +1,3 @@
 module Restfully
-  VERSION = "0.7.0.pre"
+  VERSION = "0.7.1.pre"
 end

data/spec/fixtures/bonfire-empty-collection.xml

@@ -1,4 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<collection xmlns="http://api.bonfire-project.eu/doc/schemas/occi">
-  <items/>
+<collection xmlns="http://api.bonfire-project.eu/doc/schemas/occi" href="/experiments/12/networks">
+  <items offset="0" total="0">
+  </items>
+  <link href="/experiments/12" rel="parent" type="application/vnd.bonfire+xml"/>
 </collection>

data/spec/fixtures/bonfire-experiment.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<experiment href="/experiments/12" xmlns="http://api.bonfire-project.eu/doc/schemas/occi">
+  <id>12</id>
+  <description>description expe1</description>
+  <name>expe1</name>
+  <walltime>2011-04-28T16:16:34Z</walltime>
+  <user_id>crohr</user_id>
+  <status>running</status>
+  <networks>
+  </networks>
+  <computes>
+    <compute href="/locations/fr-inria/computes/76" name="compute expe1"/>
+    <compute href="/locations/uk-epcc/computes/47" name="compute2 expe1"/>
+    <compute href="/locations/uk-epcc/computes/48" name="compute2 expe1"/>
+  </computes>
+  <storages>
+    <storage href="/locations/uk-epcc/storages/44" name="data"/>
+  </storages>
+  <link rel="parent" href="/"/>
+  <link rel="storages" href="/experiments/12/storages"/>
+  <link rel="networks" href="/experiments/12/networks"/>
+  <link rel="computes" href="/experiments/12/computes"/>
+</experiment>

data/spec/restfully/collection_spec.rb

@@ -38,6 +38,7 @@ describe Restfully::Collection do
     items = []
     @resource.load.each{|i| items << i}
     items.all?{|i| i.kind_of?(Restfully::Resource)}.should be_true
+    pp items
     items[0].relationships.map(&:to_s).sort.should == ["parent", "self"]
     items[0]['uid'].should == 376505
   end

data/spec/restfully/http/request_spec.rb

@@ -92,6 +92,15 @@ describe Restfully::HTTP::Request do
         should == 'application/json'
       request.body.should == @options[:body]
     end
+    
+    it "should correctly build the request [body as Hash, content-type=xml]" do
+      Restfully::MediaType.register Restfully::MediaType::ApplicationVndBonfireXml
+      @options[:body] = {"name" => "whatever"}
+      @options[:head][:content_type] = 'application/vnd.bonfire+xml'
+      @options[:serialization] = {"__type__" => "network"}
+      request = Restfully::HTTP::Request.new(@session, :post, "/path", @options)
+      request.body.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<network xmlns=\"http://api.bonfire-project.eu/doc/schemas/occi\">\n  <name>whatever</name>\n</network>\n"
+    end
   end
 
 end

data/spec/restfully/media_type/application_vnd_bonfire_xml_spec.rb

@@ -28,11 +28,18 @@ describe Restfully::MediaType::ApplicationVndBonfireXml do
       )
       media.property.should == {"name"=>"Private LAN", "public"=>"YES", "id"=>"29", "__type__"=>"network", "link"=>[{"href"=>"/locations/de-hlrs/networks/29", "rel"=>"self"}]}
     end
+    
+    it "should build the Hash from the XML doc [resource] 3" do
+      media = Restfully::MediaType::ApplicationVndBonfireXml.new(
+        fixture("bonfire-experiment.xml"), @session
+      )
+      media.property.should == {"name"=>"expe1", "walltime"=>"2011-04-28T16:16:34Z", "id"=>"12", "__type__"=>"experiment", "user_id"=>"crohr", "storages"=>[{"name"=>"data", "href"=>"/locations/uk-epcc/storages/44"}], "description"=>"description expe1", "computes"=>[{"name"=>"compute expe1", "href"=>"/locations/fr-inria/computes/76"}, {"name"=>"compute2 expe1", "href"=>"/locations/uk-epcc/computes/47"}, {"name"=>"compute2 expe1", "href"=>"/locations/uk-epcc/computes/48"}], "link"=>[{"href"=>"/", "rel"=>"parent"}, {"href"=>"/experiments/12/storages", "rel"=>"storages"}, {"href"=>"/experiments/12/networks", "rel"=>"networks"}, {"href"=>"/experiments/12/computes", "rel"=>"computes"}, {"href"=>"/experiments/12", "rel"=>"self"}], "status"=>"running"}
+    end
   
     it "should build the Hash from the XML doc [collection]" do
       media = Restfully::MediaType::ApplicationVndBonfireXml.new(@collection, @session)
       media.should be_collection
-      media.property.should == {"items"=>[{"address"=>"10.0.0.1", "name"=>"Network1", "size"=>"C", "__type__"=>"network", "description"=>"Network1 description", "link"=>[{"href"=>"/locations/fr-inria", "rel"=>"location"}, {"href"=>"/locations/fr-inria/networks/1", "rel"=>"self"}], "visibility"=>"public"}, {"address"=>"10.0.0.1", "name"=>"Network2", "size"=>"C", "__type__"=>"network", "description"=>"Network2 description", "link"=>[{"href"=>"/locations/fr-inria", "rel"=>"location"}, {"href"=>"/locations/fr-inria/networks/2", "rel"=>"self"}], "visibility"=>"private"}], "total"=>2, "offset"=>0, "__type__"=>"collection", "link"=>[{"href"=>"/locations/fr-inria/networks?limit=20", "rel"=>"top", "type"=>"application/vnd.bonfire+xml"}, {"href"=>"/locations/fr-inria", "rel"=>"parent", "type"=>"application/vnd.bonfire+xml"}, {"href"=>"/locations/fr-inria/networks", "rel"=>"self"}]}
+      media.property.should == {"items"=>[{"address"=>"10.0.0.1", "name"=>"Network1", "size"=>"C", "__type__"=>"network", "description"=>"Network1 description", "link"=>[{"href"=>"/locations/fr-inria", "rel"=>"location"}, {"href"=>"/locations/fr-inria/networks/1", "rel"=>"self"}], "visibility"=>"public"}, {"address"=>"10.0.0.1", "name"=>"Network2", "size"=>"C", "__type__"=>"network", "description"=>"Network2 description", "link"=>[{"href"=>"/locations/fr-inria", "rel"=>"location"}, {"href"=>"/locations/fr-inria/networks/2", "rel"=>"self"}], "visibility"=>"private"}], "total"=>2, "offset"=>0, "__type__"=>"network_collection", "link"=>[{"href"=>"/locations/fr-inria/networks?limit=20", "rel"=>"top", "type"=>"application/vnd.bonfire+xml"}, {"href"=>"/locations/fr-inria", "rel"=>"parent", "type"=>"application/vnd.bonfire+xml"}, {"href"=>"/locations/fr-inria/networks", "rel"=>"self"}]}
     end
   
     it "should build the Hash from the XML doc [empty collection]" do
@@ -145,7 +152,7 @@ describe Restfully::MediaType::ApplicationVndBonfireXml do
     it "should correctly serialize a resource" do
       serialized = Restfully::MediaType::ApplicationVndBonfireXml.serialize(
         @expected_compute_hash,
-        :uri => Addressable::URI.parse('http://path/to/computes')
+        :serialization => {"__type__" => "compute"}
       )
       serialized.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<compute xmlns=\"http://api.bonfire-project.eu/doc/schemas/occi\">\n  <startup href=\"file:///path/to/startup-script/sh\"/>\n  <name>Compute name</name>\n  <instance_type>small</instance_type>\n  <link href=\"/locations/fr-inria\" rel=\"location\" type=\"application/vnd.bonfire+xml\"/>\n  <link href=\"/locations/uk-epcc/computes/1\" rel=\"self\"/>\n  <context>\n    <bonfire_credentials>crohr:p4ssw0rd</bonfire_credentials>\n    <monitoring_ip>123.123.123.2</monitoring_ip>\n  </context>\n  <nic>\n    <device>eth0</device>\n    <mac>AA:AA:AA:AA</mac>\n    <network href=\"/locations/fr-inria/networks/1\"/>\n    <ip>123.123.123.123</ip>\n  </nic>\n  <nic>\n    <device>eth1</device>\n    <mac>BB:BB:BB:BB</mac>\n    <network href=\"/locations/fr-inria/networks/2\"/>\n    <ip>123.123.124.2</ip>\n  </nic>\n  <description>Compute description</description>\n  <disk>\n    <type>OS</type>\n    <storage href=\"/locations/fr-inria/storages/1\"/>\n    <target>sda</target>\n  </disk>\n  <disk>\n    <type>CDROM</type>\n    <storage href=\"/locations/fr-inria/storages/2\"/>\n    <target>sdc</target>\n  </disk>\n  <state>ACTIVE</state>\n</compute>\n"
     end

data/spec/restfully/resource_spec.rb

@@ -56,7 +56,8 @@ describe Restfully::Resource do
         @resource.uri,
         'some payload',
         :head => {'Content-Type' => 'text/plain'},
-        :query => {:k1 => 'v1'}
+        :query => {:k1 => 'v1'},
+        :serialization => {}
       )
       @resource.submit(
         'some payload', 
@@ -70,7 +71,8 @@ describe Restfully::Resource do
         @resource.uri,
         {:key => 'value'},
         :head => {'Content-Type' => 'text/plain'},
-        :query => {:k1 => 'v1'}
+        :query => {:k1 => 'v1'},
+        :serialization => {}
       )
       @resource.submit(
         :key => 'value', 
@@ -78,10 +80,37 @@ describe Restfully::Resource do
         :query => {:k1 => 'v1'}
       )
     end
+    it "should pass hidden properties as serialization parameters" do
+      Restfully::MediaType.register Restfully::MediaType::ApplicationVndBonfireXml
+      @request = Restfully::HTTP::Request.new(
+        @session, :get, "/locations/de-hlrs/networks/29",
+        :head => {'Accept' => 'application/vnd.bonfire+xml'}
+      )
+      @response = Restfully::HTTP::Response.new(
+        @session, 200, {
+          'Content-Type' => 'application/vnd.bonfire+xml; charset=utf-8',
+          'Allow' => 'GET'
+        }, fixture('bonfire-network-existing.xml')
+      )
+      @resource = Restfully::Resource.new(@session, @response, @request).load
+      @resource.should_receive(:allow?).with(:put).and_return(true)
+      @session.should_receive(:put).with(
+        @resource.uri,
+        {:key => 'value'},
+        :head => {'Content-Type' => 'text/plain'},
+        :query => {:k1 => 'v1'},
+        :serialization => {"__type__"=>"network"}
+      )
+      @resource.update(
+        :key => 'value', 
+        :headers => {'Content-Type' => 'text/plain'},
+        :query => {:k1 => 'v1'}
+      )
+    end
     
     it "should reload the resource" do
+      @request.should_receive(:no_cache!)
       @resource.should_receive(:load).
-        with(:head => {'Cache-Control' => 'no-cache'}).
         and_return(@resource)
       @resource.reload.should == @resource
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: restfully
 version: !ruby/object:Gem::Version 
-  hash: 961916028
+  hash: 961916024
   prerelease: 6
   segments: 
   - 0
   - 7
-  - 0
+  - 1
   - pre
-  version: 0.7.0.pre
+  version: 0.7.1.pre
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -213,6 +213,7 @@ files:
 - spec/fixtures/bonfire-compute-existing.xml
 - spec/fixtures/bonfire-empty-collection.xml
 - spec/fixtures/bonfire-experiment-collection.xml
+- spec/fixtures/bonfire-experiment.xml
 - spec/fixtures/bonfire-network-collection.xml
 - spec/fixtures/bonfire-network-existing.xml
 - spec/fixtures/bonfire-root.xml
@@ -272,6 +273,7 @@ test_files:
 - spec/fixtures/bonfire-compute-existing.xml
 - spec/fixtures/bonfire-empty-collection.xml
 - spec/fixtures/bonfire-experiment-collection.xml
+- spec/fixtures/bonfire-experiment.xml
 - spec/fixtures/bonfire-network-collection.xml
 - spec/fixtures/bonfire-network-existing.xml
 - spec/fixtures/bonfire-root.xml