Record info when syncing vaccination record

This info will be used for performing updates and deletes later.

Jira-Issue: MAV-1477

Author: misaka

app/lib/nhs/immunisations_api.rb

@@ -3,11 +3,27 @@
 module NHS::ImmunisationsAPI
   class << self
     def record_immunisation(vaccination_record)
-      NHS::API.connection.post(
-        "/immunisation-fhir-api/FHIR/R4/Immunization",
-        vaccination_record.fhir_record.to_json,
-        "Content-Type" => "application/fhir+json"
-      )
+      response =
+        NHS::API.connection.post(
+          "/immunisation-fhir-api/FHIR/R4/Immunization",
+          vaccination_record.fhir_record.to_json,
+          "Content-Type" => "application/fhir+json"
+        )
+
+      if response.status == 201
+        vaccination_record.update!(
+          nhs_immunisations_api_id:
+            extract_nhs_id(response.headers.fetch("location")),
+          nhs_immunisations_api_synced_at: Time.current,
+          # We would normally retrieve this from the API response, but the NHS
+          # Immunisations API does not return this to us, yet.
+          nhs_immunisations_api_etag: 1
+        )
+      else
+        raise "Error syncing vaccination record #{vaccination_record.id} to" \
+                " Immunisations API: unexpected response status" \
+                " #{response.status}"
+      end
     rescue Faraday::ClientError => e
       if (diagnostics = extract_error_diagnostics(e&.response)).present?
         raise "Error syncing vaccination #{vaccination_record.id} record to" \
@@ -32,5 +48,13 @@ def extract_error_diagnostics(response)
         nil
       end
     end
+
+    def extract_nhs_id(location)
+      if (match = location.match(%r{Immunization/([a-f0-9-]+)}))
+        match[1]
+      else
+        raise UnrecognisedLocation, location
+      end
+    end
   end
 end

spec/features/cli_vaccination_records_sync_spec.rb

@@ -70,7 +70,14 @@ def and_the_nhs_api_is_available
           "Content-Type" => "application/fhir+json",
           "Accept" => "application/fhir+json"
         }
-      ).to_return(status: 200, body: "", headers: {})
+      ).to_return(
+        status: 201,
+        body: "",
+        headers: {
+          location:
+            "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/Immunization/11112222-3333-4444-5555-666677778888"
+        }
+      )
   end
 
   def when_i_run_the_sync_command

spec/lib/nhs/immunisations_api_spec.rb

@@ -49,66 +49,128 @@
   end
 
   describe "record_immunisation" do
+    before do
+      stub_request(
+        :post,
+        "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
+      ).to_return(
+        status: 201,
+        body: "",
+        headers: {
+          location:
+            "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/Immunization/ffff1111-eeee-2222-dddd-3333eeee4444"
+        }
+      )
+    end
+
     it "sends the correct JSON payload" do
       expected_body =
         File.read(Rails.root.join("spec/fixtures/fhir/immunisation.json")).chomp
 
       # stree-ignore
       stubbed_request =
         stub_request(
-          :post,
-          "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
+          :post, "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
         )
           .with { |request|
-            expect(request.headers["Accept"]).to eq "application/fhir+json"
-            expect(
-              request.headers["Content-Type"]
-            ).to eq "application/fhir+json"
-            expect(request.body).to eq expected_body
-            true
-          }
-          .to_return(status: 200, body: "", headers: {})
+        expect(request.headers["Accept"]).to eq "application/fhir+json"
+        expect(
+          request.headers["Content-Type"]
+        ).to eq "application/fhir+json"
+        expect(request.body).to eq expected_body
+        true
+      }
+          .to_return(status: 201,
+                     body: "",
+                     headers: {
+                       location:
+                         "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/Immunization/ffff1111-eeee-2222-dddd-3333eeee4444"
+                     })
 
       described_class.record_immunisation(vaccination_record)
 
       expect(stubbed_request).to have_been_made
     end
 
+    it "stores the id from the response" do
+      described_class.record_immunisation(vaccination_record)
+
+      expect(
+        vaccination_record.nhs_immunisations_api_id
+      ).to eq "ffff1111-eeee-2222-dddd-3333eeee4444"
+    end
+
+    it "stores the nhs_immunisations_api_synced_at from the response" do
+      freeze_time do
+        described_class.record_immunisation(vaccination_record)
+
+        expect(
+          vaccination_record.nhs_immunisations_api_synced_at
+        ).to eq Time.current
+      end
+    end
+
+    it "initialises the etag to 1" do
+      described_class.record_immunisation(vaccination_record)
+
+      expect(vaccination_record.nhs_immunisations_api_etag).to eq "1"
+    end
+
     context "an error is returned by the api" do
-      context "4XX error" do
-        let(:response) do
-          {
-            resourceType: "OperationOutcome",
-            id: "bc2c3c82-4392-4314-9d6b-a7345f82d923",
-            meta: {
-              profile: [
-                "https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"
-              ]
-            },
-            issue: [
-              {
-                severity: "error",
-                code: "invalid",
-                details: {
-                  coding: [
-                    {
-                      system: "https://fhir.nhs.uk/Codesystem/http-error-codes",
-                      code: "NOT-FOUND"
-                    }
-                  ]
-                },
-                diagnostics: "Invalid patient ID"
-              }
+      before do
+        stub_request(
+          :post,
+          "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
+        ).to_return(status: status, body: response, headers: {})
+      end
+
+      let(:status) { 201 }
+      let(:code) { nil }
+      let(:diagnostics) { nil }
+
+      let(:response) do
+        {
+          resourceType: "OperationOutcome",
+          id: "bc2c3c82-4392-4314-9d6b-a7345f82d923",
+          meta: {
+            profile: [
+              "https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"
             ]
-          }.to_json
-        end
+          },
+          issue: [
+            {
+              severity: "error",
+              code: "invalid",
+              details: {
+                coding: [
+                  {
+                    system: "https://fhir.nhs.uk/Codesystem/http-error-codes",
+                    code:
+                  }
+                ]
+              },
+              diagnostics:
+            }
+          ]
+        }.to_json
+      end
 
-        before do
-          stub_request(
-            :post,
-            "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
-          ).to_return(status: 404, body: response, headers: {})
+      context "unexpected response status" do
+        let(:status) { 200 }
+        let(:response) { "" }
+
+        it "raises an error saying the response is unexpected" do
+          expect {
+            described_class.record_immunisation(vaccination_record)
+          }.to raise_error(
+            "Error syncing vaccination record #{vaccination_record.id} to" \
+              " Immunisations API: unexpected response status 200"
+          )
         end
+      end
+
+      context "4XX error" do
+        let(:status) { 404 }
 
         it "raises an error with the diagnostic message" do
           expect {