allscripts_unity_client 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 259866bfe6fed08cf45b403f0b6d84c7a3149413
-  data.tar.gz: bcdf989b15bb39140e4b724904272f4d23a34125
+  metadata.gz: 755d0135099c866fab0417634a30ee6af7a16418
+  data.tar.gz: e1113c97b700e1cfa5b242a4f6b39a6744eaa100
 SHA512:
-  metadata.gz: 323d5275934799ce108a744bca885a3dbcccd1a523e1a5eb5a83d5a07e7bf3fc868d8203748a39f40d1d7b30a41e93e7643f1b2f1324cfcb9d310d8c8f05bbc5
-  data.tar.gz: 6d845cd670527219ee24476349cd2581e886969d4fd8d41a636ac39d1a5879b1d8667024ba3e55ee29756598e4e22b01e547d89784f12f19d8a55b0b739d4fe9
+  metadata.gz: 53d015e539d900f44d011f4fa6ff7cfd8664e8ca942e43471d5e459a21db181ac71a4285d498e36aa9d17bcbf87b984eab7086a2438cf24dea0a6fb9f50ef3b0
+  data.tar.gz: 6e96196624e66005474455ddb45d68fe4eb86e64ae86d9ed8f6c20d852e6e205c8d19ff2d720c69c6c99d46052b5e98833427fb5b218834ad44a1d85e1aa61dc

data/README.md

@@ -1,4 +1,4 @@
-# Allscripts Unity Client [![Build Status](https://travis-ci.org/healthfinch/allscripts-unity-client.png?branch=version2)](https://travis-ci.org/healthfinch/allscripts-unity-client) [![Coverage Status](https://coveralls.io/repos/healthfinch/allscripts-unity-client/badge.png?branch=master)](https://coveralls.io/r/healthfinch/allscripts-unity-client?branch=version2)
+# Allscripts Unity Client [![Build Status](https://travis-ci.org/healthfinch/allscripts-unity-client.png?branch=master)](https://travis-ci.org/healthfinch/allscripts-unity-client) [![Coverage Status](https://coveralls.io/repos/healthfinch/allscripts-unity-client/badge.png?branch=master)](https://coveralls.io/r/healthfinch/allscripts-unity-client?branch=master)
 
 The `allscripts_unity_client` gem is a Ruby client for the Allscripts Unity API. See http://remotecentral.allscripts.com/UnityAPIReference for more documentation on the API.
  

data/lib/allscripts_unity_client.rb

@@ -11,10 +11,19 @@ require 'allscripts_unity_client/soap_client_driver'
 require 'allscripts_unity_client/json_client_driver'
 require 'allscripts_unity_client/new_relic_support'
 
+# A library for consuming Allscripts Unity web services.
 module AllscriptsUnityClient
+
+  # Any error returned from Unity is thrown as this error type
+  # with the error message.
   class APIError < RuntimeError
   end
 
+  # Create an instance of the Unity client.
+  #
+  # options:: See ClientOptions.
+  #
+  # Returns an instance of Client.
   def self.create(options = {})
     options[:mode] ||= :soap
     options[:log] = true unless options[:log] === false

data/lib/allscripts_unity_client/client.rb

@@ -1,35 +1,89 @@
 require 'nokogiri'
 
 module AllscriptsUnityClient
+
+  # Providers an interface to access Unity endpoints.
+  #
+  # Build using a dependcy injection pattern. A Client instances takes an instance of
+  # ClientDriver and delegates Unity endpoint methods to the ClientDriver.
   class Client
     attr_accessor :client_driver
 
+    # Constructor.
+    #
+    # client_driver:: An instance of a ClientDriver. Currently only SoapClientDriver and JsonClientDriver
+    # are supported.
     def initialize(client_driver)
       raise ArgumentError, 'client_driver can not be nil' if client_driver.nil?
 
       @client_driver = client_driver
     end
 
+    # Access client's options. See ClientOptions.
     def options
       @client_driver.options
     end
 
+    # Implement Unity's Magic endpoint
+    #
+    # parameters:: A Hash of Unity parameters. Takes this form:
+    #
+    #   {
+    #     :action => ...,
+    #     :userid => ...,
+    #     :appname => ...,
+    #     :patientid => ...,
+    #     :token => ...,
+    #     :parameter1 => ...,
+    #     :parameter2 => ...,
+    #     :parameter3 => ...,
+    #     :parameter4 => ...,
+    #     :parameter5 => ...,
+    #     :parameter6 => ...,
+    #     :data => ...
+    #   }
+    #
+    # Returns the result of the Magic endpoint as a Hash.
     def magic(parameters = {})
       @client_driver.magic(parameters)
     end
 
