resource_full 0.7.8 → 0.7.9

data/README.rdoc

@@ -1,16 +1,14 @@
-= ResourceFull 0.7.5
+= ResourceFull
 
-* http://github.com/bguthrie/resource_full/
-
-== DESCRIPTION
-
-ResourceFull integrates with ActionController to provide a comprehensive 
-RESTful resource modeling and querying framework.  It provides parameter 
+ResourceFull provides a fully-compliant ActiveResource server implementation
+built on ActionController. Additionally, it provides RESTful parameter 
 queryability, paging, sorting, separation of controller concerns, multiple 
 formats (HTML, XML, JSON), CRUD access permissions, and API metadata 
 surrounding the resource itself. It's opinionated but is intended to provide 
 you with as much as possible without limiting your ability to customize its
-behavior.
+behavior. Unless overridden, it uses Rails' default to_xml and to_json methods 
+to provide object serialization, which ActiveResource expects but many REST 
+clients will not.
 
 == GOALS
 
@@ -78,7 +76,7 @@ add +map.api+ to your +routes.rb+ file.
 
 (The MIT License)
 
-Copyright (c) 2009 Brian Guthrie
+Copyright (c) 2010 Brian Guthrie
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/resource_full.rb

@@ -22,6 +22,6 @@ 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/models/resourced_route'
 require File.dirname(__FILE__) + '/resource_full/controllers/resources_controller'
 require File.dirname(__FILE__) + '/resource_full/controllers/routes_controller'

data/lib/resource_full/query.rb

@@ -253,15 +253,18 @@ module ResourceFull
       # Indicates that the resource should be queryable with the given parameters, which will be pulled from
       # the params hash on an index or count call.  Accepts the following options:
       # 
+      #   * :scope => (scope) : Use a scope. The value of this parameter may be a symbol (named scope), lambda, or hash.
+      #     Most other parameter options build scopes internally.
       #   * :fuzzy => true : Use a LIKE query instead of =.
       #   * :columns / :column => ... : Override the default column, or provide a list of columns to query for this value.
       #   * :from => :join_name : Indicate that this value should be queried by joining on another model.  Should use
       #     a valid relationship from this controller's exposed model (e.g., :account if belongs_to :account is specified.)
       #   * :resource_identifier => true : Try to look up the resource controller for this value and honor its
       #     specified resource identifier.  Useful for nesting relationships.
-      #   * :allow_nils => true : Indicates that a nil value for a parameter should be taken to literally indicate
+      #   * :allow_nil => true : Indicates that a nil value for a parameter should be taken to literally indicate
       #     that null values should be returned.  This may be changed in the future to expect the literal string 'null'
       #     or some other reasonable standin.
+      #   * :default => (value) : Default to this value if the parameter is not physically present in the request.
       #
       # Examples:
       #
@@ -283,6 +286,12 @@ module ResourceFull
         end
       end
       
+      def filter_with_scope(scope=nil, &block_scope)
+        raise ArgumentError, "must provide a scope name, standard scope definition, or block scope" unless (scope || block_scope)
+        # TODO These should not require the use of dummy parameter names.
+        queryable_with "__unused__", :default => true, :scope => scope || block_scope
+      end
+      
       # :nodoc:
       def clear_queryable_params!
         @queryable_params = []

data/lib/resource_full/render.rb

@@ -8,10 +8,18 @@ module ResourceFull
       controller.rescue_from Exception, :with => :handle_generic_exception_with_correct_response_format
     end
 
+    # Override this method to provide custom error handling for the errors generated by
+    # your model object.
+    def http_error_code_for(errors)
+      if errors.any? { |message| message.include? CONFLICT_MESSAGE }
+        :conflict
+      else :unprocessable_entity end
+    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...Í
+      if ActiveRecord::VERSION::STRING >= '2.1.0' && defined?(I18n)
         (I18n.translate 'activerecord.errors.messages')[:taken]
       else
         ActiveRecord::Errors.default_error_messages[:taken]
