*************************
rarbgSearch
*************************

Perform a search on rarbg.to.

Configuration
=============

================    ======= ===========
Option              Type    Description
================    ======= ===========
categories          Array   Restrict the search to one or more categories.
search              Array   Every object in this array describes a search criteria. Every criteria is described by a ``type`` ('query', 'imdb', 'tvdb' or 'tmdb') and a term.
sort                String  Choose how results will be sorted. Defaults to 'seeders' (most seeded first); you can also choose 'leechers' (most leeched first) or 'last' (most recently added first).
minSeeders          Integer Minimum number of seeders. Torrents seeded less than this will be discarded. Must be greater than zero.
minLeechers         Integer Minimum number of leechers. Torrents leeched less than this will be discarded. Must be greater than zero.
ranked              Boolean If true, restrict results to scene releases.
quality             Object  An object describing which level of quality is acceptable. The  audioCodec  field is a list of acceptable codecs, from most to least preferred.  videoCodec ,  videoResolution  and  videoSource  work in the same way.
================    ======= ===========

Available categories:

 - All movies
 - All TV shows
 - XXX
 - Movies/XVID
 - Movies/XVID/720
 - Movies/x264
 - Movies/x264/1080
 - Movies/x264/720
 - Movies/x264/3D
 - Movies/Full BD
 - Movies/BD remux
 - TV Episodes
 - TV HD Episodes
 - Music/MP3
 - Music/FLAC
 - Games/PC ISO
 - Games/PC RIP
 - Games/PS3
 - Games/XBOX-360
 - Software/PC ISO
 - e-Books

Search types:

=====   ======================================  ===============
Type    Term                                    Effect
=====   ======================================  ===============
query   An arbitrary String                     Restricts the results to those containing the text provided
imdb    Any valid http://imdb.com ID            Restrict the results to tv shows or movies matched by the ID
tvdb    Any valid http://thetvdb.com ID         Same as above, different website
tmdb    Any valid http://www.themoviedb.org ID  Same as above, different website
=====   ======================================  ===============

Example:

.. code-block:: javascript

    {
        plugin: 'rarbgSearch',
        configuration: {
            search: [
                {type: 'query', term: 'S01'},
                {type: 'imdb', term: 'tt123456ABCD'}
            ]
        }
    }

You can find a `list of supported qualities <https://gitlab.com/egeria/egeria-divine#supported-qualities>`__ on the ``egeria-divine`` `project page <https://gitlab.com/egeria/egeria-divine>`__.

Example:

.. code-block:: javascript

    {
        plugin: 'rarbgSearch',
        configuration: {
            search: [{type: 'query', term: 'Something perfectly legal'}],
            quality: {
                videoResolution: ['1080p', '720p'],
                videoCodec: ['h265', 'h264']
            }
        }
    }

Output
======

==============================  ======  ============    ===================
Field                           Type    Notes           Description / Value
==============================  ======  ============    ===================
rarbg:title                     String
rarbg:category                  String
rarbg:download                  URL     Magnet link     Torrent link
rarbg:seeders                   Number
rarbg:leechers                  Number
rarbg:size                      Number  bytes
rarbg:pubdate                   Date
rarbg:episode_info:imdb         String                  imdb ID
rarbg:episode_info:tvdb         String                  tvdb ID
rarbg:episode_info:themoviedb   String                  tmdb ID
rarbg:ranked                    Number  0 or 1          Is it a scene release? 1 = true
rarbg:videoResolution           String
rarbg:videoSource               String
rarbg:videoCodec                String
rarbg:audioCodec                String
==============================  ======  ============    ===================