blacklight_alma

KO | EN

gitlite — search

#markdown #html #react #ai-agents #ai #list #tensorflow #self-hosted #awesome #privacy

blacklight_alma

(★ 8)

Blacklight integration with Alma

File Explorer

ZIP Download

- - blacklight_alma_helper.rb
- rails
- routes.rb
- - availability_api.rb
  - base_api.rb
  - bibs_api.rb
  - engine.rb
  - users_api.rb
  - version.rb
- - blacklight_alma_tasks.rake
- blacklight_alma.rb
- bibs.wadl
- users.wadl
.gitignore
blacklight_alma.gemspec
Gemfile
LICENSE
Rakefile
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[Blacklight](https://github.com/projectblacklight/blacklight)
integration with [Alma](https://developers.exlibrisgroup.com/alma),
the library resource management system from Ex Libris.

Features: loading real-time availability information via AJAX using
the Alma API; fulfillment iframe rendering; single sign-on (SSO) and
social auth integration with Devise.

This gem is designed to be minimally invasive, making available code
that your project must choose to use.

# How to use this

Include this in your app's Gemfile.

```ruby
gem 'blacklight_alma', :git => 'https://github.com/upenn-libraries/blacklight_alma.git'
```

For the features below to work, you'll need to set the following
environment variables:

```
ALMA_DELIVERY_DOMAIN = hostname of alma instance
ALMA_INSTITUTION_CODE = institution code
ALMA_API_KEY = api key
ALMA_AUTH_SECRET = used for social auth, copy the value from Alma configuration
```

# Features

## Availability via AJAX

This feature allows you to populate HTML elements with availability
status by loading that information via AJAX.

Edit your `application.js` file to include the js library for the
BlacklightAlma object:

```
//= require blacklight_alma/blacklight_alma
```

Add a `#alma_mms_id` method to your `SolrDocument` class if the
document's id field is different from the Alma MMS ID. Add a
`#alma_availability_mms_ids` method for the availability API.

```
class SolrDocument
  # ...
  
  # used by blacklight_alma
  def alma_mms_id
    fetch('alma_mms_id', nil)
  end

# returns an array of IDs to query through API to get holdings 
  # for this document. This is usually just the alma MMS ID for
  # this bib record, but in the case of boundwith records, we return 
  # the boundwith IDs, because that's where Alma stores the holdings.
  def alma_availability_mms_ids
    fetch('bound_with_ids', [alma_mms_id]])
  end

end
```

Create or edit your project's `/app/helpers/catalog_helper.rb` to get BlacklightAlma 
overrides:

```ruby
module CatalogHelper
  include Blacklight::CatalogHelperBehavior
  include BlacklightAlma::CatalogOverride
end
```

Create a new js file in your project containing these lines so that
the availability code is triggered on page load.

```javascript
$(document).ready(function() {
    var ba = new BlacklightAlma();
    ba.loadAvailability();
});
```

Use the `BlacklightAlma::Availability` concern in an existing
controller, create a new controller using it, or use the stock
`BlacklightAlma::AlmaController`. If you choose the last option,
remember to add it to your `routes.rb` file, like so:

```
scope module: 'blacklight_alma' do
  get 'alma/availability' => 'alma#availability'
end
```

In your view (typically `_index_default.html.erb`), add the HTML
classes and attributes needed to trigger status loading via AJAX.

```html
<dl class="document-metadata dl-horizontal dl-invert">
   
  <dt class="blacklight-availability">Status/Location:</dt>
  <dd class="blacklight-availability availability-ajax-load" data-availability-ids="<%= document.alma_availability_mms_ids.join(',') %>">Loading...</dd>
  <dt class="availability-show-on-ajax-load hide"></dt>
  <dd class="availability-show-on-ajax-load hide">
    <button class="btn btn-default availability-toggle-details" data-show-text="Show Availability Details" data-hide-text="Hide Availability Details">Show Availability Details</button>
  </dd>
</dl>

<div class="availability-details-container" data-availability-iframe-url="<%= alma_app_fulfillment_url(document) %>"></div>
```

## Fulfillment iframe

Add a `#alma_mms_id` method to your `SolrDocument` class if the
document's id field is different from the Alma MMS ID. See above.

Add something like this to your show view (`_show_default.html.erb`, usually):

```html
  <iframe src="<%= alma_app_fulfillment_url(document) %>" style="width: 100%"></iframe>
```

## SSO and Social Login

See this [page](https://developers.exlibrisgroup.com/alma/integrations/discovery/fulfillment_services)
and this [blog post](https://developers.exlibrisgroup.com/blog/Leveraging-Social-Login-with-Alma) 
for information about how to implement SSO and Alma's social login feature.

This gem can integrate these services with Devise.

In your project, create a subclass of `Devise::SessionsController` if you don't already have one. If you do,
then just include the `BlacklightAlma::SocialLogin` and/or `BlacklightAlma::Sso` modules, as appropriate.
See the code for things you can override.

```ruby
class SessionsController < Devise::SessionsController
  include BlacklightAlma::SocialLogin
  include BlacklightAlma::Sso
end
```

Modify your `routes.rb` file as follows:

```ruby
# tell devise to use your SessionsController
devise_for :users, controllers: { sessions: 'sessions' }

# set up routes for the callbacks, which are needed for the
# alma_social_login_url helper to work
devise_scope :user do
  get 'alma/social_login_callback' => 'sessions#social_login_callback'
  get 'alma/sso_login_callback' => 'sessions#sso_login_callback'
end
```

Create your HTML links to login using SSo or social login.

```html
<a href="<%= alma_social_login_url %>">Login using a Google account</a>
```

blacklight_alma

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

blacklight_alma

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README