jsonapi-utils 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 81b9858b8125f047d7c6b26ed950d98072c6af8b
-  data.tar.gz: b7436b63bbc441f6592f6ada45cedace0633fa9c
+SHA256:
+  metadata.gz: 56b5970b70c6944e7c5c536f0b92c2bd8d2503d5447886862b72bfabcf85e943
+  data.tar.gz: c07bf056d10c8550c511bdd180dec8393858e45a5de37450ef323367bcc243aa
 SHA512:
-  metadata.gz: 1285cd935d1acab08e5f950290c2eabb744420aeac9312877e856ee1a9a16e0dace61d6797b60ed8b48994e67860fbc2f299c0a2169a48ef1939c9a52565425c
-  data.tar.gz: 9ab8279a639f27b412c8b7aec1857f4c4db9e7f928487950b6118afe6c30c5ecd40b9b97e2035f706e9eea4557d6e5772776dff848ddc424c382e676fc6df999
+  metadata.gz: 4aa949f97e9e0795dc6686d393767c4a1ad6c9084815a4f1aa10c0f912fc5901192b194204510936cb55a8136ef3467534aaa76132f334dd7f9127920281bc32
+  data.tar.gz: 26e1483f33628891ab311e6e9e3b71e88de5c3e5a9da4d3ae425ae62ea7efd7496acf0a99707de58db4a04d4b3bf33e911d4e11ec8996ba9e9f519e7ffd74c3b

data/README.md

@@ -54,7 +54,7 @@ end
 Support:
 
 * Ruby 1.9+ with Rails 4
-* Ruby 2.3+ with Rails 5
+* Ruby 2.4+ with Rails 5
 
 For Rails 4 add this to your application's Gemfile:
 
@@ -62,10 +62,10 @@ For Rails 4 add this to your application's Gemfile:
 gem 'jsonapi-utils', '~> 0.4.9'
 ```
 
-For Rails 5:
+For Rails 5+:
 
 ```ruby
-gem 'jsonapi-utils', '~> 0.7.2'
+gem 'jsonapi-utils', '~> 0.7.3'
 ```
 
 And then execute:
@@ -225,12 +225,12 @@ class CustomPaginator < JSONAPI::Paginator
   end
 ```
 
-And then it can be either set at the resource class level (e.g. UserResource.paginator :custom_paginator) or via config initializer:
+And then it can be either set at the resource class level (e.g. UserResource.paginator :custom) or via config initializer:
 
 ```ruby
 # config/initializers/jsonapi_resources.rb
 JSONAPI.configure do |config|
-  config.default_paginator = :custom_paginator
+  config.default_paginator = :custom
 end
 ```
 

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/jsonapi/utils/request.rb

@@ -6,6 +6,11 @@ module JSONAPI::Utils
     def jsonapi_request_handling
       setup_request
       check_request
+    rescue JSONAPI::Exceptions::InvalidResource,
+           JSONAPI::Exceptions::InvalidField,
+           JSONAPI::Exceptions::InvalidInclude,
+           JSONAPI::Exceptions::InvalidSortCriteria => err
+      jsonapi_render_errors(json: err)
     end
 
     # Instantiate the request object.

data/lib/jsonapi/utils/response/formatters.rb

@@ -15,6 +15,11 @@ module JSONAPI
         # @option options [JSONAPI::Resource] resource: it tells the formatter which resource
         #   class to be used rather than use an infered one (default behaviour)
         #
+        # @option options [JSONAPI::Resource] source: it tells the formatter that this response is from a related resource
+        #   and the result should be interpreted as a related resources response
+        #
+        # @option options [String, Symbol] relationship_type: it tells that the formatter which relationship the data is from
+        #
         # @option options [ActiveRecord::Base] model: ActiveRecord model class to be instantiated
         #   when a Hash or Array of Hashes is passed as the "object" argument
         #
@@ -27,7 +32,7 @@ module JSONAPI
         # @api public
         def jsonapi_format(object, options = {})
           if object.is_a?(Hash)
-            hash    = object.with_indifferent_access
+            hash = object.with_indifferent_access
             object = hash_to_active_record(hash[:data], options[:model])
           end
           fix_custom_request_options(object)
@@ -51,7 +56,7 @@ module JSONAPI
         # @api public
         def jsonapi_format_errors(object)
           if active_record_obj?(object)
-            object = JSONAPI::Utils::Exceptions::ActiveRecord.new(object, @request.resource_klass, context) 
+            object = JSONAPI::Utils::Exceptions::ActiveRecord.new(object, @request.resource_klass, context)
           end
           errors = object.respond_to?(:errors) ? object.errors : object
           JSONAPI::Utils::Support::Error.sanitize(errors).uniq
@@ -77,12 +82,15 @@ module JSONAPI
         # Build the full response document.
         #
         # @param object [ActiveRecord::Base, ActiveRecord::Relation, Hash, Array<Hash>]
