THIS PROJECT IS DEPRECATED AND NOT MAINTAINED! Use at your own risk

sdktor

Simple and declarative sdk generator for the browser and nodejs. Uses superagent internally. Written in ES6 but an ES5 built is also provided. It's compatible with browserify and webpack.

Installation

npm install sdktor --save

Usage

Supports all major HTTP verbs: GET POST PATH PUT DELETE.

const sdktor = require('sdktor');

// Create the SDK with configuration
// that will be passed on to all requests
const sdk = sdktor('https://api.github.com', {
  Accept: 'application/vnd.github.v3+json',
  Authorization: 'token <OAUTH-TOKEN>'
});

// Define endpoints
const getPublicGists = sdk.get('/gists/private');
const getPrivateGists = sdk.get('/gists/public');

const now = new Date().toString();
const then = ({body}) => console.log(body);

getPublicGists().then(then);
getPublicGists({since: now}).then(then);
getPrivateGists().then(then);
getPrivateGists({since: now }).then(then);

Routes can be defined recursively with the at() method. Regular expressions are supported as well.

All params that are not route params will be passed as query string for get requests and in the body for all other methods.

Paths are parsed using the url-pattern library. Allowing for very flexible route definitions:

const sdktor = require('sdktor');
const sdk = sdktor('https://api.com/');
const containersSdk = sdk.at('v:major(.:minor)/containers/');

const { get, post, path, put, del } = containersSdk.at(':id/');

const getOne = get('', {'cache-control': 'no-cache'}); 
const getMeta = get('meta/');
const create = containersSdk.post();
const update = put();
const patch  = patch();
const remove = del();

// GET https://api.com/v1/containers/2/?source=newsletter
// with no-cache header
get({ major: 1, id: 2, source: 'newsletter' }).then(() => {}); 

// GET https://api.com/v1.2/containers/3/meta/?order=ascending&all=1
getMeta({ major: 1, id: 3 order: 'ascending', all: 1 }).then(() => {});

// POST https://api.com/v2.0-rc1/containers/4/ {name: 'nginx'}
create({ major: 2, id: 4, minor: '0-rc1', name: 'nginx'}).then(() => {});

// Error! major and id are required  
path({ name: 'nginx'}).catch(err => {});

Note: Only the pathname is parsed, the protocol is left as is.

API

sdktor(URI,HEADERS,options) => sdk

This is the base function. All subsequent methods will extend HEADERS and append to URI

##### sdk.at(path,HEADERS,options) => caller

Calls sdktor() resursively. All subsequent calls wil be relative to this path.

##### sdk.get(path,HEADERS) => caller

Sets up a get handler extending the path and headers from th current cursor location

##### sdk.post(path,HEADERS) => caller

Sets up a post handler extending the path and headers from th current cursor location

##### sdk.patch(path,HEADERS) => caller

Sets up a patch handler extending the path and headers from th current cursor location

##### sdk.put(path,HEADERS) => caller

Sets up a put handler extending the path and headers from th current cursor location

##### sdk.del(path,HEADERS) => caller

Sets up a delete handler extending the path and headers from th current cursor location

##### caller([params] => Promise

Makes the call to the preconfigured path with all headers. If regular expression where used omits the url params from the data that will be sent in the request. DELETE requests omit all body and/or query string data.

Note: All methods can be called any number of times with no side effects.

Options

options.postRequest

type: Array of (res) => res

An ordered array that will run for all children routes after the request succeeds.

Eg:

const postRequestOK = res => {
  if(res >= 400) {
    throw 'Request failed';
  }

  // We MUST return the response object
  return res;
}

const postRequestAUTH = res => {
  if(res === 401) {
    throw 'Aunthentication failed';
  }
  
  // Just an example.
  // Mutating the body here is highly discourage,
  resp.body.sdktor = true;

  return res;
}

const sdk = sdktor('https://api.github.com', headerOpts, {
  postRequest: [
    postRequestOK,
    postRequestAUTH,
  ]

  const getPublicGists = sdk.get('/gists/private');

  getPublicGists().then(({ body }) => {
    // body.sdktor === true
  })

});

Flow

Flow types are available here.

Note to self: Move libdef to flow-typed

## License

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.

maroshii/sdktor