updox 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eeab31e87fabd58b70a27bcf1a2012ba06ac93421d23861cc246d12bcf3614f
-  data.tar.gz: c4969565b9a34f4f87afacf4bd1e26165e04e17bc931457dfebc9108acb037b7
+  metadata.gz: 0bbcd6275257fa4aec9f5d2ee479d2e40cc35c6c1554b0d6daa32edf9dec4cd5
+  data.tar.gz: e3358374b773851ce3958441b264a7983f7944ebfc93dfeb9b8e2a6036a6457a
 SHA512:
-  metadata.gz: a32b3b74cc2f7afd897418274d8a041a02602c0fabf783ea2a6bcf172750cdbaa2af5873a8a7ac48e0e4ec047a5bcc26a50a8db8a759ceb662587cea54a19fd1
-  data.tar.gz: 451421900c7777190b72db3c95a8124a3294c0b0c945ac28cb08b263015b7222c5d276252e80c9cbbab637c13273fa909aa91bbb6bee69ffa6297a0f546cca93
+  metadata.gz: e848a98e0ecefbd2578478a1ce22b69b5c41c1e3f4e56aecf4a7a864aec2cb4f42c6ae133a3649603c62b2b4a4b7793b4facf07a4a9d6e27ffa6185c4211a2b5
+  data.tar.gz: 2cbe79662dfe9ee1e237b29bd37c2f848bb828eb6336a5a03249460ce96642bbf952892bd013f4db2a7ed99a82be3463eeac6242f70ecb5a5a27537d59fdc285

data/CHANGELOG.md

@@ -4,13 +4,23 @@ 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.1.x] - UNRELEASED
+## [0.3.0] - UNRELEASED
 ### Changed
 - None
 
-## 0.1.0 - 2020-01-20
+## 0.2.0 - 2020-02-06
 ### Added
-- Initial Release
+- Calendar
+- Patient
+- Location
+- User
+- Appointment
+- Application
 
-[Unreleased]: https://github.com/WeInfuse/redox/compare/v1.0.2...HEAD
-[0.1.1]: https://github.com/WeInfuse/redox/compare/0.1.0...0.1.1
+## 0.1.0 - 2020-01-21
+### Added
+- Initial Release with ability to ping Updox api
+
+[Unreleased]: https://github.com/WeInfuse/updox/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/WeInfuse/updox/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/WeInfuse/updox/compare/v0.1.0

data/README.md

@@ -26,74 +26,87 @@ Or install it yourself as:
 Make sure you're [configured](#configuration)!
 
 ```ruby
-patient = Updox::Models::Patient.new
-patient.demographics.first_name = 'Joe'
-patient.demographics['LastName'] = 'Joerson'
-patient.add_identifier(type: 'TheType', value: 'x13005')
-
-meta = Updox::Models::Meta.new
-meta.set_source(name: 'MySource', id: '123-584')
-meta.add_destination(name: 'TheDest', id: '973-238')
+auth = Updox::Models::Auth.new
+
+response = auth.ping # No authentication needed!
+
+response = auth.ping_with_application_auth # Check if you're app auth is working!
 ```
 
-### Create
+### Practice
+The practice is what Updox calls 'Account' access so anywhere the `account_id` is required is relating back to this practice instance.
+
+#### Create
+```ruby
+practice = Updox::Models::Practice.new(name: 'LOL LTD', account_id: '0001', active: true)
+practice.create
+```
 
+#### List
 ```ruby
-response = patient.create(meta: meta)
+practices = Updox::Models::Practice.query.practices
 ```
 
-### Update
+### Location
+
+#### Create
 
 ```ruby
-response = patient.update(meta: meta)
+location = Updox::Models::Location.new(active: true, name: 'My Location', code: 'ML01', id: '27')
+location.save(account_id: practice.account_id)
+
+# Bulk
+Location.sync([l0, l1], account_id: practice.account_id)
 ```
 
-### Search
+### Calendar
+
+#### Create
 
 ```ruby
-response = Updox::Models::Patient.query(patient, meta: meta)
+calendar = Updox::Models::Calendar.new(active: true, title: 'My Calendar', id: 'C1')
+calendar.create(account_id: practice.account_id)
 ```
 
-### Response
+### Patient
+
+#### Create
 
-The response object is a base `Updox::Models::Model` class.
+```ruby
+patient = Updox::Models::Patient.new(id: 'X0001', internal_id: 'X0001', first_name: 'Brian', last_name: 'Brianson', mobile_number: 5126914360, active: true)
+patient.save(account_id: practice.account_id)
+
+# Bulk
+Patient.sync([p0, p1, p2], account_id: practice.account_id)
+```
+
+### Appointment
+
+#### Create
 
