Merge pull request #96 from TAMULib/spotlight-operational-sprint-staging

tamu-sad-iii · web-flow · commit 01223b9c7940 · 2024-07-10T10:59:46.000-05:00
Spotlight Operational Sprint
diff --git a/.gitignore b/.gitignore
@@ -39,7 +39,3 @@
 /yarn-error.log
 yarn-debug.log*
 .yarn-integrity
-
-~
-$(rbenv root)
-.env*
diff --git a/.ruby-version b/.ruby-version
@@ -1 +1 @@
-3.1.4
+3.1.6
diff --git a/Gemfile b/Gemfile
@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '3.1.4'
+ruby '3.1.6'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6.1'
@@ -51,13 +51,12 @@ gem 'tzinfo-data'
 
 gem 'pg'
 
-gem 'devise_ldap_authenticatable'
+gem 'devise_saml_authenticatable'
 
 gem 'tinymce-rails'
 
-gem 'blacklight', '~> 7.35'
-# gem 'blacklight-spotlight', github: 'projectblacklight/spotlight', branch: 'main'
-gem 'blacklight-spotlight', '~> 3.3', '>= 3.3.0'
+gem 'blacklight', ' ~> 7.0'
+gem 'blacklight-spotlight', ' ~> 3.0.3'
 group :development, :test do
   gem 'solr_wrapper', '>= 0.3'
 end
@@ -70,12 +69,10 @@ gem 'devise'
 gem 'devise-guests', '~> 0.6'
 gem 'coffee-rails', '~> 4.2'
 gem 'uglifier', '>= 1.3.0'
-gem 'terser', '~> 1.1', '>= 1.1.19'
 gem 'friendly_id'
 gem 'sitemap_generator'
-gem 'blacklight-gallery', '~> 3.5'
-gem 'blacklight-oembed', '~> 1.1', '>= 1.1.1'
+gem 'blacklight-gallery', '~> 1.1'
+gem 'blacklight-oembed', '~> 1.0'
 gem 'devise_invitable'
-gem 'mimemagic', github: 'mimemagicrb/mimemagic', ref: '01f92d86d15d85cfd0f20dabd025dcbd36a8a60f'
-gem 'psych', '~> 3.3', '>= 3.3.4'
-gem 'sir_trevor_rails', '~> 0.6.1'
+
+gem 'psych', '~> 3.1'
diff --git a/app/models/search_builder.rb b/app/models/search_builder.rb
@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 class SearchBuilder < Blacklight::SearchBuilder
   include Blacklight::Solr::SearchBuilderBehavior
-
-  include Spotlight::AccessControlsEnforcementSearchBuilder
+  include Spotlight::SearchBuilder
 
   ##
   # @example Adding a new step to the processor chain
diff --git a/app/models/user.rb b/app/models/user.rb
@@ -6,7 +6,7 @@ class User < ApplicationRecord
 
   # Include default devise modules. Others available are:
   # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
-  devise :invitable, :ldap_authenticatable, :rememberable, :validatable
+  devise :invitable, :saml_authenticatable, :rememberable, :validatable
 
   # Method added by Blacklight; Blacklight uses #to_s on your
   # user class to get a user-displayable login/identifier for
diff --git a/app/views/shared/_footer.html.erb b/app/views/shared/_footer.html.erb
@@ -7,7 +7,7 @@
         <li class="list-inline-item"><%= link_to "Off-Campus Access", "https://library.tamu.edu/services/tech_troubleshooting.html" %></li>
         <li class="list-inline-item"><%= link_to "Texas A&M University", "https://www.tamu.edu" %></li>
         <li class="list-inline-item"><%= link_to "Site Policies", "https://library.tamu.edu/about/compliance.html" %></li>
-        <li class="list-inline-item"><%= link_to "Texas CREWS", "http://www.thecb.state.tx.us/apps/txcrews" %></li>
+        <li class="list-inline-item"><%= link_to "Texas CREWS", "https://txcrews.org/" %></li>
         <li class="list-inline-item"><%= link_to "Accessibility", "https://askus.library.tamu.edu/faq/229193" %></li>
         <li class="list-inline-item"><%= link_to "Comments", "https://askus.library.tamu.edu/contact/index" %></li>
         <li class="list-inline-item"><%= link_to "Copyright", "https://tamu.libwizard.com/id/92fdfdec4a3227642e99d2a56f7755f8" %></li>
