Restructure omni services and add Chatwoot research snapshot

research/chatwoot/app/helpers/api/base_helper.rb

@@ -0,0 +1,2 @@
+module Api::BaseHelper
+end

research/chatwoot/app/helpers/api/v1/agents_helper.rb

@@ -0,0 +1,2 @@
+module Api::V1::AgentsHelper
+end

research/chatwoot/app/helpers/api/v1/canned_responses_helper.rb

@@ -0,0 +1,2 @@
+module Api::V1::CannedResponsesHelper
+end

research/chatwoot/app/helpers/api/v1/conversations_helper.rb

@@ -0,0 +1,2 @@
+module Api::V1::ConversationsHelper
+end

research/chatwoot/app/helpers/api/v1/inboxes_helper.rb

@@ -0,0 +1,119 @@
+module Api::V1::InboxesHelper
+  def inbox_name(channel)
+    return channel.try(:bot_name) if channel.is_a?(Channel::Telegram)
+
+    permitted_params[:name]
+  end
+
+  def validate_email_channel(attributes)
+    channel_data = permitted_params(attributes)[:channel]
+
+    validate_imap(channel_data)
+    validate_smtp(channel_data)
+  end
+
+  private
+
+  def validate_imap(channel_data)
+    return unless channel_data.key?('imap_enabled') && channel_data[:imap_enabled]
+
+    Mail.defaults do
+      retriever_method :imap, { address: channel_data[:imap_address],
+                                port: channel_data[:imap_port],
+                                user_name: channel_data[:imap_login],
+                                password: channel_data[:imap_password],
+                                enable_ssl: channel_data[:imap_enable_ssl] }
+    end
+
+    check_imap_connection(channel_data)
+  end
+
+  def validate_smtp(channel_data)
+    return unless channel_data.key?('smtp_enabled') && channel_data[:smtp_enabled]
+
+    smtp = Net::SMTP.new(channel_data[:smtp_address], channel_data[:smtp_port])
+
+    set_smtp_encryption(channel_data, smtp)
+    check_smtp_connection(channel_data, smtp)
+  end
+
+  def check_imap_connection(channel_data)
+    Mail.connection {} # rubocop:disable:block
+  rescue SocketError => e
+    raise StandardError, I18n.t('errors.inboxes.imap.socket_error')
+  rescue Net::IMAP::NoResponseError => e
+    raise StandardError, I18n.t('errors.inboxes.imap.no_response_error')
+  rescue Errno::EHOSTUNREACH => e
+    raise StandardError, I18n.t('errors.inboxes.imap.host_unreachable_error')
+  rescue Net::OpenTimeout => e
+    raise StandardError,
+          I18n.t('errors.inboxes.imap.connection_timed_out_error', address: channel_data[:imap_address], port: channel_data[:imap_port])
+  rescue Net::IMAP::Error => e
+    raise StandardError, I18n.t('errors.inboxes.imap.connection_closed_error')
+  rescue StandardError => e
+    raise StandardError, e.message
+  ensure
+    Rails.logger.error "[Api::V1::InboxesHelper] check_imap_connection failed with #{e.message}" if e.present?
+  end
+
+  def check_smtp_connection(channel_data, smtp)
+    smtp.start(channel_data[:smtp_domain], channel_data[:smtp_login], channel_data[:smtp_password],
+               channel_data[:smtp_authentication]&.to_sym || :login)
+    smtp.finish
+  end
+
+  def set_smtp_encryption(channel_data, smtp)
+    if channel_data[:smtp_enable_ssl_tls]
+      set_enable_tls(channel_data, smtp)
+    elsif channel_data[:smtp_enable_starttls_auto]
+      set_enable_starttls_auto(channel_data, smtp)
+    end
+  end
+
+  def set_enable_starttls_auto(channel_data, smtp)
+    return unless smtp.respond_to?(:enable_starttls_auto)
+
+    if channel_data[:smtp_openssl_verify_mode]
+      context = enable_openssl_mode(channel_data[:smtp_openssl_verify_mode])
+      smtp.enable_starttls_auto(context)
+    else
+      smtp.enable_starttls_auto
+    end
+  end
+
+  def set_enable_tls(channel_data, smtp)
+    return unless smtp.respond_to?(:enable_tls)
+
+    if channel_data[:smtp_openssl_verify_mode]
+      context = enable_openssl_mode(channel_data[:smtp_openssl_verify_mode])
+      smtp.enable_tls(context)
+    else
+      smtp.enable_tls
+    end
+  end
+
+  def enable_openssl_mode(smtp_openssl_verify_mode)
+    openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{smtp_openssl_verify_mode.upcase}".constantize if smtp_openssl_verify_mode.is_a?(String)
+    context = Net::SMTP.default_ssl_context
+    context.verify_mode = openssl_verify_mode
+    context
+  end
+
+  def account_channels_method
+    {
+      'web_widget' => Current.account.web_widgets,
+      'api' => Current.account.api_channels,
+      'email' => Current.account.email_channels,
+      'line' => Current.account.line_channels,
+      'telegram' => Current.account.telegram_channels,
+      'whatsapp' => Current.account.whatsapp_channels,
+      'sms' => Current.account.sms_channels
+    }[permitted_params[:channel][:type]]
+  end
+
+  def validate_limit
+    return unless Current.account.inboxes.count >= Current.account.usage_limits[:inboxes]
+
+    render_payment_required('Account limit exceeded. Upgrade to a higher plan')
+  end
+end

