jsonapi.rb 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28e026528b72f7e8474b8ac1c7dd868aa4dc31c2
-  data.tar.gz: bef3b693f87d95ea19dee1ea5af22899585153ca
+  metadata.gz: b5fdba9a2957365a5a46bcfa292bb65e4f7067ca
+  data.tar.gz: 4b2cd03a3045fd835f8f3461e1da9a6878fdc593
 SHA512:
-  metadata.gz: bc20a859dfdccfe05188360736c38b5575de904e26b7647218b27f511fc978c6ce6e546698734ba2add7c7dbfe009d32d12d192990e71122c164789be11079c4
-  data.tar.gz: 4b5e1a141b28cacb86e08c3276791e67cc297803b5de4632c22e5c5e89ad36812810bcb32e396d6c8e04196d1f8299184919444be125734519b6f9fc006107fa
+  metadata.gz: 163a80a360a5b29b4703f8086796ceaa08043c0bd44e13b7e0c89de706d7865dcfbb482e1635a05f4bc711bf8acc2155f7722c19b3aae1aa5f23e13f2828bebf
+  data.tar.gz: 34a34bc75f47186a076f7a1e1707b73c73cb498320f590010913eb107d2f95d1cde79720ce34d48f9bca1dc0c0eba9067a17ce353f149bc3eaccefbf5c57f741

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    jsonapi.rb (1.3.3)
+    jsonapi.rb (1.4.0)
       fast_jsonapi (~> 1.5)
       rack
       ransack

data/README.md

@@ -92,6 +92,25 @@ Please follow the
 [Fast JSON API guide](https://github.com/Netflix/fast_jsonapi#serializer-definition)
 on how to define a serializer.
 
+To provide a different naming scheme implement the `jsonapi_serializer_class`
+method in your resource or application controller.
+
+Here's an example:
+```ruby
+class CustomNamingController < ActionController::Base
+
+  # ...
+
+  private
+
+  def jsonapi_serializer_class(resource, is_collection)
+    JSONAPI::Rails.serializer_class(resource, is_collection)
+  rescue NameError
+    # your serializer class naming implementation
+  end
+end
+```
+
 #### Collection Meta
 
 To provide meta information for a collection, provide the `jsonapi_meta`
@@ -121,6 +140,9 @@ when a record is not found.
 
 To render the validation errors, just pass it to the error renderer.
 
+To use an exception notifier, overwrite the
+`render_jsonapi_internal_server_error` method in your controller.
+
 Here's an example:
 
 ```ruby
@@ -136,6 +158,14 @@ class MyController < ActionController::Base
       render jsonapi_errors: record.errors, status: :unprocessable_entity
     end
   end
+
+  private
+
+  def render_jsonapi_internal_server_error(exception)
+    # Call your exception notifier here. Example:
+    # Raven.capture_exception(exception)
+    super(exception)
+  end
 end
 ```
 

data/lib/jsonapi/errors.rb

@@ -10,39 +10,52 @@ module JSONAPI
     extend ActiveSupport::Concern
 
     included do
-      rescue_from StandardError do |exception|
-        error = { status: '500', title: Rack::Utils::HTTP_STATUS_CODES[500] }
-        render jsonapi_errors: [error], status: :internal_server_error
-      end
+      rescue_from StandardError, with: :render_jsonapi_internal_server_error
+      rescue_from ActiveRecord::RecordNotFound, with: :render_jsonapi_not_found
+      rescue_from(
+        ActionController::ParameterMissing,
+        with: :render_jsonapi_unprocessable_entity
+      )
+    end
 
-      [
-        ActiveRecord::RecordNotFound
-      ].each do |exception_class|
-        rescue_from exception_class do |exception|
-          error = { status: '404', title: Rack::Utils::HTTP_STATUS_CODES[404] }
-          render jsonapi_errors: [error], status: :not_found
-        end
-      end
+    private
 
-      [
-        ActionController::ParameterMissing
-      ].each do |exception_class|
-        rescue_from exception_class do |exception|
-          source = { pointer: '' }
+    # Generic error handler callback
+    #
+    # @param exception [Exception] instance to handle
+    # @return [String] JSONAPI error response
+    def render_jsonapi_internal_server_error(exception)
+      error = { status: '500', title: Rack::Utils::HTTP_STATUS_CODES[500] }
+      render jsonapi_errors: [error], status: :internal_server_error
+    end
 
-          if !%w{data attributes relationships}.include?(exception.param.to_s)
-            source[:pointer] = "/data/attributes/#{exception.param}"
-          end
+    # Not found (404) error handler callback
+    #
+    # @param exception [Exception] instance to handle
+    # @return [String] JSONAPI error response
+    def render_jsonapi_not_found(exception)
+      error = { status: '404', title: Rack::Utils::HTTP_STATUS_CODES[404] }
+      render jsonapi_errors: [error], status: :not_found
+    end
 
-          error = {
-            status: '422',
-            title: Rack::Utils::HTTP_STATUS_CODES[422],
-            source: source
-          }
+    # Unprocessable entity (422) error handler callback
+    #
+    # @param exception [Exception] instance to handle
+    # @return [String] JSONAPI error response
+    def render_jsonapi_unprocessable_entity(exception)
+      source = { pointer: '' }
 
-          render jsonapi_errors: [error], status: :unprocessable_entity
-        end
+      if !%w{data attributes relationships}.include?(exception.param.to_s)
+        source[:pointer] = "/data/attributes/#{exception.param}"
       end
+
+      error = {
+        status: '422',
+        title: Rack::Utils::HTTP_STATUS_CODES[422],
+        source: source
+      }
+
+      render jsonapi_errors: [error], status: :unprocessable_entity
     end
   end
 end

data/lib/jsonapi/rails.rb

@@ -39,7 +39,12 @@ module JSONAPI
 
         errors = []
         model = resource.instance_variable_get('@base')
-        model_serializer = JSONAPI::Rails.serializer_class(model, false)
+
+        if respond_to?(:jsonapi_serializer_class, true)
+          model_serializer = jsonapi_serializer_class(resource, false)
+        else
+          model_serializer = JSONAPI::Rails.serializer_class(model, false)
+        end
 
         details = resource.messages
         details = resource.details if resource.respond_to?(:details)
@@ -83,7 +88,12 @@ module JSONAPI
         options[:include] ||= (
           jsonapi_include if respond_to?(:jsonapi_include, true))
 
-        serializer_class = JSONAPI::Rails.serializer_class(resource, many)
+        if respond_to?(:jsonapi_serializer_class, true)
+          serializer_class = jsonapi_serializer_class(resource, many)
+        else
+          serializer_class = JSONAPI::Rails.serializer_class(resource, many)
+        end
+
         serializer_class.new(resource, options).serialized_json
       end
     end

data/lib/jsonapi/version.rb

@@ -1,3 +1,3 @@
 module JSONAPI
-  VERSION = '1.3.3'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi.rb
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Stas Suscov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_jsonapi