hensei-api/spec/requests/grid_summons_controller_spec.rb
Justin Edmund 7b16fdc112 Refactor GridSummonsController
- Refactors controller
- Adds YARD documentation
- Adds Rspec tests
2025-02-10 18:14:41 -08:00

369 lines
12 KiB
Ruby

# frozen_string_literal: true
require 'rails_helper'
# This request spec tests the GridSummons API endpoints using modern RSpec techniques.
RSpec.describe 'GridSummons API', type: :request do
let(:user) { create(:user) }
let(:party) { create(:party, user: user, edit_key: 'secret') }
let(:summon) { Summon.find_by(granblue_id: '2040433000') }
let(:access_token) do
Doorkeeper::AccessToken.create!(
resource_owner_id: user.id,
expires_in: 30.days,
scopes: 'public'
)
end
let(:headers) do
{
'Authorization' => "Bearer #{access_token.token}",
'Content-Type' => 'application/json'
}
end
RSpec::Matchers.define :have_json_error_message do |expected_message|
match do |response|
JSON.parse(response.body)['error'].to_s.include?(expected_message)
end
failure_message do |response|
"expected error message to include '#{expected_message}', but got: #{JSON.parse(response.body)['error']}"
end
end
describe 'POST /api/v1/summons' do
let(:valid_params) do
{
summon: {
party_id: party.id,
summon_id: summon.id,
position: 0,
main: true,
friend: false,
quick_summon: false,
uncap_level: 3,
transcendence_step: 0
}
}
end
context 'with valid parameters' do
it 'creates a grid summon and returns status created' do
expect do
post '/api/v1/summons', params: valid_params.to_json, headers: headers
end.to change(GridSummon, :count).by(1)
expect(response).to have_http_status(:created)
json_response = JSON.parse(response.body)
expect(json_response).to have_key('grid_summon')
expect(json_response['grid_summon']).to include('position' => 0)
end
end
context 'with invalid parameters' do
# Revised: use a non-numeric uncap_level so the grid summon is built but fails validation.
let(:invalid_params) do
{
summon: {
party_id: party.id,
summon_id: summon.id,
position: 0,
main: true,
friend: false,
quick_summon: false,
uncap_level: 'invalid',
transcendence_step: 0
}
}
end
it 'returns unprocessable entity status with error details' do
post '/api/v1/summons', params: invalid_params.to_json, headers: headers
expect(response).to have_http_status(:unprocessable_entity)
json_response = JSON.parse(response.body)
expect(json_response).to have_key('errors')
expect(json_response['errors']).to include('uncap_level')
end
end
end
describe 'PUT /api/v1/grid_summons/:id' do
before do
@grid_summon = create(:grid_summon,
party: party,
summon: summon,
position: 1,
uncap_level: 3,
transcendence_step: 0)
end
context 'with valid parameters' do
let(:update_params) do
{
summon: {
id: @grid_summon.id,
party_id: party.id,
summon_id: summon.id,
position: 1,
main: true,
friend: false,
quick_summon: false,
uncap_level: 4,
transcendence_step: 0
}
}
end
it 'updates the grid summon and returns the updated record' do
put "/api/v1/grid_summons/#{@grid_summon.id}", params: update_params.to_json, headers: headers
expect(response).to have_http_status(:ok)
json_response = JSON.parse(response.body)
expect(json_response).to have_key('grid_summon')
expect(json_response['grid_summon']).to include('uncap_level' => 4)
end
end
context 'with invalid parameters' do
let(:invalid_update_params) do
{
summon: {
id: @grid_summon.id,
party_id: party.id,
summon_id: summon.id,
position: 1,
main: true,
friend: false,
quick_summon: false,
uncap_level: 'invalid',
transcendence_step: 0
}
}
end
it 'returns unprocessable entity status with error details' do
put "/api/v1/grid_summons/#{@grid_summon.id}", params: invalid_update_params.to_json, headers: headers
expect(response).to have_http_status(:unprocessable_entity)
json_response = JSON.parse(response.body)
expect(json_response).to have_key('errors')
expect(json_response['errors']).to include('uncap_level')
end
end
end
describe 'POST /api/v1/summons/update_uncap' do
context 'when summon has flb true, ulb false, transcendence false (max uncap 4)' do
before do
@grid_summon = create(:grid_summon,
party: party,
summon: summon,
position: 2,
uncap_level: 3,
transcendence_step: 0)
end
let(:update_uncap_params) do
{
summon: {
id: @grid_summon.id,
party_id: party.id,
summon_id: summon.id,
uncap_level: 5, # attempt above allowed; should be capped at 4
transcendence_step: 0
}
}
end
before do
summon.update!(flb: true, ulb: false, transcendence: false)
end
it 'caps the uncap level at 4 for the summon' do
post '/api/v1/summons/update_uncap', params: update_uncap_params.to_json, headers: headers
expect(response).to have_http_status(:ok)
json_response = JSON.parse(response.body)
expect(json_response).to have_key('grid_summon')
expect(json_response['grid_summon']).to include('uncap_level' => 4)
end
end
context 'when summon has ulb true, transcendence false (max uncap 5)' do
before do
@grid_summon = create(:grid_summon,
party: party,
summon: summon,
position: 2,
uncap_level: 3,
transcendence_step: 0)
end
let(:update_uncap_params) do
{
summon: {
id: @grid_summon.id,
party_id: party.id,
summon_id: summon.id,
uncap_level: 6, # attempt above allowed; should be capped at 5
transcendence_step: 0
}
}
end
before do
summon.update!(flb: true, ulb: true, transcendence: false)
end
it 'updates the uncap level to 5' do
post '/api/v1/summons/update_uncap', params: update_uncap_params.to_json, headers: headers
expect(response).to have_http_status(:ok)
json_response = JSON.parse(response.body)
expect(json_response).to have_key('grid_summon')
expect(json_response['grid_summon']).to include('uncap_level' => 5)
end
end
context 'when summon can be transcended (max uncap 6)' do
before do
@grid_summon = create(:grid_summon,
party: party,
summon: summon,
position: 2,
uncap_level: 3,
transcendence_step: 0)
end
let(:update_uncap_params) do
{
summon: {
id: @grid_summon.id,
party_id: party.id,
summon_id: summon.id,
uncap_level: 7, # attempt above allowed; should be capped at 6
transcendence_step: 0
}
}
end
before do
summon.update!(flb: true, ulb: true, transcendence: true)
end
it 'updates the uncap level to 6' do
post '/api/v1/summons/update_uncap', params: update_uncap_params.to_json, headers: headers
expect(response).to have_http_status(:ok)
json_response = JSON.parse(response.body)
expect(json_response).to have_key('grid_summon')
expect(json_response['grid_summon']).to include('uncap_level' => 6)
end
end
end
describe 'POST /api/v1/summons/update_quick_summon' do
context 'when grid summon position is not in [4,5,6]' do
let!(:grid_summon) do
create(:grid_summon,
party: party,
summon: summon,
position: 2,
quick_summon: false)
end
let(:update_quick_params) do
{
summon: {
id: grid_summon.id,
party_id: party.id,
summon_id: summon.id,
quick_summon: true
}
}
end
it 'updates the quick summon flag and returns the updated summons array' do
post '/api/v1/summons/update_quick_summon', params: update_quick_params.to_json, headers: headers
expect(response).to have_http_status(:ok)
json_response = JSON.parse(response.body)
expect(json_response).to have_key('summons')
end
end
context 'when grid summon position is in [4,5,6]' do
let!(:grid_summon) do
create(:grid_summon,
party: party,
summon: summon,
position: 4,
quick_summon: false)
end
let(:update_quick_params) do
{
summon: {
id: grid_summon.id,
party_id: party.id,
summon_id: summon.id,
quick_summon: true
}
}
end
it 'returns no content when position is in [4,5,6]' do
post '/api/v1/summons/update_quick_summon', params: update_quick_params.to_json, headers: headers
expect(response).to have_http_status(:no_content)
end
end
end
describe 'DELETE /api/v1/grid_summons/:id (destroy action)' do
context 'when the party is owned by a logged in user' do
let!(:grid_summon) do
create(:grid_summon,
party: party,
summon: summon,
position: 3,
uncap_level: 3,
transcendence_step: 0)
end
it 'destroys the grid summon and returns a success response' do
expect { delete "/api/v1/grid_summons/#{grid_summon.id}", headers: headers }
.to change(GridSummon, :count).by(-1)
expect(response).to have_http_status(:ok)
end
it 'returns not found when trying to delete a non-existent grid summon' do
delete '/api/v1/grid_summons/00000000-0000-0000-0000-000000000000', headers: headers
expect(response).to have_http_status(:not_found)
end
end
context 'when the party is anonymous (no user)' do
# For anonymous users, override the party and header edit key.
let(:headers) { super().merge('X-Edit-Key' => 'anonsecret') }
let(:party) { create(:party, user: nil, edit_key: 'anonsecret') }
let!(:grid_summon) do
create(:grid_summon,
party: party,
summon: summon,
position: 3,
uncap_level: 3,
transcendence_step: 0)
end
it 'allows anonymous user to destroy grid summon when current_user is nil' do
# To simulate an anonymous request, we remove the Authorization header.
anonymous_headers = headers.except('Authorization')
expect { delete "/api/v1/grid_summons/#{grid_summon.id}", headers: anonymous_headers }
.to change(GridSummon, :count).by(-1)
expect(response).to have_http_status(:ok)
end
it 'prevents deletion when a logged in user attempts to delete an anonymous grid summon' do
# When a logged in user (with an access token) tries to delete a grid summon
# that belongs to an anonymous party, authorization should fail.
auth_headers = headers.except('X-Edit-Key')
expect { delete "/api/v1/grid_summons/#{grid_summon.id}", headers: auth_headers }
.not_to change(GridSummon, :count)
expect(response).to have_http_status(:unauthorized)
end
end
end
end