jojitoon-lord-of-the-ring-sdk v1.0.1

Lord of the Rings SDK

This is a Javascipt SDK for the Lord of the Rings API. It is a wrapper for the Lord of the Rings API.

Installation

npm install --save jojitoon-lord-of-the-ring-sdk

or

yarn add jojitoon-lord-of-the-ring-sdk

API Key

You will need an API key to use this SDK. You can get one here.

Usage

const lordOTRing = require('jojitoon-lord-of-the-ring-sdk')('ApiKey');

in ES6

import LordOTRing from 'jojitoon-lord-of-the-ring-sdk';

const lordOTRing = new LordOTRing('APIKey');

Methods

Movie

Get all movies

lordOTRing.movie.getAll();

Get movie by ID

lordOTRing.movie.get('ID');

Get quote by movie ID

lordOTRing.movie.quotes('ID');

Quote

Get all quotes

lordOTRing.quote.getAll();

Get quote by ID

lordOTRing.quote.get('ID');

Options

The option object is used to filter the results. It is only available in the following methods:

• lordOTRing.movie.getAll(options)
• lordOTRing.movie.quotes(options)
• lordOTRing.quote.getAll(options)

Limit

The number of items to return. Default is 10.

Page

The page number to return. Default is 1.

Offset

The number of items to skip. Default is 0.

Sort By

The field to sort by. Default is _id.

Sort Order

The order to sort by. Default is asc.

Filter

The filter object is used to filter the results by the properties of the return object.

Example

you can pass an object with the following properties to the getAll method to filter the results

This will return the first 10 movies

const options = {
    limit: 10,
    page: 1,
    offset: 0,
    sortBy: 'name',
    sortOrder: 'asc'
    filter: {
        name: 'The Fellowship of the Ring'
    }
}

lordOTRing.movie.getAll(options);

Handling Errors

The SDK will throw an error if the API returns an error. You can catch the error like this:

try {
  const movies = await lordOTRing.movie.getAll();
} catch (error) {
  console.log(error);
}

or

lordOTRing.movie
  .getAll()
  .then((movies) => {
    console.log(movies);
  })
  .catch((error) => {
    console.log(error);
  });

Build

npm run build

or

yarn build

Test

before running the test, you need to create a config.env.test file in the root directory and add your API key to it.

API_KEY=your_api_key

then install dependencies

npm install

or

yarn install

then run the test

npm run test

or

yarn test

Running the Example

before running the example, you need to create a .env file in the root directory and add your API key to it.

API_KEY=your_api_key

then install dependencies

npm install

or

yarn install

then run the example

npm run example

or

yarn example