0917e1a646
This API gives you how many conversations exist per channel, broken down
by status in a given time period. The max time period is capped to 6
months for now.
**Input Params:**
- **since:** Unix timestamp (seconds) - start of date range
- **until:** Unix timestamp (seconds) - end of date range
**Response Payload:**
```json
{
"Channel::Sms": {
"resolved": 85,
"snoozed": 10,
"open": 5,
"pending": 5,
"total": 100
},
"Channel::Email": {
"resolved": 72,
"snoozed": 15,
"open": 13,
"pending": 13,
"total": 100
},
"Channel::WebWidget": {
"resolved": 90,
"snoozed": 7,
"open": 3,
"pending": 3,
"total": 100
}
}
```
**Definitons:**
resolved = Number of conversations created within the selected time
period that are currently marked as resolved.
snoozed = Number of conversations created within the selected time
period that are currently marked as snoozed.
pending = Number of conversations created within the selected time
period that are currently marked as pending.
open = Number of conversations created within the selected time period
that are currently open.
total = Total number of conversations created within the selected time
period, across all statuses.
122 lines
4.3 KiB
Ruby
122 lines
4.3 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe 'API Base', type: :request do
|
|
let!(:account) { create(:account) }
|
|
let!(:user) { create(:user, account: account) }
|
|
|
|
describe 'request with api_access_token for user' do
|
|
context 'when accessing an account scoped resource' do
|
|
let!(:admin) { create(:user, :administrator, account: account) }
|
|
let!(:conversation) { create(:conversation, account: account) }
|
|
|
|
it 'sets Current attributes for the request and then returns the response' do
|
|
# This test verifies that Current.user, Current.account, and Current.account_user
|
|
# are properly set during request processing. We verify this indirectly:
|
|
# - A successful response proves Current.account_user was set (required for authorization)
|
|
# - The correct conversation data proves Current.account was set (scopes the query)
|
|
get "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}",
|
|
headers: { api_access_token: admin.access_token.token },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(response.parsed_body['id']).to eq(conversation.display_id)
|
|
end
|
|
end
|
|
|
|
context 'when it is an invalid api_access_token' do
|
|
it 'returns unauthorized' do
|
|
get '/api/v1/profile',
|
|
headers: { api_access_token: 'invalid' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is a valid api_access_token' do
|
|
it 'returns current user information' do
|
|
get '/api/v1/profile',
|
|
headers: { api_access_token: user.access_token.token },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
json_response = response.parsed_body
|
|
expect(json_response['id']).to eq(user.id)
|
|
expect(json_response['email']).to eq(user.email)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'request with api_access_token for a super admin' do
|
|
before do
|
|
user.update!(type: 'SuperAdmin')
|
|
end
|
|
|
|
context 'when its a valid api_access_token' do
|
|
it 'returns current user information' do
|
|
get '/api/v1/profile',
|
|
headers: { api_access_token: user.access_token.token },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
json_response = response.parsed_body
|
|
expect(json_response['id']).to eq(user.id)
|
|
expect(json_response['email']).to eq(user.email)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'request with api_access_token for bot' do
|
|
let!(:agent_bot) { create(:agent_bot) }
|
|
let!(:inbox) { create(:inbox, account: account) }
|
|
let!(:conversation) { create(:conversation, account: account, inbox: inbox, assignee: user, status: 'pending') }
|
|
|
|
context 'when it is an unauthorized url' do
|
|
it 'returns unauthorized' do
|
|
get '/api/v1/profile',
|
|
headers: { api_access_token: agent_bot.access_token.token },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is a accessible url' do
|
|
it 'returns success' do
|
|
create(:agent_bot_inbox, inbox: inbox, agent_bot: agent_bot)
|
|
|
|
post "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/toggle_status",
|
|
headers: { api_access_token: agent_bot.access_token.token },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(conversation.reload.status).to eq('open')
|
|
end
|
|
end
|
|
|
|
context 'when the account is suspended' do
|
|
it 'returns 401 unauthorized' do
|
|
account.update!(status: :suspended)
|
|
|
|
post "/api/v1/accounts/#{account.id}/canned_responses",
|
|
headers: { api_access_token: user.access_token.token },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
|
|
# this exception occured in a client instance (DoubleRender error)
|
|
it 'will not throw exception if user does not have access to suspended account' do
|
|
user_with_out_access = create(:user)
|
|
account.update!(status: :suspended)
|
|
|
|
post "/api/v1/accounts/#{account.id}/canned_responses",
|
|
headers: { api_access_token: user_with_out_access.access_token.token },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
end
|
|
end
|