Background

The provided framework codebase is a minimal framework for both Jangle core and a framework and template for Jangle connectors written in Ruby.

It is meant to provide an example for other language implementations, a baseline of Jangle functionality and a simple way to get started. It is not meant to be optimized for performance, secure or intended for a production environment (although it could be probably used in one, that's not the focus of the current codebase).

Installing

At the very least you will need a modern Ruby (1.8.5 or greater) and Rubygems. There are plenty of ways to get this, depending on your architecture. The Ruby on Rails site provides good links for that. Don't worry about installing Rails (it's not needed).

Once Ruby and Gem are installed, you will need to install a handful of gems to get Jangle running.

To install gems in Unix/Linux/Mac OSX: Open a terminal and type: sudo gem install {gem-name}

In windows, go to Start->All Programs->Ruby-186-26->RubyGems->RubyGems Interactive Package Manager (where Ruby-186-26 corresponds to whatever version you installed). In the command window type: gem install {gem-name}

For any system, you may want to make sure rubygems is up-to-date before starting:

sudo gem update --system for Unix/Linux/OSX gem update --system for Windows

You will need to install the following gems:

sinatra (download and install this gem locally or install the latest from their git repository. Don't use the gem at rubyforge.org.
json

To use the demo Openbiblio adapter/database, you will need MySQL and the following gems:

activerecord
mysql
composite_primary_keys
vpim
marc (you may have to use gem install marc -v 1.8 if your ruby is older than 1.8.6)
builder

Load this database into MySQL.

To install the DLF ILS-DI API adapter, you will need:

oai
feedtools

You will probably also want to install:

mongrel

From a directory you want to install Jangle in type:

svn checkout http://jangle.googlecode.com/svn/trunk/ jangle

Update jangle/jangle/openbiblio-connector/config.yml to reflect your database settings if you're using the demo connector.

Change directory into jangle/jangle/jangle_core.

Type ruby jangle_core.rb -p 6767

If you're using the demo connector:

Change directory into jangle/jangle/openbiblio-connector

Type ruby connector.rb

If you're using the DLF ILS-DI adapter:

Change directory into jangle/external_interfaces

Type ruby ilsapi.rb -p 6666

You should now be running (hopefully).