usps-support 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 190a559ef8733f7d36fa14b58c1e075fb3123b28930782324ec12e1565eafc9b
-  data.tar.gz: 505c42aa502fc36830c5b2bf887e970f79986d2d41fdafd6334ce57759bfdc54
+  metadata.gz: 2b6530a24087990168baaaf9878366a5d4ff56a9f705c1410173eec2a2f42f76
+  data.tar.gz: 71f71e5c96b9f0c6622aa0e978a83bf74c0efe30a9aeec9699a69fbc4e2b026a
 SHA512:
-  metadata.gz: 9bbf355856e32a27aeb0a6a1f9b19c750725603438311cadd10b431b5cef111acc1663ba40f9983e825c47e7a7f27c14eb2010d4517b124c822488f13039f04d
-  data.tar.gz: 27be97998fbdb9bbb0c9e856a23db8de7a09e644856693e55af985ee4627e910e61ccd9ce5f499f3be2d3c34e759081f36bd09b5cb3aca1beb43ef68c9ed3084
+  metadata.gz: b401086e84d77ff3f7dcbcb9d731a9e802db3ff00d264fa3899971c3b994c2bcfdf066dd28d090beb4a2819ab4408a237d897a8db35d378e814f98ffd76a8190
+  data.tar.gz: 2526d8b93f8c9f49e20c7609c66475f9ba1f5467c63b15cb90b6874964bf731912f75713ec69091249027c06dfa9cb262835443c9eeabca6363863d7f52d81d3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-support (0.1.9)
+    usps-support (0.1.11)
       sassc-rails
       usps-imis-api (~> 0.10.4)
       usps-jwt_auth (~> 1.0.0)
@@ -9,9 +9,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (8.1.0)
-      actionview (= 8.1.0)
-      activesupport (= 8.1.0)
+    actionpack (8.0.4)
+      actionview (= 8.0.4)
+      activesupport (= 8.0.4)
       nokogiri (>= 1.8.5)
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
@@ -19,20 +19,20 @@ GEM
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
-    actionview (8.1.0)
-      activesupport (= 8.1.0)
+    actionview (8.0.4)
+      activesupport (= 8.0.4)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (8.1.0)
+    activesupport (8.0.4)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
-      json
       logger (>= 1.4.2)
       minitest (>= 5.1)
       securerandom (>= 0.3)
@@ -40,6 +40,7 @@ GEM
       uri (>= 0.13.1)
     ast (2.4.3)
     base64 (0.3.0)
+    benchmark (0.5.0)
     bigdecimal (3.3.1)
     builder (3.3.0)
     colorize (1.1.0)
@@ -52,8 +53,14 @@ GEM
     drb (2.2.3)
     erb (5.1.3)
     erubi (1.13.1)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
     ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
     fileutils (1.7.3)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
@@ -72,10 +79,22 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     minitest (5.26.0)
+    nokogiri (1.18.10-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-musl)
+      racc (~> 1.4)
     nokogiri (1.18.10-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
     nokogiri (1.18.10-x86_64-linux-gnu)
       racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-musl)
+      racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.10.0)
       ast (~> 2.4.1)
@@ -103,9 +122,9 @@ GEM
     rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (8.1.0)
-      actionpack (= 8.1.0)
-      activesupport (= 8.1.0)
+    railties (8.0.4)
+      actionpack (= 8.0.4)
+      activesupport (= 8.0.4)
       irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -199,8 +218,14 @@ GEM
     zeitwerk (2.7.3)
 
 PLATFORMS
-  arm64-darwin-24
-  x86_64-linux
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
 
 DEPENDENCIES
   irb

data/Readme.md

@@ -42,3 +42,13 @@ end
 ```ruby
 Usps::Supoprt::Models::GitHub.latest_tag('usps-support')
 ```
+
+```ruby
+module Members
+  class Member < Usps::Support::Models::Hq::Members::Member
+    has_many :somethings, inverse_of: :member
+
+    def unique_to_application = 'whatever'
+  end
+end
+```

data/lib/usps/support/helpers/badges_helper.rb

