From 58bfe8c43a952ea945c8fde63289967ec086f077 Mon Sep 17 00:00:00 2001
From: Daniel M Brasil <danielmbrasil@protonmail.com>
Date: Tue, 18 Jul 2023 04:15:50 -0300
Subject: [PATCH] Migrate to request specs in `/api/v1/bookmarks` (#25520)
---
.../api/v1/bookmarks_controller_spec.rb | 80 -------------------
spec/requests/api/v1/bookmarks_spec.rb | 61 ++++++++++++++
2 files changed, 61 insertions(+), 80 deletions(-)
delete mode 100644 spec/controllers/api/v1/bookmarks_controller_spec.rb
create mode 100644 spec/requests/api/v1/bookmarks_spec.rb
diff --git a/spec/controllers/api/v1/bookmarks_controller_spec.rb b/spec/controllers/api/v1/bookmarks_controller_spec.rb
deleted file mode 100644
index 69a37388e..000000000
--- a/spec/controllers/api/v1/bookmarks_controller_spec.rb
+++ /dev/null
@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Api::V1::BookmarksController do
- render_views
-
- let(:user) { Fabricate(:user) }
- let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: 'read:bookmarks') }
-
- describe 'GET #index' do
- context 'without token' do
- it 'returns http unauthorized' do
- get :index
- expect(response).to have_http_status 401
- end
- end
-
- context 'with token' do
- context 'without read scope' do
- before do
- allow(controller).to receive(:doorkeeper_token) do
- Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: '')
- end
- end
-
- it 'returns http forbidden' do
- get :index
- expect(response).to have_http_status 403
- end
- end
-
- context 'without valid resource owner' do
- before do
- token = Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: 'read')
- user.destroy!
-
- allow(controller).to receive(:doorkeeper_token) { token }
- end
-
- it 'returns http unprocessable entity' do
- get :index
- expect(response).to have_http_status 422
- end
- end
-
- context 'with read scope and valid resource owner' do
- before do
- allow(controller).to receive(:doorkeeper_token) do
- Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: 'read')
- end
- end
-
- it 'shows bookmarks owned by the user' do
- bookmarked_by_user = Fabricate(:bookmark, account: user.account)
- bookmarked_by_others = Fabricate(:bookmark)
-
- get :index
-
- expect(assigns(:statuses)).to contain_exactly(bookmarked_by_user.status)
- end
-
- it 'adds pagination headers if necessary' do
- bookmark = Fabricate(:bookmark, account: user.account)
-
- get :index, params: { limit: 1 }
-
- expect(response.headers['Link'].find_link(%w(rel next)).href).to eq "http://test.host/api/v1/bookmarks?limit=1&max_id=#{bookmark.id}"
- expect(response.headers['Link'].find_link(%w(rel prev)).href).to eq "http://test.host/api/v1/bookmarks?limit=1&min_id=#{bookmark.id}"
- end
-
- it 'does not add pagination headers if not necessary' do
- get :index
-
- expect(response.headers['Link']).to be_nil
- end
- end
- end
- end
-end
diff --git a/spec/requests/api/v1/bookmarks_spec.rb b/spec/requests/api/v1/bookmarks_spec.rb
new file mode 100644
index 000000000..1f1cd35ca
--- /dev/null
+++ b/spec/requests/api/v1/bookmarks_spec.rb
@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Bookmarks' do
+ let(:user) { Fabricate(:user) }
+ let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) }
+ let(:scopes) { 'read:bookmarks' }
+ let(:headers) { { 'Authorization' => "Bearer #{token.token}" } }
+
+ describe 'GET /api/v1/bookmarks' do
+ subject do
+ get '/api/v1/bookmarks', headers: headers, params: params
+ end
+
+ let(:params) { {} }
+ let!(:bookmarks) { Fabricate.times(3, :bookmark, account: user.account) }
+
+ let(:expected_response) do
+ bookmarks.map do |bookmark|
+ a_hash_including(id: bookmark.status.id.to_s, account: a_hash_including(id: bookmark.status.account.id.to_s))
+ end
+ end
+
+ it_behaves_like 'forbidden for wrong scope', 'write'
+
+ it 'returns http success' do
+ subject
+
+ expect(response).to have_http_status(200)
+ end
+
+ it 'returns the bookmarked statuses' do
+ subject
+
+ expect(body_as_json).to match_array(expected_response)
+ end
+
+ context 'with limit param' do
+ let(:params) { { limit: 2 } }
+
+ it 'paginates correctly', :aggregate_failures do
+ subject
+
+ expect(body_as_json.size).to eq(params[:limit])
+ expect(response.headers['Link'].find_link(%w(rel prev)).href).to eq(api_v1_bookmarks_url(limit: params[:limit], min_id: bookmarks.last.id))
+ expect(response.headers['Link'].find_link(%w(rel next)).href).to eq(api_v1_bookmarks_url(limit: params[:limit], max_id: bookmarks[1].id))
+ end
+ end
+
+ context 'without the authorization header' do
+ let(:headers) { {} }
+
+ it 'returns http unauthorized' do
+ subject
+
+ expect(response).to have_http_status(401)
+ end
+ end
+ end
+end