jsonapi.rb 1.7.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07512bb6e4135e51e0f94a3399ec068e7aa53a13d6eb65b44f5c87be8e4310e4
-  data.tar.gz: 128306af20f37d9fb7563a9cbc30f88f68dc3f761783a02eb9db539886c67bc5
+  metadata.gz: d531366279855044f83d35f4526a72156c711895290ab4dbce73f1c7615f1079
+  data.tar.gz: 63bd2be61a78d79a64bc739cbb492ee75a9e2f90a95389d55f133a2565627abb
 SHA512:
-  metadata.gz: 6658f11bc2501360cb8be91a05d14d427102905476cd1e0d2a020b1d9db36ce77857127090dc37f27dfb9292c187f3ad8028ea47ab8b26f06ffe7648276009fe
-  data.tar.gz: 2cfb89517aba924c3282d3f8f65a1281606407c0e11b97159ebab7b58c75dbf02fbf65962793a031b07e87e9e2cd90a31b87f6e5d0d54a91c769c0eed82e7088
+  metadata.gz: e602d6c993cd0259ac0b81c57eca16aee525f53ed0e5b4ac8014a0cb500528d579541375ce7735f0f191f3f732af9178ebbfdf7d4615eb967cfb244d1796cd36
+  data.tar.gz: 46a957ded4247be1607f6a4d84246da42a44fe41c58c55e2a34a914e958a28731531bc5e8a3f0d0141f571e17dce19c9c1f6f58845fc3e7db874d763dfcaffbb

data/README.md

@@ -39,7 +39,7 @@ The available features include:
    [sparse fields](https://jsonapi.org/format/#fetching-sparse-fieldsets))
  * [filtering](https://jsonapi.org/format/#fetching-filtering) and
    [sorting](https://jsonapi.org/format/#fetching-sorting) of the data
-   (powered by Ransack)
+   (powered by Ransack, soft-dependency)
  * [pagination](https://jsonapi.org/format/#fetching-pagination) support
 
 ## But how?
@@ -49,6 +49,16 @@ and [Ransack](https://github.com/activerecord-hackery/ransack).
 
 Thanks to everyone who worked on these amazing projects!
 
+## Sponsors
+
+I'm grateful for the following companies for supporting this project!
+
+<p align="center">
+<a href="https://www.luneteyewear.com"><img src="https://user-images.githubusercontent.com/112147/136836142-2bfba96e-447f-4eb6-b137-2445aee81b37.png"/></a>
+<a href="https://www.startuplandia.io"><img src="https://user-images.githubusercontent.com/112147/136836147-93f8ab17-2465-4477-a7ab-e38255483c66.png"/></a>
+</p>
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -231,6 +241,8 @@ to filter and sort over a collection of records.
 The support is pretty extended and covers also relationships and composite
 matchers.
 
+Please add `ransack` to your `Gemfile` in order to benefit from this functionality!
+
 Here's an example:
 
 ```ruby
@@ -314,7 +326,7 @@ If you want to change the default number of items per page or define a custom lo
 ```ruby
   def jsonapi_page_size(pagination_params)
     per_page = pagination_params[:size].to_f.to_i
-    per_page = 30 if per_page > 30
+    per_page = 30 if per_page > 30 || per_page < 1
     per_page
   end
 ```

data/lib/jsonapi/filtering.rb

@@ -1,5 +1,9 @@
-require 'ransack/predicate'
-require_relative 'patches'
+begin
+  require 'active_record'
+  require 'ransack'
+  require_relative 'patches'
+rescue LoadError
+end
 
 # Filtering and sorting support
 module JSONAPI

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
@@ -47,7 +47,7 @@ module JSONAPI
         ) unless resource.is_a?(ActiveModel::Errors)
 
         errors = []
-        model = resource.instance_variable_get('@base')
+        model = resource.instance_variable_get(:@base)
 
         if respond_to?(:jsonapi_serializer_class, true)
           model_serializer = jsonapi_serializer_class(model, false)
@@ -56,8 +56,8 @@ module JSONAPI
         end
 
         details = {}
-        if ::Rails::VERSION::MAJOR >= 6 && ::Rails::VERSION::MINOR >= 1
-          resource.map do |error|
+        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)
@@ -90,7 +90,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 +100,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|
@@ -121,15 +121,13 @@ module JSONAPI
 
     # Checks if an object is a collection
     #
-    # Stolen from [JSONAPI::Serializer], instance method.
+    # Basically forwards it to a [JSONAPI::Serializer] as there's no public API
     #
     # @param resource [Object] to check
     # @param force_is_collection [NilClass] flag to overwrite
     # @return [TrueClass] upon success
     def self.is_collection?(resource, force_is_collection = nil)
-      return force_is_collection unless force_is_collection.nil?
-
-      resource.respond_to?(:size) && !resource.respond_to?(:each_pair)
+      JSONAPI::ErrorSerializer.is_collection?(resource, force_is_collection)
     end
 
     # Resolves resource serializer class

data/lib/jsonapi/version.rb

@@ -1,3 +1,3 @@
 module JSONAPI
-  VERSION = '1.7.0'
+  VERSION = '2.0.1'
 end

data/spec/dummy.rb

@@ -1,8 +1,7 @@
 require 'securerandom'
-require 'active_record'
-require 'action_controller/railtie'
-require 'jsonapi'
+require 'rails/all'
 require 'ransack'
+require 'jsonapi'
 
 Rails.logger = Logger.new(STDOUT)
 Rails.logger.level = ENV['LOG_LEVEL'] || Logger::WARN

data/spec/errors_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe NotesController, type: :request do
           .to eq(Rack::Utils::HTTP_STATUS_CODES[422])
         expect(response_json['errors'][0]['source'])
           .to eq('pointer' => '/data/relationships/user')
-        if Rails::VERSION::MAJOR >= 6 && Rails::VERSION::MINOR >= 1
+        if Rails.gem_version >= Gem::Version.new('6.1')
           expect(response_json['errors'][0]['detail'])
             .to eq('User must exist')
         else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi.rb
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Stas Suscov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializer
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ransack
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ransack
+  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'
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -251,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
@@ -266,8 +280,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: So you say you need JSON:API support in your API...
 test_files: []