close_encounters 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4954f6a9a487299009cb84b6af2571743e1d08d2703683edbcde73e0670a154b
-  data.tar.gz: d05d458352582236246c0ceab9f556f8ca3c2df9c3531db3e35123e854cb6485
+  metadata.gz: e7c56a469fc69cd3a15c93f84ac6a3789415a41d8499df1ea2fd28f5f1aeb07b
+  data.tar.gz: 8e0b47517ce53491205e3a89c65a56347bed80473e7cb7ac0cec908aaddd06d8
 SHA512:
-  metadata.gz: 64c3973533245763a65dd67e466c6da6b7f425853aeaebeb4712d94eb115dfc36484a49ea146a93db1e77dd5848f4c8770d1768a76c5b435d43f4acdd2f196e0
-  data.tar.gz: d2c569f12ce8da83cfc3d3eb8d437b0100436687212bbded9d10fee5989a74e5bd3c67d03b2f4d314c4903bdbcd90bc74990bba754cbc9ac5f9cfb5d2b612d46
+  metadata.gz: a376bbdf0a61509ec060f2624a97498493decb68f7f5655eae922e2980c802378e6c3550fff069dd7d9582cf3c3923befed034bfaa1e735d83375dcbe0156cdb
+  data.tar.gz: 5af33cc8325f9db5f3a8a5db639049e02509111c83c096f046c1248114e85ede0b743e69fa2f5f4eba57de998c8192ad592c5d91e39c82006c0dbe17e51014d4

data/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.2.1] - 2025-03-05
+
+### Added
+
+- Add alias for verify method as scan.
+- Add configuration for auto_contact and verify_scan_statuses.
+
+### Changed
+
+- Ensure that events are only created if the status has changed or if the status is in the verify_scan_statuses list and verification fails.
+
 ## [0.2.0] - 2025-02-26
 
 ### Changed
@@ -15,5 +26,3 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Ability to use CloseEncounters::Middleware and CloseEncounters.auto_contact! to automatically track responses from third-party services.
 - Add metadata to events for storing extra information about the event.
-
-## [0.1.4] - Unreleased

data/app/models/close_encounters/participant_event.rb

@@ -10,5 +10,9 @@ module CloseEncounters
     unless ActiveRecord::Base.connection.adapter_name.downcase.include?("postgresql")
       serialize :metadata, coder: JSON
     end
+
+    def verified?
+      !!metadata.to_h.dig("verified")
+    end
   end
 end

data/lib/close_encounters/version.rb

@@ -1,3 +1,3 @@
 module CloseEncounters
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/close_encounters.rb

@@ -7,6 +7,23 @@ module CloseEncounters
   autoload :ParticipantService, "close_encounters/participant_service"
   autoload :ParticipantEvent, "close_encounters/participant_event"
 
+  class Configuration
+    attr_accessor :auto_contact, :verify_scan_statuses
+
+    def initialize
+      @auto_contact = !!ENV["CLOSE_ENCOUNTERS_AUTO_CONTACT"]
+      @verify_scan_statuses = [200, 201]
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
   # Record a contact with a third party service if the status has changed
   #
   # @param name [String] the name of the service
@@ -22,19 +39,28 @@ module CloseEncounters
   # Record a verification of a contact with a third party service where the
   # verification is a callable which must also respond to to_s.
   #
-  # For example, provide a callable which checks the JSON Schema for a response body
-  # and will record an event if calling the verification returns false.
+  # Creates a new event if:
+  # 1. The status has changed from the last recorded status
+  # 2. OR the status is in the verify_scan list AND verification fails
   #
   # @param name [String] the name of the service
   # @param status [Integer] the HTTP status of the contact
   # @param response [String] the response object
   # @param verifier [Proc] the verification callable which must also respond to to_s
-  def verify(name, status:, response:, verifier:)
+  def scan(name, status:, response:, verifier:)
     service = ParticipantService.find_by!(name:)
-    unless service.events.newest.pick(:status) == status && (verified = verifier.call(response))
+    last_status = service.events.newest.pick(:status)
+
+    if last_status != status
+      verified = verifier.call(response)
       service.events.create!(status:, response:, metadata: {verified:, verification: verifier.to_s})
+    elsif verify_scan_statuses.include?(status)
+      verified = verifier.call(response)
+      service.events.create!(status:, response:, metadata: {verified:, verification: verifier.to_s}) if !verified
     end
   end
+  alias_method :verify, :scan
+  module_function :verify
 
   # Determine if contacts with third party services should be recorded automatically
   # using the Rack Middleware
@@ -44,14 +70,20 @@ module CloseEncounters
   #
   # @return [Boolean] whether or not to automatically record contacts
   def auto_contact?
-    !!(ENV["CLOSE_ENCOUNTERS_AUTO_CONTACT"] || @auto_contact)
+    # If auto_contact is explicitly set, use that value
+    return configuration.auto_contact unless configuration.auto_contact.nil?
+    # Otherwise check the environment variable
+    !!ENV["CLOSE_ENCOUNTERS_AUTO_CONTACT"]
   end
 
   # Enable automatic contact recording in the Rack Middleware
   def auto_contact!
-    @auto_contact = true
+    configuration.auto_contact = true
   end
 
+  # Get the statuses that should be verified
+  def verify_scan_statuses = configuration.verify_scan_statuses
+
   # Get the status of the most recent contact with a third party service
   #
   # @param name [String] the name of the service

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: close_encounters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties