ocean-rails 1.15.1 → 1.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19c67f131eebfdd7b791385da29ad67e15566d4c
-  data.tar.gz: 3cc8700d6debe7d91b4147dc51218e19b9d3e109
+  metadata.gz: eb83c996f5ed1355575bfef824fd57198d217b0c
+  data.tar.gz: 47068ec2c58bfae1caae10623905a61a3fc4d5cb
 SHA512:
-  metadata.gz: ba8d33698a52ead461f73dd811b928b17e6bbf203fd2daf70153ab05372ec546d9d8e3b45295d2b98342609e55a381727e05cb8adf0769f01992bec9f2ce69b8
-  data.tar.gz: 2c87f83ef4bbf11636fae72a91f379335cdcefa93043b7c3b747cb2d2e288d6af8234d71a3b2b5ef17a6ccb10bb4f59679a3390e9f93606e012dc26c8dec42a0
+  metadata.gz: 255be647bf5dbdd373b83bcfae78a7132fb5cd6dd9702c92f7c8e890cebc8fc3c53b1d9b16fdeb17e763bbe046799de9c1a75b91a68ac23373c3c1a120ea3290
+  data.tar.gz: b7b01f48ee1741343532974100b1aede44f03ca00b880fee645dd87d8043e847565c2a98c57b26726a6a393007a3cfe233279a8bc243b9274de22937191f1f06

data/lib/ocean/ocean_application_controller.rb

@@ -121,8 +121,16 @@ module OceanApplicationController
   #
   # The messages are intended for presentation to an end user.
   #
-  def render_validation_errors(r)
-    render json: r.errors, :status => 422
+  # The keyword argument +except+, if present, must be a string, symbol or an
+  # array of strings or symbols and will suppress error information for the
+  # enumerated attributes of the same names. This is sometimes useful when internal
+  # attributes which never appear in external resource representations depend on
+  # user-provided data, such as password hashes and salts.
+  #
+  def render_validation_errors(r, except: [])
+    except = [except] unless except.is_a?(Array)
+    except = except.collect(&:to_sym)
+    render json: r.errors.messages.except(except), :status => 422
   end
   
   #

data/lib/ocean/ocean_resource_controller.rb

@@ -4,6 +4,15 @@
 #
 
 module Ocean
+
+  #
+  # This module is included in ActionController::Base. The most notable effect
+  # is that the class method +ocean_resource_controller+ becomes available, and that
+  # rescue_from handlers are added to handle exceptions for non-unique, stale, and
+  # invalid records. These all terminate the current action and return standard
+  # JSON API errors and validation errors. This allows +POST+ and +PUT+ actions
+  # to be written in a very terse, clear and understandable manner.
+  #
   module OceanResourceController
     
     extend ActiveSupport::Concern
@@ -12,7 +21,7 @@ module Ocean
       if defined? ActiveRecord
         rescue_from ActiveRecord::RecordNotUnique, 
                     ActiveRecord::StatementInvalid do |x|
-          render_api_error 422, "#{controller_name.singularize.camelize} already exists"
+          render_api_error 422, "Resource not unique"
         end
 
         rescue_from ActiveRecord::StaleObjectError do |x|
@@ -20,7 +29,7 @@ module Ocean
         end
 
         rescue_from ActiveRecord::RecordInvalid do |x|
-          render_validation_errors x.record
+          render_validation_errors x.record, except: ocean_resource_controller_no_validation_errors_on
         end
       end
     end
@@ -30,7 +39,7 @@ module Ocean
       #
       # The presence of +ocean_resource_controller+ in a Rails controller declares
       # that the controller is an Ocean controller handling an Ocean resource. It takes
-      # two keyword parameters:
+      # three optional keyword parameters:
       #
       # +required_attributes+: a list of keywords naming model attributes which must be
       # present in every update operation. If an API consumer submits data where any
@@ -38,6 +47,11 @@ module Ocean
       #
       #   ocean_resource_controller required_attributes: [:lock_version, :title]
       #
+      # +no_validation_errors_on+: a symbol, string, or an array of symbols and strings. Error
+      # descriptions in 422 responses will not include the enumerated attributes. This
+      # is sometimes useful for purely internal attributes which should never appear
+      # in error descriptions.
+      #
       # +extra_actions+: a hash containing information about extra controller actions
       # apart from the standard Rails ones of +index+, +show+, +create+, +update+, and 
       # +destroy+. One entry per extra action is required in order to process authentication
@@ -52,13 +66,16 @@ module Ocean
       # that +comment_create+ will be called as the result of a +POST+ to the same hyperlink.
       # Thus, +extra_actions+ maps actions to hyperlink names and HTTP methods.
       #
-      def ocean_resource_controller(required_attributes: [:lock_version, :name, :description],
-                                    extra_actions:       {}
+      def ocean_resource_controller(required_attributes:     [:lock_version, :name, :description],
+                                    no_validation_errors_on: [],
+                                    extra_actions:           {}
       	                           )
       	cattr_accessor :ocean_resource_controller_extra_actions
       	cattr_accessor :ocean_resource_controller_required_attributes
+        cattr_accessor :ocean_resource_controller_no_validation_errors_on
       	self.ocean_resource_controller_extra_actions = extra_actions
       	self.ocean_resource_controller_required_attributes = required_attributes
+        self.ocean_resource_controller_no_validation_errors_on = no_validation_errors_on
       end
     end
 

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "1.15.1"
+  VERSION = "1.15.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 1.15.1
+  version: 1.15.2
 platform: ruby
 authors:
 - Peter Bengtson