Feature: API to get most used labels (#447)

* Add most-used labels API

* Filter conversation by labels

* Move match_all to any query

Co-authored-by: Pranav Raj S <pranavrajs@gmail.com>

app/controllers/api/v1/labels_controller.rb

@@ -2,4 +2,8 @@ class Api::V1::LabelsController < Api::BaseController
   def index # list all labels in account
     @labels = current_account.all_conversation_tags
   end
+
+  def most_used
+    @labels = ActsAsTaggableOn::Tag.most_used(params[:count] || 10)
+  end
 end

app/finders/conversation_finder.rb

@@ -31,6 +31,7 @@ class ConversationFinder
 
     find_all_conversations
     filter_by_status
+    filter_by_labels if params[:labels]
 
     mine_count, unassigned_count, all_count = set_count_for_all_conversations
 
@@ -62,7 +63,6 @@ class ConversationFinder
 
   def set_assignee_type
     @assignee_type_id = ASSIGNEE_TYPES[ASSIGNEE_TYPES_BY_ID[params[:assignee_type_id].to_i]]
-    # ente budhiparamaya neekam kandit enthu tonunu? ;)
   end
 
   def find_all_conversations
@@ -86,6 +86,10 @@ class ConversationFinder
     @conversations = @conversations.where(status: params[:status] || DEFAULT_STATUS)
   end
 
+  def filter_by_labels
+    @conversations = @conversations.tagged_with(params[:labels], any: true)
+  end
+
   def set_count_for_all_conversations
     [
       @conversations.assigned_to(current_user).count,

app/views/api/v1/labels/most_used.json.jbuilder

@@ -0,0 +1,3 @@
+json.payload do
+  json.labels @labels
+end

config/routes.rb

@@ -39,7 +39,11 @@ Rails.application.routes.draw do
       resources :accounts, only: [:create]
       resources :inboxes, only: [:index, :destroy]
       resources :agents, except: [:show, :edit, :new]
-      resources :labels, only: [:index]
+      resources :labels, only: [:index] do
+        collection do
+          get :most_used
+        end
+      end
       resources :canned_responses, except: [:show, :edit, :new]
       resources :inbox_members, only: [:create, :show], param: :inbox_id
       resources :facebook_indicators, only: [] do

spec/controllers/api/v1/labels_controller_spec.rb

@@ -31,4 +31,29 @@ RSpec.describe 'Label API', type: :request do
       end
     end
   end
+
+  describe 'GET /api/v1/labels/most_used' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        get '/api/v1/labels'
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      let(:agent) { create(:user, account: account, role: :agent) }
+
+      it 'returns most used labels' do
+        get '/api/v1/labels/most_used',
+            headers: agent.create_new_auth_token,
+            params: { count: 1 },
+            as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(response.body).to include('label1')
+        expect(response.body).not_to include('label2')
+      end
+    end
+  end
 end

spec/finders/conversation_finder_spec.rb

@@ -36,6 +36,18 @@ describe ::ConversationFinder do
       end
     end
 
+    context 'with labels' do
+      let(:params) { { labels: ['resolved'] } }
+
+      it 'filter conversations by labels' do
+        conversation = inbox.conversations.first
+        conversation.update_labels('resolved')
+
+        result = conversation_finder.perform
+        expect(result[:conversations].count).to be 1
+      end
+    end
+
     context 'with pagination' do
       let(:params) { { status: 'open', assignee_type_id: 0, page: 1 } }