Home

Whowas

Whowas is a ruby gem that makes it easy to chain multiple API searches together to correlate pieces of data. The APIs, search methods, and "recipes" (chains of search methods) are completely customizable, providing enormous flexibility; however, there is some setup involved.

Overview

Read the overview for a high-level explanation of the structure of the gem (hint: it's the middleware pattern) and a simple example.

Quick Start

Follow these steps to get Whowas up and running in your environment. If you are confused by the terms or choices in these sections, please check the overview.

1. Create an API class or several and/or configure a bundled API class.
2. Create a search method or several.
3. Create a recipe or several.
4. Configure the recipe table.
5. Run a search.

Demo

A non-functional demo app provides examples of integrating whowas into an app: https://github.com/TuftsUniversity/whowas-demo.