alchemy-json_api 0.10.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 566f8ea63b33d368120cc948fa2c61b4b0039957249e85718f650e8e7ca8d322
-  data.tar.gz: 6816b1a2b645b9711a77bd8916814cd245b319e8144c6de278ec3f780c03f36f
+  metadata.gz: e8800ea751939b672e2361001cffe2d0da220a6ee61b25c6728c0e0a8db3ca9b
+  data.tar.gz: b9a7baa74ef2e0336aa91ad20f03ef26cb8f85c258caa1faf0b8a0c03d665a6f
 SHA512:
-  metadata.gz: 6041f03d5b9264d25312b7e4e1e50d9e5aae32154a47d8e8178bf7ab1dbd5362127e683d40ecba95f1fd05bb1d503afb6444286a97e99bcf5514fa4d48ade95c
-  data.tar.gz: 5355f10ab5dc5ae2ff7b2fb9412358467e4d351c23efbb37e8a9fbe6e300e6848d6e2b3a01c58fae8d1fbf8df00749835d55b65c43b2705dfcf2431281ef6a8a
+  metadata.gz: 3bbefcf52e8b02cad76158b312945bc1a818df8427b658898073bd7cdb8ef09a8d594bb33db0b0d5bcd2a4a9a7b4bd532d2d14a5c5c59f65cd8bbb880394232b
+  data.tar.gz: e4a795e0ac64b11930b10d1f582339326f79b9695863930aa69856e93c8ff41f76341710e13dad70074b85fc4a99453605d2725585525c1816fcda19f877c3af

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    module Admin
+      class LayoutPagesController < PagesController
+        private
+
+        def page_scope
+          page_scope_with_includes(page_version: :draft_version).layoutpages
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    module Admin
+      class PagesController < JsonApi::PagesController
+        prepend_before_action { authorize! :edit_content, Alchemy::Page }
+
+        def show
+          render jsonapi: Alchemy::JsonApi::Page.new(@page, page_version: :draft_version)
+        end
+
+        private
+
+        def page_scope
+          page_scope_with_includes(page_version: :draft_version).contentpages
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,11 @@ module Alchemy
       include JSONAPI::Filtering
       include JSONAPI::Pagination
 
+      rescue_from(
+        CanCan::AccessDenied,
+        with: :render_jsonapi_unauthorized,
+      )
+
       private
 
       def render_jsonapi_internal_server_error(exception)
@@ -25,6 +30,11 @@ module Alchemy
         message << "  " << exception.backtrace.join("\n  ")
         logger.fatal("#{message}\n\n")
       end
+
+      def render_jsonapi_unauthorized(exception)
+        error = { status: "401", title: Rack::Utils::HTTP_STATUS_CODES[401] }
+        render jsonapi_errors: [error], status: :unauthorized
+      end
     end
   end
 end

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

@@ -4,10 +4,6 @@ module Alchemy
     class LayoutPagesController < JsonApi::PagesController
       private
 
-      def base_page_scope
-        Page.all
-      end
-
       def page_scope
         page_scope_with_includes.layoutpages
       end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Alchemy
   module JsonApi
     class PagesController < JsonApi::BaseController
@@ -8,14 +9,16 @@ module Alchemy
         allowed = [:page_layout]
 
         jsonapi_filter(page_scope, allowed) do |filtered|
-          jsonapi_paginate(filtered.result) do |paginated|
+          # decorate with our page model that has a eager loaded elements collection
+          pages = filtered.result.map { |p| Alchemy::JsonApi::Page.new(p) }
+          jsonapi_paginate(pages) do |paginated|
             render jsonapi: paginated
           end
         end
       end
 
       def show
-        render jsonapi: @page
+        render jsonapi: Alchemy::JsonApi::Page.new(@page)
       end
 
       private
@@ -25,7 +28,7 @@ module Alchemy
 
         {
           pagination: pagination.presence,
-          total: page_scope.count
+          total: page_scope.count,
         }.compact
       end
 
