updox 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec52e4b2310bf45c257d8c4092d3c65f2d9586e49ef18b9600943af750d8af5
-  data.tar.gz: 26a29009d85aab28861408b7266910c752486e9e93771e6d01601a3a76b426a5
+  metadata.gz: d1a4c56774d2ae35862e3f78e7d30f846e6d46718f4ef6085e32046f9d88c9d0
+  data.tar.gz: 89cb3f917db60bc0b987c30493a8d43abb34f984ac183580703f0ddf0add6adc
 SHA512:
-  metadata.gz: 0c539a3fc2bc50adafb03ec452e2c3a738fe476bbcd3bde154f8f6e16f861584770bfaceea9f2461ade369cbc6f617b95204840ba94ef6d29e340bfee7caaebe
-  data.tar.gz: 8a6fd9fd5711d3e6ba8dc8d3d607ffee81ca51f1980572f3364f1761c9c02fd596f89ed61939137dd5ae4e2152201734a3d9d78089a462c4707892af30ed2518
+  metadata.gz: f29e44f7ee6cfc00923d8c09fb53a3005ab462460b8cc7ff3a6199f09d7aa75c3f3c4060bf7ddae8bcc1d9bbb1f69dcddd40eced124c93da58d6fedf032182fc
+  data.tar.gz: 127d6d020b096c7e87c3a0267fa740340c41a4025f097db4cbb9fb7c36be790f37737e893f3241bd9558f61f3a700cbb4166a59f8ad0914ec35437c257a0627a

data/CHANGELOG.md

@@ -4,6 +4,19 @@ 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).
 
+## [0.5.0] - 2020-02-13
+### Added
+- Practice#find
+- Practice#exists?
+- Location#query
+- Location#find
+- Location#exists?
+- User#find
+- Locaiton find and exists? have `cache` option
+
+### Changed
+- Any model class returned has `successful?`, `response_code` and `response_message`
+
 ## [0.4.0] - 2020-02-11
 ### Changed
 - Minor grammar fixes
@@ -25,6 +38,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Initial Release with ability to ping Updox api
 
+[0.5.0]: https://github.com/WeInfuse/updox/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/WeInfuse/updox/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/WeInfuse/updox/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/WeInfuse/updox/compare/v0.1.0...v0.2.0

data/README.md

@@ -47,6 +47,12 @@ practice.create
 practices = Updox::Models::Practice.query.practices
 ```
 
+#### Find
+```ruby
+practice = Updox::Models::Practice.find('0001')
+```
+
+
 ### Location
 
 #### Create
@@ -59,6 +65,37 @@ location.save(account_id: practice.account_id)
 Location.sync([l0, l1], account_id: practice.account_id)
 ```
 
+#### Query
+```ruby
+locations = Updox::Models::Location.query(account_id: '0001')
+```
+
+#### Find
+There is no `find` in the api, we are doing a ruby `find` on the query - so use the `cached_query` option if you are doing a bunch of lookups
+
+```ruby
+location = Updox::Models::Location.find(27, account_id: '0001')
+
+cached_query_results = Updox::Models::Location.query(account_id: '0001')
+
+10.times do |id|
+  Updox::Models::Location.find(id, account_id: '0001', cached_query: cached_query_results)
+end
+```
+
+#### Exists?
+See note on #find method about caching
+
+```ruby
+Updox::Models::Location.exists?(27, account_id: '0001')
+
+cached_query_results = Updox::Models::Location.query(account_id: '0001')
+
+10.times do |id|
+  Updox::Models::Location.exists?(id, account_id: '0001', cached_query: cached_query_results)
+end
+```
+
 ### Calendar
 
 #### Create
@@ -93,11 +130,13 @@ Appointment.sync([appt0, appt1, appt2], account_id: practice.account_id)
 ```
 
 ### Response
-By default we return `Updox::Models::Model.from_response`
+By default we usually return `Updox::Models::Model.from_response`
 
-This class throws if throw an exception on bad responses with a parsed error.
+This class throws if throw an exception on non 200 responses with a parsed error.
 
-If successful it adds helper methods and converts each to the respective class.
+Updox usually returns a `200` with error information even on things like `Unauthorized`. So you may have to check the updox status via `successful?` method.
+
+If HTTP 200 it adds helper methods and converts each to the respective class.
 
 The raw response is stored in the resulting model but you can get the raw response by setting config option to false
 
@@ -106,6 +145,11 @@ response = Updox::Models::Practice.query
 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.response # Raw HTTParty response is here
 ```
 

