liblab-take-home-ludwinski v1.0.0

Take home project - The Lord of the Rings SDK

Introduction

An SDK written in TypeScript to consume information about the Lord of the Rings Trilogy from The One API

Note: This SDK is a simple proof of concept meant to demonstrate my SDK-writing abilities as part of a take home assignment for LibLab. It is not meant for production use.

Installing

To install:

1. Setup an npm-based node project
2. Inside your project directory, run npm install -S liblab-take-home-ludwinski

Client

Require the dependency and initialize the client with an auth token that you can get by signing up for The One API. Alternatively, you can initialize the client by setting an environment variable THE_ONE_API_KEY instead.

const { Client } = require('liblab-take-home-ludwinski');
const client = new Client("YOUR_THE_ONE_API_KEY_GOES_HERE")

or set the environment variable like this:

export THE_ONE_API_KEY="YOUR_THE_ONE_API_KEY_GOES_HERE"

and then initialize the client like this:

const { Client } = require('liblab-take-home-ludwinski');
const client = new Client()

Available APIs

All APIs return promises and can be chained with .then((response) => { ...}) or awaited on as desired

• getMovies - List of all movies, including the "The Lord of the Rings" and the "The Hobbit" trilogies
• getMovieById - Request one specific movie
• getQuotesForMovie - Request all movie quotes for one specific movie (only working for the LotR trilogy)
• getQuotes - List of all movie quotes
• getQuoteById - Request one specific movie quote

Basic Example

const { Client } = require('liblab-take-home-ludwinski')

const client = new Client(process.env.THE_ONE_API_KEY)
client.getMovies().then((data) => {
  console.log(data)
})

Pagination

Pagination, sorting, and filtering are all optional. To paginate, you may use the limit, page, and offset options like:

const client = new Client()
const options = { limit: 100 }
client.getMovies(paginationOptions)

Sorting option examples

const options = { sort: "name:asc" }
const options = { sort: "character:desc" }

Filtering

Filtering doesn't work for now. I timeboxed this assignment and ran out of time before getting to it.