web47core 3.2.5 → 3.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97511542e4fd2facae8f07554574360af309703a4c4e60236087f0ce8c9d1647
-  data.tar.gz: 1fe0abc1e0e93fb4a33672f53ee244777616c4f8e4c146204d4c5d273cab8490
+  metadata.gz: 8a2f6513fc3ea7307fc8b715807aaeef3ac0c63151bec753ecde3e5233742da5
+  data.tar.gz: 2d27d9d04e23dfd8e71ae2f6fb6080567cbab65f1af0f98ce09c5a34f0e90dfd
 SHA512:
-  metadata.gz: fee9f5c0965942cb3e292b71ca556156bbacfe5e87a0c59aeb4b289a2301523ae112401fbe15619928c3551f89ad8a8f21ada2fb5584d8c51a94b14e4b0221bf
-  data.tar.gz: 76ce06f3fb886cee25351187b02fb6fbf83c45f40ce902257b0786b79c82879f48b74311a7ab6f7bf569dbb51b53cf1fd3aa780471e73c9be5bba2fac675fc15
+  metadata.gz: 42801f50f150d8d47db4833cd7c5aff6a7f4743cd6a60797000c331f1815cc57ce6f844933dc7424343962f3363c3b0d9af0a2ac257dd0ff2c6bd1c9ca0a232c
+  data.tar.gz: 8fca8b55c877d788266c5628b59d820b0e147393fd138db16e8bca762dd2a396801fd0701b7a32e0cc56b4fa5c6ae97e45597701f1714787f1892987608378bd

data/lib/app/models/command_job.rb

@@ -27,26 +27,44 @@ class CommandJob
   field :error_message, type: String
   field :started_at, type: Time
   field :finished_at, type: Time
+  field :cancelled_at, type: Time
   #
   # Relationships
   #
   has_many :logs, class_name: 'CommandJobLog', dependent: :destroy
-  belongs_to :started_by, class_name: 'User', optional: true
+  belongs_to :started_by, polymorphic: true, optional: true, inverse_of: nil
+  belongs_to :cancelled_by, polymorphic: true, optional: true, inverse_of: nil
   #
   # Validations
   #
   validates :state, inclusion: { in: ALL_STATES }
 
-  #
-  # Who started this job
-  #
+  # @abstract cancel the current job
+  def cancel!(actor)
+    update! cancelled_by: actor, cancelled_at: Time.now.utc, state: STATE_CANCELLED
+    child_jobs.map { |j| j.cancel!(actor) }
+  end
+
+  def child_jobs
+    []
+  end
+
+  # @abstract duration for the job
+  # @return Integer - How long this job took in milliseconds
+  def duration
+    succeeded? ? finished_at - started_at : 0
+  rescue StandardError
+    0
+  end
+
+  # @abstract Who started this job
+  # @return String - Who started this job if present, otherwise `System`
   def display_started_by
     started_by.present? ? started_by.name : 'System'
   end
 
-  #
-  # Default time to keep a job before auto archiving it
-  #
+  # @abstract Default time to keep a job before auto archiving it
+  # @return Integer - TTL for this job
   def ttl
     30
   end

data/lib/app/models/concerns/archive_able.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+#
+# A module that allows for trash/recycling of an object
+# it will be deleted in the app, but remain in the database until permanently deleted
+#
+module ArchiveAble
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      # Fields
+      field :archived, type: Mongoid::Boolean, default: false
+      field :archived_at, type: Time
+      field :archived_by_name, type: String
+      field :archived_by_email, type: String
+      field :restored_at, type: Time
+      field :restored_by_name, type: String
+      field :restored_by_email, type: String
+      # Relationships
+      belongs_to :archived_by, polymorphic: true, optional: true, inverse_of: nil
+      belongs_to :restored_by, polymorphic: true, optional: true, inverse_of: nil
+    end
+  end
+
+  # @abstract Display who archived this object
+  # @return String
+  def display_archived_by
+    if archived_by.present?
+      archived_by.display_name
+    elsif archived_by_email.present?
+      "#{archived_by_name} (#{archived_by_email})"
+    else
+      archived_by_name
+    end
+  end
+
+  # @abstract Display who restored this object
+  # @return String
+  def display_restored_by
+    if restored_by.present?
+      restored_by.display_name
+    elsif restored_by_email.present?
+      "#{restored_by_name} (#{restored_by_email})"
+    else
+      restored_by_name
+    end
+  end
+
+  def unarchived?
+    !archived?
+  end
+
+  # @abstract Archive the object
+  # @param [Member|User] actor - the thing performing the action
+  def archive(actor)
+    params = if actor.is_a? Cron::Job
+               { archived: true,
+                 archived_at: Time.now.utc,
+                 archived_by_name: "System - #{actor.class.name}" }
+             else
+               { archived: true,
+                 archived_by: actor,
+                 archived_at: Time.now.utc,
+                 archived_by_name: actor.name,
+                 archived_by_email: actor.email }
+             end
+    params[:name] = "#{name}-(archived at #{Time.now.utc})" if respond_to?(:name=)
+    update params
+  end
+
+  # @abstract recycle the object
+  # @param [Member|User] actor - the actor performing the action
+  def restore(actor)
+    params = { archived: false,
+               restored_by: actor,
+               restored_at: Time.now.utc,
+               restored_by_name: actor.name,
+               restored_by_email: actor.email }
+    params[:name] = name.split('-(archived at').first if respond_to?(:name=)
+    update params
+  end
+
+  def days_to_deletion
+    archived? ? ((archived_at + retention_days.days - Time.now.utc) / 86_400).to_i :  0
+  rescue StandardError
+    archived? ? retention_days : 0
+  end
+
+  def retention_days
+    30
+  end
+end

data/lib/web47core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Web47core
-  VERSION = '3.2.5'
+  VERSION = '3.2.7'
 end

data/lib/web47core.rb

@@ -1,6 +1,7 @@
 require 'web47core/config'
 require 'app/models/concerns/app47_logger'
 require 'app/models/concerns/api_tokenable'
+require 'app/models/concerns/archive_able'
 require 'app/models/concerns/aws_configuration'
 require 'app/models/concerns/core_system_configuration'
 require 'app/models/concerns/core_account'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web47core
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.7
 platform: ruby
 authors:
 - Chris Schroeder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -501,7 +501,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-lcov
+  name: simplecov_lcov_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -645,6 +645,7 @@ files:
 - lib/app/models/command_job_log.rb
 - lib/app/models/concerns/api_tokenable.rb
 - lib/app/models/concerns/app47_logger.rb
+- lib/app/models/concerns/archive_able.rb
 - lib/app/models/concerns/aws_configuration.rb
 - lib/app/models/concerns/cdn_url.rb
 - lib/app/models/concerns/cipher_able.rb
@@ -712,7 +713,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.13
 signing_key:
 specification_version: 4
 summary: App47 Web Core Library.