grape_fast_jsonapi 0.2.0 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38ad3fb865f43aa0c089abf0136617191d3dbf8fa10d3dff3798537312026851
-  data.tar.gz: 44f09504170ee1b3ec39be3d11784adaf5255b867693c77850d5089b2b2cecf5
+  metadata.gz: 6026dd876923e91c284ef3c379b4393ec47495485aab633827510601ac0b6355
+  data.tar.gz: 5a43fc86d8e7839774bd5fd56ff2c76fbef8d9d9e20b194c059e12d330ac6117
 SHA512:
-  metadata.gz: c6d628fe38e31362949ee2c9e7fbf9d866fe5e99ee910aa16f8dc533da1ee54ec5e8af949d688b194fbe783d258fe5ac09e20ee5a23d60ba8b1aa61335f4d1f7
-  data.tar.gz: c6f7ec14e0e3d67e9dd707dd99b563408d62526f4188c114198c53a8b053a0075c2c7f98bea028cf1baa797a613465ba7b0b8be16e431624bc961ae6dd00804c
+  metadata.gz: fdc6ee51194b78acda16f8a4bae6d0d0644c2b796918d6786741b055fe3679074735755ff82ac47e8c39cea0152ecd348a5ebbfebb000d4abb4f0b70aa55b1b7
+  data.tar.gz: 9bd438e0174f856064eb568953932fa786c569afbefeb52ea7b8680247e2236a256a945189c9925517f4d5bce8803b800cdbcadf5456a434999fc53e9f82b798

data/.circleci/config.yml

@@ -7,9 +7,11 @@ jobs:
   build:
     docker:
     # specify the version you desire here
-       - image: circleci/ruby:2.5.3-node-browsers
+       - image: circleci/ruby:2.6.3-node-browsers
          environment:
            RAILS_ENV: test
+           PGHOST: 127.0.0.1
+           PGUSER: root
 
     # Specify service dependencies here if necessary
     # CircleCI maintains a library of pre-built images

data/CHANGELOG.md

@@ -1,13 +1,41 @@
 ## Changelog
 
-### 0.2.1 (Next)
+### v0.2.7 (Next)
 
 * Your contribution here.
 
