smart_health_cards_test_kit 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dcd02e218c20c7df4ac05da3a491653ea9cf69f8c2f86471407a68d0582bbd5
-  data.tar.gz: 801a9e6c1301ce4daf3c1a126e9a00537dd4871e7786f664f1591daeea7e43a0
+  metadata.gz: 51f6dab0372c9503ccc8799beabcf00a7d1a704ca4ea3a22571a36629ccd2721
+  data.tar.gz: '086956b67891836434dc0239778db343c1d562b2d6ab12b33078fd397ca7781a'
 SHA512:
-  metadata.gz: a45f4aead162a4ba9dfb363310eca1e36cc09a7c289e0f7659a06a19c2d4b3c1217b3c48269d858ba0c75af99ffc937081541075db7b93715a22b12ecda73c56
-  data.tar.gz: fb75562a3a42290e637434d3b96782e51d79081343b5c50722b9fbf912e90602d21eaf91e025fe01bbc22858d9c7953cc343cc5c3c6ac3e4ce3cfe424c47faf5
+  metadata.gz: a96c251549bb37ecc945d883d9bfe332bac72af5de889c700f5a0485aeef2cc8e50992a96cc9a699636d613dcb0aa0581fadad3449f8530bac7d94fc28ab640d
+  data.tar.gz: 98299d46294ac055880916481945d1316163c6d8e6a8bd2aa784de2281886c85dcc252434d570a8229c1f595068a129d1cd41c996c1f79aef749a317d509d5a0

data/lib/smart_health_cards_test_kit/metadata.rb

