fhir_client 4.0.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d385c9e64810e036607e1da44bf1331df35398b1f9e43aedea8c7bb80e080ff0
-  data.tar.gz: 866d5929b2f4235976ed635a7ab0e795c2fe10903d7e13bfdf6f8a78d9ddc968
+  metadata.gz: 4f141904a0b942b381fa973636f64b7974741bc3abf997e947aea99bed7a16ed
+  data.tar.gz: '09d8ba15495194f29bc49b8928c066a72f40104f1efd61bc594c4a54de919ff2'
 SHA512:
-  metadata.gz: 2796ea338218119eb621b10122d2390abfc3447b384303a49eed9df8d45ab137561640c3bda7fd1ab7d8760866dc82f383640bb1dad83ad72dd893443d711400
-  data.tar.gz: 0b25a370025e1618bb00e508850d0f926d0544a0da1a392a2ecceea834ac6b59d38b32365e0328de503fbbd9b79e8f10bd0447d6c14bbeea34f3c77797ac79dd
+  metadata.gz: 4213d1b6dc0dd9e3252b78d79bf5b40afc5b58d0558c5bd88489468a97e16bc86dfce651def02436132671b8fba694c740bd643503363e6a2415fe365264fc6f
+  data.tar.gz: 936fb94723c149d1fa0d7984c6cb36deaac845787cf2d45bfe3c83bb11b8166b118b6286935a6f9643e6300042459a937edebd144b2919dee505311897cd4828

data/.github/workflows/ruby.yml

@@ -0,0 +1,26 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+    - name: Rubocop
+      run: bundle exec rubocop

data/README.md

@@ -151,9 +151,14 @@ client.destroy(FHIR::Patient, patient_id)
 
 ### Searching
 ```ruby
+# via GET
 reply = client.search(FHIR::Patient, search: {parameters: {name: 'P'}})
+
+# via POST
+reply = client.search(FHIR::Patient, search: {body: {name: 'P'}})
+
 bundle = reply.resource
-patient = bundle.entry.first.resource
+patient = bundle&.entry&.first&.resource
 ```
 
 ### Fetching a Bundle
@@ -215,7 +220,7 @@ end
 
 # License
 
-Copyright 2014-2019 The MITRE Corporation
+Copyright 2014-2022 The MITRE Corporation
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -19,8 +19,4 @@ task :rubocop do
   RuboCop::RakeTask.new
 end
 
-task test: [:rubocop] do
-  system('open coverage/index.html')
-end
-
 task default: [:test]

data/fhir_client.gemspec

@@ -6,8 +6,9 @@ require 'fhir_client/version'
 Gem::Specification.new do |spec|
   spec.name          = 'fhir_client'
   spec.version       = FHIR::Client::VERSION
-  spec.authors       = ['Andre Quina', 'Jason Walonoski', 'Janoo Fernandes']
+  spec.authors       = ['Andre Quina', 'Jason Walonoski', 'Robert Scanlon', 'Reece Adamson']
   spec.email         = ['jwalonoski@mitre.org']
+  spec.licenses      = ['Apache-2.0']
 
   spec.summary       = %q{A Gem for handling FHIR client requests in ruby}
   spec.description   = %q{A Gem for handling FHIR client requests in ruby}
@@ -22,9 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 3'
   spec.add_dependency 'addressable', '>= 2.3'
-  spec.add_dependency 'fhir_models', '>= 4.0.2'
-  spec.add_dependency 'fhir_stu3_models', '>= 3.0.1'
-  spec.add_dependency 'fhir_dstu2_models', '>= 1.0.10'
+  spec.add_dependency 'fhir_models', '>= 4.2.0'
+  spec.add_dependency 'fhir_stu3_models', '>= 3.1.0'
+  spec.add_dependency 'fhir_dstu2_models', '>= 1.1.0'
   spec.add_dependency 'nokogiri', '>= 1.10.4'
   spec.add_dependency 'oauth2', '~> 1.1'
   spec.add_dependency 'rack', '>= 1.5'
@@ -32,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tilt', '>= 1.1'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'test-unit'

data/lib/fhir_client.rb

@@ -3,6 +3,11 @@ require 'fhir_dstu2_models'
 require 'fhir_stu3_models'
 require 'active_support/all'
 