+    # Implement Unity's GetSecurityToken endpoint.
+    #
+    # Stores the results in @security_token.
+    #
+    # parameters:: A hash of Unity parameters for GetSecurityToken:
+    #
+    #   {
+    #     :username => ...,
+    #     :password => ...,
+    #     :appname => ...
+    #   }
+    #
+    # Returns the security token.
     def get_security_token!(parameters = {})
       @client_driver.get_security_token!(parameters)
     end
 
+    # Implement Unity's RetireSecurityToken endpoint using Savon.
+    #
+    # parameters:: A hash of Unity parameters for RetireSecurityToken. If not given then defaults to
+    # @security_token:
+    #
+    #   {
+    #     :token => ...,
+    #     :appname => ...
+    #   }
     def retire_security_token!(parameters = {})
       @client_driver.retire_security_token!(parameters)
     end
 
+    # Return true if a Unity security token has been fetched and saved.
     def security_token?
       @client_driver.security_token?
     end
 
+    # Return the client type, either :json or :soap.
     def client_type
       @client_driver.client_type
     end
@@ -267,8 +321,28 @@ module AllscriptsUnityClient
       raise NotImplementedError, 'GetPatientCDA magic action not implemented'
     end
 
-    def get_patient_diagnosis
-      raise NotImplementedError, 'GetPatientDiagnosis magic action not implemented'
+    def get_patient_diagnosis(userid, patientid, encounter_date = nil, encounter_type = nil, encounter_date_range = nil, encounter_id = nil)
+      magic_params = {
+        action: 'GetPatientDiagnosis',
+        userid: userid,
+        patientid: patientid,
+        parameter1: encounter_date,
+        parameter2: encounter_type,
+        parameter3: encounter_date_range,
+        parameter4: encounter_id
+      }
+
+      results = magic(magic_params)
+
+      if !results.is_a? Array
+        if results.empty?
+          results = []
+        else
+          results = [results]
+        end
+      end
+
+      result
     end
 
     def get_patient_full

data/lib/allscripts_unity_client/client_driver.rb

@@ -1,11 +1,17 @@
 require 'logger'
 
 module AllscriptsUnityClient
+
+  # An abstract class for ClientDrivers that fully implement
+  # making calls to a Unity server.
   class ClientDriver
     LOG_FILE = 'logs/unity_client.log'
 
     attr_accessor :options, :security_token
 
+    # Constructor.
+    #
+    # options:: See ClientOptions.
     def initialize(options)
       @options = ClientOptions.new(options)
 
@@ -21,22 +27,27 @@ module AllscriptsUnityClient
       end
     end
 
+    # Returns true if security token is not nil.
     def security_token?
       !@security_token.nil?
     end
 
+    # Returns the type of client, usually a symbol.
     def client_type
       :none
     end
 
+    # See Client#magic.
     def magic(parameters = {})
       raise NotImplementedError, 'magic not implemented'
     end
 
+    # See Client#get_security_token!.
     def get_security_token!(parameters = {})
       raise NotImplementedError, 'get_security_token! not implemented'
     end
 
+    # See Client#retire_security_token!.
     def retire_security_token!(parameters = {})
       raise NotImplementedError, 'retire_security_token! not implemented'
     end

data/lib/allscripts_unity_client/client_options.rb

@@ -1,8 +1,24 @@
 module AllscriptsUnityClient
+
+  # Contains various options for Unity configuration.
   class ClientOptions
     attr_accessor :proxy, :logger, :ca_file, :ca_path, :timeout, :new_relic
     attr_reader :base_unity_url, :username, :password, :appname, :timezone
 
+    # Constructor.
+    #
+    # options::
+    #
+    #   - :username - Unity license username __(required)__.
+    #   - :password - Unity license password __(required)__.
+    #   - :appname - Unity license appname __(required)__.
+    #   - :proxy - A string URL pointing to an HTTP proxy (optional, primarily for debugging)
+    #   - :logger - A Ruby object that adheres to the same interface as Logger.
+    #   - :ca_file - A string path for a CA File on the OS (JSON only).
+    #   - :cs_path - A string path for a CA directory (JSON only).
+    #   - :timeout - The number of seconds to set the HTTP response timeout and keepalive timeout (JSON only).
+    #   - :new_relc - If set to true then New Relic mixins will be applied.
+    #   - :base_unity_url - The URL where a Unity server is located (i.e. https://unity.server.com) __(required)__
     def initialize(options = {})
       @username = options[:username]
       @password = options[:password]
