rlivsey-voorhees 0.1.4 → 0.2.0

data/README.markdown

@@ -119,7 +119,7 @@ This is used in instance methods:
 Like json_service, by default it assumes you're getting items of the same class, you can override this like so:
 
     def messages
-      json_request(Message) do |r|
+      json_request(:class => Message) do |r|
         r.path        = "/messages.json"
         r.parameters  = {:user_id => self.id}        
       end
@@ -127,6 +127,19 @@ Like json_service, by default it assumes you're getting items of the same class,
 
     User.new.messages  => [Message, Message, ...]
 
+By default a json_request call will convert the JSON to objects, you can make it return something else by setting the :returning property like so:
+
+    json_request(:returning => :raw) do |r|
+      ...
+    end
+
+The returning property can be set to the following:
+
+* :raw      => the raw JSON response as a string
+* :json     => the JSON parsed to a ruby hash (through JSON.parse)
+* :response => the Voorhees::Response object
+* :objects  => casts the JSON into objects (the default)
+
 #### Voorhees::Request
 
 Both json_service and json_request create Voorhees::Request objects to do their bidding.

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/lib/voorhees/request.rb

@@ -59,7 +59,7 @@ module Voorhees
     
     def perform
       setup_request
-      parse_response(perform_actual_request)
+      build_response(perform_actual_request)
     end
         
     private
@@ -129,11 +129,8 @@ module Voorhees
         query_string_parts.size > 0 ? query_string_parts.join('&') : nil
       end
     
-      def parse_response(response)
-        Voorhees::Config[:response_class].new(JSON.parse(response.body), @caller_class, @hierarchy)
-      rescue JSON::ParserError
-        Voorhees.debug("Parsing JSON failed.\nFirst 500 chars of body:\n#{response.body[0...500]}")
-        raise Voorhees::ParseError
+      def build_response(response)
+        Voorhees::Config[:response_class].new(response.body, @caller_class, @hierarchy)
       end
     
       def validate

data/lib/voorhees/resource.rb

@@ -25,7 +25,7 @@ module Voorhees
         (class << self; self; end).instance_eval do
           define_method name do |*args|
             params = args[0]
-            json_request(klass) do |r|
+            json_request(:class => klass) do |r|
               r.parameters = params if params.is_a?(Hash)
               request_options.each do |option, value|
                 r.send("#{option}=", value)
@@ -35,10 +35,21 @@ module Voorhees
         end
       end
       
-      def json_request(klass=nil)
-        request = Voorhees::Request.new(klass || self)
+      def json_request(options={})
+        request = Voorhees::Request.new(options[:class] || self)
         yield request
-        request.perform.to_objects
+        response = request.perform
+        
+        case options[:returning]
+        when :raw
+          response.body
+        when :json
+          response.json
+        when :response
+          response
+        else
+          response.to_objects
+        end
       end
     end
     
@@ -48,8 +59,8 @@ module Voorhees
         @json_attributes ||= @raw_json.keys.collect{|x| x.underscore.to_sym}
       end
       
-      def json_request(klass=nil)
-        self.class.json_request(klass) do |r|
+      def json_request(options={})
+        self.class.json_request(options) do |r|
           yield r
         end
       end

data/lib/voorhees/response.rb

@@ -2,25 +2,32 @@ module Voorhees
   
   class Response
     
-    attr_reader :json, :klass
+    attr_reader :body, :klass
     
-    def initialize(json, klass=nil, hierarchy=nil)
-      @json       = json
+    def initialize(body, klass=nil, hierarchy=nil)
+      @body       = body
       @hierarchy  = hierarchy
       @klass      = klass      
     end
     
+    def json
+      @json ||= JSON.parse(@body)
+    rescue JSON::ParserError
+      Voorhees.debug("Parsing JSON failed.\nFirst 500 chars of body:\n#{response.body[0...500]}")
+      raise Voorhees::ParseError
+    end
+    
     def to_objects
       return unless @klass
       
       raise Voorhees::NotResourceError.new unless @klass.respond_to?(:new_from_json)
       
-      if @json.is_a?(Array)
-        @json.collect do |item|
+      if json.is_a?(Array)
+        json.collect do |item|
           @klass.new_from_json(item, @hierarchy)
         end
       else
