resource_full 0.7.6

data/lib/resource_full/render.rb

@@ -0,0 +1,63 @@
+module ResourceFull
+  module Render
+    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)
+      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
+      "has already been taken"
+    end
+
+    def status_for(errors)
+      if errors.any? { |message| message.include? CONFLICT_MESSAGE }
+        :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?)
+          deliverer = self.class.exception_data
+           data = case deliverer
+             when nil then {}
+             when Symbol then send(deliverer)
+             when Proc then deliverer.call(self)
+           end
+
+           ExceptionNotifier.deliver_exception_notification(exception, self,
+             request, data)
+        end
+        logger.error exception.message + "\n" + exception.clean_backtrace.collect {|s| "\t#{s}\n"}.join
+        render :xml => exception.to_xml, :status => :server_error
+      elsif request.format.json?
+        if defined?(ExceptionNotifiable) && defined?(ExceptionNotifier) && self.is_a?(ExceptionNotifiable) && !(consider_all_requests_local || local_request?)
+          deliverer = self.class.exception_data
+           data = case deliverer
+             when nil then {}
+             when Symbol then send(deliverer)
+             when Proc then deliverer.call(self)
+           end
+
+           ExceptionNotifier.deliver_exception_notification(exception, self,
+             request, data)
+        end
+        logger.error exception.message + "\n" + exception.clean_backtrace.collect {|s| "\t#{s}\n"}.join
+        render :json => exception.to_json, :status => :server_error
+      else
+        raise exception
+      end
+    end
+  end
+end

data/lib/resource_full/retrieve.rb

@@ -0,0 +1,87 @@
+module ResourceFull
+  module Retrieve
+    class << self
+      def included(base)
+        super(base)
+        # Define new_person, update_person, etc.
+        base.before_filter :move_queryable_params_into_model_params_on_create, :only => [:create]
+      end
+    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.
+      returning(model_class.find(:first, :conditions => { resource_identifier => params[:id] })) do |o|
+        raise ActiveRecord::RecordNotFound, "Couldn't find #{model_class} with #{resource_identifier}=#{params[:id]}" if o.nil?
+      end
+    end
+
+    def new_model_object
+      model_class.new
+    end
+
+    def edit_model_object
+      find_model_object
+    end
+
+    # Decorate the method with this - so that even if the user has overridden this method, it will get decorated within a transaction!
+    [:create, :update, :destroy].each do |action|
+      send(:define_method, "transactional_#{action}_model_object") do
+        result = nil
+        ActiveRecord::Base.transaction do
+          result = send("#{action}_#{model_name}")
+          raise ActiveRecord::Rollback unless result.errors.empty?
+        end
+        result
+      end
+    end
+
+    def update_model_object
+      object = find_model_object
+      object.update_attributes(params[model_name])
+      object
+    end
+
+    def create_model_object
+      model_class.create(params[model_name])
+    end
+
+    def destroy_model_object
+      object = find_model_object
+      object.destroy
+      object
+    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)
+          params[model_name][param_name] = params.delete(param_name)
+        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

data/lib/resource_full/version.rb

@@ -0,0 +1,9 @@
+module ResourceFull #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 7
+    TINY  = 6
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/resource_full.rb

@@ -0,0 +1,31 @@
+# Dependencies
+require 'active_record'
+require 'action_controller'
+require 'action_pack'
+
+# Extensions
+Dir[File.dirname(__FILE__) + "/resource_full/core_extensions/*.rb"].each do |extension|
+  require extension
+end
+
+# Core library
+require File.dirname(__FILE__) + '/resource_full/dispatch'
+require File.dirname(__FILE__) + '/resource_full/query'
+
+require File.dirname(__FILE__) + '/resource_full/render/html'
+require File.dirname(__FILE__) + '/resource_full/render/json'
+require File.dirname(__FILE__) + '/resource_full/render/xml'
+
+require File.dirname(__FILE__) + '/resource_full/render'
+require File.dirname(__FILE__) + '/resource_full/retrieve'
+require File.dirname(__FILE__) + '/resource_full/version'
+require File.dirname(__FILE__) + '/resource_full/base'
+
+# REST API
+require File.dirname(__FILE__) + '/resource_full/models/resourced_route.rb'
+require File.dirname(__FILE__) + '/resource_full/controllers/resources_controller'
+require File.dirname(__FILE__) + '/resource_full/controllers/routes_controller'
+
+if ActiveRecord::VERSION::STRING >= '2.1.0' && !ActiveRecord::Base.include_root_in_json
+  puts "WARNING: Please set ActiveRecord::Base.include_root_in_json = true to enable ResourceFull's JSON support."
+end

