@@ -1,5 +1,10 @@ -if ([Rails::VERSION::MAJOR, Rails::VERSION::MINOR] <=> [2,1]) >= 0 # if the rails version is 2.1 or greater...Í - ActiveRecord::Base.include_root_in_json = true -end +# Include hook code here +if !Object.constants.include?("RESOURCE_FULL_PLUGIN_INCLUDED") + RESOURCE_FULL_PLUGIN_INCLUDED = true + + if ([Rails::VERSION::MAJOR, Rails::VERSION::MINOR] <=> [2,1]) >= 0 # if the rails version is 2.1 or greater...Í + ActiveRecord::Base.include_root_in_json = true + end -require 'resource_full' + require 'resource_full' +end init.rb @@ -3,20 +3,20 @@ module ResourceFull include ResourceFull::Render::HTML include ResourceFull::Render::JSON include ResourceFull::Render::XML - + def self.included(controller) controller.rescue_from Exception, :with => :handle_generic_exception_with_correct_response_format end - + private - - CONFLICT_MESSAGE = if defined?(ActiveRecord::Errors) + + CONFLICT_MESSAGE = if defined?(ActiveRecord::Errors) if ([Rails::VERSION::MAJOR, Rails::VERSION::MINOR] <=> [2,1]) >= 0 # if the rails version is 2.1 or greater...Í (I18n.translate 'activerecord.errors.messages')[:taken] else ActiveRecord::Errors.default_error_messages[:taken] end - else + else "has already been taken" end @@ -25,7 +25,7 @@ module ResourceFull :conflict else :unprocessable_entity end end - + def handle_generic_exception_with_correct_response_format(exception) if request.format.xml? if defined?(ExceptionNotifiable) && defined?(ExceptionNotifier) && self.is_a?(ExceptionNotifiable) && !(consider_all_requests_local || local_request?) @@ -35,7 +35,7 @@ module ResourceFull when Symbol then send(deliverer) when Proc then deliverer.call(self) end - + ExceptionNotifier.deliver_exception_notification(exception, self, request, data) end @@ -49,7 +49,7 @@ module ResourceFull when Symbol then send(deliverer) when Proc then deliverer.call(self) end - + ExceptionNotifier.deliver_exception_notification(exception, self, request, data) end lib/resource_full/render.rb @@ -2,7 +2,7 @@ module ResourceFull module Render module HTML protected - + def show_html self.model_object = send("find_#{model_name}") rescue ActiveRecord::RecordNotFound => e @@ -24,7 +24,7 @@ module ResourceFull end def update_html - self.model_object = send("update_#{model_name}") + self.model_object = send("update_#{model_name}") if model_object.errors.empty? flash[:info] = "Successfully updated #{model_name.humanize} with ID of #{model_object.id}." redirect_to :action => :index, :format => :html @@ -40,8 +40,11 @@ module ResourceFull rescue ActiveRecord::RecordNotFound => e flash[:error] = e.message redirect_to :back + rescue ActiveRecord::ActiveRecordError => e + flash[:error] = e.message + redirect_to :back end - + def new_html self.model_object = send("new_#{model_name}") end lib/resource_full/render/html.rb @@ -62,6 +62,9 @@ module ResourceFull head :ok rescue ActiveRecord::RecordNotFound => e render :json => e.to_json , :status => :not_found + rescue ActiveRecord::ActiveRecordError => e + # Dont want the whole backtrace - just the message + render :xml => {:error => {:text => e.message}}.to_json, :status => :unprocessable_entity end def new_json_options lib/resource_full/render/json.rb @@ -52,6 +52,11 @@ module ResourceFull head :ok rescue ActiveRecord::RecordNotFound => e render :xml => e.to_xml, :status => :not_found + rescue ActiveRecord::ActiveRecordError => e + # Dont want the whole backtrace - just the message + builder = Builder::XmlMarkup.new(:indent => 0) + builder.errors { | b | b.error(e.message) } + render :xml => builder, :status => :unprocessable_entity end def new_xml_options lib/resource_full/render/xml.rb @@ -7,13 +7,9 @@ module ResourceFull base.before_filter :move_queryable_params_into_model_params_on_create, :only => [:create] end end - - # Override this to provide custom find conditions. This is automatically merged at query - # time with the queried conditions extracted from params. - def find_options; {}; end - + protected - + def find_model_object # TODO I am not sure what the correct behavior should be here, but I'm artifically # generating the exception in order to avoid altering the render methods for the time being. @@ -21,33 +17,33 @@ module ResourceFull raise ActiveRecord::RecordNotFound, "not found: #{params[:id]}" if o.nil? end end - + def new_model_object model_class.new end - + def update_model_object returning(find_model_object) do |object| object.update_attributes params[model_name] end end - + def create_model_object model_class.create(params[model_name]) end - + def destroy_model_object model_class.destroy_all(resource_identifier => params[:id]) end - + def find_all_model_objects completed_query.find(:all) end - + def count_all_model_objects completed_query.count end - + def move_queryable_params_into_model_params_on_create params.except(model_name).each do |param_name, value| if self.class.queryable_params.collect(&:name).include?(param_name.to_sym) @@ -55,20 +51,19 @@ module ResourceFull end end end - + private - + def completed_query self.class.queryable_params.inject(model_class) do |finder, queryer| queryer.find finder, params end end - + def resource_identifier returning(self.class.resource_identifier) do |column| return column.call(params[:id]) if column.is_a?(Proc) end end - end -end \ No newline at end of file +end lib/resource_full/retrieve.rb @@ -76,6 +76,23 @@ describe "ResourceFull::Render::JSON" , :type => :controller do hash["error"]["text"].should == "SomeNonsenseException: sparrow farts" end + it "rescues all unhandled exceptions with an XML response for destroy action as well" do + mock_user = ResourceFullMockUser.create! + ResourceFullMockUser.send :define_method, :destroy do + errors.add_to_base("Cannot delete") + raise ActiveRecord::RecordInvalid.new(self) + end + + begin + delete :destroy, :id => mock_user.id.to_s, :format => 'json' + + hash = Hash.from_json(response.body) + hash["error"]["text"].should == "Validation failed: Cannot delete" + ensure + ResourceFullMockUser.send :remove_method, :destroy + end + end + it "it sends an exception notification email if ExceptionNotifier is enabled and still renders the JSON error response" do cleanup = unless defined? ExceptionNotifier module ExceptionNotifier; end spec/resource_full/render/json_spec.rb @@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../../spec_helper' describe "ResourceFull::Render::XML" , :type => :controller do controller_name "resource_full_mock_users" - + before :each do ResourceFullMockUser.delete_all ResourceFullMockUsersController.resource_identifier = :id @@ -14,67 +14,83 @@ describe "ResourceFull::Render::XML" , :type => :controller do response.body.should have_tag("resource-full-mock-user") response.code.should == '200' end - + it "renders the appropriate error message if it can't find the model object" do get :show, :id => 1, :format => 'xml' response.body.should have_tag("errors") { with_tag("error", "ActiveRecord::RecordNotFound: not found: 1") } response.code.should == '404' end - + it "renders all model objects" do 2.times { ResourceFullMockUser.create! } get :index, :format => 'xml' Hash.from_xml(response.body)['resource_full_mock_users'].size.should == 2 response.code.should == '200' end - + it "creates and renders a new model object with an empty body" do put :create, :resource_full_mock_user => { 'first_name' => 'brian' }, :format => 'xml' response.body.should == ResourceFullMockUser.find(:first).to_xml ResourceFullMockUser.find(:first).first_name.should == 'brian' end - + it "creates a new model object and returns a status code of 201 (created)" do put :create, :resource_full_mock_user => { 'first_name' => 'brian' }, :format => 'xml' response.code.should == '201' end - + it "creates a new model object and places the location of the new object in the Location header" do put :create, :resource_full_mock_user => {}, :format => 'xml' response.headers['Location'].should == resource_full_mock_user_url(ResourceFullMockUser.find(:first)) end - + it "renders appropriate errors if a model validation fails" do ResourceFullMockUser.send :define_method, :validate do errors.add :first_name, "can't be blank" if self.first_name.blank? end - + put :create, :resource_full_mock_user => {}, :format => 'xml' response.should have_tag("errors") { with_tag("error", "First name can't be blank")} - + ResourceFullMockUser.send :remove_method, :validate end - + it "renders the XML for a new model object" do get :new, :format => 'xml' response.body.should == ResourceFullMockUser.new.to_xml end - + class SomeNonsenseException < Exception; end - + it "rescues all unhandled exceptions with an XML response" do ResourceFullMockUser.expects(:find).raises SomeNonsenseException, "sparrow farts" get :index, :format => 'xml' response.should have_tag("errors") { with_tag("error", "SomeNonsenseException: sparrow farts") } end - + + it "rescues all unhandled exceptions with an XML response for destroy action as well" do + mock_user = ResourceFullMockUser.create! + ResourceFullMockUser.send :define_method, :destroy do + errors.add_to_base("Cannot delete") + raise ActiveRecord::RecordInvalid.new(self) + end + + begin + delete :destroy, :id => mock_user.id.to_s, :format => 'xml' + + response.should have_tag("errors") { with_tag("error", "Validation failed: Cannot delete") } + ensure + ResourceFullMockUser.send :remove_method, :destroy + end + end + it "it sends an exception notification email if ExceptionNotifier is enabled and still renders the XML error response" do cleanup = unless defined? ExceptionNotifier module ExceptionNotifier; end module ExceptionNotifiable; end true end - + ResourceFullMockUsersController.send :include, ExceptionNotifiable ResourceFullMockUser.expects(:find).raises SomeNonsenseException, "sparrow farts" ResourceFullMockUsersController.stubs(:exception_data).returns(nil) @@ -83,13 +99,13 @@ describe "ResourceFull::Render::XML" , :type => :controller do ExceptionNotifier.expects(:deliver_exception_notification) get :index, :format => 'xml' response.should have_tag("errors") { with_tag("error", "SomeNonsenseException: sparrow farts") } - + if cleanup Object.send :remove_const, :ExceptionNotifier Object.send :remove_const, :ExceptionNotifiable end - end - + end + it "retains the generic error 500 when re-rendering unhandled exceptions" do ResourceFullMockUser.expects(:find).raises SomeNonsenseException, "sparrow farts" get :index, :format => 'xml' spec/resource_full/render/xml_spec.rb 2ada3d9dcc79c7a99c57ad99d8f983b0fddbcdcd Vijay Aravamudhan avijayr - at - gmail - dot - com http://github.com/bguthrie/resource_full/commit/7f08b1185af706f02bac7bc12dcd66daf94316aa 7f08b1185af706f02bac7bc12dcd66daf94316aa 2009-09-20T14:51:26-07:00 2009-09-20T14:51:26-07:00 Vijay: Added functionality to handle errors on delete call for all formats. Removed (old) no-op method (find_options) in retrieve.rb. Removed trailing spaces for easier diff with other branch from our svn repo. 5e0acb72b6f77e6a6f46a0b50944e68903506f51 Vijay Aravamudhan avijayr - at - gmail - dot - com