research/chatwoot/app/helpers/api/v1/widget/messages_helper.rb

@@ -0,0 +1,2 @@
+module Api::V1::Widget::MessagesHelper
+end

research/chatwoot/app/helpers/api/v2/accounts/heatmap_helper.rb

@@ -0,0 +1,104 @@
+module Api::V2::Accounts::HeatmapHelper
+  def generate_conversations_heatmap_report
+    timezone_data = generate_heatmap_data_for_timezone(params[:timezone_offset])
+
+    group_traffic_data(timezone_data)
+  end
+
+  private
+
+  def group_traffic_data(data)
+    # start with an empty array
+    result_arr = []
+
+    # pick all the unique dates from the data in ascending order
+    dates = data.pluck(:date).uniq.sort
+
+    # add the dates as the first row, leave an empty cell for the hour column
+    # e.g. ['Start of the hour', '2023-01-01', '2023-1-02', '2023-01-03']
+    result_arr << (['Start of the hour'] + dates)
+
+    # group the data by hour, we do not need to sort it, because the data is already sorted
+    # given it starts from the beginning of the day
+    # here each hour is a key, and the value is an array of all the items for that hour at each date
+    # e.g. hour = 1
+    # value = [{date: 2023-01-01, value: 1}, {date: 2023-01-02, value: 1}, {date: 2023-01-03, value: 1}, ...]
+    data.group_by { |d| d[:hour] }.each do |hour, items|
+      # create a new row for each hour
+      row = [format('%02d:00', hour)]
+
+      # group the items by date, so we can easily access the value for each date
+      # grouped values will be a hasg with the date as the key, and the value as the value
+      # e.g. { '2023-01-01' => [{date: 2023-01-01, value: 1}], '2023-01-02' => [{date: 2023-01-02, value: 1}], ... }
+      grouped_values = items.group_by { |d| d[:date] }
+
+      # now for each unique date we have, we can access the value for that date and append it to the array
+      dates.each do |date|
+        row << (grouped_values[date][0][:value] if grouped_values[date].is_a?(Array))
+      end
+
+      # row will look like ['22:00', 0, 0, 1, 4, 6, 7, 4]
+      # add the row to the result array
+
+      result_arr << row
+    end
+
+    # return the resultant array
+    # the result looks like this
+    # [
+    #   ['Start of the hour', '2023-01-01', '2023-1-02', '2023-01-03'],
+    #   ['00:00', 0, 0, 0],
+    #   ['01:00', 0, 0, 0],
+    #   ['02:00', 0, 0, 0],
+    #   ['03:00', 0, 0, 0],
+    #   ['04:00', 0, 0, 0],
+    # ]
+    result_arr
+  end
+
+  def generate_heatmap_data_for_timezone(offset)
+    timezone = ActiveSupport::TimeZone[offset]&.name
+    timezone_today = DateTime.now.in_time_zone(timezone).beginning_of_day
+
+    timezone_data_raw = generate_heatmap_data(timezone_today, offset)
+
+    transform_data(timezone_data_raw, false)
+  end
+
+  def generate_heatmap_data(date, offset)
+    report_params = {
+      type: :account,
+      group_by: 'hour',
+      metric: 'conversations_count',
+      business_hours: false
+    }
+
+    V2::ReportBuilder.new(Current.account, report_params.merge({
+                                                                 since: since_timestamp(date),
+                                                                 until: until_timestamp(date),
+                                                                 timezone_offset: offset
+                                                               })).build
+  end
+
+  def transform_data(data, zone_transform)
+    # rubocop:disable Rails/TimeZone
+    data.map do |d|
+      date = zone_transform ? Time.zone.at(d[:timestamp]) : Time.at(d[:timestamp])
+      {
+        date: date.to_date.to_s,
+        hour: date.hour,
+        value: d[:value]
+      }
+    end
+    # rubocop:enable Rails/TimeZone
+  end
+
+  def since_timestamp(date)
+    number_of_days = params[:days_before].present? ? params[:days_before].to_i.days : 6.days
+    (date - number_of_days).to_i.to_s
+  end
+
+  def until_timestamp(date)
+    date.to_i.to_s
+  end
+end

