Files
chatwoot/spec/services/crm/leadsquared/api/activity_client_spec.rb

366 lines
12 KiB
Ruby

require 'rails_helper'
RSpec.describe Crm::Leadsquared::Api::ActivityClient do
let(:credentials) do
{
access_key: SecureRandom.hex,
secret_key: SecureRandom.hex,
endpoint_url: 'https://api.leadsquared.com/'
}
end
let(:headers) do
{
'Content-Type': 'application/json',
'x-LSQ-AccessKey': credentials[:access_key],
'x-LSQ-SecretKey': credentials[:secret_key]
}
end
let(:client) { described_class.new(credentials[:access_key], credentials[:secret_key], credentials[:endpoint_url]) }
let(:prospect_id) { SecureRandom.uuid }
let(:activity_event) { 1001 } # Example activity event code
let(:activity_note) { 'Test activity note' }
let(:activity_date_time) { '2025-04-11 14:15:00' }
describe '#post_activity' do
let(:path) { '/ProspectActivity.svc/Create' }
let(:full_url) { URI.join(credentials[:endpoint_url], path).to_s }
context 'with missing required parameters' do
it 'raises ArgumentError when prospect_id is missing' do
expect { client.post_activity(nil, activity_event, activity_note) }
.to raise_error(ArgumentError, 'Prospect ID is required')
end
it 'raises ArgumentError when activity_event is missing' do
expect { client.post_activity(prospect_id, nil, activity_note) }
.to raise_error(ArgumentError, 'Activity event code is required')
end
end
context 'when request is successful' do
let(:activity_id) { SecureRandom.uuid }
let(:success_response) do
{
'Status' => 'Success',
'Message' => {
'Id' => activity_id,
'Message' => 'Activity created successfully'
}
}
end
before do
stub_request(:post, full_url)
.with(
body: {
'RelatedProspectId' => prospect_id,
'ActivityEvent' => activity_event,
'ActivityNote' => activity_note
}.to_json,
headers: headers
)
.to_return(
status: 200,
body: success_response.to_json,
headers: { 'Content-Type' => 'application/json' }
)
end
it 'returns activity ID directly' do
response = client.post_activity(prospect_id, activity_event, activity_note)
expect(response).to eq(activity_id)
end
end
context 'when response indicates failure' do
let(:error_response) do
{
'Status' => 'Error',
'ExceptionType' => 'NullReferenceException',
'ExceptionMessage' => 'There was an error processing the request.'
}
end
before do
stub_request(:post, full_url)
.with(
body: {
'RelatedProspectId' => prospect_id,
'ActivityEvent' => activity_event,
'ActivityNote' => activity_note
}.to_json,
headers: headers
)
.to_return(
status: 200,
body: error_response.to_json,
headers: { 'Content-Type' => 'application/json' }
)
end
it 'raises ApiError when activity creation fails' do
expect { client.post_activity(prospect_id, activity_event, activity_note) }
.to raise_error(Crm::Leadsquared::Api::BaseClient::ApiError)
end
end
end
describe '#create_activity_type' do
let(:path) { 'ProspectActivity.svc/CreateType' }
let(:full_url) { URI.join(credentials[:endpoint_url], path).to_s }
let(:activity_params) do
{
name: 'Test Activity Type',
score: 10,
direction: 0
}
end
context 'with missing required parameters' do
it 'raises ArgumentError when name is missing' do
expect { client.create_activity_type(name: nil, score: 10) }
.to raise_error(ArgumentError, 'Activity name is required')
end
end
context 'when request is successful' do
let(:activity_event_id) { 1001 }
let(:success_response) do
{
'Status' => 'Success',
'Message' => {
'Id' => activity_event_id
}
}
end
before do
stub_request(:post, full_url)
.with(
body: {
'ActivityEventName' => activity_params[:name],
'Score' => activity_params[:score],
'Direction' => activity_params[:direction],
'AllowAttachments' => 1
}.to_json,
headers: headers
)
.to_return(
status: 200,
body: success_response.to_json,
headers: { 'Content-Type' => 'application/json' }
)
end
it 'returns activity ID directly' do
response = client.create_activity_type(**activity_params)
expect(response).to eq(activity_event_id)
end
end
context 'when response indicates failure' do
let(:error_response) do
{
'Status' => 'Error',
'ExceptionType' => 'MXInvalidInputException',
'ExceptionMessage' => 'Invalid Input! Parameter Name: activity'
}
end
before do
stub_request(:post, full_url)
.with(
body: {
'ActivityEventName' => activity_params[:name],
'Score' => activity_params[:score],
'Direction' => activity_params[:direction],
'AllowAttachments' => 1
}.to_json,
headers: headers
)
.to_return(
status: 200,
body: error_response.to_json,
headers: { 'Content-Type' => 'application/json' }
)
end
it 'raises ApiError when activity type creation fails' do
expect { client.create_activity_type(**activity_params) }
.to raise_error(Crm::Leadsquared::Api::BaseClient::ApiError)
end
end
context 'when API request fails' do
before do
stub_request(:post, full_url)
.with(
body: {
'ActivityEventName' => activity_params[:name],
'Score' => activity_params[:score],
'Direction' => activity_params[:direction],
'AllowAttachments' => 1
}.to_json,
headers: headers
)
.to_return(
status: 500,
body: 'Internal Server Error',
headers: { 'Content-Type' => 'text/plain' }
)
end
it 'raises ApiError when the request fails' do
expect { client.create_activity_type(**activity_params) }
.to raise_error(Crm::Leadsquared::Api::BaseClient::ApiError)
end
end
end
describe '#upload_file' do
let(:activity_event_code) { 1001 }
let(:file_name) { 'transcript.txt' }
let(:file_content) { 'Full conversation transcript content here' }
let(:files_url) { 'https://files.leadsquared.com/File/Upload' }
context 'with missing required parameters' do
it 'raises ArgumentError when activity_event_code is missing' do
expect { client.upload_file(nil, file_name, file_content) }
.to raise_error(ArgumentError, 'Activity event code is required')
end
it 'raises ArgumentError when file_name is missing' do
expect { client.upload_file(activity_event_code, nil, file_content) }
.to raise_error(ArgumentError, 'File name is required')
end
it 'raises ArgumentError when file_content is missing' do
expect { client.upload_file(activity_event_code, file_name, nil) }
.to raise_error(ArgumentError, 'File content is required')
end
end
context 'when request is successful' do
let(:s3_file_path) { 'https://landingpagecontentv2.s3.amazonaws.com/test/transcript.txt' }
let(:success_response) do
{
'Status' => 'Success',
'uploadedFile' => file_name,
'relativeFilePath' => 'https://f2.leadsquaredcdn.com/test/transcript.txt',
's3FilePath' => s3_file_path,
'description' => nil
}
end
before do
stub_request(:post, files_url)
.to_return(
status: 200,
body: success_response.to_json,
headers: { 'Content-Type' => 'application/json' }
)
end
it 'uploads the file and returns the response' do
response = client.upload_file(activity_event_code, file_name, file_content)
expect(response['s3FilePath']).to eq(s3_file_path)
expect(response['uploadedFile']).to eq(file_name)
end
end
context 'when API request fails' do
before do
stub_request(:post, files_url)
.to_return(
status: 500,
body: 'Internal Server Error',
headers: { 'Content-Type' => 'text/plain' }
)
end
it 'raises ApiError when the request fails' do
expect { client.upload_file(activity_event_code, file_name, file_content) }
.to raise_error(Crm::Leadsquared::Api::BaseClient::ApiError)
end
end
end
describe '#attach_file_to_activity' do
let(:path) { 'ProspectActivity.svc/Attachment/Add' }
let(:full_url) { URI.join(credentials[:endpoint_url], path).to_s }
let(:activity_id) { SecureRandom.uuid }
let(:file_url) { 'https://landingpagecontentv2.s3.amazonaws.com/test/transcript.txt' }
let(:file_name) { 'transcript.txt' }
let(:description) { 'Full conversation transcript' }
context 'with missing required parameters' do
it 'raises ArgumentError when activity_id is missing' do
expect { client.attach_file_to_activity(nil, file_url, file_name) }
.to raise_error(ArgumentError, 'Activity ID is required')
end
it 'raises ArgumentError when file_url is missing' do
expect { client.attach_file_to_activity(activity_id, nil, file_name) }
.to raise_error(ArgumentError, 'File URL is required')
end
it 'raises ArgumentError when file_name is missing' do
expect { client.attach_file_to_activity(activity_id, file_url, nil) }
.to raise_error(ArgumentError, 'File name is required')
end
end
context 'when request is successful' do
let(:attachment_id) { SecureRandom.uuid }
let(:success_response) do
{
'Status' => 'Success',
'Message' => {
'Id' => attachment_id
}
}
end
before do
stub_request(:post, full_url)
.with(
body: {
'ProspectActivityId' => activity_id,
'AttachmentName' => file_name,
'Description' => description,
'AttachmentFile' => file_url
}.to_json,
headers: headers
)
.to_return(
status: 200,
body: success_response.to_json,
headers: { 'Content-Type' => 'application/json' }
)
end
it 'attaches the file to the activity and returns attachment ID' do
response = client.attach_file_to_activity(activity_id, file_url, file_name, description)
expect(response).to eq(attachment_id)
end
end
context 'when API request fails' do
before do
stub_request(:post, full_url)
.to_return(
status: 500,
body: 'Internal Server Error',
headers: { 'Content-Type' => 'text/plain' }
)
end
it 'raises ApiError when the request fails' do
expect { client.attach_file_to_activity(activity_id, file_url, file_name, description) }
.to raise_error(Crm::Leadsquared::Api::BaseClient::ApiError)
end
end
end
end