@@ -20,6 +36,9 @@ module AllscriptsUnityClient
       validate_options
     end
 
+    # Validates options by ensuring that all required options are present.
+    #
+    # See #initialize.
     def validate_options(options = {})
       base_unity_url = options.has_key?(:base_unity_url) ? options[:base_unity_url] : @base_unity_url
       username = options.has_key?(:username) ? options[:username] : @username
@@ -32,26 +51,41 @@ module AllscriptsUnityClient
       raise ArgumentError, 'appname can not be nil' if appname.nil?
     end
 
+    # Mutator for @base_unity_url.
+    #
+    # Strips trailing slash for URL.
     def base_unity_url=(base_unity_url)
       validate_options(base_unity_url: base_unity_url)
       @base_unity_url = base_unity_url.gsub /\/$/, ''
     end
 
+    # Mutator for username.
+    #
+    # Ensures username is not nil,
     def username=(username)
       validate_options(username: username)
       @username = username
     end
 
+    # Mutator for password.
+    #
+    # Ensures password is not nil,
     def password=(password)
       validate_options(password: password)
       @password = password
     end
 
+    # Mutator for appname.
+    #
+    # Ensures appname is not nil,
     def appname=(appname)
       validate_options(appname: appname)
       @appname = appname
     end
 
+    # Mutator for timezone.
+    #
+    # Ensures timezone is not nil,
     def timezone=(timezone)
       if !timezone.nil?
         @timezone = ActiveSupport::TimeZone[timezone]
@@ -60,26 +94,32 @@ module AllscriptsUnityClient
       end
     end
 
+    # Return true if proxy is set and not empty.
     def proxy?
       !@proxy.to_s.strip.empty?
     end
 
+    # Return true if logger is not nil.
     def logger?
       !@logger.nil?
     end
 
+    # Return true if ca_file is not empty.
     def ca_file?
       !@ca_file.to_s.strip.empty?
     end
 
+    # Return true if ca_path is not empty.
     def ca_path?
       !@ca_path.to_s.strip.empty?
     end
 
+    # Return true if timeout is not empty.
     def timeout?
       !@timeout.to_s.strip.empty?
     end
 
+    # Return true if new_relic is not nil.
     def new_relic?
       !@new_relic.nil?
     end

data/lib/allscripts_unity_client/json_client_driver.rb

@@ -3,11 +3,16 @@ require 'faraday'
 require 'em-http-request'
 
 module AllscriptsUnityClient
+
+  # A ClientDriver that supports Unity's JSON endpoints.
   class JSONClientDriver < ClientDriver
     attr_accessor :json_base_url, :connection
 
     UNITY_JSON_ENDPOINT = '/Unity/UnityService.svc/json'
 
+    # Constructor.
+    #
+    # options:: See ClientOptions.
     def initialize(options)
       super
       @connection = Faraday.new(build_faraday_options) do |conn|
@@ -15,10 +20,12 @@ module AllscriptsUnityClient
       end
     end
 
+    # Returns :json.
     def client_type
       :json
     end
 
+    # See Client#magic.
     def magic(parameters = {})
       request_data = JSONUnityRequest.new(parameters, @options.timezone, @options.appname, @security_token)
 
@@ -44,6 +51,7 @@ module AllscriptsUnityClient
       response.to_hash
     end
 
+    # See Client#get_security_token!.
     def get_security_token!(parameters = {})
       username = parameters[:username] || @options.username
       password = parameters[:password] || @options.password
@@ -74,6 +82,7 @@ module AllscriptsUnityClient
       @security_token = response.body
     end
 
+    # See Client#retire_security_token!.
     def retire_security_token!(parameters = {})
       token = parameters[:token] || @security_token
       appname = parameters[:appname] || @options.appname

data/lib/allscripts_unity_client/json_unity_request.rb

@@ -1,5 +1,10 @@
 module AllscriptsUnityClient
+
+  # Transform a Unity request into a Hash suitable for sending using Faraday.
   class JSONUnityRequest < UnityRequest
+
+    # Convert the parameters to a Hash for Faraday with all possible dates
+    # converted to the Organization's localtime.
     def to_hash
       action = @parameters[:action]
       userid = @parameters[:userid]

data/lib/allscripts_unity_client/json_unity_response.rb

@@ -1,5 +1,9 @@
 module AllscriptsUnityClient
+
+  # Transform Unity responses from Faraday into Hash objects.
   class JSONUnityResponse < UnityResponse
+
+    # See UnityResponse#to_hash.
     def to_hash
       result = @response
 

data/lib/allscripts_unity_client/new_relic_support.rb

@@ -1,5 +1,11 @@
 module AllscriptsUnityClient
+
+  # A mixin to provide support for New Relic instrumentation.
   module NewRelicSupport
+
+    # Mixin NewRelic::Agent::MethodTracer for a given object.
+    #
+    # instance:: The object to use as the target for the mixin.
     def self.enable_method_tracer(instance)
       class << instance
         if !respond_to?(:trace_execution_scoped) && !respond_to?(:add_method_tracer)
@@ -8,6 +14,11 @@ module AllscriptsUnityClient
       end
     end
 
+    # If a given class supports New Relic trace_execution_scoped, then
+    # run the given block using that method.
+    #
+    # klass:: The target class.
+    # scope:: A New Relic scope string.
     def self.trace_execution_scoped_if_available(klass, scope)
       if klass.respond_to?(:trace_execution_scoped)
         klass.trace_execution_scoped(scope, &Proc.new)

data/lib/allscripts_unity_client/soap_client_driver.rb

@@ -1,12 +1,17 @@
 require 'savon'
 
 module AllscriptsUnityClient
+
+  # A ClientDriver that supports Unity's SOAP endpoints.
   class SOAPClientDriver < ClientDriver
     attr_accessor :savon_client
 
     UNITY_SOAP_ENDPOINT = '/Unity/UnityService.svc/unityservice'
     UNITY_ENDPOINT_NAMESPACE = 'http://www.allscripts.com/Unity/IUnityService'
 
+    # Constructor.
+    #
+    # options:: See ClientOptions.
     def initialize(options)
       super
 
@@ -48,10 +53,12 @@ module AllscriptsUnityClient
       end
     end
 
+    # Returns :soap.
     def client_type
       :soap
     end
 
