web47core 2.0.0 → 3.0.0

data/lib/app/models/command_job_log.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+#
+# Capture command log messages for a given job
+#
+class CommandJobLog
+  include StandardModel
+  #
+  # Fields
+  #
+  field :message, type: String
+  field :command, type: String
+  field :dir, type: String
+  #
+  # Relationships
+  #
+  belongs_to :job, inverse_of: :logs, class_name: 'CommandJob'
+  #
+  # Validations
+  #
+  validates :message, presence: true
+
+  #
+  # Display message
+  #
+  def display_message
+    if dir.present?
+      "Dir: #{dir}\nCommand: #{command}\nOutput: #{message}"
+    else
+      message
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+#
+# API tokenable, support for the api token in user, but also may be applied elsewhere
+#
+module ApiTokenable
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      # store api token
+      field :api_token, type: String
+      # if the api token should be reset
+      field :reset_api_token, type: Mongoid::Boolean, default: true
+      field :last_authenticated_at, type: Time
+      field :last_authenticated_ip, type: String
+      # call back to reset the api token.
+      before_save :assign_api_token, if: :reset_api_token
+      # set the index on api token
+      index({ api_token: 1 }, background: true)
+
+      def cycle_api_token
+        self.set api_token: SecureRandom.urlsafe_base64
+        api_token
+      end
+
+      private
+
+      #
+      # set the api token
+      #
+      def assign_api_token
+        self.reset_api_token = false
+        self.api_token = SecureRandom.urlsafe_base64
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+#
+# AWS Configuration
+#
+module AwsConfiguration
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :aws_region, type: String
+      field :aws_access_key_id, type: String
+      field :aws_secret_access_key, type: String
+      field :aws_auto_scaling_group_name, type: String
+    end
+  end
+
+  #
+  # Make sure the password doesn't get blanked out on an update
+  #
+  def secure_fields
+    super + %i[aws_access_secret]
+  end
+
+  #
+  # Determine if AWS is configured
+  #
+  def aws_configured?
+    [aws_region.present?, aws_access_key_id.present?, aws_secret_access_key.present?].all?
+  end
+
+  #
+  # Determine if auto scaling group is configured
+  #
+  def aws_auto_scaling_configured?
+    aws_configured? && aws_auto_scaling_group_name.present?
+  end
+end

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

@@ -17,6 +17,13 @@
 #
 module CdnUrl
   extend ActiveSupport::Concern
+  #
+  # Constants
+  #
+  STYLE_S3_FILE_PATH = ':class/:attachment/:id/:style.:extension' unless defined? STYLE_S3_FILE_PATH
+  STYLE_FILE_PATH = 'public/system/:class/:attachment/:id/:style.:extension' unless defined? STYLE_FILE_PATH
+  STYLE_S3_FILE_URL = ':s3_domain_url' unless defined? STYLE_S3_FILE_URL
+  STYLE_FILE_URL = ':rails_root/public/system/:class/:attachment/:id/:style.:extension' unless defined? STYLE_FILE_URL
 
   def method_missing(method, *args)
     if method.to_s.start_with? 'cdn_'

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+#
+# SMTP Configuration
+#
+module CoreSmtpConfiguration
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :default_email, type: String, default: 'support@app47.com'
+      field :support_email, type: String, default: 'support@app47.com'
+      field :smtp_name, type: String
+      field :smtp_address, type: String
+      field :smtp_domain, type: String
+      field :smtp_port, type: Integer, default: 587
+      field :smtp_user_name, type: String
+      field :smtp_password, type: String
+      field :smtp_enable_starttls_auto, type: Mongoid::Boolean, default: false
+      field :mailgun_api_key, type: String
+      field :email_notification_ttl, type: Integer, default: 180
+    end
+    base.extend SmtpClassMethods
+  end
+
+  #
+  # Class methods for smtp configuration
+  #
+  module SmtpClassMethods
+    def smtp_configuration
+      output = {}
+      config = configuration
+      fields = %w[name address domain port user_name password enable_starttls_auto]
+      fields.each do |field|
+        field_name = "smtp_#{field}".to_sym
+        output[field.to_sym] = config.send(field_name)
+      end
+      output
+    end
+  end
+
+  #
+  # Make sure the password doesn't get blanked out on an update
+  #
+  def secure_fields
+    super + %i[smtp_password mailgun_api_key]
+  end
+
+  #
+  # Determine if SMTP is configured
+  #
+  def smtp_configured?
+    smtp_name.present? && smtp_address.present? && smtp_domain.present?
+  end
+
+  #
+  # Determine if mailgun is configured
+  #
+  def mail_gun_configured?
+    smtp_configured? && mailgun_api_key.present?
+  end
+end

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

