Migrate to request specs in `/api/v1/admin/domain_blocks` (#25335)

spec/controllers/api/v1/admin/domain_blocks_controller_spec.rb

-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Api::V1::Admin::DomainBlocksController do
-  render_views
-
-  let(:role)   { UserRole.find_by(name: 'Admin') }
-  let(:user)   { Fabricate(:user, role: role) }
-  let(:scopes) { 'admin:read admin:write' }
-  let(:token)  { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) }
-
-  before do
-    allow(controller).to receive(:doorkeeper_token) { token }
-  end
-
-  shared_examples 'forbidden for wrong scope' do |wrong_scope|
-    let(:scopes) { wrong_scope }
-
-    it 'returns http forbidden' do
-      expect(response).to have_http_status(403)
-    end
-  end
-
-  shared_examples 'forbidden for wrong role' do |wrong_role|
-    let(:role) { UserRole.find_by(name: wrong_role) }
-
-    it 'returns http forbidden' do
-      expect(response).to have_http_status(403)
-    end
-  end
-
-  describe 'GET #index' do
-    let!(:block) { Fabricate(:domain_block) }
-
-    before do
-      get :index
-    end
-
-    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
-    it_behaves_like 'forbidden for wrong role', ''
-    it_behaves_like 'forbidden for wrong role', 'Moderator'
-
-    it 'returns http success' do
-      expect(response).to have_http_status(200)
-    end
-
-    it 'returns the expected domain blocks' do
-      json = body_as_json
-      expect(json.length).to eq 1
-      expect(json[0][:id].to_i).to eq block.id
-    end
-  end
-
-  describe 'GET #show' do
-    let!(:block) { Fabricate(:domain_block) }
-
-    before do
-      get :show, params: { id: block.id }
-    end
-
-    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
-    it_behaves_like 'forbidden for wrong role', ''
-    it_behaves_like 'forbidden for wrong role', 'Moderator'
-
-    it 'returns http success' do
-      expect(response).to have_http_status(200)
-    end
-
-    it 'returns expected domain name' do
-      json = body_as_json
-      expect(json[:domain]).to eq block.domain
-    end
-  end
-
-  describe 'PUT #update' do
-    let!(:remote_account) { Fabricate(:account, domain: 'example.com') }
-    let(:subject) do
-      post :update, params: { id: domain_block.id, domain: 'example.com', severity: new_severity }
-    end
-    let(:domain_block) { Fabricate(:domain_block, domain: 'example.com', severity: original_severity) }
-
-    before do
-      BlockDomainService.new.call(domain_block)
-    end
-
-    context 'when downgrading a domain suspension to silence' do
-      let(:original_severity) { 'suspend' }
-      let(:new_severity)      { 'silence' }
-
-      it 'changes the block severity' do
-        expect { subject }.to change { domain_block.reload.severity }.from('suspend').to('silence')
-      end
-
-      it 'undoes individual suspensions' do
-        expect { subject }.to change { remote_account.reload.suspended? }.from(true).to(false)
-      end
-
-      it 'performs individual silences' do
-        expect { subject }.to change { remote_account.reload.silenced? }.from(false).to(true)
-      end
-    end
-
-    context 'when upgrading a domain silence to suspend' do
-      let(:original_severity) { 'silence' }
-      let(:new_severity)      { 'suspend' }
-
-      it 'changes the block severity' do
-        expect { subject }.to change { domain_block.reload.severity }.from('silence').to('suspend')
-      end
-
-      it 'undoes individual silences' do
-        expect { subject }.to change { remote_account.reload.silenced? }.from(true).to(false)
-      end
-
-      it 'performs individual suspends' do
-        expect { subject }.to change { remote_account.reload.suspended? }.from(false).to(true)
-      end
-    end
-  end
-
-  describe 'DELETE #destroy' do
-    let!(:block) { Fabricate(:domain_block) }
-
-    before do
-      delete :destroy, params: { id: block.id }
-    end
-
-    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
-    it_behaves_like 'forbidden for wrong role', ''
-    it_behaves_like 'forbidden for wrong role', 'Moderator'
-
-    it 'returns http success' do
-      expect(response).to have_http_status(200)
-    end
-
-    it 'deletes the block' do
-      expect(DomainBlock.find_by(id: block.id)).to be_nil
-    end
-  end
-
-  describe 'POST #create' do
-    let(:existing_block_domain) { 'example.com' }
-    let!(:block) { Fabricate(:domain_block, domain: existing_block_domain, severity: :suspend) }
-
-    before do
-      post :create, params: { domain: 'foo.bar.com', severity: :silence }
-    end
-
-    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
-    it_behaves_like 'forbidden for wrong role', ''
-    it_behaves_like 'forbidden for wrong role', 'Moderator'
-
-    it 'returns http success' do
-      expect(response).to have_http_status(200)
-    end
-
-    it 'returns expected domain name' do
-      json = body_as_json
-      expect(json[:domain]).to eq 'foo.bar.com'
-    end
-
-    it 'creates a domain block' do
-      expect(DomainBlock.find_by(domain: 'foo.bar.com')).to_not be_nil
-    end
-
-    context 'when a stricter domain block already exists' do
-      let(:existing_block_domain) { 'bar.com' }
-
-      it 'returns http unprocessable entity' do
-        expect(response).to have_http_status(422)
-      end
-
-      it 'renders existing domain block in error' do
-        json = body_as_json
-        expect(json[:existing_domain_block][:domain]).to eq existing_block_domain
-      end
-    end
-  end
-end

spec/requests/api/v1/admin/domain_blocks_spec.rb

+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Domain Blocks' do
+  let(:role)    { UserRole.find_by(name: 'Admin') }
+  let(:user)    { Fabricate(:user, role: role) }
+  let(:scopes)  { 'admin:read:domain_blocks admin:write:domain_blocks' }
+  let(:token)   { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) }
+  let(:headers) { { 'Authorization' => "Bearer #{token.token}" } }
+
+  shared_examples 'forbidden for wrong scope' do |wrong_scope|
+    let(:scopes) { wrong_scope }
+
+    it 'returns http forbidden' do
+      subject
+
+      expect(response).to have_http_status(403)
+    end
+  end
+
+  shared_examples 'forbidden for wrong role' do |wrong_role|
+    let(:role) { UserRole.find_by(name: wrong_role) }
+
+    it 'returns http forbidden' do
+      subject
+
+      expect(response).to have_http_status(403)
+    end
+  end
+
+  describe 'GET /api/v1/admin/domain_blocks' do
+    subject do
+      get '/api/v1/admin/domain_blocks', headers: headers, params: params
+    end
+
+    let(:params) { {} }
+
+    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
+    it_behaves_like 'forbidden for wrong role', ''
+    it_behaves_like 'forbidden for wrong role', 'Moderator'
+
+    it 'returns http success' do
+      subject
+
+      expect(response).to have_http_status(200)
+    end
+
+    context 'when there are no domain blocks' do
+      it 'returns an empty list' do
+        subject
+
+        expect(body_as_json).to be_empty
+      end
+    end
+
+    context 'when there are domain blocks' do
+      let!(:domain_blocks) do
+        [
+          Fabricate(:domain_block, severity: :silence, reject_media: true),
+          Fabricate(:domain_block, severity: :suspend, obfuscate: true),
+          Fabricate(:domain_block, severity: :noop, reject_reports: true),
+          Fabricate(:domain_block, public_comment: 'Spam'),
+          Fabricate(:domain_block, private_comment: 'Spam'),
+        ]
+      end
+      let(:expected_responde) do
+        domain_blocks.map do |domain_block|
+          {
+            id: domain_block.id.to_s,
+            domain: domain_block.domain,
+            created_at: domain_block.created_at.strftime('%Y-%m-%dT%H:%M:%S.%LZ'),
+            severity: domain_block.severity.to_s,
+            reject_media: domain_block.reject_media,
+            reject_reports: domain_block.reject_reports,
+            private_comment: domain_block.private_comment,
+            public_comment: domain_block.public_comment,
+            obfuscate: domain_block.obfuscate,
+          }
+        end
+      end
+
+      it 'returns the expected domain blocks' do
+        subject
+
+        expect(body_as_json).to match_array(expected_responde)
+      end
+
+      context 'with limit param' do
+        let(:params) { { limit: 2 } }
+
+        it 'returns only the requested number of domain blocks' do
+          subject
+
+          expect(body_as_json.size).to eq(params[:limit])
+        end
+      end
+    end
+  end
+
+  describe 'GET /api/v1/admin/domain_blocks/:id' do
+    subject do
+      get "/api/v1/admin/domain_blocks/#{domain_block.id}", headers: headers
+    end
+
+    let!(:domain_block) { Fabricate(:domain_block) }
+
+    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
+    it_behaves_like 'forbidden for wrong role', ''
+    it_behaves_like 'forbidden for wrong role', 'Moderator'
+
+    it 'returns http success' do
+      subject
+
+      expect(response).to have_http_status(200)
+    end
+
+    it 'returns the expected domain block content' do
+      subject
+
+      expect(body_as_json).to eq(
+        {
+          id: domain_block.id.to_s,
+          domain: domain_block.domain,
+          created_at: domain_block.created_at.strftime('%Y-%m-%dT%H:%M:%S.%LZ'),
+          severity: domain_block.severity.to_s,
+          reject_media: domain_block.reject_media,
+          reject_reports: domain_block.reject_reports,
+          private_comment: domain_block.private_comment,
+          public_comment: domain_block.public_comment,
+          obfuscate: domain_block.obfuscate,
+        }
+      )
+    end
+
+    context 'when the requested domain block does not exist' do
+      it 'returns http not found' do
+        get '/api/v1/admin/domain_blocks/-1', headers: headers
+
+        expect(response).to have_http_status(404)
+      end
+    end
+  end
+
+  describe 'POST /api/v1/admin/domain_blocks' do
+    subject do
+      post '/api/v1/admin/domain_blocks', headers: headers, params: params
+    end
+
+    let(:params) { { domain: 'foo.bar.com', severity: :silence } }
+
+    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
+    it_behaves_like 'forbidden for wrong role', ''
+    it_behaves_like 'forbidden for wrong role', 'Moderator'
+
+    it 'returns http success' do
+      subject
+
+      expect(response).to have_http_status(200)
+    end
+
+    it 'returns expected domain name and severity' do
+      subject
+
+      body = body_as_json
+
+      expect(body).to match a_hash_including(
+        {
+          domain: 'foo.bar.com',
+          severity: 'silence',
+        }
+      )
+    end
+
+    it 'creates a domain block' do
+      subject
+
+      expect(DomainBlock.find_by(domain: 'foo.bar.com')).to be_present
+    end
+
+    context 'when a stricter domain block already exists' do
+      before do
+        Fabricate(:domain_block, domain: 'bar.com', severity: :suspend)
+      end
+
+      it 'returns http unprocessable entity' do
+        subject
+
+        expect(response).to have_http_status(422)
+      end
+
+      it 'returns existing domain block in error' do
+        subject
+
+        expect(body_as_json[:existing_domain_block][:domain]).to eq('bar.com')
+      end
+    end
+
+    context 'when given domain name is invalid' do
+      let(:params) { { domain: 'foo bar', severity: :silence } }
+
+      it 'returns http unprocessable entity' do
+        subject
+
+        expect(response).to have_http_status(422)
+      end
+    end
+  end
+
+  describe 'PUT /api/v1/admin/domain_blocks/:id' do
+    subject do
+      put "/api/v1/admin/domain_blocks/#{domain_block.id}", headers: headers, params: params
+    end
+
+    let!(:domain_block)   { Fabricate(:domain_block, domain: 'example.com', severity: :silence) }
+    let(:params)          { { domain: 'example.com', severity: 'suspend' } }
+
+    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
+    it_behaves_like 'forbidden for wrong role', ''
+    it_behaves_like 'forbidden for wrong role', 'Moderator'
+
+    it 'returns http success' do
+      subject
+
+      expect(response).to have_http_status(200)
+    end
+
+    it 'returns the updated domain block' do
+      subject
+
+      expect(body_as_json).to match a_hash_including(
+        {
+          id: domain_block.id.to_s,
+          domain: domain_block.domain,
+          severity: 'suspend',
+        }
+      )
+    end
+
+    it 'updates the block severity' do
+      expect { subject }.to change { domain_block.reload.severity }.from('silence').to('suspend')
+    end
+
+    context 'when domain block does not exist' do
+      it 'returns http not found' do
+        put '/api/v1/admin/domain_blocks/-1', headers: headers
+
+        expect(response).to have_http_status(404)
+      end
+    end
+  end
+
+  describe 'DELETE /api/v1/admin/domain_blocks/:id' do
+    subject do
+      delete "/api/v1/admin/domain_blocks/#{domain_block.id}", headers: headers
+    end
+
+    let!(:domain_block) { Fabricate(:domain_block) }
+
+    it_behaves_like 'forbidden for wrong scope', 'write:statuses'
+    it_behaves_like 'forbidden for wrong role', ''
+    it_behaves_like 'forbidden for wrong role', 'Moderator'
+
+    it 'returns http success' do
+      subject
+
+      expect(response).to have_http_status(200)
+    end
+
+    it 'deletes the domain block' do
+      subject
+
+      expect(DomainBlock.find_by(id: domain_block.id)).to be_nil
+    end
+
+    context 'when domain block does not exist' do
+      it 'returns http not found' do
+        delete '/api/v1/admin/domain_blocks/-1', headers: headers
+
+        expect(response).to have_http_status(404)
+      end
+    end
+  end
+end