Merge pull request #1351 from MITLibraries/tco-66-hints-to-tacos

Replace Hints with Suggested Resources

Author: jazairi

Gemfile

@@ -33,7 +33,7 @@ group :production do
 end
 
 group :development, :test do
-  gem 'pry-rails'
+  gem 'debug', platforms: %i[mri mingw x64_mingw]
   gem 'sqlite3'
 end
 
@@ -49,6 +49,7 @@ group :development do
 end
 
 group :test do
+  gem 'climate_control'
   gem 'minitest-rails'
   gem 'mocha', require: false
   gem 'simplecov', require: false

Gemfile.lock

@@ -104,6 +104,7 @@ GEM
     bootsnap (1.18.3)
       msgpack (~> 1.2)
     builder (3.3.0)
+    climate_control (1.2.0)
     coderay (1.1.3)
     concurrent-ruby (1.3.4)
     crack (1.0.0)
@@ -112,6 +113,9 @@ GEM
     crass (1.0.6)
     dalli (3.2.8)
     date (3.3.4)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     debug_inspector (1.2.0)
     declarative (0.0.20)
     docile (1.4.0)
@@ -178,7 +182,11 @@ GEM
     httpclient (2.8.3)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
     ipaddr_range_set (1.0.0)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     jquery-rails (4.6.0)
       rails-dom-testing (>= 1, < 3)
       railties (>= 4.2.0)
@@ -240,11 +248,8 @@ GEM
       ast (~> 2.4.1)
       racc
     pg (1.5.6)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-rails (0.3.11)
-      pry (>= 0.13.0)
+    psych (5.1.2)
+      stringio
     public_suffix (6.0.0)
     puma (6.4.2)
       nio4r (~> 2.0)
@@ -287,7 +292,11 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
     regexp_parser (2.9.2)
+    reline (0.5.9)
+      io-console (~> 0.5)
     representable (3.2.0)
       declarative (< 0.1.0)
       trailblazer-option (>= 0.1.1, < 0.2.0)
@@ -359,6 +368,7 @@ GEM
       mini_portile2 (~> 2.8.0)
     statsd-ruby (1.5.0)
     stringex (2.8.6)
+    stringio (3.1.1)
     strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -398,7 +408,9 @@ DEPENDENCIES
   better_errors
   binding_of_caller
   bootsnap
+  climate_control
   dalli
+  debug
   dotenv-rails
   flipflop
   google-api-client
@@ -417,7 +429,6 @@ DEPENDENCIES
   net-smtp
   nokogiri
   pg
-  pry-rails
   puma
   rack-attack
   rails (~> 7.0.0)

README.md

@@ -15,25 +15,6 @@ for some of these APIs (see below).
 
 ![alt text](docs/charts/bento_overview.png "Bento system overview chart")
 
-## Loading Hints
-
-Tasks exist to reload hints from supported sources. To reload custom hints in a development environment:
-
-```
-heroku local:run bin/rails reloadhints:custom[https://www.dropbox.com/blah/blah]
-```
-
-To reload custom hints in a heroku environment:
-
-```
-heroku run bin/rails reloadhints:custom['https://www.dropbox.com/blah/blah'] --app your-appname-staging
-```
-
-Depending on your shell, you may need single-quotes around the URL.
-
-This expects to find a world-readable CSV file at the Dropbox location. Instructions for generating that file are in the 
-Google sheet where we gather custom hint metadata.
-
 ## Required Environment Variables
 
 - `ALMA_OPENURL`: base URL for Alma openurls found in CDI records.
@@ -72,6 +53,7 @@ to construct thumbnail URLs.
   - Hints will only be displayed to the user if they are in `HINT_SOURCES`.
 - `LOG_LEVEL`: set log level for development, default is `:debug`
 - `LOG_LIKE_PROD`: uses prod-like logging in development if set
+- `ORIGINS`: sets origins for CORS (currently used only for TACOS API calls).
 - `PLATFORM_NAME`: The value set is added to the header after the MIT Libraries logo. The logic and CSS for this comes from our theme gem.
 - `PRIMO_TIMEOUT`: value to override the 6 second default for Primo timeout.
 - `REQUESTS_PER_PERIOD`: number of requests per time period we allow from a
@@ -82,7 +64,8 @@ to construct thumbnail URLs.
 - `RESULTS_PER_BOX`: defaults to 3
 - `SENTRY_DSN`: logs exceptions to Sentry
 - `SENTRY_ENV`: Sentry environment for the application. Defaults to 'unknown' if unset.
-- `TACOS_URL`: The GraphQL endpoint for the [TACOS](https://github.com/mitlibraries/tacos/) application.
+- `TACOS_URL`: The GraphQL endpoint for the [TACOS API](https://github.com/mitlibraries/tacos/). When set, the
+application will log search terms to TACOS and return suggested resources detected in search terms.
 - `TIMDEX_TIMEOUT`: value to override the 6 second default for TIMDEX timeout.
 
 ### NPS Survey Environment Variables (optional)

app/assets/stylesheets/_hint.scss renamed to app/assets/stylesheets/_suggested_resources.scss

@@ -1,5 +1,5 @@
 
-.hint-box {
+.suggested-resources-box {
   position: relative;
   margin: 1.5% 0;
   box-shadow: 0px 1px 3px rgba($blue, .5);

app/assets/stylesheets/application.scss

@@ -6,6 +6,6 @@
 @import "_bento";
 @import "_search";
 @import "_results";
-@import "_hint";
+@import "_suggested_resources";
 @import "_survey";
 @import "_print";

app/controllers/hint_controller.rb

@@ -0,0 +1,12 @@
+class TacosController < ApplicationController
+  # Calls TACOS API to log search terms and return suggested resources.
+  def suggested_resources
+    # Do nothing unless all required env is set and a query param exists.
+    return if ENV.fetch('TACOS_URL', nil).blank? || ENV.fetch('ORIGINS', nil).blank?
+    return if params[:q].blank?
+
+    response = Tacos.call(params[:q])
+    @suggested_resources = response['data']['logSearchEvent']['detectors']['suggestedResources']
+    render layout: false
+  end
+end