Update safeguarding flag call to match api changes (#400)

closes #399

---------

Co-authored-by: create-issue-branch[bot] <53036503+create-issue-branch[bot]@users.noreply.github.com>
Co-authored-by: Dan Halson <[email protected]>

Author: create-issue-branch[bot]

.devcontainer/docker-compose.yml

@@ -3,7 +3,7 @@ services:
     build:
       context: .
       target: dev-container
-    command: bash bin/dev-container-entrypoint.sh
+    command: bash bin/docker-debug-entrypoint.sh
     volumes:
       # - ${HOME}/.bashrc:/root/.bashrc:ro # Map a ~/.bashrc in your home directory for customising bash
       - ${HOME}/.ssh:/root/.ssh:ro # To share any ssh keys with the container
@@ -12,4 +12,3 @@ services:
 
 volumes:
   node_modules: null
-

.gitignore

@@ -39,3 +39,5 @@
 /coverage
 
 .byebug_history
+
+docker-compose.override.yml

.vscode/launch.json

@@ -1,27 +1,22 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
     {
       "type": "ruby_lsp",
+      "name": "Debug",
       "request": "launch",
-      "name": "Debug program",
-      "program": "ruby "
+      "program": "ruby ${file}",
     },
     {
-      "type": "rdbg",
-      "name": "Debug current file with rdbg",
+      "type": "ruby_lsp",
       "request": "launch",
-      "script": "${file}",
-      "args": [],
-      "askParameters": true
+      "name": "Debug test file",
+      "program": "ruby -Itest ${relativeFile}",
     },
     {
-      "type": "rdbg",
-      "name": "Attach with rdbg",
-      "request": "attach"
-    }
-  ]
+      "type": "ruby_lsp",
+      "request": "attach",
+      "name": "Attach to existing server",
+    },
+  ],
 }

Gemfile

@@ -38,6 +38,7 @@ gem 'sentry-rails'
 
 group :development, :test do
   gem 'bullet'
+  gem 'debug'
   gem 'dotenv-rails'
   gem 'factory_bot_rails'
   gem 'faker'

Gemfile.lock

@@ -148,6 +148,9 @@ GEM
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
     date (3.3.4)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dotenv (2.8.1)
@@ -515,6 +518,7 @@ DEPENDENCIES
   climate_control
   countries
   database_cleaner-active_record
+  debug
   dotenv-rails
   email_validator
   factory_bot_rails

app/controllers/api/school_students_controller.rb

@@ -76,7 +76,8 @@ def create_teacher_safeguarding_flag
 
       ProfileApiClient.create_safeguarding_flag(
         token: current_user.token,
-        flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher]
+        flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher],
+        email: current_user.email
       )
     end
 
@@ -85,7 +86,8 @@ def create_owner_safeguarding_flag
 
       ProfileApiClient.create_safeguarding_flag(
         token: current_user.token,
-        flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner]
+        flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner],
+        email: current_user.email
       )
     end
   end

bin/dev-container-entrypoint.sh

@@ -0,0 +1,2 @@
+rails db:prepare --trace
+rdbg -n -o -c -- bin/rails s -p 3009 -b '0.0.0.0'

bin/docker-debug-entrypoint.sh

@@ -4,5 +4,5 @@
 
 if Rails.env.development?
   Rake::Task['projects:create_all'].invoke
-  Rake::Task['classroom_management:seed_a_school_with_lessons'].invoke
+  Rake::Task['classroom_management:seed_a_school_with_lessons_and_students'].invoke
 end

db/seeds.rb

@@ -153,9 +153,9 @@ def safeguarding_flags(token:)
       response.body.map { |flag| SafeguardingFlag.new(**flag.symbolize_keys) }
     end
 
-    def create_safeguarding_flag(token:, flag:)
+    def create_safeguarding_flag(token:, flag:, email:)
       response = connection(token).post('/api/v1/safeguarding-flags') do |request|
-        request.body = { flag: }
+        request.body = { flag:, email: }
       end
 
       raise UnexpectedResponse, response unless [201, 303].include?(response.status)

lib/profile_api_client.rb

@@ -2,15 +2,15 @@
 
 module ClassroomManagementHelper
   TEST_USERS = {
-    # Use this in conjunction with BYPASS_OAUTH=true to generate data for the bypass user
-    bypass_oauth: '00000000-0000-0000-0000-000000000000',
     jane_doe: '583ba872-b16e-46e1-9f7d-df89d267550d', # [email protected]
     john_doe: 'bbb9b8fd-f357-4238-983d-6f87b99bdbb2', # [email protected]
     jane_smith: 'e52de409-9210-4e94-b08c-dd11439e07d9', # student
     john_smith: '0d488bec-b10d-46d3-b6f3-4cddf5d90c71' # student
   }.freeze
 
-  TEST_SCHOOL = 'e52de409-9210-4e94-b08c-dd11439e07d9'
+  # Match the school in profile...
+  TEST_SCHOOL = 'e52de409-9210-4e94-b08c-dd11439e07d9' # e52de409-9210-4e94-b08c-dd11439e07d9
+  SCHOOL_CODE = '12-12-12-12'
 
   def create_school(creator_id, school_id = nil)
     School.find_or_create_by!(creator_id:, id: school_id) do |school|
@@ -30,6 +30,11 @@ def create_school(creator_id, school_id = nil)
   def verify_school(school)
     Rails.logger.info 'Verifying the school...'
     school.verify!
+
+    # rubocop:disable Rails/SkipsModelValidations
+    school.update_column(:code, SCHOOL_CODE) # The code needs to match the one in the profile
+    # rubocop:enable Rails/SkipsModelValidations
+
     Role.owner.create!(user_id: school.creator_id, school:)
     Role.teacher.create!(user_id: school.creator_id, school:)
   end