@@ -20,12 +28,6 @@ module ResourceFull
       "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?)

data/lib/resource_full/render/json.rb

@@ -59,12 +59,12 @@ module ResourceFull
       def create_json
         self.model_object = transactional_create_model_object
         if model_object.errors.empty?
-          render :json => model_object.to_json(create_json_options), :status => :created, :location => send("#{model_name}_url", model_object.id)
+          render :json => model_object.to_json(create_json_options), :status => :created, :location => send("#{model_name}_url", model_object.id, :format => :json)
         else
           json_data = model_object.attributes
           json_data[:errors] = {:list => model_object.errors,
                                :full_messages => model_object.errors.full_messages}
-          render :json => {json_class_name(model_object) => json_data}.to_json, :status => status_for(model_object.errors)
+          render :json => {json_class_name(model_object) => json_data}.to_json, :status => http_error_code_for(model_object.errors)
         end
       rescue => e
         handle_generic_error_in_json(e)
@@ -88,7 +88,7 @@ module ResourceFull
           json_data = model_object.attributes
           json_data[:errors] = {:list => model_object.errors,
                                :full_messages => model_object.errors.full_messages}
-          render :json => {json_class_name(model_object) => json_data}.to_json, :status => status_for(model_object.errors)
+          render :json => {json_class_name(model_object) => json_data}.to_json, :status => http_error_code_for(model_object.errors)
         end
       rescue ActiveRecord::RecordNotFound => e
         render :json => e.to_json, :status => :not_found

data/lib/resource_full/render/xml.rb

@@ -53,9 +53,9 @@ module ResourceFull
       def create_xml
         self.model_object = transactional_create_model_object
         if model_object.errors.empty?
-          render :xml => model_object.to_xml({:root => model_name}.merge(create_xml_options)), :status => :created, :location => send("#{model_name}_url", model_object.id)
+          render :xml => model_object.to_xml({:root => model_name}.merge(create_xml_options)), :status => :created, :location => send("#{model_name}_url", model_object.id, :format => :xml)
         else
-          render :xml => model_object.errors.to_xml, :status => status_for(model_object.errors)
+          render :xml => model_object.errors.to_xml, :status => http_error_code_for(model_object.errors)
         end
       rescue => e
         handle_generic_error_in_xml(e)
@@ -76,7 +76,7 @@ module ResourceFull
         if model_object.errors.empty?
           render :xml => model_object.to_xml({:root => model_name}.merge(update_xml_options))
         else
-          render :xml => model_object.errors.to_xml, :status => status_for(model_object.errors)
+          render :xml => model_object.errors.to_xml, :status => http_error_code_for(model_object.errors)
         end
       rescue ActiveRecord::RecordNotFound => e
         render :xml => e.to_xml, :status => :not_found
@@ -101,6 +101,7 @@ module ResourceFull
 
       private
       def handle_generic_error_in_xml(exception)
+        logger.error exception
         render :xml => exception, :status => :internal_server_error
       end
     end

data/lib/resource_full/version.rb

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

data/spec/resource_full/query_spec.rb

@@ -459,4 +459,56 @@ describe "ResourceFull::Query", :type => :controller do
     end
   end
   
+  describe "filter_with_scope" do
+    controller_name "resource_full_mock_users"
+    
+    # def self.filter_with_scope(scope)
+    #   queryable_with :__unused__, :default => true, :scope => scope
+    # end
+
+    it "should automatically apply the given named scope to the generated query" do
+      ResourceFullMockUsersController.filter_with_scope :rich
+      ResourceFullMockUser.named_scope :rich, :conditions => [ "income >= 50000" ]
+      
+      bob = ResourceFullMockUser.create! :income => 30000
+      alice = ResourceFullMockUser.create! :income => 50000
+      snoop_dogg = ResourceFullMockUser.create! :income => 1034831909138
+      
+      get :index
+      assigns(:resource_full_mock_users).should_not include(bob)
+      assigns(:resource_full_mock_users).should include(alice, snoop_dogg)
+    end
+    
+    it "should automatically apply the given hash scope to the generated query" do
+      ResourceFullMockUsersController.filter_with_scope :conditions => [ "income >= 50000" ]
+      
+      bob = ResourceFullMockUser.create! :income => 30000
+      alice = ResourceFullMockUser.create! :income => 50000
+      snoop_dogg = ResourceFullMockUser.create! :income => 1034831909138
+      
+      get :index
+      assigns(:resource_full_mock_users).should_not include(bob)
+      assigns(:resource_full_mock_users).should include(alice, snoop_dogg)
+    end
+    
+    it "should automatically apply the given block as the lambda for a scope" do
+      ResourceFullMockUsersController.filter_with_scope do
+        { :conditions => [ "birthdate > ?", 2.days.ago ] }
+      end
+      
+      bob = ResourceFullMockUser.create! :birthdate => 1.day.ago
+      alice = ResourceFullMockUser.create! :birthdate => 3.days.ago
+      snoop_dogg = ResourceFullMockUser.create! :birthdate => Date.parse("1971-10-20")
+      
+      get :index
+      assigns(:resource_full_mock_users).should include(bob)
+      assigns(:resource_full_mock_users).should_not include(alice, snoop_dogg)
+    end
+    
+    it "should raise an ArgumentError if neither an argument scope nor a block scope is provided" do
+      lambda do
+        ResourceFullMockUsersController.filter_with_scope
+      end.should raise_error(ArgumentError)
+    end
+  end
 end

data/spec/resource_full/render/json_spec.rb

@@ -158,7 +158,7 @@ describe "ResourceFull::Render::JSON", :type => :controller do
     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 => 'json'
 
-      response.headers['Location'].should == resource_full_mock_user_url(ResourceFullMockUser.find(:first))
+      response.headers['Location'].should == resource_full_mock_user_url(ResourceFullMockUser.find(:first), :format => :json)
     end
 
     it "renders appropriate errors if a model validation fails" do

data/spec/resource_full/render/xml_spec.rb

@@ -51,7 +51,7 @@ describe "ResourceFull::Render::XML" , :type => :controller do
       it "creates a new model object and places the location of the new object in the Location header" do
         put :create, :resource_full_namespaced_mock_record => {}, :format => 'xml'
 
-        response.headers['Location'].should == resource_full_namespaced_mock_record_url(ResourceFullSpec::ResourceFullNamespacedMockRecord.find(:first))
+        response.headers['Location'].should == resource_full_namespaced_mock_record_url(ResourceFullSpec::ResourceFullNamespacedMockRecord.find(:first), :format => :xml)
       end
     end    
 
@@ -118,7 +118,7 @@ describe "ResourceFull::Render::XML" , :type => :controller do
       it "creates a new model object and places the location of the new object in the Location header" do
         put :create, :resource_full_namespaced_mock_record => {}, :format => 'xml'
 
-        response.headers['Location'].should == resource_full_namespaced_mock_record_url(ResourceFullSpec::ResourceFullNamespacedMockRecord.find(:first))
+        response.headers['Location'].should == resource_full_namespaced_mock_record_url(ResourceFullSpec::ResourceFullNamespacedMockRecord.find(:first), :format => :xml)
       end
     end    
 
@@ -269,7 +269,7 @@ describe "ResourceFull::Render::XML" , :type => :controller do
       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))
+        response.headers['Location'].should == resource_full_mock_user_url(ResourceFullMockUser.find(:first), :format => :xml)
       end
 
       it "renders appropriate errors if a model validation fails" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 8
-  version: 0.7.8
+  - 9
+  version: 0.7.9
 platform: ruby
 authors: 
 - Brian Guthrie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 +05:30
+date: 2010-05-05 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency