grape-jsonapi 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7774831ab89dff300b99065123ca93b91950cdda6254f1b8eaf01588736d345a
-  data.tar.gz: 6592eb7bf01db5b64f3d777c3f77d2b49a34e0cc3dc6e1459e2f2b64ef851067
+  metadata.gz: 03c4961342732b83760ea4e20cd449d09f24002bb1645547f7199b4d12aa3b92
+  data.tar.gz: fd68faabd39cbf1332c80b0594a072f3a87b0fa8b58a667ab7ab2f40df4cadc4
 SHA512:
-  metadata.gz: 724fb0160e489a260e539768f587220ca66c3b37fdf21d047ab23b1303b587ce4382218da97457bf5827ec3e8c3cbb2c84b51cf7565d93c1c30f435b12ad21c9
-  data.tar.gz: 380f98e0324834f5a5d6e50f91475ab1a778735fc797a9289713aed8c01b01db5bf95b04026b9134219bb4309e36cea3ef3f8fb0042a744c5e77af6329ca1982
+  metadata.gz: ad33df912cd3ac52fcdb8fedc7b8189d02d51121d2d09edf5f6b2a6bea7bb38a5860fb692f30e2e35d6bc09aad898e486165f573af345f037e92c8c3dec8d77e
+  data.tar.gz: 1ce5157fcdcfce58aa55abe37d72708fbe414b86d67c9dbde31b9ca118eb3cee53b10b99dc1a07815468ce400995602b6d3523abf3cbb496d3dcdaa3509df801

data/CHANGELOG.md

@@ -1,13 +1,23 @@
 ## Changelog
 
-### v1.0.1 (next)
+### v1.0.2 (next)
 
 * Your contribution here.
 
