sul-dlss / sul-bento-app

The Bento Application for Stanford Library Search

README

Developer environment

1. To test agaist a local instance of searchworks, point your settings.local.yml to the local instance of SearchWorks.
2. Install Gemfile $ bundle install
3. Install required node modules (requires node be installed) yarn install.
4. Run bin/dev
5. Now, you can visit http://localhost:3000/ for the Bento app

Example of running a search from the Rails console

client = HTTP.timeout(30)
article_search = QuickSearch::ArticleSearcher.new(client, "covid").search
# could also be CatalogSearcher or ExhibitsSearcher
article_search.total # total number of search results
article_search.results.size # total number of results actually returned for display, configurable with NUM_RESULTS_SHOWN in settings.yml
article_search.results[0].title # title of the search
article_search.results[0].link # link to the results

Some of the code in this repository was extracted from NCSU/quick_search.

Copyright 2016 North Carolina State University

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sul-bento-app's Issues

Move 'See all results' button

Split off from #68.

The 'See all results' button is currently at the bottom of results. It should appear in the top left corner of the results module.

[prod] ActionView::Template::Error in quick_search/search # xhr_search

ActionView::Template::Error: undefined local variable or method 'searcher' for #<#<Class:0x000000031d5080>:0x007f5c50ca8308> Did you mean? search_field

_module_heading.html.erb  9  _app_views_quick_search_search__module_heading_html_erb(...)
--

See https://app.honeybadger.io/projects/53517/faults/34759021

Stylin' details for bento (based on -stage 2:12p Friday)

Not sure how much of this is currently WIP in #15

• please use the btn-primary styling from SearchWorks for the see-all-results links. The current link doesn't stand out enough. Note: it was intentional design to have the "see-all" button up at the top next to the header. If it's not possible to move it within the time constraints, okay; regardless, it needs to be much more visible.

• base font size should be 15px. Current 16 so it doesn't match either website nor SW.

• reduce vertical spacing between the elements of each result. Currently individual results are not holding together visually.

• add the "Full text" label styling (see SW) to the full text links in the Articles+ section.

Bento results layout and content

Create and configure google_analytics_tracking_id

We need to create and configure a google_analytics_tracking_id in quick_search_config.yml for production.

Add "more search tools" to homepage

Add "More search tools" section

Forward user IP through requests to SearchWorks

Currently the IP address of the bento app is what is executing the request which means that it will always get non-guest mode results.

Remove curly brace and "Search all" from homepage

• @jvine has requested that we suppress the bracket SVG for now.
• "Search all" heading and "About this search tool" link provided by QuickSearch should be removed

Screenshot

Add the "Your search also found..." text/link in catalog bento

Correct order of blocks in bento results

Order of blocks should be:
1 catalog
2 articles
3 website
4 yewno

(Current version has articles first.)

Disable (or replace) the QuickSearch about page

As far as I can tell, this page isn't linked to from our homepage or results pages, but it's directly accessible here:

https://bento-stage.stanford.edu/all/about

add breadcrumbs to search results where available

Breadcrumbs are available on the library website and the mockups have them showing

Update details returned for article results

• the record's abstract is currently returned
• should return: composed title
• links? --> maybe split that into another ticket

implement library website searcher with new JSON endpoint

The Chapter 3 implementation of a JSON endpoint for library website searches is now in stage:

https://library-stage.stanford.edu/bento?keys=climate%20change

development environment: why is eager_load needed?

without eager_load turned on in development, constant loading hangs the app. so development.rb and test.rb both have eager_load turned on.

Update no results experience

It looks like maybe there are links rendered that are intended to be shown at different screen sizes (via foundation) but they are both showing now.

Change bento section title from "article" to "articles+"

Split off from SearchWorks #1643

Add Stanford Libraries header to layout

Feedback link split off to #42

Replace header provided by quick_search-generic_theme with Stanford branded header

Write a search class to fetch library website results

The library website search is backed by a solr instance in our solr cloud.

Not sure if there is any API made available to get search results from Drupal, may be worth investigating.

Display facet data for bento results

Allow the display of facet data (from a particular facet for each source) in the bento search results interface.

add "Found n topic-databases"

for catalog results -- see #15 for mockups

library website faceting query not working

We are sending a Blacklight-ish facet query rather than the Drupal style:

f%5Bdocument_type_facet%5D%5B%5D=Guide

instead of:

f[0][0]=Guide&f[1]=type%3Asubject

Code organization: move scss modules into app/assets/stylesheets/moduels

Visual design/branding for Bento home

tbd

Add a Yewno embed

This is similar to what's already on the library bento page (possibly small JS drop-in?)

Add "bento insert" to catalog and articles+ results

Insert a summary version of the bento in article & catalog results as another way to lead users between the main targets.

