allscripts_unity_client 1.3.4 → 2.0.0

data/lib/allscripts_unity_client/client_driver.rb

@@ -2,84 +2,57 @@ require 'logger'
 
 module AllscriptsUnityClient
   class ClientDriver
-    LOG_FILE = "logs/unity_client.log"
+    LOG_FILE = 'logs/unity_client.log'
 
-    attr_accessor :username, :password, :appname, :base_unity_url, :proxy, :security_token, :timezone, :logger, :log
+    attr_accessor :options, :security_token
 
-    def initialize(base_unity_url, username, password, appname, proxy = nil, timezone = nil, logger = nil, log = true)
-      raise ArgumentError, "base_unity_url can not be nil" if base_unity_url.nil?
-      raise ArgumentError, "username can not be nil" if username.nil?
-      raise ArgumentError, "password can not be nil" if password.nil?
-      raise ArgumentError, "appname can not be nil" if appname.nil?
-
-      @base_unity_url = base_unity_url.gsub /\/$/, ""
-      @username = username
-      @password = password
-      @appname = appname
-      @proxy = proxy
-      @log = log
-
-      if logger.nil?
-        @logger = Logger.new(STDOUT)
-        @logger.level = Logger::INFO
-      else
-        @logger = logger
-      end
-
-      unless timezone.nil?
-        @timezone = Timezone.new(timezone)
-      else
-        @timezone = Timezone.new("UTC")
-      end
+    def initialize(options)
+      @options = ClientOptions.new(options)
     end
 
     def security_token?
-      return !@security_token.nil?
-    end
-
-    def log?
-      return @log
+      !@security_token.nil?
     end
 
     def client_type
-      return :none
+      :none
     end
 
     def magic(parameters = {})
-      raise NotImplementedError, "magic not implemented"
+      raise NotImplementedError, 'magic not implemented'
     end
 
     def get_security_token!(parameters = {})
-      raise NotImplementedError, "get_security_token! not implemented"
+      raise NotImplementedError, 'get_security_token! not implemented'
     end
 
     def retire_security_token!(parameters = {})
-      raise NotImplementedError, "retire_security_token! not implemented"
+      raise NotImplementedError, 'retire_security_token! not implemented'
     end
 
     protected
 
     def log_get_security_token
-      message = "Unity API GetSecurityToken request to #{@base_unity_url}"
+      message = "Unity API GetSecurityToken request to #{@options.base_unity_url}"
       log_info(message)
     end
 
     def log_retire_security_token
-      message = "Unity API RetireSecurityToken request to #{@base_unity_url}"
+      message = "Unity API RetireSecurityToken request to #{@options.base_unity_url}"
       log_info(message)
     end
 
     def log_magic(request)
-      raise ArgumentError, "request can not be nil" if request.nil?
-      message = "Unity API Magic request to #{@base_unity_url} [#{request.parameters[:action]}]"
+      raise ArgumentError, 'request can not be nil' if request.nil?
+      message = "Unity API Magic request to #{@options.base_unity_url} [#{request.parameters[:action]}]"
       log_info(message)
     end
 
     def log_info(message)
-      if log? && !logger.nil? && !message.nil?
+      if @options.logger? && !message.nil?
         message += " #{@timer} seconds" unless @timer.nil?
         @timer = nil
-        logger.info(message)
+        @options.logger.info(message)
       end
     end
 

data/lib/allscripts_unity_client/client_options.rb

@@ -0,0 +1,68 @@
+module AllscriptsUnityClient
+  class ClientOptions
+    attr_accessor :proxy, :logger
+    attr_reader :base_unity_url, :username, :password, :appname, :timezone
+
+    def initialize(options = {})
+      @base_unity_url = options[:base_unity_url] ? options[:base_unity_url].gsub(/\/$/, '') : nil
+      @username = options[:username]
+      @password = options[:password]
+      @appname = options[:appname]
+      @proxy = options[:proxy]
+      self.timezone = options[:timezone]
+      @logger = options[:logger]
+
+      validate_options
+    end
+
+    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
+      password = options.has_key?(:password) ? options[:password] : @password
+      appname = options.has_key?(:appname) ? options[:appname] : @appname
+
+      raise ArgumentError, 'base_unity_url can not be nil' if base_unity_url.nil?
+      raise ArgumentError, 'username can not be nil' if username.nil?
+      raise ArgumentError, 'password can not be nil' if password.nil?
+      raise ArgumentError, 'appname can not be nil' if appname.nil?
+    end
+
+    def base_unity_url=(base_unity_url)
+      validate_options(base_unity_url: base_unity_url)
+      @base_unity_url = base_unity_url.gsub /\/$/, ''
+    end
+
+    def username=(username)
+      validate_options(username: username)
+      @username = username
+    end
+
+    def password=(password)
+      validate_options(password: password)
+      @password = password
+    end
+
+    def appname=(appname)
+      validate_options(appname: appname)
+      @appname = appname
+    end
+
+    def timezone=(timezone)
+      if !timezone.nil?
+        @timezone = Timezone.new(timezone)
+      else
+        @timezone = Timezone.new('UTC')
+      end
+    end
+
+    def proxy?
+      return false if @proxy.nil?
+      return false if @proxy.empty?
+      true
+    end
+
+    def logger?
+      !@logger.nil?
+    end
+  end
+end

data/lib/allscripts_unity_client/json_client_driver.rb

@@ -1,31 +1,37 @@
-require "json"
-require "httpi"
+require 'json'
+require 'faraday'
+require 'em-http-request'
 
 module AllscriptsUnityClient
   class JSONClientDriver < ClientDriver
-    attr_accessor :json_base_url
+    attr_accessor :json_base_url, :connection
 
-    UNITY_JSON_ENDPOINT = "/Unity/UnityService.svc/json"
+    UNITY_JSON_ENDPOINT = '/Unity/UnityService.svc/json'
 
-    def initialize(base_unity_url, username, password, appname, proxy = nil, timezone = nil, logger = nil, log = true)
+    def initialize(options)
       super
+      @connection = Faraday.new(url: @options.base_unity_url) do |conn|
+        if @options.proxy?
+          conn.proxy @options.proxy
+        end
 
-      # Disable HTTPI logging
-      HTTPI.log = false
-
-      @json_base_url = "#{@base_unity_url}#{UNITY_JSON_ENDPOINT}"
+        conn.adapter :em_http
+      end
     end
 
     def client_type
-      return :json
+      :json
     end
 
     def magic(parameters = {})
-      request_data = JSONUnityRequest.new(parameters, @timezone, @appname, @security_token)
-      request = create_httpi_request("#{@json_base_url}/MagicJson", request_data.to_hash)
+      request_data = JSONUnityRequest.new(parameters, @options.timezone, @options.appname, @security_token)
 
-      start_timer
-      response = HTTPI.post(request)
+      response = @connection.post do |request|
+        request.url "#{UNITY_JSON_ENDPOINT}/MagicJson"
+        request.headers['Content-Type'] = 'application/json'
+        request.body = JSON.generate(request_data.to_hash)
+        start_timer
+      end
       end_timer
 
       response = JSON.parse(response.body)
@@ -33,24 +39,27 @@ module AllscriptsUnityClient
       raise_if_response_error(response)
       log_magic(request_data)
 
-      response = JSONUnityResponse.new(response, @timezone)
+      response = JSONUnityResponse.new(response, @options.timezone)
       response.to_hash
     end
 
     def get_security_token!(parameters = {})
-      username = parameters[:username] || @username
-      password = parameters[:password] || @password
-      appname = parameters[:appname] || @appname
+      username = parameters[:username] || @options.username
+      password = parameters[:password] || @options.password
+      appname = parameters[:appname] || @options.appname
 
       request_data = {
-        "Username" => username,
-        "Password" => password,
-        "Appname" => appname
+        'Username' => username,
+        'Password' => password,
+        'Appname' => appname
       }
-      request = create_httpi_request("#{@json_base_url}/GetToken", request_data)
 
-      start_timer
-      response = HTTPI.post(request, :net_http_persistent)
+      response = @connection.post do |request|
+        request.url "#{UNITY_JSON_ENDPOINT}/GetToken"
+        request.headers['Content-Type'] = 'application/json'
+        request.body = JSON.generate(request_data)
+        start_timer
+      end
       end_timer
 
       raise_if_response_error(response.body)
@@ -61,16 +70,19 @@ module AllscriptsUnityClient
 
     def retire_security_token!(parameters = {})
       token = parameters[:token] || @security_token
-      appname = parameters[:appname] || @appname
+      appname = parameters[:appname] || @options.appname
 
       request_data = {
-        "Token" => token,
-        "Appname" => appname
+        'Token' => token,
+        'Appname' => appname
       }
-      request = create_httpi_request("#{@json_base_url}/RetireSecurityToken", request_data)
 
-      start_timer
-      response = HTTPI.post(request, :net_http_persistent)
+      response = @connection.post do |request|
+        request.url "#{UNITY_JSON_ENDPOINT}/RetireSecurityToken"
+        request.headers['Content-Type'] = 'application/json'
+        request.body = JSON.generate(request_data)
+        start_timer
+      end
       end_timer
 
       raise_if_response_error(response.body)
@@ -81,28 +93,12 @@ module AllscriptsUnityClient
 
     private
 
-    def create_httpi_request(url, data)
-      request = HTTPI::Request.new
-      request.url = url
-      request.headers = {
-        "Accept-Encoding" => "gzip,deflate",
-        "Content-type" => "application/json;charset=utf-8"
-      }
-      request.body = JSON.generate(data)
-
-      unless @proxy.nil?
-        request.proxy = @proxy
-      end
-
-      request
-    end
-
     def raise_if_response_error(response)
       if response.nil?
-        raise APIError, "Response was empty"
-      elsif response.is_a?(Array) && !response[0].nil? && !response[0]["Error"].nil?
-        raise APIError, response[0]["Error"]
-      elsif response.is_a?(String) && response.include?("error:")
+        raise APIError, 'Response was empty'
+      elsif response.is_a?(Array) && !response[0].nil? && !response[0]['Error'].nil?
+        raise APIError, response[0]['Error']
+      elsif response.is_a?(String) && response.include?('error:')
         raise APIError, response
       end
     end

data/lib/allscripts_unity_client/json_unity_request.rb

@@ -6,27 +6,27 @@ module AllscriptsUnityClient
       appname = @parameters[:appname] || @appname
       patientid = @parameters[:patientid]
       token = @parameters[:token] || @security_token
-      parameter1 = process_date(@parameters[:parameter1]) || ""
-      parameter2 = process_date(@parameters[:parameter2]) || ""
-      parameter3 = process_date(@parameters[:parameter3]) || ""
-      parameter4 = process_date(@parameters[:parameter4]) || ""
-      parameter5 = process_date(@parameters[:parameter5]) || ""
-      parameter6 = process_date(@parameters[:parameter6]) || ""
-      data = Utilities::encode_data(@parameters[:data]) || ""
+      parameter1 = process_date(@parameters[:parameter1]) || ''
+      parameter2 = process_date(@parameters[:parameter2]) || ''
+      parameter3 = process_date(@parameters[:parameter3]) || ''
+      parameter4 = process_date(@parameters[:parameter4]) || ''
+      parameter5 = process_date(@parameters[:parameter5]) || ''
+      parameter6 = process_date(@parameters[:parameter6]) || ''
+      data = Utilities::encode_data(@parameters[:data]) || ''
 
-      return {
-        "Action" => action,
-        "AppUserID" => userid,
-        "Appname" => appname,
-        "PatientID" => patientid,
-        "Token" => token,
-        "Parameter1" => parameter1,
-        "Parameter2" => parameter2,
-        "Parameter3" => parameter3,
-        "Parameter4" => parameter4,
-        "Parameter5" => parameter5,
-        "Parameter6" => parameter6,
-        "Data" => data
+      {
+        'Action' => action,
+        'AppUserID' => userid,
+        'Appname' => appname,
+        'PatientID' => patientid,
+        'Token' => token,
+        'Parameter1' => parameter1,
+        'Parameter2' => parameter2,
+        'Parameter3' => parameter3,
+        'Parameter4' => parameter4,
+        'Parameter5' => parameter5,
+        'Parameter6' => parameter6,
+        'Data' => data
       }
     end
   end

data/lib/allscripts_unity_client/json_unity_response.rb

@@ -1,4 +1,4 @@
-require "json"
+require 'json'
 
 module AllscriptsUnityClient
   class JSONUnityResponse < UnityResponse

data/lib/allscripts_unity_client/soap_client_driver.rb

@@ -1,17 +1,17 @@
-require "savon"
+require 'savon'
 
 module AllscriptsUnityClient
   class SOAPClientDriver < ClientDriver
     attr_accessor :savon_client
 
-    UNITY_SOAP_ENDPOINT = "/Unity/UnityService.svc/unityservice"
-    UNITY_ENDPOINT_NAMESPACE = "http://www.allscripts.com/Unity/IUnityService"
+    UNITY_SOAP_ENDPOINT = '/Unity/UnityService.svc/unityservice'
+    UNITY_ENDPOINT_NAMESPACE = 'http://www.allscripts.com/Unity/IUnityService'
 
-    def initialize(base_unity_url, username, password, appname, proxy = nil, timezone = nil, logger = nil, log = true)
+    def initialize(options)
       super
 
-      client_proxy = @proxy
-      base_unity_url = "#{@base_unity_url}#{UNITY_SOAP_ENDPOINT}"
+      client_proxy = @options.proxy
+      base_unity_url = "#{@options.base_unity_url}#{UNITY_SOAP_ENDPOINT}"
 
       @savon_client = Savon.client do
         # Removes the wsdl: namespace from body elements in the SOAP
@@ -24,7 +24,7 @@ module AllscriptsUnityClient
 
         # Manually register SOAP namespace. This URL isn't live, but the
         # internal SOAP endpoints expect it.
-        namespace "http://www.allscripts.com/Unity"
+        namespace 'http://www.allscripts.com/Unity'
 
         # Register proxy with Savon if one was given.
         unless client_proxy.nil?
@@ -41,7 +41,7 @@ module AllscriptsUnityClient
         # Enable gzip on HTTP responses. Unity does not currently support this
         # as of Born On 10/7/2013, but it doesn't hurt to future-proof. If gzip
         # is ever enabled, this library will get a speed bump for free.
-        headers({ "Accept-Encoding" => "gzip,deflate" })
+        headers({ 'Accept-Encoding' => 'gzip,deflate'})
 
         # Disable Savon logs
         log false
@@ -49,19 +49,19 @@ module AllscriptsUnityClient
     end
 
     def client_type
-      return :soap
+      :soap
     end
 
     def magic(parameters = {})
-      request_data = UnityRequest.new(parameters, @timezone,  @appname, @security_token)
+      request_data = UnityRequest.new(parameters, @options.timezone, @options.appname, @security_token)
       call_data = {
-        :message => request_data.to_hash,
-        :soap_action => "#{UNITY_ENDPOINT_NAMESPACE}/Magic"
+        message: request_data.to_hash,
+        soap_action: "#{UNITY_ENDPOINT_NAMESPACE}/Magic"
       }
 
       begin
         start_timer
-        response = @savon_client.call("Magic", call_data)
+        response = @savon_client.call('Magic', call_data)
         end_timer
       rescue Savon::SOAPFault => e
         raise APIError, e.message
@@ -69,27 +69,27 @@ module AllscriptsUnityClient
 
       log_magic(request_data)
 
-      response = UnityResponse.new(response.body, @timezone)
+      response = UnityResponse.new(response.body, @options.timezone)
       response.to_hash
     end
 
     def get_security_token!(parameters = {})
-      username = parameters[:username] || @username
-      password = parameters[:password] || @password
-      appname = parameters[:appname] || @appname
+      username = parameters[:username] || @options.username
+      password = parameters[:password] || @options.password
+      appname = parameters[:appname] || @options.appname
 
       call_data = {
-        :message => {
-          "Username" => username,
-          "Password" => password,
-          "Appname" => appname
+        message: {
+          'Username' => username,
+          'Password' => password,
+          'Appname' => appname
         },
-        :soap_action => "#{UNITY_ENDPOINT_NAMESPACE}/GetSecurityToken"
+        soap_action: "#{UNITY_ENDPOINT_NAMESPACE}/GetSecurityToken"
       }
 
       begin
         start_timer
-        response = @savon_client.call("GetSecurityToken", call_data)
+        response = @savon_client.call('GetSecurityToken', call_data)
         end_timer
       rescue Savon::SOAPFault => e
         raise APIError, e.message
@@ -102,19 +102,19 @@ module AllscriptsUnityClient
 
     def retire_security_token!(parameters = {})
       token = parameters[:token] || @security_token
-      appname = parameters[:appname] || @appname
+      appname = parameters[:appname] || @options.appname
 
       call_data = {
-        :message => {
-          "Token" => token,
-          "Appname" => appname
+        message: {
+          'Token' => token,
+          'Appname' => appname
         },
-        :soap_action => "#{UNITY_ENDPOINT_NAMESPACE}/RetireSecurityToken"
+        soap_action: "#{UNITY_ENDPOINT_NAMESPACE}/RetireSecurityToken"
       }
 
       begin
         start_timer
-        @savon_client.call("RetireSecurityToken", call_data)
+        @savon_client.call('RetireSecurityToken', call_data)
         end_timer
       rescue Savon::SOAPFault => e
         raise APIError, e.message

data/lib/allscripts_unity_client/timezone.rb

@@ -1,12 +1,12 @@
-require "date"
-require "tzinfo"
+require 'date'
+require 'tzinfo'
 
 module AllscriptsUnityClient
   class Timezone
     attr_accessor :tzinfo
 
     def initialize(zone_identifier)
-      raise ArgumentError, "zone_identifier can not be nil" if zone_identifier.nil?
+      raise ArgumentError, 'zone_identifier can not be nil' if zone_identifier.nil?
 
       @tzinfo = TZInfo::Timezone.get(zone_identifier)
     end
@@ -21,6 +21,11 @@ module AllscriptsUnityClient
       convert_with_timezone(:utc_to_local, datetime)
     end
 
+    def ==(timezone)
+      return false if !timezone.is_a?(Timezone)
+      @tzinfo == timezone.tzinfo
+    end
+
     private
 
     # Direction can be :utc_to_local or :local_to_utc
@@ -52,7 +57,7 @@ module AllscriptsUnityClient
 
         if is_datetime
           # Convert to a DateTime with a UTC offset
-          datetime = DateTime.parse("#{datetime.strftime("%FT%T")}Z")
+          datetime = DateTime.parse("#{datetime.strftime('%FT%T')}Z")
         end
       end
 
@@ -65,7 +70,7 @@ module AllscriptsUnityClient
         end
       end
 
-      return datetime
+      datetime
     end
 
     # TZInfo does not correctly update a DateTime's
@@ -78,7 +83,7 @@ module AllscriptsUnityClient
 
       offset = @tzinfo.current_period.utc_offset
       negative_offset = false
-      datetime_string = datetime.strftime("%FT%T")
+      datetime_string = datetime.strftime('%FT%T')
 
       if offset < 0
         offset *= -1
@@ -86,11 +91,11 @@ module AllscriptsUnityClient
       end
 
       if offset == 0
-        offset_string = "Z"
+        offset_string = 'Z'
       else
-        offset_string = Time.at(offset).utc.strftime("%H:%M")
-        offset_string = "-" + offset_string if negative_offset
-        offset_string = "+" + offset_string unless negative_offset
+        offset_string = Time.at(offset).utc.strftime('%H:%M')
+        offset_string = '-' + offset_string if negative_offset
+        offset_string = '+' + offset_string unless negative_offset
       end
 
       "#{datetime_string}#{offset_string}"

data/lib/allscripts_unity_client/unity_request.rb

@@ -3,10 +3,10 @@ module AllscriptsUnityClient
     attr_accessor :parameters, :appname, :security_token, :timezone
 
     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?
-      raise ArgumentError, "appname can not be nil" if appname.nil?
-      raise ArgumentError, "security_token can not be nil" if security_token.nil?
+      raise ArgumentError, 'parameters can not be nil' if parameters.nil?
+      raise ArgumentError, 'timezone can not be nil' if timezone.nil?
+      raise ArgumentError, 'appname can not be nil' if appname.nil?
+      raise ArgumentError, 'security_token can not be nil' if security_token.nil?
 
       @appname = appname
       @security_token = security_token
@@ -28,19 +28,19 @@ module AllscriptsUnityClient
       parameter6 = process_date(@parameters[:parameter6])
       data = Utilities::encode_data(@parameters[:data])
 
-      return {
-        "Action" => action,
-        "UserID" => userid,
-        "Appname" => appname,
-        "PatientID" => patientid,
-        "Token" => token,
-        "Parameter1" => parameter1,
-        "Parameter2" => parameter2,
-        "Parameter3" => parameter3,
-        "Parameter4" => parameter4,
-        "Parameter5" => parameter5,
-        "Parameter6" => parameter6,
-        "data" => data
+      {
+        'Action' => action,
+        'UserID' => userid,
+        'Appname' => appname,
+        'PatientID' => patientid,
+        'Token' => token,
+        'Parameter1' => parameter1,
+        'Parameter2' => parameter2,
+        'Parameter3' => parameter3,
+        'Parameter4' => parameter4,
+        'Parameter5' => parameter5,
+        'Parameter6' => parameter6,
+        'data' => data
       }
     end
 

data/lib/allscripts_unity_client/unity_response.rb

@@ -1,12 +1,12 @@
-require "date"
+require 'date'
 
 module AllscriptsUnityClient
   class UnityResponse
     attr_accessor :response, :timezone
 
     def initialize(response, timezone)
-      raise ArgumentError, "timezone can not be nil" if timezone.nil?
-      raise ArgumentError, "response can not be nil" if response.nil?
+      raise ArgumentError, 'timezone can not be nil' if timezone.nil?
+      raise ArgumentError, 'response can not be nil' if response.nil?
 
       @response = response
       @timezone = timezone

data/lib/allscripts_unity_client/utilities.rb

@@ -1,6 +1,6 @@
-require "nori"
-require "date"
-require "american_date"
+require 'nori'
+require 'date'
+require 'american_date'
 
 module AllscriptsUnityClient
   class Utilities
@@ -29,9 +29,9 @@ module AllscriptsUnityClient
       end
 
       if data.respond_to?(:pack)
-        return data.pack("m")
+        return data.pack('m')
       else
-        return [data].pack("m")
+        return [data].pack('m')
       end
     end
 

data/lib/allscripts_unity_client/version.rb

@@ -1,3 +1,3 @@
 module AllscriptsUnityClient
-  VERSION = "1.3.4"
+  VERSION = '2.0.0'
 end