grape_fast_jsonapi 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23959b13a1fe539f5657f5e4da15712f2da6c2010c05e415426523d419831c60
-  data.tar.gz: a5ebffa2ce6617034be70fc2a52f7a876d7d894d52ab2e865036060bf3934462
+  metadata.gz: 1b2ef04c9a3d2b69160a93779d60466a90a93fed1bf1109e1e32c91e8632bad8
+  data.tar.gz: 1ba50c7bdf05a933b7c736f2a4f36e55f5bc3d4742bb2d552260760eb63dffe2
 SHA512:
-  metadata.gz: 44fd2eb2f433d265376c4e70b3d4a2a10b211a95f8251f041c1a6e0bc3825eaf4d0efcb1977a9e08cf77e479ca81f5d9fba1214b7afc925b018f7d87d74c74e1
-  data.tar.gz: 842921a39b89166e57d0286db7c6dfee887821251089c6d57a5050856582cd52c06e698544ccd3740f805a7322aba0e09020fe9cfc348a9115b80750f5854fc2
+  metadata.gz: d5175b87b19aca5fd04a5532d901ff03f41c06f1792de26f15b0c452f5e8a3357a0237a3ad6c835bb19da20cb3b09133e08b093e3680837307e3fa23d57b1317
+  data.tar.gz: 148a701839831d1b6b384b93ceddcfe07799eef6b233ec7e8df449711e94a2b4cf673cc859ab8760a96f4d20d85b4ff3c16d487c63489fac589eac3e88485c8e

data/CHANGELOG.md

@@ -1,14 +1,21 @@
 ## Changelog
 
-### v0.2.2 (Next)
+### v0.2.4 (Next)
 
 * Your contribution here.
 