@@ -0,0 +1,55 @@
+require_relative 'version'
+
+module SmartHealthCardsTestKit
+  class Metadata < Inferno::TestKit
+    id :smart_health_cards
+    title 'SMART Health Cards'
+    description <<~DESCRIPTION
+      The SMART Health Cards Test Kit provides an
+      executable set of tests for the [SMART Health Cards Framework v1.4.0](https://spec.smarthealth.cards/).
+      This test kit simulates downloading and validating a SMART Health Card.
+      <!-- break -->
+
+      This test kit is [open source](https://github.com/inferno-framework/smart-health-cards-test-kit#license)
+      and freely available for use or adoption by the health IT community including EHR vendors, health app
+      developers, and testing labs. It is built using the [Inferno Framework](https://inferno-framework.github.io/inferno-core/).
+      The Inferno Framework is designed for reuse and aims to make it easier to build test kits for any
+      FHIR-based data exchange.
+
+      ## Status
+
+      These tests are intended to allow server implementers to perform checks of their server against SMART Health Cards Framework requrirements.
+
+      The test kit currently tests the following requirements:
+      - Download and validate a health card [via File Download](https://spec.smarthealth.cards/#via-file-download)
+      - Download and validate a health card [via FHIR $health-cards-issue Operation](https://spec.smarthealth.cards/#via-fhir-health-cards-issue-operation)
+      - Download and validate a health card [via QR Code](https://spec.smarthealth.cards/#via-qr-print-or-scan)
+
+      The test kit does **NOT** test this requirement:
+      - Download and validate a health card [via Deep Link](https://spec.smarthealth.cards/#via-deep-link)
+
+      See the test descriptions within the test kit for detail on the specific validations performed as part of testing these requirements.
+
+      ## Repository
+
+      The SMART Health Cards Test Kit GitHub repository can be [found here](https://github.com/inferno-framework/smart-health-cards-test-kit).
+
+      ## Providing Feedback and Reporting Issues
+
+      We welcome feedback on the tests, including but not limited to the following areas:
+
+      - Validation logic, such as potential bugs, lax checks, and unexpected failures.
+      - Requirements coverage, such as requirements that have been missed, tests that necessitate features that the IG does not require, or other issues with the interpretation of the IG's requirements.
+      - User experience, such as confusing or missing information in the test UI.
+
+      Please report any issues with this set of tests in the [issues section](https://github.com/inferno-framework/smart-health-cards-test-kit/issues) of the repository.
+    DESCRIPTION
+    suite_ids [:smart_health_cards]
+    tags ['SMART Health Cards']
+    last_updated LAST_UPDATED
+    version VERSION
+    maturity 'Low'
+    authors ['Yunwei Wang']
+    repo 'https://github.com/inferno-framework/smart-health-cards-test-kit'
+  end
+end

data/lib/smart_health_cards_test_kit/shc_fhir_validation.rb

@@ -7,33 +7,19 @@ module SmartHealthCardsTestKit
     description %(
       SMART Health Card payload SHALL be a valid FHIR Bundle resource
     )
-    input :credential_strings
-    output :fhir_bundles
+    input :fhir_bundles
 
     run do
+      skip_if fhir_bundles.blank?, 'No FHIR bundles received'
 
-      skip_if credential_strings.blank?, 'No Verifiable Credentials received'
-      bundle_array = []
+      assert_valid_json(fhir_bundles)
+      bundle_array = JSON.parse(fhir_bundles)
 
-      credential_strings.split(',').each do |credential|
-        jws = SmartHealthCardsTestKit::Utils::JWS.from_jws(credential)
-        payload = payload_from_jws(jws)
-
-        vc = payload['vc']
-        assert vc.is_a?(Hash), "Expected 'vc' claim to be a JSON object, but found #{vc.class}"
-
-        subject = vc['credentialSubject']
-        assert subject.is_a?(Hash), "Expected 'vc.credentialSubject' to be a JSON object, but found #{subject.class}"
-
-        raw_bundle = subject['fhirBundle']
-        assert raw_bundle.is_a?(Hash), "Expected 'vc.fhirBundle' to be a JSON object, but found #{raw_bundle.class}"
-
-        bundle = FHIR::Bundle.new(raw_bundle)
-        assert_valid_resource(resource: bundle)
-        bundle_array.append(bundle)
+      skip_if bundle_array.blank?, 'No FHIR bundles received'
 
+      bundle_array.each do |bundle|
+        assert_valid_resource(resource: FHIR::Bundle.new(bundle))
       end
-      output fhir_bundles: bundle_array
     end
   end
 end

data/lib/smart_health_cards_test_kit/shc_payload_verification.rb

@@ -33,11 +33,11 @@ module SmartHealthCardsTestKit
           (e.g., `{"patient": {"reference": "resource:0"}}`)
     )
     input :credential_strings
-    output :decompressed_payloads
+    output :fhir_bundles
 
     run do
       skip_if credential_strings.blank?, 'No Verifiable Credentials received'
-      decompressed_payload_array = []
+      fhir_bundles = []
 
       credential_strings.split(',').each do |credential|
         jws = SmartHealthCardsTestKit::Utils::JWS.from_jws(credential)
@@ -79,6 +79,9 @@ module SmartHealthCardsTestKit
                 "The following Bundle entry urls do not use short resource-scheme URIs: #{bad_urls.join(', ')}"
         end
 
+        # Have to make another copy of bundle to avoid being modified by the following codes
+        fhir_bundles.append(FHIR::Bundle.new(raw_bundle))
+
         bundle = FHIR::Bundle.new(raw_bundle)
         resources = bundle.entry.map(&:resource)
         bundle.entry.each { |entry| entry.resource = nil }
@@ -117,7 +120,8 @@ module SmartHealthCardsTestKit
           end
         end
       end
-      output decompressed_payloads: decompressed_payload_array
+
+      output fhir_bundles: fhir_bundles.to_json
     end
   end
 end

data/lib/smart_health_cards_test_kit/smart_health_cards_test_suite.rb

@@ -0,0 +1,85 @@
+require 'json'
+
+require_relative 'version'
+
+require_relative 'utils/jws'
+require_relative 'health_card'
+
+require_relative 'shc_fhir_validation'
+require_relative 'shc_header_verification'
+require_relative 'shc_payload_verification'
+require_relative 'shc_signature_verification'
+
+require_relative 'file_download_group'
+require_relative 'qr_code_group'
+require_relative 'fhir_operation_group'
+
+module SmartHealthCardsTestKit
+  class SmartHealthCardsTestSuite < Inferno::TestSuite
+    id :smart_health_cards
+    title 'SMART Health Cards'
+    description %(
+      The SMART Health Cards tests systems for their conformance to the
+      [SMART Health Cards Framework v1.4.0](https://spec.smarthealth.cards/)
+    )
+
+    links [
+      {
+        label: 'Report Issue',
+        url: 'https://github.com/inferno-framework/smart-health-cards-test-kit/issues'
+      },
+      {
+        label: 'Open Source',
+        url: 'https://github.com/inferno-framework/smart-health-cards-test-kit'
+      },
+      {
+        label: 'Download',
+        url: 'https://github.com/inferno-framework/smart-health-cards-test-kit/releases'
+      },
+      {
+        label: 'SMART Health Cards Framework',
+        url: 'https://spec.smarthealth.cards/'
+      }
+    ]
+
+    # All FHIR validation requsets will use this FHIR validator
+    fhir_resource_validator do
+      # igs 'identifier#version' # Use this method for published IGs/versions
+      # igs 'igs/filename.tgz'   # Use this otherwise
+
+      exclude_message do |message|
+        message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
+      end
+    end
+
+    # HTTP Routes
+    resume_test_route :post, '/post_qr_code' do |request|
+      request.query_parameters['id']
+    end
+
+    scan_qr_code_html = File.read(File.join(__dir__, './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 = File.read(File.join(__dir__, './javascript/qr-scanner.min.js'))
+    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__, './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__, './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__, './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
+    group from: :shc_file_download_group
+    group from: :shc_fhir_operation_group
+    group from: :shc_qr_code_group
+  end
+end

data/lib/smart_health_cards_test_kit/version.rb

@@ -1,3 +1,4 @@
 module SmartHealthCardsTestKit
-  VERSION = '0.9.0'
-end
+  VERSION = '0.10.1'.freeze
+  LAST_UPDATED = '2025-03-05'.freeze # TODO: update next release
+end

data/lib/smart_health_cards_test_kit.rb

@@ -1,67 +1,5 @@
-require 'json'
-
-require_relative 'smart_health_cards_test_kit/version'
-
-require_relative 'smart_health_cards_test_kit/utils/jws'
-require_relative 'smart_health_cards_test_kit/health_card'
-
-require_relative 'smart_health_cards_test_kit/shc_fhir_validation'
-require_relative 'smart_health_cards_test_kit/shc_header_verification'
-require_relative 'smart_health_cards_test_kit/shc_payload_verification'
-require_relative 'smart_health_cards_test_kit/shc_signature_verification'
-
-require_relative 'smart_health_cards_test_kit/file_download_group'
-require_relative 'smart_health_cards_test_kit/qr_code_group'
-require_relative 'smart_health_cards_test_kit/fhir_operation_group'
+require_relative 'smart_health_cards_test_kit/smart_health_cards_test_suite'
+require_relative 'smart_health_cards_test_kit/metadata'
 
 module SmartHealthCardsTestKit
-  class SmartHealthCardsTestSuite < Inferno::TestSuite
-    id :smart_health_cards
-    title 'SMART Health Cards'
-    description %(
-      The US Core Test Kit tests systems for their conformance to the
-      [SMART Health Cards Framework v1.4.0](https://spec.smarthealth.cards/)
-    )
-    version VERSION
-
-    # All FHIR validation requsets will use this FHIR validator
-    fhir_resource_validator do
-      # igs 'identifier#version' # Use this method for published IGs/versions
-      # igs 'igs/filename.tgz'   # Use this otherwise
-
-      exclude_message do |message|
-        message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
-      end
-    end
-
-    # HTTP Routes
-    resume_test_route :post, '/post_qr_code' do |request|
-      request.query_parameters['id']
-    end
-
-    scan_qr_code_html = File.read(File.join(__dir__, './smart_health_cards_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 = File.read(File.join(__dir__, './smart_health_cards_test_kit/javascript/qr-scanner.min.js'))
-    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__, './smart_health_cards_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__, './smart_health_cards_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__, './smart_health_cards_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
-    group from: :shc_file_download_group
-    group from: :shc_fhir_operation_group
-    group from: :shc_qr_code_group
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_health_cards_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Yunwei Wang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: rqrcode
   requirement: !ruby/object:Gem::Requirement
@@ -123,11 +123,13 @@ files:
 - lib/smart_health_cards_test_kit/javascript/jsQR.js
 - lib/smart_health_cards_test_kit/javascript/qr-scanner-worker.min.js
 - lib/smart_health_cards_test_kit/javascript/qr-scanner.min.js
+- lib/smart_health_cards_test_kit/metadata.rb
 - lib/smart_health_cards_test_kit/qr_code_group.rb
 - lib/smart_health_cards_test_kit/shc_fhir_validation.rb
 - lib/smart_health_cards_test_kit/shc_header_verification.rb
 - lib/smart_health_cards_test_kit/shc_payload_verification.rb
 - lib/smart_health_cards_test_kit/shc_signature_verification.rb
+- lib/smart_health_cards_test_kit/smart_health_cards_test_suite.rb
 - lib/smart_health_cards_test_kit/utils/chunking_utils.rb
 - lib/smart_health_cards_test_kit/utils/encoding.rb
 - lib/smart_health_cards_test_kit/utils/jws.rb
@@ -146,6 +148,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/inferno-framework/smart-health-cards-test-kit
   source_code_uri: https://github.com/inferno-framework/smart-health-cards-test-kit
+  inferno_test_kit: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -154,14 +157,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.5.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Smart Health Cards test kit