web47core 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 030670e1f995d60e8bf25b1fb67c9bd91a628e859225114fcfe6203f3c77e818
-  data.tar.gz: 7db5d7cbaa718e3a296b209bf4c5e3b943441958c0019601ec031972803f6a09
+  metadata.gz: c53f1926c9087f4e9cc6f6037b29401e8b5ec7a7b29bb827228a5865b486db87
+  data.tar.gz: de8d77e1e2fb118dd40ae5f263ed08b711e370a3ce64f6ebf27d6c5898758162
 SHA512:
-  metadata.gz: d9dedd01621102e871fd5f6f19b99f46ff331788d1feba24095daf10f023c058ed61a1b7cd654e8d965c478954e41e3e53ee2c39e33efc3f46f3f4d36233e038
-  data.tar.gz: 1e77420c64920f5ffde02efa94def8a5d57d3832ebbff25177b80d9253949fbd26049b6e95fc952e7b5da415d9ab33d835e8e29f8032492dc888696134c806fc
+  metadata.gz: f84fb47a7f6a366b40a4e6d1e3155268caa889ed606b2f5e5d0d629b9992ddc16d2c49814292b36bc448a36788c6480a7a9acf6f476eaef770c2fec66e89cd56
+  data.tar.gz: 8682ac4e3c691e4bec4c2f2ec8313a4dd8c034c5d926cc76f7ea735c0e56d7eff838b40b68e38405be9d4d5bfc1f16fd1dfee65395d7a4fe17b432a644881d03

data/README.md

@@ -232,3 +232,7 @@ end
 #### ~/bin Directory
 
 Remove the delayed_job, delayed_job.sh and cron_server.sh files
+
+#### Notification Templates
+
+Move any notification templates from `~/app/assets/templates` to `~/lib/templates`

data/app/views/stack/delayed_jobs/index.html.haml

@@ -0,0 +1 @@
+=render '/delayed_jobs/index'

data/app/views/stack/delayed_jobs/show.html.haml

@@ -0,0 +1 @@
+=render '/delayed_jobs/show'

data/app/views/stack/system_configurations/edit.html.haml

@@ -1,5 +1 @@
-- title t('.title', name: SystemConfiguration.environment.titleize)
-.container
-  %form{action: stack_system_configuration_path, method: :post}
-    = render '/system_configurations/form', system_configuration: @system_configuration
-    = render '/common/form_actions', form_cancel_path: admin_system_configuration_path
+= render '/system_configurations/edit'

data/app/views/stack/system_configurations/show.html.haml

@@ -1,3 +1 @@
-- title t('.title', name: SystemConfiguration.environment.titleize)
-= edit_class_link_tag(SystemConfiguration, edit_stack_system_configuration_path)
-= render '/system_configurations/table'
+= render '/system_configurations/show'

data/lib/app/jobs/application_job.rb

@@ -4,7 +4,26 @@
 # Base application job that all jobs extend from
 #
 class ApplicationJob < ActiveJob::Base
+  include ActionView::Helpers::NumberHelper
+  include ActionView::Helpers::TextHelper
   include App47Logger
+  attr_accessor :payload, :started_at
+
+  #
+  # Standard approach to running jobs
+  #
+  def perform(payload = {})
+    Rails.cache.reconnect
+    @started_at = Time.now.utc
+    @payload = payload
+    parse_payload
+    execute
+  rescue StandardError => error
+    log_error "Failed to execute job: #{self.inspect}", error
+    raise error
+  ensure
+    GC.start
+  end
 
   #
   # If this job should run in this current environment, defaults to true
@@ -20,4 +39,97 @@ class ApplicationJob < ActiveJob::Base
     my_environments = valid_environments
     (my_environments.empty? || my_environments.include?(Rails.env))
   end