+# Default to INFO level logging for all FHIR namespaced logging. Since there is
+# no single gem that 'owns' the FHIR namespace, we use the client as the spot
+# to set the default. Otherwise the default is set to DEBUG, which is too high.
+FHIR.logger.level = Logger::INFO
+
 root = File.expand_path '.', File.dirname(File.absolute_path(__FILE__))
 Dir.glob(File.join(root, 'fhir_client', 'sections', '**', '*.rb')).each do |file|
   require file

data/lib/fhir_client/client.rb

@@ -315,36 +315,44 @@ module FHIR
     def parse_reply(klass, format, response)
       FHIR.logger.debug "Parsing response with {klass: #{klass}, format: #{format}, code: #{response.code}}."
       return nil unless [200, 201].include? response.code
-      res = nil
-      begin
-        res = if(@fhir_version == :dstu2 || klass&.ancestors&.include?(FHIR::DSTU2::Model))
-                if(format.include?('xml'))
-                  FHIR::DSTU2::Xml.from_xml(response.body)
-                else
-                  FHIR::DSTU2::Json.from_json(response.body)
-                end
-              elsif(@fhir_version == :r4 || klass&.ancestors&.include?(FHIR::Model))
-                if(format.include?('xml'))
-                  FHIR::Xml.from_xml(response.body)
-                else
-                  FHIR::Json.from_json(response.body)
-                end
-              else
-                if(format.include?('xml'))
-                  FHIR::STU3::Xml.from_xml(response.body)
-                else
-                  FHIR::STU3::Json.from_json(response.body)
-                end
-              end
-        res.client = self unless res.nil?
-        FHIR.logger.warn "Expected #{klass} but got #{res.class}" if res.class != klass
-      rescue => e
-        FHIR.logger.error "Failed to parse #{format} as resource #{klass}: #{e.message}"
-        res = nil
-      end
+      res =
+        begin
+          if(@fhir_version == :dstu2 || klass&.ancestors&.include?(FHIR::DSTU2::Model))
+            if(format.include?('xml'))
+              FHIR::DSTU2::Xml.from_xml(response.body)
+            else
+              FHIR::DSTU2::Json.from_json(response.body)
+            end
+          elsif(@fhir_version == :r4 || klass&.ancestors&.include?(FHIR::Model))
+            if(format.include?('xml'))
+              FHIR::Xml.from_xml(response.body)
+            else
+              FHIR::Json.from_json(response.body)
+            end
+          else
+            if(format.include?('xml'))
+              FHIR::STU3::Xml.from_xml(response.body)
+            else
+              FHIR::STU3::Json.from_json(response.body)
+            end
+          end
+        rescue => e
+          FHIR.logger.error "Failed to parse #{format} as resource #{klass}: #{e.message}"
+          nil
+        end
+      set_client_on_resource(res) unless res.nil?
       res
     end
 
+    def set_client_on_resource(resource)
+      return if resource.nil?
+
+      resource.client = self
+      resource.each_element do |element, _, _|
+        element.client = self if element.is_a?(Reference) || element.respond_to?(:resourceType)
+      end
+    end
+
     def strip_base(path)
       path.gsub(@base_service_url, '')
     end
@@ -375,6 +383,7 @@ module FHIR
     end
 
     # Extract the request payload in the specified format, defaults to XML
+    # Note that the payload is usually a resource, but could be a form post for searches depending on content type
     def request_payload(resource, headers)
       if headers
         format_specified = headers['Content-Type']
@@ -384,6 +393,10 @@ module FHIR
           resource.to_xml
         elsif format_specified.downcase.include?('json')
           resource.to_json
+        elsif format_specified.downcase == 'application/x-www-form-urlencoded'
+          # Special case where this is a search body and not a resource.
+          # Leave as hash because underlying libraries automatically URL encode it.
+          resource
         else
           resource.to_xml
         end
@@ -433,7 +446,7 @@ module FHIR
         begin
           response = @client.get(url, headers: headers)
         rescue => e
-          unless e.response
+          if !e.respond_to?(:response) || e.response.nil?
             # Re-raise the client error if there's no response. Otherwise, logging
             # and other things break below!
             FHIR.logger.error "GET - Request: #{url} failed! No response from server: #{e}"
@@ -480,7 +493,7 @@ module FHIR
           @reply = FHIR::ClientReply.new(req, res, self)
           return @reply
         rescue => e
