updox 0.12.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd8b2034246435b98b4d29ec70697b0d89d8d2ff6ec802cea01eb8ae70084eed
-  data.tar.gz: 07ce5cb4a144d0c244b975105795e561e0006e2ec9e355b563cd680355302a4f
+  metadata.gz: 1f62aa99da193e378457e56e3a055b4d52973c4cae2bb4944f2e300e51287064
+  data.tar.gz: e399c7debeefac7f7608579f056db93cdf3ea24ace47e4173c96adb0d176f87f
 SHA512:
-  metadata.gz: da03e1b1cf8aa70cb65e1e91b0147b2680f7e5307695c9ad071dd0f08d546ba122b43c3c5576b40d7699196d2121d0cffa9365822bca4c0b5a77b2def5f4c567
-  data.tar.gz: 9afd1c083421450366536f88212a27ae2142dafff9c9f5928b9976a2faa3c2896ac7ede4cf18bdc16bc49001804f0ba415f23191d8960f427b3697553a7e805d
+  metadata.gz: 3654a26917f7d18de3661921fe72253fbdbc9b7d518f6a9465cde9ee84d5ef65b0ad62e480213618ad676cdf6b74ff6b510bad05e917603c5c2956b69d9c8318
+  data.tar.gz: 82f90067272574222de2a8009b49c0109696a626aea6800c0b415e842a17026b1efa75c8f65cddc5e7493d4616163cee0e4df9e12f44a60514488c7eadc4a611

data/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.0.0] - [UNRELEASED]
+### Added
+- Aliases canceled to cancelled
+- Patient#exists?
+
+### Fixed
+- `failure_action = :raise` works better
+- README fix for `failure_action` method
+
 ## [0.12.0] - [2020-02-21]
 ### Added
 - Configuration to `raise` on non-success response
@@ -89,7 +98,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Initial Release with ability to ping Updox api
 
-[0.12.0]: https://github.com/WeInfuse/updox/compare/v0.11.0...HEAD
+[1.0.0]: https://github.com/WeInfuse/updox/compare/v0.12.0...HEAD
+[0.12.0]: https://github.com/WeInfuse/updox/compare/v0.11.0...v0.12.0
 [0.11.0]: https://github.com/WeInfuse/updox/compare/v0.10.0...v0.11.0
 [0.10.0]: https://github.com/WeInfuse/updox/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/WeInfuse/updox/compare/v0.8.0...v0.9.0

data/README.md

@@ -146,9 +146,9 @@ response.practices # Has the practices as Updox::Models::Practice model
 response.items # Same as practices, always exists on any model if alias is broken
 response.item  # If there is no array, we populate this object
 
-resposne.successful? # Indicates Updox successful indication
-resposne.response_code? # Indicates Updox response code
-resposne.response_message? # Indicates Updox response message
+response.successful? # Indicates Updox successful indication
+response.response_code? # Indicates Updox response code
+response.response_message? # Indicates Updox response message
 
 response.response # Raw HTTParty response is here
 ```
@@ -159,9 +159,9 @@ response.response # Raw HTTParty response is here
 Updox.configure do |c|
   c.application_id       = ENV['UPDOX_APP_ID']
   c.application_password = ENV['UPDOX_APP_PASS']
-  c.api_endpoint = 'http://hello.com' # Defaults to Updox endpoint
+  c.api_endpoint = Updox::Connection::PROD_ENDPOINT # Defaults to Updox QA endpoint
   c.parse_responses = false # Defaults to true
-  c.failure_response = :raise # Defaults to do nothing and allows lambdas
+  c.failure_action = :raise # Defaults to do nothing and allows lambdas
 end
 ```
 

data/lib/updox.rb

@@ -4,6 +4,8 @@ require 'updox/version'
 require 'updox/updox_exception'
 require 'updox/connection'
 require 'updox/models/model'
+require 'updox/models/extensions/exists'
+require 'updox/models/extensions/sync'
 require 'updox/models/auth'
 require 'updox/models/application'
 require 'updox/models/appointment'
@@ -11,6 +13,7 @@ require 'updox/models/appointment_status'
 require 'updox/models/calendar'
 require 'updox/models/location'
 require 'updox/models/patient'
+require 'updox/models/patient_message'
 require 'updox/models/practice'
 require 'updox/models/reminder'
 require 'updox/models/status'

data/lib/updox/connection.rb

@@ -1,11 +1,13 @@
 module Updox
   class Connection
-    TEST_HOST = 'updoxqa.com'
-    PROD_HOST = 'xxxxxxx.com'
+    URI_BUILDER = ->(host) { "https://#{host}/api/io/".freeze }
+
+    QA_ENDPOINT   = URI_BUILDER.call('updoxqa.com')
+    PROD_ENDPOINT = URI_BUILDER.call('myupdox.com')
 
     include HTTParty
 
