alchemy-json_api 0.1.0

checksums.yaml

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Martin Meyerhoff
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# Alchemy::JsonApi
+
+A JSON-API based API for AlchemyCMS
+
+## Usage
+
+Mount the engine in your `config/routes.rb` file where you want, like this:
+
+```rb
+  mount Alchemy::JsonApi::Engine => "/jsonapi/"
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alchemy-json_api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install alchemy-json_api
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,28 @@
+#!/usr/bin/env rake
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+Bundler::GemHelper.install_tasks
+
+require "rspec/core"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:test_setup, :spec]
+
+require "active_support/core_ext/string"
+
+desc "Setup test app"
+task :test_setup do
+  Dir.chdir("spec/dummy") do
+    system <<-SETUP.strip_heredoc
+      export RAILS_ENV=test && \
+      bin/rake db:environment:set db:drop && \
+      bin/rake railties:install:migrations && \
+      bin/rake db:migrate
+    SETUP
+    exit($?.exitstatus) unless $?.success?
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    class BaseController < ::ApplicationController
+      include Alchemy::ControllerActions
+      include JSONAPI::Fetching
+      include JSONAPI::Errors
+      include JSONAPI::Filtering
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    class LayoutPagesController < JsonApi::PagesController
+      private
+
+      def page_scope
+        base_page_scope.layoutpages
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    class PagesController < JsonApi::BaseController
+      before_action :load_page, only: :show
+
+      def index
+        allowed = [:page_layout]
+
+        jsonapi_filter(page_scope, allowed) do |filtered|
+          render jsonapi: filtered.result
+        end
+      end
+
+      def show
+        render jsonapi: @page
+      end
+
+      private
+
+      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])
+      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])
+      end
+
+      def page_scope
+        base_page_scope.contentpages
+      end
+
+      def base_page_scope
+        ::Alchemy::Page.
+          with_language(Language.current).
+          published.
+          preload(language: {nodes: [:parent, :page]}, all_elements: [:parent_element, :nested_elements, { contents: { essence: :ingredient_association } }])
+      end
+
+      def jsonapi_serializer_class(_resource, _is_collection)
+        ::Alchemy::JsonApi::PageSerializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# 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
+
+    belongs_to :page
+    has_many :essences, polymorphic: true do |element|
+      element.contents.map(&:essence)
+    end
+
+    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
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +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
+
+    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

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

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

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

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

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

@@ -0,0 +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
+
+    attribute :ingredient do |essence|
+      essence&.node&.name
+    end
+
+    belongs_to :node
+
+    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

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

@@ -0,0 +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
+
+    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
+
+      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

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

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

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

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

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

@@ -0,0 +1,14 @@
+# 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
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    class LanguageSerializer
+      include FastJsonapi::ObjectSerializer
+      attributes(
+        :name,
+        :language_code,
+        :country_code,
+        :locale,
+      )
+
+      has_many :menu_items, record_type: :node, serializer: NodeSerializer, object_method_name: :nodes, id_method_name: :node_ids
+
+      has_many :menus, record_type: :node, serializer: NodeSerializer do |language|
+        language.nodes.select { |n| n.parent.nil? }
+      end
+      has_many :pages
+      has_one :root_page, record_type: :page, serializer: 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/node_serializer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    class NodeSerializer
+      include FastJsonapi::ObjectSerializer
+
+      attributes :name
+      attribute :link_url, &:url
+      attribute :link_title, &:title
+      attribute :link_nofollow, &:nofollow
+
+      belongs_to :parent, record_type: :node
+
+      has_many :children, record_type: :node, serializer: self
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    class PageSerializer
+      include FastJsonapi::ObjectSerializer
+      attributes(
+        :name,
+        :urlname,
+        :page_layout,
+        :title,
+        :language_code,
+        :meta_keywords,
+        :meta_description,
+        :created_at,
+        :updated_at,
+      )
+
+      belongs_to :language
+
+      has_many :elements
+
+      has_many :all_elements, record_type: :element, serializer: ElementSerializer do |page|
+        page.all_elements.select { |e| e.public? && !e.trashed? }
+      end
+
+      with_options if: ->(_, params) { params[:admin] == true } do
+        attribute :tag_list
+        attribute :status
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+Alchemy::JsonApi::Engine.routes.draw do
+  resources :pages, only: [:show, :index]
+  resources :layout_pages, only: [:show, :index]
+end

data/lib/alchemy/json_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "fast_jsonapi"
+require "alchemy_cms"
+require "alchemy/json_api/engine"
+
+module Alchemy
+  module JsonApi
+    # Your code goes here...
+  end
+end

data/lib/alchemy/json_api/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "jsonapi"
+
+module Alchemy
+  module JsonApi
+    class Engine < ::Rails::Engine
+      isolate_namespace Alchemy::JsonApi
+      config.generators.api_only = true
+
+      JSONAPI::Rails.install!
+    end
+  end
+end

data/lib/alchemy/json_api/essence_serializer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Alchemy
+  module JsonApi
+    module EssenceSerializer
+      def self.included(klass)
+        klass.include FastJsonapi::ObjectSerializer
+        klass.has_one :element, record_type: :element, serializer: ElementSerializer do |essence|
+          essence.content.element
+        end
+        klass.attributes :ingredient
+        klass.attribute :role do |essence|
+          essence.content.name
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/json_api/link_helper.rb

@@ -0,0 +1,16 @@
+# 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

data/lib/alchemy/json_api/version.rb

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

data/lib/tasks/alchemy/json_api_tasks.rake

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

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: alchemy-json_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Meyerhoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-15 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: jsonapi.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  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
+    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: rspec-rails
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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/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
+- app/serializers/alchemy/json_api/essence_file_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_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/language_serializer.rb
+- app/serializers/alchemy/json_api/node_serializer.rb
+- app/serializers/alchemy/json_api/page_serializer.rb
+- config/routes.rb
+- 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/version.rb
+- lib/tasks/alchemy/json_api_tasks.rake
+homepage: https://github.com/AlchemyCMS/alchemy-json_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A JSONAPI compliant API for AlchemyCMS
+test_files: []