ocean-rails 8.1.1 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3596b974401cfe0867bf975504a31661b1463a234149e709e6072ce01b441ff1
-  data.tar.gz: 1a4c958efe9086c93bfdd0108d8d7d6836093b1d00bfa19fbfe4e814b6df868f
+  metadata.gz: 5d9060f6156d98438b9ce3dd4deba2fb97461ce44ece562fe3dcea701755c52d
+  data.tar.gz: a1a06a85ea3ccada5b17e83062db49a927936fc2d51f2262f9403d05a040d2f6
 SHA512:
-  metadata.gz: c2a9521aec078ca1aebc09d86e38c7aadaf13a0a5b194df9ad6d53399ddd5d9b4615d3d0b03d6a43df1ebdb4927120b7650682cbf84e1684aa8481482e9b7749
-  data.tar.gz: ba7a5f5800f613ad257ed1408f70afc86221c1130cb7eb7fb1e3e1b92b4188676dc63c6e55766dca9c4a70f77def9d2b8e0645857a6dca1ba11c8e390820f6e5
+  metadata.gz: '080c8feb9696e384a95ff51c1e9e3f56649c252ed9ad478d90e27c982d108177d395e79aabea3a937eb1041fb83a32b7f419e5cec60571401b46fd95afbea2d5'
+  data.tar.gz: 694b220450f368176bd3a5df6125efacd4d166494b2c29d815516327e0d10728819ec8c32366c5b4d71e0e725fb84205efc9e180e7158bf731b9d0871b714d23

data/lib/generators/ocean_scaffold_dynamo/templates/controller.rb

@@ -8,8 +8,9 @@ class <%= controller_class_name %>Controller < ApplicationController
   ocean_resource_controller
 
   before_action :find_<%= singular_table_name %>, :only => [:show, :update, :destroy]
-    
-  
+  before_action :verify_attributes, only: :update
+
+
   # GET <%= route_url %>
   def index
     expires_in 0, 's-maxage' => DEFAULT_CACHE_TIME
@@ -17,9 +18,9 @@ class <%= controller_class_name %>Controller < ApplicationController
     # Instead, we get all the instances and compute the ETag manually.
     # You may wish to remove this action entirely. You may also wish to remove the caching,
     # in which case you don't need to compute the Etag at all.
-    @<%= plural_table_name %> = <%= class_name %>.all    
+    @<%= plural_table_name %> = <%= class_name %>.all
     latest = @<%= plural_table_name %>.max_by(&:updated_at)
-    last_updated = latest && latest.updated_at 
+    last_updated = latest && latest.updated_at
     if stale?(etag: "<%= class_name %>:#{@<%= plural_table_name %>.length}:#{last_updated}")
       api_render @<%= plural_table_name %>
     end
@@ -50,10 +51,6 @@ class <%= controller_class_name %>Controller < ApplicationController
 
   # PUT <%= route_url %>/a-b-c-d-e
   def update
-    if missing_attributes?
-      render_api_error 422, "Missing resource attributes"
-      return
-    end
     @<%= singular_table_name %>.name = params[:name] if params[:name]
     @<%= singular_table_name %>.description = params[:description] if params[:description]
     set_updater(@<%= singular_table_name %>)
@@ -67,10 +64,10 @@ class <%= controller_class_name %>Controller < ApplicationController
     @<%= singular_table_name %>.destroy
     render_head_204
   end
-  
-  
+
+
   private
-     
+
   def find_<%= singular_table_name %>
     ActionController::Parameters.permit_all_parameters = true
     @<%= singular_table_name %> = <%= class_name %>.find_by_key(params['id'], consistent: true)
@@ -78,6 +75,6 @@ class <%= controller_class_name %>Controller < ApplicationController
     render_api_error 404, "<%= class_name %> not found"
     false
   end
-    
+
 end
 <% end -%>

data/lib/ocean/ocean_application_controller.rb

@@ -229,6 +229,15 @@ module OceanApplicationController
   end
 
 
