restful_json 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 939e484c768821d49878165026195240c627d440
-  data.tar.gz: 43e95c66ab6f95d36d9872639018d1f61a34cd2a
+  metadata.gz: fc95c0c7d75c8d006f6bd7b03cdc10fecb5b6bfe
+  data.tar.gz: cd6dc9927dbb99b9fa44b033e5bd41c0a50654fe
 SHA512:
-  metadata.gz: 0197b80bb543238b5c7c702ea467b9098cd1a3345041d755f02697213e125e13caf061e2c0e57b99039caa7319a52dba367754d7c62936d3f95a6513877ba381
-  data.tar.gz: 3081b689fd3ae24b4e0b9a27ca46cee918d766ec59a29f1161b32594b4499919e279570f8080f656bb2833bfaf61380f24cd88dea5515d6e153ba90de993eb69
+  metadata.gz: cfe9ef00e8b242f50a38356e09af036896e82f759896afc3c4bbd990b287e831a70b0d544672143126110c831bd7e7bed4f3b7f14caf6a00b01e137176495966
+  data.tar.gz: 7b26424e5d2b3cf61f0453fee47b227fae3426577cad8336d801396436748b7ff117c26e78ca39d6970b29fc081c285ae6050ae9ee4c655c7b6a4ddaa03ca9d7

data/README.md

@@ -84,7 +84,7 @@ You only define what you need to provide and it can easily integrate with common
 In your Rails app's `Gemfile`:
 
 ```ruby
-gem 'restful_json', '~> 4.3.0'
+gem 'restful_json', '~> 4.5.0'
 ```
 
 Then:
@@ -296,37 +296,40 @@ RestfulJson.configure do
   # if not using permitters, will check respond_to?("(singular_model_name)_params".to_sym) and if true will __send__(method)
   self.actions_that_permit = [:create, :update]
   
-  # will call .includes(...) for including and/or includes_for when action was generated by query_for
+  # will call .includes(...) for including and/or including_for_action when action was generated by query_for
   self.apply_includes_to_custom_queries = true
   
   # in error JSON, break out the exception info into fields for debugging
   self.return_error_data = true
   
   # the class that is rescued in each action method, but if nil will always reraise and not handle
-  self.rescue_class = StandardError
+  self.rj_action_rescue_class = StandardError
   
   # will define order of errors handled and what status and/or i18n message key to use
-  self.rescue_handlers = []
+  self.rj_action_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.
+  # rescue_handlers are an ordered array of handlers to handle rescue of self.rj_action_rescue_class or sub types.
   # can use optional i18n_key for message, but will default to e.message if i18n_key not found.
   
   # support 404 error for ActiveRecord::RecordNotFound if using ActiveRecord.
   begin
     require 'active_record/errors'
-    self.rescue_handlers << {exception_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze}
+    self.rj_action_rescue_handlers << {exception_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze}
   rescue LoadError, NameError
   end
   
   # support 403 error for CanCan::AccessDenied if using CanCan
   begin
     require 'cancan/exceptions'
-    self.rescue_handlers << {exception_classes: [CanCan::AccessDenied], status: :forbidden, i18n_key: 'api.not_found'.freeze}
+    self.rj_action_rescue_handlers << {exception_classes: [CanCan::AccessDenied], status: :forbidden, i18n_key: 'api.not_found'.freeze}
   rescue LoadError, NameError
   end
   
-  # support 500 error for everything else that is a self.rescue_class (in action)
-  self.rescue_handlers << {status: :internal_server_error, i18n_key: 'api.internal_server_error'.freeze}
+  # support 500 error for everything else that is a self.rj_action_rescue_class (in action)
+  self.rj_action_rescue_handlers << {status: :internal_server_error, i18n_key: 'api.internal_server_error'.freeze}
   
 end
 ```
@@ -349,7 +352,7 @@ All of the app-level configuration parameters are configurable at the controller
   self.use_permitters = true
   self.avoid_respond_with = true
   self.return_error_data = true
-  self.rescue_class = StandardError
+  self.rj_action_rescue_class = StandardError
   self.action_to_permitter = {create: nil, update: nil}
   self.actions_that_authorize = [:create, :update]
   self.allow_action_specific_params_methods = true
@@ -357,7 +360,7 @@ All of the app-level configuration parameters are configurable at the controller
   
   require 'active_record/errors'
   require 'cancan/exceptions'
-  self.rescue_handlers [
+  self.rj_action_rescue_handlers [
     {exception_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze},
     {exception_classes: [CanCan::AccessDenied], status: :forbidden, i18n_key: 'api.not_found'.freeze},
     {status: :internal_server_error, i18n_key: 'api.internal_server_error'.freeze}
@@ -929,7 +932,7 @@ To use the Rails 4 default Rack error handling, you need to remove all of the de
 
 ```ruby
   RestfulJson.configure do