data/spec/resource_full/base_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+ 
+describe ResourceFull::Base, :type => :controller do
+  controller_name "resource_full_mocks"
+ 
+  it "infers the name of its resource model from its class name" do
+    controller.model_name.should == "resource_full_mock"
+  end
+ 
+  it "infers the class of its resource model from its class name" do
+    controller.model_class.should == ResourceFullMock
+  end
+ 
+  class ResourceFullFake; end
+ 
+  it "exposes a particular resource model given a symbol" do
+    controller.class.exposes :resource_full_fake
+    controller.model_class.should == ResourceFullFake
+    controller.class.exposes :resource_full_mock # cleanup
+  end
+ 
+  it "exposes a particular resource model given a pluralized symbol" do
+    controller.class.exposes :resource_full_fakes
+    controller.model_class.should == ResourceFullFake
+    controller.class.exposes :resource_full_mock # cleanup
+  end
+ 
+  it "exposes a particular resource model given a class" do
+    controller.class.exposes ResourceFullFake
+    controller.model_class.should == ResourceFullFake
+    controller.class.exposes ResourceFullMock # cleanup
+  end
+ 
+  it "renders two formats by default" do
+    controller.class.allowed_formats.should include(:xml, :html)
+  end
+ 
+  it "allows you to specify what formats to render" do
+    controller.class.responds_to :xml, :json
+    controller.class.allowed_formats.should include(:xml, :json)
+    controller.class.allowed_formats.should_not include(:html)
+  end
+ 
+  class NonResourcesController < ActionController::Base; end
+  class ResourcesController < ResourceFull::Base; end
+ 
+  it "knows about all controller subclasses of itself" do
+    ActionController::Routing.expects(:possible_controllers).at_least_once.returns %w{resources non_resources}
+    ResourceFull::Base.all_resources.should include(ResourcesController)
+    ResourceFull::Base.all_resources.should_not include(NonResourcesController)
+  end
+ 
+  it "serializes the notion of a resource controller as XML" do
+    ResourceFullMockUsersController.clear_queryable_params!
+    ResourceFullMockUsersController.queryable_with :first_name
+    xml = Hash.from_xml(ResourceFullMockUsersController.to_xml)
+    xml["resource"]["name"].should == "resource_full_mock_users"
+    xml["resource"]["parameters"].first["name"].should == "first_name"
+  end
+ 
+  it "has a default value of :id for the resource identifier column" do
+    ResourceFullMockUsersController.resource_identifier.should == :id
+  end
+ 
+  it "allows you to set the resource_identifier field" do
+    controller.class.identified_by :first_name
+    controller.class.resource_identifier.should == :first_name
+    controller.class.resource_identifier = :id # cleanup
+  end
+ 
+  it "is paginatable by default" do
+    controller.class.should be_paginatable
+  end
+  
+  it "translates a model name into a controller constant" do
+    ResourceFull::Base.controller_for("resource_full_mock_users").should == ResourceFullMockUsersController
+  end
+  
+  it "raises ResourceNotFound if it cannot constantize the requested controller" do
+    lambda do 
+      ResourceFull::Base.controller_for("nonsense")
+    end.should raise_error(ResourceFull::ResourceNotFound, "not found: nonsense")
+  end
+  
+  it "returns the controller it's been given if it receives a Class object" do
+    ResourceFull::Base.controller_for(ResourceFullMockUsersController).should == ResourceFullMockUsersController
+  end  
+end