+  def verify_attributes
+    missing = missing_attributes?
+    if missing
+      render_api_error 422, "Missing resource attributes: #{missing.join(', ')}"
+      return false
+    end
+    return true
+  end
+
   #
   # Cache values for collections. Accepts a class, a scope, or an array.
   # The cache value is based on three components:

data/lib/ocean/ocean_resource_controller.rb

@@ -14,12 +14,12 @@ module Ocean
   # to be written in a very terse, clear and understandable manner.
   #
   module OceanResourceController
-    
+
     extend ActiveSupport::Concern
 
     included do
       if defined? ActiveRecord
-        rescue_from ActiveRecord::RecordNotUnique, 
+        rescue_from ActiveRecord::RecordNotUnique,
                     ActiveRecord::StatementInvalid do |x|
           render_api_error 422, "Resource not unique"
         end
@@ -56,7 +56,7 @@ module Ocean
       # three optional keyword parameters:
       #
       # +required_attributes+: a list of keywords naming model attributes which must be
-      # present. If an API consumer submits data where any of these attributes isn't present, 
+      # present. If an API consumer submits data where any of these attributes isn't present,
       # an API error will be generated.
       #
       #   ocean_resource_controller required_attributes: [:lock_version, :title]
@@ -73,7 +73,7 @@ module Ocean
       #   ocean_resource_controller no_validation_errors_on: [:password_hash, :password_salt]
       #
       # +extra_actions+: a hash containing information about extra controller actions
-      # apart from the standard Rails ones of +index+, +show+, +create+, +update+, and 
+      # apart from the standard Rails ones of +index+, +show+, +create+, +update+, and
       # +destroy+. One entry per extra action is required in order to process authorisation
       # requests. Here's an example:
       #
@@ -113,13 +113,16 @@ module Ocean
 
 
     #
-    # Returns true if the params hash lacks a required attribute declared using
-    # +ocean_resource_controller+.
+    # If the params hash lacks any required attributes declared using
+    # +ocean_resource_controller+, returns a list of those attributes.
+    # Otherwise return false.
     #
     def missing_attributes?
+      missing = []
       self.class.ocean_resource_controller_required_attributes.each do |attr|
-        return true unless params[attr]
+        missing << attr unless params[attr]
       end
+      return missing unless missing.blank?
       return false
     end
 

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "8.1.1"
+  VERSION = "8.2.0"
 end

data/lib/templates/rails/scaffold_controller/controller.rb

@@ -8,8 +8,9 @@ class <%= controller_class_name %>Controller < ApplicationController
   ocean_resource_controller
 
   before_action :find_<%= singular_table_name %>, :only => [:show, :update, :destroy]
-    
-  
+  before_action :verify_attributes, only: :update
+
+
   # GET <%= route_url %>
   def index
     expires_in 0, 's-maxage' => DEFAULT_CACHE_TIME
@@ -39,10 +40,6 @@ class <%= controller_class_name %>Controller < ApplicationController
 
   # PUT <%= route_url %>/1
   def update
-    if missing_attributes?
-      render_api_error 422, "Missing resource attributes"
-      return
-    end
     @<%= singular_table_name %>.assign_attributes(filtered_params <%= class_name %>)
     set_updater(@<%= singular_table_name %>)
     @<%= singular_table_name %>.save!
@@ -55,10 +52,10 @@ class <%= controller_class_name %>Controller < ApplicationController
     @<%= orm_instance.destroy %>
     render_head_204
   end
-  
-  
+
+
   private
-     
+
   def find_<%= singular_table_name %>
     @<%= singular_table_name %> = <%= class_name %>.find_by_id params[:id]
     # If your table has app and context columns and you have created Rights utilising them,
@@ -68,6 +65,6 @@ class <%= controller_class_name %>Controller < ApplicationController
     render_api_error 404, "<%= class_name %> not found"
     false
   end
-    
+
 end
 <% end -%>

metadata

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