require 'spec_helper' describe API::Todos, api: true do include ApiHelpers let(:project_1) { create(:empty_project, :test_repo) } let(:project_2) { create(:empty_project) } let(:author_1) { create(:user) } let(:author_2) { create(:user) } let(:john_doe) { create(:user, username: 'john_doe') } let(:merge_request) { create(:merge_request, source_project: project_1) } let!(:pending_1) { create(:todo, :mentioned, project: project_1, author: author_1, user: john_doe) } let!(:pending_2) { create(:todo, project: project_2, author: author_2, user: john_doe) } let!(:pending_3) { create(:on_commit_todo, project: project_1, author: author_2, user: john_doe) } let!(:done) { create(:todo, :done, project: project_1, author: author_1, user: john_doe) } before do project_1.team << [john_doe, :developer] project_2.team << [john_doe, :developer] end describe 'GET /todos' do context 'when unauthenticated' do it 'returns authentication error' do get api('/todos') expect(response.status).to eq(401) end end context 'when authenticated' do it 'returns an array of pending todos for current user' do get api('/todos', john_doe) expect(response.status).to eq(200) expect(response).to include_pagination_headers expect(json_response).to be_an Array expect(json_response.length).to eq(3) expect(json_response[0]['id']).to eq(pending_3.id) expect(json_response[0]['project']).to be_a Hash expect(json_response[0]['author']).to be_a Hash expect(json_response[0]['target_type']).to be_present expect(json_response[0]['target']).to be_a Hash expect(json_response[0]['target_url']).to be_present expect(json_response[0]['body']).to be_present expect(json_response[0]['state']).to eq('pending') expect(json_response[0]['action_name']).to eq('assigned') expect(json_response[0]['created_at']).to be_present end context 'and using the author filter' do it 'filters based on author_id param' do get api('/todos', john_doe), { author_id: author_2.id } expect(response.status).to eq(200) expect(response).to include_pagination_headers expect(json_response).to be_an Array expect(json_response.length).to eq(2) end end context 'and using the type filter' do it 'filters based on type param' do create(:todo, project: project_1, author: author_2, user: john_doe, target: merge_request) get api('/todos', john_doe), { type: 'MergeRequest' } expect(response.status).to eq(200) expect(response).to include_pagination_headers expect(json_response).to be_an Array expect(json_response.length).to eq(1) end end context 'and using the state filter' do it 'filters based on state param' do get api('/todos', john_doe), { state: 'done' } expect(response.status).to eq(200) expect(response).to include_pagination_headers expect(json_response).to be_an Array expect(json_response.length).to eq(1) end end context 'and using the project filter' do it 'filters based on project_id param' do get api('/todos', john_doe), { project_id: project_2.id } expect(response.status).to eq(200) expect(response).to include_pagination_headers expect(json_response).to be_an Array expect(json_response.length).to eq(1) end end context 'and using the action filter' do it 'filters based on action param' do get api('/todos', john_doe), { action: 'mentioned' } expect(response.status).to eq(200) expect(response).to include_pagination_headers expect(json_response).to be_an Array expect(json_response.length).to eq(1) end end end end describe 'POST /todos/:id/mark_as_done' do context 'when unauthenticated' do it 'returns authentication error' do post api("/todos/#{pending_1.id}/mark_as_done") expect(response).to have_http_status(401) end end context 'when authenticated' do it 'marks a todo as done' do post api("/todos/#{pending_1.id}/mark_as_done", john_doe) expect(response).to have_http_status(201) expect(json_response['id']).to eq(pending_1.id) expect(json_response['state']).to eq('done') expect(pending_1.reload).to be_done end it 'updates todos cache' do expect_any_instance_of(User).to receive(:update_todos_count_cache).and_call_original post api("/todos/#{pending_1.id}/mark_as_done", john_doe) end end end describe 'POST /mark_as_done' do context 'when unauthenticated' do it 'returns authentication error' do post api('/todos/mark_as_done') expect(response).to have_http_status(401) end end context 'when authenticated' do it 'marks all todos as done' do post api('/todos/mark_as_done', john_doe) expect(response).to have_http_status(204) expect(pending_1.reload).to be_done expect(pending_2.reload).to be_done expect(pending_3.reload).to be_done end it 'updates todos cache' do expect_any_instance_of(User).to receive(:update_todos_count_cache).and_call_original post api("/todos/mark_as_done", john_doe) end end end shared_examples 'an issuable' do |issuable_type| it 'creates a todo on an issuable' do post api("/projects/#{project_1.id}/#{issuable_type}/#{issuable.iid}/todo", john_doe) expect(response.status).to eq(201) expect(json_response['project']).to be_a Hash expect(json_response['author']).to be_a Hash expect(json_response['target_type']).to eq(issuable.class.name) expect(json_response['target']).to be_a Hash expect(json_response['target_url']).to be_present expect(json_response['body']).to be_present expect(json_response['state']).to eq('pending') expect(json_response['action_name']).to eq('marked') expect(json_response['created_at']).to be_present end it 'returns 304 there already exist a todo on that issuable' do create(:todo, project: project_1, author: author_1, user: john_doe, target: issuable) post api("/projects/#{project_1.id}/#{issuable_type}/#{issuable.iid}/todo", john_doe) expect(response.status).to eq(304) end it 'returns 404 if the issuable is not found' do post api("/projects/#{project_1.id}/#{issuable_type}/123/todo", john_doe) expect(response.status).to eq(404) end it 'returns an error if the issuable is not accessible' do guest = create(:user) project_1.team << [guest, :guest] post api("/projects/#{project_1.id}/#{issuable_type}/#{issuable.iid}/todo", guest) if issuable_type == 'merge_requests' expect(response).to have_http_status(403) else expect(response).to have_http_status(404) end end end describe 'POST :id/issuable_type/:issueable_id/todo' do context 'for an issue' do it_behaves_like 'an issuable', 'issues' do let(:issuable) { create(:issue, :confidential, author: author_1, project: project_1) } end end context 'for a merge request' do it_behaves_like 'an issuable', 'merge_requests' do let(:issuable) { merge_request } end end end end