+### v0.2.6 (June 20, 2020)
+
+* [#14](https://github.com/EmCousin/grape_fast_jsonapi/pull/14) and [#21](https://github.com/EmCousin/grape_fast_jsonapi/pull/21) - Fixes to swagger parser: Respect `:key` setting, fix column type rendering, allow adding to schema - [@vincentvanbush](https://github.com/vincentvanbush) and [@nathanvda](https://github.com/nathanvda)
+
+### v0.2.5 (January 23, 2020)
+
+* [#18](https://github.com/EmCousin/grape_fast_jsonapi/pull/18) - Revert to model_name instead of class-name - [@dblommesteijn](https://github.com/dblommesteijn)
+
+Note : This PR fixes a bug when serializing a ActiveRecord::Relation instance, the formatter was looking for a formatter `ActiveRecord::RelationSerializer` serializer that doesn't exist, insteafd of looking for the serializer corresponding to its model name.
+
+* Security updates
+
+### v0.2.4 (December 16, 2019)
+
+* [#15](https://github.com/EmCousin/grape_fast_jsonapi/pull/15) - Handle serializers which don't have any attributes - [@vesan](https://github.com/vesan)
+
+### v0.2.3 (December 12, 2019)
+
+* Reverted v0.2.2 and bumped `loofah` using `dependabot` - [@EmCousin](https://github.com/EmCousin).
+
+### v0.2.2 (December 12, 2019)
+
+* Fixed low severity vulnerabiliy issue with `loofah` dependency - [@EmCousin](https://github.com/EmCousin).
+
+### 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 - [@EmCousin](https://github.com/EmCousin).
+
 ### 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)
-* [#6](https://github.com/EmCousin/grape_fast_jsonapi/pull/6) - Fix to make the parser compatible with latest version of fast_jsonapi (1.5 at date) - @rromanchuk](https://github.com/rromanchuk).
+* [#6](https://github.com/EmCousin/grape_fast_jsonapi/pull/6) - Fix to make the parser compatible with latest version of fast_jsonapi (1.5 at date) - [@rromanchuk](https://github.com/rromanchuk).
 
 ### v0.1.0
 

data/Gemfile.lock

@@ -1,163 +1,187 @@
 PATH
   remote: .
   specs:
-    grape_fast_jsonapi (0.2.0)
+    grape_fast_jsonapi (0.2.6)
       fast_jsonapi (>= 1.5)
       grape
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.2)
-      actionpack (= 5.2.2)
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.2)
-      actionpack (= 5.2.2)
-      actionview (= 5.2.2)
-      activejob (= 5.2.2)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.2)
-      actionview (= 5.2.2)
-      activesupport (= 5.2.2)
-      rack (~> 2.0)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.2)
-      activesupport (= 5.2.2)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.2)
-      activesupport (= 5.2.2)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
       globalid (>= 0.3.6)
-    activemodel (5.2.2)
-      activesupport (= 5.2.2)
-    activerecord (5.2.2)
-      activemodel (= 5.2.2)
-      activesupport (= 5.2.2)
-      arel (>= 9.0)
-    activestorage (5.2.2)
-      actionpack (= 5.2.2)
-      activerecord (= 5.2.2)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
       marcel (~> 0.3.1)
-    activesupport (5.2.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    builder (3.2.3)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.4)
-    crass (1.0.4)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
     diff-lcs (1.3)
-    equalizer (0.0.11)
-    erubi (1.8.0)
+    dry-configurable (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (1.2.2)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    erubi (1.9.0)
     fast_jsonapi (1.5)
       activesupport (>= 4.2)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    grape (1.2.3)
+    grape (1.3.0)
       activesupport
       builder
+      dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-      virtus (>= 1.0.0)
-    i18n (1.5.3)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    ice_nine (0.11.2)
-    loofah (2.2.3)
+    loofah (2.6.0)
       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)
-    method_source (0.9.2)
-    mimemagic (0.3.3)
-    mini_mime (1.0.1)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    mustermann (1.0.3)
-    mustermann-grape (1.0.0)
-      mustermann (~> 1.0.0)
-    nio4r (2.3.1)
-    nokogiri (1.10.1)
+    minitest (5.14.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.1)
+      mustermann (>= 1.0.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    rack (2.0.6)
+    rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.2)
-      actioncable (= 5.2.2)
-      actionmailer (= 5.2.2)
-      actionpack (= 5.2.2)
-      actionview (= 5.2.2)
-      activejob (= 5.2.2)
-      activemodel (= 5.2.2)
-      activerecord (= 5.2.2)
-      activestorage (= 5.2.2)
-      activesupport (= 5.2.2)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       bundler (>= 1.3.0)
-      railties (= 5.2.2)
+      railties (= 6.0.3.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.2)
-      actionpack (= 5.2.2)
-      activesupport (= 5.2.2)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sprockets (3.7.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    ruby2_keywords (0.0.2)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -170,4 +194,4 @@ DEPENDENCIES
   rspec (~> 3.7)
 
 BUNDLED WITH
-   1.16.6
+   2.1.2

data/README.md

@@ -1,3 +1,5 @@
+[![CircleCI](https://circleci.com/gh/EmCousin/grape_fast_jsonapi/tree/master.svg?style=svg)](https://circleci.com/gh/EmCousin/grape_fast_jsonapi/tree/master)
+
 # Grape::FastJsonapi
 
 Use [fast_jsonapi](https://github.com/Netflix/fast_jsonapi) with [Grape](https://github.com/ruby-grape/grape).
@@ -17,8 +19,9 @@ gem 'grape_fast_jsonapi'
 
 ```ruby
 class API < Grape::API
-  format :json
+  content_type :jsonapi, "application/vnd.api+json"
   formatter :json, Grape::Formatter::FastJsonapi
+  formatter :jsonapi, Grape::Formatter::FastJsonapi
 end
 ```
 
@@ -31,14 +34,35 @@ 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:
 
 ```ruby
 # FastJsonapi serializer example
+
+# app/serializers/base_serializer.rb
+class BaseSerializer; end
 # app/serializers/user_serializer.rb
-class UserSerializer
+class UserSerializer < BaseSerializer
   include FastJsonapi::ObjectSerializer
 
   set_type :user
@@ -48,12 +72,13 @@ class UserSerializer
 end
 
 # config/initializers/grape_swagger.rb
-GrapeSwagger.model_parsers.register(GrapeSwagger::FastJsonapi::Parser, UserSerializer)
+GrapeSwagger.model_parsers.register(GrapeSwagger::FastJsonapi::Parser, BaseSerializer)
 
 # Your grape API endpoint
-desc 'Get current user',
-  success: { code: 200, model: UserSerializer, message: 'The current user' }
+desc 'Get current user' do
+  success code: 200, model: UserSerializer, message: 'The current user'
 # [...]
+end
 ```
 
 Note that you **need** the `grape-swagger` gem for this to work, otherwise it will throw an error.

data/lib/grape_fast_jsonapi.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'rails'
 require 'fast_jsonapi'
 require 'grape'
 require 'grape_fast_jsonapi/endpoint_extension'

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.try(:model_name) || object.class).name + 'Serializer'
+          end
+
+          klass_name&.safe_constantize
         end
 
         def serialize_each_pair(object, env)

data/lib/grape_fast_jsonapi/parser.rb

@@ -15,18 +15,27 @@ module GrapeSwagger
         schema = default_schema
 
         attributes_hash = if (defined? ActiveRecord)
-                      map_active_record_columns_to_attributes
+                      map_model_attributes.symbolize_keys.merge(map_active_record_columns_to_attributes.symbolize_keys)
                     else
-                      map_model_attributes
+                      map_model_attributes.symbolize_keys
                     end
 
         attributes_hash.each do |attribute, type|
           schema[:data][:properties][:attributes][:properties][attribute] = { type: type }
-          schema[:data][:example][:attributes][attribute] = send "#{type}_example"
+          example_method = "#{type}_example"
+          unless self.respond_to?(example_method, true)
+            puts "WARN unexpected type encountered, missing #{example_method}  --use string example instead"
+            example_method = "string_example"
+          end
+          schema[:data][:example][:attributes][attribute] = send example_method
         end
 
         relationships_hash = model.relationships_to_serialize || []
 
+        # If relationship has :key set different than association name, it should be rendered under that key
+        relationships_hash =
+          relationships_hash.each_with_object({}) { |(_relationship_name, relationship), accu| accu[relationship.key] = relationship }
+
         relationships_hash.each do |model_type, relationship_data|
           relationships_attributes = relationship_data.instance_values.symbolize_keys
           schema[:data][:properties][:relationships][:properties][model_type] = {
@@ -36,6 +45,8 @@ module GrapeSwagger
           schema[:data][:example][:relationships][model_type] = relationships_example(relationships_attributes)
         end
 
+        schema.deep_merge!(model.additional_schema) if model.respond_to? :additional_schema
+
         schema
       end
 
@@ -67,10 +78,10 @@ module GrapeSwagger
 
       def map_active_record_columns_to_attributes
         activerecord_model = model.record_type.to_s.camelize.safe_constantize
-        return map_model_attributes unless activerecord_model&.is_a?(ActiveRecord::Base)
+        return map_model_attributes unless activerecord_model && activerecord_model < ActiveRecord::Base
 
         columns = activerecord_model.columns.select do |c|
-          c.name.to_sym.in?(model.attributes_to_serialize.keys)
+          model.attributes_to_serialize.keys.include?(c.name.to_sym)
         end
 
         attributes = {}
@@ -83,8 +94,13 @@ module GrapeSwagger
 
       def map_model_attributes
         attributes = {}
-        model.attributes_to_serialize.each do |attribute, _|
-          attributes[attribute] = :string
+        (model.attributes_to_serialize || []).each do |attribute, _|
+          attributes[attribute] =
+            if model.respond_to? :attribute_types
+              model.attribute_types[attribute] || :string
+            else
+              :string
+            end
         end
         attributes
       end
@@ -147,6 +163,14 @@ module GrapeSwagger
         end
       end
 
+      def citext_example
+        text_example
+      end
+
+      def float_example
+        rand() * rand(1..100)
+      end
+
       def date_example
         Date.today.to_s
       end
@@ -173,6 +197,10 @@ module GrapeSwagger
       def boolean_example
         [true, false].sample
       end
+
+      def uuid_example
+        SecureRandom.uuid
+      end
     end
   end
-end
+end

data/lib/grape_fast_jsonapi/version.rb

@@ -2,6 +2,6 @@
 
 module Grape
   module FastJsonapi
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.2.6'.freeze
   end
 end

data/spec/lib/grape_fast_jsonapi/formatter_spec.rb

@@ -11,10 +11,14 @@ describe Grape::Formatter::FastJsonapi do
     let(:blog_post) do
       BlogPost.new(id: 1, title: "Blog Post title", body: "Blog post body")
     end
+    let(:admin) do
+      UserAdmin.new(id: 1, first_name: 'Jean Luc', last_name: 'Picard', password: 'supersecretpassword', email: 'jeanluc@picard.com')
+    end
 
     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,8 +28,14 @@ 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 has a model_name defined' do
+          let(:object) { admin }
+          it { is_expected.to eq ::Grape::Json.dump(user_serializer.serializable_hash) }
+        end
+
         context 'when the object is a active serializable model instance' do
           let(:object) { user }
 
@@ -36,19 +46,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 +104,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/parser_spec.rb

@@ -126,6 +126,89 @@ describe GrapeSwagger::FastJsonapi::Parser do
           })
         end
       end
+
+      context 'when schema has an association with :key different than association name' do
+        let(:model) { FooSerializer }
+
+        it 'includes associations as defined by :key attributes' do
+          expect(subject[:data][:properties][:relationships][:properties]).to include(:foo_bar, :foo_fizz, :foo_buzzes)
+        end
+      end
+
+      context 'when serializer has additional schema specified' do
+        let(:model) { FooSerializer }
+
+        it 'is deep-merged into the returned schema' do
+          expect(subject[:data][:example][:attributes]).to include(xyz: 'foobar')
+        end
+      end
+
+      context 'when serializer has DB-backed model' do
+        let(:model) { DbRecordSerializer }
+
+        before { allow(SecureRandom).to receive(:uuid).and_return 'fakeuuid' }
+
+        it 'contains examples for corresponding data types' do
+          expect(subject[:data][:example][:attributes]).to include(
+            string_attribute: be_a(String),
+            uuid_attribute: 'fakeuuid',
+            integer_attribute: be_a(Integer),
+            text_attribute: be_a(String),
+            datetime_attribute: satisfy { |val| Time.parse(val).is_a? Time },
+            date_attribute: satisfy { |val| Date.parse(val).is_a? Date },
+            boolean_attribute: be_a(TrueClass).or(be_a(FalseClass)),
+            array_attribute: be_a(Array)
+          )
+        end
+      end
+
+      context 'when the serializer doesn\'t have any attributes' do
+        let(:model) { AnotherBlogPostSerializer } # no attributes
+
+        it 'return a hash defining the schema with empty attributes' do
+          expect(subject).to eq({
+            data: {
+              type: :object,
+              properties: {
+                id: { type: :integer },
+                type: { type: :string },
+                attributes: {
+                  type: :object,
+                  properties: {}
+                },
+                relationships: {
+                  type: :object,
+                  properties: {
+                    user: {
+                      properties: {
+                        data: {
+                          properties: {
+                            id: { type: :integer },
+                            type: { type: :string }
+                          },
+                          type: :object,
+                        }
+                      },
+                      type: :object,
+                    }
+                  }
+                }
+              },
+              example: {
+                id: 1,
+                type: :blog_post,
+                attributes: {
+                },
+                relationships: {
+                  user: {
+                    data: { id: 1, type: :user }
+                  }
+                }
+              }
+            }
+          })
+        end
+      end
     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.0' }
+  it { is_expected.to eq '0.2.6' }
 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/db_record.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'active_record'
+
+class DbRecord < ActiveRecord::Base
+  def self.columns
+    [
+      # adhering to the ActiveRecord::ConnectionAdapters::Column contract
+      OpenStruct.new(name: 'id', sql_type: 'integer', type: :integer),
+      OpenStruct.new(name: 'string_attribute', sql_type: 'character varying(255)', type: :string),
+      OpenStruct.new(name: 'uuid_attribute', sql_type: 'uuid', type: :uuid),
+      OpenStruct.new(name: 'integer_attribute', sql_type: 'integer', type: :integer),
+      OpenStruct.new(name: 'text_attribute', sql_type: 'text', type: :text),
+      OpenStruct.new(name: 'datetime_attribute', sql_type: 'timestamp without time zone', type: :datetime),
+      OpenStruct.new(name: 'date_attribute', sql_type: 'date', type: :date),
+      OpenStruct.new(name: 'boolean_attribute', sql_type: 'boolean', type: :boolean),
+      OpenStruct.new(name: 'array_attribute', sql_type: 'integer[]', type: :array)
+    ]
+  end
+end

data/spec/support/models/foo.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Foo
+  include ActiveModel::Serialization
+
+  attr_accessor :id, :bar_id
+
+  # belongs_to :bar
+  # has_one :fizz
+  # has_many :buzzes
+
+  def initialize(params = {})
+    params.each do |k, v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+
+  def attributes
+    {
+      'id' => nil,
+      'bar_id' => nil
+    }
+  end
+
+  def buzz_ids
+    []
+  end
+end

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/models/user_admin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class UserAdmin
+  include ActiveModel::Serialization
+
+  attr_accessor :id, :first_name, :last_name, :password, :email
+
+  def initialize(params = {})
+    params.each do |k, v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+
+  def attributes
+    {
+      'id' => nil,
+      'first_name' => nil,
+      'last_name' => nil,
+      'password' => nil,
+      'email' => nil
+    }
+  end
+
+  def blog_post_ids
+    []
+  end
+
+  def model_name
+    ActiveModel::Name.new(User)
+  end
+end

data/spec/support/serializers/another_blog_post_serializer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AnotherBlogPostSerializer
+  include FastJsonapi::ObjectSerializer
+
+  set_type :blog_post
+
+  belongs_to :user
+end

data/spec/support/serializers/another_user_serializer.rb

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

data/spec/support/serializers/db_record_serializer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+class DbRecordSerializer
+  include FastJsonapi::ObjectSerializer
+
+  attributes(
+    :string_attribute,
+    :uuid_attribute,
+    :integer_attribute,
+    :text_attribute,
+    :datetime_attribute,
+    :date_attribute,
+    :boolean_attribute,
+    :array_attribute
+  )
+end

data/spec/support/serializers/foo_serializer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class FooSerializer
+  include FastJsonapi::ObjectSerializer
+
+  belongs_to :bar, key: :foo_bar
+  has_one :fizz, key: :foo_fizz
+  has_many :buzzes, key: :foo_buzzes
+
+  attribute :xyz
+
+  def self.additional_schema
+    {
+      data: {
+        example: {
+          attributes: {
+            xyz: 'foobar'
+          }
+        }
+      }
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_fast_jsonapi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.6
 platform: ruby
 authors:
 - Emmanuel Cousin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -93,8 +93,15 @@ files:
 - spec/lib/grape_fast_jsonapi/version_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/blog_post.rb
+- spec/support/models/db_record.rb
+- spec/support/models/foo.rb
 - spec/support/models/user.rb
+- spec/support/models/user_admin.rb
+- spec/support/serializers/another_blog_post_serializer.rb
+- spec/support/serializers/another_user_serializer.rb
 - spec/support/serializers/blog_post_serializer.rb
+- spec/support/serializers/db_record_serializer.rb
+- spec/support/serializers/foo_serializer.rb
 - spec/support/serializers/user_serializer.rb
 homepage: https://github.com/EmCousin/grape_fast_jsonapi
 licenses:
@@ -115,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Use fast_jsonapi in grape
@@ -125,6 +132,13 @@ test_files:
 - spec/lib/grape_fast_jsonapi/version_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/blog_post.rb
+- spec/support/models/db_record.rb
+- spec/support/models/foo.rb
 - spec/support/models/user.rb
+- spec/support/models/user_admin.rb
+- spec/support/serializers/another_blog_post_serializer.rb
+- spec/support/serializers/another_user_serializer.rb
 - spec/support/serializers/blog_post_serializer.rb
+- spec/support/serializers/db_record_serializer.rb
+- spec/support/serializers/foo_serializer.rb
 - spec/support/serializers/user_serializer.rb