alchemy-json_api 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25ba34a50a58c59ff4aabb21089faee49c5ada8fbbf753a1515799845bea8213
-  data.tar.gz: 247cf1d183feda62cec526e9a7ceec96716ff1ed97589a473ba86193cfd54065
+  metadata.gz: bb04c3210449c9689cc5d5f0a187492b6de5e53ad88928e878f564dfd10f6615
+  data.tar.gz: e856316ed3433935246e4fd1e33f37f5c9830bb6737fb37b02d55c441e66b91e
 SHA512:
-  metadata.gz: 1facc4daccad62f6b80c8c7494c644621713ed048e8dcc8cfb55abdeb2b3fb115f519c835febd7ebb509b6dab3d9a0e43ea2837ed6aa71d863d7b6942de001ec
-  data.tar.gz: 57c7d49f5214edbc140303a7be3a4286b6649eff07905f3eba4fa74531e27444ab24b8976a983855d1a70adaf961a639c246f12a0737e269872213f454e402cc
+  metadata.gz: dbb2638d53afbb1ccb330d65b0b7f2baec33b619c55992accdb58c457d10192a28459ad7520543cfc2fdbc921ca4dea09f992bf8fd532dd85f0fbedcc52504d7
+  data.tar.gz: a872add90f9bda24d3f0d3647ab01c0f2a5fd2707c3d83e596d21db66b9faf38bbfe587fe3179228fe9233ff921b22fe9e9c5c7954a2217c08354d5269e48668

data/Rakefile

@@ -26,3 +26,11 @@ task :test_setup do
     exit($?.exitstatus) unless $?.success?
   end
 end
+
+require "github_changelog_generator/task"
+require "alchemy/json_api/version"
+GitHubChangelogGenerator::RakeTask.new(:changelog) do |config|
+  config.user = "AlchemyCMS"
+  config.project = "alchemy-json_api"
+  config.future_release = "v#{Alchemy::JsonApi::VERSION}"
+end

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

@@ -6,6 +6,7 @@ module Alchemy
       include JSONAPI::Fetching
       include JSONAPI::Errors
       include JSONAPI::Filtering
+      include JSONAPI::Pagination
     end
   end
 end

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

@@ -8,7 +8,9 @@ module Alchemy
         allowed = [:page_layout]
 
         jsonapi_filter(page_scope, allowed) do |filtered|
-          render jsonapi: filtered.result
+          jsonapi_paginate(filtered.result) do |paginated|
+            render jsonapi: paginated
+          end
         end
       end
 
@@ -18,17 +20,25 @@ module Alchemy
 
       private
 
+      def jsonapi_meta(pages)
+        pagination = jsonapi_pagination_meta(pages)
+
+        {
+          pagination: pagination.presence,
+          total: page_scope.count
+        }.compact
+      end
+
       def load_page
         @page = load_page_by_id || load_page_by_urlname || raise(ActiveRecord::RecordNotFound)
       end
 
       def load_page_by_id
-        page_scope.find_by(id: params[:id])
+        page_scope.find_by(id: params[:path])
       end
 
       def load_page_by_urlname
-        # The route param is called :id although it might be a string
-        page_scope.find_by(urlname: params[:id])
+        page_scope.find_by(urlname: params[:path])
       end
 
       def page_scope

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

@@ -1,25 +1,28 @@
 # frozen_string_literal: true
-module Alchemy::JsonApi
-  class ElementSerializer
-    include FastJsonapi::ObjectSerializer
-    attributes(
-      :position,
-      :created_at,
-      :updated_at,
-    )
-    attribute :element_type, &:name
-    belongs_to :parent_element, record_type: :element
+module Alchemy
+  module JsonApi
+    class ElementSerializer
+      include FastJsonapi::ObjectSerializer
+      attributes(
+        :name,
+        :fixed,
+        :position,
+        :created_at,
+        :updated_at,
+      )
+      belongs_to :parent_element, record_type: :element, serializer: self
 
-    belongs_to :page
-    has_many :essences, polymorphic: true do |element|
-      element.contents.map(&:essence)
-    end
+      belongs_to :page
+      has_many :essences, polymorphic: true do |element|
+        element.contents.map(&:essence)
+      end
 
-    has_many :nested_elements, record_type: :element, serializer: self
+      has_many :nested_elements, record_type: :element, serializer: self
 
-    with_options if: ->(_, params) { params[:admin] == true } do
-      attribute :tag_list
-      attribute :display_name, &:display_name_with_preview_text
+      with_options if: ->(_, params) { params[:admin] == true } do
+        attribute :tag_list
+        attribute :display_name, &:display_name_with_preview_text
+      end
     end
   end
 end

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

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

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

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

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

@@ -1,30 +1,31 @@
 # frozen_string_literal: true
 require "alchemy/json_api/essence_serializer"
-require "alchemy/json_api/link_helper"
 
-module Alchemy::JsonApi
-  class EssenceFileSerializer
-    include EssenceSerializer
+module Alchemy
+  module JsonApi
+    class EssenceFileSerializer
+      include EssenceSerializer
 
-    attribute :link_title, &:title
+      attribute :link_title, &:title
 
-    attribute :ingredient, &:attachment_url
+      attribute :ingredient, &:attachment_url
 
-    with_options if: proc { |essence| essence.attachment.present? } do
-      attribute :attachment_name do |essence|
-        essence.attachment.name
-      end
+      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_file_name do |essence|
+          essence.attachment.file_name
+        end
 
