Skip to content

Latest commit

 

History

History
139 lines (94 loc) · 3.85 KB

README.md

File metadata and controls

139 lines (94 loc) · 3.85 KB

GlassFrog.js - Version: 0.6.3

A Node.js wrapper for the GlassFrog® API.

Importing & Initialization

Written with ♡ by your friends at Undercurrent.

To import this module:

  1. Require the module.
var GlassFrog = require('glassfrog');
  1. Pass your API Key to the function that is imported.
var gf = GlassFrog(YOUR_API_KEY);

You may optionally specify several options.

You may specify the persistence flag. If set to true GlassFrog.js will not accept 403 Forbidden responses on GET requests. This allows a work around for the API rejecting a large amount of requests.

By default, persistence is disabled. Turn it on by setting the persistence options to true:

var gf = GlassFrog(YOUR_API_KEY, {
    persistence: true
});

You may also specify the caching flag. If set to true fetched API data will be stored locally. The get() method (documented below) allows you to specify if you want to attempt to retrieve data instantaneously from the local cache or from the GlassFrog server.

The cache can dramatically speed up some of the organizational graph traversal methods.

By default, caching is disabled. Turn it on by setting the caching options to true:

var gf = GlassFrog(YOUR_API_KEY, {
    caching: true
});

For more information see.

Usage

This library follows the Promise pattern.

A method that returns a Promise should be processed with either then(callback) or spread(callback). It is also strongly recommended that you add a catch(callback) to gather any thrown exceptions.

The then(callback) accepts a function taking a single parameter of the form callback(response) where response is an array with:

  • response[0] being the entire response.
  • response[1] being the body of the response.

catch is a function with the form catch(error) where error is an error object.

The complete form of a function might look like:

gf.get().circles().withID($ID).then(function (response) {
	console.log(JSON.parse(response[1]));
}).catch(function (error) {
	console.log("There was an " + error);
});

Alternatively you can call the spread(callback) function to make the parameters more readable:

gf.get().circles().withID($ID).spread(function (response, data) {
	console.log(data);
}).catch(function(error) {
	console.log("There was an " + error);
});

Note that data will automatically be parsed into an object for you if the call to the GlassFrog API was successful

GET

These functions pull data from GlassFrog with GET HTTP requests.

See get documentation.

POST

These functions push data to GlassFrog and create new objects with POST HTTP requests.

See post documentation.

PATCH

These functions modify existing data on GlassFrog with PATCH HTTP requests.

See patch documentation.

DELETE

These functions delete existing data on GlassFrog with DELETE HTTP requests.

See delete documentation.

Authors

This software has been authored in part by:

License

Copyright 2015 Undercurrent

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.