grape_fast_jsonapi 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 124200e814c960ae250ca18ae8239bfb6cce25b6819d9e71672aef83b9fb1fad
-  data.tar.gz: 6155dd8491942fd0b0f7342032af4f8a423fc297193c5113cc6582f157bf52d3
+  metadata.gz: 6026dd876923e91c284ef3c379b4393ec47495485aab633827510601ac0b6355
+  data.tar.gz: 5a43fc86d8e7839774bd5fd56ff2c76fbef8d9d9e20b194c059e12d330ac6117
 SHA512:
-  metadata.gz: e94748c505d38c59d7d895a022343891b5895c0dd18242c4bc53f6389c89cf4584c6d94eddc54b0b7712fa23ef6cee9321506714c634a9001eb1843cd467b447
-  data.tar.gz: c5ee861778ebdbec255d56a11a9ea814f01d1775da2beed6871ffd5f7c7935bb7e4896eeb526de23fadd6f82542b87b9058cbc8bc805a4257ae3019405416f9f
+  metadata.gz: fdc6ee51194b78acda16f8a4bae6d0d0644c2b796918d6786741b055fe3679074735755ff82ac47e8c39cea0152ecd348a5ebbfebb000d4abb4f0b70aa55b1b7
+  data.tar.gz: 9bd438e0174f856064eb568953932fa786c569afbefeb52ea7b8680247e2236a256a945189c9925517f4d5bce8803b800cdbcadf5456a434999fc53e9f82b798

data/CHANGELOG.md

@@ -1,15 +1,21 @@
 ## Changelog
 
-### v0.2.6 (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)

data/Gemfile.lock

@@ -1,70 +1,70 @@
 PATH
   remote: .
   specs:
-    grape_fast_jsonapi (0.2.5)
+    grape_fast_jsonapi (0.2.6)
       fast_jsonapi (>= 1.5)
       grape
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.2.1)
-      actionpack (= 6.0.2.1)
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    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.2.1)
-      actionpack (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.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 (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    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.2.0)
-    actiontext (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    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.2.1)
-      activesupport (= 6.0.2.1)
+    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.1, >= 1.2.0)
-    activejob (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activestorage (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
+    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 (6.0.2.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     crass (1.0.6)
     diff-lcs (1.3)
     dry-configurable (0.9.0)
@@ -100,55 +100,55 @@ GEM
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    loofah (2.4.0)
+    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)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    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.7)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    rack (2.1.1)
+    rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.2.1)
-      actioncable (= 6.0.2.1)
-      actionmailbox (= 6.0.2.1)
-      actionmailer (= 6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actiontext (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    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 (= 6.0.2.1)
+      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.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
@@ -167,7 +167,7 @@ GEM
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
     ruby2_keywords (0.0.2)
-    sprockets (4.0.0)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
@@ -176,12 +176,12 @@ GEM
       sprockets (>= 3.0.0)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.1)
+    websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    zeitwerk (2.2.2)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -194,4 +194,4 @@ DEPENDENCIES
   rspec (~> 3.7)
 
 BUNDLED WITH
-   1.17.2
+   2.1.2

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 = {}
@@ -84,7 +95,12 @@ module GrapeSwagger
       def map_model_attributes
         attributes = {}
         (model.attributes_to_serialize || []).each do |attribute, _|
-          attributes[attribute] = :string
+          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

data/lib/grape_fast_jsonapi/version.rb

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

data/spec/lib/grape_fast_jsonapi/parser_spec.rb

@@ -126,6 +126,42 @@ 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
 

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.5' }
+  it { is_expected.to eq '0.2.6' }
 end

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/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.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Emmanuel Cousin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-23 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -93,11 +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:
@@ -118,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
@@ -128,9 +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