@@ -125,14 +125,17 @@ module Usps::Support::Helpers
       text&.gsub('-', '--')&.gsub('_', '__')&.gsub(' ', '_')
     end
 
+    # rubocop:disable Metrics/AbcSize
     def timestamp_color(timestamp)
       case Time.zone.at(timestamp.to_i)
       when ...14.days.ago then '63a2c7' # faded :blue
       when 14.days.ago...1.day.ago then :blue
       when 1.day.ago...1.hour.ago, 10.minutes.from_now...1.hour.from_now then :green
-      when 1.hour.ago...10.minutes.from_now then :yellowgreen
+      when 1.hour.ago...1.minute.ago, 1.minute.from_now...10.minutes.from_now then :yellowgreen
+      when 1.minute.ago...1.minute.from_now then :orange
       when 1.hour.from_now.. then :brightgreen
       end
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/usps/support/models/hq/members/associate_member.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # Associate member record
+  #
+  class AssociateMember < BaseRecord
+    self.table_name = :associates
+    self.inheritance_column = nil # The database has a `type` column, which confuses with Rails STI
+
+    belongs_to :member, foreign_key: 'certno', primary_key: 'certno', inverse_of: :associate_memberships
+    belongs_to(
+      :squadron,
+      class_name: 'Squadrons::Squadron', foreign_key: 'squadno', primary_key: 'account', inverse_of: :associate_members
+    )
+    belongs_to(
+      :district,
+      class_name: 'Squadrons::District', foreign_key: 'dist', primary_key: 'dist', inverse_of: :associate_members
+    )
+  end
+end

data/lib/usps/support/models/hq/members/base_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # Base record for the HQ VHQAB database
+  #
+  class BaseRecord < Usps::Support::Models::Hq::SharedRecord
+    self.abstract_class = true
+
+    establish_connection :members
+  end
+end

data/lib/usps/support/models/hq/members/district_job.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # District job assignment
+  #
+  class DistrictJob < BaseRecord
+    self.table_name = :djftp
+    self.primary_key = %i[certno jobcode year]
+
+    belongs_to :member, foreign_key: :certno, inverse_of: :district_jobs
+    has_one :district_job_description, foreign_key: :jobcode, primary_key: :jobcode, inverse_of: :district_jobs
+
+    def acting? = acting == 'Y'
+
+    def description
+      desc = district_job_description.jdesc
+      acting? ? "#{desc} (Acting)" : desc
+    end
+  end
+end

data/lib/usps/support/models/hq/members/district_job_description.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # District job
+  #
+  class DistrictJobDescription < BaseRecord
+    self.table_name = :djdesc
+    self.primary_key = :jobcode
+
+    has_many :district_jobs, foreign_key: :jobcode, primary_key: :jobcode, inverse_of: :district_job_description
+  end
+end

data/lib/usps/support/models/hq/members/former_member.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # Former member record
+  #
+  class FormerMember < BaseRecord
+    self.table_name = :abftp2
+    self.primary_key = :certificate
+    self.inheritance_column = nil # The database has a `type` column, which confuses with Rails STI
+
+    belongs_to(
+      :former_squadron,
+      class_name: 'Squadrons::Squadron', foreign_key: 'account', primary_key: 'account', inverse_of: :former_members,
+      optional: true
+    )
+    belongs_to(
+      :former_district,
+      class_name: 'Squadrons::District', foreign_key: 'district', primary_key: 'dist', inverse_of: :former_members,
+      optional: true
+    )
+
+    alias_attribute :member_type, :type
+
+    # Method aliases to support the expected Members::Member API
+    alias squadron former_squadron
+    alias_attribute :certno, :certificate
+    alias_attribute :first, :firstname
+    alias_attribute :last, :lastname
+
+    def simple_name = [firstname, lastname, '(Deceased)'].join(' ')
+
+    def sort_name = "#{lastname}, #{firstname}"
+
+    # rubocop:disable Naming/MethodName
+    def iMISid = nil
+    alias imis_id iMISid
+    # rubocop:enable Naming/MethodName
+  end
+end

data/lib/usps/support/models/hq/members/member.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # Regular member record
+  #
+  class Member < BaseRecord
+    self.table_name = :mbftp
+    self.primary_key = :certno
+    self.filter_attributes = %i[pin answer]
+
+    INVALID_RANKS = [0, 99].freeze
+
+    has_many :national_jobs, foreign_key: :certno, inverse_of: :member
+    has_many :district_jobs, foreign_key: :certno, inverse_of: :member
+    has_many :squadron_jobs, foreign_key: :certno, inverse_of: :member
+    belongs_to(
+      :squadron,
+      class_name: 'Squadrons::Squadron', foreign_key: 'sqdcode', primary_key: 'account', inverse_of: :members
+    )
+    belongs_to(
+      :district,
+      class_name: 'Squadrons::District', foreign_key: 'daccount', primary_key: 'account', inverse_of: :members
+    )
+    has_many(
+      :associate_memberships,
+      class_name: 'Members::AssociateMember', foreign_key: 'certno', primary_key: 'certno', inverse_of: :member
+    )
+
+    alias_attribute :certificate, :certno
+    alias_attribute :member_type, :mbrtype
+    alias_attribute :imis_id, :iMISid
+
+    def as_associate = clone.tap { it.instance_variable_set(:@associate, true) }
+    def associate? = @associate.present?
+
+    def accounts = (squadron_jobs.pluck(:account) + [account]).uniq.map(&:to_s)
+
+    def district_accounts = district.squadrons.pluck(:account)
+
+    def rank
+      return @rank if @rank
+      return unless (raw_rank = read_attribute(:rank))
+      return if raw_rank.in?(INVALID_RANKS)
+
+      normalized_rank = raw_rank.to_s.rjust(2, '0')
+      @rank = Members::Rank.find(normalized_rank).RankAbbr
+    end
+
+    def full_name
+      [
+        [rank, first, last].join(' '),
+        grade.presence
+      ].compact.join(', ')
+    end
+
+    def simple_name = [first, last].join(' ')
+
+    def sort_name = "#{last}, #{first}"
+
+    def admin? = certificate.in?(ENV['ADMIN_CERTIFICATES'].split(','))
+
+    def mailing_address
+      [
+        full_name,
+        address1,
+        address2,
+        ["#{city}, #{state} #{zip5}", zip4].compact_blank.join('-')
+      ].compact_blank
+    end
+  end
+end

data/lib/usps/support/models/hq/members/national_job.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # National job assignment
+  #
+  class NationalJob < BaseRecord
+    self.table_name = :njftp
+    self.primary_key = %i[certno jobcode year]
+
+    belongs_to :member, foreign_key: :certno, inverse_of: :national_jobs
+    has_one :national_job_description, foreign_key: :jobcode, primary_key: :jobcode, inverse_of: :national_jobs
+
+    scope :current, -> { where(year: Time.zone.now.year) }
+    scope :educational_chair, -> { current.where('jobcode REGEXP ?', '13\d{2}0') }
+    scope :educational_leadership, -> { current.where('jobcode REGEXP ?', '13\d{2}[01]') }
+    scope :educational_member, -> { current.where('jobcode REGEXP ?', '13\d{2}[012]') }
+
+    delegate :description, to: :national_job_description
+  end
+end

data/lib/usps/support/models/hq/members/national_job_description.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # National job
+  #
+  class NationalJobDescription < BaseRecord
+    self.table_name = :njdesc
+    self.primary_key = :jobcode
+    self.inheritance_column = nil # The database has a `type` column, which confuses with Rails STI
+
+    has_many :national_jobs, foreign_key: :jobcode, primary_key: :jobcode, inverse_of: :national_job_description
+
+    def description
+      return 'Budget Director' if jdesc =~ %r{/Budget Director$}
+
+      jdesc
+        .sub(/^(?:Assistant|Asst\.)?\s?(?:Chr\.|Chair\.|Chairman)? /, '')
+        .sub(/ (?:Committee|Cmte|Com\.)$/, '')
+    end
+  end
+end

data/lib/usps/support/models/hq/members/rank.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # Rank record
+  #
+  class Rank < BaseRecord
+    self.table_name = :ranks
+    self.primary_key = :RankCode
+  end
+end