@@ -1,112 +1,66 @@
 # frozen_string_literal: true
 
+#
+# The System configuration. Various configuration items that can be updated/defined at run time
+#
+# Use of this class allows you to simply ask for the configuration parameter directly without
+# first having to get an instance of it.
+#
+# SystemConfiguration.queue_impl #=> 'RedisQueue'
+#
+# This method only is allowed for accessors, you should NEVER set values on the SystemConfiguration
+# unless you are updating via the Admin or Stack UI, or during testing to setup a specific configuration
+# for that.
+#
 module CoreSystemConfiguration
   extend ActiveSupport::Concern
-  #
-  # The System configuration. Various configuration items that can be updated/defined at run time
-  #
-  # Use of this class allows you to simply ask for the configuration parameter directly without
-  # first having to get an instance of it.
-  #
-  # SystemConfiguration.queue_impl #=> 'RedisQueue'
-  #
-  # This method only is allowed for accessors, you should NEVER set values on the SystemConfiguration
-  # unless you are updating via the Admin or Stack UI, or during testing to setup a specific configuration
-  # for that.
-  #
+
   def self.included(base)
     base.class_eval do
       attr_accessor :configuration
+
       #
       # Fields
       #
       field :environment, type: String, default: 'test'
-      field :fips_mode, type: Boolean, default: false
+      field :fips_mode, type: Mongoid::Boolean, default: false
       field :fav_icon_path, { type: String, default: '/favicon.ico' }
       field :stack_logo_path, { type: String, default: 'ui-company-logo.png' }
       field :primary_stylesheet, { type: String, default: 'app47' }
       field :short_cache, { type: Integer, default: 1 }
       field :medium_cache, { type: Integer, default: 5 }
       field :long_cache, { type: Integer, default: 15 }
-      # SMTP configuration
-      field :default_email, type: String, default: 'support@app47.com'
-      field :support_email, type: String, default: 'support@app47.com'
-      field :smtp_name, type: String
-      field :smtp_address, type: String
-      field :smtp_domain, type: String
-      field :smtp_port, type: Integer, default: 587
-      field :smtp_user_name, type: String
-      field :smtp_password, type: String
-      field :smtp_enable_starttls_auto, type: Boolean
-      field :mailgun_api_key, type: String
-      # Twillio support
-      field :twilio_account_id, type: String
-      field :twilio_auth_token, type: String
-      field :twilio_phone_number, type: String
       # URLs
       field :base_url, type: String
       field :cdn_url, type: String
-      # Slack support
-      field :slack_api_url, type: String
-      field :slack_support_channel, type: String, default: 'support'
-      field :slack_sales_channel, type: String, default: 'sales'
+      field :asset_cdn_url, type: String
       # Time Zone Support
       field :default_time_zone, type: String, default: 'US/Eastern'
-      # AWS
-      field :aws_region, type: String
-      field :aws_access_key_id, type: String
-      field :aws_secret_access_key, type: String
-      field :aws_auto_scaling_group_name, type: String
-      # Zendesk
-      field :zendesk_token, type: String
-      field :zendesk_base_url, type: String, default: 'https://app47.zendesk.com'
-      field :zendesk_documentation_path, type: String, default: 'hc'
-      field :zendesk_support_path, type: String, default: 'hc/en-us/requests'
-      field :zendesk_updates_path, type: String, default: 'hc'
-      # Switchboard
-      field :switchboard_base_url, type: String, default: 'https://switchboard.app47.com'
-      field :switchboard_stack_id, type: String
-      field :switchboard_stack_api_token, type: String
-      field :switchboard_last_sync_at, type: Time
       # TTLs
       field :user_model_audit_log_ttl, type: Integer, default: 365
-      field :slack_notification_ttl, type: Integer, default: 5
-      field :email_notification_ttl, type: Integer, default: 180
       #
       # Validations
       #
       validates :environment, presence: true, uniqueness: true
-      validates :slack_support_channel, presence: true
-      validates :slack_sales_channel, presence: true
       validates :default_time_zone, presence: true
-      validates :switchboard_base_url, url: true
-      validates :zendesk_base_url, url: true
     end
     base.extend ClassMethods
   end
 
+  #
+  # Class methods for SystemConfiguration
+  #
   module ClassMethods
     def configuration
       SystemConfiguration.find_or_create_by!(environment: Rails.env)
     end
 
-    def smtp_configuration
-      output = {}
-      config = configuration
-      fields = %w[name address domain port user_name password enable_starttls_auto]
-      fields.each do |field|
-        field_name = "smtp_#{field}".to_sym
-        output[field.to_sym] = config.send(field_name)
-      end
-      output
-    end
-
     #
     # NOTE: Currently ignored Codacy issue: When using 'method_missing', fall back on 'super'
     #
-    def method_missing(method, *args, &block)
+    def method_missing(method, ...)
       if configuration.respond_to?(method)
-        configuration.send(method, *args, &block)
+        configuration.send(method, ...)
       else
         super
       end
@@ -121,18 +75,6 @@ module CoreSystemConfiguration
     end
   end
 
-  #
-  # Make sure the password doesn't get blanked out on an update
-  #
-  def secure_fields
-    super + %i[smtp_password
-               aws_access_secret
-               mailgun_api_key
-               switchboard_stack_api_token
-               twilio_auth_token
-               zendesk_token]
-  end
-
   #
   # Cache times in minutes
   #
@@ -147,129 +89,4 @@ module CoreSystemConfiguration
   def long_cache_time
     long_cache.minutes
   end
