allscripts_unity_client 4.0.1 → 5.0.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5af2ceca9d82117d1167e662511df55c3659629a
-  data.tar.gz: 428ce6f40066a7c5d15f045fd7d9d4620247eac1
+SHA256:
+  metadata.gz: 96765b528b47b9361195ebb001d42ae3123f19311265f8ec323156b737ddfd1b
+  data.tar.gz: 3a7ee1148825675e866bfe6d023bac46dc6b9365cb0cee6b6e08408a525df136
 SHA512:
-  metadata.gz: ea0bcdd635c8749437600fdc2d1f538be78bb112a34a2130b08fbde06eee79df11efb5f332287c9698cca8284386ac6b1b8a0b7eba8179c2fbb4c6150a42af47
-  data.tar.gz: ae7aae6d87dae173deda1e46c079a168ab40b764791c3032f0a49b16e02a34664e379d5578e893caabad4882e37e57e74b90a48b9f872d94d0e75aec6b0f9921
+  metadata.gz: 6b954e8c0e5cb68b5a53289d105254714cf494caa9832715e03e2e5bb58598deb90156f075d0872e292925b6c53f2f52dcc021e8a487927cade16936db3cd914
+  data.tar.gz: 18b86b32e029f5d96759e3f660d61b8e7a80130fc72896f669ec0adf15732a1d26135a2798d769178a9b7a22416979dfd525488de868623f911fd3bac5caa70f

data/lib/allscripts_unity_client.rb

@@ -21,6 +21,9 @@ module AllscriptsUnityClient
   class GetSecurityTokenError < RuntimeError
   end
 
+  # Raised when user attempts to make unauthenticated calls.
+  class UnauthenticatedError < StandardError; end
+
   # Create an instance of the Unity client.
   #
   # options:: See ClientOptions.

data/lib/allscripts_unity_client/client.rb

@@ -552,7 +552,7 @@ module AllscriptsUnityClient
     end
 
     def get_user_authentication
-      raise NotImplementedError, 'GetUserAuthentication magic action not implemented'
+      @client_driver.get_user_authentication
     end
 
     def get_user_id

data/lib/allscripts_unity_client/client_options.rb

@@ -2,15 +2,15 @@ module AllscriptsUnityClient
 
   # Contains various options for Unity configuration.
   class ClientOptions
-    attr_accessor :proxy, :logger, :ca_file, :ca_path, :timeout
+    attr_accessor :proxy, :logger, :ca_file, :ca_path, :timeout, :ehr_userid, :ehr_password
     attr_reader :base_unity_url, :username, :password, :appname, :timezone
 
     # Constructor.
     #
     # options::
     #
-    #   - :username - Unity license username __(required)__.
-    #   - :password - Unity license password __(required)__.
+    #   - :username - Unity license username for security token __(required)__.
+    #   - :password - Unity license password for security token __(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.
@@ -18,6 +18,8 @@ module AllscriptsUnityClient
     #   - :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).
     #   - :base_unity_url - The URL where a Unity server is located (i.e. https://unity.server.com) __(required)__
+    #   - :ehr_userid - Allscripts EHR Username for user authentication __(required)__.
+    #   - :ehr_password - EHR Password for user authentication __(required)__.
     def initialize(options = {})
       @username = options[:username]
       @password = options[:password]
@@ -27,6 +29,8 @@ module AllscriptsUnityClient
       @ca_file = options[:ca_file]
       @ca_path = options[:ca_path]
       @timeout = options[:timeout]
+      @ehr_userid = options[:ehr_userid]
+      @ehr_password = options[:ehr_password]
 
       self.timezone = options[:timezone]
       self.base_unity_url = options[:base_unity_url]

data/lib/allscripts_unity_client/json_client_driver.rb

@@ -47,6 +47,10 @@ module AllscriptsUnityClient
     end
 
     def magic(parameters = {})
+      unless user_authenticated? || parameters[:action] == 'GetUserAuthentication'
+        log_info("Unauthenticated access of #{parameters[:action]} for #{@options.base_unity_url}")
+      end
+
       request = JSONUnityRequest.new(parameters, @options.timezone, @options.appname, @security_token)
       request_hash = request.to_hash
       request_data = MultiJson.dump(request_hash)
@@ -70,6 +74,26 @@ module AllscriptsUnityClient
       response.to_hash
     end
 
