Feature: Knowledge Base APIs (#1002)

- Introduce models & migrations for portals, categories, folders and articles
- CRUD API for portals
- CRUD API for categories

Addresses: #714

Co-authored-by: Sojan <sojan@pepalo.com>

app/controllers/api/v1/accounts/kbase/base_controller.rb

@@ -0,0 +1,9 @@
+class Api::V1::Accounts::Kbase::BaseController < Api::V1::Accounts::BaseController
+  before_action :portal
+
+  private
+
+  def portal
+    @portal ||= Current.account.kbase_portals.find_by(id: params[:portal_id])
+  end
+end

app/controllers/api/v1/accounts/kbase/categories_controller.rb

@@ -0,0 +1,32 @@
+class Api::V1::Accounts::Kbase::CategoriesController < Api::V1::Accounts::Kbase::BaseController
+  before_action :fetch_category, except: [:index, :create]
+
+  def index
+    @categories = @portal.categories
+  end
+
+  def create
+    @category = @portal.categories.create!(category_params)
+  end
+
+  def update
+    @category.update!(category_params)
+  end
+
+  def destroy
+    @category.destroy
+    head :ok
+  end
+
+  private
+
+  def fetch_category
+    @category = @portal.categories.find(params[:id])
+  end
+
+  def category_params
+    params.require(:category).permit(
+      :name, :description, :position
+    )
+  end
+end

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

@@ -0,0 +1,32 @@
+class Api::V1::Accounts::Kbase::PortalsController < Api::V1::Accounts::Kbase::BaseController
+  before_action :fetch_portal, except: [:index, :create]
+
+  def index
+    @portals = Current.account.kbase_portals
+  end
+
+  def create
+    @portal = Current.account.kbase_portals.create!(portal_params)
+  end
+
+  def update
+    @portal.update!(portal_params)
+  end
+
+  def destroy
+    @portal.destroy
+    head :ok
+  end
+
+  private
+
+  def fetch_portal
+    @portal = current_account.kbase_portals.find(params[:id])
+  end
+
+  def portal_params
+    params.require(:portal).permit(
+      :account_id, :color, :custom_domain, :header_text, :homepage_link, :name, :page_title, :slug
+    )
+  end
+end

app/models/account.rb

@@ -48,6 +48,9 @@ class Account < ApplicationRecord
   has_many :labels, dependent: :destroy
   has_many :notification_settings, dependent: :destroy
   has_many :hooks, dependent: :destroy, class_name: 'Integrations::Hook'
+  has_many :kbase_portals, dependent: :destroy, class_name: '::Kbase::Portal'
+  has_many :kbase_categories, dependent: :destroy, class_name: '::Kbase::Category'
+  has_many :kbase_articles, dependent: :destroy, class_name: '::Kbase::Article'
   has_flags ACCOUNT_SETTINGS_FLAGS.merge(column: 'settings_flags').merge(DEFAULT_QUERY_SETTING)
 
   enum locale: LANGUAGES_CONFIG.map { |key, val| [val[:iso_639_1_code], key] }.to_h

app/models/kbase.rb

@@ -0,0 +1,5 @@
+module Kbase
+  def self.table_name_prefix
+    'kbase_'
+  end
+end

app/models/kbase/article.rb

@@ -0,0 +1,40 @@
+# == Schema Information
+#
+# Table name: kbase_articles
+#
+#  id          :bigint           not null, primary key
+#  content     :text
+#  description :text
+#  status      :integer
+#  title       :string
+#  views       :integer
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#  account_id  :integer          not null
+#  author_id   :integer
+#  category_id :integer
+#  folder_id   :integer
+#  portal_id   :integer          not null
+#
+class Kbase::Article < ApplicationRecord
+  belongs_to :account
+  belongs_to :category
+  belongs_to :portal
+  belongs_to :folder
+  belongs_to :author, class_name: 'User'
+
+  before_validation :ensure_account_id
+  validates :account_id, presence: true
+  validates :category_id, presence: true
+  validates :author_id, presence: true
+  validates :title, presence: true
+  validates :content, presence: true
+
+  enum status: { draft: 0, published: 1 }
+
+  private
+
+  def ensure_account_id
+    self.account_id = portal&.account_id
+  end
+end

app/models/kbase/category.rb

@@ -0,0 +1,29 @@
+# == Schema Information
+#
+# Table name: kbase_categories
+#
+#  id          :bigint           not null, primary key
+#  description :text
+#  name        :string
+#  position    :integer
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#  account_id  :integer          not null
+#  portal_id   :integer          not null
+#
+class Kbase::Category < ApplicationRecord
+  belongs_to :account
+  belongs_to :portal
+  has_many :folders, dependent: :destroy
+  has_many :articles, dependent: :nullify
+
+  before_validation :ensure_account_id
+  validates :account_id, presence: true
+  validates :name, presence: true
+
+  private
+
+  def ensure_account_id
+    self.account_id = portal&.account_id
+  end
+end

app/models/kbase/folder.rb

@@ -0,0 +1,20 @@
+# == Schema Information
+#
+# Table name: kbase_folders
+#
+#  id          :bigint           not null, primary key
+#  name        :string
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#  account_id  :integer          not null
+#  category_id :integer          not null
+#
+class Kbase::Folder < ApplicationRecord
+  belongs_to :account
+  belongs_to :category
+  has_many :articles, dependent: :nullify
+
+  validates :account_id, presence: true
+  validates :category_id, presence: true
+  validates :name, presence: true
+end

app/models/kbase/portal.rb

@@ -0,0 +1,30 @@
+# == Schema Information
+#
+# Table name: kbase_portals
+#
+#  id            :bigint           not null, primary key
+#  account_id    :integer          not null
+#  color         :string
+#  custom_domain :string
+#  header_text   :text
+#  homepage_link :string
+#  name          :string           not null
+#  page_title    :string
+#  slug          :string           not null
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#
+# Indexes
+#
+#  index_kbase_portals_on_slug  (slug) UNIQUE
+#
+class Kbase::Portal < ApplicationRecord
+  belongs_to :account
+  has_many :categories, dependent: :destroy
+  has_many :folders,  through: :categories
+  has_many :articles, dependent: :destroy
+
+  validates :account_id, presence: true
+  validates :name, presence: true
+  validates :slug, presence: true
+end

app/views/api/v1/accounts/kbase/categories/_category.json.jbuilder

@@ -0,0 +1,5 @@
+json.id category.id
+json.name category.name
+json.description category.description
+json.position category.position
+json.account_id category.account_id

app/views/api/v1/accounts/kbase/categories/create.json.jbuilder

@@ -0,0 +1,3 @@
+json.payload do
+  json.partial! 'category', category: @category
+end

app/views/api/v1/accounts/kbase/categories/index.json.jbuilder

@@ -0,0 +1,3 @@
+json.payload do
+  json.array! @categories, partial: 'category', as: :category
+end

app/views/api/v1/accounts/kbase/categories/update.json.jbuilder

@@ -0,0 +1,3 @@
+json.payload do
+  json.partial! 'category', category: @category
+end

app/views/api/v1/accounts/kbase/portals/_portal.json.jbuilder

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

app/views/api/v1/accounts/kbase/portals/create.json.jbuilder

@@ -0,0 +1,3 @@
+json.payload do
+  json.partial! 'portal', portal: @portal
+end

app/views/api/v1/accounts/kbase/portals/index.json.jbuilder

@@ -0,0 +1,3 @@
+json.payload do
+  json.array! @portals, partial: 'portal', as: :portal
+end

app/views/api/v1/accounts/kbase/portals/update.json.jbuilder

@@ -0,0 +1,3 @@
+json.payload do
+  json.partial! 'portal', portal: @portal
+end