hln_ice 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc821a0690dfaa750fb0dd36f1409a8a20054486318166f708bd8a266ff5c7a
-  data.tar.gz: 424486397d7ae838ee6af769155deef6a8b5bff76309291470a295c10eb58389
+  metadata.gz: 693ce96464262bed3bdbba9a9d38cc91aaaba9620c270e49994b4c0537c21b4d
+  data.tar.gz: 74711ef35d3caf83aa5b210ad0665b152275224fbc571349b686432d0fed0e10
 SHA512:
-  metadata.gz: 172c72400334ad1e9ca73b37fd7c77c7227386336e44e5d751c69d1bf40e021664ac0ceeeb835361924d6ddaff6cc0898420e07f5088fe72925821fdfa35bf11
-  data.tar.gz: 1ee834f1abd93c7cb9dc19453a7afd111a39f5745ad12d3d6345bae406805c9fb837fa3aacb80ecc03e9fe81c1cfe6d36d36b6790be2ed657aa0596e147f624d
+  metadata.gz: 6f47f5f31184385ebf20e319a415720094a792fe2e91b3e35218771e7ff15f80ecac1956771eab2bbd773c820ae2e54b5df6dc774f1bffc97786ad7814419918
+  data.tar.gz: ac317607ab177277cba5c32c458d3f5ddb583a6e84f0e98ab70d774128986db2c393d1a2d783f50386d93ae74ad0800967443024f20a93cd5f6e0a9eedaa9405

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-07-02
+
+- Stop logging PHI by default. The ICE input data, generated request XML, and raw service response are no longer logged unless the new `log_payloads:` option is set to `true`. Warnings and errors are still logged.
+- The service response is now logged at `debug` (was `info`), matching the input data and generated XML, so all payload logging behaves uniformly and stays out of `info`-level logs.
+
 ## [0.1.0] - 2026-06-22
 
 - Initial release

data/README.md

@@ -49,6 +49,7 @@ All options:
 | `max_retries:`| `3`                      | Number of retries on a failed evaluation request.     |
 | `retry_delay:`| `1`                      | Seconds to wait between retries.                      |
 | `logger:`     | `Logger.new($stdout)`    | Any `Logger`-compatible object. In Rails, pass `Rails.logger`. |
+| `log_payloads:`| `false`                 | When `true`, logs the ICE input data, generated request XML, and raw service response. These contain patient PHI, so keep this off outside local debugging. |
 
 ```ruby
 # In a Rails app, reuse the application logger:

data/hln_ice.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/hln_ice/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "hln_ice"
+  spec.version = HlnIce::VERSION
+  spec.authors = ["Sam Sohn"]
+  spec.email = ["sam@primary.health"]
+
+  spec.summary = "Ruby client for the HLN ICE (Immunization Calculation Engine) OpenCDS service."
+  spec.description = "Evaluates a patient's immunization history against the HLN ICE forecasting " \
+                     "rules and returns both the raw recommendations and a simplified status mapping."
+  spec.homepage = "https://github.com/PrimaryDotHealth/hln_ice"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "base64", "~> 0.2"
+  spec.add_dependency "httparty", "~> 0.21"
+  spec.add_dependency "nokogiri", "~> 1.15"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/hln_ice/client.rb

@@ -37,14 +37,18 @@ module HlnIce
       "Varicella Vaccine Group" => :var,
     }.freeze
 
-    attr_reader :base_url, :timeout, :max_retries, :retry_delay, :logger
+    attr_reader :base_url, :timeout, :max_retries, :retry_delay, :logger, :log_payloads
 
-    def initialize(base_url:, timeout: 30, max_retries: 3, retry_delay: 1, logger: nil)
+    # log_payloads: when false (default), the ICE input data, generated request
+    # XML, and raw service response are NOT logged. These contain patient PHI, so
+    # logging stays off unless a caller explicitly opts in (e.g. local debugging).
+    def initialize(base_url:, timeout: 30, max_retries: 3, retry_delay: 1, logger: nil, log_payloads: false)
       @base_url = base_url
       @timeout = timeout
       @max_retries = max_retries
       @retry_delay = retry_delay
       @logger = logger || Logger.new($stdout)
+      @log_payloads = log_payloads
     end
 
     # Check if the ICE service is available
@@ -127,7 +131,7 @@ module HlnIce
         gender = "U" if blank?(gender) # Set default to 'U' if blank
 
         # Log input data for debugging
-        logger.debug("ICE Input Data: #{JSON.pretty_generate(patient_data)}")
+        logger.debug("ICE Input Data: #{JSON.pretty_generate(patient_data)}") if log_payloads
 
         # Build the VMR XML
         xml_payload = <<~XML
@@ -196,7 +200,7 @@ module HlnIce
         XML
 
         # Log the generated XML for debugging
-        logger.debug("Generated ICE XML: #{xml_payload}")
+        logger.debug("Generated ICE XML: #{xml_payload}") if log_payloads
 
         # Base64 encode the XML
         base64_encoded_payload = Base64.strict_encode64(xml_payload)
@@ -245,7 +249,7 @@ module HlnIce
       end
 
       def parse_ice_response(response_body)
-        logger.info("ICE service response: #{response_body}")
+        logger.debug("ICE service response: #{response_body}") if log_payloads
 
         result = JSON.parse(response_body)
 

data/lib/hln_ice/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HlnIce
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hln_ice
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Sohn
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -66,6 +65,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- hln_ice.gemspec
 - lib/hln_ice.rb
 - lib/hln_ice/client.rb
 - lib/hln_ice/version.rb
@@ -78,7 +78,6 @@ metadata:
   homepage_uri: https://github.com/PrimaryDotHealth/hln_ice
   source_code_uri: https://github.com/PrimaryDotHealth/hln_ice
   changelog_uri: https://github.com/PrimaryDotHealth/hln_ice/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.15
 specification_version: 4
 summary: Ruby client for the HLN ICE (Immunization Calculation Engine) OpenCDS service.
 test_files: []