data/lib/usps/support/models/hq/members/squadron_job.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # Squadron job assignment
+  #
+  class SquadronJob < BaseRecord
+    self.table_name = :sjftp
+    self.primary_key = %i[certno jobcode year]
+
+    belongs_to(
+      :squadron,
+      class_name: 'Squadrons::Squadron', foreign_key: 'account', primary_key: 'account', inverse_of: :squadron_jobs
+    )
+    belongs_to :member, foreign_key: :certno, inverse_of: :squadron_jobs
+    has_one :squadron_job_description, foreign_key: :jobcode, primary_key: :jobcode, inverse_of: :squadron_jobs
+
+    def acting? = acting == 'Y'
+
+    def description
+      desc = squadron_job_description.jdesc
+      acting? ? "#{desc} (Acting)" : desc
+    end
+  end
+end

data/lib/usps/support/models/hq/members/squadron_job_description.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Members
+  # Squadron job
+  #
+  class SquadronJobDescription < BaseRecord
+    self.table_name = :sjdesc
+    self.primary_key = :jobcode
+
+    has_many :squadron_jobs, foreign_key: :jobcode, primary_key: :jobcode, inverse_of: :squadron_job_description
+  end
+end

data/lib/usps/support/models/hq/members.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Shared Rails models on the HQ VHQAB database
+#
+module Usps::Support::Models::Hq::Members; end
+
+require_relative 'members/base_record'
+require_relative 'members/associate_member'
+require_relative 'members/district_job_description'
+require_relative 'members/district_job'
+require_relative 'members/former_member'
+require_relative 'members/member'
+require_relative 'members/national_job_description'
+require_relative 'members/national_job'
+require_relative 'members/rank'
+require_relative 'members/squadron_job_description'
+require_relative 'members/squadron_job'

data/lib/usps/support/models/hq/shared_record.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq
+  # Base record for the HQ VHQAB database
+  #
+  class SharedRecord < ::ActiveRecord::Base
+    self.abstract_class = true
+
+    after_initialize :readonly!, unless: -> { Rails.env.test? || self.class.allow_hq_database_edits? }
+
+    def self.allow_hq_database_edits? = false
+  end
+end

data/lib/usps/support/models/hq/squadrons/base_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Squadrons
+  # Base class for models in the WebSites HQ database
+  #
+  class BaseRecord < Usps::Support::Models::Hq::SharedRecord
+    self.abstract_class = true
+
+    establish_connection :websites
+  end
+end

data/lib/usps/support/models/hq/squadrons/course_report.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Squadrons
+  # HQ-800 course
+  #
+  class CourseReport < Website
+    self.table_name = :mbrclasses
+
+    belongs_to :squadron, foreign_key: 'account', primary_key: 'sqnumber', inverse_of: :course_reports
+    has_one :classroom, inverse_of: :course_report
+    has_many :students, foreign_key: %i[crsid squadno], primary_key: %i[crsid sqnumber], inverse_of: :course_report
+
+    enum :status, { closed: 'C', ordered: 'O', graded: 'G' }
+  end
+end

data/lib/usps/support/models/hq/squadrons/district.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Squadrons
+  # District organization information
+  #
+  class District < Website
+    has_many :squadrons, inverse_of: :district, foreign_key: 'daccount', primary_key: 'account'
+    has_many :former_squadrons, inverse_of: :district, foreign_key: 'daccount', primary_key: 'account'
+
+    has_many(
+      :members,
+      class_name: 'Members::Member', foreign_key: 'daccount', primary_key: 'account', inverse_of: :district
+    )
+    has_many(
+      :former_members,
+      class_name: 'Members::FormerMember', foreign_key: 'dist', primary_key: 'district', inverse_of: :former_district
+    )
+
+    # Squadrons and Districts are both stored in the same table, along with various historical entries
+    default_scope { where("Name REGEXP '^D?[0-9]{2}$'").where.not(account: nil) }
+
+    # def self.lookup(number) = where("Name REGEXP '^D?0?#{number}$'").first
+
+    def number = self.Name.sub(/^D/, '').to_i
+
+    # def name = "District #{number}"
+
+    # def all_squadrons = (squadrons + former_squadrons).sort_by(&:name)
+  end
+end

