Giter Club home page Giter Club logo

tvrage-json's Introduction

Build Status Stories in Ready Dependency Status

TV Rage JSON

A node.js API for the TVRage web services; as per the name, all responses are JSON.

Installation

npm install tvragejson

Usage

var TVRage = require("tvragejson");

// Search for a show by name, returning the first match.
TVRage.search("The Big Bang Theory", function(err, response) {
    if (!err) {
        console.log(response["Results"]["show"][0]);
    }
});

// Get information for a particular show - in this case we
// are using the show ID for "The Big Bang Theory".
TVRage.search("8511", function(err, response) {
    if (!err) {
        console.log(response);
    }
});

Supported methods

  • search - Search shows by name
  • fullSearch - Full search for shows by name
  • showInfo - Show info based on a show id that can be acquired via search or fullSearch
  • fullShowInfo - Full show info based on a show id that can be acquired via search or fullSearch
  • episodeList - Episode list based on a show id that can be acquired via the search or fullSearch
  • episode_info - Episode info based on a show id (attainable via search or fullSearch) and an episode (attainable via episodeList)
  • fullShowList - Full TV show list
  • fullSchedule - Full TV schedule based on a two letter country representation as defined by ISO 3166

What's next?

  • Add some tests
  • Add ability to optionally return XML as served from TVRage without converting to JSON

Contributing

All contributions are welcome, feel free to fork master, make your changes and open a pull request.

Grunt is used with the JSHint and Watch plugins. To get up and running with grunt you need to do the following:

  • Install the Grunt Command Line Interface tools: npm install -g grunt-cli
  • Install the current Grunt version local to this project (so ensure you make this within the project's directory): npm install grunt --save-dev

Upon making any code changes, make sure you run grunt test from within the project's directory to verify that there are no errors (this is done using the JSHint plugin mentioned above) - if there are any errors, make all necessary changes before opening a pull request.

Changelog

v0.2.0

  • Fix ECONNRESET from the TvRage API
  • The callback now takes two arguments, err and result
  • Drop node.js 0.6 support

v0.1.3

  • Added a more elaborate .gitignore

v0.1.2

  • Added Grunt

v0.1.1

  • Added David dependency management badge

License

Licensed under the MIT License

tvrage-json's People

Contributors

nivl avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.