-      attribute :attachment_mime_type do |essence|
-        essence.attachment.file_mime_type
-      end
+        attribute :attachment_mime_type do |essence|
+          essence.attachment.file_mime_type
+        end
 
-      attribute :attachment_file_size do |essence|
-        essence.attachment.file_size
+        attribute :attachment_file_size do |essence|
+          essence.attachment.file_size
+        end
       end
     end
   end

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

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

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

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

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

@@ -1,32 +1,33 @@
 # frozen_string_literal: true
 require "alchemy/json_api/essence_serializer"
-require "alchemy/json_api/link_helper"
 
-module Alchemy::JsonApi
-  class EssenceNodeSerializer
-    include EssenceSerializer
+module Alchemy
+  module JsonApi
+    class EssenceNodeSerializer
+      include EssenceSerializer
 
-    attribute :ingredient do |essence|
-      essence&.node&.name
-    end
+      attribute :ingredient do |essence|
+        essence&.node&.name
+      end
 
-    belongs_to :node
+      belongs_to :node
 
-    with_options if: proc { |essence| essence.node.present? } do
-      attribute :name do |essence|
-        essence.node.name
-      end
+      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_url do |essence|
+          essence.node.url
+        end
 
-      attribute :link_title do |essence|
-        essence.node.title
-      end
+        attribute :link_title do |essence|
+          essence.node.title
+        end
 
-      attribute :link_nofollow do |essence|
-        essence.node.nofollow
+        attribute :link_nofollow do |essence|
+          essence.node.nofollow
+        end
       end
     end
   end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require "alchemy/json_api/essence_serializer"
+
+module Alchemy
+  module JsonApi
+    class EssencePageSerializer
+      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: PageSerializer
+    end
+  end
+end

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

@@ -1,40 +1,41 @@
 # frozen_string_literal: true
 require "alchemy/json_api/essence_serializer"
-require "alchemy/json_api/link_helper"
 
-module Alchemy::JsonApi
-  class EssencePictureSerializer
-    include EssenceSerializer
+module Alchemy
+  module JsonApi
+    class EssencePictureSerializer
+      include EssenceSerializer
 
-    attributes(
-      :title,
-      :caption,
-      :link_title,
-      :link_target,
-    )
-    attribute :ingredient, &:picture_url
-    attribute :alt_text, &:alt_tag
-    attribute :link_url, &:link
+      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|
-        essence.sizes_from_string(essence.render_size)
-      end
+      with_options if: proc { |essence| essence.picture.present? } do
+        attribute :image_dimensions do |essence|
+          essence.sizes_from_string(essence.render_size)
+        end
 
-      attribute :image_name do |essence|
-        essence.picture.name
-      end
+        attribute :image_name do |essence|
+          essence.picture.name
+        end
 
-      attribute :image_file_name do |essence|
-        essence.picture.image_file_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_mime_type do |essence|
+          "image/#{essence.picture.image_file_format}"
+        end
 
-      attribute :image_file_size do |essence|
-        essence.picture.image_file_size
+        attribute :image_file_size do |essence|
+          essence.picture.image_file_size
+        end
       end
     end
   end

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

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

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

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

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

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

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

@@ -9,7 +9,7 @@ module Alchemy
       attribute :link_title, &:title
       attribute :link_nofollow, &:nofollow
 
-      belongs_to :parent, record_type: :node
+      belongs_to :parent, record_type: :node, serializer: self
 
       has_many :children, record_type: :node, serializer: self
     end

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

@@ -18,6 +18,7 @@ module Alchemy
       belongs_to :language
 
       has_many :elements
+      has_many :fixed_elements, record_type: :element, serializer: ElementSerializer
 
       has_many :all_elements, record_type: :element, serializer: ElementSerializer do |page|
         page.all_elements.select { |e| e.public? && !e.trashed? }

data/config/routes.rb

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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+RSpec.shared_examples "an essence serializer" do
+  describe "attributes" do
+    subject { serializer.serializable_hash[:data][:attributes] }
+
+    it "has the right keys and values" do
+      expect(subject).to have_key(:ingredient)
+    end
+  end
+
+  describe "relationships" 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 })
+    end
+  end
+end

data/lib/alchemy/json_api/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Martin Meyerhoff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: fast_jsonapi
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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'
 - !ruby/object:Gem::Dependency
   name: jsonapi-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,7 @@ files:
 - 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
@@ -125,14 +140,14 @@ files:
 - lib/alchemy/json_api.rb
 - lib/alchemy/json_api/engine.rb
 - lib/alchemy/json_api/essence_serializer.rb
-- lib/alchemy/json_api/link_helper.rb
+- lib/alchemy/json_api/test_support/essence_serializer_behaviour.rb
 - lib/alchemy/json_api/version.rb
 - lib/tasks/alchemy/json_api_tasks.rake
 homepage: https://github.com/AlchemyCMS/alchemy-json_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A JSONAPI compliant API for AlchemyCMS
 test_files: []

data/lib/alchemy/json_api/link_helper.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-module Alchemy
-  module JsonApi
-    module LinkHelper
-      def alchemy_link(path_base, object)
-        return unless object
-
-        if Rails.application.routes.default_url_options[:host]
-          Alchemy::Engine.routes.url_helpers.public_send("#{path_base}_url", object)
-        else
-          Alchemy::Engine.routes.url_helpers.public_send("#{path_base}_path", object)
-        end
-      end
-    end
-  end
-end