close_encounters 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad2eb14acac02e5a5795ffd9508b0bb7dd19987265e398bcdbb73fe48ff42407
-  data.tar.gz: 123e788ca23010056255b21bc9a71a4fd27e4bdd1e340586b22147f8fe10e8cb
+  metadata.gz: e7c56a469fc69cd3a15c93f84ac6a3789415a41d8499df1ea2fd28f5f1aeb07b
+  data.tar.gz: 8e0b47517ce53491205e3a89c65a56347bed80473e7cb7ac0cec908aaddd06d8
 SHA512:
-  metadata.gz: fdf6130ae5170dc17f1af37cc16e7405c334b722d0ced759c8012782a1b314a73a518886bbd5f7d9199384097bf8554373379da16cb0a92dea781190095ff028
-  data.tar.gz: a652c2aaa5215275695811da24003816689a19de14407ba053186ef7c007f9825010d5053b00e2cd9421b6399f74f4b44d7255994ee22bab98f57056f360a897
+  metadata.gz: a376bbdf0a61509ec060f2624a97498493decb68f7f5655eae922e2980c802378e6c3550fff069dd7d9582cf3c3923befed034bfaa1e735d83375dcbe0156cdb
+  data.tar.gz: 5af33cc8325f9db5f3a8a5db639049e02509111c83c096f046c1248114e85ede0b743e69fa2f5f4eba57de998c8192ad592c5d91e39c82006c0dbe17e51014d4

data/CHANGELOG.md

@@ -5,24 +5,24 @@ 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.1.3] - 2024-07-11
+## [0.2.1] - 2025-03-05
 
-## [] - 
-
-### 
+### Added
 
-- [] -
+- Add alias for verify method as scan.
+- Add configuration for auto_contact and verify_scan_statuses.
 
-### Removed
+### Changed
 
-- Remove serialize connection_info for manual methods
+- 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.1.2] - 2024-07-11
+## [0.2.0] - 2025-02-26
 
-### Added
+### Changed
 
-- Check if the table exits before conditionally setting up the serialize column
+- Test with Ruby 3.4
 
-### Removed
+### Added
 
-- Appending engine migrations to the main app's migration path
+- 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.

data/README.md

@@ -27,6 +27,23 @@ CloseEncounters.status("SomeThirdPartyService") # => 200
 CloseEncounters.status("SomeThirdPartyService") # => 500
 ```
 
+### Rack Middleware
+
+Setup your middleware in your `config/application.rb` or `config/environments/production.rb`.
+
+```ruby
+config.middleware.use CloseEncounters::Middleware
+```
+
+This will automatically track responses from third-party services when you store a "domain" key in the
+`connection_info` in the ParticipantService records.
+
+Alternatively, you can use the `auto_contact!` method to automatically turn on the rack middleware:
+
+```ruby
+CloseEncounters.auto_contact!
+```
+
 ### TODO
 
 - [ ] Add JS to the gem to track events on the front-end.

data/app/models/close_encounters/participant_event.rb

@@ -6,5 +6,13 @@ module CloseEncounters
       foreign_key: "close_encounters_participant_service_id"
 
     scope :newest, -> { order(created_at: :desc).limit(1) }
+
+    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/db/migrate/20250225232551_add_metadata_to_close_encounters_participant_events.rb

@@ -0,0 +1,9 @@
+class AddMetadataToCloseEncountersParticipantEvents < ActiveRecord::Migration[7.1]
+  def change
+    if ActiveRecord::Base.connection.adapter_name.downcase.include?("postgresql")
+      add_column :close_encounters_participant_events, :metadata, :jsonb
+    else
+      add_column :close_encounters_participant_events, :metadata, :text
+    end
+  end
+end

data/lib/close_encounters/engine.rb

@@ -1,3 +1,4 @@
+require_relative "middleware"
 module CloseEncounters
   class Engine < ::Rails::Engine
     isolate_namespace CloseEncounters
@@ -6,6 +7,10 @@ module CloseEncounters
       g.test_framework :minitest, spec: true
     end
 
+    initializer "close_encounters.middleware" do |app|
+      app.middleware.use CloseEncounters::Middleware if CloseEncounters.auto_contact?
+    end
+
     if defined?(Importmap)
       initializer "close_encounters.importmap", before: "importmap" do |app|
         app.config.importmap.paths << root.join("config/importmap.rb")

data/lib/close_encounters/middleware.rb

@@ -0,0 +1,31 @@
+module CloseEncounters
+  class Middleware
+    def initialize(app, tracker: CloseEncounters)
+      @app = app
+      @tracker = tracker
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      record_contact(env["SERVER_NAME"], status, response)
+
+      [status, headers, response]
+    end
+
+    private
+
+    def record_contact(host, status, response)
+      if (name = participant_services[host])
+        @tracker.contact(name, status:, response:)
+      end
+    end
+
+    def participant_services
+      @participant_services ||= CloseEncounters::ParticipantService.all
+        .map do |service|
+          [service.connection_info["domain"], service.name]
+        end.to_h
+    end
+  end
+end

data/lib/close_encounters/version.rb

@@ -1,3 +1,3 @@
 module CloseEncounters
-  VERSION = "0.1.3"
+  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
@@ -19,6 +36,54 @@ module CloseEncounters
     end
   end
 
+  # Record a verification of a contact with a third party service where the
+  # verification is a callable which must also respond to to_s.
+  #
+  # 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 scan(name, status:, response:, verifier:)
+    service = ParticipantService.find_by!(name:)
+    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
+  #
+  # Set the CLOSE_ENCOUNTERS_AUTO_CONTACT environment variable to enable this feature
+  # or call CloseEncounters.auto_contact! in an initializer
+  #
+  # @return [Boolean] whether or not to automatically record contacts
+  def 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!
+    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.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -112,13 +112,14 @@ files:
 - app/models/close_encounters/application_record.rb
 - app/models/close_encounters/participant_event.rb
 - app/models/close_encounters/participant_service.rb
-- app/views/layouts/close_encounters/application.html.erb
 - config/importmap.rb
 - db/migrate/20240430173723_create_close_encounters_participant_services.rb
 - db/migrate/20240430173725_create_close_encounters_participant_events.rb
 - db/migrate/20240508190642_add_close_ecounters_indexes.rb
+- db/migrate/20250225232551_add_metadata_to_close_encounters_participant_events.rb
 - lib/close_encounters.rb
 - lib/close_encounters/engine.rb
+- lib/close_encounters/middleware.rb
 - lib/close_encounters/version.rb
 - lib/tasks/close_encounters.rake
 homepage: https://github.com/SOFware/close_encounters

data/app/views/layouts/close_encounters/application.html.erb

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Close encounters</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "close_encounters/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>