-
-  #
-  # Determine if SMTP is configured
-  #
-  def smtp_configured?
-    smtp_name.present? && smtp_address.present? && smtp_domain.present?
-  end
-
-  #
-  # Determine if mailgun is configured
-  #
-  def mail_gun_configured?
-    smtp_configured? && mailgun_api_key.present?
-  end
-
-  #
-  # Determine if AWS is configured
-  #
-  def aws_configured?
-    [aws_region.present?, aws_access_key_id.present?, aws_secret_access_key.present?].all?
-  end
-
-  #
-  # Determine if auto scaling group is configured
-  #
-  def aws_auto_scaling_configured?
-    aws_configured? && aws_auto_scaling_group_name.present?
-  end
-
-  #
-  # Return the zendesk documentation URL
-  #
-  def zendesk_documentation_url(user = nil)
-    zendesk_url(forward_to: zendesk_documentation_path, user: user)
-  end
-
-  #
-  # Return the zendesk support URL
-  #
-  def zendesk_requests_url(user = nil)
-    zendesk_url(forward_to: zendesk_support_path, user: user)
-  end
-
-  #
-  # Return the zendesk support URL
-  #
-  def zendesk_new_request_url(user = nil)
-    zendesk_url(forward_to: "#{zendesk_support_path}/new", user: user)
-  end
-
-  #
-  # Return the zendesk update URL
-  #
-  def zendesk_updates_url(user = nil)
-    zendesk_url(forward_to: zendesk_updates_path, user: user)
-  end
-
-  #
-  # Generate a Zendesk URL
-  #
-  # If a user is passed in and Zendesk is configured then return a JWT enabled URL for
-  # SSO authentication to Zendesk.
-  #
-  def zendesk_url(forward_to: zendesk_documentation_path, user: nil)
-    config = SystemConfiguration.configuration
-    path = if config.zendesk_configured? && user.present?
-             time_now = Time.now.to_i
-             jti = "#{time_now}/#{rand(36 ** 64).to_s(36)}"
-             payload = { jwt: JWT.encode({ iat: time_now, # Seconds since epoch, determine when this token is stale
-                                           jti: jti, # Unique token identifier, helps prevent replay attacks
-                                           name: user.name,
-                                           email: user.email }, config.zendesk_token),
-                         return_to: CGI.escape([config.zendesk_base_url, forward_to].join('/')) }
-             ['access/jwt', payload.to_query].join('?')
-           else
-             forward_to
-           end
-    [config.zendesk_base_url, path].join('/')
-  end
-
-  #
-  # Is zendesk configured?
-  #
-  def zendesk_configured?
-    [zendesk_token.present?,
-     zendesk_base_url.present?,
-     zendesk_documentation_path.present?,
-     zendesk_support_path.present?].all?
-  end
-
-  #
-  # Public: Determine if switchboard is configured
-  #
-  # Examples
-  #
-  #   switchboard_configured?
-  #   # => true || false
-  #
-  def switchboard_configured?
-    [switchboard_base_url.present?, switchboard_stack_api_token.present?, switchboard_stack_id.present?].all?
-  end
-
-  #
-  # Determine if twillio is configured at a system configuration
-  #
-  # Examples
-  #
-  #   switchboard_configured?
-  #   # => true || false
-  #
-  def twilio_configured?
-    [twilio_account_id.present?, twilio_auth_token.present?, twilio_phone_number.present?].all?
-  end
-
-  #
-  # Determine if Slack is configured
-  #
-  # Examples
-  #
-  #   switchboard_configured?
-  #   # => true || false
-  #
-  def slack_configured?
-    slack_api_url.present?
-  end
 end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# The Slack Configuration to be used inside of SystemConfiguration
+#
+module DelayedJobConfiguration
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :delayed_job_max_allowed_method, type: String, default: 'max'
+      field :delayed_job_max_allowed_factor, type: Integer, default: 5
+      field :delayed_job_restart_orphaned, type: Mongoid::Boolean, default: false
+      #
+      # Validations
+      #
+      validates :delayed_job_max_allowed_method, inclusion: { in: %w[max min avg] }
+      validates :delayed_job_max_allowed_factor, numericality: { greater_than: 0 }
+    end
+  end
+end

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

@@ -17,7 +17,7 @@ module EmailAble
       field :email_bounced_at, type: Time
       field :email_bounce_reason, type: String
       field :unconfirmed_email, type: String
-      field :email_enabled, type: Boolean, default: true
+      field :email_enabled, type: Mongoid::Boolean, default: true
       #
       # Validations
       #
@@ -61,7 +61,7 @@ module EmailAble
   #
   # Reset the bounced email
   #
-  def reset_bounce_status
+  def reset_bounce_status(current_member = nil)
     return unless SystemConfiguration.mail_gun_configured? && email_bounced?
 
     reset_url = "https://api.mailgun.net/v3/#{SystemConfiguration.smtp_domain}/bounces/#{CGI.escape(email)}"
@@ -69,7 +69,11 @@ module EmailAble
   rescue RestClient::Exception => error
     log_error "Unable to reset email bounce status: #{inspect}", error
   ensure
-    set email_bounced_at: nil, email_bounce_reason: nil
+    if current_member.present?
+      update_and_log current_member, email_bounced_at: nil, email_bounce_reason: nil
+    else
+      set email_bounced_at: nil, email_bounce_reason: nil
+    end
   end
 
   #

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

