redox-client 0.0.0.pre.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc2920cfcaf61217ebd83d4d252b9a78a2a182124d40fcdf390555584599d2c5
-  data.tar.gz: 6afc487c8b22dab175ea6f92c3b22161c8cce51c316aa86249efb865a0343029
+  metadata.gz: 7e25af2125fc17dda61023bc6513a886a24fe2e3b6fe9fae958ba6c43edb351b
+  data.tar.gz: 33b595b60b546ae11e18c54b6db60cdfb0c6d21681c0f69d8f1d8d9d3afea1ca
 SHA512:
-  metadata.gz: d2d1a6488c76791aa5bc1b78208758ed735abd761a90a38a6bccbc356d2559538b9b3b312b5294fbbe0a6171e533b6a5a7383e3099aa543770e8ca7c11c2db10
-  data.tar.gz: cb19077d938e6e75112e433d5b1832083d4c2be54dd8bf8643ae13e8f3921788b57ad71ae5d6cca214db09dbcd37655ff565a62ff0ace7c606e5cf372cd25f03
+  metadata.gz: bdc40d505021f48100f7a2f176e4a0811611b90de70cf9caee2fdb489d707f1266a815564dbf36567bab0de64ad79642b65914169ec76b7c42218d8212118271
+  data.tar.gz: 23c892f9c708256e3ed4d6f83158501daef2f3ee155dfde99938ef4bc5de2071f27850d1e036604556ca6527a5ec468e388bff38b7c33ba66732073ac56184de

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## [Unreleased]
+### Added
+
+### Changed
+
+### Removed
+
+## [0.5.0] - 2020-10-29
+### Added
+- File Upload
+- Media.New
+
+### Changed
+- fixed: source was re-authenticating every request (DateTime math was incorrect)
+
+### Removed
+- remove SchedulingBooked.Query Patient property. It is not present on the corresponding redox model and was never used.
+
+## [0.4.0] - 2020-09-04
+### Added
+- add email and phone to demographics
+- add patient contacts
+
+## [0.3.0] - 2020-08-27
+### Added
+- _body attribute containing raw response text on query results
+- SchedulingBooked.Query
+
+## [0.2.0] - 2020-08-16
+### Added
+- improve release process
+
+### Changed
+- fixed CHANGELOG url in gemspec
+
+## [0.1.0] - 2020-08-14
+### Added
+- implement PatientSearch.Query
+
+[0.1.0]: https://github.com/patient-discovery/redox-client/releases/tag/v0.1.0
+[0.2.0]: https://github.com/patient-discovery/redox-client/releases/tag/v0.2.0
+[0.3.0]: https://github.com/patient-discovery/redox-client/releases/tag/v0.3.0
+[0.4.0]: https://github.com/patient-discovery/redox-client/releases/tag/v0.4.0
+[0.5.0]: https://github.com/patient-discovery/redox-client/releases/tag/v0.5.0
+[Unreleased]: https://github.com/patient-discovery/redox-client/compare/v0.5.0...HEAD

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redox-client (0.0.0.pre.0)
+    redox-client (0.5.0)
       faraday (~> 1.0, >= 1.0.1)
       hashie (~> 4.1)
 
@@ -10,6 +10,7 @@ GEM
   specs:
     ast (2.4.1)
     diff-lcs (1.4.4)
+    docile (1.3.2)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     hashie (4.1.0)
@@ -25,6 +26,8 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
+    rspec-collection_matchers (1.2.0)
+      rspec-expectations (>= 2.99.0.beta1)
     rspec-core (3.9.2)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
@@ -48,10 +51,15 @@ GEM
     rubocop-performance (1.6.1)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     standard (0.4.7)
       rubocop (~> 0.85.0)
       rubocop-performance (~> 1.6.0)
     unicode-display_width (1.7.0)
+    vcr (6.0.0)
 
 PLATFORMS
   ruby
@@ -60,7 +68,10 @@ DEPENDENCIES
   rake (~> 12.0)
   redox-client!
   rspec (~> 3.9)
+  rspec-collection_matchers (~> 1.2)
+  simplecov (~> 0.18.5)
   standard (~> 0.4.7)
