davinci_pas_test_kit 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adbcd07bb5f1a40e3ca790bab8009a1d905f444a22fee717fe06a2630e9360f4
-  data.tar.gz: 1b3ec155956da7225994cb43a1d4cbaaf73ebc988e25b9ef1acdf375cc917026
+  metadata.gz: c4814f5a03b2688fac37d470bfa033640ba717a566897bf1d037c618cd404a66
+  data.tar.gz: 7d346d15fcbac4c5032263ed40da6ae018792cbbc9c5dd2589cbb0eee193897f
 SHA512:
-  metadata.gz: 9f0e290e3d5c5af6f5263d23f78b69d4d9f017ea5452ebf56602361b57e7c22e1ff5cfa63f5bbbbc06541ddb66a031373a65699c6b6ff5ac0026038ce1633678
-  data.tar.gz: 10d76ce494d9cfd1aee463b25a04624b8556f1f80f99b175a2b4c1e00a7e6f8c31bb1a5844b83688df0ac3f86e80e02465f9791ea657c82651e5b6761e97e221
+  metadata.gz: 99ad90a6c99758c1bcc61d0d67529676c4a63f328e73ec527bd5b429e5509d0133848a884220dc7e82a064c229879eff7a42233966a4ff254dd2f41a9eb3bf4b
+  data.tar.gz: 9fe9a036b193b5a201515881a40f657325a0535730c89a70c32acdc936eb6c9210d93b698393aff135eb25a309f27e583073b0f5f90789469f6b152a0e2f0cda

data/lib/davinci_pas_test_kit/client_suite.rb

@@ -1,10 +1,8 @@
-require_relative 'ext/inferno_core/record_response_route'
-require_relative 'ext/inferno_core/runnable'
-require_relative 'ext/inferno_core/request'
 require_relative 'validator_suppressions'
 require_relative 'tags'
 require_relative 'urls'
-require_relative 'mock_server'
+require_relative 'endpoints/claim_endpoint'
+require_relative 'endpoints/token_endpoint'
 require_relative 'custom_groups/v2.0.1/pas_client_authentication_group'
 require_relative 'custom_groups/v2.0.1/pas_client_approval_group'
 require_relative 'custom_groups/v2.0.1/pas_client_denial_group'
@@ -15,8 +13,6 @@ require_relative 'version'
 
 module DaVinciPASTestKit
   class ClientSuite < Inferno::TestSuite
-    extend MockServer
-
     id :davinci_pas_client_suite_v201
     title 'Da Vinci PAS Client Suite v2.0.1'
     version VERSION
@@ -37,10 +33,6 @@ module DaVinciPASTestKit
       }
     ]
 
-    def self.test_resumes?(test)
-      !test.config.options[:accepts_multiple_requests]
-    end
-
     fhir_resource_validator do
       igs 'hl7.fhir.us.davinci-pas#2.0.1'
 
@@ -51,26 +43,16 @@ module DaVinciPASTestKit
       end
     end
 
-    record_response_route :post, TOKEN_PATH, AUTH_TAG, method(:token_response) do |request|
-      ClientSuite.extract_client_id(request)
-    end
-
-    record_response_route :post, SUBMIT_PATH, SUBMIT_TAG, method(:claim_response),
-                          resumes: method(:test_resumes?) do |request|
-      ClientSuite.extract_bearer_token(request)
-    end
-
-    record_response_route :post, INQUIRE_PATH, INQUIRE_TAG, method(:claim_response),
-                          resumes: method(:test_resumes?) do |request|
-      ClientSuite.extract_bearer_token(request)
-    end
+    suite_endpoint :post, TOKEN_PATH, TokenEndpoint
+    suite_endpoint :post, SUBMIT_PATH, ClaimEndpoint
+    suite_endpoint :post, INQUIRE_PATH, ClaimEndpoint
 
     resume_test_route :get, RESUME_PASS_PATH do |request|
-      ClientSuite.extract_token_from_query_params(request)
+      request.query_parameters['token']
     end
 
     resume_test_route :get, RESUME_FAIL_PATH, result: 'fail' do |request|
-      ClientSuite.extract_token_from_query_params(request)
+      request.query_parameters['token']
     end
 
     group from: :pas_client_v201_authentication_group

