restfully 0.5.3 → 0.5.4

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.5.4

data/bin/restfully

@@ -56,7 +56,7 @@ def session
 end
 
 def root 
-  @root ||= session.root.load
+  @root ||= session.root
 end
 
 puts "Restfully/#{Restfully::VERSION} - The root resource is available in the 'root' variable."

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

@@ -15,7 +15,7 @@ module Restfully
           in_order_to_get_the_response_to(request) do |resource|
             resource.head(request.headers)
           end
-        end # def get
+        end # def head
         
         def get(request)
           in_order_to_get_the_response_to(request) do |resource|

data/lib/restfully/parsing.rb

@@ -1,32 +1,64 @@
-require 'json'
+
 
 module Restfully
   
   module Parsing
-  
+    
     class ParserNotFound < Restfully::Error; end
+    
+    PARSERS = [
+      {
+        :supported_types => [/^application\/.*?json/i], 
+        :parse => lambda{|object, options| 
+          require 'json'
+          JSON.parse(object)
+        }, 
+        :dump => lambda{|object, options|
+          require 'json' 
+          JSON.dump(object)
+        },
+        :object => true
+      },
+      {
+        :supported_types => [/^text\/.*?(plain|html)/i], 
+        :parse => lambda{|object, options| object}, 
+        :dump => lambda{|object, options| object}
+      },
+      { # just store the binary data in a 'raw' property
+        :supported_types => ["application/zip"],
+        :parse => lambda{|object, options| {'raw' => object}},
+        :dump => lambda{|object, options| object['raw']}
+      }
+    ]
+    
     def unserialize(object, options = {})
       content_type = options[:content_type]
       content_type ||= object.headers['Content-Type'] if object.respond_to?(:headers)
-      case content_type
-      when /^application\/.*?json/i
-        JSON.parse(object)
-      when /^text\/.*?(plain|html)/i
-        object.to_s
+      parser = select_parser_for(content_type)
+      if parser
+        parser[:parse].call(object, options)
       else
-        raise ParserNotFound.new("Content-Type '#{content_type}' is not supported. Cannot parse the given object.")
+        raise ParserNotFound.new("Cannot find a parser to parse '#{content_type}' content.")
       end
     end
   
     def serialize(object, options = {})
       content_type = options[:content_type]
       content_type ||= object.headers['Content-Type'] if object.respond_to?(:headers)
-      case content_type
-      when /^application\/.*?json/i
-        JSON.dump(object)
+      parser = select_parser_for(content_type)
+      if parser
+        parser[:dump].call(object, options)
       else
-        raise ParserNotFound, [object, content_type]
+        raise ParserNotFound.new("Cannot find a parser to dump object into '#{content_type}' content.")
+      end
+    end
+    
+    def select_parser_for(content_type)
+      content_type.split(",").each do |type|
+        parser = PARSERS.find{|parser| parser[:supported_types].find{|supported_type| type =~ (supported_type.kind_of?(String) ? Regexp.new(supported_type) : supported_type) }}
+        return parser unless parser.nil?
       end
+      nil
     end
 
   end

data/lib/restfully/session.rb

@@ -10,9 +10,8 @@ module Restfully
   end
   class Session
     include Parsing, HTTP::Headers
-    attr_reader :base_uri, :logger, :connection, :root, :default_headers
+    attr_reader :base_uri, :logger, :connection, :default_headers
     
-    # TODO: use CacheableResource
     def initialize(options = {})
       options = options.symbolize_keys
       if (config_filename = options.delete(:configuration_file)) && File.exists?(File.expand_path(config_filename))
@@ -30,6 +29,10 @@ module Restfully
       yield @root.load, self if block_given?
     end
     
+    def root
+      @root.load
+    end
+    
     # returns an HTTP::Response object or raise a Restfully::HTTP::Error
     def head(path, options = {})
       options = options.symbolize_keys

data/restfully.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restfully}
-  s.version = "0.5.3"
+  s.version = "0.5.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
-  s.date = %q{2010-02-05}
+  s.date = %q{2010-03-22}
   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}

data/spec/http/request_spec.rb

@@ -4,7 +4,7 @@ describe Restfully::HTTP::Request do
   it "should correctly initialize the attributes" do
     request = Restfully::HTTP::Request.new(
       'https://api.grid5000.fr/sid/grid5000?q1=v1&q2=v2', 
-      :headers => {'accept' => 'application/json', :cache_control => 'max-age=0', 'Content-Type' => 'application/json'}, 
+      :headers => {'accept' => 'application/xml', :cache_control => 'max-age=0', 'Content-Type' => 'application/json'}, 
       :query => {'custom_param1' => [3, 4, 5, 6], 'custom_param2' => 'value_custom_param2'},
       :body => {"key" => "value"}.to_json
     )
@@ -13,7 +13,7 @@ describe Restfully::HTTP::Request do
     request.uri.query.should == "q1=v1&q2=v2&custom_param1=3,4,5,6&custom_param2=value_custom_param2"
     request.headers.should == {
       "Content-Type"=>"application/json", 
-      'Accept' => 'application/json',
+      'Accept' => 'application/xml',
       'Cache-Control' => 'max-age=0'
     }
     request.body.should == {"key" => "value"}

data/spec/parsing_spec.rb

@@ -12,7 +12,7 @@ describe Restfully::Parsing do
     klass.should respond_to(:serialize)
   end
   it "should raise a ParserNotFound error if the object cannot be parsed" do
-    lambda{unserialize("whatever", :content_type => 'unknown')}.should raise_error(Restfully::Parsing::ParserNotFound, "Content-Type 'unknown' is not supported. Cannot parse the given object.")
+    lambda{unserialize("whatever", :content_type => 'unknown')}.should raise_error(Restfully::Parsing::ParserNotFound, "Cannot find a parser to parse 'unknown' content.")
   end
   it "should correctly unserialize json content" do
     object = {'p1' => 'v1'}
@@ -26,4 +26,15 @@ describe Restfully::Parsing do
     object = "anything"
     unserialize(object, :content_type => 'text/plain;charset=utf-8').should == object
   end
+  it "should allow to define its own parser" do
+    Restfully::Parsing::PARSERS.push({
+      :supported_types => "text/unknown",
+      :parse => lambda{|object, options| object.gsub(/x/, "y")},
+      :dump => lambda{|object, options| object.gsub(/y/, "x")}
+    })
+    object = "xyz"
+    parsed = unserialize(object, :content_type => 'text/unknown')
+    parsed.should == "yyz"
+    serialize(parsed, :content_type => 'text/unknown').should == "xxz"
+  end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'restfully'
 require 'spec'
 require 'spec/autorun'
+require 'json'
 
 def fixture(filename)
   File.read(File.join(File.dirname(__FILE__), "fixtures", filename))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restfully
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 +01:00
+date: 2010-03-22 00:00:00 +01:00
 default_executable: restfully
 dependencies: 
 - !ruby/object:Gem::Dependency