Merge pull request #6542 from NHSDigital/add-send-to-careplus-cli-tool

Add CLI tool which sends a given CSV to careplus service

Author: jf-x-dev

app/lib/careplus/client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "cgi"
+require "net/http"
+require "uri"
+
+module Careplus
+  class Client
+    TARGET_NAMESPACE_BASE = "https://careplus.syhapp.thirdparty.nhs.uk"
+
+    def initialize(username:, password:, namespace:, payload:)
+      @username = username
+      @password = password
+      @namespace = namespace
+      @payload = payload
+    end
+
+    def send_csv
+      uri =
+        URI.parse("#{Settings.careplus.base_url}/#{namespace}/soap.SchImms.cls")
+      soap_body = build_soap_envelope
+      post_soap_request(uri, soap_body)
+    end
+
+    def self.send_csv(...) = new(...).send_csv
+
+    private_class_method :new
+
+    private
+
+    attr_reader :username, :password, :namespace, :payload
+
+    def build_soap_envelope
+      escaped_payload = CGI.escapeHTML(payload)
+      target_namespace = "#{TARGET_NAMESPACE_BASE}/#{namespace}/webservices"
+
+      <<~XML
+        <?xml version="1.0" encoding="utf-8"?>
+        <soap:Envelope
+            xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+            xmlns:car="#{target_namespace}">
+          <soap:Body>
+            <car:InsertImmsRecord>
+              <car:strUserId>#{username}</car:strUserId>
+              <car:strPwd>#{password}</car:strPwd>
+              <car:strPayload>#{escaped_payload}</car:strPayload>
+            </car:InsertImmsRecord>
+          </soap:Body>
+        </soap:Envelope>
+      XML
+    end
+
+    def post_soap_request(uri, body)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request["Content-Type"] = "text/xml; charset=utf-8"
+      request.body = body
+
+      http.request(request)
+    end
+  end
+end

app/lib/mavis_cli.rb

@@ -58,6 +58,7 @@ def self.terminal_lines
 require_relative "mavis_cli/pds/get"
 require_relative "mavis_cli/pds/search"
 require_relative "mavis_cli/reports/export_automated_careplus"
+require_relative "mavis_cli/reports/send_to_careplus"
 require_relative "mavis_cli/schools/add_programme_year_group"
 require_relative "mavis_cli/schools/add_to_team"
 require_relative "mavis_cli/schools/create"

app/lib/mavis_cli/reports/send_to_careplus.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "../../careplus/client"
+
+module MavisCLI
+  module Reports
+    class SendToCareplus < Dry::CLI::Command
+      desc "Send a CarePlus CSV file to the CarePlus endpoint"
+
+      example [
+                "--input=tmp/automated_export.csv",
+                "--input=tmp/automated_export.csv --ods_code=ABC123"
+              ]
+
+      FALLBACK_NAMESPACE = "MOCK"
+      FALLBACK_USERNAME = "mavis_user"
+      FALLBACK_PASSWORD = "mavis_password"
+
+      option :input, required: true, desc: "Path to the CSV file to send"
+      option :ods_code,
+             desc: "ODS code of the organisation (to use team credentials)"
+      option :workgroup,
+             desc:
+               "Team workgroup (required if the organisation has multiple teams)"
+
+      def call(input:, ods_code: nil, workgroup: nil, **)
+        MavisCLI.load_rails
+
+        unless File.exist?(input)
+          warn "File not found: '#{input}'"
+          return
+        end
+
+        username, password, namespace =
+          resolve_credentials(ods_code:, workgroup:)
+        return if username.nil?
+
+        csv_payload = File.read(input)
+
+        response =
+          Careplus::Client.send_csv(
+            username:,
+            password:,
+            namespace:,
+            payload: csv_payload
+          )
+
+        if response.is_a?(Net::HTTPSuccess)
+          puts "Success (HTTP #{response.code})"
+          puts response.body
+        else
+          warn "Request failed with HTTP #{response.code}: #{response.message}"
+          warn response.body
+        end
+      end
+
+      private
+
+      def resolve_credentials(ods_code:, workgroup:)
+        if ods_code.nil?
+          return FALLBACK_USERNAME, FALLBACK_PASSWORD, FALLBACK_NAMESPACE
+        end
+
+        organisation = Organisation.find_by(ods_code:)
+        if organisation.nil?
+          warn "Could not find organisation with ODS code '#{ods_code}'"
+          return nil, nil
+        end
+
+        teams = organisation.teams
+        teams = teams.where(workgroup:) if workgroup
+
+        if teams.empty?
+          warn(
+            if workgroup
+              "Could not find team '#{workgroup}' for organisation '#{ods_code}'"
+            else
+              "Organisation '#{ods_code}' has no teams."
+            end
+          )
+          return nil, nil, nil
+        end
+
+        if workgroup.nil? && teams.many?
+          warn "Organisation '#{ods_code}' has multiple teams. Specify --workgroup."
+          return nil, nil, nil
+        end
+
+        team = teams.sole
+
+        unless team.careplus_username.present? &&
+                 team.careplus_password.present?
+          warn "Team '#{team.name}' does not have CarePlus credentials configured."
+          return nil, nil, nil
+        end
+
+        [
+          team.careplus_username,
+          team.careplus_password,
+          team.careplus_namespace
+        ]
+      end
+    end
+  end
+
+  register "reports" do |prefix|
+    prefix.register "send-to-careplus", Reports::SendToCareplus
+  end
+end

config/settings.yml

@@ -57,6 +57,9 @@ reporting_api:
     client_id: <%= Rails.application.credentials.reporting_api&.client_id %>
     secret: <%= Rails.application.credentials.reporting_api&.secret %>
 
+careplus:
+  base_url: https://careplus.syhapp.thirdparty.nhs.uk
+
 # Set a value to override the default values set in config/initializers/devise.rb
 devise:
   timeout_in_seconds:

config/settings/development.yml

@@ -26,3 +26,6 @@ splunk:
 reporting_api:
   client_app:
     root_url: http://localhost:4001
+
+careplus:
+  base_url: http://localhost:8080

config/settings/staging.yml

@@ -17,3 +17,6 @@ cis2:
 pds:
   raise_unknown_gp_practice: false
   rate_limit_per_second: 5
+
+careplus:
+  base_url: <%= ENV.fetch("MOCK_CAREPLUS_URL", nil) %>

config/settings/test.yml

@@ -24,3 +24,6 @@ splunk:
 reporting_api:
   client_app:
     root_url: http://localhost:5001/
+
+careplus:
+  base_url: http://localhost:8080