fun_with_json_api 0.0.10.4 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54c93718f1cb92ae625dcd73d881f2cecbf44337
-  data.tar.gz: 07c36b9edb2e9c2a75f087ec50f3ff400c1afbc0
+  metadata.gz: 1328b91ef284a304fd92db41e7a2aadb2a095e2a
+  data.tar.gz: 0f457c751fa862274f6a164bc0f4a99896e99bb8
 SHA512:
-  metadata.gz: 037d0ef8274786cbbd68f8d7dae99bf44fed9b0e2e66e54471bb5439435dccbc9f7f893b6ce217cb08f002824d94fc58c22099d804d909bbe7b0826e64cf73a8
-  data.tar.gz: 732c3c878bc211b460fc5d2160e49d10af538d8848eecf70aadff0d15fcdedac1d4bda2cf308a6e645e36656de08885a64c1035c782be70f817701bb6d7c97f0
+  metadata.gz: 2901cbad60ecfb0558f25561f00953f99b898930e9812f28ee71e6984b7abb49bbecc96747451485b88923edc3696edf84a381dccfb52c0912c3aae759b205a0
+  data.tar.gz: 3c1a3fec849e9b3a93a030c3c6d767f21ff3e37c62efbb9dc8b8375276a4ad811c66f8732d3286b5972f9c013718f75da9511385e77eeb5c7c69bd883fc6d01a

data/config/locales/fun_with_json_api.en.yml

@@ -1,6 +1,7 @@
 en:
   fun_with_json_api:
     exceptions:
+      invalid_request_body: 'Request json_api body could not be parsed'
       invalid_document: 'Request json_api document is invalid'
       invalid_document_identifier: 'Request json_api data id is invalid'
       invalid_client_generated_identifier: 'Request json_api data id has already been used for an existing resource'
@@ -27,6 +28,7 @@ en:
       invalid_uuid_v4_attribute: 'UUID value must be RFC 4122 Version 4 UUID (i.e. "f47ac10b-58cc-4372-a567-0e02b2c3d479")'
       collection_method_not_supported: 'The current relationship does not support this action'
     schema_validators:
+      document_id_is_not_a_string_message: data id value must be a JSON String (i.e. "1234")
       document_id_does_not_match_resource: "Expected data id to match resource at endpoint: %{expected}"
       document_type_does_not_match_endpoint: "Expected data type to be a '%{expected}' resource"
       invalid_relationship_type_in_array: "Expected '%{relationship}' relationship to be an Array of '%{relationship_type}' resource identifiers"

data/lib/fun_with_json_api/configuration.rb

@@ -0,0 +1,10 @@
+module FunWithJsonApi
+  class Configuration
+    attr_accessor :force_render_parse_errors_as_json_api
+    alias force_render_parse_errors_as_json_api? force_render_parse_errors_as_json_api
+
+    def initialize
+      @force_render_parse_errors_as_json_api = false
+    end
+  end
+end

data/lib/fun_with_json_api/middleware/catch_json_api_parse_errors.rb

@@ -0,0 +1,36 @@
+module FunWithJsonApi
+  module Middleware
+    class CatchJsonApiParseErrors
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      rescue ActionDispatch::ParamsParser::ParseError => error
+        if env['CONTENT_TYPE'] == FunWithJsonApi::MEDIA_TYPE && respond_with_json_api_error?(env)
+          build_json_api_parse_error_response
+        else
+          raise error
+        end
+      end
+
+      private
+
+      def build_json_api_parse_error_response
+        title = I18n.t('fun_with_json_api.exceptions.invalid_request_body')
+        [
+          400, { 'Content-Type' => FunWithJsonApi::MEDIA_TYPE },
+          [
+            { errors: [{ code: 'invalid_request_body', title: title, status: '400' }] }.to_json
+          ]
+        ]
+      end
+
+      def respond_with_json_api_error?(env)
+        FunWithJsonApi.configuration.force_render_parse_errors_as_json_api? ||
+          env['HTTP_ACCEPT'] =~ %r{application\/vnd\.api\+json}
+      end
+    end
+  end
+end

data/lib/fun_with_json_api/railtie.rb

@@ -1,12 +1,15 @@
 require 'fun_with_json_api/controller_methods'
 require 'fun_with_json_api/action_controller_extensions/serialization'
+require 'fun_with_json_api/middleware/catch_json_api_parse_errors'
 
 Mime::Type.register FunWithJsonApi::MEDIA_TYPE, :json_api
 
 module FunWithJsonApi
   # Mountable engine for fun with json_api
   class Railtie < Rails::Railtie