-With the HTTParty response object
 ```ruby
-response.response
-#<HTTParty::Response:0x7fa354c1fbe8>
+appointment = Updox::Models::Appointment.new(id: 'A0001', calendar_id: calendar.id, date: Time.now + 20, duration: 60, location_id: location.id, patient_id: patient.id)
+appointment.save(account_id: practice.account_id)
 
-response.response.ok?
-true
+# Bulk
+Appointment.sync([appt0, appt1, appt2], account_id: practice.account_id)
 ```
 
-And any `Model` objects that were returned
+### Response
+By default we return `Updox::Models::Model.from_response`
+
+This class throws if throw an exception on bad responses with a parsed error.
+
+If successful 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
+
 ```ruby
-response.patient
-{
-  "Identifiers"=> [
-      {"IDType"=>"MR", "ID"=>"0000000003"},
-      {"ID"=>"e3fedf48-c8bf-4728-845f-cb810001b571", "IDType"=>"EHRID"}
-    ],
-  "Demographics"=> {
-    "Race"=>"Black",
-    "SSN"=>"303-03-0003",
-    "Nickname"=>"Walt"
-...
-  }
-  "PCP"=> {
-    "NPI"=>nil,
-  }
-}
-
-response.meta
-{
-  "EventDateTime"=>"2019-04-26T20:03:00.304866Z",
-  "DataModel"=>"PatientAdmin",
-  ...
-  "Transmission"=>{"ID"=>797225234},
-  "Message"=>{"ID"=>1095117817}
-}
+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
+response.response # Raw HTTParty response is here
 ```
 
 ### Configuration