data/lib/davinci_pas_test_kit/{mock_server.rb → endpoints/claim_endpoint.rb}

@@ -1,38 +1,35 @@
-require_relative 'user_input_response'
+require_relative '../user_input_response'
 
 module DaVinciPASTestKit
-  # Serve responses to PAS requests
-  #
-  # Note that there are numerous expected validation issues that can safely be ignored.
-  # See here for full list: https://hl7.org/fhir/us/davinci-pas/STU2/qa.html#suppressed
-  module MockServer
-    def token_response(request, _test = nil, _test_result = nil)
-      # Placeholder for a more complete mock token endpoint
-      request.response_body = { access_token: SecureRandom.hex, token_type: 'bearer', expires_in: 300 }.to_json
-      request.status = 200
+  class ClaimEndpoint < Inferno::DSL::SuiteEndpoint
+    def test_run_identifier
+      request.headers['authorization']&.delete_prefix('Bearer ')
     end
 
-    def claim_response(request, test = nil, test_result = nil)
-      request.status = 200
-      request.response_headers = { 'Content-Type': 'application/json' }
+    def tags
+      [operation == 'submit' ? SUBMIT_TAG : INQUIRE_TAG]
+    end
+
+    def make_response
+      response.status = 200
+      response.format = :json
 
-      user_inputted_response = UserInputResponse.user_inputted_response(test, test_result)
-      if test.present? && test_result.present? && user_inputted_response.present?
-        request.response_body = user_inputted_response
+      user_inputted_response = UserInputResponse.user_inputted_response(test, result)
+      if user_inputted_response.present?
+        response.body = user_inputted_response
         return
       end
 
-      operation = request&.url&.split('$')&.last
-      req_bundle = FHIR.from_contents(request&.request_body)
+      req_bundle = FHIR.from_contents(request.body.string)
       claim_entry = req_bundle&.entry&.find { |e| e&.resource&.resourceType == 'Claim' }
       claim_full_url = claim_entry&.fullUrl
       if claim_entry.blank? || claim_full_url.blank?
-        handle_missing_required_elements(claim_entry, request)
+        handle_missing_required_elements(claim_entry, response)
         return
       end
 
       root_url = base_url(claim_full_url)
-      claim_response = mock_claim_response(claim_entry.resource, req_bundle, operation, root_url)
+      claim_response = mock_claim_response(claim_entry.resource, req_bundle, root_url)
 
       res_bundle = FHIR::Bundle.new(
         id: SecureRandom.uuid,
@@ -51,16 +48,20 @@ module DaVinciPASTestKit
 
       res_bundle.entry.concat(referenced_entities(claim_response, req_bundle.entry, root_url))
 
-      request.response_body = res_bundle.to_json
-      request.status = 200
-      request.response_headers = { 'Content-Type': 'application/json' }
+      response.body = res_bundle.to_json
     end
 
+    def update_result
+      results_repo.update_result(result.id, 'pass') unless test.config.options[:accepts_multiple_requests]
+    end
+
+    private
+
     # Note that references from the claim to other resources in the bundle need to be changed to absolute URLs
     # if they are relative, because the ClaimResponse's fullUrl is a urn:uuid
     #
     # @private
-    def mock_claim_response(claim, bundle, operation, root_url)
+    def mock_claim_response(claim, bundle, root_url)
       return FHIR::ClaimResponse.new(id: SecureRandom.uuid) if claim.blank?
 
       now = Time.now.utc
@@ -128,33 +129,23 @@ module DaVinciPASTestKit
       )
     end
 
-    def extract_client_id(request)
-      URI.decode_www_form(request.request_body).to_h['client_id']
-    end
-
-    # Header expected to be a bearer token of the form "Bearer: <token>"
-    def extract_bearer_token(request)
-      request.request_header('Authorization')&.value&.split&.last
-    end
-
-    def extract_token_from_query_params(request)
-      request.query_parameters['token']
-    end
-
-    def handle_missing_required_elements(claim_entry, request)
-      request.status = 400
-      request.response_headers = { 'Content-Type': 'application/json' }
+    def handle_missing_required_elements(claim_entry, response)
+      response.status = 400
       details = if claim_entry.blank?
                   'Required Claim entry missing from bundle'
                 else
                   'Required element fullUrl missing from Claim entry'
                 end