+
+  #
+  # Internal: Parse the payload
+  #
+  # payload - The payload from the class attribute
+  #
+  # Examples
+  #
+  #   parse_payload
+  #
+  # Assigns the class attributes from the payload
+  #
+  def parse_payload
+    attributes = payload.is_a?(Hash) ? payload : JSON.parse(payload)
+    # Set the values contained in the payload
+    attributes.each_pair do |key, value|
+      method = "#{key}=".to_sym
+      send(method, value) if respond_to?(method)
+    end
+  end
+
+  #
+  # Public: Determine the duration of the process, only reporting on the values that are
+  #         greater than zero.
+  #
+  # Examples
+  #
+  #   duration
+  #   # => '1 day 1 hour 32 minutes 10 seconds'
+  #   # => '1 hour 32 minutes 10 seconds'
+  #   # => '32 minutes 10 seconds'
+  #   # => '10 seconds'
+  #
+  # Returns the duration up until this point in time.
+  #
+  def duration
+    start_time = started_at.is_a?(String) ? Time.parse(started_at) : started_at
+    minutes, seconds = split_duration(Time.zone.now - start_time)
+    hours, minutes = split_duration minutes
+    days, hours = split_duration hours, 24
+    report_duration(days, hours, minutes, seconds)
+  end
+
+  private
+
+  #
+  # Internal: Take the current value and split using the split value, return the dividend and modulus
+  #
+  # value - The value to split
+  # split - The split value to use
+  #
+  # Examples
+  #
+  #   split_duration( 120 )
+  #   # => [2, 0]
+  #   split_duration( 125 )
+  #   # => [2, 5]
+  #   split_duration( 125 )
+  #   # => [2, 5]
+  #   split_duration( 48, 24 )
+  #   # => [2, 0]
+  #
+  # Returns an arround with the first value as the dividend and the second as the modulus
+  #
+  def split_duration(value, split = 60)
+    [(value / split).to_i, (value % split).to_i]
+  end
+
+  #
+  # Internal: Put together the descriptive text of the duration.
+  #
+  # days - The number of days
+  # hours - The number of hours
+  # minutes - The number of minutes
+  # seconds - The number of seconds
+  #
+  # Examples
+  #
+  #   report_duration(0, 0, 10, 1)
+  #   # => "10 minutes 1 second"
+  #   report_duration(1, 0, 10, 1)
+  #   # => "1 day 0 hours 10 minutes 1 second"
+  #
+  # Returns the duplicated String.
+  #
+  def report_duration(days, hours, minutes, seconds)
+    dur = []
+    dur << pluralize(days, 'day') if days.positive?
+    dur << pluralize(hours, 'hour') if hours.positive? || days.positive?
+    dur << pluralize(minutes, 'minute') if minutes.positive? || hours.positive? || days.positive?
+    dur << pluralize(seconds, 'second')
+    dur.join(' ')
+  end
 end

data/lib/app/jobs/cron/switchboard_sync_configuration.rb

@@ -18,8 +18,7 @@ module Cron
     #
     # Cycle through all configuration keys
     #
-    def perform
-      Rails.cache.reconnect
+    def execute
       RestClient.get(switchboard_url,
                      ACCESS_TOKEN: SystemConfiguration.switchboard_stack_api_token,
                      content_type: 'application/json') do |response, _request, _result, &block|

data/lib/app/jobs/cron/switchboard_sync_models.rb

@@ -18,7 +18,7 @@ module Cron
     #
     # Cycle through the collection and perform an upsert on it
     #
-    def perform
+    def execute
       Web47core::Config.switchboard_able_models.each { |model| model.each(&:switchboard_upsert) }
     end
   end

data/lib/app/jobs/cron/trim_collection.rb

@@ -9,8 +9,7 @@ module Cron
     #
     # Fetch each item and delete it if hasn't been updated in 30 days
     #
-    def perform
-      # Rails.cache.reconnect
+    def execute
       count = 0
       total = collection.count
       while count <= total

data/lib/app/jobs/cron/trim_notifications.rb

