jsonapi_actions 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36ec7e18ffd84c14377409471e3f3dd911d956e0e1d3960dc52113cd51f20923
-  data.tar.gz: 1d9034c3807d27a04923332af04f1008bd1b9d1af7fa05ced37f5a279f7d26a5
+  metadata.gz: 94c6363f31fa607be5d701095e0e35de2fa629217790e73c9a936690d5d6ad24
+  data.tar.gz: c2bf209aba2c38641420a53ab8ed65a313cebfda1aa2c5f1928ee813c7ba2a45
 SHA512:
-  metadata.gz: 4454b8e91c724d5178e80be964bb85e4d214ee5bfcfbb92b67c6522d5f970ec034a2a238f3ab19618cd8073c7856fb9a6d60cfe150d3387e28850f29f9995628
-  data.tar.gz: 57e35c3a97f5ad2418767ad556f17e1a46d7499b9a6cc0f20a8fa52a190342547a249aad7ee17ce20e617bce7f4cf0ad642b88a7dffbfaf8367bcbad1f04874b
+  metadata.gz: 46a6ff5a7e0b42f7a4dc956f990a1f6c4220b9b8c7f51e3fecece495f2004b10cfaddaec05b677f832fa38b52e8a7a35b18750c454c5027e58419f4d105c75f8
+  data.tar.gz: 2e6a382eb9b4b7f28436fd5524045b315d2d0b48cf192d994773dd1d441d9024d92a3ab2589fb66041e4ba702a32c23936f5f40f0bc4992e96d6dc30906cda99

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-*
+
+.idea/

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.1
+ruby-2.7.4

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2023-02-22
+### Added
+- Added `serializer_params` method to more easily allow for custom serializer params.
+
 ## [0.2.2] - 2020-05-18
 ### Fixed
 - JsonapiActions#json_response uses `defined?` to check for serializer library

data/Gemfile.lock

@@ -1,87 +1,105 @@
 PATH
   remote: .
   specs:
-    jsonapi_actions (0.4.0)
+    jsonapi_actions (0.6.0)
       kaminari (>= 1.0, < 2.0)
-      rails (>= 4.0, < 7.1)
+      rails (>= 4.0, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4)
-      actionpack (= 7.0.4)
-      activesupport (= 7.0.4)
+    actioncable (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4)
-      actionpack (= 7.0.4)
-      activejob (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.4)
-      actionpack (= 7.0.4)
-      actionview (= 7.0.4)
-      activejob (= 7.0.4)
-      activesupport (= 7.0.4)
+    actionmailer (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      actionview (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.4)
-      actionview (= 7.0.4)
-      activesupport (= 7.0.4)
-      rack (~> 2.0, >= 2.2.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4)
-      actionpack (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4)
-      activesupport (= 7.0.4)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4)
-      activesupport (= 7.0.4)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3.4)
+      activesupport (= 7.1.3.4)
       globalid (>= 0.3.6)
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activestorage (7.0.4)
-      actionpack (= 7.0.4)
-      activejob (= 7.0.4)
-      activerecord (= 7.0.4)
-      activesupport (= 7.0.4)
+    activemodel (7.1.3.4)
+      activesupport (= 7.1.3.4)
+    activerecord (7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.4)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
     crass (1.0.6)
+    date (3.3.4)
     diff-lcs (1.3)
-    erubi (1.11.0)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.12.0)
+    drb (2.2.1)
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     kaminari (1.2.2)
       activesupport (>= 4.1.0)
       kaminari-actionview (= 1.2.2)
@@ -94,57 +112,77 @@ GEM
       activerecord
       kaminari-core (= 1.2.2)
     kaminari-core (1.2.2)
-    loofah (2.19.0)
+    loofah (2.22.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.16.3)
-    net-imap (0.3.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.7)
+    minitest (5.23.1)
+    mutex_m (0.2.0)
+    net-imap (0.4.12)
+      date
       net-protocol
     net-pop (0.1.2)
       net-protocol
-    net-protocol (0.1.3)
+    net-protocol (0.2.2)
       timeout
-    net-smtp (0.3.3)
+    net-smtp (0.5.0)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.13.9-x86_64-darwin)
+    nio4r (2.7.3)
+    nokogiri (1.15.6)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    racc (1.6.0)
-    rack (2.2.4)
-    rack-test (2.0.2)
+    psych (5.1.2)
+      stringio
+    racc (1.8.0)
+    rack (3.1.0)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4)
-      actioncable (= 7.0.4)
-      actionmailbox (= 7.0.4)
-      actionmailer (= 7.0.4)
-      actionpack (= 7.0.4)
-      actiontext (= 7.0.4)
-      actionview (= 7.0.4)
-      activejob (= 7.0.4)
-      activemodel (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.3.4)
+      actioncable (= 7.1.3.4)
+      actionmailbox (= 7.1.3.4)
+      actionmailer (= 7.1.3.4)
+      actionpack (= 7.1.3.4)
+      actiontext (= 7.1.3.4)
+      actionview (= 7.1.3.4)
+      activejob (= 7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activerecord (= 7.1.3.4)
+      activestorage (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       bundler (>= 1.15.0)
-      railties (= 7.0.4)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.1.3.4)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (7.0.4)
-      actionpack (= 7.0.4)
-      activesupport (= 7.0.4)
-      method_source
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      irb
+      rackup (>= 1.0.0)
       rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rake (13.0.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    reline (0.5.8)
+      io-console (~> 0.5)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -158,16 +196,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    thor (1.2.1)
-    timeout (0.3.0)
-    tzinfo (2.0.5)
+    stringio (3.1.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.5)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.6)
+    zeitwerk (2.6.15)
 
 PLATFORMS
+  arm64-darwin-22
   ruby
   x86_64-darwin-20
 

data/jsonapi_actions.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_dependency 'rails', '>= 4.0', '< 7.1'
+  spec.add_dependency 'rails', '>= 4.0', '< 8'
   spec.add_dependency 'kaminari', '>= 1.0', '< 2.0'
 end

data/lib/jsonapi_actions/version.rb

@@ -1,3 +1,3 @@
 module JsonapiActions
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/jsonapi_actions.rb

@@ -74,146 +74,148 @@ module JsonapiActions
 
     private
 
-    def metadata
-      {}
-    end
+      def metadata
+        {}
+      end
 
-    def parent_scope(records)
-      return records if self.class.parent_associations.blank?
+      def parent_scope(records)
+        return records if self.class.parent_associations.blank?
 
-      self.class.parent_associations.each do |parent|
-        next if params[parent[:param]].blank?
+        self.class.parent_associations.each do |parent|
+          next if params[parent[:param]].blank?
 
-        records = records.joins(parent[:association]) unless parent[:association].blank?
-        records = if parent[:table]
-                    records.where(parent[:table] => { parent[:attribute] => params[parent[:param]] })
-                  else
-                    records.where(parent[:attribute] => params[parent[:param]])
-                  end
-      end
+          records = records.joins(parent[:association]) unless parent[:association].blank?
+          records = if parent[:table]
+                      records.where(parent[:table] => { parent[:attribute] => params[parent[:param]] })
+                    else
+                      records.where(parent[:attribute] => params[parent[:param]])
+                    end
+        end
 
-      records
-    end
+        records
+      end
 
-    def filter(records)
-      records
-    end
+      def filter(records)
+        records
+      end
 
-    def sort(records)
-      return records if params[:sort].blank?
-      order = {}
+      def sort(records)
+        return records if params[:sort].blank?
+        order = {}
 
-      params[:sort].split(',').each do |sort|
-        if sort[0] == '-'
-          order[sort[1..-1]] = :desc
-        else
-          order[sort] = :asc
+        params[:sort].split(',').each do |sort|
+          if sort[0] == '-'
+            order[sort[1..-1]] = :desc
+          else
+            order[sort] = :asc
+          end
         end
+
+        return records.order(order)
       end
 
-      return records.order(order)
-    end
+      def paginate(records)
+        records.page(page[:number]).per(page[:size])
+      end
 
-    def paginate(records)
-      records.page(page[:number]).per(page[:size])
-    end
+      def page
+        @page ||= begin
+                    page = {}
+                    page[:number] = (params.dig(:page, :number) || 1).to_i
+                    page[:size] = [[(params.dig(:page, :size) || 20).to_i, 1000].min, 1].max
+                    page
+                  end
+      end
 
-    def page
-      @page ||= begin
-                  page = {}
-                  page[:number] = (params.dig(:page, :number) || 1).to_i
-                  page[:size] = [[(params.dig(:page, :size) || 20).to_i, 1000].min, 1].max
-                  page
-                end
-    end
+      def set_record
+        @record = model.find(params[:id])
+        authorize(@record)
+      end
 
-    def set_record
-      @record = model.find(params[:id])
-      authorize(@record)
-    end
+      def id_param
+        params.require(:data).permit(policy(@record).permitted_attributes)[:id]
+      end
 
-    def id_param
-      params.require(:data).permit(policy(@record).permitted_attributes)[:id]
-    end
+      def record_params
+        params.require(:data).require(:attributes).permit(policy(@record).permitted_attributes)
+      end
 
-    def record_params
-      params.require(:data).require(:attributes).permit(policy(@record).permitted_attributes)
-    end
+      def include_param
+        if %w[* **].include? params[:include]
+          inclusion_map
+        else
+          params[:include].to_s.split(',').reject(&:blank?).map(&:to_sym)
+        end
+      end
 
-    def include_param
-      if %w[* **].include? params[:include]
-        inclusion_map
-      else
-        params[:include].to_s.split(',').reject(&:blank?).map(&:to_sym)
+      def inclusion_map
+        InclusionMapper.new(serializer, include: params[:include]).map
       end
-    end
 
-    def inclusion_map
-      InclusionMapper.new(serializer, include: params[:include]).map
-    end
+      def unprocessable_entity(record)
+        Rails.logger.debug(record.errors.messages)
+        { json: record.errors.messages, status: :unprocessable_entity }
+      end
 
-    def unprocessable_entity(record)
-      Rails.logger.debug(record.errors.messages)
-      { json: record.errors.messages, status: :unprocessable_entity }
-    end
+      def pagination_meta(collection)
+        return {} if collection.nil?
 
-    def pagination_meta(collection)
-      return {} if collection.nil?
+        {
+          current_page: collection.current_page,
+          next_page: collection.next_page,
+          prev_page: collection.prev_page,
+          total_pages: collection.total_pages,
+          total_count: collection.total_count
+        }
+      end
 
-      {
-        current_page: collection.current_page,
-        next_page: collection.next_page,
-        prev_page: collection.prev_page,
-        total_pages: collection.total_pages,
-        total_count: collection.total_count
-      }
-    end
+      def model
+        self.class.model || self.class.model_name.constantize
+      end
 
-    def model
-      self.class.model || self.class.model_name.constantize
-    end
+      def json_response(data, options = {})
+        if defined?(JSONAPI::Serializer) || defined?(FastJsonapi)
+          {
+            json: serializer(data).new(data, options.deep_merge(
+              include: include_param,
+              meta: metadata,
+              params: serializer_params)
+            )
+          }
 
-    def json_response(data, options = {})
-      if defined?(JSONAPI::Serializer) || defined?(FastJsonapi)
-        {
-          json: serializer(data).new(data, options.deep_merge(
-            include: include_param,
-            meta: metadata,
-            params: {
-              current_user: try(:current_user)
-            })
-          )
-        }
+        elsif defined?(ActiveModel::Serializer)
+          { json: data }.merge(meta: metadata, include: include_param).merge(options)
 
-      elsif defined?(ActiveModel::Serializer)
-        { json: data }.merge(meta: metadata, include: include_param).merge(options)
+        else
+          { json: { data: data }.merge(options) }
+        end
+      end
 
-      else
-        { json: { data: data }.merge(options) }
+      def serializer(data = nil)
+        serializer_classes = [
+          self.class.serializer,
+          data.try(:serializer_class),
+          "#{data.class.name}Serializer".safe_constantize,
+          data.try(:first).try(:serializer_class),
+          "#{data.try(:first).class.name}Serializer".safe_constantize
+        ].compact
+
+        if serializer_classes.any?
+          serializer_classes.first
+        else
+          "#{model.name}Serializer".safe_constantize
+        end
+      rescue NoMethodError, NameError
+        raise 'Unknown serializer'
       end
-    end
 
-    def serializer(data = nil)
-      serializer_classes = [
-        self.class.serializer,
-        data.try(:serializer_class),
-        "#{data.class.name}Serializer".safe_constantize,
-        data.try(:first).try(:serializer_class),
-        "#{data.try(:first).class.name}Serializer".safe_constantize
-      ].compact
-
-      if serializer_classes.any?
-        serializer_classes.first
-      else
-        "#{model.name}Serializer".safe_constantize
+      def serializer_params
+        { current_user: try(:current_user) }
       end
-    rescue NoMethodError, NameError
-      raise 'Unknown serializer'
-    end
 
-    def eager_load(records)
-      records
-    end
+      def eager_load(records)
+        records
+      end
   end
 
   module ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_actions
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kevin Pheasey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,7 +61,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Rails JSON:API Controller Actions