58ca82c720
## Description Adds API endpoint to list companies with pagination, search, and sorting. Fixes https://linear.app/chatwoot/issue/CW-5930/add-backend-routes-to-get-companies-result Parent issue: https://linear.app/chatwoot/issue/CW-5928/add-companies-tab-to-dashboard ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? Added comprehensive specs to `spec/enterprise/controllers/api/v1/accounts/companies_controller_spec.rb`: - Pagination (25 per page, multiple pages) - Search by name and domain (case-insensitive) - Counter cache for contacts_count - Account scoping - Authorization To reproduce: ```bash bundle exec rspec spec/enterprise/controllers/api/v1/accounts/companies_controller_spec.rb bundle exec rubocop enterprise/app/controllers/api/v1/accounts/companies_controller.rb ``` ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com> Co-authored-by: iamsivin <iamsivin@gmail.com> Co-authored-by: Shivam Mishra <scm.mymail@gmail.com> Co-authored-by: Sojan Jose <sojan@pepalo.com>
39 lines
1.4 KiB
Ruby
39 lines
1.4 KiB
Ruby
# == Schema Information
|
|
#
|
|
# Table name: companies
|
|
#
|
|
# id :bigint not null, primary key
|
|
# contacts_count :integer
|
|
# description :text
|
|
# domain :string
|
|
# name :string not null
|
|
# created_at :datetime not null
|
|
# updated_at :datetime not null
|
|
# account_id :bigint not null
|
|
#
|
|
# Indexes
|
|
#
|
|
# index_companies_on_account_and_domain (account_id,domain) UNIQUE WHERE (domain IS NOT NULL)
|
|
# index_companies_on_account_id (account_id)
|
|
# index_companies_on_name_and_account_id (name,account_id)
|
|
#
|
|
class Company < ApplicationRecord
|
|
include Avatarable
|
|
validates :account_id, presence: true
|
|
validates :name, presence: true, length: { maximum: Limits::COMPANY_NAME_LENGTH_LIMIT }
|
|
validates :domain, allow_blank: true, format: {
|
|
with: /\A[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?)+\z/,
|
|
message: I18n.t('errors.companies.domain.invalid')
|
|
}
|
|
validates :domain, uniqueness: { scope: :account_id }, if: -> { domain.present? }
|
|
validates :description, length: { maximum: Limits::COMPANY_DESCRIPTION_LENGTH_LIMIT }
|
|
|
|
belongs_to :account
|
|
has_many :contacts, dependent: :nullify
|
|
|
|
scope :ordered_by_name, -> { order(:name) }
|
|
scope :search_by_name_or_domain, lambda { |query|
|
|
where('name ILIKE :search OR domain ILIKE :search', search: "%#{query.strip}%")
|
|
}
|
|
end
|