WillowSword

A Ruby on Rails engine for the Sword V2 server. The Sword server is currently integrated with Hyrax V2.

The operational version of this code is now on gitlab.bodleian.ox.ac.uk/ORA4/willow_sword, please refer to the documentation there

OLD DOCUMENTATION FOLLOWS

---

43c80615290507143030241d8a84140836681e51

Important note for ORA users

This project uses git flow conventions for code management.

The development branch is still develop, and the release branches are tagged release/ as normal.

New versions will be tagged from v5.0.0

Deployment to ORA4 QA

At present, we have no way to configure that branch used in the ora4.reviewinterface gemfile. Therefore a release into QA should be followed by an update to the ora4-qa-symp gemfile from

gem 'willow_sword', git: 'https://gitlab.bodleian.ox.ac.uk/ORA4/willow_sword', branch: 'develop'

To

gem 'willow_sword', git: 'https://gitlab.bodleian.ox.ac.uk/ORA4/willow_sword', branch: 'working_branch'

(amend 'working_branch' to release/v{release number} as appropriate). And a bundle update and apache reboot should be run.

Installation

Add this line to your application's Gemfile:

gem 'willow_sword', git: 'https://github.com/CottageLabs/willow_sword.git'

And then execute:

$ bundle

Or install it yourself as:

$ gem install willow_sword

Mount the engine. Add this line to config/routes.rb

mount WillowSword::Engine => '/sword'

Configuration

The plugin has a few configuration options. To view the current default options and override these, see configuration options

Enable authorization

If you would like to authorize all Sword requests using an Api-key header, see Enabling authorization

Usage

To use the plugin see usage

Contributing

Contribution directions go here.

License

The gem is available as open source under the terms of the MIT License.