mahis-dde 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7505492de7f9f3257c9b711cf894ec77cf708fee5562d060c415e341caf2ad65
+  data.tar.gz: 322ae74b18e2f6e1c73b48a0c5bed16374c945172370388e982b8c327c621a21
+SHA512:
+  metadata.gz: 4896294257cd71d17c9a60841643dce73f2c7a72bd7f882984ba6db1687399f1141cfacd98aa7c78fc1f56c5a97b07614769755ec3106cdf1748583f15b4516a
+  data.tar.gz: 6b079c31529e9cec84a2e90a5fda87e1756c642a0c5f9568ff9401ca96b91d97ea1352046f7848e1d5300115dbd0c86bf1a423b639ec4d94b33a55c172150710

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 bryan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+# Dde
+DDE stands for Demographics Data Exchange. Its main purpose is to manage patient IDs
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dde', git: 'https://github.com/Malawi-Ministry-of-Health/dde-client', branch: 'main'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/dde_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/dde .css

data/app/assets/stylesheets/dde/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/dde/api/v1/dde_controller.rb

@@ -0,0 +1,92 @@
+class Dde::Api::V1::DdeController < ApplicationController
+  # GET /dde/patients
+  def find_patients_by_npid
+    npid = params.require(:npid)
+    render json: service.find_patients_by_npid(npid)
+  end
+
+  def find_patients_by_name_and_gender
+    given_name, family_name, gender = params.require(%i[given_name family_name gender])
+    render json: service.find_patients_by_name_and_gender(given_name, family_name, gender)
+  end
+
+  def import_patients_by_npid
+    npid = params.require(:npid)
+    render json: service.import_patients_by_npid(npid)
+  end
+
+  def import_patients_by_doc_id
+    doc_id = params.require(:doc_id)
+    render json: service.import_patients_by_doc_id(doc_id)
+  end
+
+  def remaining_npids
+    render json: service.remaining_npids
+  end
+
+  # GET /api/v1/dde/match
+  #
+  # Returns Dde patients matching demographics passed
+  def match_patients_by_demographics
+    render json: service.match_patients_by_demographics(
+      given_name: match_params[:given_name],
+      family_name: match_params[:family_name],
+      gender: match_params[:gender],
+      birthdate: match_params[:birthdate],
+      home_traditional_authority: match_params[:home_traditional_authority],
+      home_district: match_params[:home_district],
+      home_village: match_params[:home_village]
+    )
+  end
+
+  def reassign_patient_npid
+    patient_ids = params.permit(:doc_id, :patient_id)
+    render json: service.reassign_patient_npid(patient_ids)
+  end
+
+  def merge_patients
+    primary_patient_ids = params.require(:primary)
+    secondary_patient_ids_list = params.require(:secondary)
+
+    render json: service.merge_patients(primary_patient_ids, secondary_patient_ids_list)
+  end
+
+  def patient_diff
+    patient_id = params.require(:patient_id)
+    diff = service.find_patient_updates(patient_id)
+
+    render json: { diff: diff }
+  end
+
+  ##
+  # Updates local patient with demographics in Dde.
+  def refresh_patient
+    patient_id = params.require(:patient_id)
+    update_npid = params[:update_npid]&.casecmp?('true') || false
+
+    patient = service.update_local_patient(Patient.find(patient_id), update_npid: update_npid)
+
+    render json: patient
+  end
+
+  private
+
+  MATCH_PARAMS = %i[given_name family_name gender birthdate home_village
+                    home_traditional_authority home_district].freeze
+
+  def match_params
+    MATCH_PARAMS.each_with_object({}) do |param, params_hash|
+      raise "param #{param} is required" if params[param].blank?
+
+      params_hash[param] = params[param]
+    end
+  end
+
+  def service
+    Dde::DdeService.new(visit_type: visit_type)
+  end
+
+  def visit_type
+    Program.find(params.require(:visit_type_id))
+  end
+end

data/app/controllers/dde/api/v1/rollback_controller.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# controller for managing merge rollback
+class Api::V1::RollbackController < ApplicationController
+  def merge_history
+    identifier = params.require(:identifier)
+    render json: merge_service.get_patient_audit(identifier), status: :ok
+  end
+
+  def rollback_patient
+    patient_id = params.require(:patient_id)
+    visit_type_id = params.require(:visit_type_id)
+    render json: rollback_service.rollback_merged_patient(patient_id, visit_type_id), status: :ok
+  end
+
+  private
+
+  def merge_service
+    MergeAuditService.new
+  end
+
+  def rollback_service
+    RollbackService.new
+  end
+end

data/app/controllers/dde/application_controller.rb

@@ -0,0 +1,4 @@
+module Dde
+  class ApplicationController < ActionController::API
+  end
+end

data/app/helpers/dde/application_helper.rb

@@ -0,0 +1,4 @@
+module Dde
+  module ApplicationHelper
+  end
+end

data/app/jobs/dde/application_job.rb

@@ -0,0 +1,4 @@
+module Dde
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/dde/application_mailer.rb

@@ -0,0 +1,6 @@
+module Dde
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/dde/application_record.rb

