jsonapi.rb 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2192bbffc57d4ecbe419a90e25728951db4464c5f299e8866afefe72fa393cad
-  data.tar.gz: f7f83b43169207e7cf6d06e6e99cc8c8f705de09c4c83ff9dba5238540577a9e
+  metadata.gz: 1ab8c32a2d9e284664f914ce8ab96260bb0811378cf7bb9d1b061ee4f9b642c9
+  data.tar.gz: 166da57b4b87d9ede4a9088da6aa7e3d277db3be9ef21529784367f4621536ca
 SHA512:
-  metadata.gz: 577c2b0d1801ef2191c25925e407449ff12ba95d7fc5c8433fcbb2b20e532a1b7a51a884f147c5042c38ec27ca9eed6567bfd746aad4ad8895b7a3f90e9043b1
-  data.tar.gz: f6ca1bc49fd89c1ea942f3c047234d76c4fa1d7604bd06aa5d67c43dad93603cb19e6c542ec13837d1db5e3fbe923ec4799fd865c96c08822dcab7cb160d7f7e
+  metadata.gz: 0d274a7ae6f8931c1009ba02af6d595efc02fb3c832225327b6ec96280d863a51ed6e36283621e53a76a568565a45e1762676a10d336eecdc080a1690ee97572
+  data.tar.gz: a04bf92af8f7484d54c6ac1c01703f0673197732f3b52a7de148f38b2d99ad9f936935192942c9607a13ffd1350254ca3a976b064a026bdd0dd8d269e4b81ff0

data/README.md

@@ -233,6 +233,12 @@ class MyController < ActionController::Base
 end
 ```
 
+This allows you to run queries like:
+
+```bash
+$ curl -X GET /api/resources?fields[model]=model_attr,relationship
+```
+
 ### Filtering and sorting
 
 `JSONAPI::Filtering` uses the power of
@@ -276,7 +282,7 @@ grouping. To enable expressions along with filters, use the option flags:
 ```ruby
 options = { sort_with_expressions: true }
 jsonapi_filter(User.all, allowed_fields, options) do |filtered|
