motor-admin 0.3.17 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53345b043e43a3765e5e8cc0d1b0e336b92a59cad3af656eaea11153c5c04269
-  data.tar.gz: 1fb5e54fa20a6e57fe805759a76b635b5995d798b8ac4feba0b3a11f06a48842
+  metadata.gz: ca54cd5d999594ce72fba85a996c63bb99ef87cb58dddd02f91af2c97e8d9508
+  data.tar.gz: 26c2f9525f0324a30a1ae241a466e85cce271434a2b2d29f144387f01486d712
 SHA512:
-  metadata.gz: 15bc1b334c227e309e6d2c2ded39924d3ab23ff7028b86245d9d668dc26eb9071bd198a00d7f4d936ee384595272cd04395fa4f32a7aa286ae7bde6729ddb0c2
-  data.tar.gz: d30a7110abaa69547fd1b620397646644cd3e4abd619d8225b6f1e8b2cfdd8a9929320de0c6b270f85e6e390ee3c9791e354a1448231ad0f17f0444a35237883
+  metadata.gz: 97ade114c8bedf11dcf2586ec76fd629efd7517b4319e32fe3ce23a3c6e38f8e179e233e0fc202147785b9b0e9d3757af0064eadfb0eb84a177ce87f63b646ce
+  data.tar.gz: ccd281c10b4950741da0ecca8d3a9e1296186a8d96fb7db04b41e16809064dbed7334f0c0250f56779ae1fed660da9572c8abc0aa8dfc137684b551126176ce0

data/app/channels/motor/application_cable/channel.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Motor
+  class DummyChannel
+    def self.broadcast_to(*_args)
+      nil
+    end
+  end
+
+  module ApplicationCable
+    class Channel < defined?(ActionCable) ? ActionCable::Channel::Base : Motor::DummyChannel
+    end
+  end
+end

data/app/channels/motor/application_cable/connection.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Motor
+  module ApplicationCable
+    class Connection < defined?(ActionCable) ? ActionCable::Connection::Base : Object
+      identified_by :current_user if defined?(ActionCable)
+
+      def connect
+        self.current_user = find_verified_user
+      end
+
+      private
+
+      def find_verified_user
+        return unless env['warden']
+
+        if env['warden'].respond_to?(:admin_user)
+          env['warden'].admin_user
+        elsif env['warden'].respond_to?(:admin)
+          env['warden'].admin
+        else
+          env['warden'].user
+        end
+      end
+    end
+  end
+end

data/app/channels/motor/notes_channel.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Motor
+  class NotesChannel < ::Motor::ApplicationCable::Channel
+    def subscribed
+      stream_from "motor:notes:#{params[:room]}"
+    end
+  end
+end

data/app/channels/motor/notifications_channel.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Motor
+  class NotificationsChannel < ::Motor::ApplicationCable::Channel
+    def subscribed
+      stream_for current_user if respond_to?(:current_user)
+    end
+  end
+end

data/app/controllers/concerns/motor/current_user_method.rb

@@ -7,6 +7,8 @@ module Motor
         if defined?(current_admin)
           current_admin
         elsif defined?(current_admin_user)
+          return Motor::AdminUser.public if current_admin_user.nil? && Motor.with_public_access?
+
           current_admin_user
         elsif defined?(super)
           super

data/app/controllers/motor/note_tags_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Motor
+  class NoteTagsController < ApiBaseController
+    wrap_parameters :data, except: %i[include fields]
+
+    load_and_authorize_resource :note_tag
+
+    def index
+      render json: { data: @note_tags.to_a }
+    end
+  end
+end

data/app/controllers/motor/notes_controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Motor
+  class NotesController < ApiBaseController
+    wrap_parameters :data, except: %i[include fields]
+
+    load_and_authorize_resource :note, only: %i[index show update destroy]
+    before_action :build_note, only: :create
+    authorize_resource :note, only: :create
+
+    def index
+      @notes = Motor::ApiQuery.call(@notes.active.order(created_at: :asc), params)
+
+      render json: { data: Motor::ApiQuery::BuildJson.call(@notes, params, current_ability) }
+    end
+
+    def show
+      render json: { data: Motor::ApiQuery::BuildJson.call(@note, params, current_ability) }
+    end
+
+    def create
+      Motor::Notes::Persist.call(@note, current_user)
+      Motor::NotifyNoteMentionsJob.perform_later(@note, current_user)
+
+      render json: { data: Motor::ApiQuery::BuildJson.call(@note, params, current_ability) }
+    end
+
+    def update
+      @note.assign_attributes(note_params)
+
+      Motor::Notes::Persist.call(@note, current_user)
+      Motor::NotifyNoteMentionsJob.perform_later(@note, current_user)
+
+      render json: { data: Motor::ApiQuery::BuildJson.call(@note, params, current_ability) }
+    end
+
+    def destroy
+      @note.update!(deleted_at: Time.current)
+
+      Motor::NotesChannel.broadcast_to(
+        @note.values_at(:record_type, :record_id).join(':'),
+        ['remove', @note.as_json(only: %i[id body created_at updated_at])]
+      )
+
+      head :ok
+    end
+
+    private
+
+    def build_note
+      @note = Motor::Note.new(note_params.merge(author: current_user))
+    end
+
+    def note_params
+      params.require(:data).permit(:body, :record_id, :record_type)
+    end
+  end
+end

data/app/controllers/motor/notifications_controller.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Motor
+  class NotificationsController < ApiBaseController
+    wrap_parameters :data, except: %i[include fields]
+
+    load_and_authorize_resource :notification
+
+    def index
+      @notifications =
+        Motor::ApiQuery.call(@notifications.where(recipient: current_user).order(created_at: :desc), params)
+
+      render json: {
+        data: Motor::ApiQuery::BuildJson.call(@notifications, params, current_ability),
+        meta: Motor::ApiQuery::BuildMeta.call(@notifications, params)
+      }
+    end
+
+    def update
+      @notification.update!(notification_params)
+
+      Motor::NotificationsChannel.broadcast_to(current_user, ['update', @notification.as_json(include: %i[record])])
+
+      render json: { data: Motor::ApiQuery::BuildJson.call(@notification, params, current_ability) }
+    end
+
+    private
+
+    def notification_params
+      params.require(:data).permit(:status)
+    end
+  end
+end

data/app/controllers/motor/reminders_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Motor
+  class RemindersController < ApiBaseController
+    wrap_parameters :data, except: %i[include fields]
+
+    load_and_authorize_resource :reminder
+
+    def create
+      @reminder.update!(author: current_user, recipient: current_user)
+
+      broadcast_note_update(@reminder.record)
+
+      render json: { data: Motor::ApiQuery::BuildJson.call(@reminder, params, current_ability) }
+    end
+
+    def destroy
+      @reminder.destroy!
+
+      broadcast_note_update(@reminder.record)
+
+      head :ok
+    end
+
+    private
+
+    def broadcast_note_update(note)
+      Motor::NotesChannel.broadcast_to(
+        note.values_at(:record_type, :record_id).join(':'),
+        ['update', note.as_json(include: %i[author tags reminders])]
+      )
+    end
+
+    def reminder_params
+      params.require(:data).permit(:record_id, :record_type, :scheduled_at)
+    end
+  end
+end

data/app/controllers/motor/run_queries_controller.rb

@@ -20,7 +20,7 @@ module Motor
     private
 
     def render_result
-      query_result = Queries::RunQuery.call(@query, variables_hash: variables_params,
+      query_result = Queries::RunQuery.call(@query, variables_hash: variables_params.to_unsafe_h,
                                                     limit: params[:limit].presence,
                                                     filters: filter_params)
 

data/app/controllers/motor/send_alerts_controller.rb

@@ -8,7 +8,7 @@ module Motor
     authorize_resource :alert, only: :create
 
     def create
-      AlertsMailer.alert_email(@alert).deliver_now!
+      Motor::Alerts.send_alert(@alert)
 
       head :ok
     end
@@ -20,7 +20,7 @@ module Motor
     end
 
     def alert_params
-      params.require(:data).permit(:query_id, :name, :to_emails)
+      params.require(:data).permit(:query_id, :name, :to_emails, :description, preferences: {})
     end
   end
 end

data/app/controllers/motor/slack_conversations_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Motor
+  class SlackConversationsController < ApiBaseController
+    def index
+      authorize!(:create, Motor::Alert)
+
+      render json: { data: Motor::Slack.conversations }
+    end
+  end
+end

data/app/controllers/motor/tags_controller.rb

@@ -5,7 +5,7 @@ module Motor
     load_and_authorize_resource :tag
 
     def index
-      render json: { data: @tags }
+      render json: { data: @tags.to_a }
     end
   end
 end

data/app/controllers/motor/ui_controller.rb

@@ -4,7 +4,7 @@ module Motor
   class UiController < ApplicationController
     layout 'motor/application'
 
-    helper_method :current_user, :current_ability, :cache_keys
+    helper_method :current_user, :current_ability, :cache_keys, :custom_html
 
     before_action :set_i18n_locale
 
@@ -30,6 +30,14 @@ module Motor
       render :show
     end
 
+    def custom_html
+      Motor::Admin.config.custom_html.presence || begin
+        configs = Motor::Configs::LoadFromCache.load_configs(cache_key: cache_keys[:configs])
+
+        configs.find { |c| c.key == 'ui.custom_html' }&.value
+      end
+    end
+
     def set_i18n_locale
       configs = Motor::Configs::LoadFromCache.load_configs(cache_key: cache_keys[:configs])
 

data/app/controllers/motor/users_for_autocomplete_controller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Motor
+  class UsersForAutocompleteController < ApiBaseController
+    def index
+      authorize!(:create, Motor::Note)
+
+      render json: { data: user_emails }
+    end
+
+    private
+
+    def user_emails
+      user_class   = Motor::AdminUser if defined?(Motor::AdminUser)
+      user_class ||= AdminUser if defined?(AdminUser)
+      user_class ||= User if defined?(User)
+
+      return user_class.distinct.limit(100).pluck(:email) if user_class
+
+      []
+    end
+  end
+end

data/app/jobs/motor/alert_sending_job.rb

@@ -5,7 +5,7 @@ module Motor
     def perform(alert)
       Motor::AlertLock.create!(alert_id: alert.id, lock_timestamp: alert.cron.previous_time.to_i)
 
-      Motor::AlertsMailer.alert_email(alert).deliver_now!
+      Motor::Alerts.send_alert(alert)
     rescue ActiveRecord::RecordNotUnique
       nil
     end

data/app/jobs/motor/notify_note_mentions_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Motor
+  class NotifyNoteMentionsJob < ApplicationJob
+    def perform(note, current_user)
+      Motor::Notes::NotifyMentions.call(note, current_user)
+    end
+  end
+end

data/app/jobs/motor/notify_reminder_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Motor
+  class NotifyReminderJob < ApplicationJob
+    def perform(reminder)
+      Motor::Notes::NotifyReminder.call(reminder)
+    end
+  end
+end

data/app/mailers/motor/alerts_mailer.rb

@@ -6,9 +6,10 @@ module Motor
     SENDER_NOT_SET_ERROR_MESSAGE =
       'Please specify your sender address via MOTOR_ALERTS_FROM_ADDRESS environment variable'
 
-    def alert_email(alert)
+    def alert_email(alert, email: nil)
       @alert = alert
-      @query_result = Queries::RunQuery.call(alert.query)
+      @query_result = Queries::RunQuery.call(alert.query,
+                                             variables_hash: { current_user_email: email })
 
       return if @alert.preferences[:send_empty].blank? && @query_result.data.blank?
 
@@ -18,7 +19,7 @@ module Motor
 
       mail(
         from: from_address,
-        to: alert.to_emails,
+        to: email || alert.to_emails,
         subject: alert.name.presence || @alert.query.name
       )
     end
@@ -29,34 +30,10 @@ module Motor
       attachments["#{alert.name.presence || 'data'}.csv"] = generate_csv(query_result)
     end
 
-    def generate_csv(_query_result)
-      rows = [@query_result.columns.pluck(:name)] + @query_result.data
+    def generate_csv(query_result)
+      rows = [query_result.columns.pluck(:name)] + query_result.data
 
       rows.map(&:to_csv).join
     end
-
-    def from_address
-      from = ENV['MOTOR_ALERTS_FROM_ADDRESS'].presence || ENV['MOTOR_EMAIL_ADDRESS'].presence
-
-      from ||= application_mailer_default_from
-      from ||= mailer_config_from_address
-      from ||= "reports@#{ENV['HOST'].delete_prefix('www.')}" if ENV['HOST'].present?
-
-      from ||= 'reports@example.com' if Rails.env.development?
-
-      from
-    end
-
-    def application_mailer_default_from
-      return if !defined?(::ApplicationMailer) || ::ApplicationMailer.default[:from].to_s.include?('example.com')
-
-      ::ApplicationMailer.default[:from].presence
-    end
-
-    def mailer_config_from_address
-      return if Rails.application.config.action_mailer.default_url_options&.dig(:host).blank?
-
-      "reports@#{Rails.application.config.action_mailer.default_url_options[:host].delete_prefix('www.')}"
-    end
   end
 end

data/app/mailers/motor/application_mailer.rb

@@ -2,6 +2,32 @@
 
 module Motor
   class ApplicationMailer < ActionMailer::Base
-    layout 'mailer'
+    layout 'motor/mailer'
+
+    private
+
+    def from_address
+      from = ENV['MOTOR_ALERTS_FROM_ADDRESS'].presence || ENV['MOTOR_EMAIL_ADDRESS'].presence
+
+      from ||= application_mailer_default_from
+      from ||= mailer_config_from_address
+      from ||= "reports@#{ENV['HOST'].delete_prefix('www.')}" if ENV['HOST'].present?
+
+      from ||= 'reports@example.com' if Rails.env.development?
+
+      from
+    end
+
+    def application_mailer_default_from
+      return if !defined?(::ApplicationMailer) || ::ApplicationMailer.default[:from].to_s.include?('example.com')
+
+      ::ApplicationMailer.default[:from].presence
+    end
+
+    def mailer_config_from_address
+      return if Rails.application.config.action_mailer.default_url_options&.dig(:host).blank?
+
+      "reports@#{Rails.application.config.action_mailer.default_url_options[:host].delete_prefix('www.')}"
+    end
   end
 end

data/app/mailers/motor/notifications_mailer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Motor
+  class NotificationsMailer < ApplicationMailer
+    def notify_mention_email(notification)
+      @notification = notification
+
+      @note = notification.record
+
+      subject =
+        "#{@note.author&.email || 'Anonymous'} mentioned you in " \
+        "#{@note.record.class.model_name.human} ##{@note.record.id}"
+
+      mail(
+        from: from_address,
+        to: notification.recipient.email,
+        subject: subject
+      )
+    end
+
+    def notify_reminder_email(notification)
+      @notification = notification
+
+      @note = notification.record.record
+
+      mail(
+        from: from_address,
+        to: notification.recipient.email,
+        subject: "Reminder for #{@note.record.class.model_name.human} ##{@note.record.id}"
+      )
+    end
+  end
+end

data/app/models/motor/note.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Motor
+  class Note < ::Motor::ApplicationRecord
+    audited
+
+    belongs_to :author, polymorphic: true, optional: true
+    belongs_to :record, polymorphic: true
+
+    has_many :note_tag_tags, dependent: :destroy
+    has_many :tags, through: :note_tag_tags, class_name: 'Motor::NoteTag'
+
+    has_many :reminders, as: :record, dependent: :destroy
+    has_many :notifications, as: :record, dependent: :destroy
+
+    scope :active, -> { where(deleted_at: nil) }
+  end
+end

data/app/models/motor/note_tag.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Motor
+  class NoteTag < ::Motor::ApplicationRecord
+    has_many :note_tag_tags, dependent: :destroy
+  end
+end

data/app/models/motor/note_tag_tag.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Motor
+  class NoteTagTag < ::Motor::ApplicationRecord
+    belongs_to :tag, class_name: 'Motor::NoteTag'
+    belongs_to :note
+  end
+end

data/app/models/motor/notification.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Motor
+  class Notification < ::Motor::ApplicationRecord
+    STATUSES = [
+      PENDING = 'pending'
+    ].freeze
+
+    belongs_to :record, polymorphic: true, optional: true
+    belongs_to :recipient, polymorphic: true
+
+    attribute :status, type: :string, default: PENDING
+  end
+end

data/app/models/motor/reminder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Motor
+  class Reminder < ::Motor::ApplicationRecord
+    audited
+
+    belongs_to :record, polymorphic: true, optional: true
+    belongs_to :author, polymorphic: true
+    belongs_to :recipient, polymorphic: true
+
+    has_many :notifications, as: :record, dependent: :destroy
+  end
+end

data/app/views/layouts/motor/application.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html lang="<%= I18n.locale %>">
   <head>
-    <title>Motor Admin</title>
+    <title><%= Motor.company_name %></title>
     <meta name="viewport" content="width=device-width,initial-scale=1.0,maximum-scale=1.0,user-scalable=no">
     <link rel="stylesheet" media="all" href="<%= Motor::Assets.asset_path('main.css') %>">
     <%= csrf_meta_tags %>
@@ -10,5 +10,8 @@
   <body>
     <%= yield %>
     <script src="<%= Motor::Assets.asset_path('main.js') %>"></script>
+    <% if params[:controller] === 'motor/ui' %>
+      <%= raw(custom_html) %>
+    <% end %>
   </body>
 </html>

data/app/views/layouts/motor/mailer.html.erb

@@ -0,0 +1,72 @@
+<!doctype html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width">
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <style>
+      @media only screen and (max-width: 620px) {
+        table[class=body] h1 {
+          font-size: 28px !important;
+          margin-bottom: 10px !important;
+        }
+        table[class=body] p,
+        table[class=body] ul,
+        table[class=body] ol,
+        table[class=body] td,
+        table[class=body] span,
+        table[class=body] a {
+          font-size: 14px !important;
+        }
+        table[class=body] .wrapper,
+        table[class=body] .article {
+          padding: 10px !important;
+        }
+        table[class=body] .content {
+          padding: 0 !important;
+        }
+        table[class=body] .container {
+          padding: 0 !important;
+          width: 100% !important;
+        }
+        table[class=body] .main {
+          border-left-width: 0 !important;
+          border-radius: 0 !important;
+          border-right-width: 0 !important;
+        }
+      }
+
+      @media all {
+        .ExternalClass {
+          width: 100%;
+        }
+        .ExternalClass,
+        .ExternalClass p,
+        .ExternalClass span,
+        .ExternalClass font,
+        .ExternalClass td,
+        .ExternalClass div {
+          line-height: 100%;
+        }
+        .apple-link a {
+          color: inherit !important;
+          font-family: inherit !important;
+          font-size: inherit !important;
+          font-weight: inherit !important;
+          line-height: inherit !important;
+          text-decoration: none !important;
+        }
+        #MessageViewBody a {
+          color: inherit;
+          text-decoration: none;
+          font-size: inherit;
+          font-family: inherit;
+          font-weight: inherit;
+          line-height: inherit;
+        }
+      }
+    </style>
+  </head>
+  <body class="" style="background-color: #f9fbfc; font-family: sans-serif; -webkit-font-smoothing: antialiased; font-size: 14px; line-height: 1.4; margin: 0; padding: 0; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%;">
+    <%= yield %>
+  </body>
+</html>