web47core 0.1.11 → 0.3.0

data/lib/app/controllers/concerns/core_cron_controller.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+#
+# Manage cron job servers
+#
+module CoreCronController
+  include CoreController
+  #
+  # Table to display cron job servers
+  #
+  def index
+    authorize! :read, Cron::Server
+    authorize! :read, Cron::Tab
+  end
+
+  #
+  # Run the crontab entry now
+  #
+  def run_now
+    authorize! :read, cron_tab
+    cron_tab.run
+    redirect_to index_path
+  rescue StandardError => error
+    log_controller_error error, true
+    redirect_to index_path
+  end
+
+  #
+  # Update a crontab entry
+  #
+  def update
+    authorize! :update, cron_tab
+    cron_tab.update! cron_tab_params
+    redirect_to index_path
+  rescue StandardError => error
+    log_controller_error error
+    render :edit
+  end
+
+  #
+  # Demote a cron job server
+  #
+  def demote
+    authorize! :edit, cron_server
+    cron_server.become_secondary
+    redirect_to index_path
+  rescue StandardError => error
+    log_controller_error error, true
+    redirect_to index_path
+  end
+
+  #
+  # Destroy a cron job server
+  #
+  def destroy
+    authorize! :destroy, cron_server
+    cron_server.destroy!
+    redirect_to index_path
+  rescue StandardError => error
+    log_controller_error error, true
+    redirect_to index_path
+  end
+
+  private
+
+  def cron_tab
+    @cron_tab ||= Cron::Tab.find(params[:id])
+  end
+
+  def cron_server
+    @cron_server ||= Cron::Server.find(params[:id])
+  end
+
+  def cron_tab_params
+    p = params['cron/job_tab']
+    p[:enabled] ||= false
+    p.permit(Cron::Tab.allowed_param_names)
+  end
+end

data/lib/app/controllers/concerns/core_delayed_jobs_controller.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+#
+# Manage access to delayed jobs
+#
+module CoreDelayedJobsController
+  include CoreController
+  #
+  # Show a list of jobs currently in the system
+  #
+  def index
+    authorize! :read, Delayed::Backend::Mongoid::Job
+    @delayed_jobs = Delayed::Backend::Mongoid::Job.asc(%i[priority run_at]).limit(100)
+  end
+
+  def show
+    delayed_job
+  end
+
+  #
+  # Destroy all jobs
+  #
+  def destroy_all
+    authorize! :manage, Delayed::Backend::Mongoid::Job
+    failed_only = params[:failed_only].eql?('true')
+    Delayed::Backend::Mongoid::Job.each do |job|
+      next if failed_only && !job.failed?
+
+      job.destroy
+    end
+    flash.now[:info] = 'All DelayJobs has been destroyed'
+    redirect_to index_path
+  rescue StandardError => error
+    log_controller_error error, true
+    redirect_to index_path
+  end
+
+  #
+  # Resubmit all jobs that have failed
+  #
+  def resubmit_all
+    authorize! :read, Delayed::Backend::Mongoid::Job
+    failed_only = params[:failed_only].eql?('true')
+    Delayed::Backend::Mongoid::Job.each do |job|
+      next if failed_only && !job.failed?
+
+      job.resubmit
+    end
+    flash.now[:info] = 'All DelayJobs has been resubmitted'
+    redirect_to index_path
+  rescue StandardError => error
+    log_controller_error error, true
+    redirect_to index_path
+  end
+
+  #
+  # Resubmit the delayed job via update method
+  #
+  def resubmit
+    authorize! :read, delayed_job
+    delayed_job.resubmit
+    flash.now[:info] = 'DelayJob has been resubmitted'
+    redirect_to index_path
+  rescue StandardError => error
+    log_controller_error error, true
+    redirect_to index_path
+  end
+
+  #
+  # Destroy the selected delayed job
+  #
+  def destroy
+    authorize! :manage, delayed_job
+    delayed_job.destroy!
+    flash.now[:info] = 'DelayJob has been destroyed'
+    redirect_to index_path
+  rescue StandardError => error
+    log_controller_error error, true
+    redirect_to index_path
+  end
+
+  private
+
+  def delayed_job
+    @delayed_job ||= Delayed::Backend::Mongoid::Job.find(params[:id])
+  end
+end

data/lib/app/controllers/concerns/core_system_configuration_controller.rb

@@ -4,7 +4,7 @@
 # Manage the system configuration page
 #
 module CoreSystemConfigurationsController
