Borewit/gazelle-client

Gazelle API client

gazelle-client

Simple, idiomatic access to the API features of Gazelle.

Overview

Gazelle provides a JSON API to registered users. This library aims to maintain coverage of all features within a reasonable timeframe and provide an easy to use and obvious surface.

Installation

npm install gazelle-client

yarn add gazelle-client

Example

const gazelle = require('gazelle-client');

const client = new gazelle.GazelleClient('https://what.cd', 'username', 'password');

(async () => {

  try {
    const data = await client.index();
    console.log(data);
  } catch(error) {
    console.error(error.message);
  } 
})();

API

constructor

GazelleClient(baseUrl: string, username: string, password: string, options?: IOptions)

argument	Description
baseUrl	Gazelle base URL, e.g. https://what.cd/
username	Gazelle username
password	Gazelle password
options	Got options

getIndex()

async function async getIndex(): Promise<IIndex>

Gazelle API documentation: https://github.com/WhatCD/Gazelle/wiki/JSON-API-Documentation#index

getArtistById()

async function getArtistById(id: number, name?, onlyAsMain?: boolean): Promise<IArtist>

argument	Description
id	Artist's id
onlyAsMain	If set, only include groups where the artist is the main artist

Gazelle API documentation: https://github.com/WhatCD/Gazelle/wiki/JSON-API-Documentation#artist

getArtistByName()

async function getArtistByName(name: string, onlyAsMain?: boolean): Promise<IArtist>

argument	Description
name	Artist's Name
onlyAsMain	If set, only include groups where the artist is the main artist

Gazelle API documentation: https://github.com/WhatCD/Gazelle/wiki/JSON-API-Documentation#artist

getTorrentInfoById()

Download torrent with torrentId.

async function getTorrentInfoById(torrentId: number): Promise<IAttachment>

getTorrentInfoByHash()

async function getTorrentInfoByHash(torrentHash: string): Promise<ITorrentAndGroupInfo> 

action()

function action<T>(action: string, args: any): Promise<T>

Low level API call.

where action is one of:

• announcements
• artist
• bookmarks
• bookmarks_artists
• bookmarks_torrents
• browse
• forum_main
• forum_viewforum
• forum_viewthread
• inbox
• inbox_inbox
• inbox_sentbox
• inbox_viewconv
• index
• notifications
• request
• requests
• similar_artists
• subscriptions
• top10
• top10_tags
• top10_torrents
• top10_users
• torrent
• torrentgroup
• user
• usersearch

Unit Tests

Create the following JSON file in you project folder: etc/gazelle.json

Replace the values with the Gazelle forum you would like to test against.

{
  "myProfile": {
    "baseUrl": "https://gazelle-forum.org",
    "username": "username",
    "password": "password",
    "torrentId": 27531578,
    "artistId": 864
  }
}

License

(The MIT License)

Copyright (c) 2021 Borewit

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.