grape-jsonapi 1.0.0

data/spec/lib/grape_jsonapi/parser_spec.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+describe GrapeSwagger::Jsonapi::Parser do
+  let(:model) { BlogPostSerializer }
+  let(:endpoint) { '/' }
+
+  describe 'attr_readers' do
+    subject { described_class.new(model, endpoint) }
+
+    it { expect(subject.model).to eq model }
+    it { expect(subject.endpoint).to eq endpoint }
+  end
+
+  describe 'instance methods' do
+    describe '#call' do
+      subject { described_class.new(model, endpoint).call }
+
+      it 'return a hash defining the schema' do
+        expect(subject).to eq({
+          data: {
+            type: :object,
+            properties: {
+              id: { type: :integer },
+              type: { type: :string },
+              attributes: {
+                type: :object,
+                properties: {
+                  title: { type: :string },
+                  body: { type: :string }
+                }
+              },
+              relationships: {
+                type: :object,
+                properties: {
+                  user: {
+                    type: :object,
+                    properties: {
+                      data: {
+                        type: :object,
+                        properties: {
+                          id: { type: :integer },
+                          type: { type: :string }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            example: {
+              id: 1,
+              type: :blog_post,
+              attributes: {
+                title: 'Example string',
+                body: 'Example string'
+              },
+              relationships: {
+                user: {
+                  data: {
+                    id: 1,
+                    type: :user
+                  }
+                }
+              }
+            }
+          }
+        })
+      end
+
+      context 'when the serializer contains sensitive information' do
+        let(:model) { UserSerializer } # contains :password attribute
+
+        it 'return a hash defining the schema filtering the sensitive attributes' do
+          expect(subject).to eq({
+            data: {
+              type: :object,
+              properties: {
+                id: { type: :integer },
+                type: { type: :string },
+                attributes: {
+                  type: :object,
+                  properties: {
+                    first_name: { type: :string },
+                    last_name: { type: :string },
+                    email: { type: :string }
+                    # password: { type: :string }, FILTERED
+                  }
+                },
+                relationships: {
+                  type: :object,
+                  properties: {
+                    blog_posts: {
+                      type: :object,
+                      properties: {
+                        data: {
+                          type: :array,
+                          items: {
+                            type: :object,
+                            properties: {
+                              id: { type: :integer },
+                              type: { type: :string }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              example: {
+                id: 1,
+                type: :user,
+                attributes: {
+                  first_name: 'Example string',
+                  last_name: 'Example string',
+                  email: 'Example string'
+                  # password: "Example string", FILTERED
+                },
+                relationships: {
+                  blog_posts: {
+                    data: [{ id: 1, type: :blog_post }]
+                  }
+                }
+              }
+            }
+          })
+        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

data/spec/lib/grape_jsonapi/version_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_model'
+require 'grape_jsonapi'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }

data/spec/support/models/blog_post.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class BlogPost
+  include ActiveModel::Serialization
+
+  attr_accessor :id, :title, :body
+
+  def initialize(params = {})
+    params.each do |k, v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+
+  def user_id
+    nil
+  end
+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/models/user.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class User
+  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
+end

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 JSONAPI::Serializer
+
+  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 JSONAPI::Serializer
+
+  attributes :email
+end

data/spec/support/serializers/blog_post_serializer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class BlogPostSerializer
+  include JSONAPI::Serializer
+
+  belongs_to :user
+
+  attributes :title, :body
+end

data/spec/support/serializers/db_record_serializer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+class DbRecordSerializer
+  include JSONAPI::Serializer
+
+  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 JSONAPI::Serializer
+
+  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

data/spec/support/serializers/user_serializer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class UserSerializer
+  include JSONAPI::Serializer
+
+  has_many :blog_posts
+
+  attributes :first_name, :last_name, :email
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: grape-jsonapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Emmanuel Cousin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a Formatter for the Grape API DSL to emit objects serialized
+  with jsonapi-serializer.
+email:
+- emmanuel_cousin@hotmail.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- grape-jsonapi.gemspec
+- lib/grape_jsonapi.rb
+- lib/grape_jsonapi/deprecated/formatter.rb
+- lib/grape_jsonapi/deprecated/parser.rb
+- lib/grape_jsonapi/endpoint_extension.rb
+- lib/grape_jsonapi/formatter.rb
+- lib/grape_jsonapi/parser.rb
+- lib/grape_jsonapi/version.rb
+- spec/lib/grape_jsonapi/deprecated.rb/formatter_spec.rb
+- spec/lib/grape_jsonapi/deprecated.rb/parser_spec.rb
+- spec/lib/grape_jsonapi/formatter_spec.rb
+- spec/lib/grape_jsonapi/parser_spec.rb
+- spec/lib/grape_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-jsonapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Use grape-jsonapi in grape
+test_files:
+- spec/lib/grape_jsonapi/deprecated.rb/formatter_spec.rb
+- spec/lib/grape_jsonapi/deprecated.rb/parser_spec.rb
+- spec/lib/grape_jsonapi/formatter_spec.rb
+- spec/lib/grape_jsonapi/parser_spec.rb
+- spec/lib/grape_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