@@ -20,5 +20,25 @@ module Cron
     def collection
       Notification.all
     end
+
+    #
+    # Test if this should be archived
+    #
+    def archive?(item)
+      time = if item.is_a?(EmailNotification) && template?(item)
+               5.years.ago.utc
+             else
+               allowed_time
+             end
+      item.updated_at < time
+    end
+
+    #
+    # Determine if the notification has a template associated with it
+    #
+    def template?(item)
+      item.notification_template.present? ||
+        item[:notification_template_id].present? && Template.where(_id: item[:notification_template_id]).present?
+    end
   end
 end

data/lib/app/models/audit_log.rb

@@ -20,7 +20,7 @@ class AuditLog
   #
   # Validations
   #
-  validates :action, inclusion: { in: ALL_ACTIONS }
+  # validates :action, inclusion: { in: ALL_ACTIONS }
 
   def self.sort_order
     [:created_at, -1]

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

@@ -39,4 +39,18 @@ module CoreAccount
   def fetch_smtp_configuration
     smtp_configuration || build_smtp_configuration
   end
+
+  #
+  # return the email notifications templates, these are custom notifications sent by an admin.
+  #
+  def email_notification_templates
+    templates.where(_type: 'EmailNotificationTemplate')
+  end
+
+  #
+  # return the email templates, these are email templates for actions in the system
+  #
+  def email_templates
+    templates.where(_type: 'EmailTemplate')
+  end
 end

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

@@ -147,7 +147,7 @@ module CoreSystemConfiguration
   #
   # Determine if mailgun is configured
   #
-  def mailgun_configured?
+  def mail_gun_configured?
     smtp_configured? && mailgun_api_key.present?
   end
 

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

@@ -62,7 +62,7 @@ module EmailAble
   # Reset the bounced email
   #
   def reset_bounce_status
-    return unless SystemConfiguration.mailgun_configured? && email_bounced?
+    return unless SystemConfiguration.mail_gun_configured? && email_bounced?
 
     reset_url = "https://api.mailgun.net/v3/#{SystemConfiguration.smtp_domain}/bounces/#{CGI.escape(email)}"
     RestClient.delete(reset_url, user: 'api', password: SystemConfiguration.mailgun_api_key)

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

@@ -15,16 +15,16 @@ module StandardModel
       #
       # Fields
       #
-      field :last_modified_by_email
-      field :last_modified_by_name
-      field :created_by_email
-      field :created_by_name
+      field :last_modified_by_email, type: String
+      field :last_modified_by_name, type: String
+      field :created_by_email, type: String
+      field :created_by_name, type: String
       #
       # Relationships
       #
-      belongs_to :last_modified_by, class_name: 'User', optional: true
-      belongs_to :created_by, class_name: 'User', optional: true
-      has_many Web47core::Config.user_audit_model_log_symbol, dependent: :nullify
+      belongs_to :last_modified_by, class_name: Web47core::Config.audit_model_class_name, optional: true
+      belongs_to :created_by, class_name: Web47core::Config.audit_model_class_name, optional: true
+      has_many Web47core::Config.audit_model_log_symbol, dependent: :nullify
       #
       # Callbacks
       #
@@ -42,9 +42,9 @@ module StandardModel
     # Used by calling 'model.without_callback(*.args, &block) do'
     def without_callback(*args, &_block)
       skip_callback(*args)
-      result = yield
+      yield
+    ensure
       set_callback(*args)
-      result
     end
 
     #
@@ -60,10 +60,7 @@ module StandardModel
     def allowed_param_names(filter_names = [])
       # Always filter out the mongoid reserved items
       filter_names += %w[created_at updated_at _type _id]
-      associations = all_associations
-      # filter out the relationship names so we don't have dups
-      associations.each { |association| filter_names << association.keys.first }
-      (field_names + associations).delete_if { |name| filter_names.include?(name) }
+      field_names(filter_names)
     rescue StandardError
       attribute_names.delete_if { |name| filter_names.include?(name) }
     end
@@ -72,38 +69,19 @@ module StandardModel
     # allow the model to filter out a name if they want to, meaning the model
     # can return a subset of attribute names
     #
-    def field_names
-      attribute_names
-    end
-
-    #
-    # gather up the collections we care about and return them. For now, the
-    # many to many associations are the ones that need some extra help.
-    #
-    def all_associations
-      many_to_many_associations
-    end
-
-    #
-    # Return a collection of many to many assocations. We basically
-    # need to turn the current value returned by attribute names
-    #
-    # relationship_ids
-    #
-    # to
-    #
-    # { relationship_ids => [] }
-    #
-    # Telling the permit command to accept the value as an array of items.
-    #
-    def many_to_many_associations
-      associations = []
-      reflect_on_all_associations.each do |association|
-        next unless association.macro == :has_and_belongs_to_many
-
-        associations << { association.key => [] }
-      end
-      associations
+    def field_names(filter_names)
+      fields.collect do |field|
+        next if filter_names.include?(field[0])
+
+        case field[1].options[:type].to_s
+        when 'Hash'
+          { field[0] => {} }
+        when 'Array'
+          { field[0] => [] }
+        else
+          field[0]
+        end
+      end.compact
     end
 
     #
@@ -142,10 +120,10 @@ module StandardModel
     # Log the audit record
     #
     def log_change(user, model, changes)
-      Web47core::Config.user_audit_model_log_class.create!(Web47core::Config.user_audit_model => user,
-                                                           model: model,
-                                                           action: model.audit_action,
-                                                           changed_values: App47Logger.clean_params(changes).to_json)
+      Web47core::Config.audit_model_log_class.create!(Web47core::Config.audit_model => user,
+                                                      model: model,
+                                                      action: model.audit_action,
+                                                      changed_values: App47Logger.clean_params(changes).to_json)
     end
   end
 
@@ -196,10 +174,10 @@ module StandardModel
   # record a change for the object instance
   #
   def log_change(user, changes, action)
-    Web47core::Config.user_audit_model_log_class.create!(Web47core::Config.user_audit_model => user,
-                                                         model: self,
-                                                         action: action,
-                                                         changed_values: App47Logger.clean_params(changes).to_json)
+    Web47core::Config.audit_model_log_class.create!(Web47core::Config.audit_model => user,
+                                                    model: self,
+                                                    action: action,
+                                                    changed_values: App47Logger.clean_params(changes).to_json)
   end
 
   def audit_action
@@ -300,10 +278,10 @@ module StandardModel
   # Log the deletion, capturing the current values of the record before it is removed from the system
   #
   def log_deletion(user, model)
-    Web47core::Config.user_audit_model_log_class.create!(Web47core::Config.user_audit_model => user,
-                                                         model: model,
-                                                         action: AuditLog::DELETE_ACTION,
-                                                         changed_values: App47Logger.clean_params(attributes).to_json)
+    Web47core::Config.audit_model_log_class.create!(Web47core::Config.audit_model => user,
+                                                    model: model,
+                                                    action: AuditLog::DELETE_ACTION,
+                                                    changed_values: App47Logger.clean_params(attributes).to_json)
   end
 
   def capture_user_info

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

@@ -9,8 +9,7 @@ module SwitchboardAble
   def self.included(base)
     base.class_eval do
       field :switchboard_id, type: String
-      after_create :switchboard_upsert
-      # after_update :switchboard_upsert
+      after_save :switchboard_upsert
       before_destroy :switchboard_delete
     end
   end
@@ -55,13 +54,12 @@ module SwitchboardAble
   def switchboard_delete
     return unless SystemConfiguration.switchboard_configured? && switchboard_id.present?
 