-    base_uri "https://#{TEST_HOST}/api/io/".freeze
+    base_uri QA_ENDPOINT
 
     headers 'Content-Type' => 'application/json'
 

data/lib/updox/error_message.rb

@@ -0,0 +1,60 @@
+module Updox
+  ERROR_CODES = {
+    "2000"=>"OK",
+    "4000"=>"Bad Request",
+    "4010"=>"Unauthorized",
+    "4011"=>"Unauthorized [Practice does not exist or is inactive]",
+    "4012"=>"Unauthorized [User does not exist or is inactive]",
+    "4060"=>"A validation error in the request. For example not including a required field, an invalid e-mail address, too long of a value, etc. A list of the errors is included in the message.",
+    "5000"=>"an unknown error has occurred",
+    "5100"=>"an unknown server error has occurred",
+    "5110"=>"an unknown server error has occurred",
+    "4130"=>"account already exists",
+    "4110"=>"no practice ID",
+    "4160"=>"direct domain is invalid",
+    "4621"=>"direct address error: domain does not match the direct domain for this vendor",
+    "4150"=>"direct domain is already taken",
+    "4163"=>"direct domain is unavailable",
+    "4610"=>"direct address error: direct address is taken",
+    "4161"=>"web address is invalid",
+    "4131"=>"account does not exist",
+    "4140"=>"web address is already taken",
+    "4230"=>"user already exists",
+    "4210"=>"no user ID",
+    "4241"=>"invalid user ID, user IDs starting with '@' are reserved for practice users",
+    "4251"=>"invalid NPI",
+    "4252"=>"invalid taxonomy code",
+    "4630"=>"direct address error: account does not have a direct domain configured",
+    "4232"=>"user password is required",
+    "4240"=>"user does not exist, use practice methods instead",
+    "4231"=>"user does not exist",
+    "4641"=>"direct address error: sending user does not have a direct address configured",
+    "4642"=>"direct address error: identity verification required to send to this address",
+    "4640"=>"direct address error: invalid direct address",
+    "4650"=>"direct error: send failed",
+    "4651"=>"direct error: send failed and/or invalid direct address",
+    "4430"=>"message type does not have any MDNs",
+    "4410"=>"message not found",
+    "4652"=>"direct error: either from or patientDemographics is required",
+    "4071"=>"Recipient not found",
+    "4070"=>"Invalid recipient",
+    "4831"=>"portal account does not exist",
+    "4830"=>"portal account already exists",
+    "4832"=>"patient has opted out of portal communications",
+    "4731"=>"patient account does not exist",
+    "4960"=>"image not found",
+    "4331"=>"contact does not exist",
+    "4931"=>"you sent zero bulk faxes with this bulkFaxId",
+    "4021"=>"Invalid date format",
+    "4930"=>"no fax found for this ID",
+    "4932"=>"fax number does not appear to be available",
+    "4933"=>"invalid fax number",
+    "4330"=>"contact already exists",
+    "6212"=>"at least one id must be specified for the request",
+    "4162"=>"ip is invalid",
+    "4165"=>"port is invalid",
+    "6210"=>"at least one value must be provided",
+    "6213"=>"record does not exist for ID",
+    "9010"=>"the date format must be in the format is yyyy-MM-dd"
+  }
+end

data/lib/updox/models/appointment.rb

@@ -1,6 +1,8 @@
 module Updox
   module Models
     class Appointment < Model
+      extend Updox::Models::Extensions::Sync
+
       SYNC_ENDPOINT  = '/AppointmentsSync'.freeze
 
       SYNC_LIST_TYPE = 'appointments'.freeze
@@ -14,8 +16,8 @@ module Updox
       property :typeId, from: :type_id
       property :summary
       property :details
-      property :blocked, required: true, transform_with: ->(v) { true == v }, default: false
-      property :cancelled, required: true, transform_with: ->(v) { true == v }, default: false
+      property :blocked, required: true, default: false
+      property :cancelled, required: true, from: :canceled, default: false
       property :locationId, from: :location_id
       property :reminderTokens, from: :reminder_tokens
 
@@ -25,6 +27,7 @@ module Updox
       alias_method :type_id, :typeId
       alias_method :location_id, :locationId
       alias_method :reminder_tokens, :reminderTokens
+      alias_method :canceled, :cancelled
 
       def to_h
         result = super.to_h

data/lib/updox/models/appointment_status.rb

@@ -1,6 +1,8 @@
 module Updox
   module Models
     class AppointmentStatus < Model