-    initializer :register_json_api_mime_type do
+    class ParseError < ::StandardError; end
+
+    initializer :register_json_api_parser do |app|
       parsers =
         if Rails::VERSION::MAJOR >= 5
           ActionDispatch::Http::Parameters
@@ -19,6 +22,18 @@ module FunWithJsonApi
         data = { _json: data } unless data.is_a?(Hash)
         data.with_indifferent_access
       end
+
+      # Add Middleware for catching parser errors
+      if Rails::VERSION::MAJOR >= 5
+        ActionDispatch::Request.parameter_parsers = parsers::DEFAULT_PARSERS
+        app.config.middleware.use(
+          'FunWithJsonApi::Middleware::CatchJsonApiParseErrors'
+        )
+      else
+        app.config.middleware.insert_before(
+          parsers, 'FunWithJsonApi::Middleware::CatchJsonApiParseErrors'
+        )
+      end
     end
     initializer :register_json_api_renderer do
       ActionController::Renderers.add :json_api do |json, options|

data/lib/fun_with_json_api/schema_validators/check_document_id_matches_resource.rb

@@ -20,14 +20,27 @@ module FunWithJsonApi
       def call
         if resource.try(:persisted?)
           # Ensure correct update document is being sent
+          check_resource_id_is_a_string
           check_resource_id_matches_document_id
         elsif document_id
           # Ensure correct create document is being sent
+          check_resource_id_is_a_string
           check_resource_id_can_be_client_generated
           check_resource_id_has_not_already_been_used
         end
       end
 
+      def check_resource_id_is_a_string
+        unless document_id.is_a?(String)
+          payload = ExceptionPayload.new(
+            detail: document_id_is_not_a_string_message,
+            pointer: '/data/id'
+          )
+          message = "document id is not a string: #{document_id.class.name}"
+          raise Exceptions::InvalidDocumentIdentifier.new(message, payload)
+        end
+      end
+
       def check_resource_id_matches_document_id
         if document_id != resource_id
           message = "resource id '#{resource_id}' does not match the expected id for"\
@@ -67,6 +80,13 @@ module FunWithJsonApi
 
       private
 
+      def document_id_is_not_a_string_message
+        I18n.t(
+          :document_id_is_not_a_string_message,
+          scope: 'fun_with_json_api.schema_validators'
+        )
+      end
+
       def document_id_does_not_match_resource_message
         I18n.t(
           :document_id_does_not_match_resource,

data/lib/fun_with_json_api/version.rb

@@ -1,3 +1,3 @@
 module FunWithJsonApi
-  VERSION = '0.0.10.4'.freeze
+  VERSION = '0.0.11'.freeze
 end

data/lib/fun_with_json_api.rb

@@ -1,6 +1,7 @@
 require 'fun_with_json_api/exception'
 require 'fun_with_json_api/attribute'
 
+require 'fun_with_json_api/configuration'
 require 'fun_with_json_api/pre_deserializer'
 require 'fun_with_json_api/deserializer'
 require 'fun_with_json_api/schema_validator'
@@ -14,6 +15,16 @@ module FunWithJsonApi
 
   module_function
 
+  attr_writer :configuration
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield(configuration)
+  end
+
   def deserialize(document, deserializer_class, resource = nil, options = {})
     # Prepare the deserializer and the expected config
     deserializer = deserializer_class.create(options)

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,5 +1,13 @@
 class ApplicationController < ActionController::Base
+  include FunWithJsonApi::ControllerMethods
+
+  rescue_from FunWithJsonApi::Exception, with: :render_fun_with_json_api_exception
+
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
+
+  def echo
+    render json: params.slice(:data)
+  end
 end

data/spec/dummy/config/application.rb

@@ -20,6 +20,6 @@ module Dummy
     # config.i18n.default_locale = :de
 
     # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
+    # config.active_record.raise_in_transactional_callbacks = true
   end
 end

data/spec/dummy/config/environments/test.rb

@@ -13,8 +13,13 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static file server for tests with Cache-Control for performance.
-  config.serve_static_files   = true
-  config.static_cache_control = 'public, max-age=3600'
+  if config.respond_to?(:public_file_server)
+    config.public_file_server.enabled = true
+    config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+  else
+    config.serve_static_files   = true
+    config.static_cache_control = 'public, max-age=3600'
+  end
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true

data/spec/dummy/config/routes.rb

@@ -53,4 +53,7 @@ Rails.application.routes.draw do
   #     # (app/controllers/admin/products_controller.rb)
   #     resources :products
   #   end
+
+  # Takes a valid json_api request, and echos the payload back as json
+  post :echo, to: 'application#echo'
 end