redox 1.8.6 → 1.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5742373796299f7b326bcdf0092a6cc6048ea5af88f9b99352393078fa2274c3
-  data.tar.gz: 61af84c3bf51295755730f5e8f12db9be8290341ec41c53b42cbea26bfbc0ed3
+  metadata.gz: 2bc256b17ea2a9745930f73c9f2dc82dcf1168e30da66de044c504ebee800a78
+  data.tar.gz: 5308af92aebf6176a20cbc4915a5cd1aa2a47a023cab6426980059a0dd7178c0
 SHA512:
-  metadata.gz: d09ec3e490dc6f82c147e2e54e68f5ad66466b7488a84ffad9eae5300cdc30e1f5260e1132b0713a8955edc1528e2228b5152035f42820bb75f004d9e465fc5d
-  data.tar.gz: bd8b9a01d13eaccbe0a8dcfafc90de10ee1dc88b63add310b06436a1aa2d4453c8a77dc89db5e71c9737a3fee8571cb6500251f977dd680bafac5a29b5d6998e
+  metadata.gz: 4179504877fa5e41874f3de73537d49f9612b01360a45d96ed90d666b9b5e60964f0616419b0ce90463550e8d1dceb4e87f953cb0696b44b45a8fe55b616149c
+  data.tar.gz: 7ec7560d7e7087c5bcccb0a5d20bee3c57a99f309ab88bc8a9270244d2e4e9f1d266a8889edac501211dbd35213a2e23b54edeb393b5dd64fc4f2ee9443249f7

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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).
 
+## [1.8.7] - 2025-07-30
+### Changed
+- Gemspec dependency httparty version
+- Gemfile rake version
+- Moved development dependencies to Gemfile
+- GitHub Actions CI
+- Rubocop suggestions
+
+### Added
+- Gemfile rubocop, rubocop-minitest, rubocop-performance
+
 ## [1.8.6] - 2023-05-12
 ### Changed
 - Updated test JSON files for update retiring Meta.Message.ID and Meta.Transmission.ID
@@ -207,6 +218,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Initial Release
 
+[1.8.7]: https://github.com/WeInfuse/redox/compare/v1.8.6...v1.8.7
 [1.8.6]: https://github.com/WeInfuse/redox/compare/v1.8.5...v1.8.6
 [1.8.5]: https://github.com/WeInfuse/redox/compare/v1.8.4...v1.8.5
 [1.8.4]: https://github.com/WeInfuse/redox/compare/v1.8.3...v1.8.4

data/Gemfile

@@ -1,4 +1,17 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in redox.gemspec
 gemspec
+
+gem 'bundler', '>=1', '<3'
+gem 'byebug', '~> 11'
+gem 'minitest', '~> 5.0'
+gem 'ostruct', '~> 0.6.3'
+gem 'rake', '~> 13.3'
+gem 'rubocop'
+gem 'rubocop-minitest'
+gem 'rubocop-performance'
+gem 'webmock', '~> 3.1'
+gem 'yard', '~> 0.9'

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/lib/redox/authentication.rb

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/MissingSuper
+# rubocop:disable Style/ClassVars
+# rubocop:disable Metrics/MethodLength
 module Redox
   class Authentication < Connection
     attr_accessor :response
 
-    BASE_ENDPOINT    = '/auth'.freeze
+    BASE_ENDPOINT    = '/auth'
 
-    AUTH_ENDPOINT    = "#{BASE_ENDPOINT}/authenticate".freeze
-    REFRESH_ENDPOINT = "#{BASE_ENDPOINT}/refreshToken".freeze
+    AUTH_ENDPOINT    = "#{BASE_ENDPOINT}/authenticate"
+    REFRESH_ENDPOINT = "#{BASE_ENDPOINT}/refreshToken"
 
     class << self
       attr_accessor :token_expiry_padding
@@ -18,22 +23,22 @@ module Redox
     end
 
     def authenticate
