Franklin Forms

Franklin Forms is a Rails app that provides various forms and interfaces to patrons for making requests, asking for help from staff, and viewing information on resource sharing.

Dependencies

• Ruby 2.3.1
• Rails 5
• Docker
• Docker Compose

Additional dependencies for running the app w/o Docker

• libaio1
• Oracle Instant Client 12.1
• FreeTDS
• JS runtime (e.g., nodejs)

Installation

1. Clone the repository.
2. Copy .env.example to .env.
3. Open .env set the values for each variable. Each variable is documented in the file.

When installing gems, you may need to set an additional environment variable for LD_LIBRARY_PATH that points to the location of your install of the Oracle Instant Client (e.g., /opt/oracle/instantclient_12_1).

Now you can run the Rails server to access the forms or execute the following to run the forms with Docker:

If you see Warning: NLS_LANG is not set. fallback to US7ASCII., you cna silence that by setting an environment variable NLS_LANG=AMERICAN_AMERICA.AL32UTF8

docker-compose up .

Deployment

Execute the following commands to create the Docker image and push it to the local Docker hub:

docker build -t indexing-dev.library.upenn.int:5000/upenn-libraries/franklinforms:master .
docker push indexing-dev.library.upenn.int:5000/upenn-libraries/franklinforms:master

Development

To set up a development environment you first need to export your local UID/GID as new variables (CURRENT_UID and CURRENT_GID):

export CURRENT_UID=$(id -u)
export CURRENT_GID=$(id -g)

Then run the dockerized dev environment:

docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d

Any changes made to the files in your local directory will be reflected within the container.

Paths

Franklin Forms has two top-level paths:

• /redir: Most forms are initially linked under this path and are redirected to an analagous path under /forms or an external service such as Ares or Aeon. This is done when additional information needs to be retrieved before handling the request, such as referrer information or OpenURL data. "Need Help?" is linked here and does not redirect.
• /forms: Most form requests end up under this path. The resource sharing page is also under here.

Forms / Interfaces

Franklin Forms provides the following request options and interfaces:

Option	Notes
Books by Mail	appears in fulfillment iframe and on Services page
FacultyEXPRESS	appears in fulfillment iframe and on Services page
Fix OPAC Request	appears in fulfillment iframe and on Services page
ILL	appears in fulfillment iframe and on Services page
Need Help?	appears on Services page
Place on Course Reserve	appears in fulfillment iframe and on Services page
Request Enhanced Cataloging	appears in fulfillment iframe and on Services page
Request to View	appears in Franklin
Resource Sharing	appears in Franklin and library website

Integration Points

Franklin Forms operates with the following services:

Service	Notes
Aeon	for requesting to view special collection titles
Alma	for retrieving bibliographic information
Ares	for placing course reserves
BorrowDirect+	for Relais authentication and linking to search interface
ILLiad	for placing various requests; interacts directly w/database and simulates browser activity
Penn Community	for retrieving patron information

Auditing Secrets

You can use Gitleaks to check the repository for unencrypted secrets that have been committed.

docker run --rm --name=gitleaks -v $PWD:/code quay.io/upennlibraries/gitleaks:v1.23.0 -v --repo-path=/code --repo-config

Any leaks will be logged to stdout. You can add the --redact flag if you do not want to log the offending secrets.