restfully 0.5.2 → 0.5.3

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.5.3
+* can handle text/* content, useful when using low-level methods on a session object (session.{get,post,delete,put})
+* can now find a collection item using collection[:symbol] even if item uid is an integer: collection[:'12345']
+* default_headers no longer overwrite custom headers set by user
+* fixed bug with latest version of rest-client
+
 0.5.2
 * support for DELETE requests. Use resource.delete(options)
 * fixed bug in resource.load(:reload => true)

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "cyril.rohr@gmail.com"
     gem.homepage = "http://github.com/crohr/restfully"
     gem.authors = ["Cyril Rohr"]
-    gem.add_dependency "rest-client", '>= 1.0'
+    gem.add_dependency "rest-client", '>= 1.3'
     gem.add_dependency "backports"
     gem.rubyforge_project = 'restfully'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.5.3

data/lib/restfully.rb

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

data/lib/restfully/collection.rb

@@ -33,7 +33,7 @@ module Restfully
     # 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} || find{|i| i['uid'] == property.to_s.to_i}
       else
         super(property)
       end
@@ -77,15 +77,15 @@ module Restfully
 
     
     def pretty_print(pp)
-      super(pp) do |pp|
+      super(pp) do |inner_pp|
         if @items.length > 0
-          pp.breakable
-          pp.text "ITEMS (#{self["offset"]}..#{self["offset"]+@items.length})/#{self["total"]}"
-          pp.nest 2 do
+          inner_pp.breakable
+          inner_pp.text "ITEMS (#{self["offset"]}..#{self["offset"]+@items.length})/#{self["total"]}"
+          inner_pp.nest 2 do
             @items.each_with_index do |item, i|
-              pp.breakable
-              pp.text "#<#{item.class}:0x#{item.object_id.to_s(16)} uid=#{item['uid'].inspect}>"            
-              pp.text "," if i < @items.length-1
+              inner_pp.breakable
+              inner_pp.text "#<#{item.class}:0x#{item.object_id.to_s(16)} uid=#{item['uid'].inspect}>"            
+              inner_pp.text "," if i < @items.length-1
             end
           end
         end

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

@@ -46,8 +46,8 @@ module Restfully
             headers.delete(:status)
             status = response.code
           rescue RestClient::ExceptionWithResponse => e
-            body = e.http_body
-            headers = e.response.to_hash
+            body = e.response.to_s
+            headers = e.response.headers
             status = e.http_code
           end
           Response.new(status, headers, body)

data/lib/restfully/parsing.rb

@@ -11,6 +11,8 @@ module Restfully
       case content_type
       when /^application\/.*?json/i
         JSON.parse(object)
+      when /^text\/.*?(plain|html)/i
+        object.to_s
       else
         raise ParserNotFound.new("Content-Type '#{content_type}' is not supported. Cannot parse the given object.")
       end

data/lib/restfully/session.rb

@@ -62,7 +62,9 @@ module Restfully
     
     protected
     def transmit(method, request)
-      request.add_headers(default_headers) unless default_headers.empty?
+      default_headers.each do |header, value|
+        request.headers[header] ||= value
+      end
       logger.info "#{method.to_s.upcase} #{request.uri}"  +
                   "\nHeaders: #{request.headers.inspect}" +
                   "#{request.body ? "\nBody: #{request.body.length} bytes" : ""}"

data/restfully.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restfully}
-  s.version = "0.5.2"
+  s.version = "0.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
-  s.date = %q{2009-12-14}
+  s.date = %q{2010-02-05}
   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}
@@ -50,6 +50,7 @@ Gem::Specification.new do |s|
      "restfully.gemspec",
      "spec/collection_spec.rb",
      "spec/fixtures/configuration_file.yml",
+     "spec/fixtures/grid5000-rennes-jobs.json",
      "spec/fixtures/grid5000-sites.json",
      "spec/http/error_spec.rb",
      "spec/http/headers_spec.rb",
@@ -90,14 +91,14 @@ Gem::Specification.new do |s|
     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"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.3"])
       s.add_runtime_dependency(%q<backports>, [">= 0"])
     else
-      s.add_dependency(%q<rest-client>, [">= 1.0"])
+      s.add_dependency(%q<rest-client>, [">= 1.3"])
       s.add_dependency(%q<backports>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rest-client>, [">= 1.0"])
+    s.add_dependency(%q<rest-client>, [">= 1.3"])
     s.add_dependency(%q<backports>, [">= 0"])
   end
 end

data/spec/collection_spec.rb

@@ -6,6 +6,7 @@ describe Collection do
     before do
       @uri = URI.parse('http://api.local/x/y/z')
       @collection = Collection.new(@uri, session=mock('session')).load(:body => JSON.parse(fixture("grid5000-sites.json")))
+      @jobs_collection = Collection.new(@uri, session=mock('session')).load(:body => JSON.parse(fixture("grid5000-rennes-jobs.json")))
     end
     it "should be enumerable" do
       @collection.length.should == 9
@@ -26,6 +27,11 @@ describe Collection do
       rennes.class.should == Restfully::Resource
       rennes['uid'].should == 'rennes'
     end
+    it "should try to find the matching item in the collection when calling [] with a symbol" do
+      job = @jobs_collection[:'319482']
+      job.class.should == Restfully::Resource
+      job['uid'].should == 319482
+    end
   end  
   
   describe "populating collection" do

data/spec/fixtures/grid5000-rennes-jobs.json

@@ -0,0 +1,166 @@
+{
+  "items": [
+    {
+      "name": "test",
+      "submitted_at": 1265359473,
+      "uid": 319482,
+      "user_uid": "crohr",
+      "links": [
+        {
+          "href": "/sid/grid5000/sites/rennes/jobs/319482",
+          "rel": "self",
+          "type": "application/vnd.fr.grid5000.api.Job+json;level=1"
+        },
+        {
+          "href": "/sid/grid5000/sites/rennes",
+          "rel": "parent",
+          "type": "application/vnd.fr.grid5000.api.Site+json;level=1"
+        }
+      ],
+      "queue": "default",
+      "state": "running"
+    },
+    {
+      "submitted_at": 1265359155,
+      "uid": 319481,
+      "user_uid": "rnou",
+      "links": [
+        {
+          "href": "/sid/grid5000/sites/rennes/jobs/319481",
+          "rel": "self",
+          "type": "application/vnd.fr.grid5000.api.Job+json;level=1"
+        },
+        {
+          "href": "/sid/grid5000/sites/rennes",
+          "rel": "parent",
+          "type": "application/vnd.fr.grid5000.api.Site+json;level=1"
+        }
+      ],
+      "queue": "default",
+      "state": "running"
+    },
+    {
+      "submitted_at": 1265359003,
+      "uid": 319480,
+      "user_uid": "ethome",
+      "links": [
+        {
+          "href": "/sid/grid5000/sites/rennes/jobs/319480",
+          "rel": "self",
+          "type": "application/vnd.fr.grid5000.api.Job+json;level=1"
+        },
+        {
+          "href": "/sid/grid5000/sites/rennes",
+          "rel": "parent",
+          "type": "application/vnd.fr.grid5000.api.Site+json;level=1"
+        }
+      ],
+      "queue": "default",
+      "state": "running"
+    },
+    {
+      "submitted_at": 1265354868,
+      "uid": 319479,
+      "user_uid": "jarnaud",
+      "links": [
+        {
+          "href": "/sid/grid5000/sites/rennes/jobs/319479",
+          "rel": "self",
+          "type": "application/vnd.fr.grid5000.api.Job+json;level=1"
+        },
+        {
+          "href": "/sid/grid5000/sites/rennes",
+          "rel": "parent",
+          "type": "application/vnd.fr.grid5000.api.Site+json;level=1"
+        }
+      ],
+      "queue": "default",
+      "state": "running"
+    },
+    {
+      "submitted_at": 1265312207,
+      "uid": 319462,
+      "user_uid": "acarpena",
+      "links": [
+        {
+          "href": "/sid/grid5000/sites/rennes/jobs/319462",
+          "rel": "self",
+          "type": "application/vnd.fr.grid5000.api.Job+json;level=1"
+        },
+        {
+          "href": "/sid/grid5000/sites/rennes",
+          "rel": "parent",
+          "type": "application/vnd.fr.grid5000.api.Site+json;level=1"
+        }
+      ],
+      "queue": "default",
+      "state": "waiting"
+    },
+    {
+      "submitted_at": 1265292999,
+      "uid": 319432,
+      "user_uid": "acarpena",
+      "links": [
+        {
+          "href": "/sid/grid5000/sites/rennes/jobs/319432",
+          "rel": "self",
+          "type": "application/vnd.fr.grid5000.api.Job+json;level=1"
+        },
+        {
+          "href": "/sid/grid5000/sites/rennes",
+          "rel": "parent",
+          "type": "application/vnd.fr.grid5000.api.Site+json;level=1"
+        }
+      ],
+      "queue": "default",
+      "state": "waiting"
+    },
+    {
+      "submitted_at": 1265218740,
+      "uid": 319355,
+      "user_uid": "bfnicola",
+      "links": [
+        {
+          "href": "/sid/grid5000/sites/rennes/jobs/319355",
+          "rel": "self",
+          "type": "application/vnd.fr.grid5000.api.Job+json;level=1"
+        },
+        {
+          "href": "/sid/grid5000/sites/rennes",
+          "rel": "parent",
+          "type": "application/vnd.fr.grid5000.api.Site+json;level=1"
+        }
+      ],
+      "queue": "default",
+      "state": "waiting"
+    },
+    {
+      "submitted_at": 1265148155,
+      "uid": 319332,
+      "user_uid": "akguyantoine",
+      "links": [
+        {
+          "href": "/sid/grid5000/sites/rennes/jobs/319332",
+          "rel": "self",
+          "type": "application/vnd.fr.grid5000.api.Job+json;level=1"
+        },
+        {
+          "href": "/sid/grid5000/sites/rennes",
+          "rel": "parent",
+          "type": "application/vnd.fr.grid5000.api.Site+json;level=1"
+        }
+      ],
+      "queue": "default",
+      "state": "waiting"
+    }
+  ],
+  "total": 8,
+  "links": [
+    {
+      "href": "/sid/grid5000/sites/rennes/jobs",
+      "rel": "self",
+      "type": "application/vnd.fr.grid5000.api.Collection+json;level=1"
+    }
+  ],
+  "offset": 0
+}

data/spec/http/rest_client_adapter_spec.rb

@@ -22,7 +22,7 @@ describe Restfully::HTTP::Adapters::RestClientAdapter do
     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}, :[] => '')
+    res = mock(RestClient::Response, :code => 404, :to_s => '{"message":"whatever"}', :headers => {:content_type => 'application/json;charset=utf-8', :content_length => 22})
     RestClient::Resource.should_receive(:new).and_raise RestClient::ResourceNotFound.new(res)
     adapter = Restfully::HTTP::Adapters::RestClientAdapter.new("https://api.grid5000.fr", :username => 'crohr', :password => 'password')
     response = adapter.get(mock("request", :uri => "uri"))

data/spec/parsing_spec.rb

@@ -22,4 +22,8 @@ describe Restfully::Parsing do
     object = {'p1' => 'v1'}
     serialize(object, :content_type => 'application/json;charset=utf-8').should == object.to_json
   end
+  it "should correctly unserialize text content" do
+    object = "anything"
+    unserialize(object, :content_type => 'text/plain;charset=utf-8').should == object
+  end
 end

data/spec/session_spec.rb

@@ -83,7 +83,9 @@ describe Session do
   describe "Transmitting requests" do
     before do
       Session.send(:public, :transmit)  
-      @request.should_receive(:add_headers).with("User-Agent"=>"Restfully/#{restfully_version}", "Accept"=>"application/json")
+      @request.headers.stub!(:[]).and_return(nil)
+      @request.headers.should_receive(:[]=).with("User-Agent", "Restfully/#{restfully_version}")
+      @request.headers.should_receive(:[]=).with("Accept", "application/json")
     end
     it "should send a head" do
       @session.connection.should_receive(:head).with(@request).and_return(@response)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restfully
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-14 00:00:00 +01:00
+date: 2010-02-05 00:00:00 +01:00
 default_executable: restfully
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "1.0"
+        version: "1.3"
     version: 
 - !ruby/object:Gem::Dependency 
   name: backports
@@ -73,6 +73,7 @@ files:
 - restfully.gemspec
 - spec/collection_spec.rb
 - spec/fixtures/configuration_file.yml
+- spec/fixtures/grid5000-rennes-jobs.json
 - spec/fixtures/grid5000-sites.json
 - spec/http/error_spec.rb
 - spec/http/headers_spec.rb