-        @klass.new_from_json(@json, @hierarchy)
+        @klass.new_from_json(json, @hierarchy)
       end
     end
     

data/spec/request_spec.rb

@@ -157,7 +157,7 @@ describe Voorhees::Request do
       body = '{"something":"result"}'
       @http_response = Net::HTTPResponse::CODE_TO_OBJ["200"].new("1.1", 200, body)
       @http_response.stub!(:body).and_return(body)
-      @json_response = JSON.parse(body)
+      @json_response = body
       
       @mock_http  = MockNetHttp.new
       @connection = @mock_http.connection
@@ -275,7 +275,7 @@ describe Voorhees::Request do
       @request.perform.should be_a(Voorhees::Response)
     end    
     
-    it "should pass the parsed JSON, caller class and hierarcy to the response" do
+    it "should pass the json body, caller class and hierarcy to the response" do
       @connection.stub!(:request).and_return(@http_response)
             
       Voorhees::Response.should_receive(:new).with(@json_response, @caller_class, @hierarchy)      
@@ -317,7 +317,7 @@ describe Voorhees::Request do
           it "should return the response from the service" do
             @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_raise(Timeout::Error.new(nil))                
             @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_return(@http_response)
-            @request.perform.json.should == @json_response
+            @request.perform.body.should == @json_response
           end
 
         end
@@ -407,7 +407,7 @@ describe Voorhees::Request do
           it "should return the response from the service" do
             @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_raise(Errno::ECONNREFUSED)                
             @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_return(@http_response)
-            @request.perform.json.should == @json_response
+            @request.perform.body.should == @json_response
           end
         end
 

data/spec/resource_spec.rb

@@ -36,13 +36,19 @@ describe User  do
     describe "json_request" do
       
       before :each do 
+        @json_string= "{}"
+        @json_hash  = {}
+        
         @request  = mock(:request,  :null_object => true)
         @response = mock(:response, :null_object => true)
         @objects  = [mock(:object)]
                 
         Voorhees::Request.stub!(:new).and_return(@request)
         @request.stub!(:perform).and_return(@response)
+        
         @response.stub!(:to_objects).and_return(@objects)
+        @response.stub!(:json).and_return(@json_hash)        
+        @response.stub!(:body).and_return(@json_string)            
       end
       
       def perform_request
@@ -57,7 +63,7 @@ describe User  do
       
       it "should call Request.new with the specified class if a class is passed" do
         Voorhees::Request.should_receive(:new).with(Message).and_return(@request)
-        User.json_request(Message) do |request|
+        User.json_request(:class => Message) do |request|
           # ...
         end
       end
@@ -80,9 +86,26 @@ describe User  do
         perform_request
       end
       
-      it "should return the result of Response#to_objects" do
+      it "should return the result of Response#to_objects if :returning is not set" do
         perform_request.should == @objects
       end
+      
+      it "should return the JSON string if :returning is set to :raw" do
+        User.json_request(:returning => :raw){}.should == @json_string
+      end
+      
+      it "should return the JSON hash if :returning is set to :json" do
+        User.json_request(:returning => :json){}.should == @json_hash
+      end
+      
+      it "should return the objects string if :returning is set to :objects" do
+        User.json_request(:returning => :objects){}.should == @objects
+      end
+      
+      it "should return the response if :returning is set to :response" do
+        User.json_request(:returning => :response){}.should == @response
+      end
+              
     end
     
     describe "json_service" do

data/spec/response_spec.rb

@@ -89,5 +89,5 @@ def build_response(fixture)
   @hierarchy = {
     :address => Address
   }
-  @response = Voorhees::Response.new(JSON.parse(body), @klass, @hierarchy)
+  @response = Voorhees::Response.new(body, @klass, @hierarchy)
 end

data/voorhees.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{voorhees}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Livsey"]
-  s.date = %q{2009-06-24}
+  s.date = %q{2009-07-01}
   s.email = %q{richard@livsey.org}
   s.extra_rdoc_files = [
     "LICENSE",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rlivsey-voorhees
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - Richard Livsey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-24 00:00:00 -07:00
+date: 2009-07-01 00:00:00 -07:00
 default_executable: 
 dependencies: []