data/lib/usps/support/models/hq/squadrons/former_squadron.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Squadrons
+  # Former Squadron organization information
+  #
+  class FormerSquadron < Website
+    belongs_to :district, inverse_of: :former_squadrons, foreign_key: 'daccount', primary_key: 'account'
+
+    # Former Squadrons stored in the same table as current Squadrons
+    default_scope { where(account: nil).where('Name NOT REGEXP \'^[0-9]{2}\.$\'') }
+
+    # When a squadron becomes "former", its account is moved into the `plat` column
+    alias_attribute :account_number, :plat
+
+    def name = self.Name.sub(/\.$/, '')
+  end
+end

data/lib/usps/support/models/hq/squadrons/squadron.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Squadrons
+  # Squadron organization information
+  #
+  class Squadron < Website
+    belongs_to :district, inverse_of: :squadrons, foreign_key: 'daccount', primary_key: 'account'
+    has_many(
+      :members,
+      class_name: 'Members::Member', foreign_key: 'account', primary_key: 'account', inverse_of: :squadron
+    )
+    has_many(
+      :former_members,
+      class_name: 'Members::FormerMember', foreign_key: 'account', primary_key: 'account', inverse_of: :former_squadron
+    )
+    has_many(
+      :squadron_jobs,
+      class_name: 'Members::SquadronJob', foreign_key: 'account', primary_key: 'account', inverse_of: :squadron
+    )
+    has_many :classrooms, foreign_key: 'account', primary_key: 'account', inverse_of: :squadron
+    has_many :course_reports, foreign_key: 'account', primary_key: 'sqnumber', inverse_of: :squadron
+
+    default_scope { where.not("Name REGEXP '^D?[0-9]{2}$'").where.not(account: nil) }
+
+    def name = self.Name.split(/ Sail (&|and)/)[0]
+  end
+end

data/lib/usps/support/models/hq/squadrons/student.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Squadrons
+  # HQ-800 student
+  #
+  class Student < Website
+    self.table_name = :students
+    self.ignored_columns += %i[validate]
+
+    belongs_to :course_report, foreign_key: %i[crsid squadno], primary_key: %i[crsid sqnumber], inverse_of: :students
+
+    alias_attribute :certificate, :certno
+
+    # Tweak data format to match expected
+    def grade=(int_or_string)
+      write_attribute(:grade, int_or_string.to_s.rjust(3, '0'))
+    end
+  end
+end

data/lib/usps/support/models/hq/squadrons/website.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models::Hq::Squadrons
+  # Base class for records in the websites (i.e. organizations) table
+  #
+  class Website < BaseRecord
+    self.abstract_class = true
+    self.table_name = :websites
+    self.primary_key = :id
+    self.inheritance_column = nil # The database has a `type` column, which confuses with Rails STI
+
+    # This is a default behavior, that is overwritten by FormerSquadron
+    alias_attribute :account_number, :account
+  end
+end

data/lib/usps/support/models/hq/squadrons.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Shared Rails models on the HQ WebSites database
+#
+module Usps::Support::Models::Hq::Squadrons; end
+
+require_relative 'squadrons/base_record'
+require_relative 'squadrons/website'
+require_relative 'squadrons/course_report'
+require_relative 'squadrons/district'
+require_relative 'squadrons/former_squadron'
+require_relative 'squadrons/squadron'
+require_relative 'squadrons/student'

data/lib/usps/support/models/hq.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models
+  # HQ database models
+  #
+  # Note: This module must be loaded *after* ActiveRecord in the parent application
+  #
+  module Hq; end
+end
+
+require_relative 'hq/shared_record'
+require_relative 'hq/members'
+require_relative 'hq/squadrons'

