renderror 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf0849a4098632c1107b831164c2eb590c6bf9e0
-  data.tar.gz: 43e8eb0da0171280e300820eee7e6597f98247c1
+  metadata.gz: 59e93d7cb7ba860191c0bab1f7e8506c595075b8
+  data.tar.gz: afccc80bde92e3cbe34352dba0ece5d0cc682562
 SHA512:
-  metadata.gz: 2bf62640dc1aab88e8496493693bb0bd65a06fcbd5d8fc2c6d126fcd6dea7d5c93d13d6b994c1a9523ce209aa2bbc643808bf5cb5d647d79c089da28b3b71308
-  data.tar.gz: ba1ef634c009863693e954f12bed8cc1a369938a4ce8bd8b79fbbb1501db3340702a61a0d98ad0fa9a1dcf012a2f9fc80024197904b0aa0be7864efc0bc45cf1
+  metadata.gz: dbac24758fba89d8d767c72c308f956988f189be827299c46577ac7d8d640b3acb7cb05f720eac83a4944067988537855826057fa8d1bacff2e9b2e4baa20190
+  data.tar.gz: a9b567bd35851d3c13ad8a9164c3f2c85584a34ad1f57eedac22374e5b472f16f0b1fb1754e352597bcb3d40e5b7b05401b1a51f1539e87959e331f860683015

data/README.md

