The Supplejack API is a Rails mountable engine that provides functionality to store, index and retrieve metadata via an API. It also includes an API dashboard for monitoring API key activity and setting query throttle rates.

This wiki provides a guide on how to create and configure your API as well as an introduction to the rest of the Supplejack project.

Getting started

Before starting you should check that you have all the dependencies installed.

Once that is complete we strongly recommend using the Supplejack template to create your app. This template will create a new app which includes the Supplejack API engine and then step through the configuration options.

For details about how to install Supplejack Template, see Install & Setup

Once the install is complete you should have a working API. The next step is to configure your schema so that you can configure the fields that are stored/returned by your API.

Setup a custom record model from your API [OPTIONAL]

If you want to use a custom SupplejackApi::Record model, you can define a supplejack_api.rb initializer file and define the following block:

SupplejackApi.setup do |config|
  config.record_class = YourCustomClass
  config.preview_record_class = YourPreviewCustomClass

Log Record Metric Data

By default, Supplejack will log a history of Records that have been viewed in searches and individually, if you do not want this functionality simply set config.log_metrics = false in config/initializers/supplejack_api.rb

SupplejackApi.setup do |config|
  config.log_metrics = false

Make sure your model follow the same structure as the SupplejackApi::Record and SupplejackApi::PreviewRecord

By setting a custom class you will be able to do for example: YourCustomClass.custom_find()

Generate API User keys

From the Worker’s project root, Run the console.

rails c

Create a user.

 > SupplejackApi::User.create(email: '', name: 'Your Name', username: 'your_username')
=> #<SupplejackApi::User _id: 53d58681f694195642000002, created_at: 2014-07-27 23:08:49 UTC, updated_at: 2014-07-27 23:08:49 UTC, email: "", encrypted_password: nil, name: "Your Name", username: "your_username", sign_in_count: nil, current_sign_in_at: nil, last_sign_in_at: nil, current_sign_in_ip: nil, last_sign_in_ip: nil, authentication_token: "JmVe15z2BSHDwaVsjMvA", daily_requests: 0, monthly_requests: 0, max_requests: 10000, role: "developer", daily_activity: nil, daily_activity_stored: true>
 > SupplejackApi::User.last.authentication_token
=> "RhymLHa9xRQGU8gyAYXP"

Cron Jobs

Supplejack has a few cronjobs that will help with indexing records. You can see examples of them in schedule.example.rb. The main one you should add is the SupplejackApi::IndexRemainingRecordsInQueue as it will index records that are in the Redis queue when there is not yet enough of them to trigger an index automatically.

Supplejack Sidekiq

Supplejack has it’s own instance of Sidekiq that you will need to run for the Full and Flush harvest to work. Start Sidekiq from the api directory with bundle exec sidekiq. If you are running both Sidekiq instances on the same machine, you will need to point them at separate Redis databases otherwise you will end up in problems where the two Sidekiqs are trying to process each others jobs. This can be done by appending /<number> to the end of your Redis URL.