md-movie-utils
Version:
The ultimate utility to get any information about a movie
220 lines (180 loc) • 8.69 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Source: clients/omdb.client.js | </title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/tui-doc.css">
<link type="text/css" rel="stylesheet" href=".docs.styles.css">
</head>
<body>
<nav class="lnb" id="lnb">
<div class="logo" style="width: 162px; height: 76px">
<img src="https://github.com/dibosh/md-movie-utils/raw/master/md-movie-utils-icon-invert.png" width="100%" height="100%">
</div>
<div class="title">
<h1><a href="index.html" class="link"> </a></h1>
</div>
<div class="search-container" id="search-container">
<input type="text" placeholder="Search">
<ul></ul>
</div>
<div class="lnb-api hidden"><h3>Classes</h3><ul><li><a href="BaseClient.html">BaseClient</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="BaseClient_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="BaseClient.html#get">get</a></li><li><a href="BaseClient.html#search">search</a></li></ul></div></li><li><a href="MovieDBClient.html">MovieDBClient</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MovieDBClient_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MovieDBClient.html#.getInstance">getInstance</a></li><li><a href="MovieDBClient.html#get">get</a></li><li><a href="MovieDBClient.html#getByIMDBId">getByIMDBId</a></li><li><a href="MovieDBClient.html#getByTitleAndYear">getByTitleAndYear</a></li><li><a href="MovieDBClient.html#getDetails">getDetails</a></li><li><a href="MovieDBClient.html#search">search</a></li></ul></div></li><li><a href="OMDBAPIClient.html">OMDBAPIClient</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="OMDBAPIClient_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="OMDBAPIClient.html#.getInstance">getInstance</a></li><li><a href="OMDBAPIClient.html#get">get</a></li><li><a href="OMDBAPIClient.html#getByIMDBId">getByIMDBId</a></li><li><a href="OMDBAPIClient.html#getByTitleAndYear">getByTitleAndYear</a></li><li><a href="OMDBAPIClient.html#search">search</a></li></ul></div></li><li><a href="Parser.html">Parser</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Parser_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Parser.html#parseFromTorrentFileName">parseFromTorrentFileName</a></li><li><a href="Parser.html#parseMovieNameAndYear">parseMovieNameAndYear</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Global</h3><ul><li><a href="global.html#toCamelCase">toCamelCase</a></li></ul></div>
</nav>
<div id="resizer"></div>
<div class="main" id="main">
<section>
<article>
<pre class="prettyprint source linenums"><code>let axios = require('axios');
let utils = require('../utils');
let BaseClient = require('./base.client');
/**
* Open Movie Database API Client.
* @extends BaseClient
*/
class OMDBAPIClient extends BaseClient {
/**
* @param {string} apiKey The omdb api key ([Ref]{@link http://www.omdbapi.com/apikey.aspx})
* @param baseUrl Base url for omdb api
*/
constructor(apiKey, baseUrl) {
super(apiKey, baseUrl);
}
/**
* Get omdb client instance.
* @param {string} apiKey The omdb api key
* @returns {OMDBAPIClient}
*/
static getInstance(apiKey) {
return new OMDBAPIClient(apiKey, 'http://www.omdbapi.com/');
}
get authParam() {
return 'apikey';
}
get requestKeyMap() {
return {
title: 't',
query: 's',
year: 'y',
imdbID: 'i',
plot: 'plot',
format: 'r',
type: 'type',
page: 'page'
};
}
/**
* Get a media(movie/series) by looking up using different params (e.g. title, imdb id, year etc.)
* @param {object} options The options based on which the movie will be fetched.
* @example
* get({title: 'Saw', year: 2004, plot: 'short', format: 'xml', type: 'movie'})
* @example
* get({imdbID: 'tt12444'})
* @returns {Promise}
* @fulfil {object} - The movie/series object.
* @reject {Error} - The error with an appropriate `message`.
*/
get(options) {
if (!options.imdbID) {
if (!options.title || !options.year || !options.type) {
throw new Error('Either one of the format of data must be provided: imdbID | (title, year, type)');
}
}
let reqOptions = this._translateIncomingRequestOptions(options);
reqOptions.plot = reqOptions.plot || 'full';
reqOptions.format = reqOptions.format || 'json';
return this._makeHTTPGET('', reqOptions, null, this._transformResponse.bind(this))
.then((resp) => {
return resp.data;
});
}
/**
* Search for a movie/series.
* @param {object} options The options based on which the search will be conducted.
* @example
* search({query: 'Saw', year: 2004, format: 'xml', type: 'movie'})
* @returns {Promise}
* @fulfil {object} - The movie/series object.
* @reject {Error} - The error with an appropriate `message`.
*/
search(options) {
if (!options.query) {
throw new Error('Query must be given');
}
let reqOptions = this._translateIncomingRequestOptions(options);
reqOptions.plot = reqOptions.plot || 'full';
reqOptions.format = reqOptions.format || 'json';
return this._makeHTTPGET('', reqOptions, null, this._transformResponse.bind(this))
.then((resp) => {
return resp.data;
});
}
/**
* Get a media(movie/series) by title and year
* @param {string} title Title of the media (movie/series)
* @param {number} year The year media type(movie/series) was released (Optional).
* @param {string} [type='movie'] Type of the media; movie/series (Optional).
* @returns {Promise}
* @fulfil {object} - The movie/series object.
* @reject {Error} - The error with an appropriate `message`.
*/
getByTitleAndYear(title, year, type = 'movie') {
return this.get({title: title, year: year, format: 'json', plot: 'short', type: type});
}
/**
* Get a media(movie/series) by IMDB ID
* @param {string} imdbID IMDB ID of the media
* @returns {Promise}
* @fulfil {object} - The movie/series object.
* @reject {Error} - The error with an appropriate `message`.
*/
getByIMDBId(imdbID) {
return this.get({imdbID: imdbID, format: 'json', plot: 'short'});
}
_transformResponse(data) {
if (data['Search']) {
return data['Search'].map((result) => {
return this._translateResponseObject(result);
});
} else {
return this._translateResponseObject(data);
}
}
_translateResponseObject(responseObj) {
let translated = {};
Object.keys(responseObj).forEach((key) => {
translated[utils.toCamelCase(key)] = responseObj[key];
});
return translated;
}
}
module.exports = OMDBAPIClient;
</code></pre>
</article>
</section>
</div>
<footer>
<img class="logo" src="https://github.com/dibosh/md-movie-utils/raw/master/md-movie-utils-icon-invert.png" style="width: 162px; height: 76px">
<div class="footer-text">If you liked the module, don't forget to hit a star on github: https://github.com/dibosh/md-movie-utils</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tui-doc.js"></script>
<script src="scripts/linenumber.js"></script>
<script>
var id = '_sub'.replace(/"/g, '_');
var selectedApi = document.getElementById(id); // do not use jquery selector
var $selectedApi = $(selectedApi);
$selectedApi.removeClass('hidden');
$selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
showLnbApi();
</script>
</body>
</html>