-          unless e.response
+          if !e.respond_to?(:response) || e.response.nil?
             # Re-raise the client error if there's no response. Otherwise, logging
             # and other things break below!
             FHIR.logger.error "GET - Request: #{url} failed! No response from server: #{e}"
@@ -515,7 +528,7 @@ module FHIR
         begin
           response = @client.post(url, headers: headers, body: payload)
         rescue => e
-          unless e.response
+          if !e.respond_to?(:response) || e.response.nil?
             # Re-raise the client error if there's no response. Otherwise, logging
             # and other things break below!
             FHIR.logger.error "POST - Request: #{url} failed! No response from server: #{e}"
@@ -562,7 +575,7 @@ module FHIR
         begin
           response = @client.put(url, headers: headers, body: payload)
         rescue => e
-          unless e.response
+          if !e.respond_to?(:response) || e.response.nil?
             # Re-raise the client error if there's no response. Otherwise, logging
             # and other things break below!
             FHIR.logger.error "PUT - Request: #{url} failed! No response from server: #{e}"
@@ -609,7 +622,7 @@ module FHIR
         begin
           response = @client.patch(url, headers: headers, body: payload)
         rescue => e
-          unless e.response
+          if !e.respond_to?(:response) || e.response.nil?
             # Re-raise the client error if there's no response. Otherwise, logging
             # and other things break below!
             FHIR.logger.error "PATCH - Request: #{url} failed! No response from server: #{e}"
@@ -645,7 +658,7 @@ module FHIR
             @reply = FHIR::ClientReply.new(request.args, res, self)
           end
         rescue => e
-          unless e.response
+          if !e.respond_to?(:response) || e.response.nil?
             # Re-raise the client error if there's no response. Otherwise, logging
             # and other things break below!
             FHIR.logger.error "PATCH - Request: #{url} failed! No response from server: #{e}"
@@ -677,7 +690,7 @@ module FHIR
         begin
           response = @client.delete(url, headers: headers)
         rescue => e
-          unless e.response
+          if !e.respond_to?(:response) || e.response.nil?
             # Re-raise the client error if there's no response. Otherwise, logging
             # and other things break below!
             FHIR.logger.error "DELETE - Request: #{url} failed! No response from server: #{e}"

data/lib/fhir_client/ext/model.rb

@@ -2,17 +2,14 @@ module FHIR
   module ModelExtras
 
     def self.included base
-      base.send :include, InstanceMethods
+      base.include InstanceMethods
       base.extend ClassMethods
+      base.attr_writer :client
     end
 
     module InstanceMethods
       def client
-        FHIR::Model.client
-      end
-
-      def client=(client)
-        FHIR::Model.client = client
+        @client || FHIR::Model.client
       end
 
       def vread(version_id)
@@ -146,4 +143,4 @@ module FHIR
       include FHIR::ModelExtras
     end
   end
-end
+end

data/lib/fhir_client/sections/crud.rb

@@ -226,7 +226,7 @@ module FHIR
           resource.id = FHIR::ResourceAddress.pull_out_id(resource.class.name.demodulize, reply.self_link)
           reply.resource = resource # just send back the submitted resource
         end
-        reply.resource.client = self
+        set_client_on_resource(reply.resource)
         reply.resource_class = resource.class
         reply
       end

data/lib/fhir_client/sections/operations.rb

@@ -132,8 +132,11 @@ module FHIR
         add_resource_parameter(params, 'resource', resource)
         add_parameter(params, 'onlyCertainMatches', 'Boolean', options[:onlyCertainMatches]) unless options[:onlyCertainMatches].nil?
         add_parameter(params, 'count', 'Integer', options[:matchCount]) if options[:matchCount].is_a?(Integer)
-        post resource_url(options), params, fhir_headers({content_type: "#{format || @default_format}",
-                                                          accept: "#{format || @default_format}"})
+        post(
+          resource_url(options),
+          params,
+          fhir_headers({content_type: "#{format || @default_format}", accept: "#{format || @default_format}"})
+        ).tap { |reply| set_client_on_resource(reply.resource) }
       end
 
       #
@@ -154,7 +157,8 @@ module FHIR
         params = versioned_resource_class('Parameters').new
         add_resource_parameter(params, 'resource', resource)
         add_parameter(params, 'profile', 'Uri', options[:profile_uri]) unless options[:profile_uri].nil?
