jsonapi-realizer 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4a1e03486bb8663b51ad6ea08cbb64c33fe80027183ef2639e70f8460680138
-  data.tar.gz: 680d9e08548505ac0c7bb26b948a46d2f66328979a41524622789074e58bbd56
+  metadata.gz: 8cb7f214558b3e9926ec20b9156c10d8e4b00bf29c1b8ef2bbade489a066ece2
+  data.tar.gz: 29abee993505d8728b4092542207541864baec6dfee5e8d5739996b6d58367d8
 SHA512:
-  metadata.gz: ad18e205c934375d6052faf8220a217e81e7f0c3d09dae35aaa8310807023cd259f4c7b7eece4b93737ec03398a7906ee0f4d23efd32837cd2461de3cb6300ff
-  data.tar.gz: 614fc08428ce221a595b026811add7e8d8c88f5139588c5f96f460cbee670c552339a8c8b1151ee0eb8218caa56ddaa5ff37c13acdfe46868987cf5ec42e3567
+  metadata.gz: 8ff7e820e1a2b5222afd5076e4822d31f706302501a1a020c9dd4ae5cb8c327d2cb741b3f687d2e376b876166d1aadd85bfab770542604f76e3ea4ab9d32f26f
+  data.tar.gz: cf2485faba6a11e199580c619aed6eb888be5a72cb2582ace2c3c29efda84fd6859c4ebc1cde89af841395e59594fa524e94ddf4c874154fd5da0d6a3cbbcbc9

data/README.md

@@ -63,7 +63,7 @@ class PhotosController < ApplicationController
 
     ProcessPhotosService.new(realization.model)
 
-    render json: JSONAPI::Serializer.serialize(record)
+    render json: JSONAPI::Serializer.serialize(realization.model)
   end
 
   def index
@@ -128,6 +128,7 @@ end
 ``` ruby
 class PhotosController < ApplicationController
   def index
+    # See: pundit for `policy_scope()`
     realization = JSONAPI::Realizer.index(
       policy(Photo).sanitize(:index, params),
       headers: request.headers,
@@ -135,9 +136,10 @@ class PhotosController < ApplicationController
       relation: policy_scope(Photo)
     )
 
-    # See: pundit for `policy_scope()`
     # See: pundit for `authorize()`
-    render json: JSONAPI::Serializer.serialize(authorize(realization.models), is_collection: true)
+    authorize(realization.relation)
+
+    render json: JSONAPI::Serializer.serialize(realization.models, is_collection: true)
   end
 end
 ```
@@ -181,6 +183,121 @@ class PhotoRealizer
 end
 ```
 
+### rails and jsonapi-realizer and jsonapi-serializers and pundit
+
+While this gem contains nothing specifically targeting Rails or pundit or [jsonapi-serializers](https://github.com/fotinakis/jsonapi-serializers) (a fantastic gem) I've already written some seamless integration code. This root controller will handle exceptions in a graceful way and also give you access to a clean interface for serializing:
+
+``` ruby
+module V1
+  class ApplicationController < ::ApplicationController
+    include Pundit
+
+    after_action :verify_authorized, except: :index
+    after_action :verify_policy_scoped, only: :index
+
+    rescue_from JSONAPI::Realizer::Error::MissingAcceptHeader, with: :missing_accept_header
+    rescue_from JSONAPI::Realizer::Error::InvalidAcceptHeader, with: :invalid_accept_header
+    rescue_from Pundit::NotAuthorizedError, with: :access_not_authorized
+
+    private def missing_accept_header
+      head :not_acceptable
+    end
+
+    private def invalid_accept_header
+      head :not_acceptable
+    end
+
+    private def access_not_authorized
+      head :unauthorized
+    end
+
+    private def pundit_user
+      current_account
+    end
+
+    private def serialize(realization)
+      JSONAPI::Serializer.serialize(
+        if realization.respond_to?(:models) then realization.models else realization.model end,
+        is_collection: realization.respond_to?(:models),
+        meta: serialized_metadata,
+        links: serialized_links,
+        jsonapi: serialized_jsonapi,
+        fields: serialized_fields(realization),
+        include: serialized_includes(realization),
+        namespace: ::V1
+      )
+    end
+
+    private def serialized_metadata
+      {
+        api: {
+          version: "1"
+        }
+      }
+    end
+
+    private def serialized_links
+      {
+        discovery: {
+          href: "/"
+        }
+      }
+    end
+
+    private def serialized_jsonapi
+      {
+        version: "1.0"
+      }
+    end
+
+    private def serialized_fields(realization)
+      realization.fields if realization.fields.any?
+    end
+
+    private def serialized_includes(realization)
+      realization.includes if realization.includes.any?
+    end
+  end
+end
+```
+
+You can see this resource controller used below:
+
+``` ruby
+module V1
+  class AccountsController < ::V1::ApplicationController
+    def index
+      realization = JSONAPI::Realizer.index(
+        policy(Account).sanitize(:index, params),
+        headers: request.headers,
+        scope: policy_scope(Account),
+        type: :accounts
+      )
+
+      authorize realization.relation
+
+      render json: serialize(realization)
+    end
+
+    def create
+      realization = JSONAPI::Realizer.create(
+        policy(Account).sanitize(:create, params),
+        headers: request.headers,
+        scope: policy_scope(Account)
+      )
+
+      authorize realization.relation
+
+      render json: serialize(realization)
+    end
+  end
+end
+```
+
+### jsonapi-home
+
+I'm already using jsonapi-realizer and it's sister project jsonapi-serializers in a new gem of mine that allows services to be discoverable: [jsonapi-home](https://github.com/krainboltgreene/jsonapi-home).
+
 ### Notes
 
 A successful JSON:API request can be annotated as:
@@ -206,7 +323,7 @@ BusinessLayer -> JSONAPIRequest -> (Record | Array<Record>)
 
 Add this line to your application's Gemfile:
 
-    gem "jsonapi-realizer", "3.0.0"
+    gem "jsonapi-realizer", "4.1.0"
 
 And then execute:
 

data/lib/jsonapi/realizer.rb

@@ -4,7 +4,7 @@ require "active_support/core_ext/enumerable"
 require "active_support/core_ext/string"
 
 module JSONAPI
-  MEDIA_TYPE = "application/vnd.api+json"
+  MEDIA_TYPE = "application/vnd.api+json" unless const_defined?("MEDIA_TYPE")
 
   module Realizer
     require_relative "realizer/version"

data/lib/jsonapi/realizer/action.rb

@@ -51,7 +51,7 @@ module JSONAPI
         end
       end
 
-      private def relation
+      def relation
         relation_after_fields(
           relation_after_inclusion(
             @scope || model_class

data/lib/jsonapi/realizer/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Realizer
-    VERSION = "4.0.1"
+    VERSION = "4.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-realizer
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene