Merge pull request #6433 from NHSDigital/refactor-imms-methods

Refactor Imms API concern

Author: jf-x-dev

app/lib/nhs/immunisations_api.rb

@@ -258,15 +258,6 @@ def delete_immunisation(vaccination_record)
       end
     end
 
-    def should_be_in_immunisations_api?(vaccination_record)
-      vaccination_record.kept? &&
-        vaccination_record.correct_source_for_nhs_immunisations_api? &&
-        vaccination_record.administered? &&
-        Flipper.enabled?(:imms_api_sync_job, vaccination_record.programme) &&
-        vaccination_record.notify_parents != false &&
-        vaccination_record.patient.not_invalidated?
-    end
-
     def should_perform_search_for_patient?(patient)
       patient.teams.any?(&:has_point_of_care_access?)
     end
@@ -355,7 +346,8 @@ def next_sync_action(vaccination_record)
                 " nhs_immunisations_api_sync_pending_at is nil"
       end
 
-      should_be_recorded = should_be_in_immunisations_api?(vaccination_record)
+      should_be_recorded =
+        vaccination_record.should_be_in_nhs_immunisations_api?
       is_recorded = is_recorded_in_immunisations_api?(vaccination_record)
 
       if is_recorded

app/models/vaccination_record.rb

@@ -85,11 +85,11 @@ class VaccinationRecord < ApplicationRecord
   include Confirmable
   include Discard::Model
   include HasDoseVolume
+  include NHSImmunisationsAPISync
   include Notable
   include PendingChangesConcern
   include PerformableAtDateAndTime
   include PerformableBy
-  include SyncableToNHSImmunisationsAPI
 
   audited associated_with: :patient
 

…rns/syncable_to_nhs_immunisations_api.rb …ion_record/nhs_immunisations_api_sync.rbapp/models/concerns/syncable_to_nhs_immunisations_api.rb renamed to app/models/vaccination_record/nhs_immunisations_api_sync.rb app/models/concerns/syncable_to_nhs_immunisations_api.rb renamed to app/models/vaccination_record/nhs_immunisations_api_sync.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module SyncableToNHSImmunisationsAPI
+module VaccinationRecord::NHSImmunisationsAPISync
   extend ActiveSupport::Concern
 
   included do
@@ -52,9 +52,14 @@ def correct_source_for_nhs_immunisations_api?
       )
   end
 
+  def should_be_in_nhs_immunisations_api?
+    kept? && correct_source_for_nhs_immunisations_api? && administered? &&
+      Flipper.enabled?(:imms_api_sync_job, programme) &&
+      notify_parents != false && patient.not_invalidated?
+  end
+
   def sync_status
-    should_be_synced =
-      NHS::ImmunisationsAPI.should_be_in_immunisations_api?(self)
+    should_be_synced = should_be_in_nhs_immunisations_api?
     return :not_synced unless should_be_synced
 
     synced_at = nhs_immunisations_api_synced_at

spec/lib/nhs/immunisations_api_spec.rb

@@ -661,100 +661,6 @@
     end
   end
 
-  describe "should_be_in_immunisations_api?" do
-    subject(:should_be_in_immunisations_api) do
-      described_class.should_be_in_immunisations_api?(vaccination_record)
-    end
-
-    context "when all conditions are met" do
-      it { should be true }
-    end
-
-    context "when the vaccination record has been discarded" do
-      before { vaccination_record.discard! }
-
-      it { should be false }
-    end
-
-    context "when the vaccination record doesn't have the correct source" do
-      before do
-        allow(vaccination_record).to receive(
-          :correct_source_for_nhs_immunisations_api?
-        ).and_return(false)
-      end
-
-      it { should be false }
-    end
-
-    VaccinationRecord.defined_enums["outcome"].each_key do |outcome|
-      next if outcome == "administered"
-
-      context "the vaccination record outcome is #{outcome}" do
-        let(:vaccination_record) do
-          create(
-            :vaccination_record,
-            outcome:,
-            patient:,
-            nhs_immunisations_api_synced_at:,
-            nhs_immunisations_api_id:,
-            nhs_immunisations_api_primary_source:,
-            nhs_immunisations_api_etag:,
-            nhs_immunisations_api_sync_pending_at:
-          )
-        end
-
-        it { should be false }
-      end
-    end
-
-    context "when the patient has no NHS number" do
-      before { patient.update(nhs_number: nil) }
-
-      it { should be true }
-    end
-
-    context "when the patient has requested that their parents aren't notified" do
-      before do
-        create(
-          :consent,
-          :given,
-          :self_consent,
-          patient:,
-          programme:,
-          notify_parents_on_vaccination: false
-        )
-      end
-
-      let(:notify_parents) { false }
-
-      it { should be false }
-    end
-
-    context "when notify_parents is not set" do
-      let(:notify_parents) { nil }
-
-      it { should be true }
-    end
-
-    context "when the patient is invalidated" do
-      before { patient.update(invalidated_at: Time.current) }
-
-      it { should be false }
-    end
-
-    context "when the programme type is not enabled in the feature flag" do
-      let(:programme) { Programme.menacwy }
-      let(:vaccine) { programme.vaccines.first }
-
-      before do
-        Flipper.disable(:imms_api_sync_job)
-        Flipper.enable(:imms_api_sync_job, Programme.hpv)
-      end
-
-      it { should be false }
-    end
-  end
-
   describe "next_sync_action" do
     subject(:next_sync_action) do
       described_class.send(:next_sync_action, vaccination_record)
@@ -791,10 +697,14 @@
     end
 
     context "the vaccination record is already in-sync" do
-      let(:nhs_immunisations_api_synced_at) { 1.second.ago }
-      let(:nhs_immunisations_api_id) { Random.uuid }
-      let(:nhs_immunisations_api_primary_source) { true }
-      let(:nhs_immunisations_api_sync_pending_at) { 2.seconds.ago }
+      before do
+        vaccination_record.update_columns(
+          nhs_immunisations_api_synced_at: 1.second.ago,
+          nhs_immunisations_api_id: Random.uuid,
+          nhs_immunisations_api_primary_source: true,
+          nhs_immunisations_api_sync_pending_at: 2.seconds.ago
+        )
+      end
 
       it { should be_nil }
     end

…yncable_to_nhs_immunisations_api_spec.rb …ecord/nhs_immunisations_api_sync_spec.rbspec/models/concerns/syncable_to_nhs_immunisations_api_spec.rb renamed to spec/models/vaccination_record/nhs_immunisations_api_sync_spec.rb spec/models/concerns/syncable_to_nhs_immunisations_api_spec.rb renamed to spec/models/vaccination_record/nhs_immunisations_api_sync_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe SyncableToNHSImmunisationsAPI do
+describe VaccinationRecord::NHSImmunisationsAPISync do
   let(:vaccination_record) do
     build(:vaccination_record, outcome:, programme:, session:, created_at:)
   end
@@ -521,4 +521,90 @@
       end
     end
   end
+
+  describe "#should_be_in_nhs_immunisations_api?" do
+    subject { vaccination_record.should_be_in_nhs_immunisations_api? }
+
+    let(:patient) { create(:patient, session:) }
+    let(:notify_parents) { true }
+    let(:vaccination_record) do
+      create(
+        :vaccination_record,
+        outcome:,
+        programme:,
+        session:,
+        patient:,
+        notify_parents:
+      )
+    end
+
+    before { Flipper.enable(:imms_api_sync_job, programme) }
+
+    context "when all conditions are met" do
+      it { should be true }
+    end
+
+    context "when the vaccination record has been discarded" do
+      before { vaccination_record.discard! }
+
+      it { should be false }
+    end
+
+    context "when the vaccination record doesn't have the correct source" do
+      before do
+        allow(vaccination_record).to receive(
+          :correct_source_for_nhs_immunisations_api?
+        ).and_return(false)
+      end
+
+      it { should be false }
+    end
+
+    VaccinationRecord.defined_enums["outcome"].each_key do |outcome|
+      next if outcome == "administered"
+
+      context "the vaccination record outcome is #{outcome}" do
+        let(:vaccination_record) do
+          create(:vaccination_record, outcome:, programme:, session:, patient:)
+        end
+
+        it { should be false }
+      end
+    end
+
+    context "when the patient has no NHS number" do
+      before { patient.update(nhs_number: nil) }
+
+      it { should be true }
+    end
+
+    context "when the patient has requested that their parents aren't notified" do
+      let(:notify_parents) { false }
+
+      it { should be false }
+    end
+
+    context "when notify_parents is not set" do
+      let(:notify_parents) { nil }
+
+      it { should be true }
+    end
+
+    context "when the patient is invalidated" do
+      before { patient.update(invalidated_at: Time.current) }
+
+      it { should be false }
+    end
+
+    context "when the programme type is not enabled in the feature flag" do
+      let(:programme) { Programme.menacwy }
+
+      before do
+        Flipper.disable(:imms_api_sync_job)
+        Flipper.enable(:imms_api_sync_job, Programme.hpv)
+      end
+
+      it { should be false }
+    end
+  end
 end