Git Product home page Git Product logo

js-api-resource's Introduction

API Resource

Simple wrapper for http resources for client-side JavaScript or Node.js

Setup

npm install api-resource

Simple usage

var Resource = require('api-resource');

var listUsers = new Resource({
        method: 'get',
        route: 'http://localhost/users/:group',
    }),
    createUser: new Resource({
        method: 'post',
        route: 'http://localhost/users',
    });

// Fires GET request to http://localhost/users/followers?q=foo
listUsers.query({ // Request payload + route variables
    group: 'followers'
}, { // Query params
    q: 'foo'
})
.then(function (res) {
    // Response code was successful (<= 200)
    var results = res.body;
}, function (res) {
    // Response code was not successful (> 200)
    throw new Error('Users list responded ' + res.status + ', ' + res.body);
})

// Fires GET request to http://localhost/users/followers?q=foo
createUser.query({ // Request payload + route variables
    username: 'johndoe'
})
.then(function (res) {
    var response = res;
});

Middleware example

var Resource = require('api-resource'),
    token = 'arbitrary-auth-token',
    session;

var sessionEndpoint = new Resource({
    method: 'get',
    route: 'http://localhost/session'
});

sessionEndpoint.use(function (req, next) {
    // Always add authorisation header to this resource
    req.setRequestHeader('Authorization', token);

    // Bind a callback to an event on this resource
    this.once('success', function (res) {
        console.log('Session received correctly');
    });
});

sessionEndpoint.query()
.then(function (res) {
    session = res.body;
});

Resource

Resource instances are also event-emitters. After querying them you can listen you can handle responses by using the promised form or by binding callbacks to their events.

Options

  • method (String) Case insensitive HTTP method (E.g. 'post')
  • route (String) Dynamic resource route (E.g. 'http://www.foo.bar/users/:username')

Events

  • response Fired when a response is received, with a response object passed as argument
  • success Fired when a successful response (Status <= 200) is received, with a response object passed as argument
  • failure Fired when a unsuccessful response (Status > 200) is received, with a response object passed as argument
  • error Fired when an error occurs sending the XMLHttpRequest, with the error passed as argument

Methods

.query([ data ], [ query_params ]) Query endpoint. The values in the data object will also be used to build the URL if the resource route is dynamic. Query params will be added to the final URL as a query string. .use(middleware) Add a middleware function to the resource. The function will be called on the Resource instance and receive as arguments the XMLHttpRequest request instance and the next function to proceed.

Test

Tests are currently written on server-side only. Run npm install and npm test to test.

Contribution

Contributions are welcome as long as documented and tested.

License

Copyright (c) 2014 Kano Computing Ltd. - Released under the MIT license

js-api-resource's People

Contributors

tancredi avatar

Watchers

James Cloos avatar mike 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.