-        #   Object to be formatted into JSON
-        #   e.g.: User.first, User.all, { data: { id: 1, first_name: 'Tiago' } },
-        #   [{ data: { id: 1, first_name: 'Tiago' } }]
+        #   Object to be formatted into JSON.
         #
-        # @option options [JSONAPI::Resource] resource: it tells the builder which resource
-        #   class to be used rather than use an infered one (default behaviour)
+        # @option options [JSONAPI::Resource] :resource which resource class to be used
+        #   rather than using the default one (inferred)
+        #
+        # @option options [ActiveRecord::Base, JSONAPI::Resource] :source source of related resource,
+        #   the result should be interpreted as a related resources response
+        #
+        # @option options [String, Symbol] :relationship which relationship the data is from
         #
         # @option options [Integer] count: if it's rendering a collection of resources, the default
         #   gem's counting method can be bypassed by the use of this options. It's shows then the total
@@ -95,8 +103,7 @@ module JSONAPI
           results = JSONAPI::OperationResults.new
 
           if object.respond_to?(:to_ary)
-            records = build_collection(object, options)
-            results.add_result(JSONAPI::ResourcesOperationResult.new(:ok, records, result_options(object, options)))
+            results.add_result(build_collection_result(object, options))
           else
             record = turn_into_resource(object, options)
             results.add_result(JSONAPI::ResourceOperationResult.new(:ok, record))
@@ -105,6 +112,68 @@ module JSONAPI
           @_response_document = create_response_document(results)
         end
 
+        # Build the result operation object for collection actions.
+        #
+        # @param object [ActiveRecord::Relation, Array<Hash>]
+        #   Object to be formatted into JSON.
+        #
+        # @option options [JSONAPI::Resource] :resource which resource class to be used
+        #   rather than using the default one (inferred)
+        #
+        # @option options [ActiveRecord::Base, JSONAPI::Resource] :source parent model/resource
+        #   of the related resource
+        #
+        # @option options [String, Symbol] :relationship which relationship the data is from
+        #
+        # @option options [Integer] count: if it's rendering a collection of resources, the default
+        #   gem's counting method can be bypassed by the use of this options. It's shows then the total
+        #   records resulting from that request and also calculates the pagination.
+        #
+        # @return [JSONAPI::ResourcesOperationResult, JSONAPI::RelatedResourcesOperationResult]
+        #
+        # @api private
+        def build_collection_result(object, options)
+          records = build_collection(object, options)
+          result_options = result_options(object, options)
+
+          if related_resource_operation?(options)
+            source_resource = turn_source_into_resource(options[:source])
+            relationship_type = get_source_relationship(options)
+
+            JSONAPI::RelatedResourcesOperationResult.new(
+              :ok,
+              source_resource,
+              relationship_type,
+              records,
+              result_options
+            )
+          else
+            JSONAPI::ResourcesOperationResult.new(:ok, records, result_options)
+          end
+        end
+
+        # Is this a request for related resources?
+        #
+        # In order to answer that it needs to check for some {options}
+        # controller params like {params[:source]} and {params[:relationship]}.
+        #
+        # @option options [Boolean] :related when true, jsonapi-utils infers the parent and
+        #   related resources from controller's {params} values.
+        #
+        # @option options [ActiveRecord::Base, JSONAPI::Resource] :source parent model/resource
+        #   of the related resource
+        #
+        # @option options [String, Symbol] :relationship which relationship the data is from
+        #
+        # @return [Boolean]
+        #
+        # @api private
+        def related_resource_operation?(options)
+          (options[:related] || options[:source].present?) &&
+            params[:source].present? &&
+            params[:relationship].present?
+        end
+
         # Apply a proper action setup for custom requests/actions.
         #
         # @note The setup_(index|show)_action comes from JSONAPI::Resources' API.
@@ -134,10 +203,9 @@ module JSONAPI
         #   Objects to be instantiated as JSONAPI::Resource ones.
         #   e.g.: User.all, [{ data: { id: 1, first_name: 'Tiago' } }]
         #
-        # @option options [JSONAPI::Resource] resource: it tells the buider which resource
-        #   class to be used rather than use an infered one (default behaviour)
+        # @option options [JSONAPI::Resource] :resource it resource class to be used rather than default one (infered)
         #
-        # @option options [Integer] count: if it's rendering a collection of resources, the default
+        # @option options [Integer] :count if it's rendering a collection of resources, the default
         #   gem's counting method can be bypassed by the use of this options. It's shows then the total
         #   records resulting from that request and also calculates the pagination.
         #
@@ -171,6 +239,30 @@ module JSONAPI
           end
         end
 