+      extend Updox::Models::Extensions::Exists
+
       LIST_ENDPOINT  = '/AppointmentStatusesGetByIds'.freeze
 
       LIST_TYPE = 'appointmentStatuses'

data/lib/updox/models/calendar.rb

@@ -1,6 +1,8 @@
 module Updox
   module Models
     class Calendar < Model
+      extend Updox::Models::Extensions::Exists
+
       SYNC_ENDPOINT = '/CalendarsSync'.freeze
       LIST_ENDPOINT  = '/PracticeCalendarsRetrieve'.freeze
 

data/lib/updox/models/extensions/exists.rb

@@ -0,0 +1,17 @@
+module Updox
+  module Models
+    module Extensions
+      module Exists
+        def exists?(item_id, account_id: , cached_query: nil)
+          raise UpdoxException.new('Not implemented on this model.') unless self.respond_to?(:find)
+          opts = { account_id: account_id }
+          opts[:cached_query] = cached_query unless cached_query.nil?
+
+          response = self.find(item_id, **opts)
+
+          false == response.nil?
+        end
+      end
+    end
+  end
+end

data/lib/updox/models/extensions/sync.rb

@@ -0,0 +1,32 @@
+module Updox
+  module Models
+    module Extensions
+      module Sync
+        RECOMMENDED_BATCH_SIZE = 200
+
+        def sync(items, account_id: , batch_size: RECOMMENDED_BATCH_SIZE, endpoint: self.const_get(:SYNC_ENDPOINT))
+          response  = nil
+          list_type = self.const_get(:SYNC_LIST_TYPE)
+
+          if 0 >= batch_size
+            response = request(endpoint: endpoint, body: { list_type => items }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT)
+          else
+            items.each_slice(batch_size) do |batch|
+              r = request(endpoint: endpoint, body: { list_type => batch }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT)
+
+              return r unless r.successful?
+
+              if response
+                response.items += r.items
+              else
+                response = r
+              end
+            end
+          end
+
+          return response
+        end
+      end
+    end
+  end
+end

data/lib/updox/models/location.rb

@@ -1,6 +1,9 @@
 module Updox
   module Models
     class Location < Model
+      extend Updox::Models::Extensions::Exists
+      extend Updox::Models::Extensions::Sync
+
       SYNC_ENDPOINT  = '/LocationsSync'.freeze
       LIST_ENDPOINT  = '/PracticeLocationsRetrieve'.freeze
 

data/lib/updox/models/model.rb

@@ -1,9 +1,7 @@
 module Updox
   module Models
     DATETIME_FORMAT = '%Y-%m-%d %H:%M'.freeze
-    DATETIME_OTHER_FORMAT = '%m/%d/%Y %H:%M:%s %z'.freeze
-
-    RECOMMENDED_BATCH_SIZE = 200
+    DATETIME_TZ_FORMAT = '%m/%d/%Y %H:%M:%s %z'.freeze
 
     class Model < Hashie::Trash
       include Hashie::Extensions::IgnoreUndeclared
@@ -33,39 +31,6 @@ module Updox
         "#{response_code}: #{response_message}"
       end
 
-      def self.exists?(item_id, account_id: , cached_query: nil)
-        raise UpdoxException.new('Not implemented on this model.') unless self.respond_to?(:find)
-        opts = { account_id: account_id }
-        opts[:cached_query] = cached_query unless cached_query.nil?
-
-        response = self.find(item_id, **opts)
-
-        false == response.nil? && (false == self.const_defined?(:FIND_ENDPOINT) || response.successful?)
-      end
-
-      def self.sync(items, account_id: , batch_size: RECOMMENDED_BATCH_SIZE, endpoint: self.const_get(:SYNC_ENDPOINT))
-        response  = nil
-        list_type = self.const_get(:SYNC_LIST_TYPE)
-
-        if 0 >= batch_size
-          response = request(endpoint: endpoint, body: { list_type => items }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT)
-        else
-          items.each_slice(batch_size) do |batch|
-            r = request(endpoint: endpoint, body: { list_type => batch }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT)
-
-            return r unless r.successful?
-
-            if response
-              response.items += r.items
-            else
-              response = r
-            end
-          end
-        end
-
-        return response
-      end
-
       def self.request(**kwargs)
         from_response(UpdoxClient.connection.request(kwargs))
       end
@@ -88,15 +53,15 @@ module Updox
             model.item = klazz.new(data.dig(klazz.const_get(:ITEM_TYPE)))
             model.define_singleton_method(klazz.const_get(:ITEM_TYPE)) { self.item }
           else
-            k = data&.keys&.find {|k| k.to_s.downcase.end_with?('statuses') }
-            c = 'Updox::Models::' + k[0..-3].capitalize if k
+            status_key   = data&.keys&.find {|k| k.to_s.downcase.end_with?('statuses') }
+            status_class = 'Updox::Models::' + status_key[0..-3].capitalize if status_key
 
-            if k.nil? || false == Module.const_defined?(c)
+            if status_key.nil? || false == Module.const_defined?(status_class)
               model.items = [data]
             else
-              statuses = data.delete(k)
+              statuses = data.delete(status_key)
 
-              model.items = statuses.map {|status| Object.const_get(c).new(status) }
+              model.items = statuses.map {|status| Object.const_get(status_class).new(status) }
               model.define_singleton_method(:statuses) { self.items }
             end
 

data/lib/updox/models/patient.rb

@@ -1,6 +1,8 @@
 module Updox
   module Models
     class Patient < Model
+      extend Updox::Models::Extensions::Sync
+
       SYNC_ENDPOINT  = '/PatientsSync'.freeze
       SYNC_LIST_TYPE = 'patients'.freeze
 
@@ -33,7 +35,7 @@ module Updox
       end
 
       def self.exists?(patient_id, account_id: )
-        request(endpoint: MESSAGE_COUNT_ENDPOINT, body: { patientId: patient_id }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT).successful?
+        Updox::Models::PatientMessage.exists?(patient_id, account_id: account_id)
       end
     end
   end

data/lib/updox/models/patient_message.rb

@@ -0,0 +1,15 @@
+module Updox
+  module Models
+    class PatientMessage < Model
+      LIST_ENDPOINT  = '/PatientMessageCountSince'.freeze
+
+      def self.query(patient_id, account_id: )
+        request(endpoint: LIST_ENDPOINT, body: { patientId: patient_id }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT)
+      end
+
+      def self.exists?(patient_id, account_id: )
+        request(endpoint: LIST_ENDPOINT, body: { patientId: patient_id }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT).successful?
+      end
+    end
+  end
+end

data/lib/updox/models/practice.rb

@@ -40,11 +40,17 @@ module Updox
       end
 
       def self.exists?(account_id)
-        self.find(account_id).successful?
+        false == self.find(account_id).nil?
       end
 
       def self.find(account_id)
-        request(endpoint: FIND_ENDPOINT, body: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_APP)
+        response = request(endpoint: FIND_ENDPOINT, body: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_APP)
+
+        if response.successful?
+          response
+        else
+          nil
+        end
       end
 
       def self.query

data/lib/updox/models/reminder.rb

@@ -3,7 +3,7 @@ module Updox
     class Reminder < Model
       property :reminderId
       property :reminderStatus
-      property :reminderStatusDate, transform_with: ->(v) { DateTime.strptime(v, DATETIME_OTHER_FORMAT) unless v.nil? || v.empty? }
+      property :reminderStatusDate, transform_with: ->(v) { DateTime.strptime(v, DATETIME_TZ_FORMAT) unless v.nil? || v.empty? }
       property :reminderType
 
       alias_method :reminder_id, :reminderId

data/lib/updox/models/user.rb

@@ -1,6 +1,8 @@
 module Updox
   module Models
     class User < Model
+      extend Updox::Models::Extensions::Exists
+
       SAVE_ENDPOINT  = '/UserSave'.freeze
       QUERY_ENDPOINT = '/UserList'.freeze
       FIND_ENDPOINT  = '/UserGet'.freeze
@@ -45,7 +47,13 @@ module Updox
       end
 
       def self.find(user_id, account_id: )
-        request(endpoint: FIND_ENDPOINT, account_id: account_id, body: { userId: user_id}, required_auths: Updox::Models::Auth::AUTH_ACCT)
+        response = request(endpoint: FIND_ENDPOINT, account_id: account_id, body: { userId: user_id}, required_auths: Updox::Models::Auth::AUTH_ACCT)
+
+        if response.successful?
+          response
+        else
+          nil
+        end
       end
 
       def self.query

data/lib/updox/version.rb

@@ -1,3 +1,3 @@
 module Updox
-  VERSION = '0.12.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: updox
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Crockett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -142,14 +142,18 @@ files:
 - Rakefile
 - lib/updox.rb
 - lib/updox/connection.rb
+- lib/updox/error_message.rb
 - lib/updox/models/application.rb
 - lib/updox/models/appointment.rb
 - lib/updox/models/appointment_status.rb
 - lib/updox/models/auth.rb
 - lib/updox/models/calendar.rb
+- lib/updox/models/extensions/exists.rb
+- lib/updox/models/extensions/sync.rb
 - lib/updox/models/location.rb
 - lib/updox/models/model.rb
 - lib/updox/models/patient.rb
+- lib/updox/models/patient_message.rb
 - lib/updox/models/practice.rb
 - lib/updox/models/reminder.rb
 - lib/updox/models/status.rb