node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

grazer

grazer Build Status

An API wrapper to the amazing Graze public API.

Getting Started

Install the module with: npm install grazer

var grazer = require('grazer');

Create a new Grazer object:

var Grazer = new grazer.Grazer();

Now you can run any of the methods.

Documentation

Please look under the /doc folder or on CoffeeDocs.info.

Examples

Retrieve product ID 1033 and output result to console.

   new Grazer.getProduct(1033, true, function(result) {
     console.log (result);
   });

Search for products that have 'jalapeno' in their description.

   new Grazer.getProductSearch('jalapeno', true, function(result) {
     console.log (result);
   });

Retrieve the contents of box F9H0N and output result to console.

   new Grazer.getBoxContents('F9H0N', true, function(result) {
     console.log (result);
   });

Get categories list and log to console

   new Grazer.getCategories(false, function(result) {
        console.log (result);
   });

Contributing

TODO: the asynch methods need Jasmine tests to be written for them.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

First release (0.1.0): 19/06/2014

License

Copyright (c) 2014 Chris von Csefalvay. Licensed under the MIT license.

Disclaimer: I am not affiliated with Graze, just a fan of their snack boxes.

If you enjoy this module, please do me a favour and check out Special Effect. They're a charity that helps disabled gamers by acquiring and/or hacking together adaptive and augmentative devices to help them play. The experience of gaming belongs to everyone. Consider donating or helping them out - trust me, it'll change your life.