data/spec/resource_full/controllers/resources_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module ResourceFull
+  module Controllers
+    describe ResourcesController, :type => :controller do
+      it "finds all resources" do
+        get :index, :format => 'xml'
+
+        response.should have_tag('resources>resource') do
+          with_tag('name', 'resource_full_mock_users')
+          with_tag('name', 'resource_full_mock_addresses')
+        end
+      end
+
+      it "finds a specific resource" do
+        get :show, :format => 'xml', :id => 'resource_full_mock_users'
+
+        response.should have_tag('resource>name', 'resource_full_mock_users')
+        response.should_not have_tag('resource>name', 'resource_full_mock_addresses')
+      end
+
+      it "returns a 404 response when the requested resource is not found" do
+        get :show, :format => 'xml', :id => 'foo'
+
+        response.body.should have_tag("errors") { with_tag("error", "not found: foo") }
+        response.code.should == '404'
+      end
+    end
+  end
+end

data/spec/resource_full/dispatch_spec.rb

@@ -0,0 +1,274 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "ResourceFull::Dispatch", :type => :controller do
+  controller_name "resource_full_mocks"
+
+  before(:each) do
+    ResourceFullMock.stubs(:find).with(:all).returns([stub(:id => 1, :to_xml => "")])
+  end
+
+  it "exposes a method for skipping format and method protection"
+
+  describe "based on request format" do
+    controller_name "resource_full_mocks"
+
+    after :each do
+      controller.class.responds_to :defaults
+    end
+
+    it "dispatches to index_xml render method if xml is requested" do
+      controller.expects(:index_xml)
+      get :index, :format => 'xml'
+    end
+
+    it "dispatches to index_json render method if json is requested" do
+      controller.expects(:index_json)
+      get :index, :format => 'json'
+    end
+
+    it "dispatches to index_html render method if html is requested" do
+      controller.expects(:index_html)
+      controller.stubs(:render)
+      get :index, :format => 'html'
+    end
+
+    it "raises a 406 error if it does not respond to a format for which no methods are included" do
+      get :index, :format => 'txt'
+      response.code.should == '406'
+    end
+
+    it "raises a 406 error if it does not respond to a format which has been explicitly removed" do
+      controller.class.responds_to :xml
+      get :index, :format => 'html'
+      response.code.should == '406'
+    end
+
+    it "includes an appropriate error message if it does not respond to a format which has been explicitly removed" do
+      controller.class.responds_to :xml
+      get :index, :format => 'html'
+      response.body.should =~ /Resource does not have a representation in text\/html format/
+    end
+  end
+
+  describe "based on request action" do
+    controller_name "resource_full_mocks"
+
+    after :each do
+      controller.class.responds_to :defaults
+    end
+
+    it "claims to respond to create, read, update, delete, and count by default" do
+      controller.class.responds_to :defaults
+      controller.class.allowed_methods.should include(:create, :read, :update, :delete)
+    end
+
+    it "lists all the standard Rails methods plus count as its possible actions" do
+      controller.class.possible_actions.should include(:create, :new, :show, :index, :count, :update, :edit, :destroy)
+    end
+
+    it "claims to not respond to any methods for an unsupported format" do
+      controller.class.responds_to :xml
+      controller.class.allowed_methods(:html).should be_empty
+    end
+
+    it "claims to respond to default methods for a requested format if no explicit methods are given" do
+      controller.class.responds_to :xml
+      controller.class.allowed_methods(:xml).should include(:create, :read, :update, :delete)
+    end
+
+    it "claims to respond to only methods given a single value with the :only option" do
+      controller.class.responds_to :xml, :only => :read
+      controller.class.allowed_methods(:xml).should == [:read]
+    end
+
+    it "claims to respond to only methods given multiple values with the :only option" do
+      controller.class.responds_to :xml, :only => [:read, :delete]
+      controller.class.allowed_methods(:xml).should == [:read, :delete]
+    end
+
+    it "responds successfully to supported methods" do
+      controller.class.responds_to :xml, :only => :read
+      get :index, :format => "xml"
+      response.should be_success
+    end
+
+    it "disallows unsupported methods with code 405" do
+      controller.class.responds_to :html, :only => :read
+      controller.stubs(:destroy)
+      delete :destroy, :id => 1
+      response.code.should == '405'
+      response.body.should =~ /Resource does not allow destroy action/
+    end
+
+    it "ignores and does not verify custom methods" do
+      controller.class.responds_to :xml, :only => [:delete]
+
+      get :foo, :format => 'xml'
+      response.body.should have_tag("foo", "bar")
+      response.code.should == '200'
+    end
+
+    it "allows you to specify the appropriate CRUD semantics of a custom method"
+  end
+
+  describe "GET index" do
+    controller_name "resource_full_mocks"
+
+    before :each do
+      controller.stubs(:render)
+    end
+
+    it "sets an @mocks instance variable based on the default finder" do
+      ResourceFullMock.stubs(:find).returns "a list of mocks"
+      get :index, :format => 'html'
+      assigns(:resource_full_mocks).should == "a list of mocks"
+    end
+
+    it "sets an @mocks instance variable appropriately if the default finder is overridden" do
+      begin
+        controller.class.class_eval do
+          def find_all_resource_full_mocks; "another list of mocks"; end
+        end
+        get :index, :format => 'html'
+        assigns(:resource_full_mocks).should == "another list of mocks"
+      ensure
+        controller.class.class_eval do
+          undef :find_all_resource_full_mocks
+        end
+      end
+    end
+  end
+
+  describe "GET count" do
+    controller_name "resource_full_mocks"
+    
+    before :each do
+      controller.stubs(:render)
+    end
+
+    it "should render the count" do
+      ResourceFullMock.stubs(:count).returns(12)
+      get :count, :format => 'html'
+      response.body.should == ["", []]
+    end
+  end
+
+  describe "GET show" do
+    controller_name "resource_full_mocks"
+
+    before :each do
+      controller.stubs(:render)
+    end
+
+    it "sets a @mock instance variable based on the default finder" do
+      ResourceFullMock.stubs(:find).returns "a mock"
+      get :show, :id => 1, :format => 'html'
+      assigns(:resource_full_mock).should == "a mock"
+    end
+
+    it "sets a @mock instance variable appropriately if the default finder is overridden" do
+      controller.class.class_eval do
+        def find_resource_full_mock; "another mock"; end
+      end
+      get :show, :id => 1, :format => 'html'
+      assigns(:resource_full_mock).should == "another mock"
+    end
+  end
+
+  describe "POST create" do
+    controller_name "resource_full_mocks"
+
+    before :each do
+      controller.stubs :render
+    end
+
+    it "sets a @mock instance variable based on the default creator" do
+      ResourceFullMock.stubs(:create).returns stub(:errors => stub_everything, :id => :mock)
+      post :create, :format => 'html'
+      assigns(:resource_full_mock).id.should == :mock
+    end
+
+    it "sets a @mock instance variable appropriately if the default creator is overridden" do
+      ResourceFullMock.stubs(:super_create).returns stub(:errors => stub_everything, :id => :super_mock)
+      controller.class.class_eval do
+        def create_resource_full_mock; ResourceFullMock.super_create; end
+      end
+      post :create, :format => 'html'
+      assigns(:resource_full_mock).id.should == :super_mock
+    end
+  end
+
+  describe "PUT update" do
+    controller_name "resource_full_mocks"
+
+    before :each do
+      controller.stubs :render
+    end
+
+    it "sets a @mock instance variable based on the default updater" do
+      ResourceFullMock.stubs(:find).returns stub(:id => 1, :update_attributes => true, :errors => stub_everything)
+      put :update, :id => 1, :format => 'html'
+      assigns(:resource_full_mock).id.should == 1
+    end
+
+    it "sets a @mock instance variable appropriately if the default updater is overridden" do
+      ResourceFullMock.stubs(:super_update).returns stub(:errors => stub_everything, :id => :super_mock)
+      controller.class.class_eval do
+        def update_resource_full_mock; ResourceFullMock.super_update; end
+      end
+      put :update, :id => 1, :format => 'html'
+      assigns(:resource_full_mock).id.should == :super_mock
+    end
+  end
+
+  describe "when the user agent is IE7" do
+    before :each do
+      request.env["HTTP_USER_AGENT"] = "MSIE 7.0"
+      controller.stubs(:find_all_resource_full_mocks).returns([])
+    end
+
+    it "should set the request format to json when the incoming request format looks like json" do
+      get :index, :format => 'json-test'
+      response.content_type.should == "application/json"
+    end
+
+    it "should set the request format to json when the incoming request format looks like javascript" do
+      get :index, :format => 'javascript-test'
+      response.content_type.should == "application/json"
+    end
+
+    it "should set the request format to json when the incoming request uri looks like json" do
+      request.env["REQUEST_URI"] = "/resource_full_mocks.json?foo=bar"
+      get :index
+      response.content_type.should == "application/json"
+    end
+
+    it "should set the request format to xml when the incoming request format looks like xml" do
+      get :index, :format => 'xml-test'
+      response.content_type.should == "application/xml"
+    end
+
+    it "should set the request format to json when the incoming request uri looks like xml" do
+      request.env["REQUEST_URI"] = "/resource_full_mocks.xml?foo=bar"
+      get :index
+      response.content_type.should == "application/xml"
+    end
+
+    # Dirk assures me that the following functionality is necessary due to the way Rails handles IE7
+    # request formats, or perhaps the way IE7 sends its request content-type.
+    # TODO Find a better criterion than 'else, use text/html'.
+    it "should default the request format to text/html when the incoming request uri is not supported" do
+      controller.stubs :render
+      request.env["REQUEST_URI"] = "/resource_full_mocks.png"
+      get :index
+      response.content_type.should == "text/html"
+    end
+
+    # See above.
+    it "should default the request format to text/html when the incoming request format is not supported" do
+      controller.stubs :render
+      get :index, :format => "image/png"
+      response.content_type.should == "text/html"
+    end
+  end
+end

