close_encounters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a24140efc0d1f7aa0f701d7c7ac16a1ced62c808d44224220dff606156cc08b3
+  data.tar.gz: cbf2f638428e2526cec682ba2250c465632f4aad9d8028135d61c63fac99f9ce
+SHA512:
+  metadata.gz: 5a7cd81cdb97205774b919c928fd81ba896fa22300784171a8e3037c0d5a1243c5da1e8587d7c616b7e7ead0b3973cc4fa06cada1579ec22af4b5170c87dc670
+  data.tar.gz: 85223a244ef256129651b57eb089f712732eb24be7c80fcf1b969017c0b45d88d0c93fe9b7114d1ff0691a05cada6ad31836e85f0129feab303765e2f365b70e

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change log
+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/).
+
+## Unreleased
+### Added:
+- Initial implimentation 

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Jim Gay
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# CloseEncounters
+Add serices and events that can track responses from third-party services.
+
+## Usage
+Install it like any other rails engine.
+
+```ruby
+rails close_encounters:install:migrations
+```
+
+Then when you have it installed and migrated you can start tracking events.
+
+```ruby
+response = SomeThirdPartyService.call
+CloseEncounters.contact("SomeThirdPartyService", status: response.status.to_i, response.body)
+```
+
+If the services regularly returns 200 responses, no new events will be recorded.
+When it switches to a different status, a new event will be recorded.
+
+```ruby
+CloseEncounters.status("SomeThirdPartyService") # => 200
+# evuntually you use `contact` and it records a 500 and you'll be able to get
+CloseEncounters.status("SomeThirdPartyService") # => 500
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "close_encounters"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install close_encounters
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: ["db:setup", "db:migrate", "app:environment", :test] # Modify default task

data/app/models/close_encounters/application_record.rb

@@ -0,0 +1,5 @@
+module CloseEncounters
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/close_encounters/participant_event.rb

@@ -0,0 +1,7 @@
+module CloseEncounters
+  class ParticipantEvent < ApplicationRecord
+    belongs_to :participant_service, inverse_of: :events, class_name: "CloseEncounters::ParticipantService"
+
+    scope :newest, -> { order(created_at: :desc).first }
+  end
+end

data/app/models/close_encounters/participant_service.rb

@@ -0,0 +1,13 @@
+module CloseEncounters
+  class ParticipantService < ApplicationRecord
+    has_many :events, inverse_of: :participant_service, class_name: "CloseEncounters::ParticipantEvent"
+
+    validates :name, presence: true
+
+    if columns_hash["connection_info"].type == :text
+      serialize :connection_info, coder: JSON
+    end
+
+    encrypts :connection_info
+  end
+end

data/db/migrate/20240430173723_create_close_encounters_participant_services.rb

@@ -0,0 +1,14 @@
+class CreateCloseEncountersParticipantServices < ActiveRecord::Migration[7.1]
+  def change
+    create_table :close_encounters_participant_services do |t|
+      t.string :name, null: false
+      if ActiveRecord::Base.connection.adapter_name.downcase.include?("postgresql")
+        t.jsonb :connection_info
+      else
+        t.text :connection_info
+      end
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20240430173725_create_close_encounters_participant_events.rb

@@ -0,0 +1,11 @@
+class CreateCloseEncountersParticipantEvents < ActiveRecord::Migration[7.1]
+  def change
+    create_table :close_encounters_participant_events do |t|
+      t.text :response
+      t.references :close_encounters_participant_service, null: false, foreign_key: true
+      t.integer :status, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20240508190642_add_close_ecounters_indexes.rb

@@ -0,0 +1,16 @@
+class AddCloseEcountersIndexes < ActiveRecord::Migration[7.1]
+  disable_ddl_transaction!
+
+  def change
+    options = if self.class.adapter_name.match?(/postgres/i)
+      {algorithm: :concurrently}
+    else
+      {}
+    end
+
+    add_index :close_encounters_participant_services,
+      :name,
+      unique: true,
+      **options
+  end
+end

data/lib/close_encounters/engine.rb

@@ -0,0 +1,5 @@
+module CloseEncounters
+  class Engine < ::Rails::Engine
+    isolate_namespace CloseEncounters
+  end
+end

data/lib/close_encounters/version.rb

@@ -0,0 +1,3 @@
+module CloseEncounters
+  VERSION = "0.1.0"
+end

data/lib/close_encounters.rb

@@ -0,0 +1,39 @@
+require "close_encounters/version"
+require "close_encounters/engine"
+
+module CloseEncounters
+  module_function
+
+  autoload :ParticipantService, "close_encounters/participant_service"
+  autoload :ParticipantEvent, "close_encounters/participant_event"
+
+  # Record a contact with a third party service if the status has changed
+  #
+  # @param name [String] the name of the service
+  # @param status [Integer] the HTTP status of the contact
+  # @param response [String] the response object
+  def contact(name, status:, response:)
+    service = ParticipantService.find_by!(name:)
+    unless service.events.newest.status == status
+      service.events.create!(status: status, response:)
+    end
+  end
+
+  # Get the status of the most recent contact with a third party service
+  #
+  # @param name [String] the name of the service
+  # @return [Integer] the HTTP status of the most recent contact
+  def status(name)
+    ParticipantService.find_by!(name: name).events.newest.status
+  end
+
+  # Ensure that a participant service exists
+  #
+  # @param name [String] the name of the service
+  # @param connection_info [Hash] the connection information for the service
+  def ensure_service(name, connection_info: {})
+    ParticipantService.find_or_create_by!(name: name) do |service|
+      service.connection_info = connection_info
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: close_encounters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Gay
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Keep track of responses from third party systems. Use this to monitor
+  and respond to changes in status.
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/close_encounters/application_record.rb
+- app/models/close_encounters/participant_event.rb
+- app/models/close_encounters/participant_service.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
+- lib/close_encounters.rb
+- lib/close_encounters/engine.rb
+- lib/close_encounters/version.rb
+homepage: https://github.com/SOFware/close_encounters
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SOFware/close_encounters
+  source_code_uri: https://github.com/SOFware/close_encounters
+  changelog_uri: https://github.com/SOFware/close_encounters/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Close Encounters of the Third Party
+test_files: []