updox 0.1.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+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
+### Changed
+- None
+
+## 0.1.0 - 2020-01-20
+### Added
+- Initial Release
+
+[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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redox.gemspec
+gemspec

data/README.md

@@ -0,0 +1,117 @@
+[![CircleCI](https://circleci.com/gh/WeInfuse/updox.svg?style=svg)](https://circleci.com/gh/WeInfuse/updox)
+
+# Updox
+Ruby API wrapper for [Updox](https://updoxqa.com/api/newio)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'updox'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install updox
+
+## Usage
+
+### Setup
+
+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')
+```
+
+### Create
+
+```ruby
+response = patient.create(meta: meta)
+```
+
+### Update
+
+```ruby
+response = patient.update(meta: meta)
+```
+
+### Search
+
+```ruby
+response = Updox::Models::Patient.query(patient, meta: meta)
+```
+
+### Response
+
+The response object is a base `Updox::Models::Model` class.
+
+With the HTTParty response object
+```ruby
+response.response
+#<HTTParty::Response:0x7fa354c1fbe8>
+
+response.response.ok?
+true
+```
+
+And any `Model` objects that were returned
+```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}
+}
+```
+
+### Configuration
+
+```ruby
+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
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WeInfuse/updox.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/updox.rb

@@ -0,0 +1,65 @@
+require 'httparty'
+require 'hashie'
+require 'updox/version'
+require 'updox/updox_exception'
+require 'updox/connection'
+require 'updox/models/auth'
+require 'updox/models/practice'
+
+module Updox
+  class Configuration
+    attr_accessor :application_id, :application_password
+
+    def initialize
+      @application_id       = nil
+      @application_password = nil
+    end
+
+    def api_endpoint=(endpoint)
+      Connection.base_uri(endpoint.freeze)
+    end
+
+    def api_endpoint
+      return Connection.base_uri
+    end
+
+    def to_h
+      return {
+        application_id: @application_id,
+        application_password: @application_password,
+        api_endpoint: api_endpoint
+      }
+    end
+
+    def from_h(h)
+      self.application_id = h[:application_id]
+      self.application_password  = h[:application_password]
+      self.api_endpoint = h[:api_endpoint]
+
+      return self
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  # Updox API client
+  class UpdoxClient
+    class << self
+      def connection
+        @connection ||= Connection.new
+      end
+
+      def release
+        @connection = nil
+      end
+    end
+  end
+end

data/lib/updox/connection.rb

@@ -0,0 +1,36 @@
+module Updox
+  class Connection
+    include HTTParty
+
+    base_uri 'http://updoxqa.com/api/io/'.freeze
+
+    headers 'Content-Type' => 'application/json'
+
+    format :json
+
+    def request(endpoint: Updox::Models::Auth::PING_ENDPOINT, body: {}, headers: {}, auth: Updox::Models::Auth.new, required_auths: [])
+      if body.is_a?(Hash)
+        body = auth_data(auth, required_auths).merge(body)
+        body = body.to_json
+      end
+
+      self.class.post(endpoint, body: body, headers: headers)
+    end
+
+    private
+    def auth_data(auth, required_auths)
+      result_auth = auth.dup
+
+      if required_auths.any?
+        result_auth = Updox::Models::Auth.new(
+          application_id: Updox.configuration.application_id,
+          application_password: Updox.configuration.application_password
+        ).merge(result_auth)
+      end
+
+      result_auth = result_auth.keep_if {|k, v| required_auths.include?(k) }
+
+      result_auth.to_h
+    end
+  end
+end

data/lib/updox/models/auth.rb

@@ -0,0 +1,40 @@
+module Updox
+  module Models
+    class Auth < Hashie::Trash
+      AUTH_NONE = []
+      AUTH_APP  = [:applicationId, :applicationPassword]
+      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'
+
+      property :applicationId, from: :application_id
+      property :applicationPassword, from: :application_password
+      property :accountId, from: :account_id
+      property :userId, from: :user_id
+
+      def to_h
+        { auth: super.to_h }
+      end
+
+      def ping
+        UpdoxClient.connection.request(endpoint: PING_ENDPOINT, auth: self)
+      end
+
+      def ping_with_application_auth
+        UpdoxClient.connection.request(endpoint: PING_APP_ENDPOINT, auth: self, required_auths: AUTH_APP)
+      end
+
+      def ping_with_account_auth
+        UpdoxClient.connection.request(endpoint: PING_ACCT_ENDPOINT, auth: self, required_auths: AUTH_ACCT)
+      end
+
+      def ping_with_full_auth
+        UpdoxClient.connection.request(endpoint: PING_FULL_ENDPOINT, auth: self, required_auths: AUTH_FULL)
+      end
+    end
+  end
+end

data/lib/updox/models/practice.rb

@@ -0,0 +1,38 @@
+module Updox
+  module Models
+    class Practice < Hashie::Trash
+      CREATE_ENDPOINT = '/practiceCreate'.freeze
+
+      include Hashie::Extensions::IndifferentAccess
+
+      property :name, required: true
+      property :active, default: false
+      property :accountId, from: :account_id, with: ->(v) { v.to_s }
+      property :address1
+      property :address2
+      property :city
+      property :state
+      property :postal
+      property :phone
+      property :fax
+      property :websiteAddress, from: :website_address
+      property :timeZone, from: :time_zone
+      property :directDomain, from: :direct_domain
+      property :directAddress, from: :direct_address
+      property :protocol
+      property :ipAddress, from: :ip_address
+      property :port
+      property :path
+      property :metadata
+      property :practiceSpecialtyCode, from: :practice_specialty_code
+      property :practiceNpi, from: :practice_npi
+      property :defaultConsentMethods
+
+      alias_method :account_id, :accountId
+
+      def create
+        UpdoxClient.connection.request(endpoint: CREATE_ENDPOINT, body: self.to_h)
+      end
+    end
+  end
+end

data/lib/updox/updox_exception.rb

@@ -0,0 +1,22 @@
+module Updox
+  class UpdoxException < Exception
+    def self.from_response(response, msg: nil)
+      exception_msg = "Failed #{msg}:"
+      exception_msg << " HTTP code: #{response.code} MSG: "
+
+      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
+      rescue JSON::ParserError
+        exception_msg << response.body
+      end
+
+      return UpdoxException.new(exception_msg)
+    end
+  end
+end

data/lib/updox/version.rb

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

data/updox.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'updox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'updox'
+  spec.version       = Updox::VERSION
+  spec.authors       = ['Mike Crockett']
+  spec.email         = ['mike.crockett@weinfuse.com']
+
+  spec.summary       = 'Ruby wrapper for the Updox API'
+  spec.homepage      = 'https://github.com/WeInfuse/updox'
+
+  # Prevent pushing this gem to RubyGems.org.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match?(%r{^(test|spec|features|bin|helpers|)/}) || f.match?(%r{^(\.[[:alnum:]]+)})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.licenses      = ['MIT']
+
+  spec.add_dependency 'httparty', '~> 0.17'
+  spec.add_dependency 'hashie', '~> 3.5'
+  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 'webmock', '~> 3.1'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: updox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Crockett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- mike.crockett@weinfuse.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/updox.rb
+- lib/updox/connection.rb
+- lib/updox/models/auth.rb
+- lib/updox/models/practice.rb
+- lib/updox/updox_exception.rb
+- lib/updox/version.rb
+- updox.gemspec
+homepage: https://github.com/WeInfuse/updox
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Updox API
+test_files: []