-    RestClient.delete(switchboard_url, ACCESS_TOKEN: sw_api_token) do |response, _request, _result, &block|
+    RestClient.delete(switchboard_url, ACCESS_TOKEN: sw_api_token) do |response, _request, _result|
       case response.code
       when 200
         App47Logger.log_debug "Switchboard deleted #{inspect}"
       else
         App47Logger.log_error "Unable to delete the switchboard object #{inspect}, #{response.inspect}"
-        response.return!(&block)
       end
     end
   end

data/lib/app/models/email_notification.rb

@@ -231,23 +231,17 @@ class EmailNotification < Notification
   end
 
   def subject_from_template(template_name, locals)
-    subject = account_subject_template(template_name) ||
-              default_subject_template(template_name) ||
-              template_from_file(template_name, prefix: 'subject')
-    return subject_from_liquid_text(subject, locals) if subject.present?
-
-    subject = template_from_file(template_name, format: 'haml', prefix: 'subject')
-    subject_from_haml_text(subject, locals) if subject.present?
+    subject = account_subject_template(template_name) || Template.from_file(template_name, prefix: 'subject')
+    if subject.present?
+      subject_from_liquid_text(subject, locals)
+    else
+      subject = Template.from_file(template_name, format: 'haml', prefix: 'subject')
+      subject.present? ? subject_from_haml_text(subject, locals) : nil
+    end
   end
 
   def account_subject_template(template_name)
-    account.templates.emails.find_by(name: template_name.to_s).subject
-  rescue StandardError
-    nil
-  end
-
-  def default_subject_template(template_name)
-    EmailTemplate.where(account: nil, name: template_name.to_s).template
+    account.email_templates.find_by(name: template_name.to_s).subject
   rescue StandardError
     nil
   end

data/lib/app/models/email_template.rb

@@ -7,7 +7,37 @@ class EmailTemplate < Template
   #
   field :subject, type: String
   #
+  # Callbacks
+  #
+  before_save :htmlize_template
+  #
   # Validations
   #
   validates :subject, presence: true
+
+  #
+  # Make sure the template is wrapped in html
+  def htmlize_template
+    if template.present? && !template.strip.start_with?("<")
+      self.template = "<body><pre>#{template}</pre></body>"
+    end
+  end
+
+  def valid_liquid_template
+    super && Liquid::Template.parse(self.subject).nil?
+  rescue Exception => error
+    self.errors.add(:subject, "Invalid liquid text in subject: #{error.message}")
+    false
+  end
+
+  #
+  # Copy the default from disk
+  #
+  def self.copy_default(name)
+    template = EmailTemplate.new
+    template.name = name
+    template.template = from_file name
+    template.subject = from_file name, prefix: 'subject'
+    template
+  end
 end

data/lib/app/models/notification.rb

@@ -158,7 +158,7 @@ class Notification
   # If the account does exists or the template in the account does exist, we catch the error and return nil
   #
   def account_message_template(template_name)
-    account.templates.find_by(name: template_name.to_s, _type: "Account#{delivery_channel.humanize}Template").template
+    account.templates.find_by(name: template_name.to_s, _type: "#{delivery_channel.humanize}Template").template
   rescue StandardError
     nil
   end
@@ -172,20 +172,6 @@ class Notification
     nil
   end
 
-  #
-  # Retrieve the template out of the project
-  #
-  def template_from_file(template_name, format: 'liquid', prefix: nil)
-    file_name = [template_name, prefix, format].compact.join('.')
-    if File.exist?(Rails.root.join('lib', 'templates', delivery_channel, file_name))
-      File.open(Rails.root.join('lib', 'templates', delivery_channel, file_name))
-    else
-      File.read(File.join(__dir__, '../../lib', 'templates', delivery_channel, file_name))
-    end.read
-  rescue StandardError
-    nil
-  end
-
   #
   # Default delivery channel is email, override for sms, SMTP or other channels
   #
@@ -194,17 +180,20 @@ class Notification
   end
 
   def message_from_template(template_name, locals)
