restfully 0.5.6 → 0.5.7

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.5.7
+* fixed bug due to the way RestClient handles custom headers (esp. the Accept HTTP header)
+* added PUT method
+
 0.5.6
 * requires rest-client 1.4+
 

data/VERSION

@@ -1 +1 @@
-0.5.6
+0.5.7

data/lib/restfully.rb

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

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

@@ -9,30 +9,36 @@ module Restfully
         def initialize(base_uri, options = {})
           super(base_uri, options)
           @options[:user] = @options.delete(:username)
+          RestClient.log = logger
         end # def initialize
         
         def head(request)
           in_order_to_get_the_response_to(request) do |resource|
-            resource.head(request.headers)
+            resource.head(convert_header_keys_into_symbols(request.headers))
           end
         end # def head
         
         def get(request)
           in_order_to_get_the_response_to(request) do |resource|
-            resource.get(request.headers)
+            resource.get(convert_header_keys_into_symbols(request.headers))
           end
         end # def get
         
-
         def delete(request)
           in_order_to_get_the_response_to(request) do |resource|
-            resource.delete(request.headers)
+            resource.delete(convert_header_keys_into_symbols(request.headers))
           end
         end # def delete
         
+        def put(request)
+          in_order_to_get_the_response_to(request) do |resource|
+            resource.put(request.raw_body, convert_header_keys_into_symbols(request.headers))
+          end
+        end # def put
+        
         def post(request)
           in_order_to_get_the_response_to(request) do |resource|
-            resource.post(request.raw_body, request.headers)
+            resource.post(request.raw_body, convert_header_keys_into_symbols(request.headers))
           end
         end # def post
         
@@ -53,6 +59,15 @@ module Restfully
           Response.new(status, headers, body)
         end # def in_order_to_get_the_response_to
         
+        # there is a bug in RestClient, when passing headers whose keys are string that are already defined as default headers, they get overwritten.
+        def convert_header_keys_into_symbols(headers)
+          headers.inject({}) do |final, (key,value)|
+            key = key.to_s.gsub(/-/, "_").downcase.to_sym
+            final[key] = value
+            final
+          end
+        end # def convert_header_keys_into_symbols
+        
       end
     
     end

data/lib/restfully/session.rb

@@ -29,6 +29,7 @@ module Restfully
       yield @root.load, self if block_given?
     end
     
+    # returns the root resource
     def root
       @root.load
     end
@@ -52,6 +53,13 @@ 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 put(path, body, options = {})
+      options = options.symbolize_keys
+      uri = uri_for(path)
+      transmit :put, 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
@@ -68,9 +76,6 @@ module Restfully
       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" : ""}"
       response = connection.send(method.to_sym, request)
       response = deal_with_eventual_errors(response, request)
     end

data/restfully.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restfully}
-  s.version = "0.5.6"
+  s.version = "0.5.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]

data/spec/http/rest_client_adapter_spec.rb

@@ -4,7 +4,7 @@ describe Restfully::HTTP::Adapters::RestClientAdapter do
     adapter = Restfully::HTTP::Adapters::RestClientAdapter.new("https://api.grid5000.fr", :username => 'crohr', :password => 'password')
     request = Restfully::HTTP::Request.new('http://api.local/sid/grid5000', :headers => {:accept => 'application/json'}, :query => {:q1 => 'v1'})
     RestClient::Resource.should_receive(:new).with('http://api.local/sid/grid5000?q1=v1', :password => 'password', :user => 'crohr').and_return(resource = mock("restclient resource"))
-    resource.should_receive(:get).with(request.headers).and_return(mock("restclient response", :headers => {:content_type => 'application/json;charset=utf-8'}, :to_s => "", :code => 200))
+    resource.should_receive(:get).with({:accept => 'application/json'}).and_return(mock("restclient response", :headers => {:content_type => 'application/json;charset=utf-8'}, :to_s => "", :code => 200))
     response = adapter.get(request)
     response.status.should == 200
     response.body.should be_nil
@@ -18,7 +18,8 @@ describe Restfully::HTTP::Adapters::RestClientAdapter do
     adapter.options[:username].should be_nil
   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")
+    require 'restfully/http/adapters/patron_adapter'
+    adapter = Restfully::HTTP::Adapters::PatronAdapter.new("https://api.grid5000.fr")
     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

data/spec/resource_spec.rb

@@ -32,6 +32,7 @@ describe Resource do
   
   describe "loading" do
     before do
+      @session = Restfully::Session.new(:base_uri => "http://api.local")
       @raw = {
         'links' => [
           {'rel' => 'self', 'href' => '/grid5000/sites/rennes'},
@@ -100,7 +101,12 @@ describe Resource do
       resource.load(:reload => true)
     end
     it "should correctly define the functions to access simple values" do
-      resource = Resource.new(@uri, session = mock("session", :get => @response_200, :logger => @logger))
+      stub_request(:get, @uri.to_s).to_return(
+        :status => 200,
+        :body => @raw.to_json,
+        :headers => {'Content-Type' => 'application/json', 'Content-Length' => @raw.length}
+      )
+      resource = Resource.new(@uri, @session)
       resource.stub!(:define_link) # do not define links
       resource.load
       resource['whatever'].should == 'whatever'
@@ -108,7 +114,20 @@ describe Resource do
       resource["uid"].should == 'rennes'
       resource['an_array'].should be_a(SpecialArray)
       resource['an_array'].should == [1,2,3]
-      lambda{resource.clusters}.should raise_error(NoMethodError)
+    end
+    
+    it "should correctly send custom headers" do
+      stub_request(:get, @uri.to_s).with(:headers => {
+        'User-Agent'=>"Restfully/#{Restfully::VERSION}", 
+        'Accept-Encoding'=>'gzip, deflate', 
+        'Accept'=>'application/json'
+      }).to_return(
+        :status => 200,
+        :body => @raw.to_json,
+        :headers => {'Content-Type' => 'application/json', 'Content-Length' => @raw.length}
+      )
+      resource = Resource.new(@uri, @session)
+      resource.load(:headers => {:accept => 'application/json'})
     end
     
     it "should correctly define a collection link" do

data/spec/restfully_spec.rb

@@ -1,6 +1,9 @@
 require File.expand_path(File.dirname(__FILE__)+'/spec_helper')
 
 describe Restfully do
+  after do
+    Restfully.adapter = Restfully::HTTP::Adapters::RestClientAdapter
+  end
   it "should have a default adapter" do
     Restfully.adapter.should == Restfully::HTTP::Adapters::RestClientAdapter
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restfully
 version: !ruby/object:Gem::Version 
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors: 
 - Cyril Rohr