-  render jsonapi: result.group('id').to_a
+  render jsonapi: filtered.result.group('id').to_a
 end
 ```
 

data/lib/jsonapi/active_model_error_serializer.rb

@@ -12,35 +12,15 @@ module JSONAPI
     end
 
     attribute :code do |object|
-      _, error_hash = object
-      code = error_hash[:error] unless error_hash[:error].is_a?(Hash)
-      code ||= error_hash[:message] || :invalid
-      # `parameterize` separator arguments are different on Rails 4 vs 5...
-      code.to_s.delete("''").parameterize.tr('-', '_')
+      object.type.to_s.delete("''").parameterize.tr('-', '_')
     end
 
-    attribute :detail do |object, params|
-      error_key, error_hash = object
-      errors_object = params[:model].errors
-
-      # Rails 4 provides just the message.
-      if error_hash[:error].present? && error_hash[:error].is_a?(Hash)
-        message = errors_object.generate_message(
-          error_key, nil, error_hash[:error]
-        )
-      elsif error_hash[:error].present?
-        message = errors_object.generate_message(
-          error_key, error_hash[:error], error_hash
-        )
-      else
-        message = error_hash[:message]
-      end
-
-      errors_object.full_message(error_key, message)
+    attribute :detail do |object, _params|
+      object.full_message
     end
 
     attribute :source do |object, params|
-      error_key, _ = object
+      error_key = object.attribute
       model_serializer = params[:model_serializer]
       attrs = (model_serializer.attributes_to_serialize || {}).keys
       rels = (model_serializer.relationships_to_serialize || {}).keys

data/lib/jsonapi/deserialization.rb

@@ -65,7 +65,7 @@ module JSONAPI
         rel_name = jsonapi_inflector.singularize(assoc_name)
 
         if assoc_data.is_a?(Array)
-          parsed["#{rel_name}_ids"] = assoc_data.map { |ri| ri['id'] }.compact
+          parsed["#{rel_name}_ids"] = assoc_data.filter_map { |ri| ri['id'] }
           next
         end
 

data/lib/jsonapi/error_serializer.rb

@@ -8,7 +8,7 @@ module JSONAPI
     set_type :error
 
     # Object/Hash attribute helpers.
-    [:status, :source, :title, :detail].each do |attr_name|
+    [:status, :source, :title, :detail, :code].each do |attr_name|
       attribute attr_name do |object|
         object.try(attr_name) || object.try(:fetch, attr_name, nil)
       end

data/lib/jsonapi/fetching.rb

@@ -17,7 +17,7 @@ module JSONAPI
       end
 
       params[:fields].each do |k, v|
-        extracted[k] = v.to_s.split(',').map(&:strip).compact
+        extracted[k] = v.to_s.split(',').filter_map(&:strip)
       end
 
       extracted
@@ -29,7 +29,7 @@ module JSONAPI
     #
     # @return [Array]
     def jsonapi_include
-      params['include'].to_s.split(',').map(&:strip).compact
+      params['include'].to_s.split(',').filter_map(&:strip)
     end
   end
 end

data/lib/jsonapi/filtering.rb

@@ -1,9 +1,7 @@
 begin
-  require 'active_record'
-  require 'ransack'
+  require 'ransack/predicate'
   require_relative 'patches'
 rescue LoadError
-  warn('Install `ransack` gem before using `JSONAPI::Filtering`!')
 end
 
 # Filtering and sorting support

data/lib/jsonapi/pagination.rb

@@ -13,14 +13,13 @@ module JSONAPI
     def jsonapi_paginate(resources)
       offset, limit, _ = jsonapi_pagination_params
 
+      # Cache the original resources size to be used for pagination meta
+      @_jsonapi_original_size = resources.size
+
       if resources.respond_to?(:offset)
         resources = resources.offset(offset).limit(limit)
       else
-        original_size = resources.size
         resources = resources[(offset)..(offset + limit - 1)] || []
-
-        # Cache the original resources size to be used for pagination meta
-        resources.instance_variable_set(:@original_size, original_size)
       end
 
       block_given? ? yield(resources) : resources
@@ -64,13 +63,7 @@ module JSONAPI
 
       numbers = { current: page }
 
-      if resources.respond_to?(:unscope)
-        total = resources.unscope(:limit, :offset, :order).size
-      else
-        # Try to fetch the cached size first
-        total = resources.instance_variable_get(:@original_size)
-        total ||= resources.size
-      end
+      total = @_jsonapi_original_size
 
       last_page = [1, (total.to_f / limit).ceil].max
 

data/lib/jsonapi/rails.rb

@@ -37,7 +37,7 @@ module JSONAPI
     # @return [NilClass]
     def self.add_errors_renderer!
       ActionController::Renderers.add(:jsonapi_errors) do |resource, options|
-        self.content_type ||= Mime[:jsonapi]
+        self.content_type = Mime[:jsonapi] if self.media_type.nil?
 
         many = JSONAPI::Rails.is_collection?(resource, options[:is_collection])
         resource = [resource] unless many
@@ -46,7 +46,6 @@ module JSONAPI
           JSONAPI::ErrorSerializer.new(resource, options)
         ) unless resource.is_a?(ActiveModel::Errors)
 
-        errors = []
         model = resource.instance_variable_get(:@base)
 
         if respond_to?(:jsonapi_serializer_class, true)
@@ -55,31 +54,12 @@ module JSONAPI
           model_serializer = JSONAPI::Rails.serializer_class(model, false)
         end
 
-        details = {}
-        if ::Rails.gem_version >= Gem::Version.new('6.1')
-          resource.each do |error|
-            attr = error.attribute
-            details[attr] ||= []
-            details[attr] << error.detail.merge(message: error.message)
-          end
-        elsif resource.respond_to?(:details)
-          details = resource.details
-        else
-          details = resource.messages
-        end
-
-        details.each do |error_key, error_hashes|
-          error_hashes.each do |error_hash|
-            # Rails 4 provides just the message.
-            error_hash = { message: error_hash } unless error_hash.is_a?(Hash)
-
-            errors << [ error_key, error_hash ]
-          end
-        end
-
         JSONAPI::Rails.serializer_to_json(
           JSONAPI::ActiveModelErrorSerializer.new(
-            errors, params: { model: model, model_serializer: model_serializer }
+            resource.errors, params: {
+              model: model,
+              model_serializer: model_serializer
+            }
           )
         )
       end
@@ -90,7 +70,7 @@ module JSONAPI
     # @return [NilClass]
     def self.add_renderer!
       ActionController::Renderers.add(:jsonapi) do |resource, options|
-        self.content_type ||= Mime[:jsonapi]
+        self.content_type = Mime[:jsonapi] if self.media_type.nil?
 
         JSONAPI_METHODS_MAPPING.to_a[0..1].each do |opt, method_name|
           next unless respond_to?(method_name, true)
@@ -100,7 +80,7 @@ module JSONAPI
         # If it's an empty collection, return it directly.
         many = JSONAPI::Rails.is_collection?(resource, options[:is_collection])
         if many && !resource.any?
-          return options.slice(:meta, :links).merge(data: []).to_json
+          return options.slice(:meta, :links).compact.merge(data: []).to_json
         end
 
         JSONAPI_METHODS_MAPPING.to_a[2..-1].each do |opt, method_name|

data/lib/jsonapi/version.rb

@@ -1,3 +1,3 @@
 module JSONAPI
-  VERSION = '2.0.0'
+  VERSION = '2.1.1'
 end

data/spec/dummy.rb

@@ -30,12 +30,34 @@ end
 
 class User < ActiveRecord::Base
   has_many :notes
+
+  def self.ransackable_attributes(auth_object = nil)
+    %w(created_at first_name id last_name updated_at)
+  end
+
+  def self.ransackable_associations(auth_object = nil)
+    %w(notes)
+  end
 end
 
 class Note < ActiveRecord::Base
+  validate :title_cannot_contain_slurs
   validates_format_of :title, without: /BAD_TITLE/
   validates_numericality_of :quantity, less_than: 100, if: :quantity?
   belongs_to :user, required: true
+
+  def self.ransackable_associations(auth_object = nil)
+    %w(user)
+  end
+
+  def self.ransackable_attributes(auth_object = nil)
+    %w(created_at id quantity title updated_at user_id)
+  end
+
+  private
+  def title_cannot_contain_slurs
+    errors.add(:base, 'Title has slurs') if title.to_s.include?('SLURS')
+  end
 end
 
 class CustomNoteSerializer
@@ -97,6 +119,7 @@ class UsersController < ActionController::Base
       result = result.to_a if params[:as_list]
 
       jsonapi_paginate(result) do |paginated|
+        paginated = paginated.to_a if params[:decorate_after_pagination]
         render jsonapi: paginated
       end
     end

data/spec/errors_spec.rb

@@ -32,11 +32,15 @@ RSpec.describe NotesController, type: :request do
       it do
         expect(response).to have_http_status(:unprocessable_entity)
         expect(response_json['errors'].size).to eq(1)
-        expect(response_json['errors'][0]['status']).to eq('422')
-        expect(response_json['errors'][0]['title'])
-          .to eq(Rack::Utils::HTTP_STATUS_CODES[422])
-        expect(response_json['errors'][0]['source']).to eq('pointer' => '')
-        expect(response_json['errors'][0]['detail']).to be_nil
+        expect(response_json['errors']).to contain_exactly(
+          {
+            'status' => '422',
+            'source' => { 'pointer' => '' },
+            'title' => 'Unprocessable Entity',
+            'detail' => nil,
+            'code' => nil
+          }
+        )
       end
     end
 
@@ -50,19 +54,20 @@ RSpec.describe NotesController, type: :request do
       it do
         expect(response).to have_http_status(:unprocessable_entity)
         expect(response_json['errors'].size).to eq(1)
-        expect(response_json['errors'][0]['status']).to eq('422')
-        expect(response_json['errors'][0]['code']).to include('blank')
-        expect(response_json['errors'][0]['title'])
-          .to eq(Rack::Utils::HTTP_STATUS_CODES[422])
-        expect(response_json['errors'][0]['source'])
-          .to eq('pointer' => '/data/relationships/user')
-        if Rails.gem_version >= Gem::Version.new('6.1')
-          expect(response_json['errors'][0]['detail'])
-            .to eq('User must exist')
+        expected_detail = if Rails.gem_version >= Gem::Version.new('6.1')
+          'User must exist'
         else
-          expect(response_json['errors'][0]['detail'])
-            .to eq('User can\'t be blank')
+          'User can\'t be blank'
         end
+        expect(response_json['errors']).to contain_exactly(
+          {
+            'status' => '422',
+            'source' => { 'pointer' => '/data/relationships/user' },
+            'title' => 'Unprocessable Entity',
+            'detail' => expected_detail,
+            'code' => 'blank'
+          }
+        )
       end
 
       context 'required by validations' do
@@ -76,45 +81,51 @@ RSpec.describe NotesController, type: :request do
         it do
           expect(response).to have_http_status(:unprocessable_entity)
           expect(response_json['errors'].size).to eq(3)
-          expect(response_json['errors'][0]['status']).to eq('422')
-          expect(response_json['errors'][0]['code']).to include('invalid')
-          expect(response_json['errors'][0]['title'])
-            .to eq(Rack::Utils::HTTP_STATUS_CODES[422])
-          expect(response_json['errors'][0]['source'])
-              .to eq('pointer' => '/data/attributes/title')
-          expect(response_json['errors'][0]['detail'])
-            .to eq('Title is invalid')
-
-          expect(response_json['errors'][1]['status']).to eq('422')
-
-          if Rails::VERSION::MAJOR >= 5
-            expect(response_json['errors'][1]['code']).to eq('invalid')
-          else
-            expect(response_json['errors'][1]['code']).to eq('has_typos')
-          end
-
-          expect(response_json['errors'][1]['title'])
-            .to eq(Rack::Utils::HTTP_STATUS_CODES[422])
-          expect(response_json['errors'][1]['source'])
-            .to eq('pointer' => '/data/attributes/title')
-          expect(response_json['errors'][1]['detail'])
-            .to eq('Title has typos')
-
-          expect(response_json['errors'][2]['status']).to eq('422')
-
-          if Rails::VERSION::MAJOR >= 5
-            expect(response_json['errors'][2]['code']).to eq('less_than')
-          else
-            expect(response_json['errors'][2]['code'])
-              .to eq('must_be_less_than_100')
-          end
-
-          expect(response_json['errors'][2]['title'])
-            .to eq(Rack::Utils::HTTP_STATUS_CODES[422])
-          expect(response_json['errors'][2]['source'])
-            .to eq('pointer' => '/data/attributes/quantity')
-          expect(response_json['errors'][2]['detail'])
-            .to eq('Quantity must be less than 100')
+          expect(response_json['errors']).to contain_exactly(
+            {
+              'status' => '422',
+              'source' => { 'pointer' => '/data/attributes/title' },
+              'title' => 'Unprocessable Entity',
+              'detail' => 'Title is invalid',
+              'code' => 'invalid'
+            },
+            {
+              'status' => '422',
+              'source' => { 'pointer' => '/data/attributes/title' },
+              'title' => 'Unprocessable Entity',
+              'detail' => 'Title has typos',
+              'code' => 'invalid'
+            },
+            {
+              'status' => '422',
+              'source' => { 'pointer' => '/data/attributes/quantity' },
+              'title' => 'Unprocessable Entity',
+              'detail' => 'Quantity must be less than 100',
+              'code' => 'less_than'
+            }
+          )
+        end
+      end
+
+      context 'validations with non-interpolated messages' do
+        let(:params) do
+          payload = note_params.dup
+          payload[:data][:attributes][:title] = 'SLURS ARE GREAT'
+          payload
+        end
+
+        it do
+          expect(response).to have_http_status(:unprocessable_entity)
+          expect(response_json['errors'].size).to eq(1)
+          expect(response_json['errors']).to contain_exactly(
+            {
+              'status' => '422',
+              'source' => { 'pointer' => '' },
+              'title' => 'Unprocessable Entity',
+              'detail' => 'Title has slurs',
+              'code' => 'title_has_slurs'
+            }
+          )
         end
       end
 
@@ -129,8 +140,15 @@ RSpec.describe NotesController, type: :request do
 
         it do
           expect(response).to have_http_status(:unprocessable_entity)
-          expect(response_json['errors'][0]['source'])
-            .to eq('pointer' => '/data/attributes/title')
+          expect(response_json['errors']).to contain_exactly(
+            {
+              'status' => '422',
+              'source' => { 'pointer' => '/data/attributes/title' },
+              'title' => 'Unprocessable Entity',
+              'detail' => nil,
+              'code' => nil
+            }
+          )
         end
       end
     end
@@ -142,11 +160,15 @@ RSpec.describe NotesController, type: :request do
       it do
         expect(response).to have_http_status(:not_found)
         expect(response_json['errors'].size).to eq(1)
-        expect(response_json['errors'][0]['status']).to eq('404')
-        expect(response_json['errors'][0]['title'])
-          .to eq(Rack::Utils::HTTP_STATUS_CODES[404])
-        expect(response_json['errors'][0]['source']).to be_nil
-        expect(response_json['errors'][0]['detail']).to be_nil
+        expect(response_json['errors']).to contain_exactly(
+          {
+            'status' => '404',
+            'source' => nil,
+            'title' => 'Not Found',
+            'detail' => nil,
+            'code' => nil
+          }
+        )
       end
     end
 
@@ -157,11 +179,15 @@ RSpec.describe NotesController, type: :request do
       it do
         expect(response).to have_http_status(:internal_server_error)
         expect(response_json['errors'].size).to eq(1)
-        expect(response_json['errors'][0]['status']).to eq('500')
-        expect(response_json['errors'][0]['title'])
-          .to eq(Rack::Utils::HTTP_STATUS_CODES[500])
-        expect(response_json['errors'][0]['source']).to be_nil
-        expect(response_json['errors'][0]['detail']).to be_nil
+        expect(response_json['errors']).to contain_exactly(
+          {
+            'status' => '500',
+            'source' => nil,
+            'title' => 'Internal Server Error',
+            'detail' => nil,
+            'code' => nil
+          }
+        )
       end
     end
   end

data/spec/pagination_spec.rb

@@ -53,12 +53,14 @@ RSpec.describe UsersController, type: :request do
 
         context 'on page 2 out of 3' do
           let(:as_list) { }
+          let(:decorate_after_pagination) { }
           let(:params) do
             {
               page: { number: 2, size: 1 },
               sort: '-created_at',
-              as_list: as_list
-            }.reject { |_k, _v| _v.blank? }
+              as_list: as_list,
+              decorate_after_pagination: decorate_after_pagination
+            }.compact_blank
           end
 
           context 'on an array of resources' do
@@ -80,6 +82,25 @@ RSpec.describe UsersController, type: :request do
             end
           end
 
+          context 'when decorating objects after pagination' do
+            let(:decorate_after_pagination) { true }
+
+            it do
+              expect(response).to have_http_status(:ok)
+              expect(response_json['data'].size).to eq(1)
+              expect(response_json['data'][0]).to have_id(second_user.id.to_s)
+
+              expect(response_json['meta']['pagination']).to eq(
+                'current' => 2,
+                'first' => 1,
+                'prev' => 1,
+                'next' => 3,
+                'last' => 3,
+                'records' => 3
+              )
+            end
+          end
+
           it do
             expect(response).to have_http_status(:ok)
             expect(response_json['data'].size).to eq(1)
@@ -157,7 +178,7 @@ RSpec.describe UsersController, type: :request do
             {
               page: { number: 5, size: 1 },
               as_list: as_list
-            }.reject { |_k, _v| _v.blank? }
+            }.compact_blank
           end
 
           context 'on an array of resources' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi.rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Stas Suscov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializer
@@ -98,16 +98,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
@@ -265,7 +265,7 @@ homepage: https://github.com/stas/jsonapi.rb
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: Install manually `ransack` gem before using `JSONAPI::Filtering`!
 rdoc_options: []
 require_paths:
 - lib
@@ -280,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: So you say you need JSON:API support in your API...