@@ -0,0 +1,5 @@
+module Dde
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/services/dde/dde_client.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'restclient'
+
+class Dde::DdeClient
+  def initialize
+    @auto_login = true # If logged out, automatically login on next request
+    @base_url = nil
+    @connection = nil
+  end
+
+  # Connect to Dde Web Service using either a configuration file
+  # or an old Connection.
+  #
+  # @return A Connection object that can be used to re-connect to Dde
+  def connect(url:, username:, password:)
+    @connection = establish_connection(url: url, username: username, password: password)
+  end
+
+  # Reconnect to Dde using previous connection
+  #
+  # @see: DdeClient#connect
+  def restore_connection(connection)
+    @connection = reload_connection(connection)
+  end
+
+  def get(resource)
+    exec_request resource do |url, headers|
+      RestClient.get url, headers
+    end
+  end
+
+  def post(resource, data)
+    exec_request resource do |url, headers|
+      RestClient.post url, data.to_json, headers
+    end
+  end
+
+  def put(resource, data)
+    exec_request resource do |url, headers|
+      RestClient.put url, data.to_json, headers
+    end
+  end
+
+  def delete(resource)
+    exec_request resource do |url, headers|
+      RestClient.delete url, headers
+    end
+  end
+
+  private
+
+  JSON_CONTENT_TYPE = 'application/json'
+  LOGGER = Logger.new(STDOUT)
+  Dde_API_KEY_VALIDITY_PERIOD = 3600 * 12
+  Dde_VERSION = 'v1'
+
+  # Reload old connection to Dde
+  def reload_connection(connection)
+    LOGGER.debug 'Loading Dde connection'
+    if connection[:expires] < Time.now
+      LOGGER.debug 'Dde connection expired'
+      establish_connection(connection[:config])
+    else
+      @base_url = connection[:config][:url]
+      connection
+    end
+  end
+
+  # Establish a connection to Dde
+  #
+  # NOTE: This simply involves logging into Dde
+  def establish_connection(url:, username:, password:)
+    LOGGER.debug 'Establishing new connection to Dde from configuration'
+
+    # Block any automatic logins when processing request to avoid infinite loop
+    # in request execution below... Under normal circumstances request execution
+    # will attempt a login if 401 is met. Not pretty, I know but it does the job
+    # for now!!!
+    @auto_login = false
+
+    # HACK: Globally save base_url as a connection object may not currently
+    # be available to the build_url method right now
+    @base_url = url
+
+    response, status = post('login', username: username, password: password)
+
+    @auto_login = true
+
+    if status != 200
+      raise StandardError, "Unable to establish connection to Dde: #{response}"
+    end
+
+    LOGGER.info('Connection to Dde established :)')
+    @connection = {
+      key: response['access_token'],
+      expires: Time.now + Dde_API_KEY_VALIDITY_PERIOD,
+      config: { url: url, username: username, password: password }
+    }
+  end
+
+  # Returns a URI object with API host attached
+  def build_uri(resource)
+    "#{@base_url}/#{Dde_VERSION}/#{resource}"
+  end
+
+  def headers
+    {
+      'Content-type' => JSON_CONTENT_TYPE,
+      'Authorization' => @connection ? @connection[:key] : nil
+    }
+  end
+
+  def exec_request(resource)
+    LOGGER.debug "Executing Dde request (#{resource})"
+    response = yield build_uri(resource), headers
+    LOGGER.debug "Handling Dde response:\n\tStatus - #{response.code}\n\tBody - #{response.body}"
+    handle_response response
+  rescue RestClient::Unauthorized => e
+    LOGGER.error "DdeClient suppressed exception: #{e}"
+    return handle_response e.response unless @auto_login
+
+    LOGGER.debug 'Auto-logging into Dde...'
+    establish_connection(@connection[:config])
+    LOGGER.debug "Reset connection: #{@connection}"
+    retry # Retry last request...
+  rescue RestClient::BadRequest => e
+    LOGGER.error "DdeClient suppressed exception: #{e}"
+    handle_response e.response
+  rescue RestClient::UnprocessableEntity => e
+    LOGGER.error "DdeClient suppressed exception: #{e}"
+    handle_response e.response
+  rescue RestClient::NotFound => e
+    LOGGER.error "DdeClient suppressed exception: #{e}"
+    handle_response e.response
+  rescue RestClient::InternalServerError => e
+    LOGGER.error "DdeClient suppressed exceptionnnn: #{e}"
+    handle_response e.response
+  end
+
+  def handle_response(response)
+    # 204 is no content response, no further processing required.
+    return nil, 204 if response.code.to_i == 204
+
+    # NOTE: Following is commented out as Dde at the moment is quite liberal
+    # in how it responds to various requests. It seems to know no difference
+    # between 'application/json' and 'text/plain'.
+    #
+    # unless response["content-type"].include? JSON_CONTENT_TYPE
+    #   puts "Invalid response from API: content-type: " + response["content-type"]
+    #   return nil, 0
+    # end
+
+    # Dde is somewhat undecided on how it reports back its status code.
+    # Sometimes we get a proper HTTP status code and sometimes it is within
+    # the response body.
+    # response_status = response.code || response.body['status']
+    response_status = response.code
+    [JSON.parse(response.body), response_status&.to_i]
+  end
+end