RubyGems - shc_vaccination_test_kit - Versions diffs - 0.1.0 → 0.3.0 - Mend

shc_vaccination_test_kit 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

checksums.yaml +4 -4
data/lib/shc_vaccination_test_kit/igs/README.md +56 -0
data/lib/shc_vaccination_test_kit/igs/cards.smarthealth.terminology-0.1.0.tgz +0 -0
data/lib/shc_vaccination_test_kit/igs/shc-vaccination-1.0.0-updated.tgz +0 -0
data/lib/shc_vaccination_test_kit/javascript/jsQR.js +10100 -0
data/lib/shc_vaccination_test_kit/javascript/qr-scanner-worker.min.js +98 -0
data/lib/shc_vaccination_test_kit/javascript/qr-scanner.min.js +31 -0
data/lib/shc_vaccination_test_kit/metadata.rb +54 -0
data/lib/shc_vaccination_test_kit/shc_vaccination_validation_test.rb +152 -0
data/lib/shc_vaccination_test_kit/version.rb +4 -0
data/lib/shc_vaccination_test_kit/views/scan_qr_code.html +207 -0
data/lib/shc_vaccination_test_kit/views/upload_qr_code.html +130 -0
data/lib/shc_vaccination_test_kit.rb +66 -8
metadata +26 -21
data/lib/covid19_vci/fhir_operation.rb +0 -105
data/lib/covid19_vci/file_download.rb +0 -109
data/lib/covid19_vci/vc_fhir_validation.rb +0 -75
data/lib/covid19_vci/vc_headers.rb +0 -21
data/lib/covid19_vci/vc_payload_verification.rb +0 -115
data/lib/covid19_vci/vc_signature_verification.rb +0 -69
data/lib/covid19_vci/version.rb +0 -3

data/lib/shc_vaccination_test_kit/views/scan_qr_code.html ADDED Viewed

@@ -0,0 +1,207 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Scan a QR Code</title>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
+  </head>
+  <body class="m-3" onload="onLoad()">
+    <section class="hero is-small is-success">
+      <h3>Scan a QR Code</h3>
+      <p class="subtitle">Use device's camera to scan a QR code representing a Smart Health Card</p>
+    </section>
+    <div>
+      <div class="field is-grouped">
+          <button id="start" class="btn btn-primary" onclick="disableStartButton()">Start</button>
+          <button id="stop" class="btn btn-primary" onclick="enableStartButton()" disabled>Stop</button>
+      </div>
+      <div class="level-right" id="multi-status-container">
+      </div>
+      <video id="preview"></video>
+      <div class="notification is-success is-light" hidden id="success-notification">
+        <div class="level">
+          <div class="level-left">
+            <div class="level-item">
+              <span class="is-size-4">QR code scanned successfully.</span>
+            </div>
+          </div>
+        </div>
+      </div>
+      <div class="notification is-success is-light">
+        <form id="upload-qr-code" action="post_qr_code" accept-charset="UTF-8" method="post"></form>
+          <div class="level">
+            <div class="level-left">
+              <div class="level-item">
+                <span class="is-size-4" id="qr-contents"></span>
+              </div>
+            </div>
+          </div>
+        </form>
+      </div>
+      <div class="notification is-danger is-light" hidden id="error-notification">
+        <div class="level">
+          <div class="level-left">
+            <div class="level-item">
+              <span class="is-size-4">QR code does not contain a SMART Health Card.</span>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.bundle.min.js" crossorigin="anonymous"></script>
+    <script type="module">
+      import QrScanner from './qr-scanner.min.js';
+      const healthCardPattern = /^shc:\/(?<multipleChunks>(?<chunkIndex>[0-9]+)\/(?<chunkCount>[0-9]+)\/)?[0-9]+$/;
+      let qrScanner;
+      let startButton;
+      let stopButton;
+      let successNotification;
+      let errorNotification;
+      let inputField;
+      let multiStatusContainer;
+      let form
+      let scannedCodes = [];
+      window.onLoad = function() {
+        const videoElement = document.getElementById('preview');
+        qrScanner = new QrScanner(videoElement, handleScan);
+        startButton = document.getElementById('start');
+        stopButton = document.getElementById('stop');
+        successNotification = document.getElementById('success-notification');
+        errorNotification = document.getElementById('error-notification');
+        inputField = document.getElementById('qr-contents');
+        multiStatusContainer = document.getElementById('multi-status-container');
+        form = document.getElementById('upload-qr-code');
+        startButton.addEventListener('click', startScanning);
+        stopButton.addEventListener('click', stopScanning);
+      }
+      window.startScanning = function() {
+        disableStartButton();
+        hideSuccessNotification();
+        hideErrorNotification();
+        qrScanner.start();
+      };
+      window.stopScanning = function() {
+        enableStartButton();
+        qrScanner.stop();
+      };
+      window.disableStartButton = function() {
+        startButton.setAttribute('disabled', true);
+        stopButton.removeAttribute('disabled');
+      };
+      window.enableStartButton = function() {
+        stopButton.setAttribute('disabled', true);
+        startButton.removeAttribute('disabled');
+      };
+      window.hideSuccessNotification = function() {
+        successNotification.setAttribute('hidden', true);
+      };
+      window.showSuccessNotification = function() {
+        hideErrorNotification();
+        successNotification.removeAttribute('hidden');
+      };
+      window.hideErrorNotification = function() {
+        errorNotification.setAttribute('hidden', true);
+      };
+      window.showErrorNotification = function() {
+        hideSuccessNotification();
+        errorNotification.removeAttribute('hidden');
+      };
+      window.handleScan = function(result) {
+        console.log(result);
+        if (healthCardPattern.test(result)) {
+          const match = result.match(healthCardPattern);
+          if (match.groups.multipleChunks) {
+            hideErrorNotification();
+            const chunkCount = +match.groups.chunkCount;
+            const currentChunkIndex = +match.groups.chunkIndex;
+            if (scannedCodes.length !== chunkCount) {
+              scannedCodes = new Array(chunkCount);
+              scannedCodes.fill(null, 0, chunkCount);
+            }
+            scannedCodes[currentChunkIndex - 1] = result;
+            multiStatusContainer.innerHTML = scannedCodes
+              .map((code, index) => {
+                return code
+                  ? multiPresentElement(index + 1, chunkCount)
+                  : multiMissingElement(index + 1, chunkCount);
+              })
+              .join('\n');
+            if (scannedCodes.every(code => code)) {
+              stopScanning();
+              inputField.textContent = JSON.stringify(scannedCodes);
+              showSuccessNotification();
+              //TODO: do something here. Post result to endpoint? Need to understand the logic in this nested if statement
+            }
+          } else {
+            stopScanning();
+            multiStatusContainer.innerHTML = '';
+            inputField.textContent = JSON.stringify([result]);
+            showSuccessNotification();
+            //QR code scanned successfully. Post to endpoint (code borrowed from upload_qr_code.html)
+            const urlParams = new URLSearchParams(window.location.search);
+            const requestId = urlParams.get('id');
+            if (requestId) {
+              form.action += '?id=' + encodeURIComponent(requestId);
+            }
+            const postUrl = `${form.action}`;
+            fetch(postUrl, {
+              method: 'POST',
+              headers: {
+                'Content-Type': 'application/json',
+              },
+              body: JSON.stringify({ qr_code_content: result }),
+            })
+              .then(response => {
+                if (response.ok) {
+                  inputField.textContent += " - QR Code successfully posted to server.";
+                  window.history.back(); // Go back to the previous page
+                } else {
+                  inputField.textContent += " - Error posting QR code to server.";
+                }
+              })
+              .catch(error => {
+                inputField.textContent += ` - Network error: ${error}`;
+              });
+          }
+        } else {
+          stopScanning();
+          showErrorNotification();
+        }
+      };
+    </script>
+  </body>
+</html>

data/lib/shc_vaccination_test_kit/views/upload_qr_code.html ADDED Viewed