-    template = account_message_template(template_name) || template_from_file(template_name)
-    return message_from_liquid_text(template, locals) if template.present?
-
-    template = template_from_file(template_name, format: 'haml')
-    message_from_haml_text(template, locals) if template.present?
+    template = account_message_template(template_name) ||
+      Template.from_file(template_name, delivery_channel: delivery_channel)
+    if template.present?
+      message_from_liquid_text(template, locals)
+    else
+      template = Template.from_file(template_name, format: 'haml', delivery_channel: delivery_channel)
+      template.present? ? message_from_haml_text(template, locals) : nil
+    end
   end
 
   def message_from_haml_text(haml_text, locals)
     locals[:base_url] = SystemConfiguration.base_url
     engine = Haml::Engine.new(haml_text)
-    self.message = engine.render(Object.new, stringify_all(locals))
+    self.message = engine.render(Object.new, locals)
   end
 
   def message_from_haml_file(file_name, locals)

data/lib/app/models/template.rb

@@ -18,4 +18,31 @@ class Template
   validates :name, uniqueness: { scope: :account_id }
   validates :name, presence: true
   validates :template, presence: true
+  validate :valid_liquid_template
+
+  private
+
+  #
+  # Ensure that the template is correct from a liquid statement
+  #
+  def valid_liquid_template
+    Liquid::Template.parse(self.template).nil?
+  rescue Exception => error
+    self.errors.add(:template, "Invalid liquid text in template: #{error.message}")
+    false
+  end
+
+  #
+  # Retrieve the template out of the project
+  #
+  def self.from_file(template_name, format: 'liquid', prefix: nil, delivery_channel: 'email')
+    file_name = [template_name, prefix, format].compact.join('.')
+    if File.exist?(Rails.root.join('lib/templates', delivery_channel, file_name))
+      File.open(Rails.root.join('lib/templates', delivery_channel, file_name))
+    else
+      File.read(File.join(__dir__, '../../lib/templates', delivery_channel, file_name))
+    end.read
+  rescue StandardError
+    nil
+  end
 end

data/lib/web47core/config.rb

@@ -6,30 +6,34 @@ module Web47core
   #
   class Config
     include Singleton
-    attr_accessor :email_able_models, :switchboard_able_models, :user_audit_model
+    attr_accessor :email_able_models, :switchboard_able_models, :audit_model
 
     def initialize
       @email_able_models = []
       @switchboard_able_models = []
-      @user_audit_model = :user
+      @audit_model = :user
     end
 
     def self.reset
       instance.email_able_models = []
       instance.switchboard_able_models = []
-      instance.user_audit_model = :user
+      instance.audit_model = :user
     end
 
-    def self.user_audit_model_log_class
-      user_audit_model_log_class_name.constantize
+    def self.audit_model_log_class
+      audit_model_log_class_name.constantize
     end
 
-    def self.user_audit_model_log_class_name
-      user_audit_model_log_symbol.camelize
+    def self.audit_model_log_class_name
+      audit_model_log_symbol.camelize
     end
 
-    def self.user_audit_model_log_symbol
-      "#{instance.user_audit_model}_model_audit_log"
+    def self.audit_model_log_symbol
+      "#{instance.audit_model}_model_audit_log"
+    end
+
+    def self.audit_model_class_name
+      instance.audit_model.to_s.camelize
     end
 
     #

data/lib/web47core/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web47core
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Chris Schroeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -583,6 +583,8 @@ files:
 - app/views/delayed_jobs/show.html.haml
 - app/views/stack/cron/edit.html.haml
 - app/views/stack/cron/index.html.haml
+- app/views/stack/delayed_jobs/index.html.haml
+- app/views/stack/delayed_jobs/show.html.haml
 - app/views/stack/system_configurations/edit.html.haml
 - app/views/stack/system_configurations/show.html.haml
 - app/views/status/index.html.haml