+  vcr (~> 6.0)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,15 +1,139 @@
-# Redox::Client
+[![Gem Version](https://img.shields.io/gem/v/redox-client.svg)](https://badge.fury.io/rb/redox-client)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+![Test](https://github.com/patient-discovery/redox-client/workflows/Test/badge.svg)
 
-Ruby gem that makes it easy to consume Redox JSON APIs.
+# redox-client - Ruby gem facade for Redox APIs
+
+This gem makes it easy to consume [Redox APIs](https://developer.redoxengine.com/).
 
 *Note: This is pre-release software under active development and should be considered unstable until version 1.0.0*
 
+## Features
+ - supports creation of multiple Redox Sources, each with its own API key and secret
+ - automatically requests Redox access tokens when needed in a thread safe way
+ - provides ruby style [DTOs](https://en.wikipedia.org/wiki/Data_transfer_object) to conveniently consume and generate Redox camel cased JSON
+
 ## Installation
 
+Add the following to your `Gemfile`:
+
+```ruby
+gem "redox-client"
+```
+
+and run:
+
+```bash
+bundle install
+```
+
 ## Usage
+To uses redox-client effectively you will want to be familiar with the [Redox APIs](https://developer.redoxengine.com/) and in particular how sources, destinations, and subscriptions work.
+
+Create a Redox Source.
+
+```ruby
+source = Redox::Source.new(
+    endpoint: ENV["REDOX_ENDPOINT"],
+    api_key: ENV["REDOX_API_KEY"],
+    secret: ENV["REDOX_SECRET"]
+  )
+```
+
+Build query object for API you wish to execute:
+
+```ruby
+query = Redox::PatientSearch::Query.new(
+  patient: Redox::Models::Patient.new(
+    demographics: Redox::Models::Demographics.new(
+      first_name: "Timothy",
+      middle_name: "Paul",
+      ...
+    )
+  )
+)
+```
+
+Perform the query using your source and the appropriate destination id:
+
+```ruby
+result = query.perform source, "my-destination-id"
+```
+
+The result object is a DTO containing the Redox response:
+
+```ruby
+result.patient.identifiers.first.id_type   # => "MR"
+result.patient.identifiers.first.id        # => "0000000001"
+```
+
+See the `specs/` for more examples.
+
+### Authentication and Lifecycle
+`Redox::Source` requests a Redox access token using the Redox API key and secret. The access token is used until it is near expiration, which is typically 1 day after being issued. So a `Redox::Source` object is intended to be created once and reused.
+
+Since `Redox::Source` has shared state, i.e., the access token and its expiration time, `Redox::Source` uses a [Monitor](https://ruby-doc.org/stdlib-2.6.3/libdoc/monitor/rdoc/MonitorMixin.html) to be thread safe.
+
+
+## Supported APIs
+
+- PatientSearch.Query
+- Scheduling.Booked
+- Media.New
+- File Upload
 
 ## Development
+***Nota Bene**: This project uses [VCR](https://relishapp.com/vcr/vcr/docs) to record HTTP requests and responses and play them back during tests. Do NOT use Redox production credentials when developing tests.*
+
+### Initial Setup
+After checking out the repo, run `bin/setup` to install gem dependencies and a git pre-commit hook. The pre-commit hook checks test fixtures for Redox credential exposure. While recommended the hook is not required and can be removed or replaced if desired. After setup completes run `rake` to run all the tests.
+
+### Testing
+This project uses `rspec` and [VCR](https://relishapp.com/vcr/vcr/docs). VCR provides fast deterministic testing of HTTP APIs. It also makes it possible to set up any server response you want to test by authoring the server responses directly. This comes in handy when trying to test edge cases that might occur but are hard to reproduce.
+
+Some effort has been made to filter credentials from recorded HTTP interactions, but you should always carefully review all your changes before pushing them to avoid credential exposure.
+
+### Recording and Playing Back Cassettes
+The `VCR_MODE` environment variable controls whether VCR is recording cassettes or playing them back. When recoding cassettes the following environment variables are used to call Redox APIs:
+
+- `REDOX_ENDPOINT`: base URL of Redox API endpoint (e.g., https://api.redoxengine.com/)
+- `REDOX_API_KEY`: Redox `apiKey` used by /auth/authenticate
+- `REDOX_SECRET`: Redox `secret` used by /auth/authenticate
+
+Set these to the credentials for the Redox environment you are using for testing.
+
+When playing back cassettes these environment variables are ignored and no API requests are made to Redox.
+
+To make a new test with a new recording, set environment variables above then:
+
+```bash
+env VCR_MODE=record rspec spec/my_new_spec.rb
+```
+
+This will record all API requests made by the test. Be **careful**: if you run all the tests with `VCR_MODE=record` it will re-record all the cassettes.
+
+The default mode is playback, so to playback cassettes just run `rspec`.
+
+### Coding Style
+This project adheres to [StandardRB](https://github.com/testdouble/standard/blob/master/README.md). Additionally
+[# frozen_string_literal](https://bugs.ruby-lang.org/issues/8976#note-30) is required in Ruby source files, and is enforced by Rubocop.
+
+Run `rake` to run the style checks. Run `rake fix` to fix violations.
+
+### Useful commands
+- `rake` - run all tests (lint, Redox cred scan, rspec)
+- `rake fix` - Fix RuboCop and StandardRB violations
+- `rake vcr:fix` - attempt to replace real looking credentials in VCR cassettes with dummy test values.
+- `rake -T` - see available rake tasks
+- `bin/console` - get an interactive prompt for experimenting
+
+### Release Process
+This project uses [Semantic Versioning](https://semver.org)
+
+Prepare release on master branch, then run:
 
-## Contributing
+```
+rake prepare:release
+```
 
-## License
+and follow the instructions.

data/Rakefile

@@ -1,6 +1,71 @@
+# frozen_string_literal: true
+
+require "date"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "standard/rake"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new :spec
+RuboCop::RakeTask.new :rubocop do |task|
+  task.options = %w[--format quiet]
+end
+
+desc "Run all checks and tests"
+task default: :test
+
+desc "Run all checks and tests"
+task test: [:rubocop, :standard, :vcr, :spec]
+
+desc "Fix RuboCop and StandardRB violations"
+task fix: ["rubocop:auto_correct", "standard:fix"]
+
+# TODO: Make these a proper lib/rake_tasks.rb task and avoid exec'ing out
+desc "Check VCR cassettes for Redox credential leak"
+task "vcr" do
+  raise "Possible credential leak, run rake vcr:fix" unless system "bin/check-vcr-cassettes"
+end
+
+desc "Scrub VCR cassettes, replacing suspected real creds with test ones"
+task "vcr:fix" do
+  system "bin/check-vcr-cassettes --scrub"
+end
+
+task "prepare:changelog" do
+  repo = "https://github.com/patient-discovery/redox-client"
+  changelog = IO.readlines("CHANGELOG.md").map(&:chomp)
+  entries = [
+    "## [#{Redox::VERSION}] - #{Date.today}",
+    "[#{Redox::VERSION}]: #{repo}/releases/tag/v#{Redox::VERSION}",
+    "[Unreleased]: #{repo}/compare/v#{Redox::VERSION}...HEAD"
+  ]
+  unless entries.all? { |x| changelog.include? x }
+    puts "\nAdd these to CHANGELOG.md:\n\n"
+    puts entries.join("\n")
+    puts "\n\n"
+    abort "ERROR: CHANGELOG version entries needed"
+  end
+  puts "CHANGELOG looks good"
+end
+
+task "prepare:version" do
+  if system("git show-ref --tags v#{Redox::VERSION}")
+    abort("ERROR: Tag already exists. Check version.rb")
+  end
+end
+
+task "prepare:tag" do
+  unless system("git tag -m 'Version #{Redox::VERSION}' v#{Redox::VERSION}")
+    abort("ERROR: Unable to tag")
+  end
+end
 
-RSpec::Core::RakeTask.new(:spec)
+desc "Prepare a gem release"
+task "prepare:release": [
+  "release:guard_clean", "test", "prepare:version", "prepare:changelog", "prepare:tag"
+] do
+  puts "Release tagged. To create release run:\n\n"
+  puts "git push --follow-tags"
+end
 
-task :default => :spec
+CLEAN.include "coverage"

data/lib/redox.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "redox/version"
+
+require_relative "redox/model"
+require_relative "redox/models/address"
+require_relative "redox/models/contact"
+require_relative "redox/models/demographics"
+require_relative "redox/models/destination"
+require_relative "redox/models/error"
+require_relative "redox/models/location"
+require_relative "redox/models/media"
+require_relative "redox/models/message"
+require_relative "redox/models/meta"
+require_relative "redox/models/patient_identifier"
+require_relative "redox/models/patient"
+require_relative "redox/models/phone_number"
+require_relative "redox/models/provider"
+require_relative "redox/models/visit"
+
+require_relative "redox/source"
+require_relative "redox/query"
+require_relative "redox/file_upload"
+
+require_relative "redox/patient_search/query.rb"
+require_relative "redox/scheduling/booked.rb"
+require_relative "redox/media/new.rb"
+
+module Redox
+  class Error < StandardError
+    attr_accessor :status
+    attr_accessor :body
+    attr_accessor :message
+
+    def initialize(status: nil, body: nil, message: nil)
+      self.status = status
+      self.body = body
+      self.message = message
+    end
+  end
+
+  class AuthenticationError < Error; end
+end

data/lib/redox/file_upload.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Redox
+  class FileUpload
+    ENDPOINT = "https://blob.redoxengine.com/upload"
+
+    # Create a multipart file upload.
+    #
+    # @param filename_or_io [String, IO] Either a String filename of a local file
+    # or an open IO object
+    # @param content_type [String] String content type of the file data
+    # @param upload_as_filename [String] (optional) Name to use for uploaded file
+    def initialize(filename_or_io, content_type, upload_as_filename = nil)
+      @file_part = Faraday::FilePart.new(filename_or_io, content_type, upload_as_filename)
+    end
+
+    # Upload the file.
+    #
+    # @param [Redox::Source] source to use for authentication
+    def perform(source)
+      source.ensure_access_token
+
+      connection = Faraday.new { |f|
+        f.authorization :Bearer, source.access_token
+        f.request :multipart
+        f.headers[:accept] = "application/json"
+      }
+      res = connection.post ENDPOINT, {file: @file_part}
+
+      raise Redox::Error.new(status: res.status, body: res.body) unless res.success?
+
+      uri =
+        begin
+          JSON.parse(res.body)["URI"]
+        rescue
+        end
+      raise Redox::Error.new(status: res.status, body: res.body) unless uri
+
+      uri
+    end
+  end
+end

data/lib/redox/media/new.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "redox"
+
+module Redox
+  module Media
+    class New < Redox::Query
+      redox_property :Patient, coerce: Models::Patient
+      redox_property :Visit, coerce: Models::Visit
+      redox_property :Media, coerce: Models::Media
+
+      def response_type
+        NewResponse
+      end
+    end
+
+    class NewResponse < Models::Message
+    end
+  end
+end

data/lib/redox/model.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "hashie"
+require "json"
+
+module Redox::Models
+end
+class Redox::Model < Hashie::Trash
+  include Hashie::Extensions::Dash::Coercion
+  include Hashie::Extensions::IgnoreUndeclared
+
+  def initialize(hash = {})
+    if hash.keys.first.is_a? String
+      hash = hash.transform_keys { |key|
+        translated_key = self.class.translations[key.to_sym]
+        translated_key.nil? ? key : translated_key
+      }
+    end
+    super hash
+  end
+
+  def self.redox_property(redox_property, options = {})
+    property to_snake_case(redox_property).to_sym, options.merge({from: redox_property})
+  end
+
+  def self.from_redox_json(json)
+    case json
+    when String
+      json = JSON.parse json
+    end
+    new json.transform_keys(&:to_sym)
+  end
+
+  def to_redox_hash
+    to_h
+      .transform_keys { |k| self.class.inverse_translations[k] }
+      .transform_values { |v| value_to_redox_hash(v) }
+  end
+
+  def value_to_redox_hash(value)
+    if value.respond_to?(:to_redox_hash)
+      value.to_redox_hash
+    elsif value.is_a?(Array)
+      value.map { |element| value_to_redox_hash(element) }
+    else
+      value
+    end
+  end
+
+  def to_redox_json
+    to_redox_hash.to_json
+  end
+
+  # Convert word from CamelCase to snake_case. This is roughly the same as the
+  # rails `String.underscore` method with the following simplications:
+  #
+  # - any word in all caps is assumed to be an acronym (ZIP -> zip)
+  # - only alphabetic characters are modified
+  #
+  # Note: this function does not have an inverse. Both "Zip" and "ZIP"
+  # map to "zip".
+  #
+  # @param [String] camel_cased_word word to convert to snake case
+  # @return [String] camel_cased_qord converted to snake case
+  def self.to_snake_case(camel_cased_word)
+    word = camel_cased_word.to_s
+    return word.downcase if word.upcase == word
+
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+    word.downcase!
+    word
+  end
+end

data/lib/redox/models/address.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Redox
+  module Models
+    class Address < Redox::Model
+      redox_property :StreetAddress
+      redox_property :City
+      redox_property :State
+      redox_property :ZIP
+      redox_property :County
+      redox_property :Country
+    end
+  end
+end

data/lib/redox/models/contact.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "address"
+require_relative "phone_number"
+
+module Redox
+  module Models
+    class Contact < Redox::Model
+      redox_property :FirstName
+      redox_property :MiddleName
+      redox_property :LastName
+      redox_property :Address, coerce: Address
+      redox_property :PhoneNumber, coerce: PhoneNumber
+      redox_property :EmailAddresses, coerce: Array[String]
+      redox_property :RelationToPatient
+      redox_property :Roles, coerce: Array[String]
+    end
+  end
+end

data/lib/redox/models/demographics.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "address"
+require_relative "phone_number"
+
+module Redox
+  module Models
+    class Demographics < Redox::Model
+      redox_property :FirstName
+      redox_property :MiddleName
+      redox_property :LastName
+      redox_property :DOB
+      redox_property :SSN
+      redox_property :Sex
+      redox_property :Address, coerce: Address
+      redox_property :PhoneNumber, coerce: PhoneNumber
+      redox_property :EmailAddresses, coerce: Array[String]
+    end
+  end
+end

data/lib/redox/models/destination.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Redox
+  module Models
+    class Destination < Redox::Model
+      redox_property :ID
+      redox_property :Name
+    end
+  end
+end

data/lib/redox/models/error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Redox
+  module Models
+    class Error < Redox::Model
+      redox_property :ID
+      redox_property :Text
+      redox_property :Type
+      redox_property :Module
+    end
+  end
+end

data/lib/redox/models/location.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Redox
+  module Models
+    class Location < Redox::Model
+      redox_property :Type
+      redox_property :Facility
+      redox_property :Department
+      redox_property :Room
+    end
+  end
+end

data/lib/redox/models/media.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "provider"
+
+module Redox
+  module Models
+    class Media < Redox::Model
+      redox_property :FileType
+      redox_property :FileName
+      redox_property :FileContents
+      redox_property :DocumentType
+      redox_property :DocumentID
+      redox_property :DocumentDescription
+      redox_property :CreationDateTime
+      redox_property :ServiceDateTime
+      redox_property :Provider, coerce: Provider
+      redox_property :Authenticated
+      redox_property :Authenticator, coerce: Provider
+      redox_property :Availability
+      redox_property :Notifications, coerce: Array[Provider]
+    end
+  end
+end

data/lib/redox/models/message.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "meta"
+
+module Redox
+  module Models
+    class Message < Redox::Model
+      attr_accessor :_body
+      redox_property :Meta, coerce: Redox::Models::Meta
+    end
+  end
+end

data/lib/redox/models/meta.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "destination"
+
+module Redox
+  module Models
+    # Redox::Message is already taken: it refers to an entire response
+    class MetaMessage < Redox::Model
+      redox_property :ID
+    end
+    class Meta < Redox::Model
+      redox_property :DataModel
+      redox_property :EventType
+      redox_property :EventDateTime
+      redox_property :Test
+      redox_property :Destinations, coerce: Array[Redox::Models::Destination]
+      redox_property :Message, coerce: MetaMessage
+      redox_property :Errors, coerce: Array[Redox::Models::Error]
+    end
+  end
+end

data/lib/redox/models/patient.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "patient_identifier"
+require_relative "demographics"
+require_relative "contact"
+
+module Redox
+  module Models
+    class Patient < Redox::Model
+      redox_property :Identifiers, coerce: Array[PatientIdentifier]
+      redox_property :Demographics, coerce: Demographics
+      redox_property :Contacts, coerce: Array[Contact]
+    end
+  end
+end

data/lib/redox/models/patient_identifier.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Redox
+  module Models
+    class PatientIdentifier < Redox::Model
+      redox_property :IDType
+      redox_property :ID
+    end
+  end
+end

data/lib/redox/models/phone_number.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Redox
+  module Models
+    class PhoneNumber < Redox::Model
+      redox_property :Home
+      redox_property :Office
+      redox_property :Mobile
+    end
+  end
+end

data/lib/redox/models/provider.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "address"
+require_relative "location"
+require_relative "phone_number"
+
+module Redox
+  module Models
+    class Provider < Redox::Model
+      redox_property :ID
+      redox_property :IDType
+      redox_property :FirstName
+      redox_property :LastName
+      redox_property :Credentials, coerce: Array[String]
+      redox_property :Address, coerce: Address
+      redox_property :EmailAddresses, coerce: Array[String]
+      redox_property :PhoneNumber, coerce: PhoneNumber
+      redox_property :Location, coerce: Location
+    end
+  end
+end

data/lib/redox/models/visit.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "location"
+require_relative "patient"
+require_relative "provider"
+
+module Redox
+  module Models
+    class Visit < Redox::Model
+      redox_property :VisitNumber
+      redox_property :AccountNumber
+      redox_property :VisitDateTime
+      redox_property :PatientClass
+      redox_property :Status
+      redox_property :Duration
+      redox_property :Reason
+      redox_property :CancelReason
+      redox_property :LastUpdated
+      redox_property :ScheduledDateTime
+      redox_property :CancelDateTime
+      redox_property :Type
+      redox_property :Instructions
+      redox_property :Patient, coerce: Patient
+      redox_property :AttendingProvider, coerce: Provider
+      redox_property :ConsultingProvider, coerce: Provider
+      redox_property :ReferringProvider, coerce: Provider
+      redox_property :VisitProvider, coerce: Provider
+      redox_property :Location, coerce: Location
+    end
+  end
+end

data/lib/redox/patient_search/query.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "redox"
+
+module Redox
+  module PatientSearch
+    class Query < Redox::Query
+      redox_property :Patient, coerce: Models::Patient
+
+      def response_type
+        Response
+      end
+    end
+
+    class Response < Models::Message
+      redox_property :Patient, coerce: Models::Patient
+    end
+  end
+end

data/lib/redox/query.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Redox
+  class Query < Models::Message
+    def perform(source, destination_id)
+      data_model, event_type = self.class.name.split("::").drop(1)
+      self.meta = {
+        data_model: data_model,
+        event_type: event_type,
+        event_date_time: DateTime.now.iso8601,
+        destinations: [Redox::Models::Destination.new(id: destination_id)]
+      }
+      result_body = source.execute_query self
+      response = response_type.from_redox_json result_body
+      response._body = result_body
+      response
+    end
+  end
+end

data/lib/redox/scheduling/booked.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "redox"
+
+module Redox
+  module Scheduling
+    class Booked < Redox::Query
+      redox_property :StartDateTime, coerce: ->(v) {
+        v.respond_to?(:iso8601) ? v.iso8601 : v.to_s
+      }
+      redox_property :EndDateTime, coerce: ->(v) {
+        v.respond_to?(:iso8601) ? v.iso8601 : v.to_s
+      }
+
+      def response_type
+        BookedResponse
+      end
+    end
+
+    class BookedResponse < Models::Message
+      redox_property :Visits, coerce: Array[Models::Visit]
+    end
+  end
+end

data/lib/redox/source.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "date"
+require "json"
+require "faraday"
+
+class Redox::Source
+  include MonitorMixin
+
+  SECONDS_PER_DAY = 60 * 60 * 24
+  ACCESS_TOKEN_EXPIRATION_BUFFER = Rational(300, SECONDS_PER_DAY)
+
+  attr_reader :access_token_expires_at
+
+  def initialize(endpoint:, api_key:, secret:, test_mode: true)
+    super()
+    @connection = Faraday.new(
+      url: endpoint,
+      headers: {
+        accept: "application/json",
+        content_type: "application/json"
+      }
+    )
+    @api_key = api_key
+    @secret = secret
+    @test_mode = test_mode
+  end
+
+  def execute_query(model)
+    ensure_access_token
+    res = @connection.post("/endpoint", model.to_redox_json)
+    message =
+      begin
+        JSON.parse(res.body)
+      rescue
+        nil
+      end
+
+    unless res.success?
+      raise Redox::Error.new(
+        status: res.status,
+        body: res.body,
+        message: Redox::Models::Message.from_redox_json(message)
+      )
+    end
+    message
+  end
+
+  def ensure_access_token
+    synchronize {
+      authenticate if access_token.nil? || token_expiring_soon?
+    }
+  end
+
+  def access_token
+    @connection.headers["Authorization"]&.delete_prefix "Bearer "
+  end
+
+  def access_token=(token)
+    if token.nil?
+      @connection.headers.delete "Authorization"
+    else
+      @connection.authorization :Bearer, token
+    end
+  end
+
+  def token_expiring_soon?
+    DateTime.now > @access_token_expires_at - ACCESS_TOKEN_EXPIRATION_BUFFER
+  end
+
+  private
+
+  def authenticate
+    self.access_token = nil
+    res = @connection.post("/auth/authenticate", {apiKey: @api_key, secret: @secret}.to_json)
+    raise Redox::AuthenticationError.new status: res.status, body: res.body unless res.success?
+    data = JSON.parse(res.body)
+    self.access_token = data["accessToken"]
+    @access_token_expires_at = DateTime.parse(data["expires"])
+  end
+end

data/lib/redox/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Redox
+  VERSION = "0.5.0"
+end

data/redox-client.gemspec

@@ -1,8 +1,10 @@
-require_relative "lib/redox/client/version"
+# frozen_string_literal: true
+
+require_relative "lib/redox/version"
 
 Gem::Specification.new do |gem|
   gem.name = "redox-client"
-  gem.version = Redox::Client::VERSION
+  gem.version = Redox::VERSION
   gem.homepage = "https://github.com/patient-discovery/redox-client"
   gem.authors = ["Michael Keirnan"]
   gem.email = ["mike@patientdiscovery.com"]
@@ -10,17 +12,20 @@ Gem::Specification.new do |gem|
   gem.summary = "Ruby library for consuming Redox JSON APIs"
   gem.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
   gem.metadata["source_code_uri"] = gem.homepage
-  gem.metadata["changelog_uri"] = "#{gem.homepage}/CHANGELOG.md"
+  gem.metadata["changelog_uri"] = "#{gem.homepage}/blob/master/CHANGELOG.md"
 
   gem.license = "MIT"
   gem.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{(^spec|^\.)}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{(^spec|^bin|^\.)}) }
   end
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency "rake", "~> 12.0"
   gem.add_development_dependency "rspec", "~> 3.9"
+  gem.add_development_dependency "rspec-collection_matchers", "~> 1.2"
+  gem.add_development_dependency "simplecov", "~> 0.18.5"
   gem.add_development_dependency "standard", "~> 0.4.7"
+  gem.add_development_dependency "vcr", "~> 6.0"
 
   gem.add_runtime_dependency "faraday", "~> 1.0", ">= 1.0.1"
   gem.add_runtime_dependency "hashie", "~> 4.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redox-client
 version: !ruby/object:Gem::Version
-  version: 0.0.0.pre.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Michael Keirnan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -93,20 +135,42 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- lib/redox/client.rb
-- lib/redox/client/version.rb
+- lib/redox.rb
+- lib/redox/file_upload.rb
+- lib/redox/media/new.rb
+- lib/redox/model.rb
+- lib/redox/models/address.rb
+- lib/redox/models/contact.rb
+- lib/redox/models/demographics.rb
+- lib/redox/models/destination.rb
+- lib/redox/models/error.rb
+- lib/redox/models/location.rb
+- lib/redox/models/media.rb
+- lib/redox/models/message.rb
+- lib/redox/models/meta.rb
+- lib/redox/models/patient.rb
+- lib/redox/models/patient_identifier.rb
+- lib/redox/models/phone_number.rb
+- lib/redox/models/provider.rb
+- lib/redox/models/visit.rb
+- lib/redox/patient_search/query.rb
+- lib/redox/query.rb
+- lib/redox/scheduling/booked.rb
+- lib/redox/source.rb
+- lib/redox/version.rb
 - redox-client.gemspec
 homepage: https://github.com/patient-discovery/redox-client
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/patient-discovery/redox-client
-  changelog_uri: https://github.com/patient-discovery/redox-client/CHANGELOG.md
+  changelog_uri: https://github.com/patient-discovery/redox-client/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -118,9 +182,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 

data/lib/redox/client.rb

@@ -1,8 +0,0 @@
-require "redox/client/version"
-
-module Redox
-  module Client
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end

data/lib/redox/client/version.rb

@@ -1,5 +0,0 @@
-module Redox
-  module Client
-    VERSION = '0.0.0-0'
-  end
-end