@@ -0,0 +1,130 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Upload a QR image file</title>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
+  </head>
+  <body class="m-3">
+    <div>
+      <h3>Upload a QR image file</h3>
+      <p class="subtitle">Manually upload a pre saved QR image file. The file shall have .png, .jpg, or .jpeg file extension.</p>
+    </div>
+    <div>
+      <form id="upload-qr-code" action="post_qr_code" accept-charset="UTF-8" method="post">
+        <div class="field is-grouped">
+          <div class="file has-name">
+            <label class="file-label">
+              <input type="file" name="qr_file" id="qr_file" accept=".png, .jpg, .jpeg" class="file-input" style="display: none;">
+              <label for="qr_file" class="btn btn-primary">Choose File</label>
+              <span class="file-name">No file uploaded</span>
+            </label>
+          </div>
+          <p></p>
+          <p id="qr-content" style="margin-top: 10px;"></p>
+          <p class="control">
+            <input type="submit" class="btn btn-secondary" id="upload-button" disabled>
+          </p>
+        </div>
+      </form>
+      <canvas id="qr-canvas" style="display: none;"></canvas>
+      <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.bundle.min.js" crossorigin="anonymous"></script>
+      <script src="jsqr.js"></script>
+      <script>
+        document.addEventListener('DOMContentLoaded', function () {
+          const fileInput = document.getElementById('qr_file');
+          const fileName = document.querySelector('.file-name');
+          const uploadButton = document.getElementById('upload-button');
+          const qrCanvas = document.getElementById('qr-canvas');
+          const qrContent = document.getElementById('qr-content');
+          const form = document.getElementById('upload-qr-code');
+          let qrCodeContent = null;
+          // Update form action if `id` query param is present
+          const urlParams = new URLSearchParams(window.location.search);
+          const requestId = urlParams.get('id');
+          if (requestId) {
+            form.action += '?id=' + encodeURIComponent(requestId);
+          }
+          fileInput.addEventListener('change', function () {
+            const file = fileInput.files[0];
+            if (file) {
+              fileName.textContent = file.name;
+              // Read the image file and decode QR code
+              const reader = new FileReader();
+              reader.onload = function (e) {
+                const img = new Image();
+                img.onload = function () {
+                  // Draw the image on the canvas
+                  const ctx = qrCanvas.getContext('2d');
+                  qrCanvas.width = img.width;
+                  qrCanvas.height = img.height;
+                  ctx.drawImage(img, 0, 0, img.width, img.height);
+                  // Get image data from the canvas
+                  const imageData = ctx.getImageData(0, 0, qrCanvas.width, qrCanvas.height);
+                  // Decode QR code using jsQR
+                  const qrCode = jsQR(imageData.data, imageData.width, imageData.height);
+                  if (qrCode) {
+                    qrContent.textContent = `QR Code Content: ${qrCode.data}`;
+                    qrCodeContent = qrCode.data; // Store the decoded content
+                    uploadButton.disabled = false; // Enable the submit button
+                    // Change button style to "btn-primary"
+                    uploadButton.classList.remove('btn-secondary');
+                    uploadButton.classList.add('btn-primary');
+                  } else {
+                    qrContent.textContent = 'No QR code detected in the image.';
+                    uploadButton.disabled = true;
+                    // Reset button style to "btn-secondary"
+                    uploadButton.classList.remove('btn-primary');
+                    uploadButton.classList.add('btn-secondary');
+                  }
+                };
+                img.src = e.target.result;
+              };
+              reader.readAsDataURL(file);
+            } else {
+              fileName.textContent = 'No file uploaded';
+              uploadButton.disabled = true;
+              qrContent.textContent = '';
+              // Reset button style to "btn-secondary"
+              uploadButton.classList.remove('btn-primary');
+              uploadButton.classList.add('btn-secondary');
+            }
+          });
+          form.addEventListener('submit', function (event) {
+            event.preventDefault(); // Prevent default form submission
+            if (qrCodeContent) {
+              const postUrl = `${form.action}`;
+              fetch(postUrl, {
+                method: 'POST',
+                headers: {
+                  'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({ qr_code_content: qrCodeContent }),
+              })
+                .then(response => {
+                  if (response.ok) {
+                    qrContent.textContent += " - QR Code successfully posted to server.";
+                    window.history.back(); // Go back to the previous page
+                  } else {
+                    qrContent.textContent += " - Error posting QR code to server.";
+                  }
+                })
+                .catch(error => {
+                  qrContent.textContent += ` - Network error: ${error}`;
+                });
+            }
+          });
+        });
+      </script>
+    </div>
+  </body>
+</html>

data/lib/shc_vaccination_test_kit.rb CHANGED Viewed

@@ -1,13 +1,71 @@
-require 'health_cards'
-require_relative 'covid19_vci/file_download'
-require_relative 'covid19_vci/fhir_operation'
+require 'smart_health_cards_test_kit'
+require_relative 'shc_vaccination_test_kit/shc_vaccination_validation_test'
+require_relative 'shc_vaccination_test_kit/metadata'
-module Covid19VCI
-  class Suite < Inferno::TestSuite
-    id 'c19-vci'
+module SHCVaccinationTestKit
+  class SHCVaccinationSuite < Inferno::TestSuite
+    id 'shc_vaccination'
     title 'SMART Health Cards: Vaccination & Testing'
+    description %(
+      This test suite evaluates the ability of a system to provide
+      access to [SMART Health Cards Vaccination and Testing](https://hl7.org/fhir/uv/shc-vaccination/2021Sep/index.html)
+      resources via file download, HL7® FHIR® API, or QR Scanning.
+    )
+    source_code_url('https://github.com/inferno-framework/shc-vaccination-test-kit')
+    download_url('https://github.com/inferno-framework/shc-vaccination-test-kit/releases')
+    report_issue_url('https://github.com/inferno-framework/shc-vaccination-test-kit/issues')
-    group from: :vci_file_download
-    group from: :vci_fhir_operation
+    VALIDATION_MESSAGE_FILTERS = [
+      /\A\S+: \S+: URL value '.*' does not resolve/,
+    ].freeze
+    fhir_resource_validator do
+      igs('igs/cards.smarthealth.terminology-0.1.0.tgz', 'igs/shc-vaccination-1.0.0-updated.tgz')
+      exclude_message do |message|
+        VALIDATION_MESSAGE_FILTERS.any? { |filter| filter.match? message.message }
+      end
+    end
+    scan_qr_code_html = File.read(File.join(__dir__, './shc_vaccination_test_kit/views/scan_qr_code.html'))
+    scan_qr_code_html_route_handler = proc { [200, { 'Content-Type' => 'text/html' }, [scan_qr_code_html]] }
+    route(:get, '/scan_qr_code', scan_qr_code_html_route_handler)
+    qr_scanner_route_handler = proc { [200, { 'Content-Type' => 'text/javascript' }, [qr_scanner]] }
+    route(:get, '/qr-scanner.min.js', qr_scanner_route_handler)
+    qr_scanner_worker = File.read(File.join(__dir__, './shc_vaccination_test_kit/javascript/qr-scanner-worker.min.js'))
+    qr_scanner_worker_route_handler = proc { [200, { 'Content-Type' => 'text/javascript' }, [qr_scanner_worker]] }
+    route(:get, '/qr-scanner-worker.min.js', qr_scanner_worker_route_handler)
+    js_qr = File.read(File.join(__dir__, './shc_vaccination_test_kit/javascript/jsQR.js'))
+    js_qr_route_handler = proc { [200, { 'Content-Type' => 'text/javascript' }, [js_qr]] }
+    route(:get, '/jsqr.js', js_qr_route_handler)
+    upload_html = File.read(File.join(__dir__, './shc_vaccination_test_kit/views/upload_qr_code.html'))
+    upload_html_route_handler = proc { [200, { 'Content-Type' => 'text/html' }, [upload_html]] }
+    route(:get, '/upload_qr_code', upload_html_route_handler)
+    # Tests and TestGroups
+    # SmartHealthCardsTestKit::SmartHealthCardsTestSuite.groups.each do |group|
+    #   test_group = group.ancestors[1]
+    #   test_group.children.reject! { |test| test.id.include?('shc_fhir_validation_test') }
+    #   test_group.test(from: :shc_vaccination_validation_test)
+    #   group(from: test_group.id)
+    # end
+    def self.add_shc_group(group_id)
+      group from: group_id do
+        children.reject! { |test| test.id.include?('shc_fhir_validation_test') }
+        test from: :shc_vaccination_validation_test
+      end
+    end
+    add_shc_group :shc_file_download_group
+    add_shc_group :shc_fhir_operation_group
+    add_shc_group :shc_qr_code_group
   end
 end

metadata CHANGED Viewed

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: shc_vaccination_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen MacVicar
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-28 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: health_cards
+  name: inferno_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
-  name: inferno_core
+  name: smart_health_cards_test_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner-sequel
   requirement: !ruby/object:Gem::Requirement
@@ -103,18 +103,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- lib/covid19_vci/fhir_operation.rb
-- lib/covid19_vci/file_download.rb
-- lib/covid19_vci/vc_fhir_validation.rb
-- lib/covid19_vci/vc_headers.rb
-- lib/covid19_vci/vc_payload_verification.rb
-- lib/covid19_vci/vc_signature_verification.rb
-- lib/covid19_vci/version.rb
 - lib/shc_vaccination_test_kit.rb
+- lib/shc_vaccination_test_kit/igs/README.md
+- lib/shc_vaccination_test_kit/igs/cards.smarthealth.terminology-0.1.0.tgz
+- lib/shc_vaccination_test_kit/igs/shc-vaccination-1.0.0-updated.tgz
+- lib/shc_vaccination_test_kit/javascript/jsQR.js
+- lib/shc_vaccination_test_kit/javascript/qr-scanner-worker.min.js
+- lib/shc_vaccination_test_kit/javascript/qr-scanner.min.js
+- lib/shc_vaccination_test_kit/metadata.rb
+- lib/shc_vaccination_test_kit/shc_vaccination_validation_test.rb
+- lib/shc_vaccination_test_kit/version.rb
+- lib/shc_vaccination_test_kit/views/scan_qr_code.html
+- lib/shc_vaccination_test_kit/views/upload_qr_code.html
 homepage: https://github.com/inferno-framework/shc-vaccination-test-kit
 licenses:
 - Apache-2.0
 metadata:
+  inferno_test_kit: 'true'
   homepage_uri: https://github.com/inferno-framework/shc-vaccination-test-kit
   source_code_uri: https://github.com/inferno-framework/shc-vaccination-test-kit
 post_install_message:
@@ -125,14 +130,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.3.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: 'A collection of tests for the SMART Health Cards: Vaccination & Testing

data/lib/covid19_vci/fhir_operation.rb DELETED Viewed

@@ -1,105 +0,0 @@
-require_relative 'vc_fhir_validation'
-require_relative 'vc_headers'
-require_relative 'vc_payload_verification'
-require_relative 'vc_signature_verification'
-module Covid19VCI
-  class FHIROperation < Inferno::TestGroup
-    id 'vci_fhir_operation'
-    title 'Download and validate a health card via FHIR $health-cards-issue operation'
-    input :base_fhir_url, :patient_id
-    fhir_client do
-      url :base_fhir_url
-    end
-    test do
-      title 'Server advertises health card support in its SMART configuration'
-      id 'vci-fhir-01'
-      run do
-        get("#{base_fhir_url}/.well-known/smart-configuration")
-        assert_response_status(200)
-        assert_valid_json(response[:body])
-        smart_configuration = JSON.parse(response[:body])
-        assert smart_configuration['capabilities']&.include?('health-cards'),
-               "SMART configuration does not list support for 'health-cards' capability"
-      end
-    end
-    test do
-      title 'Server advertises $health-cards-issue operation support in its CapabilityStatement'
-      id 'vci-fhir-02'
-      run do
-        fhir_get_capability_statement
-        assert_response_status(200)
-        operations = resource.rest&.flat_map do |rest|
-          rest.resource
-            &.select { |r| r.type == 'Patient' && r.respond_to?(:operation) }
-            &.flat_map(&:operation)
-        end&.compact
-        operation_defined = operations.any? { |operation| operation.name == 'health-cards-issue' }
-        assert operation_defined,
-               'Server CapabilityStatement did not declare support for $health-cards-issue operation ' \
-               'on the Patient resource.'
-      end
-    end
-    test do
-      title 'Server returns a health card from the $health-cards-issue operation'
-      id 'vci-fhir-03'
-      output :credential_strings
-      run do
-        request_params = FHIR::Parameters.new(
-          parameter: [
-            {
-              name: 'credentialType',
-              valueUri: 'https://smarthealth.cards#covid19'
-            }
-          ]
-        )
-        fhir_operation("/Patient/#{patient_id}/$health-cards-issue", body: request_params)
-        assert_response_status((200..207).to_a)
-        assert_resource_type(:parameters)
-        hc_parameters = resource.parameter.select { |parameter| parameter.name == 'verifiableCredential' }
-        assert hc_parameters.present?, 'No COVID-19 health cards were returned'
-        credential_strings = hc_parameters.map(&:value).join(',')
-        output credential_strings: credential_strings
-        count = hc_parameters.length
-        pass "#{count} verifiable #{'credential'.pluralize(count)} received"
-      end
-    end
-    test from: :vc_headers do
-      id 'vci-fhir-04'
-    end
-    test from: :vc_signature_verification do
-      id 'vci-fhir-05'
-    end
-    test from: :vc_payload_verification do
-      id 'vci-fhir-06'
-    end
-    test from: :vc_fhir_verification do
-      id 'vci-fhir-07'
-    end
-  end
-end