Restaurang.js

A stripped-down, Restangular-inspired REST library using the Fetch specification.

This was created because I wanted something similar to the excellent Restangular outside AngularJS.

Only supports JSON objects for now.

Disclaimer

This is still very much work in progress.

Install

<script src="restaurang.js"></script>

Restaurang uses the standard Fetch specification for requests, so you'll probably want the fetch polyfill.

IE users will need the es6-promise polyfill.

Usage

// Let's start by setting the base url
Restaurang.setUrl("/api/v1");

// Fetch one post
Restaurang.one("posts", "1").get().then(function(post) { // GET /api/v1/posts/1
    post.name = "Lorem ipsum...";

    console.log(post.name);

    post.put(); // PUT /api/v1/posts/1

    // Let's fetch the comments for this post
    post.all("comments").getList().then(function(comments) { // GET /api/v1/posts/1/comments, expects an array
        console.log(comments[0].id); // 1
    });
});

// Fetch a comment without first fetching the post
Restaurang.one("posts", "1").one("comments", "1").get(); // GET /api/v1/posts/1/comments/1

// Create a new post
Restaurang.all("posts").post({ // POST /api/v1/posts
    name: "Foo",
    body: "Bar"
}).then(function(post) {
    console.log(post.name);
});

Methods

Each Restaurang object has the following object methods (including Restaurang itself). Restaurang elements and collections also have some specific methods.

Object methods

• one(route, id) - creates an object with the endpoint /route/id
• all(route) - creates a collection with the endpoint /route
• setUrl(url) - sets the base url
• setDefaultHeaders(headers) - set default headers included in each request

Element methods

• get([queryParams, headers]) - GET element
• getList(element, [queryParams, headers]) - GET collection
• put([queryParams, headers]) - performs PUT on an element
• post(element, data, [queryParams, headers]) - performs POST to element with data payload
• remove([queryParams, headers]) - performs DELETE on an element

Collection methods

• get(id,[queryParams, headers]) - GET element with id from collection
• getList([queryParams, headers]) - GET collection
• post(data, [queryParams, headers]) - POST data to collection endpoint

Restaurang.fetch

If you need a custom fetch function for checking/renewing tokens or just want to be fancy, you can replace Restaurang.fetch with a Fetch specification compatible function.

TODO

• Custom requests
• Add to npm and bower
• HEAD, TRACE, jsonp
• Tests

License

The MIT License (MIT)

Copyright (c) 2015 Anders Rex

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.