-    self.rescue_handlers = []
+    self.rj_action_rescue_handlers = []
   end
 ```
 
@@ -941,7 +944,7 @@ First, ensure that you've unset restful_json's rescue_handlers to use the Rails
 
 ```ruby
   RestfulJson.configure do
-    self.rescue_handlers = []
+    self.rj_action_rescue_handlers = []
   end
 ```
 
@@ -988,14 +991,14 @@ The standard configuration will rescue StandardError in each action method and w
 
 There are a few options to customize the rescue and error rendering behavior.
 
-The `rescue_class` config option specifies what to rescue. Set to StandardError to behave like a normal rescue. Set to nil to just reraise everything rescued (to disable handling).
+The `rj_action_rescue_class` config option specifies what to rescue. Set to StandardError to behave like a normal rescue. Set to nil to just reraise everything rescued (to disable handling).
 
-The `rescue_handlers` config option is like a minimalist set of rescue blocks that apply to every action method. For example, the following would effectively `rescue => e` (rescuing `StandardError`) and then for `ActiveRecord::RecordNotFound`, it would uses response status `:not_found` (HTTP 404). Otherwise it uses status `:internal_server_error` (HTTP 500). In both cases the error message is `e.message`:
+The `rj_action_rescue_handlers` config option is like a minimalist set of rescue blocks that apply to every action method. For example, the following would effectively `rescue => e` (rescuing `StandardError`) and then for `ActiveRecord::RecordNotFound`, it would uses response status `:not_found` (HTTP 404). Otherwise it uses status `:internal_server_error` (HTTP 500). In both cases the error message is `e.message`:
 
 ```ruby
 RestfulJson.configure do
-  self.rescue_class = StandardError
-  self.rescue_handlers = [
+  self.rj_action_rescue_class = StandardError
+  self.rj_action_rescue_handlers = [
     {exception_classes: [ActiveRecord::RecordNotFound], status: :not_found},
     {status: :internal_server_error}
   ]
@@ -1006,8 +1009,8 @@ In a slightly more complicated case, this configuration would catch all exceptio
 
 ```ruby
 RestfulJson.configure do
-  self.rescue_class = Exception
-  self.rescue_handlers = [
+  self.rj_action_rescue_class = Exception
+  self.rj_action_rescue_handlers = [
     {exception_ancestor_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze},
     {i18n_key: 'api.internal_server_error'.freeze}
   ]
@@ -1020,8 +1023,8 @@ You can turn off backtrace cleaning in `error_data` by setting `clean_backtrace`
 
 ```ruby
 RestfulJson.configure do
-  self.rescue_class = Exception
-  self.rescue_handlers = [
+  self.rj_action_rescue_class = Exception
+  self.rj_action_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}
   ]
@@ -1034,6 +1037,8 @@ See the [changelog][changelog] for basically what happened when, and git log for
 
 ### Upgrading
 
