Improve test coverage for `/api/v1/featured_tags` (#25076)

spec/controllers/api/v1/featured_tags_controller_spec.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-describe Api::V1::FeaturedTagsController do
-  render_views
-
-  let(:user)    { Fabricate(:user) }
-  let(:token)   { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: 'read:accounts') }
-  let(:account) { Fabricate(:account) }
-
-  before do
-    allow(controller).to receive(:doorkeeper_token) { token }
-  end
-
-  describe 'GET #index' do
-    it 'returns http success' do
-      get :index, params: { account_id: account.id, limit: 2 }
-
-      expect(response).to have_http_status(200)
-    end
-  end
-end

spec/fabricators/featured_tag_fabricator.rb

@@ -3,5 +3,5 @@
 Fabricator(:featured_tag) do
   account
   tag
-  name 'Tag'
+  name { sequence(:name) { |i| "Tag#{i}" } }
 end

spec/requests/api/v1/featured_tags_spec.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'FeaturedTags' do
+  let(:user)    { Fabricate(:user) }
+  let(:token)   { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: scopes) }
+  let(:scopes)  { 'read:accounts write:accounts' }
+  let(:headers) { { 'Authorization' => "Bearer #{token.token}" } }
+
+  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
+
+  describe 'GET /api/v1/featured_tags' do
+    context 'with wrong scope' do
+      before do
+        get '/api/v1/featured_tags', headers: headers
+      end
+
+      it_behaves_like 'forbidden for wrong scope', 'read:statuses'
+    end
+
+    context 'when Authorization header is missing' do
+      it 'returns http unauthorized' do
+        get '/api/v1/featured_tags'
+
+        expect(response).to have_http_status(401)
+      end
+    end
+
+    it 'returns http success' do
+      get '/api/v1/featured_tags', headers: headers
+
+      expect(response).to have_http_status(200)
+    end
+
+    context 'when the requesting user has no featured tag' do
+      before { Fabricate.times(3, :featured_tag) }
+
+      it 'returns an empty body' do
+        get '/api/v1/featured_tags', headers: headers
+
+        body = body_as_json
+
+        expect(body).to be_empty
+      end
+    end
+
+    context 'when the requesting user has featured tags' do
+      let!(:user_featured_tags) { Fabricate.times(5, :featured_tag, account: user.account) }
+
+      it 'returns only the featured tags belonging to the requesting user' do
+        get '/api/v1/featured_tags', headers: headers
+
+        body = body_as_json
+        expected_ids = user_featured_tags.pluck(:id).map(&:to_s)
+
+        expect(body.pluck(:id)).to match_array(expected_ids)
+      end
+    end
+  end
+
+  describe 'POST /api/v1/featured_tags' do
+    let(:params) { { name: 'tag' } }
+
+    it 'returns http success' do
+      post '/api/v1/featured_tags', headers: headers, params: params
+
+      expect(response).to have_http_status(200)
+    end
+
+    it 'returns the correct tag name' do
+      post '/api/v1/featured_tags', headers: headers, params: params
+
+      body = body_as_json
+
+      expect(body[:name]).to eq(params[:name])
+    end
+
+    it 'creates a new featured tag for the requesting user' do
+      post '/api/v1/featured_tags', headers: headers, params: params
+
+      featured_tag = FeaturedTag.find_by(name: params[:name], account: user.account)
+
+      expect(featured_tag).to be_present
+    end
+
+    context 'with wrong scope' do
+      before do
+        post '/api/v1/featured_tags', headers: headers, params: params
+      end
+
+      it_behaves_like 'forbidden for wrong scope', 'read:statuses'
+    end
+
+    context 'when Authorization header is missing' do
+      it 'returns http unauthorized' do
+        post '/api/v1/featured_tags', params: params
+
+        expect(response).to have_http_status(401)
+      end
+    end
+
+    context 'when required param "name" is not provided' do
+      it 'returns http bad request' do
+        post '/api/v1/featured_tags', headers: headers
+
+        expect(response).to have_http_status(400)
+      end
+    end
+
+    context 'when provided tag name is invalid' do
+      let(:params) { { name: 'asj&*!' } }
+
+      it 'returns http unprocessable entity' do
+        post '/api/v1/featured_tags', headers: headers, params: params
+
+        expect(response).to have_http_status(422)
+      end
+    end
+
+    context 'when tag name is already taken' do
+      before do
+        FeaturedTag.create(name: params[:name], account: user.account)
+      end
+
+      it 'returns http unprocessable entity' do
+        post '/api/v1/featured_tags', headers: headers, params: params
+
+        expect(response).to have_http_status(422)
+      end
+    end
+  end
+
+  describe 'DELETE /api/v1/featured_tags' do
+    let!(:featured_tag) { FeaturedTag.create(name: 'tag', account: user.account) }
+    let(:id) { featured_tag.id }
+
+    it 'returns http success' do
+      delete "/api/v1/featured_tags/#{id}", headers: headers
+
+      expect(response).to have_http_status(200)
+    end
+
+    it 'returns an empty body' do
+      delete "/api/v1/featured_tags/#{id}", headers: headers
+
+      body = body_as_json
+
+      expect(body).to be_empty
+    end
+
+    it 'deletes the featured tag' do
+      delete "/api/v1/featured_tags/#{id}", headers: headers
+
+      featured_tag = FeaturedTag.find_by(id: id)
+
+      expect(featured_tag).to be_nil
+    end
+
+    context 'with wrong scope' do
+      before do
+        delete "/api/v1/featured_tags/#{id}", headers: headers
+      end
+
+      it_behaves_like 'forbidden for wrong scope', 'read:statuses'
+    end
+
+    context 'when Authorization header is missing' do
+      it 'returns http unauthorized' do
+        delete "/api/v1/featured_tags/#{id}"
+
+        expect(response).to have_http_status(401)
+      end
+    end
+
+    context 'when featured tag with given id does not exist' do
+      it 'returns http not found' do
+        delete '/api/v1/featured_tags/0', headers: headers
+
+        expect(response).to have_http_status(404)
+      end
+    end
+
+    context 'when deleting a featured tag of another user' do
+      let!(:other_user_featured_tag) { Fabricate(:featured_tag) }
+      let(:id) { other_user_featured_tag.id }
+
+      it 'returns http not found' do
+        delete "/api/v1/featured_tags/#{id}", headers: headers
+
+        expect(response).to have_http_status(404)
+      end
+    end
+  end
+end