redox-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682fb0886128839a8dd06635c1c3da718f9707a8d222c3702ed4401931fbd3d4
-  data.tar.gz: b8d36a7a36c1f278ef81f6a4bfe1ac452a573678316ae64224f208b563b64950
+  metadata.gz: 7d4299c12f9132415ab91ad2ffad342feac72cd08159f608844951831ab45cbf
+  data.tar.gz: 92888834d1ec14cc7b35f91767bfdb950331533bad8a88b8f6f08b9fef542909
 SHA512:
-  metadata.gz: 4775f40565fb129f5c701c37da3077f2a6a41498a9b7ce7ea89bfdf105b5731a73343323faa9c4472a8fae5814112cc8835fe383a74c2236b07948a53e6be2e3
-  data.tar.gz: f5279b33223b00641e91e399b3a660cb72be8d5945ce34c632d9920b1c2def89bada648d2e3d1e26905adb87d3fd4770e125b98efc3e77575292df1340d22566
+  metadata.gz: 8a9352e931af11b49722b5e86fd6fde9974198ba11dc39e1bb4bf26efd64166f31073be8eb057c6ef6173c95ba466fce99a99a1d286497f948977831032a00be
+  data.tar.gz: 12a7fb2890bfac558b8b46d578254aca9e6205341dbbac32c1f70126c77054e5c7dd7d0190668ac72a875369b2efa0a8ae22531a6a5b5205b32f6eabb26bd15f

data/CHANGELOG.md

@@ -7,6 +7,11 @@
 
 ### Removed
 
+## [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
@@ -20,4 +25,5 @@
 
 [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
-[Unreleased]: https://github.com/patient-discovery/redox-client/compare/v0.2.0...HEAD
+[0.3.0]: https://github.com/patient-discovery/redox-client/releases/tag/v0.3.0
+[Unreleased]: https://github.com/patient-discovery/redox-client/compare/v0.3.0...HEAD

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redox-client (0.2.0)
+    redox-client (0.3.0)
       faraday (~> 1.0, >= 1.0.1)
       hashie (~> 4.1)
 
@@ -26,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)
@@ -66,6 +68,7 @@ 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)

data/README.md

@@ -77,6 +77,7 @@ Since `Redox::Source` has shared state, i.e., the access token and its expiratio
 ## Supported APIs
 
 - PatientSearch.Query
+- Scheduling.Booked
 
 ## 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.*
@@ -87,6 +88,14 @@ After checking out the repo, run `bin/setup` to install gem dependencies and a g
 ### 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.
+
+To make a new test with a new recording:
+
+```bash
+env REDOX_API_KEY=my-key REDOX_SECRET=my-secret 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.
@@ -96,7 +105,7 @@ 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
-- `bin/check-vcr-cassettes --scrub` - attempt to replace real looking credentials in VCR cassettes with dummy test values.
+- `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
 

data/Rakefile

@@ -15,15 +15,20 @@ desc "Run all checks and tests"
 task default: :test
 
 desc "Run all checks and tests"
-task test: [:rubocop, :standard, :check_vcr_cassettes, :spec]
+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 :check_vcr_cassettes do
-  # TODO: Make this a proper lib/rake_tasks.rb task and avoid exec'ing out
-  raise "Possible credential leak" unless system "bin/check-vcr-cassettes"
+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
@@ -55,6 +60,7 @@ task "prepare:tag" do
   end
 end
 
+desc "Prepare a gem release"
 task "prepare:release": [
   "release:guard_clean", "test", "prepare:version", "prepare:changelog", "prepare:tag"
 ] do

data/lib/redox.rb

@@ -6,16 +6,33 @@ require_relative "redox/model"
 require_relative "redox/models/address"
 require_relative "redox/models/demographics"
 require_relative "redox/models/destination"
+require_relative "redox/models/error"
+require_relative "redox/models/location"
 require_relative "redox/models/message"
 require_relative "redox/models/meta"
-require_relative "redox/models/patient"
 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/query"
 require_relative "redox/source"
 require_relative "redox/patient_search/query.rb"
+require_relative "redox/scheduling/booked.rb"
 
 module Redox
-  class Error < StandardError; end
+  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/model.rb

@@ -55,7 +55,7 @@ class Redox::Model < Hashie::Trash
   # rails `String.underscore` method with the following simplications:
   #
   # - any word in all caps is assumed to be an acronym (ZIP -> zip)
-  # - only alphabetic characters and modified
+  # - only alphabetic characters are modified
   #
   # Note: this function does not have an inverse. Both "Zip" and "ZIP"
   # map to "zip".

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/message.rb

@@ -5,6 +5,7 @@ require_relative "meta"
 module Redox
   module Models
     class Message < Redox::Model
+      attr_accessor :_body
       redox_property :Meta, coerce: Redox::Models::Meta
     end
   end

data/lib/redox/models/meta.rb

@@ -10,6 +10,7 @@ module Redox
       redox_property :EventDateTime
       redox_property :Test
       redox_property :Destinations, coerce: Array[Redox::Models::Destination]
+      redox_property :Errors, coerce: Array[Redox::Models::Error]
     end
   end
 end

data/lib/redox/models/patient.rb

@@ -3,7 +3,11 @@
 require_relative "patient_identifier"
 require_relative "demographics"
 
-class Redox::Models::Patient < Redox::Model
-  redox_property :Identifiers, coerce: Array[Redox::Models::PatientIdentifier]
-  redox_property :Demographics, coerce: Redox::Models::Demographics
+module Redox
+  module Models
+    class Patient < Redox::Model
+      redox_property :Identifiers, coerce: Array[PatientIdentifier]
+      redox_property :Demographics, coerce: Demographics
+    end
+  end
 end

data/lib/redox/models/patient_identifier.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
-class Redox::Models::PatientIdentifier < Redox::Model
-  redox_property :IDType
-  redox_property :ID
+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/query.rb

@@ -12,7 +12,10 @@ module Redox
         event_date_time: DateTime.now.iso8601,
         destinations: [Redox::Models::Destination.new(id: destination_id)]
       }
-      response_type.from_redox_json source.execute_query self
+      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,26 @@
+# 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
+      }
+
+      redox_property :Patient, coerce: Models::Patient
+
+      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

@@ -28,8 +28,21 @@ class Redox::Source
   def execute_query(model)
     ensure_access_token
     res = @connection.post("/endpoint", model.to_redox_json)
-    raise Redox::Error.new "#{res.status} #{res.body}" unless res.success?
-    JSON.parse(res.body)
+    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
@@ -59,7 +72,7 @@ class Redox::Source
   def authenticate
     self.access_token = nil
     res = @connection.post("/auth/authenticate", {apiKey: @api_key, secret: @secret}.to_json)
-    raise Redox::AuthenticationError.new "#{res.status} #{res.body}" unless res.success?
+    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"])

data/lib/redox/version.rb

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

data/redox-client.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |gem|
 
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redox-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Keirnan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ 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
@@ -132,12 +146,18 @@ files:
 - lib/redox/models/address.rb
 - lib/redox/models/demographics.rb
 - lib/redox/models/destination.rb
+- lib/redox/models/error.rb
+- lib/redox/models/location.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