data/spec/resource_full/models/resourced_route_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module ResourceFull
+  module Models
+    describe ResourcedRoute do
+      it "has a verb, name, pattern, and action" do
+        ResourcedRoute.new(:controller => "resource_full_mock_users", :verb => "GET").verb.should == "GET"
+        ResourcedRoute.new(:controller => "resource_full_mock_users", :name => "users").name.should == "users"
+        ResourcedRoute.new(:controller => "resource_full_mock_users", :pattern => "/users").pattern.should == "/users"
+        ResourcedRoute.new(:controller => "resource_full_mock_users", :action => "index").action.should == "index"
+      end
+
+      it "has an associated controller derived from the given string" do
+        ResourcedRoute.new(:controller => "resource_full_mock_users").controller.should == ResourceFullMockUsersController
+      end
+
+      it "has an associated controller derived from the given class" do
+        ResourcedRoute.new(:controller => ResourceFullMockUsersController).controller.should == ResourceFullMockUsersController
+      end
+
+      it "should know if it's a formatted route" do
+        ResourcedRoute.new(:controller => "resource_full_mock_users", :name => "formatted_resource_full_mock_users").should be_formatted
+      end
+
+      class DumbController < ActionController::Base; end
+
+      it "should know if it's a resourced route" do
+        ResourcedRoute.new(:controller => DumbController).should_not be_resourced
+      end
+
+      it "should know how to look up its resource" do
+        ResourcedRoute.new(:controller => ResourceFullMockUsersController).resource.should == "resource_full_mock_users"
+      end
+
+      describe "query" do
+        it "raises an exception when it can't find a particular route" do
+          lambda do
+            ResourcedRoute.find("this route does not exist")
+          end.should raise_error(ResourceFull::Models::RouteNotFound)
+        end
+
+        it "locates a particular named route" do
+          route = ResourcedRoute.find :resource_full_mock_users
+          route.pattern.should =~ /\/resource_full_mock_users/
+          route.verb.should == "GET"
+          route.action.should == "index"
+          route.controller.should == ResourceFullMockUsersController
+        end
+
+        it "locates all named routes" do
+          ResourcedRoute.find(:all).collect(&:name).should include(:resource_full_mock_users, :new_resource_full_mock_user, :resource_full_mock_addresses)
+        end
+
+        it "should filter by a particular resource" do
+          route_names = ResourcedRoute.find(:all, :resource_id => "resource_full_mock_users").collect(&:name)
+          route_names.should include(:resource_full_mock_users)
+          route_names.should_not include(:resource_full_mock_addresses)
+        end
+      end
+    end
+  end
+end