From 812a84ff5fbaefebb84081be9a837ee7b9624bb3 Mon Sep 17 00:00:00 2001
From: Daniel M Brasil <danielmbrasil@protonmail.com>
Date: Thu, 27 Jul 2023 09:58:20 -0300
Subject: [PATCH] Migrate to request specs in `/api/v2/filters` (#25721)
---
.rubocop_todo.yml | 1 -
.../api/v2/filters_controller_spec.rb | 123 ---------
spec/requests/api/v2/filters/filters_spec.rb | 248 ++++++++++++++++++
3 files changed, 248 insertions(+), 124 deletions(-)
delete mode 100644 spec/controllers/api/v2/filters_controller_spec.rb
create mode 100644 spec/requests/api/v2/filters/filters_spec.rb
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
index 42e7e4e89..472bb0622 100644
--- a/.rubocop_todo.yml
+++ b/.rubocop_todo.yml
@@ -272,7 +272,6 @@ RSpec/LetSetup:
- 'spec/controllers/api/v2/admin/accounts_controller_spec.rb'
- 'spec/controllers/api/v2/filters/keywords_controller_spec.rb'
- 'spec/controllers/api/v2/filters/statuses_controller_spec.rb'
- - 'spec/controllers/api/v2/filters_controller_spec.rb'
- 'spec/controllers/auth/confirmations_controller_spec.rb'
- 'spec/controllers/auth/passwords_controller_spec.rb'
- 'spec/controllers/auth/sessions_controller_spec.rb'
diff --git a/spec/controllers/api/v2/filters_controller_spec.rb b/spec/controllers/api/v2/filters_controller_spec.rb
deleted file mode 100644
index 722037eeb..000000000
--- a/spec/controllers/api/v2/filters_controller_spec.rb
+++ /dev/null
@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Api::V2::FiltersController do
- render_views
-
- let(:user) { Fabricate(:user) }
- let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) }
-
- before do
- allow(controller).to receive(:doorkeeper_token) { token }
- end
-
- describe 'GET #index' do
- let(:scopes) { 'read:filters' }
- let!(:filter) { Fabricate(:custom_filter, account: user.account) }
-
- it 'returns http success' do
- get :index
- expect(response).to have_http_status(200)
- end
- end
-
- describe 'POST #create' do
- let(:scopes) { 'write:filters' }
-
- before do
- post :create, params: { title: 'magic', context: %w(home), filter_action: 'hide', keywords_attributes: [keyword: 'magic'] }
- end
-
- it 'returns http success' do
- expect(response).to have_http_status(200)
- end
-
- it 'returns a filter with keywords' do
- json = body_as_json
- expect(json[:title]).to eq 'magic'
- expect(json[:filter_action]).to eq 'hide'
- expect(json[:context]).to eq ['home']
- expect(json[:keywords].map { |keyword| keyword.slice(:keyword, :whole_word) }).to eq [{ keyword: 'magic', whole_word: true }]
- end
-
- it 'creates a filter' do
- filter = user.account.custom_filters.first
- expect(filter).to_not be_nil
- expect(filter.keywords.pluck(:keyword)).to eq ['magic']
- expect(filter.context).to eq %w(home)
- expect(filter.irreversible?).to be true
- expect(filter.expires_at).to be_nil
- end
- end
-
- describe 'GET #show' do
- let(:scopes) { 'read:filters' }
- let(:filter) { Fabricate(:custom_filter, account: user.account) }
-
- it 'returns http success' do
- get :show, params: { id: filter.id }
- expect(response).to have_http_status(200)
- end
- end
-
- describe 'PUT #update' do
- let(:scopes) { 'write:filters' }
- let!(:filter) { Fabricate(:custom_filter, account: user.account) }
- let!(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: filter) }
-
- context 'when updating filter parameters' do
- before do
- put :update, params: { id: filter.id, title: 'updated', context: %w(home public) }
- end
-
- it 'returns http success' do
- expect(response).to have_http_status(200)
- end
-
- it 'updates the filter title' do
- expect(filter.reload.title).to eq 'updated'
- end
-
- it 'updates the filter context' do
- expect(filter.reload.context).to eq %w(home public)
- end
- end
-
- context 'when updating keywords in bulk' do
- before do
- allow(redis).to receive_messages(publish: nil)
- put :update, params: { id: filter.id, keywords_attributes: [{ id: keyword.id, keyword: 'updated' }] }
- end
-
- it 'returns http success' do
- expect(response).to have_http_status(200)
- end
-
- it 'updates the keyword' do
- expect(keyword.reload.keyword).to eq 'updated'
- end
-
- it 'sends exactly one filters_changed event' do
- expect(redis).to have_received(:publish).with("timeline:#{user.account.id}", Oj.dump(event: :filters_changed)).once
- end
- end
- end
-
- describe 'DELETE #destroy' do
- let(:scopes) { 'write:filters' }
- let(:filter) { Fabricate(:custom_filter, account: user.account) }
-
- before do
- delete :destroy, params: { id: filter.id }
- end
-
- it 'returns http success' do
- expect(response).to have_http_status(200)
- end
-
- it 'removes the filter' do
- expect { filter.reload }.to raise_error ActiveRecord::RecordNotFound
- end
- end
-end
diff --git a/spec/requests/api/v2/filters/filters_spec.rb b/spec/requests/api/v2/filters/filters_spec.rb
new file mode 100644
index 000000000..2ee24d809
--- /dev/null
+++ b/spec/requests/api/v2/filters/filters_spec.rb
@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Filters' do
+ let(:user) { Fabricate(:user) }
+ let(:scopes) { 'read:filters write:filters' }
+ let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) }
+ let(:headers) { { 'Authorization' => "Bearer #{token.token}" } }
+
+ shared_examples 'unauthorized for invalid token' do
+ let(:headers) { { 'Authorization' => '' } }
+
+ it 'returns http unauthorized' do
+ subject
+
+ expect(response).to have_http_status(401)
+ end
+ end
+
+ describe 'GET /api/v2/filters' do
+ subject do
+ get '/api/v2/filters', headers: headers
+ end
+
+ let!(:filters) { Fabricate.times(3, :custom_filter, account: user.account) }
+
+ it_behaves_like 'forbidden for wrong scope', 'write write:filters'
+ it_behaves_like 'unauthorized for invalid token'
+
+ it 'returns the existing filters successfully', :aggregate_failures do
+ subject
+
+ expect(response).to have_http_status(200)
+ expect(body_as_json.pluck(:id)).to match_array(filters.map { |filter| filter.id.to_s })
+ end
+ end
+
+ describe 'POST /api/v2/filters' do
+ subject do
+ post '/api/v2/filters', params: params, headers: headers
+ end
+
+ let(:params) { {} }
+
+ it_behaves_like 'forbidden for wrong scope', 'read read:filters'
+ it_behaves_like 'unauthorized for invalid token'
+
+ context 'with valid params' do
+ let(:params) { { title: 'magic', context: %w(home), filter_action: 'hide', keywords_attributes: [keyword: 'magic'] } }
+
+ it 'returns http success' do
+ subject
+
+ expect(response).to have_http_status(200)
+ end
+
+ it 'returns a filter with keywords', :aggregate_failures do
+ subject
+
+ json = body_as_json
+
+ expect(json[:title]).to eq 'magic'
+ expect(json[:filter_action]).to eq 'hide'
+ expect(json[:context]).to eq ['home']
+ expect(json[:keywords].map { |keyword| keyword.slice(:keyword, :whole_word) }).to eq [{ keyword: 'magic', whole_word: true }]
+ end
+
+ it 'creates a filter', :aggregate_failures do
+ subject
+
+ filter = user.account.custom_filters.first
+
+ expect(filter).to be_present
+ expect(filter.keywords.pluck(:keyword)).to eq ['magic']
+ expect(filter.context).to eq %w(home)
+ expect(filter.irreversible?).to be true
+ expect(filter.expires_at).to be_nil
+ end
+ end
+
+ context 'when the required title param is missing' do
+ let(:params) { { context: %w(home), filter_action: 'hide', keywords_attributes: [keyword: 'magic'] } }
+
+ it 'returns http unprocessable entity' do
+ subject
+
+ expect(response).to have_http_status(422)
+ end
+ end
+
+ context 'when the required context param is missing' do
+ let(:params) { { title: 'magic', filter_action: 'hide', keywords_attributes: [keyword: 'magic'] } }
+
+ it 'returns http unprocessable entity' do
+ subject
+
+ expect(response).to have_http_status(422)
+ end
+ end
+
+ context 'when the given context value is invalid' do
+ let(:params) { { title: 'magic', context: %w(shaolin), filter_action: 'hide', keywords_attributes: [keyword: 'magic'] } }
+
+ it 'returns http unprocessable entity' do
+ subject
+
+ expect(response).to have_http_status(422)
+ end
+ end
+ end
+
+ describe 'GET /api/v2/filters/:id' do
+ subject do
+ get "/api/v2/filters/#{filter.id}", headers: headers
+ end
+
+ let(:filter) { Fabricate(:custom_filter, account: user.account) }
+
+ it_behaves_like 'forbidden for wrong scope', 'write write:filters'
+ it_behaves_like 'unauthorized for invalid token'
+
+ it 'returns the filter successfully', :aggregate_failures do
+ subject
+
+ expect(response).to have_http_status(200)
+ expect(body_as_json[:id]).to eq(filter.id.to_s)
+ end
+
+ context 'when the filter belongs to someone else' do
+ let(:filter) { Fabricate(:custom_filter) }
+
+ it 'returns http not found' do
+ subject
+
+ expect(response).to have_http_status(404)
+ end
+ end
+ end
+
+ describe 'PUT /api/v2/filters/:id' do
+ subject do
+ put "/api/v2/filters/#{filter.id}", params: params, headers: headers
+ end
+
+ let!(:filter) { Fabricate(:custom_filter, account: user.account) }
+ let!(:keyword) { Fabricate(:custom_filter_keyword, custom_filter: filter) }
+ let(:params) { {} }
+
+ it_behaves_like 'forbidden for wrong scope', 'read read:filters'
+ it_behaves_like 'unauthorized for invalid token'
+
+ context 'when updating filter parameters' do
+ context 'with valid params' do
+ let(:params) { { title: 'updated', context: %w(home public) } }
+
+ it 'updates the filter successfully', :aggregate_failures do
+ subject
+
+ filter.reload
+
+ expect(response).to have_http_status(200)
+ expect(filter.title).to eq 'updated'
+ expect(filter.reload.context).to eq %w(home public)
+ end
+ end
+
+ context 'with invalid params' do
+ let(:params) { { title: 'updated', context: %w(word) } }
+
+ it 'returns http unprocessable entity' do
+ subject
+
+ expect(response).to have_http_status(422)
+ end
+ end
+ end
+
+ context 'when updating keywords in bulk' do
+ let(:params) { { keywords_attributes: [{ id: keyword.id, keyword: 'updated' }] } }
+
+ before do
+ allow(redis).to receive_messages(publish: nil)
+ end
+
+ it 'returns http success' do
+ subject
+
+ expect(response).to have_http_status(200)
+ end
+
+ it 'updates the keyword' do
+ subject
+
+ expect(keyword.reload.keyword).to eq 'updated'
+ end
+
+ it 'sends exactly one filters_changed event' do
+ subject
+
+ expect(redis).to have_received(:publish).with("timeline:#{user.account.id}", Oj.dump(event: :filters_changed)).once
+ end
+ end
+
+ context 'when the filter belongs to someone else' do
+ let(:filter) { Fabricate(:custom_filter) }
+
+ it 'returns http not found' do
+ subject
+
+ expect(response).to have_http_status(404)
+ end
+ end
+ end
+
+ describe 'DELETE /api/v2/filters/:id' do
+ subject do
+ delete "/api/v2/filters/#{filter.id}", headers: headers
+ end
+
+ let(:filter) { Fabricate(:custom_filter, account: user.account) }
+
+ it_behaves_like 'forbidden for wrong scope', 'read read:filters'
+ it_behaves_like 'unauthorized for invalid token'
+
+ it 'returns http success' do
+ subject
+
+ expect(response).to have_http_status(200)
+ end
+
+ it 'removes the filter' do
+ subject
+
+ expect { filter.reload }.to raise_error ActiveRecord::RecordNotFound
+ end
+
+ context 'when the filter belongs to someone else' do
+ let(:filter) { Fabricate(:custom_filter) }
+
+ it 'returns http not found' do
+ subject
+
+ expect(response).to have_http_status(404)
+ end
+ end
+ end
+end