diff --git a/babel.config.js b/babel.config.js
@@ -1,9 +1,9 @@
 module.exports = function(api) {
-  var validEnv = ['development', 'test', 'production']
-  var currentEnv = api.env()
-  var isDevelopmentEnv = api.env('development')
-  var isProductionEnv = api.env('production')
-  var isTestEnv = api.env('test')
+  var validEnv = ['development', 'test', 'production'];
+  var currentEnv = api.env();
+  var isDevelopmentEnv = api.env('development');
+  var isProductionEnv = api.env('production');
+  var isTestEnv = api.env('test');
 
   if (!validEnv.includes(currentEnv)) {
     throw new Error(
@@ -12,7 +12,7 @@ module.exports = function(api) {
         '"test", and "production". Instead, received: ' +
         JSON.stringify(currentEnv) +
         '.'
-    )
+    );
   }
 
   return {
@@ -21,9 +21,9 @@ module.exports = function(api) {
         '@babel/preset-env',
         {
           targets: {
-            node: 'current'
-          }
-        }
+            node: 'current',
+          },
+        },
       ],
       (isProductionEnv || isDevelopmentEnv) && [
         '@babel/preset-env',
@@ -32,9 +32,9 @@ module.exports = function(api) {
           useBuiltIns: 'entry',
           corejs: 3,
           modules: false,
-          exclude: ['transform-typeof-symbol']
-        }
-      ]
+          exclude: ['transform-typeof-symbol'],
+        },
+      ],
     ].filter(Boolean),
     plugins: [
       'babel-plugin-macros',
@@ -44,29 +44,41 @@ module.exports = function(api) {
       [
         '@babel/plugin-proposal-class-properties',
         {
-          loose: true
-        }
+          loose: true,
+        },
       ],
       [
         '@babel/plugin-proposal-object-rest-spread',
         {
-          useBuiltIns: true
-        }
+          useBuiltIns: true,
+        },
       ],
       [
         '@babel/plugin-transform-runtime',
         {
           helpers: false,
           regenerator: true,
-          corejs: false
-        }
+          corejs: false,
+        },
       ],
       [
         '@babel/plugin-transform-regenerator',
         {
-          async: false
-        }
-      ]
-    ].filter(Boolean)
-  }
-}
+          async: false,
+        },
+      ],
+      [
+        '@babel/plugin-transform-private-methods',
+        {
+          loose: true,
+        },
+      ],
+      [
+        '@babel/plugin-transform-private-property-in-object',
+        {
+          loose: true,
+        },
+      ],
+    ].filter(Boolean),
+  };
+};
diff --git a/config/application.rb b/config/application.rb
@@ -9,6 +9,9 @@
 module TamuSpotlight
   class Application < Rails::Application
     config.action_mailer.default_url_options = { host: "localhost:4200", from: "noreply@example.com" }
+
+    config.active_record.use_yaml_unsafe_load = true
+
     # Initialize configuration defaults for originally generated Rails version.
     config.load_defaults 6.0
 
diff --git a/config/attribute-map.yml b/config/attribute-map.yml
@@ -0,0 +1,3 @@
+# attribute-map.yml
+"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "user_name"
+"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "email"
diff --git a/config/database.yml b/config/database.yml
@@ -25,7 +25,7 @@ production:
   encoding: <%= ENV['DATABASE_ENCODING'] || "unicode" %>
   database: <%= ENV['DATABASE_NAME'] || "spotlight" %>
   pool:     <%= ENV['DATABASE_POOL'] || 5 %>
-  username: <%= ENV['DATABASE_USERNAME'] || "spotlight_user" %>
+  username: <%= ENV['DATABASE_USERNAME'] || "spotlight" %>
   password: <%= ENV['DATABASE_PASSWORD'] || "spotlight" %>
   host:     <%= ENV['DATABASE_HOST'] || "localhost" %>
   port:     <%= ENV['DATABASE_PORT'] || 5432 %>
diff --git a/config/environments/production.rb b/config/environments/production.rb
@@ -24,11 +24,7 @@
 
   # Compress CSS using a preprocessor.
   # config.assets.css_compressor = :sass
-
-  config.assets.css_compressor = nil
-
-  # config.assets.js_compressor = Uglifier.new(harmony: true)
-  config.assets.js_compressor = :terser
+  config.assets.js_compressor = :uglifier
 
   # Do not fallback to assets pipeline if a precompiled asset is missed.
   config.assets.compile = false
diff --git a/config/initializers/devise.rb b/config/initializers/devise.rb
@@ -10,10 +10,6 @@
 # Many of these configuration options can be set straight in your model.
 Devise.setup do |config|
 
-  config.ldap_logger = true ## Enable logging LDAP Query
-  config.ldap_create_user = true  ## All valid AD users can log in and automatically create user records.
-  config.ldap_update_password = false  ## Make sure that password change is not written back to AD.
-  config.ldap_use_admin_to_bind = true  ## Use Administrator in bind at the time of LDAP authentication.
   config.authentication_keys = [:email]  ## Key used for authentication.
   config.case_insensitive_keys = [:email]  ## Does not distinguish case of key
   config.strip_whitespace_keys = [:email]  ## Delete the blanks contained in the key
@@ -236,7 +232,7 @@
 
   # ==> Configuration for :validatable
   # Range for password length.
-  config.password_length = 6..128
+  # config.password_length = 6..128
 
   # Email regex used to validate email formats. It simply asserts that
   # one (and only one) @ exists in the given string. This is mainly
@@ -282,7 +278,7 @@
   # Time interval you can reset your password with a reset password key.
   # Don't put a too small interval or your users won't have the time to
   # change their passwords.
-  config.reset_password_within = 6.hours
+  # config.reset_password_within = 6.hours
 
   # When set to false, does not sign a user in automatically after their password is
   # reset. Defaults to true, so a user is signed in automatically after a reset.
@@ -366,4 +362,97 @@
   # When set to false, does not sign a user in automatically after their password is
   # changed. Defaults to true, so a user is signed in automatically after changing a password.
   # config.sign_in_after_change_password = true
+
+  # ==> Configuration for :saml_authenticatable
+
+  # Create user if the user does not exist. (Default is false)
+  # Can also accept a proc, for ex:
+  # Devise.saml_create_user = Proc.new do |model_class, saml_response, auth_value|
+  #  model_class == Admin
+  # end
+  config.saml_create_user = true
+
+  # Update the attributes of the user after a successful login. (Default is false)
+  # Can also accept a proc, for ex:
+  # Devise.saml_update_user = Proc.new do |model_class, saml_response, auth_value|
+  #  model_class == Admin
+  # end
+  config.saml_update_user = true
+
+  # Lambda that is called if Devise.saml_update_user and/or Devise.saml_create_user are true.
+  # Receives the model object, saml_response and auth_value, and defines how the object's values are
+  # updated with regards to the SAML response. 
+  # config.saml_update_resource_hook = -> (user, saml_response, auth_value) {
+  #   saml_response.attributes.resource_keys.each do |key|
+  #     user.send "#{key}=", saml_response.attribute_value_by_resource_key(key)
+  #   end
+  #
+  #   if (Devise.saml_use_subject)
+  #     user.send "#{Devise.saml_default_user_key}=", auth_value
+  #   end
+  #
+  #   user.save!
+  # }
+
+  # Lambda that is called to resolve the saml_response and auth_value into the correct user object.
+  # Receives a copy of the ActiveRecord::Model, saml_response and auth_value. Is expected to return
+  # one instance of the provided model that is the matched account, or nil if none exists.
+  # config.saml_resource_locator = -> (model, saml_response, auth_value) {
+  #   model.find_by(Devise.saml_default_user_key => auth_value)
+  # }
+
+  # Set the default user key. The user will be looked up by this key. Make
+  # sure that the Authentication Response includes the attribute.
+  config.saml_default_user_key = :email
+
+  # Optional. This stores the session index defined by the IDP during login.  If provided it will be used as a salt
+  # for the user's session to facilitate an IDP initiated logout request.
+  config.saml_session_index_key = :session_index
+
+  # You can set this value to use Subject or SAML assertion as info to which email will be compared.
+  # If you don't set it then email will be extracted from SAML assertion attributes.
+  # config.saml_use_subject = true
+
+  # You can implement IdP settings with the options to support multiple IdPs and use the request object by setting this value to the name of a class that implements a ::settings method
+  # which takes an IdP entity id and a request object as arguments and returns a hash of idp settings for the corresponding IdP.
+  # config.idp_settings_adapter = "MyIdPSettingsAdapter"
+  config.idp_settings_adapter = nil
+
+  # You provide you own method to find the idp_entity_id in a SAML message in the case of multiple IdPs
+  # by setting this to the name of a custom reader class, or use the default.
+  # config.idp_entity_id_reader = "DeviseSamlAuthenticatable::DefaultIdpEntityIdReader"
+
+  # You can set the name of a class that takes the response for a failed SAML request and the strategy,
+  # and implements a #handle method. This method can then redirect the user, return error messages, etc.
+  # config.saml_failed_callback = "MySamlFailedCallbacksHandler"
+
+  # You can customize the named routes generated in case of named route collisions with
+  # other Devise modules or libraries. Set the saml_route_helper_prefix to a string that will
+  # be appended to the named route.
+  # If saml_route_helper_prefix = 'saml' then the new_user_session route becomes new_saml_user_session
+  # config.saml_route_helper_prefix = 'saml'
+
+  # You can add allowance for clock drift between the sp and idp.
+  # This is a time in seconds.
+  # config.allowed_clock_drift_in_seconds = 0
+
+  # In SAML responses, validate that the identity provider has included an InResponseTo
+  # header that matches the ID of the SAML request. (Default is false)
+  # config.saml_validate_in_response_to = false
+
+  config.saml_sign_out_success_url = ENV['SAML_SP_ENTITY_ID'] || "http://localhost:3000"
+
+  # Configure with your SAML settings (see ruby-saml's README for more information: https://github.com/onelogin/ruby-saml).
+  config.saml_configure do |settings|
+    settings.assertion_consumer_service_url     = ENV['SAML_ASSERTION_CONSUMER_SERVICE_URL'] || "http://localhost:3000/users/saml/auth"
+    settings.assertion_consumer_service_binding = ENV['SAML_ASSERTION_CONSUMER_SERVICE_BINDING'] || "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
+    settings.issuer                             = ENV['SAML_ISSUER'] || "http://localhost:3000/users/saml/metadata"
+    settings.name_identifier_format             = ENV['SAML_NAME_IDENTIFIER_FORMAT'] || "urn:oasis:names:tc:SAML:2.0:nameid-format:transient"
+    settings.sp_entity_id                       = ENV['SAML_SP_ENTITY_ID'] || "http://localhost:3000"
+    settings.authn_context                      = ENV['SAML_AUTHN_CONTEXT'] || "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"
+    settings.idp_slo_service_url                = ENV['SAML_IDP_SLO_SERVICE_URL'] || "https://login.microsoftonline.com/68f381e3-46da-47b9-ba57-6f322b8f0da1/saml2"
+    settings.idp_sso_service_url                = ENV['SAML_IDP_SSO_SERVICE_URL'] || "https://login.microsoftonline.com/68f381e3-46da-47b9-ba57-6f322b8f0da1/saml2"
+    settings.idp_cert_fingerprint               = ENV['SAML_IDP_CERT_FINGERPRINT'] || "00:A1:2B:3C:44:55:6F:A7:88:CC:DD:EE:22:33:44:55:D6:77:8F:99"
+    settings.idp_cert_fingerprint_algorithm     = ENV['SAML_IDP_CERT_FINGERPRINT_ALGORITHM'] || "http://www.w3.org/2000/09/xmldsig#sha1"
+  end
 end