data/lib/usps/support/models/toast.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Usps::Support::Models
+  # Toast constructor
+  #
+  class Toast
+    attr_accessor :type, :title, :body, :timeout, :id
+
+    def self.success(**)
+      new(type: :SUCCESS, **)
+    end
+
+    def self.notice(**)
+      new(type: :NOTICE, **)
+    end
+
+    def self.error(**)
+      new(type: :ERROR, **)
+    end
+
+    def initialize(options)
+      @type = options[:type] || :NOTICE
+      @title = options[:title]
+      @body = options[:body]
+      @timeout = options[:timeout] || 4_000
+      @id = options[:id]
+    end
+
+    def broadcast!
+      BroadcastToastChannel.broadcast!(title, body, timeout:, type:, id:)
+    end
+
+    def dismiss!
+      BroadcastToastChannel.dismiss!(id)
+    end
+
+    def to_s
+      attributes = to_h.map { |key, value| "@#{key}=#{value.inspect}" }.join(' ')
+
+      "#<Toast:#{object_id} #{attributes}>"
+    end
+    alias inspect to_s
+
+    def to_h
+      {
+        type: type || :NOTICE,
+        title:,
+        body:,
+        timeout:,
+        id:
+      }
+    end
+
+    def to_json(*_)
+      validate!
+
+      JSON.dump(to_h)
+    end
+
+    # Reserved standard Toast configurations
+    #
+    module Reserved
+      IDS = {
+        restarting: 10_001
+      }.freeze
+
+      def self.restarting
+        Toast.notice(
+          title: 'SERVER WILL RESTART SOON',
+          body: "Please do not attempt to make any changes for a moment.\n" \
+                "We'll let you know when the server's back up.",
+          timeout: 0,
+          id: IDS[:restarting]
+        )
+      end
+
+      def self.restarted
+        Toast.notice(
+          title: 'Server Restarted',
+          body: 'The server has completed its restart. You can resume working.'
+        )
+      end
+    end
+
+  private
+
+    def validate!
+      raise 'Invalid type' unless type.in?(%i[SUCCESS NOTICE ERROR])
+      raise 'No title set' if title.blank?
+      raise 'No body set' if body.blank?
+    end
+  end
+end

data/lib/usps/support/models.rb

@@ -6,3 +6,4 @@ module Usps::Support::Models; end
 
 require_relative 'models/git_hub'
 require_relative 'models/dynamo_db'
+require_relative 'models/toast'

data/lib/usps/support/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Support
-    VERSION = '0.1.9'
+    VERSION = '0.1.11'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-support
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Julian Fiander
@@ -75,6 +75,29 @@ files:
 - lib/usps/support/models/.rubocop.yml
 - lib/usps/support/models/dynamo_db.rb
 - lib/usps/support/models/git_hub.rb
+- lib/usps/support/models/hq.rb
+- lib/usps/support/models/hq/members.rb
+- lib/usps/support/models/hq/members/associate_member.rb
+- lib/usps/support/models/hq/members/base_record.rb
+- lib/usps/support/models/hq/members/district_job.rb
+- lib/usps/support/models/hq/members/district_job_description.rb
+- lib/usps/support/models/hq/members/former_member.rb
+- lib/usps/support/models/hq/members/member.rb
+- lib/usps/support/models/hq/members/national_job.rb
+- lib/usps/support/models/hq/members/national_job_description.rb
+- lib/usps/support/models/hq/members/rank.rb
+- lib/usps/support/models/hq/members/squadron_job.rb
+- lib/usps/support/models/hq/members/squadron_job_description.rb
+- lib/usps/support/models/hq/shared_record.rb
+- lib/usps/support/models/hq/squadrons.rb
+- lib/usps/support/models/hq/squadrons/base_record.rb
+- lib/usps/support/models/hq/squadrons/course_report.rb
+- lib/usps/support/models/hq/squadrons/district.rb
+- lib/usps/support/models/hq/squadrons/former_squadron.rb
+- lib/usps/support/models/hq/squadrons/squadron.rb
+- lib/usps/support/models/hq/squadrons/student.rb
+- lib/usps/support/models/hq/squadrons/website.rb
+- lib/usps/support/models/toast.rb
 - lib/usps/support/version.rb
 - sig/usps/support.rbs
 homepage: https://github.com/unitedstatespowersquadrons/usps-rails