lib/tasks/classroom_management_helper.rb

@@ -18,12 +18,12 @@
 
   it 'creates the school owner safeguarding flag' do
     post("/api/schools/#{school.id}/students/batch", headers:, params: { file: })
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'does not create the school teacher safeguarding flag' do
     post("/api/schools/#{school.id}/students/batch", headers:, params: { file: })
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: owner.email)
   end
 
   it 'responds 204 No Content' do
@@ -44,15 +44,15 @@
     authenticated_in_hydra_as(teacher)
 
     post("/api/schools/#{school.id}/students/batch", headers:, params: { file: })
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'creates the school teacher safeguarding flag when the user is a school-teacher' do
     teacher = create(:teacher, school:)
     authenticated_in_hydra_as(teacher)
 
     post("/api/schools/#{school.id}/students/batch", headers:, params: { file: })
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: teacher.email)
   end
 
   it 'responds 422 Unprocessable Entity when params are invalid' do

spec/features/school_student/creating_a_batch_of_school_students_spec.rb

@@ -25,12 +25,12 @@
 
   it 'creates the school owner safeguarding flag' do
     post("/api/schools/#{school.id}/students", headers:, params:)
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'does not create the school teacher safeguarding flag' do
     post("/api/schools/#{school.id}/students", headers:, params:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: owner.email)
   end
 
   it 'responds 204 No Content' do
@@ -51,15 +51,15 @@
     authenticated_in_hydra_as(teacher)
 
     post("/api/schools/#{school.id}/students", headers:, params:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'creates the school teacher safeguarding flag when the user is a school teacher' do
     teacher = create(:teacher, school:)
     authenticated_in_hydra_as(teacher)
 
     post("/api/schools/#{school.id}/students", headers:, params:)
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: teacher.email)
   end
 
   it 'responds 400 Bad Request when params are missing' do

spec/features/school_student/creating_a_school_student_spec.rb

@@ -16,12 +16,12 @@
 
   it 'creates the school owner safeguarding flag' do
     delete("/api/schools/#{school.id}/students/#{student_id}", headers:)
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'does not create the school teacher safeguarding flag' do
     delete("/api/schools/#{school.id}/students/#{student_id}", headers:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: owner.email)
   end
 
   it 'responds 204 No Content' do
@@ -55,15 +55,15 @@
     authenticated_in_hydra_as(teacher)
 
     delete("/api/schools/#{school.id}/students/#{student_id}", headers:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'does not create the school teacher safeguarding flag when logged in as a teacher' do
     teacher = create(:teacher, school:)
     authenticated_in_hydra_as(teacher)
 
     delete("/api/schools/#{school.id}/students/#{student_id}", headers:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: teacher.email)
   end
 
   it 'responds 403 Forbidden when the user is a school-student' do

spec/features/school_student/deleting_a_school_student_spec.rb

@@ -22,12 +22,12 @@
 
   it 'creates the school owner safeguarding flag' do
     get("/api/schools/#{school.id}/students", headers:)
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'does not create the school teacher safeguarding flag' do
     get("/api/schools/#{school.id}/students", headers:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: owner.email)
   end
 
   it 'responds 200 OK when the user is a school-teacher' do
@@ -43,15 +43,15 @@
     authenticated_in_hydra_as(teacher)
 
     get("/api/schools/#{school.id}/students", headers:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'creates the school teacher safeguarding flag when the user is a school teacher' do
     teacher = create(:teacher, school:)
     authenticated_in_hydra_as(teacher)
 
     get("/api/schools/#{school.id}/students", headers:)
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: teacher.email)
   end
 
   it 'responds with the school students JSON' do

spec/features/school_student/listing_school_students_spec.rb

@@ -26,12 +26,12 @@
 
   it 'creates the school owner safeguarding flag' do
     put("/api/schools/#{school.id}/students/#{student_id}", headers:, params:)
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'does not create the school teacher safeguarding flag' do
     put("/api/schools/#{school.id}/students/#{student_id}", headers:, params:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: owner.email)
   end
 
   it 'responds 204 No Content' do
@@ -52,15 +52,15 @@
     authenticated_in_hydra_as(teacher)
 
     put("/api/schools/#{school.id}/students/#{student_id}", headers:, params:)
-    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner])
+    expect(ProfileApiClient).not_to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:owner], email: owner.email)
   end
 
   it 'creates the school teacher safeguarding flag when the user is a school teacher' do
     teacher = create(:teacher, school:)
     authenticated_in_hydra_as(teacher)
 
     put("/api/schools/#{school.id}/students/#{student_id}", headers:, params:)
-    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher])
+    expect(ProfileApiClient).to have_received(:create_safeguarding_flag).with(token: UserProfileMock::TOKEN, flag: ProfileApiClient::SAFEGUARDING_FLAGS[:teacher], email: teacher.email)
   end
 
   it 'responds 401 Unauthorized when no token is given' do

spec/features/school_student/updating_a_school_student_spec.rb

@@ -246,7 +246,7 @@ def list_safeguarding_flags
 
     it 'sends the safeguarding flag in the request body' do
       create_safeguarding_flag
-      expect(WebMock).to have_requested(:post, create_safeguarding_flag_url).with(body: { flag: }.to_json)
+      expect(WebMock).to have_requested(:post, create_safeguarding_flag_url).with(body: { flag:, email: '[email protected]' }.to_json)
     end
 
     it 'returns empty body if created successfully' do
@@ -276,7 +276,7 @@ def list_safeguarding_flags
     end
 
     def create_safeguarding_flag
-      described_class.create_safeguarding_flag(token:, flag:)
+      described_class.create_safeguarding_flag(token:, flag:, email: '[email protected]')
     end
   end