jsonapi_actions 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd75b7ea62934cf27cc351d4327cf302af2ab1f5aed66d6d6075575e974d90b6
-  data.tar.gz: 56008596f5f59e8eb0640b2d0be4b81eed49dd6fdc7e0f08af5d9f10fc683687
+  metadata.gz: fe65b6ed02022e7f5962df4faca6f9326aa69e270ce3a7206d23b604141b03d8
+  data.tar.gz: f429a5e20e6caa7f485b25873d30887bde4321e12ff22483505ffce2ded6b249
 SHA512:
-  metadata.gz: 709f2ae770a5efbfca5252997c866205a898eb85cc77dddc5517a936d99910e169f7767ecd1a677ec33b4aef30157236528260e9d629cb937578250fb489350b
-  data.tar.gz: 47e353f3fa687d0ee7a8463dfa412b110982bfcf10c2f294084603bce6f12d29ae937befb795549be5b3bc36f59ce2c9a2f85c4368a2c0a217a57c79159f93c5
+  metadata.gz: 68cf00f70d0727172195ddc306e5b450e83cf003203c94cdbfa85677e4c9fde9dc3853737e17640d6b9546f47287481b240653c03c13bfb72356d5f820ab6770
+  data.tar.gz: '0992c33f6b4e04eb049ffef3139dba7b7339ace3ebff6d66a631ab408d52395ca038a4ec47c23b263bde7a83b09b78715659747d00c7edfcf90e3021ace19da6'

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-*

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.3
+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,133 +1,151 @@
 PATH
   remote: .
   specs:
-    jsonapi_actions (0.1.2)
+    jsonapi_actions (0.4.0)
       kaminari (>= 1.0, < 2.0)
-      rails (>= 4.0, < 7.0)
+      rails (>= 4.0, < 7.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.2.2)
-      actionpack (= 6.0.2.2)
+    actioncable (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionmailbox (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
       mail (>= 2.7.1)
-    actionmailer (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
+      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)
       mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.2)
-      actionview (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actiontext (7.0.4)
+      actionpack (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activestorage (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      marcel (~> 0.3.1)
-    activesupport (6.0.2.2)
+    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)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     builder (3.2.4)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.3)
-    erubi (1.9.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.2)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    kaminari (1.2.0)
+    kaminari (1.2.2)
       activesupport (>= 4.1.0)
-      kaminari-actionview (= 1.2.0)
-      kaminari-activerecord (= 1.2.0)
-      kaminari-core (= 1.2.0)
-    kaminari-actionview (1.2.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
       actionview
-      kaminari-core (= 1.2.0)
-    kaminari-activerecord (1.2.0)
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
       activerecord
-      kaminari-core (= 1.2.0)
-    kaminari-core (1.2.0)
-    loofah (2.4.0)
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    loofah (2.19.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mimemagic (0.3.4)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    nio4r (2.5.2)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    rack (2.2.2)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (6.0.2.2)
-      actioncable (= 6.0.2.2)
-      actionmailbox (= 6.0.2.2)
-      actionmailer (= 6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actiontext (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-      bundler (>= 1.3.0)
-      railties (= 6.0.2.2)
-      sprockets-rails (>= 2.0.0)
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    net-imap (0.3.1)
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.8)
+    nokogiri (1.13.9-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.9-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      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)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
     rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -142,24 +160,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    sprockets (4.0.0)
+    thor (1.2.1)
+    timeout (0.3.0)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    websocket-driver (0.7.1)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    zeitwerk (2.3.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.6)
 
 PLATFORMS
+  arm64-darwin-22
   ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler (~> 2.0)
@@ -168,4 +181,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.1
+   2.2.2

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.0'
+  spec.add_dependency 'rails', '>= 4.0', '< 7.1'
   spec.add_dependency 'kaminari', '>= 1.0', '< 2.0'
 end

data/lib/jsonapi_actions/version.rb

@@ -1,3 +1,3 @@
 module JsonapiActions
-  VERSION = "0.3.0"
+  VERSION = "0.5.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.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Pheasey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2023-02-22 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.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !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.0.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Rails JSON:API Controller Actions