@@ -34,6 +37,7 @@ module Alchemy
       end
 
       def load_page_by_id
+        return unless params[:path] =~ /\A\d+\z/
         page_scope.find_by(id: params[:path])
       end
 
@@ -45,18 +49,31 @@ module Alchemy
         page_scope_with_includes.contentpages
       end
 
-      def page_scope_with_includes
+      def page_scope_with_includes(page_version: :public_version)
         base_page_scope.
-          with_language(Language.current).
-          preload(language: {nodes: [:parent, :page]}, all_elements: [:parent_element, :nested_elements, { contents: { essence: :ingredient_association } }])
+          where(language: Language.current).
+          includes(
+            [
+              :legacy_urls,
+              { language: { nodes: [:parent, :children, { page: { language: { site: :languages } } }] } },
+              {
+                page_version => {
+                  elements: [
+                    :nested_elements,
+                    { contents: { essence: :ingredient_association } },
+                  ],
+                },
+              },
+            ]
+          )
       end
 
       def base_page_scope
         # cancancan is not able to merge our complex AR scopes for logged in users
-        if can?(:edit_content, Page)
-          Page.all
+        if can?(:edit_content, ::Alchemy::Page)
+          Alchemy::Page.all
         else
-          Page.published
+          Alchemy::Page.published
         end
       end
 

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

@@ -0,0 +1,46 @@
+module Alchemy
+  module JsonApi
+    class Page < SimpleDelegator
+      def initialize(page, page_version: :public_version)
+        @page_version = page.public_send(page_version)
+        super(page)
+      end
+
+      # All elements including nested and fixed elements
+      def all_elements
+        @_all_elements ||= element_repository
+      end
+
+      # Not nested unfixed top level elements
+      def elements
+        @_elements ||= element_repository.not_nested.unfixed
+      end
+
+      # Not nested fixed top level elements
+      def fixed_elements
+        @_fixed_elements ||= element_repository.not_nested.fixed
+      end
+
+      def all_element_ids
+        @_all_element_ids ||= all_elements.map(&:id)
+      end
+
+      def element_ids
+        @_element_ids ||= elements.map(&:id)
+      end
+
+      def fixed_element_ids
+        @_fixed_element_ids ||= fixed_elements.map(&:id)
+      end
+
+      private
+
+      def element_repository
+        return Alchemy::ElementsRepository.none unless @page_version
+
+        # Need to use select here, otherwise rails would not eager load the elements correctly
+        Alchemy::ElementsRepository.new(@page_version.elements.select(&:public))
+      end
+    end
+  end
+end

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

@@ -11,22 +11,16 @@ module Alchemy
         :created_at,
         :updated_at,
       )
-      belongs_to :parent_element, record_type: :element, serializer: self
 
-      belongs_to :page, record_type: :page, serializer: ::Alchemy::JsonApi::PageSerializer
-
-      has_many :essences, polymorphic: true do |element|
-        element.contents.reject { |c| !!c.try(:deprecated?) }.map!(&:essence)
+      attribute :deprecated do |element|
+        !!element.definition[:deprecated]
       end
 
-      has_many :nested_elements, record_type: :element, serializer: self do |element|
-        element.nested_elements.reject { |c| !!c.try(:deprecated?) }
+      has_many :essences, polymorphic: true do |element|
+        element.contents.map(&:essence)
       end
 
-      with_options if: ->(_, params) { params[:admin] == true } do
-        attribute :tag_list
-        attribute :display_name, &:display_name_with_preview_text
-      end
+      has_many :nested_elements, record_type: :element, serializer: self
     end
   end
 end

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

@@ -18,12 +18,6 @@ module Alchemy
       end
       has_many :pages
       has_one :root_page, record_type: :page, serializer: ::Alchemy::JsonApi::PageSerializer