+### v0.2.3 (December 12, 2019)
+
+* Reverted v0.2.2 and bumped `loofah` using `dependabot`
+
+### v0.2.2 (December 12, 2019)
+
+* Fixed low severity vulnerabiliy issue with `loofah` dependency
+
 ### v0.2.1 (September 18, 2019)
 
 * [#12](https://github.com/EmCousin/grape_fast_jsonapi/pull/12) - Removed call to `rails` and fixed a potential security issue
 
-
 ### v0.2.0 (February 8, 2019)
 
 * [#5](https://github.com/EmCousin/grape_fast_jsonapi/pull/5): Provide custom Grape Swagger parser for fast_jsonapi object serializers, as well as unit test coverage - [@EmCousin](https://github.com/EmCousin)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape_fast_jsonapi (0.2.1)
+    grape_fast_jsonapi (0.2.3)
       fast_jsonapi (>= 1.5)
       grape
 
@@ -71,7 +71,7 @@ GEM
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.1.5)
-    crass (1.0.4)
+    crass (1.0.5)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
@@ -91,7 +91,7 @@ GEM
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    loofah (2.2.3)
+    loofah (2.3.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -107,7 +107,7 @@ GEM
     mustermann-grape (1.0.0)
       mustermann (~> 1.0.0)
     nio4r (2.5.1)
-    nokogiri (1.10.4)
+    nokogiri (1.10.5)
       mini_portile2 (~> 2.4.0)
     rack (2.0.7)
     rack-accept (0.4.5)

data/README.md

@@ -32,6 +32,24 @@ get "/" do
 end
 ```
 
+### Use a custom serializer
+
+```ruby
+get "/" do
+  user = User.find("123")
+  render user, serializer: 'CustomUserSerializer'
+end
+```
+
+Or
+
+```ruby
+get "/" do
+  user = User.find("123")
+  render CustomUserSerializer.new(user).serialized_json
+end
+```
+
 ### 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_fast_jsonapi/formatter.rb

@@ -36,22 +36,32 @@ module Grape
         end
 
         def fast_jsonapi_serializable(object, options)
-          serializable_class(object)&.new(object, options)
+          serializable_class(object, options)&.new(object, options)
         end
 
         def serializable_collection(collection, options)
-          if collection.map(&:model_name).uniq.count > 1
+         if heterogeneous_collection?(collection)
             collection.map do |o|
               fast_jsonapi_serializable(o, options).serializable_hash || o.map(&:serializable_hash)
             end
           else
-            fast_jsonapi_serializable(collection, options).serializable_hash || collection.map(&:serializable_hash)
+            fast_jsonapi_serializable(collection, options)&.serializable_hash || collection.map(&:serializable_hash)
           end
         end
 
-        def serializable_class(object)
-          object = object.first if object.is_a?(Array)
-          (object.model_name.name + 'Serializer').safe_constantize
+        def heterogeneous_collection?(collection)
+          collection.map { |item| item.class.name }.uniq.size > 1
+        end
+
+        def serializable_class(object, options)
+          klass_name = options['serializer'] || options[:serializer]
+          klass_name ||= begin
+            object = object.first if object.is_a?(Array)
+
+            object.class.name + 'Serializer'
+          end
+
+          klass_name&.safe_constantize
         end
 
         def serialize_each_pair(object, env)

data/lib/grape_fast_jsonapi/version.rb

@@ -2,6 +2,6 @@
 
 module Grape
   module FastJsonapi
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.2.3'.freeze
   end
 end

data/spec/lib/grape_fast_jsonapi/formatter_spec.rb

@@ -14,7 +14,8 @@ describe Grape::Formatter::FastJsonapi do
 
     describe '.call' do
       subject { described_class.call(object, env) }
-      let(:env) { {} }
+      let(:fast_jsonapi_options) { nil }
+      let(:env) { { 'fast_jsonapi_options' => fast_jsonapi_options } }
 
       context 'when the object is a string' do
         let(:object) { "I am a string" }
@@ -24,6 +25,7 @@ describe Grape::Formatter::FastJsonapi do
 
       context 'when the object is serializable' do
         let(:user_serializer) { UserSerializer.new(object, {}) }
+        let(:another_user_serializer) { AnotherUserSerializer.new(object, {}) }
         let(:blog_post_serializer) { BlogPostSerializer.new(object, {}) }
 
         context 'when the object is a active serializable model instance' do
@@ -36,19 +38,31 @@ describe Grape::Formatter::FastJsonapi do
           let(:object) { [user, another_user] }
 
           it { is_expected.to eq ::Grape::Json.dump(user_serializer.serializable_hash) }
+        end
 
-          context "when the array contains instances of different models" do
-            let(:object) { [user, blog_post] }
+        context "when the array contains instances of different models" do
+          let(:object) { [user, blog_post] }
 
-            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
-              ]))
-            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
+            ]))
           end
         end
 
+        context 'when the object is an empty array ' do
+          let(:object) { [] }
+
+          it { is_expected.to eq ::Grape::Json.dump(object) }
+        end
+
+        context 'when the object is an array of null objects ' do
+          let(:object) { [nil, nil] }
+
+          it { is_expected.to eq ::Grape::Json.dump(object) }
+        end
+
         context 'when the object is a Hash of plain values' do
           let(:object) { user.as_json }
 
@@ -82,6 +96,15 @@ describe Grape::Formatter::FastJsonapi do
 
           it { is_expected.to eq '42' }
         end
+
+        context 'when a custom serializer is passed as an option' do
+          let(:object) { user }
+          let(:fast_jsonapi_options) { {
+            'serializer' => '::AnotherUserSerializer'
+          } }
+
+          it { is_expected.to eq ::Grape::Json.dump(another_user_serializer.serializable_hash) }
+        end
       end
     end
   end

data/spec/lib/grape_fast_jsonapi/version_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 describe Grape::FastJsonapi::VERSION do
-  it { is_expected.to eq '0.2.1' }
+  it { is_expected.to eq '0.2.3' }
 end

data/spec/support/models/blog_post.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 class BlogPost
-  extend ActiveModel::Naming
   include ActiveModel::Serialization
 
   attr_accessor :id, :title, :body

data/spec/support/models/user.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 class User
-  extend ActiveModel::Naming
   include ActiveModel::Serialization
 
   attr_accessor :id, :first_name, :last_name, :password, :email

data/spec/support/serializers/another_user_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AnotherUserSerializer
+  include FastJsonapi::ObjectSerializer
+
+  attributes :email
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_fast_jsonapi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Emmanuel Cousin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-18 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -94,6 +94,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/models/blog_post.rb
 - spec/support/models/user.rb
+- spec/support/serializers/another_user_serializer.rb
 - spec/support/serializers/blog_post_serializer.rb
 - spec/support/serializers/user_serializer.rb
 homepage: https://github.com/EmCousin/grape_fast_jsonapi
@@ -126,5 +127,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/models/blog_post.rb
 - spec/support/models/user.rb
+- spec/support/serializers/another_user_serializer.rb
 - spec/support/serializers/blog_post_serializer.rb
 - spec/support/serializers/user_serializer.rb