alchemy-json_api 1.2.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d436e84cb2932c71c9974bc75433118852c186814c96f21114b3c6c6b390810f
-  data.tar.gz: 4ea8ca6841fe3845c6e68fa4956c3c730de0040f2a9ced1c24e9081d17e8a80a
+  metadata.gz: e4da501de3e83d19a9226ed5cba95c5ee4026c0931997070daaa55aabc4357c3
+  data.tar.gz: 7a4c15a0d2186d2a3b62badf8817ccc2f16ffc4bd8fcea8dc2b88adfc2099b16
 SHA512:
-  metadata.gz: af4117975a7904c5625818a0e0f8bc569e4bf3e1c9ca03a4bf4886b064903486f21d1eb3be20eb03fc1612307889f42c66bcc82b4a4404dd56a7d8b0a3ae12fc
-  data.tar.gz: a1ecca618f3edac7de63242bdfb084eb4dcbe877df31ac5b1ebea666382391c91e4c762b96303743f41d75d011957d0ce1f0c2bf64140aebbe66cef3bd55146c
+  metadata.gz: 19a29387ac8c5e087bb1ad8f04e162af62c4f0c05f6481d3579fa0b415dca569517c7a3e5a763c17aff0d3f6fe0cb1bda913156b7be3b51900724af3f713516a
+  data.tar.gz: 7800110a1df4d98a6e96184420316be08ba8c43a25690ce6f6a29f29191505055f344cf0f80523e06221796a344f4b58bd4a1da169fc1dc2da4a384ef3085817

data/app/controllers/alchemy/json_api/pages_controller.rb

@@ -6,7 +6,7 @@ module Alchemy
       before_action :load_page_for_cache_key, only: :show
 
       def index
-        allowed = [:page_layout, :urlname]
+        allowed = Alchemy::Page.ransackable_attributes
 
         jsonapi_filter(page_scope, allowed) do |filtered_pages|
           @pages = filtered_pages.result
@@ -79,6 +79,7 @@ module Alchemy
 
       def load_page_by_id
         return unless params[:path] =~ /\A\d+\z/
+
         page_scope_with_includes.find_by(id: params[:path])
       end
 
@@ -100,12 +101,11 @@ module Alchemy
                 page_version_type => {
                   elements: [
                     :nested_elements,
-                    { contents: { essence: :ingredient_association } },
                     { ingredients: :related_object },
                   ],
                 },
               },
-            ]
+            ],
           )
       end
 

data/app/models/alchemy/json_api/page.rb

@@ -1,4 +1,10 @@
 module Alchemy
+  # With Ransack 4 we need to define the attributes
+  # that are allowed to be searched.
+  def Page.ransackable_attributes(_auth_object = nil)
+    super | %w[page_layout]
+  end
+
   module JsonApi
     class Page < SimpleDelegator
       attr_reader :page_version_type, :page_version

data/app/serializers/alchemy/json_api/element_serializer.rb

@@ -16,10 +16,6 @@ module Alchemy
         !!element.definition[:deprecated]
       end
 
-      has_many :essences, polymorphic: true do |element|
-        element.contents.map(&:essence)
-      end
-
       has_many :ingredients,
         serializer: ->(record) do
           "Alchemy::JsonApi::Ingredient#{record.type.demodulize}Serializer".constantize

data/lib/alchemy/json_api/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Alchemy
   module JsonApi
-    VERSION = "1.2.0"
+    VERSION = "2.0.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Martin Meyerhoff
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -17,20 +17,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0.a
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0.a
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: jsonapi.rb
   requirement: !ruby/object:Gem::Requirement
@@ -134,20 +134,6 @@ files:
 - app/models/alchemy/json_api/page.rb
 - app/serializers/alchemy/json_api/base_serializer.rb
 - app/serializers/alchemy/json_api/element_serializer.rb
-- app/serializers/alchemy/json_api/essence_audio_serializer.rb
-- app/serializers/alchemy/json_api/essence_boolean_serializer.rb
-- app/serializers/alchemy/json_api/essence_date_serializer.rb
-- app/serializers/alchemy/json_api/essence_file_serializer.rb
-- app/serializers/alchemy/json_api/essence_headline_serializer.rb
-- app/serializers/alchemy/json_api/essence_html_serializer.rb
-- app/serializers/alchemy/json_api/essence_link_serializer.rb
-- app/serializers/alchemy/json_api/essence_node_serializer.rb
-- app/serializers/alchemy/json_api/essence_page_serializer.rb
-- app/serializers/alchemy/json_api/essence_picture_serializer.rb
-- app/serializers/alchemy/json_api/essence_richtext_serializer.rb
-- app/serializers/alchemy/json_api/essence_select_serializer.rb
-- app/serializers/alchemy/json_api/essence_text_serializer.rb
-- app/serializers/alchemy/json_api/essence_video_serializer.rb
 - app/serializers/alchemy/json_api/ingredient_audio_serializer.rb
 - app/serializers/alchemy/json_api/ingredient_boolean_serializer.rb
 - app/serializers/alchemy/json_api/ingredient_datetime_serializer.rb
@@ -193,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: A JSONAPI compliant API for AlchemyCMS

data/app/serializers/alchemy/json_api/essence_audio_serializer.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceAudioSerializer < BaseSerializer
-      include EssenceSerializer
-
-      attributes(
-        :autoplay,
-        :controls,
-        :muted,
-        :loop,
-      )
-
-      attribute :ingredient do |essence|
-        essence.attachment&.url
-      end
-
-      with_options if: ->(essence) { essence.attachment } do
-        attribute :audio_name do |essence|
-          essence.attachment.name
-        end
-
-        attribute :audio_file_name do |essence|
-          essence.attachment.file_name
-        end
-
-        attribute :audio_mime_type do |essence|
-          essence.attachment.file_mime_type
-        end
-
-        attribute :audio_file_size do |essence|
-          essence.attachment.file_size
-        end
-      end
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_boolean_serializer.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceBooleanSerializer < BaseSerializer
-      include EssenceSerializer
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_date_serializer.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceDateSerializer < BaseSerializer
-      include EssenceSerializer
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_file_serializer.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceFileSerializer < BaseSerializer
-      include EssenceSerializer
-
-      attribute :link_title, &:title
-
-      attribute :ingredient, &:attachment_url
-
-      with_options if: proc { |essence| essence.attachment.present? } do
-        attribute :attachment_name do |essence|
-          essence.attachment.name
-        end
-
-        attribute :attachment_file_name do |essence|
-          essence.attachment.file_name
-        end
-
-        attribute :attachment_mime_type do |essence|
-          essence.attachment.file_mime_type
-        end
-
-        attribute :attachment_file_size do |essence|
-          essence.attachment.file_size
-        end
-      end
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_headline_serializer.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceHeadlineSerializer < BaseSerializer
-      include EssenceSerializer
-
-      attributes :level, :size
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_html_serializer.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceHtmlSerializer < BaseSerializer
-      include EssenceSerializer
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_link_serializer.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceLinkSerializer < BaseSerializer
-      include EssenceSerializer
-      attributes(
-        :link_title,
-        :link_target,
-      )
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_node_serializer.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceNodeSerializer < BaseSerializer
-      include EssenceSerializer
-
-      attribute :ingredient do |essence|
-        essence&.node&.name
-      end
-
-      belongs_to :node, record_type: :node, serializer: ::Alchemy::JsonApi::NodeSerializer
-
-      with_options if: proc { |essence| essence.node.present? } do
-        attribute :name do |essence|
-          essence.node.name
-        end
-
-        attribute :link_url do |essence|
-          essence.node.url
-        end
-
-        attribute :link_title do |essence|
-          essence.node.title
-        end
-
-        attribute :link_nofollow do |essence|
-          essence.node.nofollow
-        end
-      end
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_page_serializer.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssencePageSerializer < BaseSerializer
-      include EssenceSerializer
-
-      attribute :ingredient do |essence|
-        essence.page&.url_path
-      end
-
-      attribute :page_name do |essence|
-        essence.page&.name
-      end
-
-      attribute :page_url do |essence|
-        essence.page&.url_path
-      end
-
-      has_one :page, record_type: :page, serializer: ::Alchemy::JsonApi::PageSerializer
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_picture_serializer.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssencePictureSerializer < BaseSerializer
-      include EssenceSerializer
-
-      attributes(
-        :title,
-        :caption,
-        :link_title,
-        :link_target,
-      )
-      attribute :ingredient, &:picture_url
-      attribute :alt_text, &:alt_tag
-      attribute :link_url, &:link
-
-      with_options if: proc { |essence| essence.picture.present? } do
-        attribute :image_dimensions do |essence|
-          sizes = essence.content.settings[:size]&.split("x", 2)&.map(&:to_i) || [
-            essence.image_file_width,
-            essence.image_file_height,
-          ]
-
-          ratio = essence.image_file_width.to_f / essence.image_file_height
-          width = sizes[0].zero? ? sizes[1] * ratio : sizes[0]
-          height = sizes[1].zero? ? sizes[0] / ratio : sizes[1]
-
-          {
-            width: width,
-            height: height,
-          }
-        end
-
-        attribute :srcset do |essence|
-          essence.content.settings.fetch(:srcset, []).map do |src|
-            case src
-            when Hash
-              url = essence.picture_url(src)
-              size = src[:size]
-              type = Mime::Type.lookup_by_extension(src[:format] || essence.picture.default_render_format)
-            else
-              url = essence.picture_url(size: src)
-              size = src
-              type = Mime::Type.lookup_by_extension(essence.picture.default_render_format)
-            end
-            width, height = size.split("x", 2)
-
-            {
-              url: url,
-              desc: "#{width}w",
-              width: width,
-              height: height,
-              type: type.to_s,
-            }
-          end
-        end
-
-        attribute :image_name do |essence|
-          essence.picture.name
-        end
-
-        attribute :image_file_name do |essence|
-          essence.picture.image_file_name
-        end
-
-        attribute :image_mime_type do |essence|
-          "image/#{essence.picture.image_file_format}"
-        end
-
-        attribute :image_file_size do |essence|
-          essence.picture.image_file_size
-        end
-      end
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_richtext_serializer.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceRichtextSerializer < BaseSerializer
-      include EssenceSerializer
-      attributes(
-        :body,
-        :sanitized_body,
-        :stripped_body,
-      )
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_select_serializer.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceSelectSerializer < BaseSerializer
-      include EssenceSerializer
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_text_serializer.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceTextSerializer < BaseSerializer
-      include EssenceSerializer
-      attributes(
-        :body,
-        :link_title,
-        :link_target,
-      )
-      attribute :link_url, &:link
-    end
-  end
-end

data/app/serializers/alchemy/json_api/essence_video_serializer.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require "alchemy/json_api/essence_serializer"
-
-module Alchemy
-  module JsonApi
-    class EssenceVideoSerializer < BaseSerializer
-      include EssenceSerializer
-
-      attributes(
-        :width,
-        :height,
-        :allow_fullscreen,
-        :autoplay,
-        :controls,
-        :preload,
-      )
-
-      attribute :ingredient do |essence|
-        essence.attachment&.url
-      end
-
-      with_options if: ->(essence) { essence.attachment } do
-        attribute :video_name do |essence|
-          essence.attachment.name
-        end
-
-        attribute :video_file_name do |essence|
-          essence.attachment.file_name
-        end
-
-        attribute :video_mime_type do |essence|
-          essence.attachment.file_mime_type
-        end
-
-        attribute :video_file_size do |essence|
-          essence.attachment.file_size
-        end
-      end
-    end
-  end
-end