+To avoid an internal conflict with Rails' `rj_action_rescue_from` using the same variable, if you had set `rj_action_rescue_handlers` in your config or controller for restful_json use, please change the variable name to `rj_action_rescue_handlers`. Also similarly change `rj_action_rescue_class` to `rj_action_rescue_class`.
+
 The class method:
 
 ```ruby

data/lib/restful_json/config.rb

@@ -16,8 +16,8 @@ module RestfulJson
     :actions_supporting_params_methods,
     :avoid_respond_with,
     :return_error_data,
-    :rescue_class,
-    :rescue_handlers,
+    :rj_action_rescue_class,
+    :rj_action_rescue_handlers,
     :apply_includes_to_custom_queries
   ]
   
@@ -79,10 +79,10 @@ RestfulJson.configure do
   self.return_error_data = true
   
   # the class that is rescued in each action method, but if nil will always reraise and not handle
-  self.rescue_class = StandardError
+  self.rj_action_rescue_class = StandardError
   
   # will define order of errors handled and what status and/or i18n message key to use
-  self.rescue_handlers = []
+  self.rj_action_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]
@@ -93,18 +93,18 @@ RestfulJson.configure do
   # support 404 error for ActiveRecord::RecordNotFound if using ActiveRecord.
   begin
     require 'active_record/errors'
-    self.rescue_handlers << {exception_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze}
+    self.rj_action_rescue_handlers << {exception_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze}
   rescue LoadError, NameError
   end
   
   # support 403 error for CanCan::AccessDenied if using CanCan
   begin
     require 'cancan/exceptions'
-    self.rescue_handlers << {exception_classes: [CanCan::AccessDenied], status: :forbidden, i18n_key: 'api.not_found'.freeze}
+    self.rj_action_rescue_handlers << {exception_classes: [CanCan::AccessDenied], status: :forbidden, i18n_key: 'api.not_found'.freeze}
   rescue LoadError, NameError
   end
   
   # support 500 error for everything else that is a self.rescue_class (in action)
-  self.rescue_handlers << {status: :internal_server_error, i18n_key: 'api.internal_server_error'.freeze}
+  self.rj_action_rescue_handlers << {status: :internal_server_error, i18n_key: 'api.internal_server_error'.freeze}
   
 end

data/lib/restful_json/controller.rb

@@ -242,15 +242,15 @@ module RestfulJson
       self.return_error_data
     end
 
-    # Searches through self.rescue_handlers for appropriate handler.
-    # self.rescue_handlers is an array of hashes where there is key :exception_classes and/or :exception_ancestor_classes
+    # Searches through self.rj_action_rescue_handlers for appropriate handler.
+    # self.rj_action_rescue_handlers is an array of hashes where there is key :exception_classes and/or :exception_ancestor_classes
     # along with :i18n_key and :status keys.
     # :exception_classes contains an array of classes to exactly match the exception.
     # :exception_ancestor_classes contains an array of classes that can match an ancestor of the exception.
     # If exception handled, returns hash, hopefully containing keys :i18n_key and :status.
     # Otherwise, returns nil which indicates that this exception should not be handled.
     def exception_handling_data(e)
-      self.rescue_handlers.each do |handler|
+      self.rj_action_rescue_handlers.each do |handler|
         return handler if (handler.key?(:exception_classes) && handler[:exception_classes].include?(e.class))
         if handler.key?(:exception_ancestor_classes)
           handler[:exception_ancestor_classes].each do |ancestor|
@@ -264,7 +264,7 @@ module RestfulJson
     end
 
     def handle_or_raise(e)
-      raise e if self.rescue_class.nil?
+      raise e if self.rj_action_rescue_class.nil?
       handling_data = exception_handling_data(e)
       raise e unless handling_data
       # this is something we intended to rescue, so log it
@@ -342,7 +342,7 @@ module RestfulJson
       params
     end
 
-    # Renders error using handling data options (where options are probably hash from self.rescue_handlers that was matched).
+    # Renders error using handling data options (where options are probably hash from self.rj_action_rescue_handlers that was matched).
     #
     # If include_error_data? is true, it returns something like the following (with the appropriate HTTP status code via setting appropriate status in respond_do:
     # {"status": "not_found",
@@ -539,7 +539,7 @@ module RestfulJson
       @value = value
       instance_variable_set(@model_at_plural_name_sym, @value)
       render_or_respond(true)
-    rescue self.rescue_class => e
+    rescue self.rj_action_rescue_class => e
       handle_or_raise(e)
     end
 
@@ -552,7 +552,7 @@ module RestfulJson
       allowed_params
       instance_variable_set(@model_at_singular_name_sym, @value)
       render_or_respond(true, @value.nil? ? :not_found : :ok)
-    rescue self.rescue_class => e
+    rescue self.rj_action_rescue_class => e
       handle_or_raise(e)
     end
 
@@ -565,7 +565,7 @@ module RestfulJson
       @value = @model_class.new
       instance_variable_set(@model_at_singular_name_sym, @value)
       render_or_respond(true)
-    rescue self.rescue_class => e
+    rescue self.rj_action_rescue_class => e
       handle_or_raise(e)
     end
 
@@ -578,7 +578,7 @@ module RestfulJson
       allowed_params
       instance_variable_set(@model_at_singular_name_sym, @value)
       @value
-    rescue self.rescue_class => e
+    rescue self.rj_action_rescue_class => e
       handle_or_raise(e)
     end
 
@@ -589,7 +589,7 @@ module RestfulJson
       @value.save
       instance_variable_set(@model_at_singular_name_sym, @value)
       render_or_respond(false, :created)
-    rescue self.rescue_class => e
+    rescue self.rj_action_rescue_class => e
       handle_or_raise(e)
     end
 
@@ -603,7 +603,7 @@ module RestfulJson
       @value.update_attributes(p_params) unless @value.nil?
       instance_variable_set(@model_at_singular_name_sym, @value)
       render_or_respond(true, @value.nil? ? :not_found : :ok)
-    rescue self.rescue_class => e
+    rescue self.rj_action_rescue_class => e
       handle_or_raise(e)
     end
 
@@ -625,7 +625,7 @@ module RestfulJson
       else
         render_or_respond(false)
       end
-    rescue self.rescue_class => e
+    rescue self.rj_action_rescue_class => e
       handle_or_raise(e)
     end
   end

data/lib/restful_json/version.rb

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

metadata

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