@@ -103,6 +116,7 @@ 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.parse_responses = false # Defaults to true
 end
 ```
 

data/lib/updox.rb

@@ -3,16 +3,26 @@ require 'hashie'
 require 'updox/version'
 require 'updox/updox_exception'
 require 'updox/connection'
+require 'updox/models/model'
 require 'updox/models/auth'
+require 'updox/models/application'
+require 'updox/models/appointment'
+require 'updox/models/calendar'
+require 'updox/models/location'
+require 'updox/models/patient'
 require 'updox/models/practice'
+require 'updox/models/user'
 
 module Updox
   class Configuration
-    attr_accessor :application_id, :application_password
+    attr_accessor :application_id, :application_password, :parse_responses
+
+    alias_method :parse_responses?, :parse_responses
 
     def initialize
       @application_id       = nil
       @application_password = nil
+      @parse_responses      = true
     end
 
     def api_endpoint=(endpoint)
@@ -27,7 +37,8 @@ module Updox
       return {
         application_id: @application_id,
         application_password: @application_password,
-        api_endpoint: api_endpoint
+        api_endpoint: api_endpoint,
+        parse_responses: @parse_responses
       }
     end
 
@@ -35,6 +46,7 @@ module Updox
       self.application_id = h[:application_id]
       self.application_password  = h[:application_password]
       self.api_endpoint = h[:api_endpoint]
+      self.parse_responses = h[:parse_responses]
 
       return self
     end

data/lib/updox/models/application.rb

@@ -0,0 +1,23 @@
+module Updox
+  module Models
+    class Application < Model
+      OPEN_ENDPOINT = '/ApplicationOpen'.freeze
+
+      property :ipAddress
+      property :timeout
+      property :metadata
+
+      def url(account_id: , user_id: , base_uri: nil)
+        response = self.open(account_id: account_id, user_id: user_id)
+
+        base_uri ||= Updox.configuration.api_endpoint.split(URI.parse(Updox.configuration.api_endpoint).path).first
+
+        "#{base_uri}/sso/applicationOpen/#{Updox.configuration.application_id}/#{response.item.dig('token')}"
+      end
+
+      def open(account_id: , user_id: )
+        Model.from_response(UpdoxClient.connection.request(endpoint: OPEN_ENDPOINT, auth: {accountId: account_id, userId: user_id}, required_auths: Updox::Models::Auth::AUTH_FULL))
+      end
+    end
+  end
+end

data/lib/updox/models/appointment.rb

@@ -0,0 +1,37 @@
+module Updox
+  module Models
+    class Appointment < Model
+      SYNC_ENDPOINT  = '/AppointmentsSync'.freeze
+
+      property :id, required: true
+      property :updoxId, from: :updox_id
+      property :calendarId, required: true, from: :calendar_id
+      property :date, required: true
+      property :duration
+      property :patientId
+      property :typeId
+      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 :locationId, from: :location_id
+      property :reminderTokens, from: :reminder_tokens
+
+      def to_h
+        result = super.to_h
+
+        result['date'] = result['date'].strftime(Updox::Models::DATETIME_FORMAT) if result['date'].respond_to?(:strftime)
+
+        result
+      end
+
+      def save(account_id: )
+        self.class.sync([self], account_id: account_id)
+      end
+
+      def self.sync(appointments, account_id: )
+        from_response(UpdoxClient.connection.request(endpoint: SYNC_ENDPOINT, body: { appointments: appointments.map(&:to_h) }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT), self)
+      end
+    end
+  end
+end

data/lib/updox/models/auth.rb

@@ -6,10 +6,10 @@ module Updox
       AUTH_ACCT = AUTH_APP + [:accountId]
       AUTH_FULL = AUTH_ACCT + [:userId]
 
-      PING_ENDPOINT = '/ping'
-      PING_APP_ENDPOINT = '/pingWithApplicationAuth'
-      PING_ACCT_ENDPOINT = '/pingWithAccountAuth'
-      PING_FULL_ENDPOINT = '/pingWithAuth'
+      PING_ENDPOINT = '/Ping'
+      PING_APP_ENDPOINT = PING_ENDPOINT + 'WithApplicationAuth'
+      PING_ACCT_ENDPOINT = PING_ENDPOINT + 'WithAccountAuth'
+      PING_FULL_ENDPOINT = PING_ENDPOINT + 'WithAuth'
 
       property :applicationId, from: :application_id
       property :applicationPassword, from: :application_password

data/lib/updox/models/calendar.rb

@@ -0,0 +1,19 @@
+module Updox
+  module Models
+    class Calendar < Model
+      SYNC_ENDPOINT = '/CalendarsSync'.freeze
+
+      property :id, required: true
+      property :title, required: true
+      property :color, required: true, default: '#000000'
+      property :textColor, required: true, default: '#FFFFFF'
+      property :publicCalendar, default: false, from: :public_calendar, with: ->(v) { true == v}, transform_with: ->(v) { true == v }
+      property :active, default: true
+      property :reminderTurnOff, default: false, from: :reminder_turn_off, with: ->(v) { true == v}, transform_with: ->(v) { true == v }
+
+      def create(account_id: )
+        self.class.from_response(UpdoxClient.connection.request(endpoint: SYNC_ENDPOINT, body: self.to_h, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT))
+      end
+    end
+  end
+end

data/lib/updox/models/location.rb

@@ -0,0 +1,21 @@
+module Updox
+  module Models
+    class Location < Model
+      SYNC_ENDPOINT  = '/LocationsSync'.freeze
+
+      property :id
+      property :code
+      property :name
+      property :showInPortal, default: false, from: :show_in_portal, with: ->(v) { true == v }, transform_with: ->(v) { true == v }
+      property :active, default: true
+
+      def save(account_id: )
+        self.class.sync([self], account_id: account_id)
+      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)
+      end
+    end
+  end
+end

data/lib/updox/models/model.rb

@@ -0,0 +1,41 @@
+module Updox
+  module Models
+    DATETIME_FORMAT = '%Y-%m-%d %H:%M'.freeze
+
+    class Model < Hashie::Trash
+      include Hashie::Extensions::IgnoreUndeclared
+      include Hashie::Extensions::IndifferentAccess
+
+      LIST_TYPE = 'undefined'
+      LIST_NAME = 'models'
+
+      property :item, required: false
+      property :items, required: false
+
+      def self.from_response(response, klazz = self)
+        return response if false == Updox.configuration.parse_responses?
+
+        model = Model.new
+        model.define_singleton_method(:response) { response }
+
+        if (response.ok?)
+          data = response.parsed_response
+
+          if data.is_a?(Array)
+            model.items = data
+          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 }
+          else
+            model.items = [data]
+            model.item  = data
+          end
+        else
+          raise UpdoxException.from_response(response)
+        end
+
+        return model
+      end
+    end
+  end
+end

data/lib/updox/models/patient.rb

@@ -0,0 +1,26 @@
+module Updox
+  module Models
+    class Patient < Model
+      SYNC_ENDPOINT  = '/PatientsSync'.freeze
+
+      property :id
+      property :internalId, required: true, from: :internal_id
+      property :firstName, from: :first_name
+      property :middleName, from: :middle_name
+      property :lastName, from: :last_name
+      property :emailAddress, from: :email_address
+      property :homePhone, from: :home_phone
+      property :workPhone, from: :work_phone
+      property :mobileNumber, from: :mobile_number
+      property :active, default: true
+
+      def save(account_id: )
+        self.class.sync([self], account_id: account_id)
+      end
+
+      def self.sync(patients, account_id: )
+        from_response(UpdoxClient.connection.request(endpoint: SYNC_ENDPOINT, body: { patients: patients }, auth: {accountId: account_id}, required_auths: Updox::Models::Auth::AUTH_ACCT), self)
+      end
+    end
+  end
+end

data/lib/updox/models/practice.rb

@@ -1,12 +1,13 @@
 module Updox
   module Models
-    class Practice < Hashie::Trash
-      CREATE_ENDPOINT = '/practiceCreate'.freeze
+    class Practice < Model
+      CREATE_ENDPOINT = '/PracticeCreate'.freeze
+      QUERY_ENDPOINT  = '/PracticeList'.freeze
 
-      include Hashie::Extensions::IndifferentAccess
+      LIST_TYPE = 'practiceList'.freeze
+      LIST_NAME = 'practices'
 
       property :name, required: true
-      property :active, default: false
       property :accountId, from: :account_id, with: ->(v) { v.to_s }
       property :address1
       property :address2
@@ -27,11 +28,16 @@ module Updox
       property :practiceSpecialtyCode, from: :practice_specialty_code
       property :practiceNpi, from: :practice_npi
       property :defaultConsentMethods
+      property :active, default: true
 
       alias_method :account_id, :accountId
 
       def create
-        UpdoxClient.connection.request(endpoint: CREATE_ENDPOINT, body: self.to_h)
+        UpdoxClient.connection.request(endpoint: CREATE_ENDPOINT, body: self.to_h, 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)
       end
     end
   end

data/lib/updox/models/user.rb

@@ -0,0 +1,39 @@
+module Updox
+  module Models
+    class User < Model
+      SAVE_ENDPOINT  = '/UserSave'.freeze
+      QUERY_ENDPOINT = '/UserList'.freeze
+
+      LIST_TYPE = 'userList'.freeze
+      LIST_NAME = 'users'
+
+      property :userId, from: :user_id
+      property :emrUserId, from: :emr_user_id
+      property :loginId, from: :login_id
+      property :loginPassword, from: :login_password
+      property :firstName, required: true, from: :first_name
+      property :middleName, from: :middle_name
+      property :lastName, required: true, from: :last_name
+      property :address1
+      property :address2
+      property :city
+      property :state
+      property :postal
+      property :provider, default: false
+      property :admin, default: false
+      property :searchOptOut, from: :search_opt_out, default: true
+
+      alias_method :user_id, :userId
+      alias_method :first_name, :firstName
+      alias_method :last_name, :lastName
+
+      def create
+        UpdoxClient.connection.request(endpoint: SAVE_ENDPOINT, body: self.to_h, 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)
+      end
+    end
+  end
+end

data/lib/updox/updox_exception.rb

@@ -2,18 +2,24 @@ module Updox
   class UpdoxException < Exception
     def self.from_response(response, msg: nil)
       exception_msg = "Failed #{msg}:"
-      exception_msg << " HTTP code: #{response.code} MSG: "
+      exception_msg << " HTTP code: #{response.code}"
 
       begin
         error_response = JSON.parse(response.body)
 
-        #if (error_response.is_a?(Hash) && error_response.include?("Meta") && error_response["Meta"].include?("Errors"))
-          #exception_msg << error_response["Meta"]["Errors"]
-        #else
-          exception_msg << error_response
-        #end
+        if error_response.is_a?(Hash)
+          if error_response.include?('responseMessage')
+            exception_msg << " MSG: #{error_response['responseMessage']}"
+          end
+
+          if error_response.include?('responseCode')
+            exception_msg << " UPDOX CODE: #{error_response['responseCode']}"
+          end
+        else
+          exception_msg << " MSG: #{error_response}"
+        end
       rescue JSON::ParserError
-        exception_msg << response.body
+        exception_msg << " MSG: #{response.body}"
       end
 
       return UpdoxException.new(exception_msg)

data/lib/updox/version.rb

@@ -1,3 +1,3 @@
 module Updox
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/updox.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>=1', '<3'
   spec.add_development_dependency 'byebug', '~> 11'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'webmock', '~> 3.1'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: updox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Crockett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -142,8 +142,15 @@ files:
 - Rakefile
 - lib/updox.rb
 - lib/updox/connection.rb
+- lib/updox/models/application.rb
+- lib/updox/models/appointment.rb
 - lib/updox/models/auth.rb
+- lib/updox/models/calendar.rb
+- lib/updox/models/location.rb
+- lib/updox/models/model.rb
+- lib/updox/models/patient.rb
 - lib/updox/models/practice.rb
+- lib/updox/models/user.rb
 - lib/updox/updox_exception.rb
 - lib/updox/version.rb
 - updox.gemspec