dlingley/My-Alma-Rails-Library

Student Portal application in Ruby on Rails based on Alma APIs

Ex Libris Student Portal Sample App - My Rails Library

Introduction

This is a port of the My Alma Library sample application into Ruby on Rails.

The original application does the following:

• Authentication with Google OAuth
• Library card- displays some basic student information and allow users to update a few key data elements
• Requests- shows a list of the student's requests, and allow the user to cancel them
• Fines & Fees- displays a students's fines, and integrates with PayPal to process fine payment

More information about the integration with PayPal is available in this blog entry.

More information about the original C# app is available in this blog entry.

About the App

The application is written in Ruby on Rails and uses the new Alma APIs described here. As with all demo applications, we include the following disclaimer: in an effort to increase readability and clarity, only minimal error handling has been added.

Installation Instructions

On any machine with Ruby on Rails and Git installed, do the following:

1. Clone this repository: git clone https://github.com/jweisman/my-alma-rails-library.git
2. Install dependencies: bundle install
3. Copy the application.example.yml file to application.yml and replace the placeholder values:

• almaurl from the Alma API Getting Started Guide
• apikey from the Ex Libris Developer Network dashboard
• googleclientid and googleclientsecret from the Google Developer Console

4. Run the application: bin\rails server for WEBrick or bundle exec puma for Puma