+        # Get JSONAPI::Resource for source object
+        #
+        # @param record [ActiveRecord::Base, JSONAPI::Resource]
+        #
+        # @return [JSONAPI::Resource]
+        #
+        # @api private
+        def turn_source_into_resource(record)
+          return record if record.kind_of?(JSONAPI::Resource)
+          @request.source_klass.new(record, context)
+        end
+
+        # Get relationship type of source object
+        #
+        # @option options [Symbol] relationship: it tells which relationship
+        #   to be used rather than use an infered one (default behaviour)
+        #
+        # @return [Symbol]
+        #
+        # @api private
+        def get_source_relationship(options)
+          options[:relationship]&.to_sym || @request.resource_klass._type
+        end
+
         # Apply some result options like pagination params and record count to collection responses.
         #
         # @param records [ActiveRecord::Relation, Hash, Array<Hash>]
@@ -186,8 +278,7 @@ module JSONAPI
         # @api private
         def result_options(records, options)
           {}.tap do |data|
-            if JSONAPI.configuration.default_paginator != :none &&
-              JSONAPI.configuration.top_level_links_include_pagination
+            if include_pagination_links?
               data[:pagination_params] = pagination_params(records, options)
             end
 
@@ -195,7 +286,7 @@ module JSONAPI
               data[:record_count] = record_count_for(records, options)
             end
 
-            if JSONAPI.configuration.top_level_meta_include_page_count
+            if include_page_count?
               data[:page_count] = page_count_for(data[:record_count])
             end
           end

data/lib/jsonapi/utils/response/renders.rb

@@ -14,6 +14,11 @@ module JSONAPI
         #
         # @option options [JSONAPI::Resource] resource: it tells the render which resource
         #   class to be used rather than use an infered one (default behaviour)
+        # 
+        # @option options [JSONAPI::Resource] source_resource: it tells the render that this response is from a related resource
+        #   and the result should be interpreted as a related resources response
+        #
+        # @option options [String, Symbol] relationship_type: it tells that the render which relationship the data is from
         #
         # @option options [ActiveRecord::Base] model: ActiveRecord model class to be instantiated
         #   when a Hash or Array of Hashes is passed to the "json" key argument

data/lib/jsonapi/utils/support/pagination.rb

@@ -4,20 +4,40 @@ module JSONAPI
       module Pagination
         RecordCountError = Class.new(ArgumentError)
 
+        # Check whether pagination links should be included.
+        #
+        # @api public
+        # @return [Boolean]
+        def include_pagination_links?
+          JSONAPI.configuration.default_paginator != :none &&
+            JSONAPI.configuration.top_level_links_include_pagination
+        end
+
+        # Check whether pagination's page count should be included
+        # on the "meta" key.
+        #
+        # @api public
+        # @return [Boolean]
+        def include_page_count?
+          JSONAPI.configuration.top_level_meta_include_page_count
+        end
+
         # Apply proper pagination to the records.
         #
         # @param records [ActiveRecord::Relation, Array] collection of records
         #   e.g.: User.all or [{ id: 1, name: 'Tiago' }, { id: 2, name: 'Doug' }]
         #
-        # @param options [Hash] JU's options
+        # @param options [Hash] JSONAPI::Utils' options
         #   e.g.: { resource: V2::UserResource, count: 100 }
         #
         # @return [ActiveRecord::Relation, Array]
         #
         # @api public
         def apply_pagination(records, options = {})
-          return records unless apply_pagination?(options)
-          records.is_a?(Array) ? records[paginate_with(:range)] : paginate_with(:paginator).apply(records, nil)
+          if !apply_pagination?(options) then records
+          elsif records.is_a?(Array)     then records[paginate_with(:range)]
+          else paginate_with(:paginator).apply(records, nil)
+          end
         end
 
         # Mount pagination params for JSONAPI::ResourcesOperationResult.
@@ -32,9 +52,10 @@ module JSONAPI
         # @return [Hash]
         #   e.g.: {"first"=>{"number"=>1, "size"=>2}, "next"=>{"number"=>2, "size"=>2}, "last"=>{"number"=>2, "size"=>2}}
         #
+        #
         # @api public
         def pagination_params(records, options)
-          return {} unless JSONAPI.configuration.top_level_links_include_pagination
+          return {} unless include_pagination_links?
           paginator.links_page_params(record_count: record_count_for(records, options))
         end
 

data/lib/jsonapi/utils/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Utils
-    VERSION = '0.7.2'.freeze
+    VERSION = '0.7.3'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-utils
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Tiago Guedes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-resources
@@ -17,98 +17,122 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: smart_rspec
   requirement: !ruby/object:Gem::Requirement
@@ -129,28 +153,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
 description: Build JSON API-compliant APIs on Rails with no (or less) learning curve.
 email:
 - tiagopog@gmail.com
@@ -163,6 +199,7 @@ files:
 - LICENSE.txt
 - README.md
 - bin/console
+- bin/rspec
 - bin/setup
 - lib/jsonapi/utils.rb
 - lib/jsonapi/utils/exceptions.rb
@@ -199,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: JSON::Utils is a simple way to get a full-featured JSON API on your Rails