Merge pull request #236 from psu-libraries/229-rails-admin

set up rails admin dashboard

Author: Smullz622

.rubocop.yml

@@ -4,6 +4,9 @@ inherit_gem:
 Metrics/BlockLength:
   Exclude:
     - 'config/environments/development.rb'
+    - 'app/models/api_user.rb'
+    - 'app/models/job.rb'
+    - 'config/routes.rb'
 
 Metrics/CyclomaticComplexity:
   Exclude:

Gemfile

@@ -9,7 +9,7 @@ gem 'rails', '~> 7.2.2', '>= 7.2.2.1'
 
 gem 'shakapacker'
 # Use mysql as the database for Active Record
-gem 'mysql2'
+gem 'mysql2', '~> 0.5.7'
 # Use the Puma web server [https://github.com/puma/puma]
 gem 'puma', '>= 5.0'
 # Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
@@ -78,6 +78,8 @@ group :test do
   gem 'shoulda-matchers'
 end
 
+gem 'rails_admin'
 gem 'rails_warden', '~> 0.6.0'
 
 gem 'bugsnag', '~> 6.28'
+gem 'sassc-rails'

Gemfile.lock

@@ -50,6 +50,10 @@ GEM
       globalid (>= 0.3.6)
     activemodel (7.2.2.2)
       activesupport (= 7.2.2.2)
+    activemodel-serializers-xml (1.0.3)
+      activemodel (>= 5.0.0.a)
+      activesupport (>= 5.0.0.a)
+      builder (~> 3.1)
     activerecord (7.2.2.2)
       activemodel (= 7.2.2.2)
       activesupport (= 7.2.2.2)
@@ -131,6 +135,7 @@ GEM
     concurrent-ruby (1.3.5)
     connection_pool (2.5.4)
     crass (1.0.6)
+    csv (3.3.5)
     date (3.4.1)
     debug (1.11.0)
       irb (~> 1.10)
@@ -185,6 +190,18 @@ GEM
     json-schema (5.2.2)
       addressable (~> 2.8)
       bigdecimal (~> 3.1)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -205,6 +222,7 @@ GEM
     msgpack (1.8.0)
     mysql2 (0.5.7)
       bigdecimal
+    nested_form (0.3.2)
     net-http (0.6.0)
       uri
     net-imap (0.5.10)
@@ -283,6 +301,13 @@ GEM
     rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    rails_admin (3.3.0)
+      activemodel-serializers-xml (>= 1.0)
+      csv
+      kaminari (>= 0.14, < 2.0)
+      nested_form (~> 0.3)
+      rails (>= 6.0, < 9)
+      turbo-rails (>= 1.0, < 3)
     rails_warden (0.6.0)
       warden (>= 1.2.0)
     railties (7.2.2.2)
@@ -388,6 +413,14 @@ GEM
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sassc-rails (2.1.2)
+      railties (>= 4.0.0)
+      sassc (>= 2.0)
+      sprockets (> 3.0)
+      sprockets-rails
+      tilt
     scss_lint (0.60.0)
       sass (~> 3.5, >= 3.5.5)
     securerandom (0.4.1)
@@ -413,11 +446,23 @@ GEM
       rack (>= 3.1.0)
       redis-client (>= 0.23.2)
     smart_properties (1.17.0)
+    sprockets (4.2.2)
+      concurrent-ruby (~> 1.0)
+      logger
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.5.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      sprockets (>= 3.0.0)
     stimulus-rails (1.3.4)
       railties (>= 6.0.0)
     stringio (3.1.7)
     thor (1.4.0)
+    tilt (2.7.0)
     timeout (0.4.3)
+    turbo-rails (2.0.23)
+      actionpack (>= 7.1.0)
+      railties (>= 7.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
@@ -462,17 +507,19 @@ DEPENDENCIES
   faraday
   image_processing
   jbuilder
-  mysql2
+  mysql2 (~> 0.5.7)
   niftany
   puma (>= 5.0)
   rails (~> 7.2.2, >= 7.2.2.1)
+  rails_admin
   rails_warden (~> 0.6.0)
   redis (>= 4.0.1)
   rspec-rails
   rswag-api
   rswag-specs
   rswag-ui
   rubocop-rails-omakase
+  sassc-rails
   selenium-webdriver
   shakapacker
   shoulda-matchers

app/assets/config/manifest.js

@@ -1,2 +1 @@
-//= link_tree ../images
-//= link_directory ../stylesheets .css
+// No additional asset directories to link

app/models/api_user.rb

@@ -11,6 +11,54 @@ class APIUser < ApplicationRecord
   validates :webhook_endpoint, presence: true
   validates :webhook_endpoint, format: { with: URI::RFC2396_PARSER.make_regexp('https') }
 
+  RailsAdmin.config do |config|
+    config.model 'ApiUser' do
+      list do
+        field :id
+        field :name
+        field :email
+        field :created_at
+        field :updated_at
+      end
+
+      show do
+        field :id
+        field :name
+        field :email
+        field :api_key
+        field :webhook_key
+        field :webhook_endpoint
+        field :created_at
+        field :updated_at
+      end
+
+      edit do
+        field :name
+        field :email
+
+        field :api_key do
+          read_only true
+          help 'API keys are generated automatically'
+        end
+
+        field :webhook_key do
+          read_only true
+          help 'Webhook keys are generated automatically'
+        end
+
+        field :webhook_endpoint
+
+        field :created_at do
+          read_only true
+        end
+
+        field :updated_at do
+          read_only true
+        end
+      end
+    end
+  end
+
   private
 
     def set_keys

app/models/gui_user.rb

@@ -6,4 +6,24 @@ class GUIUser < ApplicationRecord
   has_many :jobs, as: :owner, dependent: :restrict_with_exception
   has_many :pdf_jobs, as: :owner, dependent: :restrict_with_exception
   has_many :image_jobs, as: :owner, dependent: :restrict_with_exception
+
+  RailsAdmin.config do |config|
+    config.model 'GuiUser' do
+      list do
+        field :id
+        field :email
+        field :created_at
+      end
+
+      edit do
+        field :email
+        field :created_at do
+          read_only true
+        end
+        field :updated_at do
+          read_only true
+        end
+      end
+    end
+  end
 end

app/models/job.rb

@@ -14,6 +14,39 @@ def completed?
     status == 'completed'
   end
 
+  RailsAdmin.config do |config|
+    config.model 'Job' do
+      list do
+        field :uuid
+        field :type
+        field :status
+        field :owner_type
+        field :owner_id
+        field :created_at
+        field :finished_at
+      end
+
+      show do
+        field :uuid
+        field :type
+        field :status
+        field :llm_model
+        field :prompt
+        field :alt_text
+        field :source_url
+        field :output_url
+        field :output_object_key
+        field :output_url_expires_at
+        field :processing_error_message
+        field :owner_type
+        field :owner_id
+        field :created_at
+        field :updated_at
+        field :finished_at
+      end
+    end
+  end
+
   private
 
     def broadcast_to_job_channel

app/models/rails_admin.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RailsAdmin.config do |config|
+  config.included_models = [
+    'GuiUser',
+    'ApiUser',
+    'Job'
+  ]
+end

config/initializers/rails_admin.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RailsAdmin.config do |config|
+  config.authenticate_with do
+    unless AdminUserChecker.admin_user?(request)
+      render plain: 'Forbidden', status: :forbidden
+    end
+  end
+
+  config.current_user_method do
+    warden.user
+  end
+end

config/routes.rb

@@ -1,21 +1,22 @@
 # frozen_string_literal: true
 
 require 'sidekiq/web'
-require 'sidekiq_web_constraint'
+require 'admin_user_checker'
 
 Rails.application.routes.draw do
+  mount RailsAdmin::Engine => '/admin', as: 'rails_admin'
   mount ActionCable.server => '/cable'
   mount Rswag::Api::Engine => '/api-docs'
   mount Rswag::Ui::Engine => '/api-docs'
-  mount Sidekiq::Web => '/sidekiq', :constraints => SidekiqWebConstraint.new
+  mount Sidekiq::Web => '/sidekiq', :constraints => ->(req) { AdminUserChecker.admin_user?(req) }
 
   get '/sidekiq', to: ->(_env) {
     [
       401,
       { 'Content-Type' => 'text/plain' },
       ['Unauthorized']
     ]
-  }, constraints: ->(req) { !SidekiqWebConstraint.new.matches?(req) }
+  }, constraints: ->(req) { !AdminUserChecker.admin_user?(req) }
   # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
 
   # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.