doowb / fly-api

Fly.io API wrapper for simplifying REST calls.

fly-api

Fly.io API wrapper for simplifying REST calls.

Install

Install with npm:

$ npm install --save fly-api

Install with yarn:

$ yarn add fly-api

Usage

var Fly = require('fly-api');

API

Fly

Create a new Fly instance using the given options.

Params

• options {Object}: Options for setting authentication token and api url.
• options.token {String}: Authentication token for fly.io api.
• options.url {String}: fly.io api url. Defaults to (https://fly.io/api/v1/)

Example

var fly = new Fly({token: 'xxxx'});

.get

Send a GET request to the specified path at the fly.io api url.

Params

• path {String}: Path to use after the api url
• options {Object}: Options
• cb {Function}: Callback function that takes an err and result parameters.

Example

fly.get('sites/doowb/hostnames', {}, function(err, result) {
  if (err) {
    console.error(err);
    return;
  }
  console.log(result);
  //=> {
  //=>   "data": {
  //=>     "attributes": {
  //=>        "hostname": "foo.doowb.com"
  //=>     }
  //=>   }
  //=> }
});

.post

Send a POST request to the specified path at the fly.io api url.

Params

• path {String}: Path to use after the api url
• data {Object}: The payload to send in the post.
• cb {Function}: Callback function that takes an err and result parameters.

Example

var options = {
  data: {
    attributes: { hostname: 'bar.doowb.com' }
  }
};

fly.post('sites/doowb/hostnames', options, function(err, result) {
  if (err) {
    console.error(err);
    return;
  }
  console.log(result);
  //=> {
  //=>   "data": {
  //=>     "attributes": {
  //=>        "hostname": "bar.doowb.com"
  //=>     }
  //=>   }
  //=> }
});

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2017, Brian Woodward. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on August 21, 2017.