-      if (self.expires?)
-        if (self.refresh_token)
-          request = {
-            body: { apiKey: Redox.configuration.api_key, refreshToken: self.refresh_token },
-            endpoint: REFRESH_ENDPOINT
-          }
-        else
-          request = {
-            body: { apiKey: Redox.configuration.api_key, secret: Redox.configuration.secret },
-            endpoint: AUTH_ENDPOINT
-          }
-        end
+      if expires?
+        request = if refresh_token
+                    {
+                      body: { apiKey: Redox.configuration.api_key, refreshToken: refresh_token },
+                      endpoint: REFRESH_ENDPOINT
+                    }
+                  else
+                    {
+                      body: { apiKey: Redox.configuration.api_key, secret: Redox.configuration.secret },
+                      endpoint: AUTH_ENDPOINT
+                    }
+                  end
 
         response = self.request(**request, auth: false)
 
-        if (false == response.ok?)
+        if false == response.ok?
           @response = nil
           raise RedoxException.from_response(response, msg: 'Authentication')
         else
@@ -41,32 +46,33 @@ module Redox
         end
       end
 
-      return self
+      self
     end
 
     def access_token
-      return @response['accessToken'] if @response
+      @response['accessToken'] if @response
     end
 
     def expiry
-      return @response['expires'] if @response
+      @response['expires'] if @response
     end
 
     def refresh_token
-      return @response['refreshToken'] if @response
+      @response['refreshToken'] if @response
     end
 
     def expires?(seconds_from_now = Authentication.token_expiry_padding)
-      if (self.expiry)
-        return DateTime.strptime(self.expiry, Models::Meta::FROM_DATETIME_FORMAT).to_time.utc <= (Time.now + seconds_from_now).utc
+      if expiry
+        DateTime.strptime(expiry,
+                          Models::Meta::FROM_DATETIME_FORMAT).to_time.utc <= (Time.now + seconds_from_now).utc
       else
-        return true
+        true
       end
     end
 
     def access_header
-      return {
-        'Authorization' => "Bearer #{self.access_token}",
+      {
+        'Authorization' => "Bearer #{access_token}"
       }
     end
 
@@ -75,3 +81,6 @@ module Redox
     end
   end
 end
+# rubocop:enable Metrics/MethodLength
+# rubocop:enable Style/ClassVars
+# rubocop:enable Lint/MissingSuper

data/lib/redox/connection.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Redox
   class Connection
-    DEFAULT_ENDPOINT = '/endpoint'.freeze
+    DEFAULT_ENDPOINT = '/endpoint'
 
     include HTTParty
 
-    base_uri 'https://api.redoxengine.com/'.freeze
+    base_uri 'https://api.redoxengine.com/'
 
     headers 'Content-Type' => 'application/json'
 
@@ -22,7 +24,7 @@ module Redox
     def auth_header
       @auth ||= Authentication.new
 
-      return @auth.authenticate.access_header
+      @auth.authenticate.access_header
     end
   end
 end

data/lib/redox/models/administration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class Administration < AbstractModel
@@ -6,10 +8,10 @@ module Redox
       property :StartDate, required: false, from: :start_date
       property :EndDate, required: false, from: :end_date
 
-      alias_method :status, :Status
-      alias_method :medication, :Medication
-      alias_method :start_date, :StartDate
-      alias_method :end_date, :EndDate
+      alias status Status
+      alias medication Medication
+      alias start_date StartDate
+      alias end_date EndDate
     end
   end
 end

data/lib/redox/models/component.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class Component < AbstractModel
@@ -5,9 +7,9 @@ module Redox
       property :Name, required: false, from: :name
       property :Value, required: false, from: :value
 
-      alias_method :id, :ID
-      alias_method :name, :Name
-      alias_method :value, :Value
+      alias id ID
+      alias name Name
+      alias value Value
     end
   end
 end

data/lib/redox/models/financial.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class Financial < AbstractModel
@@ -5,9 +7,9 @@ module Redox
       property :Patient, required: false, from: :patient, default: Redox::Models::Patient.new
       property :Transactions, required: false, from: :transactions, default: []
 
-      alias_method :patient, :Patient
-      alias_method :visit, :Visit
-      alias_method :transactions, :Transactions
+      alias patient Patient
+      alias visit Visit
+      alias transactions Transactions
     end
   end
 end

data/lib/redox/models/media/notification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class Notification < AbstractModel
@@ -7,10 +9,10 @@ module Redox
       property :IDType, from: :id_type
       property :LastName, required: false, from: :last_name
 
-      alias_method :first_name, :FirstName
-      alias_method :id_type, :IDType
-      alias_method :id, :ID
-      alias_method :last_name, :LastName
+      alias first_name FirstName
+      alias id_type IDType
+      alias id ID
+      alias last_name LastName
     end
   end
 end

data/lib/redox/models/media.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class Media < AbstractModel
@@ -15,37 +17,35 @@ module Redox
       property :Provider, from: :provider, required: false
       property :ServiceDateTime, from: :service_date_time, required: false
 
-      alias_method  :availability, :Availability
-      alias_method  :direct_address_from, :DirectAddressFrom
-      alias_method  :direct_address_to, :DirectAddressTo
-      alias_method  :document_id, :DocumentID
-      alias_method  :document_type, :DocumentType
-      alias_method  :file_contents, :FileContents
-      alias_method  :file_name, :FileName
-      alias_method  :file_type, :FileType
-      alias_method  :provider, :Provider
-      alias_method  :service_date_time, :ServiceDateTime
-      alias_method  :notifications, :Notifications
+      alias availability Availability
+      alias direct_address_from DirectAddressFrom
+      alias direct_address_to DirectAddressTo
+      alias document_id DocumentID
+      alias document_type DocumentType
+      alias file_contents FileContents
+      alias file_name FileName
+      alias file_type FileType
+      alias provider Provider
+      alias service_date_time ServiceDateTime
+      alias notifications Notifications
 
       def availability=(value)
-        case value
-        when true
-          self[:Availability] = 'Available'
-        when false
-          self[:Availability] = 'Unavailable'
-        else
-          self[:Availability] = value
-        end
+        self[:Availability] = case value
+                              when true
+                                'Available'
+                              when false
+                                'Unavailable'
+                              else
+                                value
+                              end
       end
 
       def add_filepath(path)
-        if File.size(path) > BLOB_REQUIRED_SIZE
-          raise 'Not implemented'
-        else
-          self.file_contents = Base64::encode64(File.read(path))
-          self.file_type     = "#{File.extname(path)}".delete_prefix('.').upcase
-          self.file_name     = File.basename(path, '.*')
-        end
+        raise 'Not implemented' if File.size(path) > BLOB_REQUIRED_SIZE
+
+        self.file_contents = Base64.encode64(File.read(path))
+        self.file_type     = File.extname(path).to_s.delete_prefix('.').upcase
+        self.file_name     = File.basename(path, '.*')
       end
     end
   end

data/lib/redox/models/media_upload.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class MediaUpload < AbstractModel
@@ -5,9 +7,9 @@ module Redox
       property :Visit, required: false, from: :visit, default: Redox::Models::Visit.new
       property :Media, required: false, from: :media, default: Redox::Models::Media.new
 
-      alias_method :patient, :Patient
-      alias_method :visit, :Visit
-      alias_method :media, :Media
+      alias patient Patient
+      alias visit Visit
+      alias media Media
     end
   end
 end

data/lib/redox/models/medication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class Medication < AbstractModel
@@ -12,16 +14,16 @@ module Redox
       property :Indications, required: false, from: :indications, default: []
       property :AdministeringProvider, required: false, from: :administering_provider, default: {}
 
-      alias_method :order, :Order
-      alias_method :lot_number, :LotNumber
-      alias_method :dose, :Dose
-      alias_method :rate, :Rate
-      alias_method :route, :Route
-      alias_method :product, :Product
-      alias_method :components, :Components
-      alias_method :ordered_by, :OrderedBy
-      alias_method :indications, :Indications
-      alias_method :administering_provider, :AdministeringProvider
+      alias order Order
+      alias lot_number LotNumber
+      alias dose Dose
+      alias rate Rate
+      alias route Route
+      alias product Product
+      alias components Components
+      alias ordered_by OrderedBy
+      alias indications Indications
+      alias administering_provider AdministeringProvider
     end
   end
 end

data/lib/redox/models/medications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class Medications < AbstractModel
@@ -5,14 +7,13 @@ module Redox
       property :Patient, required: false, from: :patient, default: Redox::Models::Patient.new
       property :Administrations, required: false, from: :administrations, default: []
 
-      alias_method :patient, :Patient
-      alias_method :visit, :Visit
-      alias_method :administrations, :Administrations
+      alias patient Patient
+      alias visit Visit
+      alias administrations Administrations
 
       def create(meta: Meta.new)
         Redox::Request::Medications.administration(patient: self, meta: meta)
       end
-
     end
   end
 end

data/lib/redox/models/meta.rb

@@ -1,41 +1,43 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
     class Meta < Model
-      TO_DATETIME_FORMAT   = '%Y-%m-%dT%H:%M:%S.%6NZ'.freeze
-      FROM_DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%N%Z'.freeze
+      TO_DATETIME_FORMAT   = '%Y-%m-%dT%H:%M:%S.%6NZ'
+      FROM_DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%N%Z'
 
       property :DataModel, from: :data_model, required: false
       property :EventType, from: :event_type, required: false
-      property :EventDateTime, from: :event_date_time, default: ->() { Time.now.utc.strftime(TO_DATETIME_FORMAT) }
+      property :EventDateTime, from: :event_date_time, default: -> { Time.now.utc.strftime(TO_DATETIME_FORMAT) }
       property :Test, from: :test, default: true
       property :Source, from: :source, required: false
       property :Destinations, from: :destinations, required: false
       property :FacilityCode, from: :facility_code, required: false
 
-      alias_method :data_model, :DataModel
-      alias_method :event_type, :EventType
-      alias_method :event_date_time, :EventDateTime
-      alias_method :test, :Test
-      alias_method :source, :Source
-      alias_method :destinations, :Destinations
-      alias_method :facility_code, :FacilityCode
+      alias data_model DataModel
+      alias event_type EventType
+      alias event_date_time EventDateTime
+      alias test Test
+      alias source Source
+      alias destinations Destinations
+      alias facility_code FacilityCode
 
-      def add_destination(name: , id: )
+      def add_destination(name:, id:)
         self[:Destinations] ||= []
         self[:Destinations] << Meta.build_subscription(name: name, id: id)
 
-        return self
+        self
       end
 
-      def set_source(name: , id: )
+      def set_source(name:, id:)
         self[:Source] = Meta.build_subscription(name: name, id: id)
 
-        return self
+        self
       end
 
       class << self
-        def build_subscription(name: , id:)
-          return {
+        def build_subscription(name:, id:)
+          {
             'ID' => id,
             'Name' => name
           }

data/lib/redox/models/model.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Redox
   module Models
-    def self.format_datetime(d)
-      if d.respond_to?(:strftime)
-        d.strftime(Redox::Models::Meta::TO_DATETIME_FORMAT)
+    def self.format_datetime(date)
+      if date.respond_to?(:strftime)
+        date.strftime(Redox::Models::Meta::TO_DATETIME_FORMAT)
       else
-        d
+        date
       end
     end
 
@@ -12,7 +14,7 @@ module Redox
       include Hashie::Extensions::IgnoreUndeclared
       include Hashie::Extensions::IndifferentAccess
 
-      HIGH_LEVEL_KEYS = %w[Meta Patient Visit PotentialMatches]
+      HIGH_LEVEL_KEYS = %w[Meta Patient Visit PotentialMatches].freeze
 
       property :Meta, from: :meta, required: false
       property :Patient, from: :patient, required: false
@@ -21,72 +23,78 @@ module Redox
       property :Extensions, from: :extensions, required: false
       property :response, required: false
 
-      alias_method :potential_matches, :PotentialMatches
-      alias_method :patient, :Patient
-      alias_method :visit, :Visit
-      alias_method :meta, :Meta
+      alias potential_matches PotentialMatches
+      alias patient Patient
+      alias visit Visit
+      alias meta Meta
 
-      def to_json(args = {})
-        return self.to_h.to_json
+      def to_json(_args = {})
+        to_h.to_json
       end
 
       def insurances
-        (self.patient&.insurances || []) + (self.visit&.insurances || [])
+        (patient&.insurances || []) + (visit&.insurances || [])
       end
 
       def self.from_response(response)
         model = Model.new
         model.response = response
 
+        # rubocop:disable Lint/SuppressedException
         HIGH_LEVEL_KEYS.each do |k|
-          begin
-            model.send("#{k}=", Module.const_get("Redox::Models::#{k}").new(response[k])) if response[k]
-          rescue
-          end
+          model.send("#{k}=", Module.const_get("Redox::Models::#{k}").new(response[k])) if response[k]
+        rescue StandardError
         end
+        # rubocop:enable Lint/SuppressedException
 
-        return model
+        model
       end
 
       def self.from_response_inflected(response)
-        model = self.from_response(response)
-
-        if (model.response.ok?)
-          data = model.response.parsed_response
-
-          if data.respond_to?(:keys)
-            model_class = nil
-
-            if model.meta&.data_model
-              model_class = "Redox::Models::#{model.meta.data_model}"
-
-              begin
-                model_class = Object.const_get(model_class)
-              rescue NameError
-                model_class = nil
-              end
-            end
-
-            data.keys.each do |key|
-              next if HIGH_LEVEL_KEYS.include?(key.to_s)
-
-              helper_name = key.to_s.downcase.to_sym
-
-              if model_class.nil?
-                model.define_singleton_method(helper_name) { data[key] }
-              else
-                if data[key].is_a?(Array)
-                  model.define_singleton_method(helper_name) { data[key].map {|obj| model_class.new(obj) } }
-                else
-                  model.define_singleton_method(helper_name) { model_class.new(data[key]) }
-                end
-              end
-            end
+        model = from_response(response)
+
+        return model unless model.response.ok?
+
+        data = model.response.parsed_response
+
+        return model unless data.respond_to?(:keys)
+
+        add_helpers(model, data)
+      end
+
+      def self.get_inflected_class(data_model)
+        return if data_model.nil?
+
+        model_class = "Redox::Models::#{data_model}"
+
+        begin
+          Object.const_get(model_class)
+        rescue NameError
+          nil
+        end
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def self.add_helpers(model, data)
+        model_class = get_inflected_class(model.meta&.data_model)
+
+        data.each_key do |key|
+          next if HIGH_LEVEL_KEYS.include?(key.to_s)
+
+          helper_name = key.to_s.downcase.to_sym
+
+          if model_class.nil?
+            model.define_singleton_method(helper_name) { data[key] }
+          elsif data[key].is_a?(Array)
+            model.define_singleton_method(helper_name) { data[key].map { |obj| model_class.new(obj) } }
+          else
+            model.define_singleton_method(helper_name) { model_class.new(data[key]) }
           end
         end
 
-        return model
+        model
       end
+      # rubocop:enable Metrics/AbcSize
     end
 
     class Model < AbstractModel
@@ -99,16 +107,17 @@ module Redox
           end
         end
 
-        super(data)
+        super
       end
 
       def to_h
-        return { key => super.to_h }
+        { key => super.to_h }
       end
 
       private
+
       def key
-        return self.class.to_s.split('::').last.to_s
+        self.class.to_s.split('::').last.to_s
       end
     end
   end