feat: Portal and Category public APIs (#4946)

app/controllers/api/v1/accounts/articles_controller.rb

@@ -11,6 +11,7 @@ class Api::V1::Accounts::ArticlesController < Api::V1::Accounts::BaseController
   def create
     @article = @portal.articles.create!(article_params)
     @article.associate_root_article(article_params[:associated_article_id])
+    @article.draft!
     render json: { error: @article.errors.messages }, status: :unprocessable_entity and return unless @article.valid?
   end
 
@@ -39,7 +40,7 @@ class Api::V1::Accounts::ArticlesController < Api::V1::Accounts::BaseController
 
   def article_params
     params.require(:article).permit(
-      :title, :content, :description, :position, :category_id, :author_id, :associated_article_id
+      :title, :content, :description, :position, :category_id, :author_id, :associated_article_id, :status
     )
   end
 

app/controllers/api/v1/accounts/portals_controller.rb

@@ -26,6 +26,11 @@ class Api::V1::Accounts::PortalsController < Api::V1::Accounts::BaseController
     head :ok
   end
 
+  def archive
+    @portal.update(archive: true)
+    head :ok
+  end
+
   private
 
   def fetch_portal

app/controllers/public/api/v1/portals/categories_controller.rb

@@ -0,0 +1,20 @@
+class Public::Api::V1::Portals::CategoriesController < PublicController
+  before_action :set_portal
+  before_action :set_category, only: [:show]
+
+  def index
+    @categories = @portal.categories
+  end
+
+  def show; end
+
+  private
+
+  def set_category
+    @category = @portal.categories.find_by!(slug: params[:slug])
+  end
+
+  def set_portal
+    @portal = ::Portal.find_by!(slug: params[:portal_slug], archived: false)
+  end
+end

app/controllers/public/api/v1/portals_controller.rb

@@ -0,0 +1,11 @@
+class Public::Api::V1::PortalsController < PublicController
+  before_action :set_portal
+
+  def show; end
+
+  private
+
+  def set_portal
+    @portal = ::Portal.find_by!(slug: params[:slug], archived: false)
+  end
+end

app/models/article.rb

@@ -53,7 +53,7 @@ class Article < ApplicationRecord
   validates :title, presence: true
   validates :content, presence: true
 
-  enum status: { draft: 0, published: 1 }
+  enum status: { draft: 0, published: 1, archived: 2 }
 
   scope :search_by_category_slug, ->(category_slug) { where(categories: { slug: category_slug }) if category_slug.present? }
   scope :search_by_category_locale, ->(locale) { where(categories: { locale: locale }) if locale.present? }
@@ -100,6 +100,10 @@ class Article < ApplicationRecord
     article.associated_article_id || article.id
   end
 
+  def draft!
+    update(status: :draft)
+  end
+
   private
 
   def ensure_account_id

app/models/portal.rb

@@ -39,4 +39,6 @@ class Portal < ApplicationRecord
   validates :slug, presence: true, uniqueness: true
 
   accepts_nested_attributes_for :members
+
+  scope :active, -> { where(archived: false) }
 end

app/views/public/api/v1/kbase/portal/show.json.jbuilder

@@ -1 +0,0 @@
-json.partial! 'portal', portal: @portal

app/views/public/api/v1/models/_associated_category.json.jbuilder

@@ -0,0 +1,5 @@
+json.name category.name
+json.slug category.slug
+json.locale category.locale
+json.description category.description
+json.position category.position

app/views/public/api/v1/models/_category.json.jbuilder

@@ -1,5 +1,25 @@
-json.id category.id
 json.name category.name
+json.slug category.slug
 json.locale category.locale
 json.description category.description
 json.position category.position
+
+json.related_categories do
+  if category.related_categories.any?
+    json.array! category.related_categories.each do |related_category|
+      json.partial! partial: 'associated_category', category: related_category
+    end
+  end
+end
+
+if category.parent_category.present?
+  json.parent_category do
+    json.partial! partial: 'associated_category', category: category.parent_category
+  end
+end
+
+if category.linked_category.present?
+  json.linked_category do
+    json.partial! partial: 'associated_category', category: category.linked_category
+  end
+end

app/views/public/api/v1/models/_portal.json.jbuilder

@@ -1,9 +1,14 @@
-json.id portal.id
-json.color portal.color
 json.custom_domain portal.custom_domain
 json.header_text portal.header_text
 json.homepage_link portal.homepage_link
 json.name portal.name
 json.page_title portal.page_title
 json.slug portal.slug
-json.config portal.config
+
+json.categories do
+  if portal.categories.any?
+    json.array! portal.categories.each do |category|
+      json.partial! 'categories/category.json.jbuilder', category: category
+    end
+  end
+end

app/views/public/api/v1/portals/categories/index.json.jbuilder

@@ -0,0 +1,3 @@
+json.payload do
+  json.array! @categories, partial: 'public/api/v1/models/category.json.jbuilder', as: :category
+end

app/views/public/api/v1/portals/categories/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! 'public/api/v1/models/category.json.jbuilder', category: @category

app/views/public/api/v1/portals/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @portals, partial: 'public/api/v1/models/portal.json.jbuilder', as: :portal

app/views/public/api/v1/portals/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! 'public/api/v1/models/portal.json.jbuilder', portal: @portal