+    # See Client#get_user_authentication.
+    def get_user_authentication(parameters = {})
+      response = magic({
+                         action: 'GetUserAuthentication',
+                         userid: parameters[:ehr_userid] || @options.ehr_userid,
+                         parameter1: parameters[:ehr_password] || @options.ehr_password
+                       })
+
+      if response[:valid_user] == 'YES'
+        @user_authentication = response
+        log_info("Successful authentication attempt for #{@options.base_unity_url}")
+        return true
+      elsif response[:valid_user] == 'NO'
+        log_info("Unuccessful authentication attempt for #{@options.base_unity_url}")
+        return false
+      else
+        raise StandardError.new('Unexpected response from the server')
+      end
+    end
+
     # See Client#get_security_token!.
     def get_security_token!(parameters = {})
       username = parameters[:username] || @options.username
@@ -116,6 +140,15 @@ module AllscriptsUnityClient
       log_retire_security_token
 
       @security_token = nil
+      revoke_authentication
+    end
+
+    def user_authenticated?
+      @user_authentication.present?
+    end
+
+    def revoke_authentication
+      @user_authentication = nil
     end
 
     private

data/lib/allscripts_unity_client/version.rb

@@ -1,3 +1,3 @@
 module AllscriptsUnityClient
-  VERSION = '4.0.1'.freeze
+  VERSION = '5.0.0-alpha'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allscripts_unity_client
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.0.pre.alpha
 platform: ruby
 authors:
 - healthfinch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -212,23 +212,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 description: Provides a simple interface to the Allscripts Unity API using JSON. Developed
   at healthfinch http://healthfinch.com
 email:
-- darkarts@healthfinch.com
+- engineering@healthfinch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
-- allscripts_unity_client.gemspec
 - lib/allscripts_unity_client.rb
 - lib/allscripts_unity_client/client.rb
 - lib/allscripts_unity_client/client_driver.rb
@@ -240,49 +245,6 @@ files:
 - lib/allscripts_unity_client/unity_response.rb
 - lib/allscripts_unity_client/utilities.rb
 - lib/allscripts_unity_client/version.rb
-- spec/allscripts_unity_client_spec.rb
-- spec/client_driver_spec.rb
-- spec/client_options_spec.rb
-- spec/client_spec.rb
-- spec/factories/allscripts_unity_client_parameters_factory.rb
-- spec/factories/client_driver_factory.rb
-- spec/factories/client_factory.rb
-- spec/factories/client_options.rb
-- spec/factories/magic_request_factory.rb
-- spec/factories/unity_request_factory.rb
-- spec/factories/unity_response_factory.rb
-- spec/fixtures/attributes_hash.yml
-- spec/fixtures/date_hash.yml
-- spec/fixtures/date_string_hash.yml
-- spec/fixtures/error.json
-- spec/fixtures/get_providers.json
-- spec/fixtures/get_providers.xml
-- spec/fixtures/get_providers_json.yml
-- spec/fixtures/get_providers_xml.yml
-- spec/fixtures/get_security_token.json
-- spec/fixtures/get_security_token.xml
-- spec/fixtures/get_server_info.json
-- spec/fixtures/get_server_info.xml
-- spec/fixtures/get_server_info_json.yml
-- spec/fixtures/get_server_info_xml.yml
-- spec/fixtures/no_attributes_hash.yml
-- spec/fixtures/retire_security_token.json
-- spec/fixtures/retire_security_token.xml
-- spec/fixtures/soap_fault.xml
-- spec/fixtures/string_keyed_hash.yml
-- spec/fixtures/symbol_keyed_hash.yml
-- spec/json_client_driver_spec.rb
-- spec/json_unity_request_spec.rb
-- spec/json_unity_response_spec.rb
-- spec/spec_helper.rb
-- spec/support/factory_bot.rb
-- spec/support/fixture_loader.rb
-- spec/support/shared_examples_for_client_driver.rb
-- spec/support/shared_examples_for_unity_request.rb
-- spec/support/shared_examples_for_unity_response.rb
-- spec/unity_request_spec.rb
-- spec/unity_response_spec.rb
-- spec/utilities_spec.rb
 homepage: https://github.com/healthfinch/allscripts-unity-client
 licenses:
 - MIT
@@ -293,17 +255,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.10
 signing_key: 
 specification_version: 4
 summary: Allscripts Unity API client

data/.gitignore

@@ -1,21 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-gembuild.txt
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.idea
-logs
-*.swp

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,340 +0,0 @@
-AllCops:
-  DisabledByDefault: true
-  DisplayCopNames: true
-  Exclude:
-    - 'bin/**/*'
-
-
-Style/AndOr:
-  Description: 'Use &&/|| instead of and/or.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-and-or-or'
-  Enabled: true
-  Exclude:
-    - 'lib/healthfinch/service/controller_base.rb'
-
-Style/DefWithParentheses:
-  Description: 'Use def with parentheses when there are arguments.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens'
-  Enabled: true
-
-Style/PreferredHashMethods:
-  Description: 'Checks for use of deprecated Hash methods.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-key'
-  Enabled: true
-
-Style/DoubleNegation:
-  Description: 'Checks for uses of double negation (!!).'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-bang-bang'
-  Enabled: true
-  Exclude:
-    - 'lib/healthfinch/service/rspec/process_service_acceptance.rb'
-
-Layout/ElseAlignment:
-  Description: 'Align elses and elsifs correctly.'
-  Enabled: true
-
-Style/EmptyElse:
-  Description: 'Avoid empty else-clauses.'
-  Enabled: true
-
-Layout/EmptyLineBetweenDefs:
-  Description: 'Use empty lines between defs.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods'
-  Enabled: true
-
-Layout/EmptyLines:
-  Description: "Don't use several empty lines in a row."
-  Enabled: true
-
-Layout/EndOfLine:
-  Description: 'Use Unix-style line endings.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#crlf'
-  Enabled: true
-
-Layout/ExtraSpacing:
-  Description: 'Do not use unnecessary spacing.'
-  Enabled: true
-
-Naming/FileName:
-  Description: 'Use snake_case for source file names.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files'
-  Enabled: true
-
-Layout/IndentationConsistency:
-  Description: 'Keep indentation straight.'
-  Enabled: true
-
-Layout/IndentationWidth:
-  Description: 'Use 2 spaces for indentation.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-indentation'
-  Enabled: true
-
-Style/MethodCallWithoutArgsParentheses:
-  Description: 'Do not use parentheses for method calls with no arguments.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-args-no-parens'
-  Enabled: true
-
-Style/MethodDefParentheses:
-  Description: >-
-                 Checks if the method definitions have or don't have
-                 parentheses.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens'
-  Enabled: true
-
-Naming/MethodName:
-  Description: 'Use the configured style when naming methods.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars'
-  Enabled: true
-
-Style/NestedTernaryOperator:
-  Description: 'Use one expression per branch in a ternary operator.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-ternary'
-  Enabled: true
-
-Style/NilComparison:
-  Description: 'Prefer x.nil? to x == nil.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
-  Enabled: true
-
-Style/NonNilCheck:
-  Description: 'Checks for redundant nil checks.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-non-nil-checks'
-  Enabled: true
-
-Layout/SpaceAroundKeyword:
-  Description: 'Put a space before the modifier keyword.'
-  Enabled: true
-
-Layout/Tab:
-  Description: 'No hard tabs.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-indentation'
-  Enabled: true
-
-Layout/TrailingBlankLines:
-  Description: 'Checks trailing blank lines and final newline.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#newline-eof'
-  Enabled: true
-
-Layout/TrailingWhitespace:
-  Description: 'Avoid trailing whitespace.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-whitespace'
-  Enabled: true
-
-Style/UnlessElse:
-  Description: >-
-                 Do not use unless with else. Rewrite these with the positive
-                 case first.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-else-with-unless'
-  Enabled: true
-
-Naming/VariableName:
-  Description: 'Use the configured style when naming variables.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars'
-  Enabled: true
-
-#################### Lint ################################
-### Warnings
-
-Lint/AmbiguousOperator:
-  Description: >-
-                 Checks for ambiguous operators in the first argument of a
-                 method invocation without parentheses.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-as-args'
-  Enabled: true
-
-Lint/AmbiguousRegexpLiteral:
-  Description: >-
-                 Checks for ambiguous regexp literals in the first argument of
-                 a method invocation without parenthesis.
-  Enabled: true
-
-Lint/AssignmentInCondition:
-  Description: "Don't use assignment in conditions."
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition'
-  Enabled: true
-
-Lint/BlockAlignment:
-  Description: 'Align block ends correctly.'
-  Enabled: true
-
-Lint/CircularArgumentReference:
-  Description: "Don't refer to the keyword argument in the default value."
-  Enabled: true
-
-Lint/ConditionPosition:
-  Description: >-
-                 Checks for condition placed in a confusing position relative to
-                 the keyword.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
-  Enabled: true
-
-Lint/Debugger:
-  Description: 'Check for debugger calls.'
-  Enabled: true
-
-Lint/DefEndAlignment:
-  Description: 'Align ends corresponding to defs correctly.'
-  Enabled: true
-
-Lint/DeprecatedClassMethods:
-  Description: 'Check for deprecated class method calls.'
-  Enabled: true
-
-Lint/DuplicateMethods:
-  Description: 'Check for duplicate methods calls.'
-  Enabled: true
-
-Lint/DuplicatedKey:
-  Description: 'Check for duplicate keys in hash literals.'
-  Enabled: true
-
-Lint/EachWithObjectArgument:
-  Description: 'Check for immutable argument given to each_with_object.'
-  Enabled: true
-
-Lint/ElseLayout:
-  Description: 'Check for odd code arrangement in an else block.'
-  Enabled: true
-
-Lint/EmptyEnsure:
-  Description: 'Checks for empty ensure block.'
-  Enabled: true
-
-Lint/EmptyInterpolation:
-  Description: 'Checks for empty string interpolation.'
-  Enabled: true
-
-Lint/EndAlignment:
-  Description: 'Align ends correctly.'
-  Enabled: true
-
-Lint/EndInMethod:
-  Description: 'END blocks should not be placed inside method definitions.'
-  Enabled: true
-
-Lint/EnsureReturn:
-  Description: 'Do not use return in an ensure block.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-return-ensure'
-  Enabled: true
-
-Security/Eval:
-  Description: 'The use of eval represents a serious security risk.'
-  Enabled: true
-
-Lint/FormatParameterMismatch:
-  Description: 'The number of parameters to format/sprint must match the fields.'
-  Enabled: true
-
-Lint/HandleExceptions:
-  Description: "Don't suppress exception."
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
-  Enabled: true
-
-Lint/LiteralInCondition:
-  Description: 'Checks of literals used in conditions.'
-  Enabled: true
-
-Lint/LiteralInInterpolation:
-  Description: 'Checks for literals used in interpolation.'
-  Enabled: true
-
-Lint/Loop:
-  Description: >-
-                 Use Kernel#loop with break rather than begin/end/until or
-                 begin/end/while for post-loop tests.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#loop-with-break'
-  Enabled: true
-
-Lint/NestedMethodDefinition:
-  Description: 'Do not use nested method definitions.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-methods'
-  Enabled: true
-
-Lint/NonLocalExitFromIterator:
-  Description: 'Do not use return in iterator to cause non-local exit.'
-  Enabled: true
-
-Lint/ParenthesesAsGroupedExpression:
-  Description: >-
-                 Checks for method calls with a space before the opening
-                 parenthesis.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces'
-  Enabled: true
-
-Lint/RequireParentheses:
-  Description: >-
-                 Use parentheses in the method call to avoid confusion
-                 about precedence.
-  Enabled: true
-
-Lint/RescueException:
-  Description: 'Avoid rescuing the Exception class.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-blind-rescues'
-  Enabled: true
-
-Lint/ShadowingOuterLocalVariable:
-  Description: >-
-                 Do not use the same name as outer local variable
-                 for block arguments or block local variables.
-  Enabled: true
-
-Layout/SpaceBeforeFirstArg:
-  Description: >-
-                 Put a space between a method name and the first argument
-                 in a method call without parentheses.
-  Enabled: true
-
-Lint/StringConversionInInterpolation:
-  Description: 'Checks for Object#to_s usage in string interpolation.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-to-s'
-  Enabled: true
-
-Lint/UnderscorePrefixedVariableName:
-  Description: 'Do not use prefix `_` for a variable that is used.'
-  Enabled: true
-
-Lint/UnneededDisable:
-  Description: >-
-                 Checks for rubocop:disable comments that can be removed.
-                 Note: this cop is not disabled when disabling all cops.
-                 It must be explicitly disabled.
-  Enabled: true
-
-Lint/UnusedBlockArgument:
-  Description: 'Checks for unused block arguments.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
-  Enabled: true
-
-Lint/UnusedMethodArgument:
-  Description: 'Checks for unused method arguments.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
-  Enabled: true
-
-Lint/UnreachableCode:
-  Description: 'Unreachable code.'
-  Enabled: true
-
-Lint/UselessAccessModifier:
-  Description: 'Checks for useless access modifiers.'
-  Enabled: true
-
-Lint/UselessAssignment:
-  Description: 'Checks for useless assignment to a local variable.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
-  Enabled: true
-
-Lint/UselessComparison:
-  Description: 'Checks for comparison of something with itself.'
-  Enabled: true
-
-Lint/UselessElseWithoutRescue:
-  Description: 'Checks for useless `else` in `begin..end` without `rescue`.'
-  Enabled: true
-
-Lint/UselessSetterCall:
-  Description: 'Checks for useless setter call to a local variable.'
-  Enabled: true
-
-Lint/Void:
-  Description: 'Possible use of operator/literal/variable in void context.'
-  Enabled: true