research/chatwoot/app/helpers/api/v2/accounts/reports_helper.rb

@@ -0,0 +1,93 @@
+module Api::V2::Accounts::ReportsHelper
+  def generate_agents_report
+    reports = V2::Reports::AgentSummaryBuilder.new(
+      account: Current.account,
+      params: build_params(type: :agent)
+    ).build
+
+    Current.account.users.map do |agent|
+      report = reports.find { |r| r[:id] == agent.id }
+      [agent.name] + generate_readable_report_metrics(report)
+    end
+  end
+
+  def generate_inboxes_report
+    reports = V2::Reports::InboxSummaryBuilder.new(
+      account: Current.account,
+      params: build_params(type: :inbox)
+    ).build
+
+    Current.account.inboxes.map do |inbox|
+      report = reports.find { |r| r[:id] == inbox.id }
+      [inbox.name, inbox.channel&.name] + generate_readable_report_metrics(report)
+    end
+  end
+
+  def generate_teams_report
+    reports = V2::Reports::TeamSummaryBuilder.new(
+      account: Current.account,
+      params: build_params(type: :team)
+    ).build
+
+    Current.account.teams.map do |team|
+      report = reports.find { |r| r[:id] == team.id }
+      [team.name] + generate_readable_report_metrics(report)
+    end
+  end
+
+  def generate_labels_report
+    reports = V2::Reports::LabelSummaryBuilder.new(
+      account: Current.account,
+      params: build_params({})
+    ).build
+
+    reports.map do |report|
+      [report[:name]] + generate_readable_report_metrics(report)
+    end
+  end
+
+  def generate_conversations_report
+    builder = V2::Reports::Conversations::MetricBuilder.new(Current.account, build_params(type: :account))
+    summary = builder.summary
+
+    [generate_conversation_report_metrics(summary)]
+  end
+
+  private
+
+  def build_params(base_params)
+    base_params.merge(
+      {
+        since: params[:since],
+        until: params[:until],
+        business_hours: ActiveModel::Type::Boolean.new.cast(params[:business_hours])
+      }
+    )
+  end
+
+  def report_builder(report_params)
+    V2::ReportBuilder.new(Current.account, build_params(report_params))
+  end
+
+  def generate_readable_report_metrics(report)
+    [
+      report[:conversations_count],
+      Reports::TimeFormatPresenter.new(report[:avg_first_response_time]).format,
+      Reports::TimeFormatPresenter.new(report[:avg_resolution_time]).format,
+      Reports::TimeFormatPresenter.new(report[:avg_reply_time]).format,
+      report[:resolved_conversations_count]
+    ]
+  end
+
+  def generate_conversation_report_metrics(summary)
+    [
+      summary[:conversations_count],
+      summary[:incoming_messages_count],
+      summary[:outgoing_messages_count],
+      Reports::TimeFormatPresenter.new(summary[:avg_first_response_time]).format,
+      Reports::TimeFormatPresenter.new(summary[:avg_resolution_time]).format,
+      summary[:resolutions_count],
+      Reports::TimeFormatPresenter.new(summary[:reply_time]).format
+    ]
+  end
+end