-        post resource_url(options), params, fhir_headers(headers)
+        post(resource_url(options), params, fhir_headers(headers))
+          .tap { |reply| set_client_on_resource(reply.resource) }
       end
 
       def validate_existing(resource, id, options = {}, format = @default_format)
@@ -165,7 +169,8 @@ module FHIR
         params = versioned_resource_class('Parameters').new
         add_resource_parameter(params, 'resource', resource)
         add_parameter(params, 'profile', 'Uri', options[:profile_uri]) unless options[:profile_uri].nil?
-        post resource_url(options), params, fhir_headers(headers)
+        post(resource_url(options), params, fhir_headers(headers))
+          .tap { |reply| set_client_on_resource(reply.resource) }
       end
 
       private

data/lib/fhir_client/sections/search.rb

@@ -12,40 +12,28 @@ module FHIR
         options[:resource] = klass
         options[:format] = format
 
-        reply = if options[:search] && options[:search][:flag]
-                  post resource_url(options), nil, fhir_headers({content_type: 'application/x-www-form-urlencoded'})
-                else
+        reply = if options.dig(:search, :flag) != true && options.dig(:search, :body).nil?
                   get resource_url(options), fhir_headers
+                else
+                  options[:search][:flag] = true
+                  post resource_url(options), options.dig(:search, :body), fhir_headers({content_type: 'application/x-www-form-urlencoded'})
                 end
-        # reply = get resource_url(options), fhir_headers(options)
+
         reply.resource = parse_reply(klass, format, reply)
         reply.resource_class = klass
         reply
       end
 
+      # It does not appear that this is part of the specification (any more?)
+      # Investigate removing in next major version.
       def search_existing(klass, id, options = {}, format = @default_format)
-        options.merge!(resource: klass, id: id, format: format)
-        # if options[:search][:flag]
-        reply = if options[:search] && options[:search][:flag]
-                  post resource_url(options), nil, fhir_headers({content_type: 'application/x-www-form-urlencoded'})
-                else
-                  get resource_url(options), fhir_headers
-                end
-        reply.resource = parse_reply(klass, format, reply)
-        reply.resource_class = klass
-        reply
+        options[:id] = id
+        search(klass, options, format)
       end
 
       def search_all(options = {}, format = @default_format)
         options[:format] = format
-        reply = if options[:search] && options[:search][:flag]
-                  post resource_url(options), nil, fhir_headers({content_type: 'application/x-www-form-urlencoded'})
-                else
-                  get resource_url(options), fhir_headers
-                end
-        reply.resource = parse_reply(nil, format, reply)
-        reply.resource_class = nil
-        reply
+        search(nil, options, format)
       end
     end
   end

data/lib/fhir_client/sections/transactions.rb

@@ -74,6 +74,7 @@ module FHIR
         rescue
           reply.resource = nil
         end
+        set_client_on_resource(reply.resource)
         reply.resource_class = reply.resource.class
         reply
       end

data/lib/fhir_client/version.rb

@@ -1,5 +1,5 @@
 module FHIR
   class Client
-    VERSION = '4.0.3'
+    VERSION = '5.0.0'.freeze
   end
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fhir_client
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 5.0.0
 platform: ruby
 authors:
 - Andre Quina
 - Jason Walonoski
-- Janoo Fernandes
-autorequire: 
+- Robert Scanlon
+- Reece Adamson
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,42 +47,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: fhir_stu3_models
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: fhir_dstu2_models
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -170,16 +171,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -247,11 +248,11 @@ files:
 - ".csslintrc"
 - ".eslintignore"
 - ".eslintrc"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".simplecov"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -283,9 +284,10 @@ files:
 - lib/fhir_client/version.rb
 - lib/fhir_client/version_management.rb
 homepage: https://github.com/fhir-crucible/fhir_client
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -300,8 +302,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: A Gem for handling FHIR client requests in ruby
 test_files: []

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-before_install:
-  - gem update --system
-  - gem install bundler
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rake test
-after_script:
-  - ./cc-test-reporter after-build -t simplecov --exit-code $TRAVIS_TEST_RESULT
-notifications:
-  email:
-    recipients:
-      - fhir-testing-list@lists.mitre.org
-    on_failure: change