+### v1.0.1 (January 25, 2022)
+
+[#32](https://github.com/EmCousin/grape-jsonapi/pull/32) - [@EmCousin](https://github.com/EmCousin)
+
+* The gem now forces API response to have a JSONAPI compliant format, even for objects that are not being serialized via a `JSONAPI::Serializer`
+* You can now customize the `meta` and `links` properties of your response at rendering time, without having to rely on your serializers (check README.md for more information)
+* Changed the response's data structure when the object is a heterogeneous collection (a list of objects of different classes), to make it JSONAPI compliant.
+* Fixed a defect that was causing empty hashes to be rendered as empty arrays
+
 ### v1.0.0 (November 21, 2020)
 
 [#14](https://github.com/EmCousin/grape_fast_jsonapi/pull/14) - [@EmCousin](https://github.com/EmCousin)
 
+* renamed gem from `grape_fast_jsonapi` to `grape-jsonapi`
 * Changed dependency from [fast_jsonapi](https://github.com/Netflix/fast_jsonapi) to [jsonapi-serializer](https://github.com/jsonapi-serializer/jsonapi-serializer)
 * Deprecated `Grape::Formatter::FastJsonapi` and `Grape::FastJsonapi::Parser` in favor to `Grape::Formatter::Jsonapi` and `Grape::Jsonapi::Parser`. Will be removed in v1.1
 * Fixed bugs due to breaking changes caused by the switch

data/Gemfile.lock

@@ -8,64 +8,68 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.4)
-      actionpack (= 6.0.3.4)
+    actioncable (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionmailbox (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
+    actionmailer (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      actionview (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.3.2)
+      actionview (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actiontext (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionview (6.1.3.2)
+      activesupport (= 6.1.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activejob (6.1.3.2)
+      activesupport (= 6.1.3.2)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activestorage (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.4)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activestorage (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     builder (3.2.4)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
     diff-lcs (1.4.4)
     dry-configurable (0.11.6)
@@ -100,67 +104,67 @@ GEM
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jsonapi-serializer (2.1.0)
       activesupport (>= 4.2)
-    loofah (2.8.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.1)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
+    mini_mime (1.0.3)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.0.1)
       mustermann (>= 1.0.0)
-    nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nio4r (2.5.7)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
     parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
+    racc (1.5.2)
     rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.4)
-      actioncable (= 6.0.3.4)
-      actionmailbox (= 6.0.3.4)
-      actionmailer (= 6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actiontext (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      bundler (>= 1.3.0)
-      railties (= 6.0.3.4)
+    rails (6.1.3.2)
+      actioncable (= 6.1.3.2)
+      actionmailbox (= 6.1.3.2)
+      actionmailer (= 6.1.3.2)
+      actionpack (= 6.1.3.2)
+      actiontext (= 6.1.3.2)
+      actionview (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    railties (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
     regexp_parser (2.0.0)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -194,15 +198,14 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -216,4 +219,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Emmanuel Cousin
+Copyright (c) 2018-2021 Emmanuel Cousin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -6,11 +6,10 @@ Use [jsonapi-serializer](https://github.com/jsonapi-serializer/jsonapi-serialize
 
 ## Installation
 
-Add the `grape` and `grape-jsonapi` gems to Gemfile.
+Add `grape-jsonapi` to your Gemfile.
 
 ```ruby
-gem 'grape'
-gem 'grape-jsonapi'
+gem 'grape-jsonapi', require: "grape_jsonapi"
 ```
 
 ## Usage
@@ -52,6 +51,16 @@ get "/" do
 end
 ```
 
+### Override `meta`and `links` properties
+
+`meta` and `links` properties are usually defined per resource within your serializer ([here](https://github.com/jsonapi-serializer/jsonapi-serializer#meta-per-resource) and [here](https://github.com/jsonapi-serializer/jsonapi-serializer#links-per-object))
+
+However, if you need to override those properties, you can pass them as options when rendering your response:
+```ruby
+user = User.find("123")
+render user, meta: { pagination: { page: 1, total: 42 } }, links: { self: 'https://my-awesome.app.com/users/1' }
+```
+
 ### Model parser for response documentation
 
 When using Grape with Swagger via [grape-swagger](https://github.com/ruby-grape/grape-swagger), you can generate response documentation automatically via the provided following model parser:

data/lib/grape_jsonapi/formatter.rb

@@ -5,11 +5,10 @@ module Grape
     module Jsonapi
       class << self
         def call(object, env)
-          return object if object.is_a?(String)
-          return ::Grape::Json.dump(serialize(object, env)) if serializable?(object)
-          return object.to_json if object.respond_to?(:to_json)
-
-          ::Grape::Json.dump(object)
+          response = serializable?(object) ? serialize(object, env) : { data: object }
+          ::Grape::Json.dump(
+            response.merge(env.slice('meta', 'links'))
+          )
         end
 
         private
@@ -25,17 +24,17 @@ module Grape
         def serialize(object, env)
           if object.respond_to?(:serializable_hash)
             serializable_object(object, jsonapi_options(env)).serializable_hash
-          elsif serializable_collection?(object)
-            serializable_collection(object, jsonapi_options(env))
           elsif object.is_a?(Hash)
             serialize_each_pair(object, env)
+          elsif serializable_collection?(object)
+            serializable_collection(object, env)
           else
             object
           end
         end
 
         def serializable_collection?(object)
-          object.respond_to?(:to_a) && object.all? do |o|
+          !object.nil? && object.respond_to?(:to_a) && object.any? && object.all? do |o|
             o.respond_to?(:serializable_hash)
           end
         end
@@ -48,13 +47,13 @@ module Grape
           serializable_class(object, options)&.new(object, options)
         end
 
-        def serializable_collection(collection, options)
+        def serializable_collection(collection, env)
           if heterogeneous_collection?(collection)
-            collection.map do |o|
-              serialize_resource(o, options)
+            collection.each_with_object({ data: [] }) do |o, hash|
+              hash[:data].push(serialize_resource(o, env)[:data])
             end
           else
-            serialize_resource(collection, options)
+            serialize_resource(collection, env)
           end
         end
 
@@ -62,8 +61,10 @@ module Grape
           collection.map { |item| item.class.name }.uniq.many?
         end
 
-        def serialize_resource(resource, options)
-          jsonapi_serializable(resource, options)&.serializable_hash || resource.map(&:serializable_hash)
+        def serialize_resource(resource, env)
+          jsonapi_serializable(resource, jsonapi_options(env))&.serializable_hash || resource.map do |item|
+            serialize(item, env)
+          end
         end
 
         def serializable_class(object, options)
@@ -78,8 +79,15 @@ module Grape
         end
 
         def serialize_each_pair(object, env)
-          h = {}
-          object.each_pair { |k, v| h[k] = serialize(v, env) }
+          h = { data: {} }
+          object.each_pair do |k, v|
+            serialized_value = serialize(v, env)
+            h[:data][k] = if serialized_value.is_a?(Hash) && serialized_value[:data]
+                            serialized_value[:data]
+                          else
+                            serialized_value
+                          end
+          end
           h
         end
 

data/lib/grape_jsonapi/version.rb

@@ -2,6 +2,6 @@
 
 module Grape
   module Jsonapi
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/spec/lib/grape_jsonapi/formatter_spec.rb

@@ -18,12 +18,15 @@ describe Grape::Formatter::Jsonapi do
     describe '.call' do
       subject { described_class.call(object, env) }
       let(:jsonapi_serializer_options) { nil }
-      let(:env) { { 'jsonapi_serializer_options' => jsonapi_serializer_options } }
+      let(:meta) { { pagination: { page: 1, total: 2 } } }
+      let(:links) { { self: 'https://example/org' } }
+      let(:env) { { 'jsonapi_serializer_options' => jsonapi_serializer_options, 'meta' => meta, 'links' => links } }
 
       context 'when the object is a string' do
         let(:object) { 'I am a string' }
+        let(:response) { ::Grape::Json.dump({ data: object, meta: meta, links: links }) }
 
-        it { is_expected.to eq object }
+        it { is_expected.to eq response }
       end
 
       context 'when the object is serializable' do
@@ -33,76 +36,102 @@ describe Grape::Formatter::Jsonapi do
 
         context 'when the object has a model_name defined' do
           let(:object) { admin }
-          it { is_expected.to eq ::Grape::Json.dump(user_serializer.serializable_hash) }
+          let(:response) { ::Grape::Json.dump(user_serializer.serializable_hash.merge(meta: meta, links: links)) }
+
+          it { is_expected.to eq response }
         end
 
         context 'when the object is a active serializable model instance' do
           let(:object) { user }
+          let(:response) { ::Grape::Json.dump(user_serializer.serializable_hash.merge(meta: meta, links: links)) }
 
-          it { is_expected.to eq ::Grape::Json.dump(user_serializer.serializable_hash) }
+          it { is_expected.to eq response }
         end
 
-        context 'when the object is an array of active serializable model instances' do
-          let(:object) { [user, another_user] }
-
-          it { is_expected.to eq ::Grape::Json.dump(user_serializer.serializable_hash) }
-        end
+        context 'when the object is an array' do
+          context 'when the object is an array of active serializable model instances' do
+            let(:object) { [user, another_user] }
+            let(:response) { ::Grape::Json.dump(user_serializer.serializable_hash.merge(meta: meta, links: links)) }
 
-        context 'when the array contains instances of different models' do
-          let(:object) { [user, blog_post] }
+            it { is_expected.to eq response }
+          end
 
-          it 'returns an array of jsonapi serialialized objects' do
-            expect(subject).to eq(::Grape::Json.dump([
-                                                       UserSerializer.new(user, {}).serializable_hash,
-                                                       BlogPostSerializer.new(blog_post, {}).serializable_hash
-                                                     ]))
+          context 'when the array contains instances of different models' do
+            let(:object) { [user, blog_post] }
+            let(:response) do
+              ::Grape::Json.dump({
+                data: [
+                  UserSerializer.new(user, {}).serializable_hash[:data],
+                  BlogPostSerializer.new(blog_post, {}).serializable_hash[:data]
+                ],
+                meta: meta,
+                links: links
+              })
+            end
+
+            it 'returns an array of jsonapi serialialized objects' do
+              expect(subject).to eq response
+            end
           end
-        end
 
-        context 'when the object is an empty array ' do
-          let(:object) { [] }
+          context 'when the object is an empty array' do
+            let(:object) { [] }
 
-          it { is_expected.to eq ::Grape::Json.dump(object) }
-        end
+            it { is_expected.to eq({ data: [], meta: meta, links: links }.to_json) }
+          end
 
-        context 'when the object is an array of null objects ' do
-          let(:object) { [nil, nil] }
+          context 'when the object is an array of null objects' do
+            let(:object) { [nil, nil] }
 
-          it { is_expected.to eq ::Grape::Json.dump(object) }
+            it { is_expected.to eq({ data: [nil, nil], meta: meta, links: links }.to_json) }
+          end
         end
 
-        context 'when the object is a Hash of plain values' do
-          let(:object) { user.as_json }
+        context 'when the object is a hash' do
+          context 'when the object is an empty hash' do
+            let(:object) { {} }
 
-          it { is_expected.to eq ::Grape::Json.dump(object) }
-        end
+            it { is_expected.to eq({ data: {}, meta: meta, links: links }.to_json) }
+          end
 
-        context 'when the object is a Hash with serializable object values' do
-          let(:object) do
-            {
-              user: user,
-              blog_post: blog_post
-            }
+          context 'when the object is a Hash of plain values' do
+            let(:object) { user.as_json }
+
+            it { is_expected.to eq ::Grape::Json.dump({ data: user.as_json, meta: meta, links: links }) }
           end
 
-          it 'returns an hash of with jsonapi serialialized objects values' do
-            expect(subject).to eq(::Grape::Json.dump({
-                                                       user: UserSerializer.new(user, {}).serializable_hash,
-                                                       blog_post: BlogPostSerializer.new(blog_post, {}).serializable_hash
-                                                     }))
+          context 'when the object is a Hash with serializable object values' do
+            let(:object) do
+              { user: user, blog_post: blog_post }
+            end
+
+            let(:response) do
+              ::Grape::Json.dump({
+                data: {
+                  user: UserSerializer.new(user, {}).serializable_hash[:data],
+                  blog_post: BlogPostSerializer.new(blog_post, {}).serializable_hash[:data]
+                },
+                meta: meta,
+                links: links
+              })
+            end
+
+            it 'returns an hash of with jsonapi serialialized objects values' do
+              expect(subject).to eq response
+            end
           end
         end
 
         context 'when the object is nil' do
           let(:object) { nil }
 
-          it { is_expected.to eq 'null' }
+          it { is_expected.to eq({ data: nil, meta: meta, links: links }.to_json) }
         end
 
         context 'when the object is a number' do
           let(:object) { 42 }
 
-          it { is_expected.to eq '42' }
+          it { is_expected.to eq({ data: 42, meta: meta, links: links }.to_json) }
         end
 
         context 'when a custom serializer is passed as an option' do
@@ -113,7 +142,7 @@ describe Grape::Formatter::Jsonapi do
             }
           end
 
-          it { is_expected.to eq ::Grape::Json.dump(another_user_serializer.serializable_hash) }
+          it { is_expected.to eq ::Grape::Json.dump(another_user_serializer.serializable_hash.merge(meta: meta, links: links)) }
         end
       end
     end

data/spec/lib/grape_jsonapi/version_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 describe Grape::Jsonapi::VERSION do
-  it { is_expected.to eq '1.0.0'.freeze }
+  it { is_expected.to eq '1.0.1'.freeze }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-jsonapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Emmanuel Cousin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Use grape-jsonapi in grape