diff --git a/config/initializers/sir_trevor_rails.rb b/config/initializers/sir_trevor_rails.rb
@@ -7,11 +7,4 @@ def self.custom_block_types
     # You can define your custom block types directly here or in your engine config.
     Spotlight::Engine.config.sir_trevor_widgets
   end
-  
-  def self.from_hash(hash, parent = nil)
-    hash = hash.deep_dup.with_indifferent_access
-    type_klass(hash).new(hash, parent)
-  end
-
-
 end
diff --git a/config/webpack/development.js b/config/webpack/development.js
@@ -1,7 +1,5 @@
 process.env.NODE_ENV = process.env.NODE_ENV || 'development'
 
-import { toWebpackConfig } from './environment'
-// const environment = require('./environment')
+const environment = require('./environment')
 
-export default toWebpackConfig()
-// module.exports = environment.toWebpackConfig()
+module.exports = environment.toWebpackConfig()
diff --git a/config/webpacker.yml b/config/webpacker.yml
@@ -53,7 +53,7 @@ development:
   compile: true
 
   # Verifies that correct packages and versions are installed by inspecting package.json, yarn.lock, and node_modules
-  check_yarn_integrity: false
+  check_yarn_integrity: true
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
diff --git a/db/migrate/20240625133800_add_session_index_to_users.rb b/db/migrate/20240625133800_add_session_index_to_users.rb
@@ -0,0 +1,5 @@
+class AddSessionIndexToUsers < ActiveRecord::Migration[6.1]
+  def change
+    add_column :users, :session_index, :string
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
@@ -372,6 +372,7 @@
     t.integer "invited_by_id"
     t.integer "invitations_count", default: 0
     t.string "remember_token"
+    t.string "session_index"
     t.index ["email"], name: "index_users_on_email", unique: true
     t.index ["invitation_token"], name: "index_users_on_invitation_token", unique: true
     t.index ["invitations_count"], name: "index_users_on_invitations_count"
diff --git a/package.json b/package.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# attribute-map.yml`
	`2`	`+"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "user_name"`
	`3`	`+"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "email"`