-      request.response_body = FHIR::OperationOutcome.new(
+      response.body = FHIR::OperationOutcome.new(
         issue: FHIR::OperationOutcome::Issue.new(severity: 'fatal', code: 'required',
                                                  details: FHIR::CodeableConcept.new(text: details))
       ).to_json
     end
 
+    def operation
+      request.url&.split('$')&.last
+    end
+
     # Drop the last two segments of a URL, i.e. the resource type and ID of a FHIR resource
     # e.g. http://example.org/fhir/Patient/123 -> http://example.org/fhir
     # @private
@@ -165,7 +156,6 @@ module DaVinciPASTestKit
       url.sub(%r{/[^/]*/[^/]*(/)?\z}, '')
     end
 
-    # @private
     def referenced_entities(resource, entries, root_url)
       matches = []
       attributes = resource&.source_hash&.keys
@@ -185,21 +175,18 @@ module DaVinciPASTestKit
       matches
     end
 
-    # @private
     def absolute_reference(ref, entries, root_url)
       url = find_matching_entry(ref&.reference, entries, root_url)&.fullUrl
       ref.reference = url if url
       ref
     end
 
-    # @private
     def find_matching_entry(ref, entries, root_url = '')
       ref = "#{root_url}/#{ref}" if relative_reference?(ref) && root_url&.present?
 
       entries&.find { |entry| entry&.fullUrl == ref }
     end
 
-    # @private
     def relative_reference?(ref)
       ref&.count('/') == 1
     end

data/lib/davinci_pas_test_kit/endpoints/token_endpoint.rb

@@ -0,0 +1,22 @@
+module DaVinciPASTestKit
+  class TokenEndpoint < Inferno::DSL::SuiteEndpoint
+    def test_run_identifier
+      URI.decode_www_form(request.body.string).to_h['client_id']
+    end
+
+    def tags
+      [AUTH_TAG]
+    end
+
+    def make_response
+      # Placeholder for a more complete mock token endpoint
+      response.status = 200
+      response.format = :json
+      response.body = { access_token: SecureRandom.hex, token_type: 'bearer', expires_in: 300 }.to_json
+    end
+
+    def update_result
+      results_repo.update_result(result.id, 'pass')
+    end
+  end
+end

data/lib/davinci_pas_test_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DaVinciPASTestKit
-  VERSION = '0.11.0'
+  VERSION = '0.11.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: davinci_pas_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Inferno Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -120,9 +120,8 @@ files:
 - lib/davinci_pas_test_kit/custom_groups/v2.0.1/pas_error_group.rb
 - lib/davinci_pas_test_kit/docs/client_suite_description_v201.md
 - lib/davinci_pas_test_kit/docs/server_suite_description_v201.md
-- lib/davinci_pas_test_kit/ext/inferno_core/record_response_route.rb
-- lib/davinci_pas_test_kit/ext/inferno_core/request.rb
-- lib/davinci_pas_test_kit/ext/inferno_core/runnable.rb
+- lib/davinci_pas_test_kit/endpoints/claim_endpoint.rb
+- lib/davinci_pas_test_kit/endpoints/token_endpoint.rb
 - lib/davinci_pas_test_kit/fhir_resource_navigation.rb
 - lib/davinci_pas_test_kit/generated/v2.0.1/beneficiary/client_inquire_request_beneficiary_must_support_test.rb
 - lib/davinci_pas_test_kit/generated/v2.0.1/beneficiary/client_submit_request_beneficiary_must_support_test.rb
@@ -248,7 +247,6 @@ files:
 - lib/davinci_pas_test_kit/generator/validation_test_generator.rb
 - lib/davinci_pas_test_kit/generator/value_extractor.rb
 - lib/davinci_pas_test_kit/igs/README.md
-- lib/davinci_pas_test_kit/mock_server.rb
 - lib/davinci_pas_test_kit/must_support_test.rb
 - lib/davinci_pas_test_kit/pas_bundle_validation.rb
 - lib/davinci_pas_test_kit/tags.rb

data/lib/davinci_pas_test_kit/ext/inferno_core/record_response_route.rb

@@ -1,98 +0,0 @@
-require 'hanami/controller'
-
-module Inferno
-  module DSL
-    # A base class for creating routes with custom response logic. Requests and responses are tagged and saved.
-    # @private
-    # @see Inferno::DSL::Runnable#resume_test_route
-    class RecordResponseRoute < Hanami::Action
-      include Import[
-                requests_repo: 'inferno.repositories.requests',
-                results_repo: 'inferno.repositories.results',
-                test_runs_repo: 'inferno.repositories.test_runs',
-                tests_repo: 'inferno.repositories.tests'
-              ]
-
-      def self.call(...)
-        new.call(...)
-      end
-
-      # @private
-      def test_run_identifier_block
-        self.class.singleton_class.instance_variable_get(:@test_run_identifier_block)
-      end
-
-      # @private
-      def build_response_block
-        self.class.singleton_class.instance_variable_get(:@build_response_block)
-      end
-
-      # @private
-      def tags
-        self.class.singleton_class.instance_variable_get(:@tags)
-      end
-
-      # @private
-      def resumes?(test)
-        instance_exec(test, &self.class.singleton_class.instance_variable_get(:@resumes))
-      end
-
-      # @private
-      def find_test_run(test_run_identifier)
-        test_runs_repo.find_latest_waiting_by_identifier(test_run_identifier)
-      end
-
-      # @private
-      def find_waiting_result(test_run)
-        results_repo.find_waiting_result(test_run_id: test_run.id)
-      end
-
-      # @private
-      def update_result(waiting_result)
-        results_repo.update_result(waiting_result.id, 'pass')
-      end
-
-      # @private
-      def persist_request(request, test_run, waiting_result, test)
-        requests_repo.create(
-          request.to_hash.merge(
-            test_session_id: test_run.test_session_id,
-            result_id: waiting_result.id,
-            name: test.config.request_name(test.incoming_request_name),
-            tags:
-          )
-        )
-      end
-
-      # @private
-      def find_test(waiting_result)
-        tests_repo.find(waiting_result.test_id)
-      end
-
-      # @private
-      def handle(req, res)
-        request = Inferno::Entities::Request.from_hanami_request(req)
-
-        test_run_identifier = instance_exec(request, &test_run_identifier_block)
-
-        test_run = find_test_run(test_run_identifier)
-
-        halt 500, "Unable to find test run with identifier '#{test_run_identifier}'." if test_run.nil?
-
-        waiting_result = find_waiting_result(test_run)
-        test = find_test(waiting_result)
-
-        test_runs_repo.mark_as_no_longer_waiting(test_run.id) if resumes? test
-
-        update_result(waiting_result) if resumes? test
-
-        instance_exec(request, test, waiting_result, &build_response_block)
-
-        Inferno::Entities::Request.to_hanami_response(request, res)
-        persist_request(request, test_run, waiting_result, test)
-
-        Jobs.perform(Jobs::ResumeTestRun, test_run.id) if resumes? test
-      end
-    end
-  end
-end

data/lib/davinci_pas_test_kit/ext/inferno_core/request.rb

@@ -1,19 +0,0 @@
-module Inferno
-  module Entities
-    class Request
-      def self.to_hanami_response(request, response)
-        response.status = request.status
-        response.body = request.response_body
-        request.response_headers.each do |header|
-          response.headers[header.name] = header.value
-        end
-
-        response
-      end
-
-      def response_headers=(headers_hash)
-        headers.concat(headers_hash.map { |key, value| Header.new(name: key.to_s, value:, type: 'response') })
-      end
-    end
-  end
-end

data/lib/davinci_pas_test_kit/ext/inferno_core/runnable.rb

@@ -1,18 +0,0 @@
-require_relative 'record_response_route'
-
-module Inferno
-  module DSL
-    module Runnable
-      def record_response_route(method, path, tags, build_response, resumes: ->(_) { true }, &block)
-        route_class = Class.new(Inferno::DSL::RecordResponseRoute) do |klass|
-          klass.singleton_class.instance_variable_set(:@build_response_block, build_response)
-          klass.singleton_class.instance_variable_set(:@test_run_identifier_block, block)
-          klass.singleton_class.instance_variable_set(:@tags, Array.wrap(tags))
-          klass.singleton_class.instance_variable_set(:@resumes, resumes)
-        end
-
-        route(method, path, route_class)
-      end
-    end
-  end
-end