Implement ProfileApiClient.delete_school_student

API docs: https://my.raspberrypi.org/api/v1/documentation/#/Students/delete_schools__schoolId__students__studentId_

Author: chrisroos

lib/concepts/school_student/delete.rb

@@ -16,7 +16,7 @@ def call(school:, student_id:, token:)
       private
 
       def delete_student(school, student_id, token)
-        ProfileApiClient.delete_school_student(token:, student_id:, organisation_id: school.id)
+        ProfileApiClient.delete_school_student(token:, student_id:, school_id: school.id)
       end
     end
   end

lib/profile_api_client.rb

@@ -137,13 +137,12 @@ def update_school_student(token:, school_id:, student_id:, name: nil, username:
     end
     # rubocop:enable Metrics/AbcSize
 
-    def delete_school_student(token:, student_id:, organisation_id:)
+    def delete_school_student(token:, school_id:, student_id:)
       return nil if token.blank?
 
-      _ = student_id
-      _ = organisation_id
+      response = connection(token).delete("/api/v1/schools/#{school_id}/students/#{student_id}")
 
-      {}
+      raise UnexpectedResponse, response unless response.status == 204
     end
 
     def safeguarding_flags(token:)

spec/concepts/school_student/delete_spec.rb

@@ -21,7 +21,7 @@
 
     # TODO: Replace with WebMock assertion once the profile API has been built.
     expect(ProfileApiClient).to have_received(:delete_school_student)
-      .with(token:, student_id:, organisation_id: school.id)
+      .with(token:, student_id:, school_id: school.id)
   end
 
   context 'when removal fails' do

spec/lib/profile_api_client_spec.rb

@@ -675,4 +675,60 @@ def school_student
       described_class.school_student(token:, school_id: school.id, student_id:)
     end
   end
+
+  describe '.delete_school_student' do
+    let(:school) { build(:school, id: SecureRandom.uuid) }
+    let(:delete_student_url) { "#{api_url}/api/v1/schools/#{school.id}/students/#{student_id}" }
+    let(:student_id) { SecureRandom.uuid }
+
+    before do
+      stub_request(:delete, delete_student_url).to_return(status: 204, body: '', headers: { 'content-type' => 'application/json' })
+    end
+
+    it 'makes a request to the profile api host' do
+      delete_school_student
+      expect(WebMock).to have_requested(:delete, delete_student_url)
+    end
+
+    it 'includes token in the authorization request header' do
+      delete_school_student
+      expect(WebMock).to have_requested(:delete, delete_student_url).with(headers: { authorization: "Bearer #{token}" })
+    end
+
+    it 'includes the profile api key in the x-api-key request header' do
+      delete_school_student
+      expect(WebMock).to have_requested(:delete, delete_student_url).with(headers: { 'x-api-key' => api_key })
+    end
+
+    it 'sets accept header to json' do
+      delete_school_student
+      expect(WebMock).to have_requested(:delete, delete_student_url).with(headers: { 'accept' => 'application/json' })
+    end
+
+    it 'returns nil if successful' do
+      stub_request(:delete, delete_student_url)
+        .to_return(status: 204, body: '', headers: { 'content-type' => 'application/json' })
+      expect(delete_school_student).to be_nil
+    end
+
+    it 'raises exception if anything other than a 200 status code is returned' do
+      stub_request(:delete, delete_student_url)
+        .to_return(status: 201)
+
+      expect { delete_school_student }.to raise_error(ProfileApiClient::UnexpectedResponse)
+    end
+
+    it 'raises faraday exception for 4xx and 5xx responses' do
+      stub_request(:delete, delete_student_url)
+        .to_return(status: 401)
+
+      expect { delete_school_student }.to raise_error(Faraday::Error)
+    end
+
+    private
+
+    def delete_school_student
+      described_class.delete_school_student(token:, school_id: school.id, student_id:)
+    end
+  end
 end