-  authorize_resource :system_configuration
+  include CoreController
 
   #
   # Edit the system configuration
@@ -21,7 +21,7 @@ module CoreSystemConfigurationsController
     SystemConfiguration.configuration.update! system_configuration_params
     flash[:info] = 'System Configuration Updated, sync job running in the background'
     Cron::SwitchboardSyncConfiguration.perform_later
-    redirect_to system_configuration_path
+    redirect_to index_path
   rescue StandardError => error
     log_controller_error error
     load_configuration
@@ -34,7 +34,7 @@ module CoreSystemConfigurationsController
   # Get the system configuration properties from the request
   #
   def system_configuration_params
-    params.require(:system_configuration).permit(SystemConfiguration.allowed_param_names)
+    params[:system_configuration].permit(%i[switchboard_base_url switchboard_stack_id switchboard_stack_api_token])
   end
 
   #

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

@@ -10,6 +10,9 @@ require 'optparse'
 require 'pathname'
 
 module Cron
+  #
+  # Provide a friendly command structure for managing the cron server
+  #
   class Command
 
     DIR_PWD = Pathname.new Dir.pwd
@@ -21,11 +24,11 @@ module Cron
         opt.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options] start|stop|restart|run"
 
         opt.on('-h', '--help', 'Show this message') do
-          puts opt
+          warn opt
           exit 1
         end
         opt.on('-e', '--environment=NAME', 'Specifies the environment to run this delayed jobs under (test/development/production).') do |_e|
-          STDERR.puts 'The -e/--environment option has been deprecated and has no effect. Use RAILS_ENV and see http://github.com/collectiveidea/delayed_job/issues/7'
+          warn 'The -e/--environment option has been deprecated and has no effect. Use RAILS_ENV and see http://github.com/collectiveidea/delayed_job/issues/7'
         end
         opt.on('--pid-dir=DIR', 'Specifies an alternate directory in which to store the process ids.') do |dir|
           @options[:pid_dir] = dir

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-#
-# Value object for a cron tab entry
-#
 module Cron
+  #
+  # Value object for a cron tab entry
+  #
   class JobTab < Tab
     FRAMEWORK_CLASSES = %w[Job TrimCollection Command Server Tab JobTab].freeze unless defined? FRAMEWORK_CLASSES
     #
@@ -38,9 +38,7 @@ module Cron
       def job_names
         @job_names ||= Cron.constants.collect do |job|
           job_name = job.to_s
-          next if FRAMEWORK_CLASSES.include?(job_name) ||
-            job_name.end_with?('Test') ||
-            job_name.start_with?('Base')
+          next if FRAMEWORK_CLASSES.include?(job_name) || job_name.end_with?('Test') || job_name.start_with?('Base')
 
           job_name.underscore
         end.compact

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

@@ -1,7 +1,9 @@
-#
-# Handle the coordination of which server should be running the cron jobs
-#
+# frozen_string_literal: true
+
 module Cron
+  #
+  # Handle the coordination of which server should be running the cron jobs
+  #
   class Server
     include StandardModel
     #
@@ -108,6 +110,7 @@ module Cron
 
     #
     # Become secondary node
+    # TODO: [CMS] Update when auditing in place
     #
     def become_secondary(user = nil)
       if user.present?

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

@@ -5,7 +5,7 @@ module Cron
   #
   # Cycle through all members and tell them to sync with with switchboard
   #
-  class SwitchboardSyncModels <Job
+  class SwitchboardSyncModels < Job
     cron_tab_entry :daily
 
     #

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-#
-# Value object for a cron tab entry
-#
 module Cron
+  #
+  # Value object for a cron tab entry
+  #
   class Tab
     include StandardModel
     include SearchAble

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

@@ -1,16 +1,7 @@
 # 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.
+# The Base Account
 #
 module CoreAccount
   extend ActiveSupport::Concern

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

@@ -1,18 +1,18 @@
 # 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
+  #
+  # 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.
+  #
   extend ActiveSupport::Concern
 
   def self.included(base)
@@ -110,7 +110,7 @@ module CoreSystemConfiguration
     # NOTE: Currently ignored Codacy issue: When using 'method_missing', fall back on 'super'
     #
     # rubocop:disable Style/MethodMissingSuper
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &_block)
       configuration.send method, *args
     end
 

data/lib/app/models/delayed_job.rb

@@ -11,7 +11,7 @@ module Delayed
         def status_description
           return 'Failed' if failed?
 
-          locked_by.present? ? locked_by : "Scheduled (#{attempts})"
+          locked_by.presence || "Scheduled (#{attempts})"
         end
 
         #

data/lib/app/models/email_notification.rb

@@ -192,9 +192,9 @@ class EmailNotification < Notification
       authentication: smtp.authentication_method.to_sym,
       enable_starttls_auto: smtp.ssl.eql?(true)
     }
-    config[:domain] = smtp.domain unless smtp.domain.nil? || smtp.domain.empty?
-    config[:user_name] = smtp.username unless smtp.username.nil? || smtp.username.empty?
-    config[:password] = smtp.password unless smtp.password.nil? || smtp.password.empty?
+    config[:domain] = smtp.domain if smtp.domain.present?
+    config[:user_name] = smtp.username if smtp.username.present?
+    config[:password] = smtp.password if smtp.password.present?
     config
   end
 
@@ -231,8 +231,8 @@ class EmailNotification < Notification
 
   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')
+              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')
@@ -240,7 +240,7 @@ class EmailNotification < Notification
   end
 
   def account_subject_template(template_name)
-    self.account.templates.emails.find_by(name: template_name.to_s).subject
+    account.templates.emails.find_by(name: template_name.to_s).subject
   rescue StandardError
     nil
   end

data/lib/app/models/email_template.rb

@@ -1,6 +1,9 @@
+#
+# Support an email template for an account
+#
 class EmailTemplate < Template
 
   field :subject, type: String
 
   validates_presence_of :subject
-end
+end

data/lib/app/models/notification.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
 #
+# Base class for notification
 #
 class Notification
   include StandardModel
   #
   # Constants
   #
