node-google-api

Simple but dynamic wrapper for RESTful Google APIs.

npm install node-google-api
3 downloads in the last day
10 downloads in the last week
39 downloads in the last month

node-google-api

A Node.js module that simplifies the use of RESTful Google APIs. API functions are formed through the Google APIs Discovery Service, so they are automagically up to date.

How to Install

npm install node-google-api

How to use

There are two "constructors" for the google object. The first and easiest is to pass your private API key as a string, but you cna also use an object hash to specify more options (shown below).

var google = require('node-google-api')('<<YOUR GOOGLE API KEY>>');

or

var google = require('node-google-api')({
    apiKey: '<<YOUR GOOGLE API KEY>>',
    debugMode: true // Throws errors instead of passing them silently.
});

Calling build will build all of the APIs, returning one object that contains each API. Then just use the APIs according to their documentation!

google.build(function(api) {
  api.calendar.events.list({
    calendarid: 'en.usa#holiday@group.v.calendar.google.com'
  }, function(result) {
    if(result.error){
      console.log(result.error);
    } else {
      for(var i in result.items) {
        console.log(result.items[i].summary);
      }
    }
  });
});

Need a list of all API's exposed? That's easy! Just run this little snippet:

google.build(function(api) {
  for(var k in api){
    console.log(k);
  }
});

If you need to pass additional data, such as an OAuth token, simply add the hash to the data for the method, shown here:

google.build(function(api) {
  api.calendar.events.list(
    {
      calendarId: 'en.usa#holiday@group.v.calendar.google.com',
      access_token: user.token, // You have to supply the OAuth token for the current user
    },
    function(events) {
      for(var e in events.items) {
        console.log(events.items[e].summary);
      }
    }
  });
});

Future Plans

  • Create an issue for enhancements!

License

(The MIT License)

Copyright (c) 2013 Jim Buck <jim@jimmyboh.com> and node-google-api contributors

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.

npm loves you