redox-client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f0d83a6d33710574c0f6155a7a255baec5d3ad2c63ccd53640814002b9dc39e
-  data.tar.gz: 973b6a299bad59fdb9dd0ae0341e241bdfa377963642312e3cea67e24e7e923b
+  metadata.gz: 7e25af2125fc17dda61023bc6513a886a24fe2e3b6fe9fae958ba6c43edb351b
+  data.tar.gz: 33b595b60b546ae11e18c54b6db60cdfb0c6d21681c0f69d8f1d8d9d3afea1ca
 SHA512:
-  metadata.gz: b83d9b7c136ed63c448c993c269a20e2ab4ab6819e588a67c32c7ae81ae6f446a79ca33468b8af1b3f74f4cc3e9786f637aee37dd25ee034b65a16fb2f9be1bd
-  data.tar.gz: 30b26d98cc7dadc1498a00a7e128ee4493f1d68c23f17f1ba7722fe7408530550d1f67305985942f1b52950acbb40086447ef296d6ca25e439425089f7a25b32
+  metadata.gz: bdc40d505021f48100f7a2f176e4a0811611b90de70cf9caee2fdb489d707f1266a815564dbf36567bab0de64ad79642b65914169ec76b7c42218d8212118271
+  data.tar.gz: 23c892f9c708256e3ed4d6f83158501daef2f3ee155dfde99938ef4bc5de2071f27850d1e036604556ca6527a5ec468e388bff38b7c33ba66732073ac56184de

data/CHANGELOG.md

@@ -7,6 +7,17 @@
 
 ### 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
@@ -32,4 +43,5 @@
 [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
-[Unreleased]: https://github.com/patient-discovery/redox-client/compare/v0.4.0...HEAD
+[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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redox-client (0.4.0)
+    redox-client (0.5.0)
       faraday (~> 1.0, >= 1.0.1)
       hashie (~> 4.1)
 

data/README.md

@@ -79,6 +79,8 @@ Since `Redox::Source` has shared state, i.e., the access token and its expiratio
 
 - 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.*
@@ -91,12 +93,27 @@ This project uses `rspec` and [VCR](https://relishapp.com/vcr/vcr/docs). VCR pro
 
 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:
+### 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 REDOX_API_KEY=my-key REDOX_SECRET=my-secret rspec
+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.

data/lib/redox.rb

@@ -9,6 +9,7 @@ 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"
@@ -17,10 +18,13 @@ 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/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

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

@@ -4,12 +4,17 @@ 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

data/lib/redox/scheduling/booked.rb

@@ -12,8 +12,6 @@ module Redox
         v.respond_to?(:iso8601) ? v.iso8601 : v.to_s
       }
 
-      redox_property :Patient, coerce: Models::Patient
-
       def response_type
         BookedResponse
       end

data/lib/redox/source.rb

@@ -7,7 +7,8 @@ require "faraday"
 class Redox::Source
   include MonitorMixin
 
-  ACCESS_TOKEN_EXPIRATION_BUFFER_SECONDS = 300
+  SECONDS_PER_DAY = 60 * 60 * 24
+  ACCESS_TOKEN_EXPIRATION_BUFFER = Rational(300, SECONDS_PER_DAY)
 
   attr_reader :access_token_expires_at
 
@@ -63,12 +64,12 @@ class Redox::Source
     end
   end
 
-  private
-
   def token_expiring_soon?
-    DateTime.now > @access_token_expires_at - ACCESS_TOKEN_EXPIRATION_BUFFER_SECONDS
+    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)

data/lib/redox/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redox-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Michael Keirnan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -142,6 +142,8 @@ files:
 - README.md
 - Rakefile
 - 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
@@ -149,6 +151,7 @@ files:
 - 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