restful_json 4.3.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f05edb16346a80a688564ca06a5463d3b4739b48
-  data.tar.gz: 71f4b6e1770c4e026c2f5f9be6dedd62485d7fa3
+  metadata.gz: 939e484c768821d49878165026195240c627d440
+  data.tar.gz: 43e95c66ab6f95d36d9872639018d1f61a34cd2a
 SHA512:
-  metadata.gz: 03ead94cce9a811f74feeddd61bca48361769aae629748cf9ddd9ba0fa3e2e60791fb87b9db8f73080175680879f4da76a2dac3acf84046a833cf5b046819a66
-  data.tar.gz: d0feaec66ab9ccf77953468e33f28b888280fd4dcde651f3168a1e7e916edaf928e2decacd513f1348e03ed3f53b169d0def3efd2b92a7b148df5e939fd0ea05
+  metadata.gz: 0197b80bb543238b5c7c702ea467b9098cd1a3345041d755f02697213e125e13caf061e2c0e57b99039caa7319a52dba367754d7c62936d3f95a6513877ba381
+  data.tar.gz: 3081b689fd3ae24b4e0b9a27ca46cee918d766ec59a29f1161b32594b4499919e279570f8080f656bb2833bfaf61380f24cd88dea5515d6e153ba90de993eb69

data/README.md

@@ -108,38 +108,44 @@ Be sure to read the [Strong Parameters][strong_parameters] docs, because you nee
 As noted in [Strong Parameters][strong_parameters], it is suggested to encapsulate the permitting into a private method in the controller, so we allow:
 
 ```ruby
-def foobar_params
-  params.require(:foobar).permit(:name, :age)
-end
+private
+
+  def foobar_params
+    params.require(:foobar).permit(:name, :age)
+  end
 ```
 
 or if `self.allow_action_specific_params_methods = true` is set in restful_json configuration, as it is by default:
 
 ```ruby
-def create_foobar_params
-  params.require(:foobar).permit(:name, :age)
-end
+private
 
-def update_foobar_params
-  params.require(:foobar).permit(:age)
-end
+  def create_foobar_params
+    params.require(:foobar).permit(:name, :age)
+  end
+
+  def update_foobar_params
+    params.require(:foobar).permit(:age)
+  end
 ```
 
-and even other actions if you want:
+and even other actions, if needed:
 
 ```ruby
-def index_foobars_params
-  params.require(:foobars).permit(:foo_id)
-end
+private
 
-# where 'some_action' is a custom action created by query_for
-def some_action_foobars_params
-  params.require(:foobars).permit(:foo_id)
-end
+  def index_foobars_params
+    params.require(:foobars).permit(:foo_id)
+  end
 
-def show_foobar_params
-  params.require(:foobar).permit(:id)
-end
+  # where 'some_action' is a custom action created by query_for
+  def some_action_foobars_params
+    params.require(:foobars).permit(:foo_id)
+  end
+
+  def show_foobar_params
+    params.require(:foobar).permit(:id)
+  end
 ```
 
 ##### Permitters
@@ -714,12 +720,9 @@ By convention, a restful_json controller can call the `(singular model name)_par
 ```ruby
 self.actions_supporting_params_methods = [:create, :update]
 ```
+e.g., starting in restful_json v4.4, in FoobarsController after any other specifics, it would look for a foobar_params method in your controller, and if it is there, it will call it, expecting it to permit params. But, if you change the value of `self.actions_supporting_params_methods` in restful_json config or controller config, it will use whatever you specified.
 
-And by default restful_json allows action specific `(action)_(model)_params` methods, so you only need to define a method like `create_foobar_params` and it will try to call that on create:
-
-```ruby
-self.allow_action_specific_params_methods = true
-```
+Also, if you have a method like `create_foobar_params`, and it will try to call that on create (and similar for `update_foobar_params` and update).
 
 ##### Avoid n+1 Queries
 
@@ -912,13 +915,37 @@ For more realistic use that takes advantage of existing configuration in the con
 
 ### Error Handling
 
-#### Properly Handling Non-controller-action Errors
+#### Validation Errors
 
-Some things restful_json can't do in the controller, like responding with json for a json request when the route is not setup correctly or an action is missing.
+Validation errors (for validations you put in your models) are handled in the controller and returned as an error response in JSON.
+
+#### RecordNotFound and Other Non-validation Errors
+
+##### Rails 4 Default Rack Error Handling
 
 Rails 4 has basic error handling for non-HTML formats defined in the [public_exceptions][public_exceptions] and [show_exceptions][show_exceptions] Rack middleware.
 
-Rails 3.2.x has support for `config.exceptions_app` which can be defined as the following to simulate Rails 4 exception handling:
+To use the Rails 4 default Rack error handling, you need to remove all of the default configuration for rescue handlers in restful_json via:
+
+```ruby
+  RestfulJson.configure do
+    self.rescue_handlers = []
+  end
+```
+
+If you don't want to handle it the way Rack does by default, read on...
+
+#### Rails 3.2.x+ Rack Exceptions App Customization
+
+First, ensure that you've unset restful_json's rescue_handlers to use the Rails 3.2+ Rack error handling:
+
+```ruby
+  RestfulJson.configure do
+    self.rescue_handlers = []
+  end
+```
+
+Rails 3.2.x has support for `config.exceptions_app` which can be defined as the following in your Rails app configuration to simulate Rails 4 exception handling, or if you want to customize Rails 4's Rack exception handling:
 
 ```ruby
 config.exceptions_app = lambda do |env|
@@ -953,17 +980,11 @@ Unfortunately, this doesn't work for Rails 3.1.x. However, in many scenarios the
 
 But, if you can make Rack respond a little better for some errors, that's great.
 
-To let all errors and exceptions fall out of restful_json action methods so that they will all be handled (without `error_data` in response) in the same way as routing, missing action, and other errors caught by Rack, just use:
+#### The Default Way Non-validation Errors Are Handled
 
-```ruby
-  RestfulJson.configure do
-    self.rescue_handlers = []
-  end
-```
-
-#### Controller Error-handling Configuration
+The default configuration will use a configuration to use rescue_handlers which is just a way to configure how the controller's action methods rescue non-validation errors to render a response.
 
-The default configuration will rescue StandardError in each action method and will render as 404 for ActiveRecord::RecordNotFound or 500 for all other StandardError (and ancestors, like a normal rescue).
+The standard configuration will rescue StandardError in each action method and will render as 404 for ActiveRecord::RecordNotFound or 500 for all other StandardError (and ancestors, like a normal rescue).
 
 There are a few options to customize the rescue and error rendering behavior.
 
@@ -993,13 +1014,17 @@ RestfulJson.configure do
 end
 ```
 
-The `return_error_data` config option will not only return a response with `status` and `error` but also an `error_data` containing the `e.class.name`, `e.message`, and cleaned `e.backtrace`.
+The `return_error_data` restful_json config option (true by default) will not only return a response with `status` and `error` but also an `error_data` containing the `e.class.name`, `e.message`, and cleaned `e.backtrace`.
 
-If you want to rescue using `rescue_from` in a controller or ApplicationController, let all errors and exceptions fall out of restful_json action methods with:
+You can turn off backtrace cleaning in `error_data` by setting `clean_backtrace` per handler to false, e.g.:
 
 ```ruby
 RestfulJson.configure do
-  self.rescue_handlers = []
+  self.rescue_class = Exception
+  self.rescue_handlers = [
+    {exception_ancestor_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze},
+    {i18n_key: 'api.internal_server_error'.freeze, clean_backtrace: false}
+  ]
 end
 ```
 

data/lib/restful_json/config.rb

@@ -83,6 +83,9 @@ RestfulJson.configure do
   
   # will define order of errors handled and what status and/or i18n message key to use
   self.rescue_handlers = []
+
+  # default to checking for the StrongParameters default method (singular model name)_params and using it if haven't tried
+  self.actions_supporting_params_methods = [:create, :update]
   
   # rescue_handlers are an ordered array of handlers to handle rescue of self.rescue_class or sub types.
   # can use optional i18n_key for message, but will default to e.message if i18n_key not found.

data/lib/restful_json/controller.rb

@@ -52,6 +52,7 @@ module RestfulJson
       self.param_to_through ||= {}
       self.action_to_render_options ||= {}
       self.action_to_query_includes ||= {}
+      self.actions_supporting_params_methods ||= []
     end
 
     module ClassMethods
@@ -308,7 +309,7 @@ module RestfulJson
 
     def apply_includes(value)
       this_includes = current_action_includes
-      if this_includes
+      if this_includes && this_includes.size > 0
         value = value.includes(*this_includes)
       end
       value
@@ -327,10 +328,14 @@ module RestfulJson
       if self.actions_that_permit.include?(action_sym)
         if self.use_permitters
           return permitted_params_using(self.action_to_permitter[action_sym] || permitter_class)
-        elsif self.allow_action_specific_params_methods && respond_to?(action_specific_params_method)
+        elsif self.allow_action_specific_params_methods && self.respond_to?(action_specific_params_method, true)
           return __send__(action_specific_params_method)
-        elsif self.actions_supporting_params_methods.include?(action_sym) && respond_to?(model_name_params_method)
-          return __send__(model_name_params_method)
+        elsif self.actions_supporting_params_methods.include?(action_sym)
+          if self.respond_to?(model_name_params_method, true)
+            return __send__(model_name_params_method)
+          elsif defined?(::ActionController::StrongParameters)
+            raise "#{self.class.name} needs a method (can be private): #{model_name_params_method}#{self.allow_action_specific_params_methods ? " or #{action_specific_params_method}" : ''}"
+          end
         end
       end
 
@@ -350,6 +355,7 @@ module RestfulJson
     #
     # It handles any format in theory that is supported by respond_to and has a `to_(some format)` method.
     def render_error(e, handling_data)
+      use_backtrace_cleaner = handling_data[:clean_backtrace] || true
       i18n_key = handling_data[:i18n_key]
       msg = t(i18n_key, default: e.message)
       status = handling_data[:status] || :internal_server_error

data/lib/restful_json/version.rb

@@ -1,3 +1,3 @@
 module RestfulJson
-  VERSION = '4.3.1'
+  VERSION = '4.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_json
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.0
 platform: ruby
 authors:
 - Gary S. Weaver
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport