alchemy-json_api 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 529c7f7ab8ebaaf065cfdaf1e25441ef1453c5e179a10cd6e40caefdbbe58f1a
-  data.tar.gz: 6761266d21e3d9bba7678f86edc9f8372850845880ec8030c98d91d74752f8cd
+  metadata.gz: 89edfe1ba595351698467e746b9451be8483071b6e4878fd9ef30c6cd062011a
+  data.tar.gz: 5cdbc986b5eeae3dadfb7dd8f5beb6fc2632a5766131ac7b12e50b2595062e11
 SHA512:
-  metadata.gz: 8335a8178b3ffdffa04a7b4c637248387cf3b625d7e7b6db7ce02fc95faf456fd61a7ebd052af1c96accb5fce206e6c005c69a365c871ac5707b86a64fa37902
-  data.tar.gz: ed1ee154159e7b67262999db7539791b1b904ab860846042421a4f2e04a1e8f21643096adb9d5ddf478f73572da699323192628b204fdfd5cb523973175c4398
+  metadata.gz: 0cc256eb440f91369407d301410674cd7703a84bc28704e4ae220c32ee69d6cc6984f84bf53b6ec9d45c29b203381f30173292ef384b200aed95ab89aff96b12
+  data.tar.gz: e67fb531194df5b8b457f5cbdeadedd78e04cf5f2adfdb86ded3ec4a0eb8081e858bdff63a59b9f1a71ea81d87cae99e81526affcbb234985108d9b9d207b62b

data/Rakefile

@@ -12,6 +12,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 task default: [:test_setup, :spec]
 
+require "active_support"
 require "active_support/core_ext/string"
 
 desc "Setup test app"

data/app/controllers/alchemy/json_api/admin/layout_pages_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     module Admin

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     module Admin
@@ -13,11 +14,15 @@ module Alchemy
         end
 
         def caching_options
-          { public: false, must_revalidate: true }
+          {public: false, must_revalidate: true}
         end
 
         def set_current_preview
-          Alchemy::Page.current_preview = @page
+          if Alchemy.const_defined?(:Current)
+            Alchemy::Current.preview_page = @page
+          else
+            Alchemy::Page.current_preview = @page
+          end
         end
 
         def last_modified_for(page)

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     class BaseController < ::ApplicationController
@@ -11,7 +12,7 @@ module Alchemy
 
       rescue_from(
         CanCan::AccessDenied,
-        with: :render_jsonapi_unauthorized,
+        with: :render_jsonapi_unauthorized
       )
 
       private
@@ -32,7 +33,7 @@ module Alchemy
       end
 
       def render_jsonapi_unauthorized(exception)
-        error = { status: "401", title: Rack::Utils::HTTP_STATUS_CODES[401] }
+        error = {status: "401", title: Rack::Utils::HTTP_STATUS_CODES[401]}
         render jsonapi_errors: [error], status: :unauthorized
       end
     end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     class LayoutPagesController < JsonApi::PagesController

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

@@ -11,7 +11,7 @@ module Alchemy
           end
         end
 
-        expires_in cache_duration, { public: true, must_revalidate: true }
+        expires_in cache_duration, {public: true, must_revalidate: true}
       end
 
       private
@@ -25,7 +25,7 @@ module Alchemy
 
         {
           pagination: pagination.presence,
-          total: node_scope.count,
+          total: node_scope.count
         }.compact
       end
 
@@ -37,7 +37,7 @@ module Alchemy
         if params[:include].present?
           includes = params[:include].split(",").map do |association|
             association.split(".").reverse.inject({}) do |value, key|
-              { key.to_sym => value }
+              {key.to_sym => value}
             end
           end
           node_scope.includes(includes)

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

@@ -6,18 +6,18 @@ 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
           if !@pages.all?(&:cache_page?)
             render_pages_json(allowed) && return
-          elsif stale?(last_modified: @pages.maximum(:published_at), etag: @pages.max_by(&:cache_key)&.cache_key)
+          elsif stale?(last_modified: @pages.maximum(:published_at), etag: @pages.max_by(&:cache_key_with_version)&.cache_key_with_version)
             render_pages_json(allowed)
           end
         end
 
-        expires_in cache_duration, { public: @pages.none?(&:restricted?) }.merge(caching_options)
+        expires_in cache_duration, {public: @pages.none?(&:restricted?)}.merge(caching_options)
       end
 
       def show
@@ -25,12 +25,12 @@ module Alchemy
           render(jsonapi: api_page(load_page)) && return
         end
 
-        if stale?(last_modified: last_modified_for(@page), etag: @page.cache_key)
+        if stale?(last_modified: last_modified_for(@page), etag: @page.cache_key_with_version)
           # Only load page with all includes when browser cache is stale
           render jsonapi: api_page(load_page)
         end
 
-        expires_in cache_duration, { public: !@page.restricted? }.merge(caching_options)
+        expires_in cache_duration, {public: !@page.restricted?}.merge(caching_options)
       end
 
       private
@@ -51,13 +51,13 @@ module Alchemy
       end
 
       def caching_options
-        { must_revalidate: true }
+        {must_revalidate: true}
       end
 
       # Get page w/o includes to get cache key
       def load_page_for_cache_key
-        @page = page_scope.where(id: params[:path]).
-          or(page_scope.where(urlname: params[:path])).first!
+        @page = page_scope.where(id: params[:path])
+          .or(page_scope.where(urlname: params[:path])).first!
       end
 
       def last_modified_for(page)
@@ -69,7 +69,7 @@ module Alchemy
 
         {
           pagination: pagination.presence,
-          total: page_scope.count,
+          total: page_scope.count
         }.compact
       end
 
@@ -78,7 +78,8 @@ module Alchemy
       end
 
       def load_page_by_id
-        return unless params[:path] =~ /\A\d+\z/
+        return unless /\A\d+\z/.match?(params[:path])
+
         page_scope_with_includes.find_by(id: params[:path])
       end
 
@@ -91,19 +92,19 @@ module Alchemy
       end
 
       def page_scope_with_includes
-        page_scope.
-          includes(
+        page_scope
+          .includes(
             [
               :legacy_urls,
-              { language: { nodes: [:parent, :children, { page: { language: { site: :languages } } }] } },
+              {language: {nodes: [:parent, :children, {page: {language: {site: :languages}}}]}},
               {
                 page_version_type => {
                   elements: [
                     :nested_elements,
-                    { ingredients: :related_object },
-                  ],
-                },
-              },
+                    {ingredients: :related_object}
+                  ]
+                }
+              }
             ]
           )
       end
@@ -119,9 +120,17 @@ module Alchemy
       def base_page_scope
         # cancancan is not able to merge our complex AR scopes for logged in users
         if can?(:edit_content, ::Alchemy::Page)
-          Alchemy::Language.current.pages.joins(page_version_type)
+          current_language.pages.joins(page_version_type)
+        else
+          current_language.pages.published.joins(page_version_type)
+        end
+      end
+
+      def current_language
+        if Alchemy.const_defined?(:Current)
+          Alchemy::Current.language
         else
-          Alchemy::Language.current.pages.published.joins(page_version_type)
+          Alchemy::Language.current
         end
       end
 

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

@@ -2,7 +2,7 @@ module Alchemy
   # With Ransack 4 we need to define the attributes
   # that are allowed to be searched.
   def Page.ransackable_attributes(_auth_object = nil)
-    %w[urlname page_layout]
+    super | %w[page_layout]
   end
 
   module JsonApi

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     class ElementSerializer < BaseSerializer
@@ -7,7 +8,7 @@ module Alchemy
         :fixed,
         :position,
         :created_at,
-        :updated_at,
+        :updated_at
       )
 
       cache_options store: Rails.cache, namespace: "alchemy-jsonapi"

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

@@ -11,7 +11,7 @@ module Alchemy
         :autoplay,
         :controls,
         :muted,
-        :loop,
+        :loop
       )
 
       attribute :value do |ingredient|

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

@@ -12,7 +12,7 @@ module Alchemy
         :caption,
         :link_class_name,
         :link_title,
-        :link_target,
+        :link_target
       )
 
       attribute :value do |ingredient|
@@ -26,7 +26,7 @@ module Alchemy
         attribute :image_dimensions do |ingredient|
           sizes = ingredient.settings[:size]&.split("x", 2)&.map(&:to_i) || [
             ingredient.image_file_width,
-            ingredient.image_file_height,
+            ingredient.image_file_height
           ]
 
           ratio = ingredient.image_file_width.to_f / ingredient.image_file_height
@@ -35,7 +35,7 @@ module Alchemy
 
           {
             width: width,
-            height: height,
+            height: height
           }
         end
 
@@ -58,7 +58,7 @@ module Alchemy
               desc: "#{width}w",
               width: width,
               height: height,
-              type: type.to_s,
+              type: type.to_s
             }
           end
         end

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

@@ -9,7 +9,7 @@ module Alchemy
 
       attributes(
         :sanitized_body,
-        :stripped_body,
+        :stripped_body
       )
 
       attribute :body, &:value

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

@@ -11,7 +11,7 @@ module Alchemy
         :link,
         :link_class_name,
         :link_target,
-        :link_title,
+        :link_title
       )
 
       # maintain compatibility with EssenceText

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

@@ -13,7 +13,7 @@ module Alchemy
         :allow_fullscreen,
         :autoplay,
         :controls,
-        :preload,
+        :preload
       )
 
       attribute :value do |ingredient|

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     class LanguageSerializer < BaseSerializer
@@ -6,7 +7,7 @@ module Alchemy
         :name,
         :language_code,
         :country_code,
-        :locale,
+        :locale
       )
 
       has_many :menu_items, record_type: :node, serializer: ::Alchemy::JsonApi::NodeSerializer, object_method_name: :nodes, id_method_name: :node_ids

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     class NodeSerializer < BaseSerializer
@@ -13,7 +14,7 @@ module Alchemy
         :page,
         record_type: :page,
         if: ->(node) { node.page },
-        serializer: ::Alchemy::JsonApi::PageSerializer,
+        serializer: ::Alchemy::JsonApi::PageSerializer
       ) do |node|
         ::Alchemy::JsonApi::Page.new(node.page)
       end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     class PageSerializer < BaseSerializer
@@ -14,7 +15,7 @@ module Alchemy
         :meta_keywords,
         :meta_description,
         :created_at,
-        :updated_at,
+        :updated_at
       )
 
       cache_options store: Rails.cache, namespace: "alchemy-jsonapi"

data/config/routes.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
+
 Alchemy::JsonApi::Engine.routes.draw do
   resources :pages, only: [:index]
-  get "pages/*path" => "pages#show", as: :page
+  get "pages/*path" => "pages#show", :as => :page
   resources :layout_pages, only: [:index]
-  get "layout_pages/*path" => "layout_pages#show", as: :layout_page
+  get "layout_pages/*path" => "layout_pages#show", :as => :layout_page
   resources :nodes, only: [:index]
 
   namespace :admin do
-    get "pages/*path" => "pages#show", as: :page
+    get "pages/*path" => "pages#show", :as => :page
     resources :layout_pages, only: [:index]
-    get "layout_pages/*path" => "layout_pages#show", as: :layout_page
+    get "layout_pages/*path" => "layout_pages#show", :as => :layout_page
   end
 end

data/lib/alchemy/json_api/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "jsonapi"
 
 module Alchemy

data/lib/alchemy/json_api/essence_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     module EssenceSerializer

data/lib/alchemy/json_api/test_support/essence_serializer_behaviour.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.shared_examples "an essence serializer" do
   describe "attributes" do
     subject { serializer.serializable_hash[:data][:attributes] }
@@ -15,7 +16,7 @@ RSpec.shared_examples "an essence serializer" do
         expect(content).to receive(:definition).at_least(:once) do
           {
             name: "intro",
-            deprecated: true,
+            deprecated: true
           }
         end
       end
@@ -30,7 +31,7 @@ RSpec.shared_examples "an essence serializer" do
     subject { serializer.serializable_hash[:data][:relationships] }
 
     it "has the right keys and values" do
-      expect(subject[:element]).to eq(data: { id: essence.element.id.to_s, type: :element })
+      expect(subject[:element]).to eq(data: {id: essence.element.id.to_s, type: :element})
     end
   end
 end

data/lib/alchemy/json_api/test_support/ingredient_serializer_behaviour.rb

@@ -31,7 +31,7 @@ RSpec.shared_examples "an ingredient serializer" do
     subject { serializer.serializable_hash[:data][:relationships] }
 
     it "has one element" do
-      expect(subject[:element]).to eq(data: { id: ingredient.element_id.to_s, type: :element })
+      expect(subject[:element]).to eq(data: {id: ingredient.element_id.to_s, type: :element})
     end
   end
 end

data/lib/alchemy/json_api/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
-    VERSION = "2.0.0"
+    VERSION = "2.1.0"
   end
 end

data/lib/tasks/alchemy/json_api_tasks.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :alchemy_json_api do
 #   # Task goes here

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Martin Meyerhoff
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -35,16 +35,22 @@ dependencies:
   name: jsonapi.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A JSONAPI compliant API for AlchemyCMS