OfficeBot SDK

A handly little utility for interacting with RESTful APIs.

Prerequisites

This library uses many ES6 features and will only work in modern browsers that support ES6 features. Additionally, the end-to-end test suite requires Node.js to be installed.

Installation and Getting Started

Install the library via NPM:

npm install officebot-sdk

When using in the browser, this package will export a single global variable officebotSdk. This package can also be included in any project that uses Browserify by requiring it in:

<script src="node_modules/officebot-sdk/dist/officebot-sdk.min.js"></script>

OR

const officebotSdk = require('officebot-sdk');

Example Usage

let api = new officebotSdk.API();

api
  .baseUrl('http://localhost/api');

api
  .endpoint('Sample')
  .url('/sample');

api.Sample
  .find({id : 1})
  .select('id title')
  .limit(10)
  .exec().then(arrayOfModels => {
    //Do something with the array of models
  }).catch(err => {
    console.error(err);
  });

Check out our documentation for more examples.

Building

Though a prebuild version of this library is included with this repository, you may find yourself in a situation where rebuilding it from source is desirable. Two NPM scripts are provided to do exactly that:

npm run build

Or if you'd prefer a minified version

npm run build-minified

Running the tests

Unit tests and end-to-end tests are included. To run the full test suite, first ensure that all dependencies are installed:

npm install

Then run:

npm test

Generating Docs and Coverage Report

NPM scripts for generating documentation are included.

npm run coverage && npm run docs

Built With

• Browserify - Javascript bundler
• Istanbul - Code coverage
• Karma - Test runner
• Mocha - Unit testing
• NodeJS - Provides core libraries for query parsing
• Fast JSON Patch - Used to calculate diffs

Contributing

Please read Contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Scott Peterson - OfficeBot

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Billie Thompson - PurpleBooth for providing the CONTRIBUTING.md gist