restfully 0.2.1

data/restfully.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{restfully}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cyril Rohr"]
+  s.date = %q{2009-09-17}
+  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}
+  s.executables = ["restfully"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "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",
+     "lib/restfully/session.rb",
+     "lib/restfully/special_array.rb",
+     "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",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/crohr/restfully}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{restfully}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Experimental code for auto-generation of wrappers on top of RESTful APIs that follow some specific conventions.}
+  s.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",
+     "spec/spec_helper.rb",
+     "examples/grid5000.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 1.0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 1.0"])
+  end
+end

data/spec/collection_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__)+'/spec_helper'
+
+include Restfully
+describe Collection do
+
+  it "should have all methods of a hash" do
+    collection = Collection.new("uri", session=mock('session'))
+    collection.size.should == 0
+    collection.store("rennes", resource = mock(Resource))
+    collection.size.should == 1
+    collection.should == {'rennes' => resource}
+    collection.should respond_to(:each)
+    collection.should respond_to(:store)
+    collection.should respond_to(:[])
+    collection.should respond_to(:length)
+  end
+  
+  
+  
+  describe "loading" do
+    before(:all) do
+      @raw = fixture("grid5000-sites.json")
+      @response_200 = Restfully::HTTP::Response.new(200, {'Content-Type' => 'application/json;charset=utf-8', 'Content-Length' => @raw.length}, @raw)
+      @logger = Logger.new(STDOUT)
+    end
+    it "should not load if already loaded and no :reload" do
+      collection = Collection.new("uri", mock("session"))
+      collection.should_receive(:loaded?).and_return(true)
+      collection.load(:reload => false).should == collection
+    end
+    it "should load when :reload param is true [already loaded]" do
+      collection = Collection.new("uri", session=mock("session", :logger => Logger.new(STDOUT)))
+      collection.should_receive(:loaded?).and_return(true)
+      session.should_receive(:get).and_return(@response_200)
+      collection.load(:reload => true).should == collection    
+    end
+    it "should load when force_reload is true [not loaded]" do
+      collection = Collection.new("uri", session=mock("session", :logger => Logger.new(STDOUT)))
+      collection.should_receive(:loaded?).and_return(false)
+      session.should_receive(:get).and_return(@response_200)
+      collection.load(:reload => true).should == collection    
+    end
+    it "should force reload when query parameters are given" do
+      collection = Collection.new("uri", session=mock("session", :logger => Logger.new(STDOUT)))
+      session.should_receive(:get).and_return(@response_200)
+      collection.load(:query => {:q1 => 'v1'}).should == collection
+    end
+    it "should not initialize resources lacking a self link" do
+      collection = Collection.new("uri", session = mock("session", :get => mock("restfully response", :body => {
+        'rennes' => {
+          'links' => [
+            {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/versions', 'resolvable' => false, 'title' => 'versions'}
+          ],
+          'uid' => 'rennes'
+        }
+      }), :logger => @logger))
+      Resource.should_not_receive(:new)
+      collection.load
+      collection['rennes'].should be_nil
+    end
+    it "should initialize resources having a self link" do
+      collection = Collection.new("uri", session = mock("session", :get => mock("restfully response", :body => {
+        'rennes' => {
+          'links' => [
+            {'rel' => 'self', 'href' => '/grid5000/sites/rennes'},
+            {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/versions', 'resolvable' => false, 'title' => 'versions'}
+          ],
+          'uid' => 'rennes'
+        }
+      }), :logger => @logger))
+      Resource.should_receive(:new).with('/grid5000/sites/rennes', session, :raw => {
+        'links' => [
+          {'rel' => 'self', 'href' => '/grid5000/sites/rennes'},
+          {'rel' => 'collection', 'href' => '/grid5000/sites/rennes/versions', 'resolvable' => false, 'title' => 'versions'}
+        ],
+        'uid' => 'rennes'
+      }).and_return(resource=mock("restfully resource"))
+      resource.should_receive(:load).and_return(resource)
+      collection.load
+      collection['rennes'].should == resource
+    end
+    it "should correctly initialize its resources [integration test]" do
+      collection = Collection.new("uri", session=mock("session", :logger => Logger.new(STDOUT), :get => @response_200))
+      collection.load
+      collection.should be_loaded
+      collection.uri.should == "uri"
+      collection['rennes'].uid.should == 'rennes'
+      collection['rennes'].type.should == 'site'
+      collection.keys.should =~ ['rennes', 'lille', 'bordeaux', 'nancy', 'sophia', 'toulouse', 'lyon', 'grenoble', 'orsay']
+    end 
+  end
+  
+end

data/spec/fixtures/grid5000-sites.json

@@ -0,0 +1,489 @@
+{
+  "lille": {
+    "name": "Lille",
+    "latitude": 50.65,
+    "location": "Lille, France",
+    "security_contact": null,
+    "uid": "lille",
+    "type": "site",
+    "user_support_contact": null,
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/lille",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/lille\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/lille\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/lille\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/lille\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/lille\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "",
+    "longitude": 3.0833,
+    "email_contact": null,
+    "web": null,
+    "sys_admin_contact": null
+  },
+  "grenoble": {
+    "name": "Grenoble",
+    "latitude": 45.1833,
+    "location": "Grenoble, France",
+    "security_contact": null,
+    "uid": "grenoble",
+    "type": "site",
+    "user_support_contact": null,
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/grenoble",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/grenoble\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/grenoble\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/grenoble\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/grenoble\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/grenoble\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "",
+    "longitude": 5.7167,
+    "email_contact": null,
+    "web": null,
+    "sys_admin_contact": null
+  },
+  "toulouse": {
+    "name": "Toulouse",
+    "latitude": 43.6167,
+    "location": "Toulouse, France",
+    "security_contact": null,
+    "uid": "toulouse",
+    "type": "site",
+    "user_support_contact": null,
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/toulouse",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/toulouse\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/toulouse\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/toulouse\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/toulouse\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/toulouse\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "",
+    "longitude": 1.4333,
+    "email_contact": null,
+    "web": null,
+    "sys_admin_contact": null
+  },
+  "sophia": {
+    "name": "Sophia-Antipolis",
+    "latitude": 43.6161,
+    "location": "Sophia-Antipolis, France",
+    "security_contact": "sophia-staff@lists.grid5000.fr",
+    "uid": "sophia",
+    "type": "site",
+    "user_support_contact": "sophia-staff@lists.grid5000.fr",
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/sophia",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/sophia\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/sophia\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/sophia\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/sophia\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/sophia\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "",
+    "longitude": 7.0678,
+    "compilation_server": true,
+    "email_contact": "sophia-staff@lists.grid5000.fr",
+    "web": null,
+    "sys_admin_contact": "sophia-staff@lists.grid5000.fr"
+  },
+  "rennes": {
+    "name": "Rennes",
+    "latitude": 48.1,
+    "location": "Rennes, France",
+    "security_contact": "rennes-staff@lists.grid5000.fr",
+    "uid": "rennes",
+    "type": "site",
+    "user_support_contact": "rennes-staff@lists.grid5000.fr",
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/rennes",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/rennes\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/rennes\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/rennes\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/rennes\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/rennes\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "",
+    "longitude": -1.6667,
+    "compilation_server": false,
+    "email_contact": "rennes-staff@lists.grid5000.fr",
+    "web": "http:\/\/www.irisa.fr",
+    "sys_admin_contact": "rennes-staff@lists.grid5000.fr"
+  },
+  "lyon": {
+    "name": "Lyon",
+    "latitude": 45.7667,
+    "location": "Lyon, France",
+    "security_contact": null,
+    "uid": "lyon",
+    "type": "site",
+    "user_support_contact": null,
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/lyon",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/lyon\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/lyon\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/lyon\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/lyon\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/lyon\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "",
+    "longitude": 4.8333,
+    "email_contact": null,
+    "web": null,
+    "sys_admin_contact": null
+  },
+  "nancy": {
+    "name": "Nancy",
+    "latitude": 48.7,
+    "location": "Nancy, France",
+    "security_contact": null,
+    "uid": "nancy",
+    "type": "site",
+    "user_support_contact": null,
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/nancy",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/nancy\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/nancy\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/nancy\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/nancy\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/nancy\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "",
+    "longitude": 6.2,
+    "web": null,
+    "sys_admin_contact": null
+  },
+  "bordeaux": {
+    "name": "Bordeaux",
+    "latitude": 44.833333,
+    "location": "Bordeaux, France",
+    "security_contact": "bordeaux-staff@lists.grid5000.fr",
+    "uid": "bordeaux",
+    "type": "site",
+    "user_support_contact": "bordeaux-staff@lists.grid5000.fr",
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/bordeaux",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/bordeaux\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/bordeaux\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/bordeaux\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/bordeaux\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/bordeaux\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "Grid5000 Bordeaux site",
+    "longitude": -0.566667,
+    "email_contact": "bordeaux-staff@lists.grid5000.fr",
+    "web": "http:\/\/www.grid5000.fr\/mediawiki\/index.php\/Bordeaux:Home",
+    "sys_admin_contact": "bordeaux-staff@lists.grid5000.fr"
+  },
+  "orsay": {
+    "name": "Orsay",
+    "latitude": 48.7,
+    "location": "Orsay, France",
+    "security_contact": null,
+    "uid": "orsay",
+    "type": "site",
+    "user_support_contact": null,
+    "version": "747d2af24c5f3c2578a96626e0b00413c8484f04",
+    "links": [
+      {
+        "href": "\/grid5000\/sites\/orsay",
+        "rel": "self"
+      },
+      {
+        "href": "\/grid5000\/sites\/orsay\/versions\/747d2af24c5f3c2578a96626e0b00413c8484f04",
+        "title": "version",
+        "rel": "member"
+      },
+      {
+        "href": "\/grid5000\/sites\/orsay\/versions",
+        "title": "versions",
+        "rel": "collection"
+      },
+      {
+        "href": "\/grid5000\/sites\/orsay\/clusters",
+        "resolvable": true,
+        "title": "clusters",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000\/sites\/orsay\/environments",
+        "resolvable": true,
+        "title": "environments",
+        "rel": "collection",
+        "resolved": false
+      },
+      {
+        "href": "\/grid5000",
+        "rel": "parent"
+      },
+      {
+        "href": "\/grid5000\/sites\/orsay\/status",
+        "title": "status",
+        "rel": "collection"
+      }
+    ],
+    "description": "",
+    "longitude": 2.2,
+    "email_contact": null,
+    "web": null,
+    "sys_admin_contact": null
+  }
+}