data/lib/updox/connection.rb

@@ -8,8 +8,11 @@ module Updox
 
     format :json
 
-    def request(endpoint: Updox::Models::Auth::PING_ENDPOINT, body: {}, headers: {}, auth: Updox::Models::Auth.new, required_auths: [])
+    def request(endpoint: Updox::Models::Auth::PING_ENDPOINT, body: {}, headers: {}, auth: Updox::Models::Auth.new, required_auths: [], account_id: nil, user_id: nil)
       if body.is_a?(Hash)
+        auth[:accountId] = account_id unless account_id.nil?
+        auth[:userId]    = user_id unless user_id.nil?
+
         body = auth_data(auth, required_auths).merge(body)
         body = body.to_json
       end

data/lib/updox/models/location.rb

@@ -2,21 +2,57 @@ module Updox
   module Models
     class Location < Model
       SYNC_ENDPOINT  = '/LocationsSync'.freeze
+      LIST_ENDPOINT  = '/PracticeLocationsRetrieve'.freeze
+
+      LIST_TYPE = 'locations'
+      LIST_NAME = LIST_TYPE
 
       property :id
       property :code
       property :name
+      property :address1
+      property :address2
+      property :city
+      property :state
+      property :zip
+      property :dayphone, from: :phone
+      property :evephone
+      property :faxphone, from: :fax
+      property :apptphone
+      property :emailAddress, from: :email
+      property :emailAddress, from: :email_address
       property :showInPortal, default: false, from: :show_in_portal
       property :active, default: true
 
+      # This is only on response
+      property :external_id, from: :externalId
+
       alias_method :show_in_portal, :showInPortal
+      alias_method :phone, :dayphone
+      alias_method :fax, :faxphone
+      alias_method :email, :emailAddress
+      alias_method :email_address, :emailAddress
 
       def save(account_id: )
         self.class.sync([self], account_id: account_id)
       end
 
+      def self.exists?(location_id, account_id: , cached_query: nil)
+        false == self.find(location_id, account_id: account_id, cached_query: cached_query).nil?
+      end
+
+      def self.find(location_id, account_id: , cached_query: nil)
+        obj = cached_query || self.query(account_id: account_id)
+
+        obj.locations.find {|location| location_id.to_s == location.external_id.to_s }
+      end
+
+      def self.query(account_id: , active_only: false)
+        from_response(UpdoxClient.connection.request(endpoint: LIST_ENDPOINT, body: { activeOnly: active_only }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT))
+      end
+
       def self.sync(locations, account_id: )
-        from_response(UpdoxClient.connection.request(endpoint: SYNC_ENDPOINT, body: { locations: locations }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT), self)
+        from_response(UpdoxClient.connection.request(endpoint: SYNC_ENDPOINT, body: { locations: locations }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT))
       end
     end
   end

data/lib/updox/models/model.rb

@@ -8,9 +8,23 @@ module Updox
 
       LIST_TYPE = 'undefined'
       LIST_NAME = 'models'
+      ITEM_TYPE = 'model'
 
       property :item, required: false
       property :items, required: false
+      property :updox_status, default: {}
+
+      def successful?
+        self[:updox_status].dig('successful')
+      end
+
+      def response_code
+        self[:updox_status].dig('responseCode')
+      end
+
+      def response_message
+        self[:updox_status].dig('responseMessage')
+      end
 
       def self.from_response(response, klazz = self)
         return response if false == Updox.configuration.parse_responses?
@@ -26,10 +40,15 @@ module Updox
           elsif data&.include?(klazz.const_get(:LIST_TYPE))
             model.items = data.dig(klazz.const_get(:LIST_TYPE)).map { |obj| klazz.new(obj) }
             model.define_singleton_method(klazz.const_get(:LIST_NAME)) { self.items }
+          elsif data&.include?(klazz.const_get(:ITEM_TYPE))
+            model.item = klazz.new(data.dig(klazz.const_get(:ITEM_TYPE)))
+            model.define_singleton_method(klazz.const_get(:ITEM_TYPE)) { self.item }
           else
             model.items = [data]
             model.item  = data
           end
+
+          model.updox_status = data&.select {|k,v| ['successful', 'responseMessage', 'responseCode'].include?(k)} || {}
         else
           raise UpdoxException.from_response(response)
         end

data/lib/updox/models/patient.rb

@@ -8,10 +8,12 @@ module Updox
       property :firstName, from: :first_name
       property :middleName, from: :middle_name
       property :lastName, from: :last_name
+      property :emailAddress, from: :email
       property :emailAddress, from: :email_address
       property :homePhone, from: :home_phone
       property :workPhone, from: :work_phone
       property :mobileNumber, from: :mobile_number
+      property :mobileNumber, from: :mobile_phone
       property :active, default: true
 
       alias_method :email, :emailAddress

data/lib/updox/models/practice.rb

@@ -2,10 +2,12 @@ module Updox
   module Models
     class Practice < Model
       CREATE_ENDPOINT = '/PracticeCreate'.freeze
+      FIND_ENDPOINT   = '/PracticeGet'.freeze
       QUERY_ENDPOINT  = '/PracticeList'.freeze
 
       LIST_TYPE = 'practiceList'.freeze
       LIST_NAME = 'practices'
+      ITEM_TYPE = 'practice'
 
       property :name, required: true
       property :accountId, from: :account_id, with: ->(v) { v.to_s }
@@ -13,7 +15,7 @@ module Updox
       property :address2
       property :city
       property :state
-      property :postal
+      property :postal, from: :zip
       property :phone
       property :fax
       property :websiteAddress, from: :website_address
@@ -31,13 +33,22 @@ module Updox
       property :active, default: true
 
       alias_method :account_id, :accountId
+      alias_method :zip, :postal
 
       def create
         UpdoxClient.connection.request(endpoint: CREATE_ENDPOINT, body: self.to_h, required_auths: Updox::Models::Auth::AUTH_APP)
       end
 
+      def self.exists?(account_id)
+        self.find(account_id).successful?
+      end
+
+      def self.find(account_id)
+        from_response(UpdoxClient.connection.request(endpoint: FIND_ENDPOINT, body: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_APP))
+      end
+
       def self.query
-        from_response(UpdoxClient.connection.request(endpoint: QUERY_ENDPOINT, required_auths: Updox::Models::Auth::AUTH_APP), self)
+        from_response(UpdoxClient.connection.request(endpoint: QUERY_ENDPOINT, required_auths: Updox::Models::Auth::AUTH_APP))
       end
     end
   end

data/lib/updox/models/user.rb

@@ -3,9 +3,11 @@ module Updox
     class User < Model
       SAVE_ENDPOINT  = '/UserSave'.freeze
       QUERY_ENDPOINT = '/UserList'.freeze
+      FIND_ENDPOINT  = '/UserGet'.freeze
 
       LIST_TYPE = 'userList'.freeze
       LIST_NAME = 'users'
+      ITEM_TYPE = 'user'
 
       property :userId, from: :user_id
       property :emrUserId, from: :emr_user_id
@@ -32,8 +34,12 @@ module Updox
         UpdoxClient.connection.request(endpoint: SAVE_ENDPOINT, body: self.to_h, required_auths: Updox::Models::Auth::AUTH_APP)
       end
 
+      def self.find(user_id, account_id: )
+        from_response(UpdoxClient.connection.request(endpoint: FIND_ENDPOINT, account_id: account_id, body: { userId: user_id}, required_auths: Updox::Models::Auth::AUTH_ACCT))
+      end
+
       def self.query
-        from_response(UpdoxClient.connection.request(endpoint: QUERY_ENDPOINT, required_auths: Updox::Models::Auth::AUTH_APP), self)
+        from_response(UpdoxClient.connection.request(endpoint: QUERY_ENDPOINT, required_auths: Updox::Models::Auth::AUTH_APP))
       end
     end
   end

data/lib/updox/version.rb

@@ -1,3 +1,3 @@
 module Updox
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: updox
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Crockett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty