Merge pull request #6541 from NHSDigital/add-careplus-url-credentials

Add columns for careplus namespace, username and password to team model

Author: jf-x-dev

app/models/onboarding.rb

@@ -24,8 +24,11 @@ class Onboarding
 
   TEAM_ATTRIBUTES = {
     point_of_care: %i[
+      careplus_namespace
+      careplus_password
       careplus_staff_code
       careplus_staff_type
+      careplus_username
       careplus_venue_code
       days_before_consent_reminders
       days_before_consent_requests

app/models/team.rb

@@ -5,8 +5,11 @@
 # Table name: teams
 #
 #  id                              :bigint           not null, primary key
+#  careplus_namespace              :string
+#  careplus_password               :string
 #  careplus_staff_code             :string
 #  careplus_staff_type             :string
+#  careplus_username               :string
 #  careplus_venue_code             :string
 #  days_before_consent_reminders   :integer          default(7), not null
 #  days_before_consent_requests    :integer          default(21), not null
@@ -80,6 +83,8 @@ class Team < ApplicationRecord
   normalizes :email, with: EmailAddressNormaliser.new
   normalizes :phone, with: PhoneNumberNormaliser.new
 
+  encrypts :careplus_username, :careplus_password
+
   enum :type,
        { point_of_care: 0, national_reporting: 1, support: 2 },
        validate: true,

db/migrate/20260407121005_add_careplus_credentials_to_teams.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddCareplusCredentialsToTeams < ActiveRecord::Migration[8.1]
+  def change
+    change_table :teams, bulk: true do |t|
+      t.string :careplus_namespace
+      t.string :careplus_username
+      t.string :careplus_password
+    end
+  end
+end

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_120000) do
+ActiveRecord::Schema[8.1].define(version: 2026_04_07_121005) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_catalog.plpgsql"
   enable_extension "pg_trgm"
@@ -904,8 +904,11 @@
   end
 
   create_table "teams", force: :cascade do |t|
+    t.string "careplus_namespace"
+    t.string "careplus_password"
     t.string "careplus_staff_code"
     t.string "careplus_staff_type"
+    t.string "careplus_username"
     t.string "careplus_venue_code"
     t.datetime "created_at", null: false
     t.integer "days_before_consent_reminders", default: 7, null: false

docs/managing-teams.md

@@ -22,6 +22,9 @@ team:
   careplus_staff_code: # Staff code used in CarePlus exports
   careplus_staff_type: # Staff type used in CarePlus exports
   careplus_venue_code: # Venue code used in CarePlus exports
+  careplus_namespace: # Optional namespace for the CarePlus web service
+  careplus_username: # Optional username for the CarePlus web service
+  careplus_password: # Optional password for the CarePlus web service
   privacy_notice_url: # URL of a privacy notice shown to parents
   privacy_policy_url: # URL of a privacy policy shown to parents
   reply_to_id: # Optional GOV.UK Notify Reply-To UUID

spec/factories/teams.rb

@@ -5,8 +5,11 @@
 # Table name: teams
 #
 #  id                              :bigint           not null, primary key
+#  careplus_namespace              :string
+#  careplus_password               :string
 #  careplus_staff_code             :string
 #  careplus_staff_type             :string
+#  careplus_username               :string
 #  careplus_venue_code             :string
 #  days_before_consent_reminders   :integer          default(7), not null
 #  days_before_consent_requests    :integer          default(21), not null
@@ -90,9 +93,12 @@
     end
 
     trait :with_careplus_enabled do
+      careplus_namespace { "MOCK" }
       careplus_staff_code { "LW5PM" }
       careplus_staff_type { "IN" }
       careplus_venue_code { identifier.to_s }
+      careplus_username { "careplus_user" }
+      careplus_password { "careplus_password" }
     end
 
     after(:create) do |team|

spec/models/team_spec.rb

@@ -5,8 +5,11 @@
 # Table name: teams
 #
 #  id                              :bigint           not null, primary key
+#  careplus_namespace              :string
+#  careplus_password               :string
 #  careplus_staff_code             :string
 #  careplus_staff_type             :string
+#  careplus_username               :string
 #  careplus_venue_code             :string
 #  days_before_consent_reminders   :integer          default(7), not null
 #  days_before_consent_requests    :integer          default(21), not null