[sul-bento-app/prod] ActionView::Template::Error: undefined method `text' for nil:NilClass

Backtrace

line 28 of [PROJECT_ROOT]/app/services/library_website_search_service.rb: block in results
line 25 of [PROJECT_ROOT]/app/services/library_website_search_service.rb: collect
line 25 of [PROJECT_ROOT]/app/services/library_website_search_service.rb: results

View full backtrace and more info at honeybadger.io

Set up a repo for a SUL quick_search theme

https://github.com/ncsu-libraries/quick_search-generic_theme

Handle "No results" for each bento search

Each bento search should display the following when no results are found:

replace search placeholder text

Our homepage searchbar currently displays "Search all the things!", (inherited from quick_search-generic_theme) as placeholder text.

Possible solutions:
(1) No placeholder text (shown in mockups)
(2) description text in SearchWorks is "catalog, articles, website, & more in one search"

Opinions, @jvine?

Current

Add Stanford global footer to layout

Replace the footer provided by quick_search-generic_theme with the Stanford global footer

Adjust styling for records

• add description text beneath module title
• put record title inline with <ol> number
• reduce font size of record title

Mockup

Current

Allow for bento panels to be loaded asynchronously

It appears that the best-bets result is the only one that is loaded asynchronously. We'll likely want all of our panels to be loaded asynchronously for speed/efficiency purposes.

Style jump-to links

• ignore bracket image
• restyle current jump-to links (e.g. SearchWorks articles, SearchWorks catalog)
• add Yewno link
  

Display total counts of various bento boxes

Remove the quick search backend

javascript errors calling foundation

Uncaught TypeError: $(...).foundation is not a function
    at HTMLDocument.<anonymous> (quick_search_generic_theme.self-f86edabee359830edeb94bd93b23bf087c8d9d70b760a32424c9a7a27aedd3d8.js?body=1:15)
    at fire (jquery.self-bd7ddd393353a8d2480a622e80342adf488fb6006d667e8b42e4c0073393abee.js?body=1:3233)
    at Object.fireWith [as resolveWith] (jquery.self-bd7ddd393353a8d2480a622e80342adf488fb6006d667e8b42e4c0073393abee.js?body=1:3363)
    at Function.ready (jquery.self-bd7ddd393353a8d2480a622e80342adf488fb6006d667e8b42e4c0073393abee.js?body=1:3583)
    at HTMLDocument.completed (jquery.self-bd7ddd393353a8d2480a622e80342adf488fb6006d667e8b42e4c0073393abee.js?body=1:3618)

Add dejavu font to result titles

Dejavu needs to be imported and added to the stylesheets. In SearchWorks, we use Dejavu for record titles because it handles diacritics etc. better than Source Sans Pro.

Add feedback form

The current Feedback link is a dummy link. We'll need something similar to SearchWorks.

Write a searcher class to fetch EDS results

We could use the ebsco-eds gem as part of the searcher (which would make a useful gem for anybody else using both EBSCO and our chosen bento framework).

However; we could also use the SearchWorks json endpoint which might greatly reduce the scope and complexity for completing this (given that we'll most likely want to have something similar for catalog results anyway).

One consideration here would be how guest vs. non-guest will work from the bento app. If we're using a ruby class to issue the search to the Blacklight API, then the request's IP address will be that of the bento application itself and not the user.

Write a searcher class to fetch SearchWorks catalog results

Not sure if we'll need multiple here or not. The current bento implementation does two API requests against SearchWorks: one for catalog results and one restricted to just databases (check the design-docs to see if the same is true).

Text/heading cleanup in bento to match SW

• all <h4> headings should be <h3>
• remove "Covers ~87% of our subscribed databases." from the Articles+ blurb
• link "topic-specific databases" in the Catalog blurb to https://searchworks.stanford.edu/databases

Fix/Consolidate sul-variables / bootstrap variables import

Currently we can't take advantage of BS mixins or overriding BS variables that are in bootstrap-variables.scss. We should fix this to do better global overrides.

Additional Yewno module styling

• black border to differentiate it from Stanford services
• Link text should be a button below embedded viewer
• Subtitle "Explore relationships among concepts"

Can we switch search-btn class for btn-sul ? (use the mixin)?

Add feedback form related javascript

A port of SearchWorks javascript plugin was unsuccessful. We need to write (rewrite) for sul-bento to do the following:

• set viewport and agent https://github.com/sul-dlss/SearchWorks/blob/master/app/assets/javascripts/feedback_form.js#L40-L41
• submit form and render flash https://github.com/sul-dlss/SearchWorks/blob/master/app/assets/javascripts/feedback_form.js#L45-L57
• replace links for buttons https://github.com/sul-dlss/SearchWorks/blob/master/app/assets/javascripts/feedback_form.js#L81-L97
• add focus to message https://github.com/sul-dlss/SearchWorks/blob/master/app/assets/javascripts/feedback_form.js#L119-L122
• update reporting from field https://github.com/sul-dlss/SearchWorks/blob/master/app/assets/javascripts/feedback_form.js#L115-L117

Add rspec & TravisCI build

[sul-bento-app/prod] AbstractSearchService::NoResults: AbstractSearchService::NoResults

Backtrace

line 127 of [PROJECT_ROOT]/app/services/abstract_search_service.rb: search
line 6 of [PROJECT_ROOT]/app/searchers/quick_search/article_searcher.rb: search

View full backtrace and more info at honeybadger.io

Proxy - coordinate website/Drupal tasks with Bento implementation

Just to keep track of the Drupal tasks associated with getting the Bento connected:

• send searches from home page main search box to bento
• send searches from banner search box (on all pages) to bento
• rename content types
• exclude some content types from search (hero image, feature image...)
• reconfigure SOLR settings and reindex (?)