@@ -91,6 +91,51 @@ Ties into the [CanCanCan](https://github.com/CanCanCommunity/cancancan) gem to a
 }
 ```
 
+#### `:conflict`
+
+This ties into `renderror_validate` mentioned below, and allows auto rescuing from `Renderror::Conflict` errors, responding with a `Conflict` error
+
+```json
+{
+  "errors": [
+    {
+      "title": "Conflict",
+      "status": "409",
+      "detail": "Incorrect type specified"
+    }
+  ]
+}
+```
+
+## Renderror Validate
+
+As well as providing an auto rescue functionality, Renderror can also validate request params to ensure they have the correct type and id [as specified by JSON:Api](http://jsonapi.org/format/#crud-creating-responses-409). 
+
+You can enable this in a similar way to auto rescue:
+
+```ruby 
+class ApiController < ApplicationController
+  renderror_validate :jsonapi_type, :jsonapi_id
+end
+```
+
+This will enable automatic type validate for all `create` and `update` actions, as well as validating that the `id` matches the query param id for all `update` requests. If this validation fails a `Renderror::Conflict` will be raised, which you can auto rescue from (as mentioned above).
+
+### Validating Custom Actions
+
+Sometimes you may want to validate `jsonapi_type` or `jsonapi_id` for actions other than just create and update. If this is the case then you can simply pass them in as a before action and they will be handled the same way:
+
+```ruby 
+class UsersController < ApiController
+  before_action :validate_jsonapi_type, only: :change_status
+  before_action :validate_jsonapi_id,   only: :change_status
+
+  def change_status
+    # Your code here
+  end
+end
+```
+
 ## Additional Methods
 
 There is also a number of situations where Renderror can be triggered manually, such as when wanting to render model errors or invalid authentication errors. You can do this using the following methods.

data/lib/generators/renderror/install/templates/en.yml

@@ -20,3 +20,6 @@ en:
     unprocessable_entity:
       title: Unprocessable Entity
       detail: Unprocessable Entity
+    conflict:
+      title: Conflict
+      detail: Incorrect type specified

data/lib/renderror.rb

@@ -1,6 +1,7 @@
 require 'active_support'
 require 'renderror/configuration'
 require 'renderror/auto_rescue'
+require 'renderror/validate'
 require 'renderror/renderer'
 
 require 'renderror/base_error'
@@ -9,6 +10,7 @@ require 'renderror/unauthorized'
 require 'renderror/forbidden'
 require 'renderror/not_found'
 require 'renderror/unprocessable_entity'
+require 'renderror/conflict'
 
 module Renderror
   extend Configuration
@@ -19,6 +21,7 @@ end
 module ActionController
   class Base
     include Renderror::AutoRescue
+    include Renderror::Validate
     include Renderror::Renderer
   end
 end

data/lib/renderror/auto_rescue.rb

@@ -3,12 +3,9 @@ module Renderror
     extend ActiveSupport::Concern
 
     PERMITTED_EXCEPTIONS = %i[
-      bad_request not_found invalid_document cancan
+      bad_request not_found invalid_document cancan conflict
     ].freeze
 
-    included do
-    end
-
     module ClassMethods
       def renderror_auto_rescue(*exceptions)
         sanitized_exceptions(exceptions).each do |e|
@@ -52,6 +49,12 @@ module Renderror
           )
         end
       end
+
+      def rescue_conflict
+        rescue_from Renderror::Conflict do |exception|
+          render_errors(exception)
+        end
+      end
     end
   end
 end

data/lib/renderror/base_error.rb

@@ -7,12 +7,12 @@ module Renderror
     end
 
     def to_json
-      {
-        'status' => status,
-        'title' => title,
-        'detail' => detail,
-        'pointer' => pointer
-      }
+      Hash.new.tap do |hash|
+        hash['status'] = status
+        hash['title'] = title
+        hash['detail'] = detail
+        hash['source'] = { 'pointer' => pointer } if pointer
+      end
     end
 
     def status

data/lib/renderror/conflict.rb

@@ -0,0 +1,15 @@
+module Renderror
+  class Conflict < Renderror::BaseError
+    def status
+      '409'
+    end
+
+    def default_title
+      I18n.t(:"renderror.conflict.title")
+    end
+
+    def default_detail
+      I18n.t(:"renderror.conflict.detail")
+    end
+  end
+end

data/lib/renderror/render_unprocessable.rb

@@ -13,10 +13,15 @@ module Renderror
         resource.errors.map do |field, error|
           Renderror::UnprocessableEntity.new(
             detail: resource.errors.full_message(field, error),
-            pointer: "/data/attributes/#{field.to_s.dasherize}"
+            pointer: pointer_for(field)
           )
         end
       end
+
+      def pointer_for(field)
+        return if field == :base
+        "/data/attributes/#{field.to_s.dasherize}"
+      end
     end
   end
 end

data/lib/renderror/renderer.rb

@@ -12,7 +12,8 @@ module Renderror
       include RenderInvalidAuthentication
 
       def render_errors(errors)
-        render json: { errors: errors.map(&:to_json) }, status: errors[0].status
+        render json: { errors: Array(errors).map(&:to_json) },
+               status: Array(errors)[0].status
       end
     end
   end

data/lib/renderror/validate.rb

@@ -0,0 +1,58 @@
+module Renderror
+  module Validate
+    extend ActiveSupport::Concern
+
+    PERMITTED_VALIDATIONS = %i[
+      jsonapi_type jsonapi_id
+    ].freeze
+
+    included do
+      def validate_jsonapi_type
+        return unless params['data'].present?
+
+        raise Renderror::Conflict unless type_matches?
+      end
+
+      def type_matches?
+        params['data'].try(:[], 'type') == jsonapi_type
+      end
+
+      # This can be overwritten on a per-controller basis if the type name
+      # doesn't match the controller name
+      def jsonapi_type
+        controller_name.dasherize
+      end
+
+      def validate_jsonapi_id
+        return unless params['data'].present?
+        return if id_matches?
+
+        raise Renderror::Conflict.new(detail: 'Incorrect resource ID')
+      end
+
+      def id_matches?
+        params.dig(:data, :id) == params[:id]
+      end
+    end
+
+    module ClassMethods
+      def renderror_validate(*validations)
+        sanitized_validations(validations).each do |validation|
+          send("validate_#{validation}")
+        end
+      end
+
+      def sanitized_validations(validation_list)
+        validation_list.select { |e| PERMITTED_VALIDATIONS.include? e }
+      end
+
+      def validate_jsonapi_type
+        before_action :validate_jsonapi_type, only: %i[create update]
+      end
+
+      def validate_jsonapi_id
+        before_action :validate_jsonapi_id, only: :update
+      end
+    end
+  end
+end

data/lib/renderror/version.rb

@@ -1,3 +1,3 @@
 module Renderror
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renderror
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Isaac Norman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-09 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,6 +111,7 @@ files:
 - lib/renderror/bad_request.rb
 - lib/renderror/base_error.rb
 - lib/renderror/configuration.rb
+- lib/renderror/conflict.rb
 - lib/renderror/forbidden.rb
 - lib/renderror/not_found.rb
 - lib/renderror/reform_unprocessable.rb
@@ -119,6 +120,7 @@ files:
 - lib/renderror/renderer.rb
 - lib/renderror/unauthorized.rb
 - lib/renderror/unprocessable_entity.rb
+- lib/renderror/validate.rb
 - lib/renderror/version.rb
 - renderror.gemspec
 homepage: https://github.com/Papercloud/renderror
@@ -142,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Render Errors Easily