close_encounters 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a98acff8fa4c0e6c76e3ed6395f5717ee7dbf47873c4090dc31d5017e86ef2
-  data.tar.gz: 96af7f9bc65d6f0ad66932f87d4d6a0f6ed80416b718b787ae73bcf332058943
+  metadata.gz: 4954f6a9a487299009cb84b6af2571743e1d08d2703683edbcde73e0670a154b
+  data.tar.gz: d05d458352582236246c0ceab9f556f8ca3c2df9c3531db3e35123e854cb6485
 SHA512:
-  metadata.gz: 8398c29adc130ca89723d8af7e05d507f6427bcb4b5037c3f587249dbbdcf3773b2821122a81cdc6c57768785bd6fade2ed665bca4d242b0e14468b94ce6c102
-  data.tar.gz: 35fd7ce3f343d2a9fea20c875f8ef50f4c79c690fc7641d49b8797801a655694a49dc1741c42df4126b0347a0b31e9d89b5c4dd105e68093a631e9a8c874ba6c
+  metadata.gz: 64c3973533245763a65dd67e466c6da6b7f425853aeaebeb4712d94eb115dfc36484a49ea146a93db1e77dd5848f4c8770d1768a76c5b435d43f4acdd2f196e0
+  data.tar.gz: d2c569f12ce8da83cfc3d3eb8d437b0100436687212bbded9d10fee5989a74e5bd3c67d03b2f4d314c4903bdbcd90bc74990bba754cbc9ac5f9cfb5d2b612d46

data/CHANGELOG.md

@@ -5,26 +5,15 @@ 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.2] - 2024-07-11
+## [0.2.0] - 2025-02-26
 
-### Added
-
-- Check if the table exits before conditionally setting up the serialize column
-
-### Removed
+### Changed
 
-- Appending engine migrations to the main app's migration path
-
-## [0.1.1] - 2024-07-11
+- Test with Ruby 3.4
 
 ### Added
 
-- Support for Importmaps
-- `reissue` gem for managing releases
-
-### Fixed
+- 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.
 
-- Alter newest scope to properly return a relation limited to 1 record
-- Update ensure_service to not overwrite existing connection_info
-- Allow specs to run properly locally
-- Incorrect manifest paths for sprockets
+## [0.1.4] - Unreleased

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,9 @@ 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
   end
 end

data/app/models/close_encounters/participant_service.rb

@@ -6,18 +6,21 @@ module CloseEncounters
 
     validates :name, presence: true
 
-    # if the table exists, then we can check the column type
-    if connection.table_exists?(table_name) && (
-      columns_hash = connection.schema_cache.columns_hash(table_name)
-    )
-      if columns_hash["connection_info"].type == :text
-        serialize :connection_info, coder: JSON
-      end
-    end
-
     # ONLY encrypt if you have the necessary keys
     if Rails.application.credentials.close_encounters_encryption_key.present?
       encrypts :connection_info
     end
+
+    def connection_info
+      if super.is_a?(String)
+        JSON.parse(super)
+      else
+        super
+      end
+    end
+
+    def connection_info=(value)
+      super(value.to_json)
+    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.2"
+  VERSION = "0.2.0"
 end

data/lib/close_encounters.rb

@@ -19,6 +19,39 @@ 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.
+  #
+  # 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.
+  #
+  # @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:)
+    service = ParticipantService.find_by!(name:)
+    unless service.events.newest.pick(:status) == status && (verified = verifier.call(response))
+      service.events.create!(status:, response:, metadata: {verified:, verification: verifier.to_s})
+    end
+  end
+
+  # 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?
+    !!(ENV["CLOSE_ENCOUNTERS_AUTO_CONTACT"] || @auto_contact)
+  end
+
+  # Enable automatic contact recording in the Rack Middleware
+  def auto_contact!
+    @auto_contact = true
+  end
+
   # 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.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2025-02-26 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>