@@ -39,6 +39,22 @@ module SearchAble
     end
   end
 
+  def method_missing(method, *args)
+    if method.to_s.start_with? 'sorted_'
+      send(method.to_s.sub(/^sorted_/, '')).asc(:sort_text)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    super || method_name.to_s.start_with?('sorted_')
+  end
+
+  def respond_to?(method, include_private = false)
+    super || method.to_s.start_with?('sorted_')
+  end
+
   #
   # Place holder to call to allow for work to be done before we gather up search text fields
   #

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+#
+# Mixin for objects that act as servers
+#
+module ServerProcessAble
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :host_name, type: String
+      field :pid, type: Integer
+      field :running, type: Mongoid::Boolean, default: false
+      field :last_check_in_at, type: Time
+      #
+      # Validations
+      #
+      validates :host_name, presence: true
+      validates :pid, presence: true
+    end
+    base.extend ClassMethods
+  end
+
+  #
+  # Methods for the concrete class this concern is attached too, ways to find or create or just find the
+  # associated server.
+  #
+  module ClassMethods
+    #
+    # Find a record for this server
+    #
+    def find_or_create_server
+      find_or_create_by!(host_name: Socket.gethostname, pid: Process.pid)
+    end
+
+    #
+    # Find a worker, return nil if not found
+    #
+    def find_server
+      find_by(host_name: Socket.gethostname, pid: Process.pid)
+    rescue StandardError
+      nil
+    end
+  end
+
+  #
+  # Perform a check in for the server
+  #
+  def check_in
+    set(last_check_in_at: Time.now.utc)
+  end
+
+  #
+  # Stop the worker
+  #
+  def stop
+    set(running: false, last_check_in_at: Time.now.utc)
+  end
+
+  #
+  # Start the worker
+  #
+  def start
+    set(running: true, last_check_in_at: Time.now.utc)
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+#
+# The Slack Configuration to be used inside of SystemConfiguration
+#
+module SlackConfiguration
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :slack_api_url, type: String
+      field :slack_support_channel, type: String, default: 'support'
+      field :slack_sales_channel, type: String, default: 'sales'
+      field :slack_notification_ttl, type: Integer, default: 5
+      #
+      # Validations
+      #
+      validates :slack_api_url, url: true, allow_blank: true
+      validates :slack_support_channel, presence: true
+      validates :slack_sales_channel, presence: true
+    end
+  end
+
+  #
+  # Determine if Slack is configured
+  #
+  # Examples
+  #
+  #   slack_configured??
+  #   # => true || false
+  #
+  def slack_configured?
+    [slack_api_url.present?, slack_support_channel.present?, slack_sales_channel.present?].all?
+  end
+end

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

@@ -42,9 +42,12 @@ module StandardModel
     # Used by calling 'model.without_callback(*.args, &block) do'
     def without_callback(*args, &_block)
       skip_callback(*args)
-      yield
-    ensure
+      block_result = yield
       set_callback(*args)
+      block_result
+    rescue StandardError
+      set_callback(*args)
+      nil
     end
 
     #
@@ -66,7 +69,7 @@ module StandardModel
       names = field_names(filter_names)
       names += associations if include_relationships
       names.delete_if { |name| filter_names.include?(name) }
-    rescue StandardError
+    rescue StandardError => error
       attribute_names.delete_if { |name| filter_names.include?(name) }
     end
 
@@ -84,12 +87,8 @@ module StandardModel
     #
     def many_to_many_associations
       associations = []
-      reflect_on_all_associations.each do |association|
-        if Mongoid::Compatibility::Version.mongoid7_or_newer?
-          next unless association.relation == Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy
-        else
-          next unless association.macro == :has_and_belongs_to_many
-        end
+      reflect_on_all_associations(:has_and_belongs_to_many).each do |association|
+        next unless association.relation == Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy
 
         associations << { association.key => [] }
       end