-
-      with_options if: ->(_, params) { params[:admin] == true } do
-        attribute :created_at
-        attribute :updated_at
-        attribute :public
-      end
     end
   end
 end

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

@@ -4,6 +4,8 @@ module Alchemy
     class PageSerializer
       include JSONAPI::Serializer
 
+      ELEMENT_SERIALIZER = ::Alchemy::JsonApi::ElementSerializer
+
       attributes(
         :name,
         :urlname,
@@ -16,24 +18,23 @@ module Alchemy
         :updated_at,
       )
 
-      belongs_to :language, record_type: :language, serializer: ::Alchemy::JsonApi::LanguageSerializer
-
-      has_many :elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer do |page|
-        page.elements.reject { |e| !!e.try(:deprecated?) }
+      attribute :legacy_urls do |page|
+        page.legacy_urls.map(&:urlname)
       end
 
-      has_many :fixed_elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer do |page|
-        page.fixed_elements.reject { |c| !!c.try(:deprecated?) }
-      end
+      belongs_to :language, record_type: :language, serializer: ::Alchemy::JsonApi::LanguageSerializer
 
-      has_many :all_elements, record_type: :element, serializer: ::Alchemy::JsonApi::ElementSerializer do |page|
-        page.all_elements.select { |e| e.public? && !e.trashed? && !e.try(:deprecated?) }
-      end
+      # All public elements of this page regardless of if they are fixed or nested.
+      # Used for eager loading and should be used as the +include+ parameter of your query
+      has_many :all_elements, record_type: :element, serializer: ELEMENT_SERIALIZER
 
-      with_options if: ->(_, params) { params[:admin] == true } do
-        attribute :tag_list
-        attribute :status
-      end
+      # The top level public, non-fixed elements of this page that - if present -
+      # contains their nested_elements.
+      has_many :elements, record_type: :element, serializer: ELEMENT_SERIALIZER
+
+      # The top level public, fixed elements of this page that - if present -
+      # contains their nested_elements.
+      has_many :fixed_elements, record_type: :element, serializer: ELEMENT_SERIALIZER
     end
   end
 end

data/config/routes.rb

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

data/lib/alchemy/json_api/essence_serializer.rb

@@ -11,6 +11,9 @@ module Alchemy
         klass.attribute :role do |essence|
           essence.content.name
         end
+        klass.attribute :deprecated do |essence|
+          !!essence.content.definition[:deprecated]
+        end
       end
     end
   end

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

@@ -5,6 +5,24 @@ RSpec.shared_examples "an essence serializer" do
 
     it "has the right keys and values" do
       expect(subject).to have_key(:ingredient)
+      expect(subject[:deprecated]).to be(false)
+    end
+
+    context "a deprecated content" do
+      let(:content) { FactoryBot.create(:alchemy_content, name: "intro", element: element) }
+
+      before do
+        expect(content).to receive(:definition).at_least(:once) do
+          {
+            name: "intro",
+            deprecated: true,
+          }
+        end
+      end
+
+      it "has deprecated attribute set to true" do
+        expect(subject[:deprecated]).to eq(true)
+      end
     end
   end
 

data/lib/alchemy/json_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 6.0.a
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 6.0.a
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
@@ -100,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A JSONAPI compliant API for AlchemyCMS
 email:
 - mamhoff@gmail.com
@@ -110,9 +124,12 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/alchemy/json_api/admin/layout_pages_controller.rb
+- app/controllers/alchemy/json_api/admin/pages_controller.rb
 - app/controllers/alchemy/json_api/base_controller.rb
 - app/controllers/alchemy/json_api/layout_pages_controller.rb
 - app/controllers/alchemy/json_api/pages_controller.rb
+- app/models/alchemy/json_api/page.rb
 - app/serializers/alchemy/json_api/element_serializer.rb
 - app/serializers/alchemy/json_api/essence_boolean_serializer.rb
 - app/serializers/alchemy/json_api/essence_date_serializer.rb