-  STATE_INVALID = 'invalid'.freeze unless defined? STATE_INVALID
-  STATE_NEW = 'new'.freeze unless defined? STATE_NEW
-  STATE_PROCESSED = 'processed'.freeze unless defined? STATE_PROCESSED
-  STATE_PROCESSING = 'processing'.freeze unless defined? STATE_PROCESSING
-  STATE_RESUBMITTED = 'resubmitted'.freeze unless defined? STATE_RESUBMITTED
-  STATE_RETRYING = 'retrying'.freeze unless defined? STATE_RETRYING
-  STATE_SUBMITTED = 'submitted'.freeze unless defined? STATE_SUBMITTED
-  STATE_VIEWED = 'viewed'.freeze unless defined? STATE_VIEWED
+  STATE_INVALID = 'invalid' unless defined? STATE_INVALID
+  STATE_NEW = 'new' unless defined? STATE_NEW
+  STATE_PROCESSED = 'processed' unless defined? STATE_PROCESSED
+  STATE_PROCESSING = 'processing' unless defined? STATE_PROCESSING
+  STATE_RESUBMITTED = 'resubmitted' unless defined? STATE_RESUBMITTED
+  STATE_RETRYING = 'retrying' unless defined? STATE_RETRYING
+  STATE_SUBMITTED = 'submitted' unless defined? STATE_SUBMITTED
+  STATE_VIEWED = 'viewed' unless defined? STATE_VIEWED
   unless defined? ALL_STATES
     ALL_STATES = [STATE_INVALID,
                   STATE_NEW,
@@ -28,9 +29,9 @@ class Notification
   #
   # Channels
   #
-  DELIVERY_EMAIL = 'email'.freeze unless defined? DELIVERY_EMAIL
-  DELIVERY_SLACK = 'slack'.freeze unless defined? DELIVERY_SLACK
-  DELIVERY_SMS = 'sms'.freeze unless defined? DELIVERY_SMS
+  DELIVERY_EMAIL = 'email' unless defined? DELIVERY_EMAIL
+  DELIVERY_SLACK = 'slack' unless defined? DELIVERY_SLACK
+  DELIVERY_SMS = 'sms' unless defined? DELIVERY_SMS
   #
   # Fields
   #

data/lib/app/models/redis_configuration.rb

@@ -130,7 +130,7 @@ class RedisConfiguration
 
       config
     rescue StandardError => error
-      puts "Error loading #{config_file_path} file", error
+      App47Logger.log_warn "Error loading #{config_file_path} file", error
       nil # return nothing if there is an error
     end
   end

data/lib/app/models/template.rb

@@ -15,7 +15,7 @@ class Template
   #
   # Validations
   #
-  validates :name, uniqueness: {scope: :account_id}
+  validates :name, uniqueness: { scope: :account_id }
   validates :name, presence: true
   validates :template, presence: true
 end

data/lib/templates/slack/error_message.liquid

@@ -1 +1,3 @@
-*ERROR:* `{{message}}`{% if exception != blank %} - ```{{exception}}``` {% endif %}
+*ERROR:* `{{message}}`{% if exception != blank %} -
+```ruby {{exception}}```
+{% endif %}

data/lib/web47core/config.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-#
-# Configuration for the Web47Core platform
-#
 module Web47core
+  #
+  # Configuration for the Web47Core platform
+  #
   class Config
     include Singleton
-    attr_accessor :email_able_models,
-                  :switchboard_able_models,
-                  :system_configuration_namespace
+    attr_accessor :email_able_models, :switchboard_able_models
 
     def initialize
       @email_able_models = []

data/lib/web47core/engine.rb

@@ -1,3 +1,3 @@
 module Web47core
   class Engine < Rails::Engine; end
-end
+end

data/lib/web47core/version.rb

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

data/lib/web47core.rb

@@ -1,5 +1,3 @@
-VERSION = '0.1.6'
-
 require 'app/models/concerns/app47_logger'
 require 'app/models/concerns/cdn_url'
 require 'app/models/concerns/email_able'
@@ -38,7 +36,8 @@ require 'app/jobs/cron/trim_failed_delayed_jobs'
 # Controllers
 #
 require 'web47core/engine'
-require 'app/controllers/concerns/core_system_configuration_controller'
 require 'app/controllers/concerns/restful_controller'
-
-
+require 'app/controllers/concerns/core_controller'
+require 'app/controllers/concerns/core_system_configuration_controller'
+require 'app/controllers/concerns/core_cron_controller'
+require 'app/controllers/concerns/core_delayed_jobs_controller'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web47core
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Schroeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: delayed_job_mongoid
+  name: cancancan
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: email_format
   requirement: !ruby/object:Gem::Requirement
@@ -545,16 +559,42 @@ files:
 - app/controllers/exceptions_controller.rb
 - app/controllers/notifications_controller.rb
 - app/controllers/status_controller.rb
+- app/helpers/core_form_helper.rb
+- app/helpers/core_helper.rb
+- app/helpers/core_link_helper.rb
+- app/views/admin/cron/edit.html.haml
+- app/views/admin/cron/index.html.haml
+- app/views/admin/delayed_jobs/index.html.haml
+- app/views/admin/delayed_jobs/show.html.haml
+- app/views/admin/system_configurations/edit.html.haml
+- app/views/admin/system_configurations/show.html.haml
+- app/views/common/_form_actions.html.haml
+- app/views/cron/_edit.html.haml
+- app/views/cron/_index.html.haml
+- app/views/cron/edit.html.haml
+- app/views/cron/index.html.haml
+- app/views/delayed_jobs/_index.html.haml
+- app/views/delayed_jobs/_show.html.haml
+- app/views/delayed_jobs/index.html.haml
+- app/views/delayed_jobs/show.html.haml
+- app/views/stack/cron/edit.html.haml
+- app/views/stack/cron/index.html.haml
+- app/views/stack/system_configurations/edit.html.haml
+- app/views/stack/system_configurations/show.html.haml
 - app/views/status/index.html.haml
+- app/views/system_configurations/_edit.html.haml
+- app/views/system_configurations/_show.html.haml
+- app/views/system_configurations/edit.html.haml
+- app/views/system_configurations/show.html.haml
 - bin/cron_server
 - bin/delayed_job
 - config/locales/en.yml
 - config/routes.rb
+- lib/app/controllers/concerns/core_controller.rb
+- lib/app/controllers/concerns/core_cron_controller.rb
+- lib/app/controllers/concerns/core_delayed_jobs_controller.rb
 - lib/app/controllers/concerns/core_system_configuration_controller.rb
 - lib/app/controllers/concerns/restful_controller.rb
-- lib/app/helpers/core_form_helper.rb
-- lib/app/helpers/core_helper.rb
-- lib/app/helpers/core_link_helper.rb
 - lib/app/jobs/application_job.rb
 - lib/app/jobs/cron/command.rb
 - lib/app/jobs/cron/job.rb
@@ -586,8 +626,6 @@ files:
 - lib/app/models/sms_notification.rb
 - lib/app/models/smtp_configuration.rb
 - lib/app/models/template.rb
-- lib/app/views/system_configurations/edit.html.haml
-- lib/app/views/system_configurations/show.html.haml
 - lib/templates/email/notification_failure.liquid
 - lib/templates/email/notification_failure.subject.liquid
 - lib/templates/slack/error_message.liquid