ruby

Remote-LibLouis

Remote-LibLouis is a Sinatra HTTP service written in Ruby that lets you interact with LibLouisXML remotely as a REST service.

Installation

System Requirements

Running the Ruby remote translation service requires a system with Ruby and Ruby gems installed. Most modern UNIX systems have Ruby already installed by default or have packages that make installation easy.

We have tested the service with Ruby 2.0 and 1.9. Earlier versions of Ruby may pose problems. We suggest upgrading to Ruby 2.0.

The installation section assumes that you are installing on an Ubuntu system. You may need to modify the package names and commands to fit your system.

$ sudo apt-get install ruby rubygems

Install LibLouis

Your system must have LibLouis installed (specifically the version that contains file2brl).

$ sudo apt-get install liblouisutdml-bin

Clone the GitHub Repository

You will need a copy of this repository.

$ sudo apt-get install git
$ git clone https://github.com/umd-mith/braille.git

Install Remote-LibLouis

In the directory containing the Gemfile, you will want to run the bundler to install needed Ruby gems:

• sinatra
• json
• tempfile
• unicorn

$ cd braille/remote-liblouis/ruby
$ sudo bundle install

Run Remote-LibLouis

In the same directory where you ran the bundle command, you can start the translation service using unicorn:

$ unicorn -p 1234

Replace "1234" with the port number that you wish to use for the REST service.

Configure the WordPress Braille Plugin

When using this service as the remote LibLouis service for the Braille WordPress plugin, use the braille.json endpoint.

Changelog

Version 1.0

• Inclusion of a JSON endpoint for the service; additional tweaks to the documentation and code documentation.

Version 0.9

• Initial version of the service available for beta testing

License

Remote-LibLouis is released under the MIT Open Source License.