Merge pull request #6651 from NHSDigital/add-careplus-team-scopes

jf-x-dev · web-flow · commit 671e705ee936 · 2026-04-21T10:13:34.000+01:00
Add careplus_enabled, has_careplus_credentials, eligible_for_automated_careplus_reports scope/predicate
diff --git a/app/lib/mavis_cli/reports/export_automated_careplus.rb b/app/lib/mavis_cli/reports/export_automated_careplus.rb
@@ -126,8 +126,8 @@ def call(
         # prevent this tool from creating database entries at all
 
         ActiveRecord::Base.transaction do
-          careplus_export =
-            CareplusExport.create!(
+          careplus_report =
+            CareplusReport.create!(
               team:,
               academic_year: academic_year_value,
               date_from: parsed_start_date,
@@ -141,10 +141,10 @@ def call(
             )
 
           now_iso = now.iso8601(6)
-          CareplusExportVaccinationRecord.insert_all!(
+          CareplusReportVaccinationRecord.insert_all!(
             records.map do |record|
               {
-                careplus_export_id: careplus_export.id,
+                careplus_report_id: careplus_report.id,
                 vaccination_record_id: record.id,
                 change_type: 0,
                 created_at: now_iso,
diff --git a/app/models/careplus_report.rb b/app/models/careplus_report.rb
@@ -2,7 +2,7 @@
 
 # == Schema Information
 #
-# Table name: careplus_exports
+# Table name: careplus_reports
 #
 #  id              :bigint           not null, primary key
 #  academic_year   :integer          not null
@@ -21,24 +21,24 @@
 #
 # Indexes
 #
-#  index_careplus_exports_on_programme_types            (programme_types) USING gin
-#  index_careplus_exports_on_status_and_scheduled_at    (status,scheduled_at)
-#  index_careplus_exports_on_team_id                    (team_id)
-#  index_careplus_exports_on_team_id_and_academic_year  (team_id,academic_year)
+#  index_careplus_reports_on_programme_types            (programme_types) USING gin
+#  index_careplus_reports_on_status_and_scheduled_at    (status,scheduled_at)
+#  index_careplus_reports_on_team_id                    (team_id)
+#  index_careplus_reports_on_team_id_and_academic_year  (team_id,academic_year)
 #
 # Foreign Keys
 #
 #  fk_rails_...  (team_id => teams.id)
 #
-class CareplusExport < ApplicationRecord
+class CareplusReport < ApplicationRecord
   include HasManyProgrammes
 
   audited associated_with: :team
 
   belongs_to :team
 
-  has_many :careplus_export_vaccination_records, dependent: :destroy
-  has_many :vaccination_records, through: :careplus_export_vaccination_records
+  has_many :careplus_report_vaccination_records, dependent: :destroy
+  has_many :vaccination_records, through: :careplus_report_vaccination_records
 
   enum :status, { pending: 0, sending: 1, sent: 2, failed: 3 }, validate: true
 
diff --git a/app/models/careplus_report_vaccination_record.rb b/app/models/careplus_report_vaccination_record.rb
@@ -2,28 +2,28 @@
 
 # == Schema Information
 #
-# Table name: careplus_export_vaccination_records
+# Table name: careplus_report_vaccination_records
 #
 #  change_type           :integer          not null
 #  created_at            :datetime         not null
 #  updated_at            :datetime         not null
-#  careplus_export_id    :bigint           not null, primary key
+#  careplus_report_id    :bigint           not null, primary key
 #  vaccination_record_id :bigint           not null, primary key
 #
 # Indexes
 #
-#  idx_on_careplus_export_id_8ce4ed1ff0     (careplus_export_id)
-#  idx_on_vaccination_record_id_d4c93aefb7  (vaccination_record_id)
+#  idx_on_careplus_report_id_98876049c7     (careplus_report_id)
+#  idx_on_vaccination_record_id_e7f05454ab  (vaccination_record_id)
 #
 # Foreign Keys
 #
-#  fk_rails_...  (careplus_export_id => careplus_exports.id) ON DELETE => cascade
+#  fk_rails_...  (careplus_report_id => careplus_reports.id) ON DELETE => cascade
 #  fk_rails_...  (vaccination_record_id => vaccination_records.id)
 #
-class CareplusExportVaccinationRecord < ApplicationRecord
-  self.primary_key = %i[careplus_export_id vaccination_record_id]
+class CareplusReportVaccinationRecord < ApplicationRecord
+  self.primary_key = %i[careplus_report_id vaccination_record_id]
 
-  belongs_to :careplus_export
+  belongs_to :careplus_report
   belongs_to :vaccination_record
 
   enum :change_type, { created: 0, updated: 1 }, validate: true
diff --git a/app/models/team.rb b/app/models/team.rb
@@ -85,6 +85,23 @@ class Team < ApplicationRecord
 
   encrypts :careplus_username, :careplus_password
 
+  scope :careplus_enabled,
+        -> do
+          where
+            .not(careplus_staff_code: [nil, ""])
+            .where.not(careplus_staff_type: [nil, ""])
+            .where.not(careplus_venue_code: [nil, ""])
+        end
+  scope :has_careplus_credentials,
+        -> do
+          where
+            .not(careplus_namespace: [nil, ""])
+            .where.not(careplus_username: nil)
+            .where.not(careplus_password: nil)
+        end
+  scope :eligible_for_automated_careplus_reports,
+        -> { careplus_enabled.has_careplus_credentials }
+
   enum :type,
        { point_of_care: 0, national_reporting: 1, support: 2 },
        validate: true,
@@ -154,4 +171,9 @@ def careplus_enabled?
     careplus_staff_code.present? && careplus_staff_type.present? &&
       careplus_venue_code.present?
   end
+
+  def eligible_for_automated_careplus_reports?
+    careplus_enabled? && careplus_username.present? &&
+      careplus_password.present? && careplus_namespace.present?
+  end
 end
diff --git a/config/locales/en.yml b/config/locales/en.yml
@@ -334,13 +334,13 @@ en:
               blank: Choose a programme
   activerecord:
     attributes:
-      careplus_export:
+      careplus_report:
         statuses:
           pending: Pending
           sending: Sending
           sent: Sent
           failed: Failed
-      careplus_export_vaccination_record:
+      careplus_report_vaccination_record:
         change_types:
           created: Created
           updated: Updated
@@ -518,7 +518,7 @@ en:
               taken: This batch expiry date already exists for this batch number
             number:
               blank: Enter a batch number
-        careplus_export:
+        careplus_report:
           attributes:
             academic_year:
               blank: Enter an academic year
@@ -532,7 +532,7 @@ en:
               blank: Enter a scheduled date
             status:
               inclusion: Choose a status
-        careplus_export_vaccination_record:
+        careplus_report_vaccination_record:
           attributes:
             change_type:
               inclusion: Choose a change type
diff --git a/db/migrate/20260419122121_rename_careplus_exports_to_reports.rb b/db/migrate/20260419122121_rename_careplus_exports_to_reports.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class RenameCareplusExportsToReports < ActiveRecord::Migration[8.0]
+  def change
+    rename_table :careplus_exports, :careplus_reports
+
+    rename_table :careplus_export_vaccination_records,
+                 :careplus_report_vaccination_records
+    rename_column :careplus_report_vaccination_records,
+                  :careplus_export_id,
+                  :careplus_report_id
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[8.1].define(version: 2026_04_07_121005) do
+ActiveRecord::Schema[8.1].define(version: 2026_04_19_122121) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_catalog.plpgsql"
   enable_extension "pg_trgm"
@@ -102,17 +102,17 @@
     t.index ["vaccine_id"], name: "index_batches_on_vaccine_id"
   end
 
-  create_table "careplus_export_vaccination_records", primary_key: ["careplus_export_id", "vaccination_record_id"], force: :cascade do |t|
-    t.bigint "careplus_export_id", null: false
+  create_table "careplus_report_vaccination_records", primary_key: ["careplus_report_id", "vaccination_record_id"], force: :cascade do |t|
+    t.bigint "careplus_report_id", null: false
     t.integer "change_type", null: false
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.bigint "vaccination_record_id", null: false
-    t.index ["careplus_export_id"], name: "idx_on_careplus_export_id_8ce4ed1ff0"
-    t.index ["vaccination_record_id"], name: "idx_on_vaccination_record_id_d4c93aefb7"
+    t.index ["careplus_report_id"], name: "idx_on_careplus_report_id_98876049c7"
+    t.index ["vaccination_record_id"], name: "idx_on_vaccination_record_id_e7f05454ab"
   end
 
-  create_table "careplus_exports", force: :cascade do |t|
+  create_table "careplus_reports", force: :cascade do |t|
     t.integer "academic_year", null: false
     t.datetime "created_at", null: false
     t.text "csv_data"
@@ -126,10 +126,10 @@
     t.integer "status", default: 0, null: false
     t.bigint "team_id", null: false
     t.datetime "updated_at", null: false
-    t.index ["programme_types"], name: "index_careplus_exports_on_programme_types", using: :gin
-    t.index ["status", "scheduled_at"], name: "index_careplus_exports_on_status_and_scheduled_at"
-    t.index ["team_id", "academic_year"], name: "index_careplus_exports_on_team_id_and_academic_year"
-    t.index ["team_id"], name: "index_careplus_exports_on_team_id"
+    t.index ["programme_types"], name: "index_careplus_reports_on_programme_types", using: :gin
+    t.index ["status", "scheduled_at"], name: "index_careplus_reports_on_status_and_scheduled_at"
+    t.index ["team_id", "academic_year"], name: "index_careplus_reports_on_team_id_and_academic_year"
+    t.index ["team_id"], name: "index_careplus_reports_on_team_id"
   end
 
   create_table "class_imports", force: :cascade do |t|
@@ -1087,9 +1087,9 @@
   add_foreign_key "attendance_records", "patients"
   add_foreign_key "batches", "teams"
   add_foreign_key "batches", "vaccines"
-  add_foreign_key "careplus_export_vaccination_records", "careplus_exports", on_delete: :cascade
-  add_foreign_key "careplus_export_vaccination_records", "vaccination_records"
-  add_foreign_key "careplus_exports", "teams"
+  add_foreign_key "careplus_report_vaccination_records", "careplus_reports", on_delete: :cascade
+  add_foreign_key "careplus_report_vaccination_records", "vaccination_records"
+  add_foreign_key "careplus_reports", "teams"
   add_foreign_key "class_imports", "locations"
   add_foreign_key "class_imports", "teams"
   add_foreign_key "class_imports", "users", column: "uploaded_by_user_id"
diff --git a/spec/factories/careplus_report_vaccination_records.rb b/spec/factories/careplus_report_vaccination_records.rb
@@ -2,27 +2,27 @@
 
 # == Schema Information
 #
-# Table name: careplus_export_vaccination_records
+# Table name: careplus_report_vaccination_records
 #
 #  change_type           :integer          not null
 #  created_at            :datetime         not null
 #  updated_at            :datetime         not null
-#  careplus_export_id    :bigint           not null, primary key
+#  careplus_report_id    :bigint           not null, primary key
 #  vaccination_record_id :bigint           not null, primary key
 #
 # Indexes
 #
-#  idx_on_careplus_export_id_8ce4ed1ff0     (careplus_export_id)
-#  idx_on_vaccination_record_id_d4c93aefb7  (vaccination_record_id)
+#  idx_on_careplus_report_id_98876049c7     (careplus_report_id)
+#  idx_on_vaccination_record_id_e7f05454ab  (vaccination_record_id)
 #
 # Foreign Keys
 #
-#  fk_rails_...  (careplus_export_id => careplus_exports.id) ON DELETE => cascade
+#  fk_rails_...  (careplus_report_id => careplus_reports.id) ON DELETE => cascade
 #  fk_rails_...  (vaccination_record_id => vaccination_records.id)
 #
 FactoryBot.define do
-  factory :careplus_export_vaccination_record do
-    careplus_export
+  factory :careplus_report_vaccination_record do
+    careplus_report
     vaccination_record
     change_type { :created }
   end
diff --git a/spec/factories/careplus_reports.rb b/spec/factories/careplus_reports.rb
@@ -2,7 +2,7 @@
 
 # == Schema Information
 #
-# Table name: careplus_exports
+# Table name: careplus_reports
 #
 #  id              :bigint           not null, primary key
 #  academic_year   :integer          not null
@@ -21,17 +21,17 @@
 #
 # Indexes
 #
-#  index_careplus_exports_on_programme_types            (programme_types) USING gin
-#  index_careplus_exports_on_status_and_scheduled_at    (status,scheduled_at)
-#  index_careplus_exports_on_team_id                    (team_id)
-#  index_careplus_exports_on_team_id_and_academic_year  (team_id,academic_year)
+#  index_careplus_reports_on_programme_types            (programme_types) USING gin
+#  index_careplus_reports_on_status_and_scheduled_at    (status,scheduled_at)
+#  index_careplus_reports_on_team_id                    (team_id)
+#  index_careplus_reports_on_team_id_and_academic_year  (team_id,academic_year)
 #
 # Foreign Keys
 #
 #  fk_rails_...  (team_id => teams.id)
 #
 FactoryBot.define do
-  factory :careplus_export do
+  factory :careplus_report do
     transient { programmes { [Programme.sample] } }
 
     team { association(:team, programmes:) }
@@ -44,7 +44,7 @@
     trait :sent do
       status { :sent }
       sent_at { Time.current }
-      csv_filename { "careplus_export.csv" }
+      csv_filename { "careplus_report.csv" }
       csv_data { "col1,col2\nval1,val2" }
     end
 
diff --git a/spec/features/cli_reports_export_automated_careplus_spec.rb b/spec/features/cli_reports_export_automated_careplus_spec.rb
diff --git a/spec/models/careplus_report_spec.rb b/spec/models/careplus_report_spec.rb
diff --git a/spec/models/careplus_report_vaccination_record_spec.rb b/spec/models/careplus_report_vaccination_record_spec.rb
diff --git a/spec/models/team_spec.rb b/spec/models/team_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`# == Schema Information`
`4`	`4`	`#`
`5`		`-# Table name: careplus_exports`
	`5`	`+# Table name: careplus_reports`
`6`	`6`	`#`
`7`	`7`	`# id :bigint not null, primary key`
`8`	`8`	`# academic_year :integer not null`
`@@ -21,24 +21,24 @@`
`21`	`21`	`#`
`22`	`22`	`# Indexes`
`23`	`23`	`#`
`24`		`-# index_careplus_exports_on_programme_types (programme_types) USING gin`
`25`		`-# index_careplus_exports_on_status_and_scheduled_at (status,scheduled_at)`
`26`		`-# index_careplus_exports_on_team_id (team_id)`
`27`		`-# index_careplus_exports_on_team_id_and_academic_year (team_id,academic_year)`
	`24`	`+# index_careplus_reports_on_programme_types (programme_types) USING gin`
	`25`	`+# index_careplus_reports_on_status_and_scheduled_at (status,scheduled_at)`
	`26`	`+# index_careplus_reports_on_team_id (team_id)`
	`27`	`+# index_careplus_reports_on_team_id_and_academic_year (team_id,academic_year)`
`28`	`28`	`#`
`29`	`29`	`# Foreign Keys`
`30`	`30`	`#`
`31`	`31`	`# fk_rails_... (team_id => teams.id)`
`32`	`32`	`#`
`33`		`-class CareplusExport < ApplicationRecord`
	`33`	`+class CareplusReport < ApplicationRecord`
`34`	`34`	`include HasManyProgrammes`
`35`	`35`
`36`	`36`	`audited associated_with: :team`
`37`	`37`
`38`	`38`	`belongs_to :team`
`39`	`39`
`40`		`- has_many :careplus_export_vaccination_records, dependent: :destroy`
`41`		`- has_many :vaccination_records, through: :careplus_export_vaccination_records`
	`40`	`+ has_many :careplus_report_vaccination_records, dependent: :destroy`
	`41`	`+ has_many :vaccination_records, through: :careplus_report_vaccination_records`
`42`	`42`
`43`	`43`	`enum :status, { pending: 0, sending: 1, sent: 2, failed: 3 }, validate: true`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -2,28 +2,28 @@`
`2`	`2`
`3`	`3`	`# == Schema Information`
`4`	`4`	`#`
`5`		`-# Table name: careplus_export_vaccination_records`
	`5`	`+# Table name: careplus_report_vaccination_records`
`6`	`6`	`#`
`7`	`7`	`# change_type :integer not null`
`8`	`8`	`# created_at :datetime not null`
`9`	`9`	`# updated_at :datetime not null`
`10`		`-# careplus_export_id :bigint not null, primary key`
	`10`	`+# careplus_report_id :bigint not null, primary key`
`11`	`11`	`# vaccination_record_id :bigint not null, primary key`
`12`	`12`	`#`
`13`	`13`	`# Indexes`
`14`	`14`	`#`
`15`		`-# idx_on_careplus_export_id_8ce4ed1ff0 (careplus_export_id)`
`16`		`-# idx_on_vaccination_record_id_d4c93aefb7 (vaccination_record_id)`
	`15`	`+# idx_on_careplus_report_id_98876049c7 (careplus_report_id)`
	`16`	`+# idx_on_vaccination_record_id_e7f05454ab (vaccination_record_id)`
`17`	`17`	`#`
`18`	`18`	`# Foreign Keys`
`19`	`19`	`#`
`20`		`-# fk_rails_... (careplus_export_id => careplus_exports.id) ON DELETE => cascade`
	`20`	`+# fk_rails_... (careplus_report_id => careplus_reports.id) ON DELETE => cascade`
`21`	`21`	`# fk_rails_... (vaccination_record_id => vaccination_records.id)`
`22`	`22`	`#`
`23`		`-class CareplusExportVaccinationRecord < ApplicationRecord`
`24`		`- self.primary_key = %i[careplus_export_id vaccination_record_id]`
	`23`	`+class CareplusReportVaccinationRecord < ApplicationRecord`
	`24`	`+ self.primary_key = %i[careplus_report_id vaccination_record_id]`
`25`	`25`
`26`		`- belongs_to :careplus_export`
	`26`	`+ belongs_to :careplus_report`
`27`	`27`	`belongs_to :vaccination_record`
`28`	`28`
`29`	`29`	`enum :change_type, { created: 0, updated: 1 }, validate: true`
Original file line number	Diff line number	Diff line change
`@@ -2,27 +2,27 @@`
`2`	`2`
`3`	`3`	`# == Schema Information`
`4`	`4`	`#`
`5`		`-# Table name: careplus_export_vaccination_records`
	`5`	`+# Table name: careplus_report_vaccination_records`
`6`	`6`	`#`
`7`	`7`	`# change_type :integer not null`
`8`	`8`	`# created_at :datetime not null`
`9`	`9`	`# updated_at :datetime not null`
`10`		`-# careplus_export_id :bigint not null, primary key`
	`10`	`+# careplus_report_id :bigint not null, primary key`
`11`	`11`	`# vaccination_record_id :bigint not null, primary key`
`12`	`12`	`#`
`13`	`13`	`# Indexes`
`14`	`14`	`#`
`15`		`-# idx_on_careplus_export_id_8ce4ed1ff0 (careplus_export_id)`
`16`		`-# idx_on_vaccination_record_id_d4c93aefb7 (vaccination_record_id)`
	`15`	`+# idx_on_careplus_report_id_98876049c7 (careplus_report_id)`
	`16`	`+# idx_on_vaccination_record_id_e7f05454ab (vaccination_record_id)`
`17`	`17`	`#`
`18`	`18`	`# Foreign Keys`
`19`	`19`	`#`
`20`		`-# fk_rails_... (careplus_export_id => careplus_exports.id) ON DELETE => cascade`
	`20`	`+# fk_rails_... (careplus_report_id => careplus_reports.id) ON DELETE => cascade`
`21`	`21`	`# fk_rails_... (vaccination_record_id => vaccination_records.id)`
`22`	`22`	`#`
`23`	`23`	`FactoryBot.define do`
`24`		`- factory :careplus_export_vaccination_record do`
`25`		`- careplus_export`
	`24`	`+ factory :careplus_report_vaccination_record do`
	`25`	`+ careplus_report`
`26`	`26`	`vaccination_record`
`27`	`27`	`change_type { :created }`
`28`	`28`	`end`