+    # See Client#magic.
     def magic(parameters = {})
       request_data = UnityRequest.new(parameters, @options.timezone, @options.appname, @security_token)
       call_data = {
@@ -76,6 +83,7 @@ module AllscriptsUnityClient
       response.to_hash
     end
 
+    # See Client#get_security_token!.
     def get_security_token!(parameters = {})
       username = parameters[:username] || @options.username
       password = parameters[:password] || @options.password
@@ -106,6 +114,7 @@ module AllscriptsUnityClient
       @security_token = response.body[:get_security_token_response][:get_security_token_result]
     end
 
+    # See Client#retire_security_token!.
     def retire_security_token!(parameters = {})
       token = parameters[:token] || @security_token
       appname = parameters[:appname] || @options.appname

data/lib/allscripts_unity_client/unity_request.rb

@@ -1,7 +1,31 @@
 module AllscriptsUnityClient
+
+  # Transform a Unity request into a Hash suitable for sending using Savon.
   class UnityRequest
     attr_accessor :parameters, :appname, :security_token, :timezone
 
+    # Constructor.
+    #
+    # parameters:: A Hash of Unity parameters. Takes this form:
+    #
+    #   {
+    #     'Action' => ...,
+    #     'UserID' => ...,
+    #     'Appname' => ...,
+    #     'PatientID' => ...,
+    #     'Token' => ...,
+    #     'Parameter1' => ...,
+    #     'Parameter2' => ...,
+    #     'Parameter3' => ...,
+    #     'Parameter4' => ...,
+    #     'Parameter5' => ...,
+    #     'Parameter6' => ...,
+    #     'data' => ...
+    #   }
+    #
+    # timezone:: An ActiveSupport::TimeZone instance.
+    # appname:: The Unity license appname.
+    # security_token:: A security token from the Unity GetSecurityToken call.
     def initialize(parameters, timezone, appname, security_token)
       raise ArgumentError, 'parameters can not be nil' if parameters.nil?
       raise ArgumentError, 'timezone can not be nil' if timezone.nil?
@@ -14,6 +38,8 @@ module AllscriptsUnityClient
       @timezone = timezone
     end
 
+    # Convert the parameters to a Hash for Savon with all possible dates
+    # converted to the Organization's localtime.
     def to_hash
       action = @parameters[:action]
       userid = @parameters[:userid]

data/lib/allscripts_unity_client/unity_response.rb

@@ -1,9 +1,15 @@
 require 'date'
 
 module AllscriptsUnityClient
+
+  # Transform Unity responses from Savon into Hash objects.
   class UnityResponse
     attr_accessor :response, :timezone
 
+    # Constructor.
+    #
+    # response:: The response to transform.
+    # timezone:: An ActiveSupport:TimeZone instance.
     def initialize(response, timezone)
       raise ArgumentError, 'timezone can not be nil' if timezone.nil?
       raise ArgumentError, 'response can not be nil' if response.nil?
@@ -12,6 +18,8 @@ module AllscriptsUnityClient
       @timezone = timezone
     end
 
+    # Convert the Unity response to a Hash with symbolized snake_case keys
+    # and convert all dates to UTC.
     def to_hash
       result = @response[:magic_response][:magic_result][:diffgram]
       result = strip_attributes(result)

data/lib/allscripts_unity_client/utilities.rb

@@ -3,10 +3,20 @@ require 'date'
 require 'american_date'
 
 module AllscriptsUnityClient
+
+  # Utilities for massaging the data that comes back from Unity.
   class Utilities
     DATETIME_REGEX = /^((\d{1,2}[-\/]\d{1,2}[-\/]\d{4})|(\d{4}[-\/]\d{1,2}[-\/]\d{1,2})|(\d{1,2}-[A-Za-z]{3,4}-\d{4})|([A-Za-z]{3,4} +\d{1,2} \d{2,4}))(T| +)(\d{1,2}:\d{2}(:\d{2})?(\.\d+)? ?(PM|AM|pm|am)?((-|\+)\d{2}:?\d{2})?Z?)$/
     DATE_REGEX = /^((\d{1,2}[-\/]\d{1,2}[-\/]\d{4})|(\d{4}[-\/]\d{1,2}[-\/]\d{1,2})|(\d{1,2}-[A-Za-z]{3,4}-\d{4})|([A-Za-z]{3,4} +\d{1,2} \d{2,4}))$/
 
+    # Try to encode a string into a Data or ActiveSupport::TimeWithZone object.
+    #
+    # Uses DATETIME_REGEX and DATE_REGEX to match possible date string.
+    #
+    # timezone:: An ActiveSupport::TimeZone instance.
+    # possible_data:: A string that could contain a date.
+    #
+    # Returns Date or ActiveSupport::TimeWithZone, or the string if it did not contain a date.
     def self.try_to_encode_as_date(timezone, possible_date)
       if possible_date.nil?
         return nil
@@ -23,6 +33,11 @@ module AllscriptsUnityClient
       possible_date
     end
 
+    # Encode binary data into Base64 encoding.
+    #
+    # data:: Data to encode.
+    #
+    # The Base64 encoding of the data.
     def self.encode_data(data)
       if data.nil?
         return nil
@@ -35,6 +50,11 @@ module AllscriptsUnityClient
       end
     end
 
+    # Transform string keys into symbols and convert CamelCase to snake_case.
+    #
+    # hash:: The hash to transform.
+    #
+    # Returns the transformed hash.
     def self.recursively_symbolize_keys(hash)
       # Base case: nil maps to nil
       if hash.nil?

data/lib/allscripts_unity_client/version.rb

@@ -1,3 +1,3 @@
 module AllscriptsUnityClient
-  VERSION = '2.2.0'
+  VERSION = '2.2.2'
 end

data/spec/client_spec.rb

@@ -150,9 +150,7 @@ describe AllscriptsUnityClient::Client do
     it { expect { subject.get_patient_cda }.to raise_error(NotImplementedError) }
   end
 
-  describe '#get_patient_diagnosis' do
-    it { expect { subject.get_patient_diagnosis }.to raise_error(NotImplementedError) }
-  end
+  describe '#get_patient_diagnosis'
 
   describe '#get_patient_full' do
     it { expect { subject.get_patient_full }.to raise_error(NotImplementedError) }

data/spec/spec_helper.rb

@@ -56,7 +56,7 @@ RSpec.configure do |config|
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 10
+  # config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allscripts_unity_client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Ash Gupta
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon