christiansmith / nggapi

AngularJS Google API Client

ngGAPI

ngGAPI is a Google APIs client for AngularJS.

Status

Currently Youtube, Google+, Google Calendar, and parts of Blogger and Google Drive are implemented. I'm working (as of 10/20/2013) in my spare time to support the rest of the APIs. Erik Isaksen is helping with this and an example app. Glad to spend some time pair programming with anyone else that wants to contribute. If you want to use ngGAPI but something is missing or doesn't work as expected, please submit an issue, or better yet a pull request. Thanks in advance!

Install

Bower is the quickest way to include ngGAPI in your project.

$ bower install https://github.com/christiansmith/ngGAPI.git --save

<script src="bower_components/ngGAPI/gapi.js"></script>

If you don't use Bower, just download gapi.js into your scripts directory.

$ curl -O https://raw.github.com/christiansmith/ngGAPI/master/gapi.js

<script src="your/js/path/gapi.js"></script>

ngGAPI requires Google API JavaScript client library

<script src="https://apis.google.com/js/client.js"></script>

Usage

Be sure to include "gapi" as a dependency in your main app module.

angular.module('myApp', ['gapi'])

After you register your app in the Google APIs Console, configure ngGAPI with credentials and whatever scopes you need for your app.

angular.module('myApp')
  .value('GoogleApp', {
    apiKey: 'YOUR_API_KEY',
    clientId: 'YOUR_CLIENT_ID',
    scopes: [
      // whatever scopes you need for your app, for example:
      'https://www.googleapis.com/auth/drive',
      'https://www.googleapis.com/auth/youtube',
      'https://www.googleapis.com/auth/userinfo.profile'
      // ...
    ]
  })

To use a specific service, inject it into your controllers by name. All GAPI methods return a promise.

angular.module('myApp')
  .controller('VideosCtrl', function ($scope, Youtube) {
    $scope.videos = Youtube.search({ part: 'snippet', q: 'Search terms' })
  });

Services

GAPI authorization

• GAPI.init()

Admin Directory::users

• Users
  • AdminDirectory.insertUsers(params)
  • AdminDirectory.updateUsers(id, params)
  • AdminDirectory.patchUsers(id, params)
  • AdminDirectory.deleteUsers(id, params)
  • AdminDirectory.makeAdmin(id)
  • AdminDirectory.unMakeAdmin(id)
  • AdminDirectory.getUsers(id)
  • AdminDirectory.listUsers(params)

Admin Directory::groups

• Users
  • AdminDirectory.insertGroups(params)
  • AdminDirectory.updateGroups(id, params)
  • AdminDirectory.patchGroups(id, params)
  • AdminDirectory.deleteGroups(id, params)
  • AdminDirectory.getGroups(id)
  • AdminDirectory.listGroups(params)

Drive

• Files

  • Drive.getFiles(fileId, params)
  • Drive.insertFiles(data, params)
  • Drive.patchFiles(fileId, data, params)
  • Drive.updateFiles(fileId, data, params)
  • Drive.copyFiles(fileId, data, params)
  • Drive.deleteFiles(fileId)
  • Drive.listFiles(params)
  • Drive.touchFiles(fileId)
  • Drive.trashFiles(fileId)
  • Drive.untrashFiles(fileId)
  • Drive.watchFiles(fileId, data)

• About

  • Drive.about(params)

• Changes

  • Drive.getChanges(changeId)
  • Drive.listChanges(params)
  • Drive.watchChanges(data)

• Children

  • Drive.deleteChildren(folderId, childId)
  • Drive.getChildren(folderId, childId)
  • Drive.insertChildren(folderId, data)
  • Drive.listChildren(folderId, params)

• Parents

  • Drive.deleteParents(fileId, parentId)
  • Drive.getParents(fileId, parentId)
  • Drive.insertParents(fileId, data)
  • Drive.listParents(fileId)

• Permissions

  • Drive.deletePermissions(fileId, permissionId)
  • Drive.getPermissions(fileId, permissionId)
  • Drive.insertPermissions(fileId, data, params)
  • Drive.listPermissions(fileId)
  • Drive.patchPermissions(fileId, permissionId, data, params)
  • Drive.updatePermissions(fileId, permissionId, data, params)
  • Drive.getPermissionIdForEmail(email)

• Revisions

  • Drive.deleteRevisions(fileId, revisionId)
  • Drive.getRevisions(fileId, revisionId)
  • Drive.listRevisions(fileId)
  • Drive.patchRevisions(fileId, revisionId, data)
  • Drive.updateRevisions(fileId, revisionId, data, params)

• Apps

  • Drive.listApps()
  • Drive.getApps(appId)

• Comments

  • Drive.deleteComments(fileId, commentId)
  • Drive.getComments(fileId, commentId, params)
  • Drive.insertComments(fileId, data, params)
  • Drive.listComments(fileId, params)
  • Drive.patchComments(fileId, commentId, data, params)
  • Drive.updateComments(fileId, commentId, data, params)

• Replies

  • Drive.deleteReplies(fileId, commentId, replyId)
  • Drive.getReplies(fileId, commentId, replyId, params)
  • Drive.insertReplies(fileId, commentId, data)
  • Drive.listReplies(fileId, commentId, params)
  • Drive.patchReplies(fileId, commentId, replyId, data)
  • Drive.updateReplies(fileId, commentId, replyId, data)

• Properties

  • Drive.deleteProperties(fileId, propertyKey)
  • Drive.getProperties(fileId, propertyKey)
  • Drive.insertProperties(fileId, data)
  • Drive.listProperties(fileId)
  • Drive.patchProperties(fileId, propertyKey, data, params)
  • Drive.updateProperties(fileId, propertyKey, data, params)

• Channels

  • Drive.stopChannels(data)

• Realtime

  • Drive.getRealtime(fileId)
  • Drive.updateRealtime(fileId, params)

Youtube

Official Youtube DATA API (v3) reference documentation

• Activities

  • Youtube.listActivities(params)
  • Youtube.insertActivities(data, params)

• ChannelBanners

  • Youtube.insertChannelBanners()

• Channels

  • Youtube.listChannels(params)
  • Youtube.updateChannels(data, params)

• GuideCategories

  • Youtube.listGuideCategories(params)

• PlaylistItems

  • Youtube.listPlaylistItems(params)
  • Youtube.insertPlaylistItems(data, params)
  • Youtube.updatePlaylistItems(data, params)
  • Youtube.deletePlaylistItems(params)

• Playlists

  • Youtube.listPlaylists(params)
  • Youtube.insertPlaylists(data, params)
  • Youtube.updatePlaylists(data, params)
  • Youtube.deletePlaylists(params)

• Search

  • Youtube.search()

• Subscriptions

  • Youtube.listSubscriptions(params)
  • Youtube.insertSubscriptions(data, params)
  • Youtube.deleteSubscriptions(params)

• Thumbnails

  • Youtube.setThumbnails(params)

• VideoCategories

  • Youtube.listVideoCategories(params)

• Videos

  • Youtube.listVideos(params)
  • Youtube.insertVideos(data, params)
  • Youtube.updateVideos(data, params)
  • Youtube.deleteVideos(params)
  • Youtube.rateVideos(params)
  • Youtube.getVideoRatings(params)

• Watermarks

  • Youtube.setWatermarks()
  • Youtube.unsetWatermarks()

Google+

• People

  • Plus.getPeople(userId)
  • Plus.searchPeople(params)
  • Plus.listPeopleByActivity(activityId, collection)
  • Plus.listPeople(userId, collection, params)

• Activities

  • Plus.listActivities(userId, collection, params)
  • Plus.getActivities(activityId)
  • Plus.searchActivities(params)

• Comments

  • Plus.listComments(activityId, params)
  • Plus.getComments(commentId)

• Moments

  • Plus.insertMoments(userId, collection, data, params)
  • Plus.listMoments(userId, collection, params)
  • Plus.removeMoments(id)

Calendar API

• ACL

  • Calendar.deleteAcl(calendarId, ruleId)
  • Calendar.getAcl(calendarId, ruleId)
  • Calendar.insertAcl(calendarId, data)
  • Calendar.listAcl(calendarId)
  • Calendar.updateAcl(calendarId, ruleId, data)
  • Calendar.patchAcl(calendarId, ruleId, data)

• CalendarList

  • Calendar.deleteCalendarList(calendarId)
  • Calendar.getCalendarList(calendarId)
  • Calendar.insertCalendarList(data)
  • Calendar.listCalendarList(params)
  • Calendar.updateCalendarList(calendarId, data)
  • Calendar.patchCalendarList(calendarId, data)

• Calendars

  • Calendar.clearCalendars(calendarId)
  • Calendar.deleteCalendars(calendarId)
  • Calendar.getCalendars(calendarId)
  • Calendar.insertCalendars(data)
  • Calendar.updateCalendars(calendarId, data)
  • Calendar.patchCalendars(calendarId, data)

• Colors

  • Calendar.getColors()

• Events

  • Calendar.deleteEvents(calendarId, eventId)
  • Calendar.getEvents(calendarId, eventId, params)
  • Calendar.importEvents(calendarId, data, params)
  • Calendar.insertEvents(calendarId, data, params)
  • Calendar.listEventInstances(calendarId, eventId, params)
  • Calendar.listEvents(calendarId, params)
  • Calendar.moveEvents(calendarId, eventId, params)
  • Calendar.quickAdd(calendarId, params)
  • Calendar.updateEvents(calendarId, eventId, data, params)
  • Calendar.patchEvents(calendarId, eventId, data, params)
  • Calendar.watchEvents(calendarId, data)

• FreeBusy

  • Calendar.freeBusy(data)

• Settings

  • Calendar.getSettings(setting)
  • Calendar.listSettings()

• Channels

  • Calendar.stopWatching(data)

Development

Installing the Karma test runner with npm install karma -g, then run the tests with karma start.

Copyright and License

The library is Copyright (c) 2013 Christian Smith, and distributed under the MIT License.

nggapi's Issues

Upload functionality not working as expected

Upload functionality is incomplete. It seems very different in implementation than the other methods and API calls. Documentation for Google Drive has an example of their API but it is not clear at first (and second) glance how this is working and what 'update' really constitutes in this context. A most in depth analysis or alternative resource may be required.

Example integration:
https://developers.google.com/drive/v2/reference/files/update

TypeScript definition

Can you provide a TypeScript definition ("d.ts" extension file) please?

Logged in

Hello!
It's possible to check if user is logged in?

First time clicking button to do oauth triggers pop-up blocker

Not sure why this is happening, but this would be awful for our users to experience. Any tips on getting it to work properly the first time they click auth?

Google Auth

$scope.authorize = function () {
var promise = GAPI.init();
promise.then(function(data){
console.log("data", data);
var googleUser = Plus.searchPeople('me');
console.log("googleUser", googleUser);
});
};

Authenticate window on Android

Hi,

I am trying to use this in my ionic app.
In browser, i get the popup, but same thing never loads when I create an Android APK and test on my device. Any idea? I may be missing something?

Cannot read property 'access_token' of undefined

Error when trying to use GAPI.init();

Already checked if the value 'GoogleApp' is defined at the module level.

Tried the sample app wich uses ngDropbox and ngGapi, same problem. Not sure what to fix. Your help is appreciated.

TypeError: Youtube.search is not a function

Hi,

I get this errors and i don't get it :

TypeError: Youtube.search is not a function

My controller file :

'use strict';

var myapp = angular.module('teamc')
    .value('Youtube', {
        apiKey: 'AIzaSyBQ......msgl1LN8nQIo',
        scopes: [
          'https://www.googleapis.com/auth/youtube'
        ]
    })
    .controller('VideosCtrl', function ($scope, Youtube) {
        $scope.videos = Youtube.search({ part: 'snippet', q: 'sdfsdfsfd' });
        console.log($scope.videos);
    });

Any idea ?
"gapi" is also include as a dependency in my main app module. Installation with bower

Unknown provider: DriveProvider <- Drive <- VideoController

Following the boilerplate example, getting this console error:

Unknown provider: DriveProvider <- Drive <- VideoController

Following the boilerplate installation, got this output:

angular.js:14110 Error: [$injector:unpr] Unknown provider: DriveProvider <- Drive <- VideoController
http://errors.angularjs.org/1.5.9/$injector/unpr?p0=DriveProvider%20%3C-%20Drive%20%3C-%20VideoController
at angular.js:68
at angular.js:4554
at Object.getService [as get] (angular.js:4707)
at angular.js:4559
at getService (angular.js:4707)
at injectionArgs (angular.js:4732)
at Object.invoke (angular.js:4754)
at $controllerInit (angular.js:10518)
at nodeLinkFn (angular.js:9416)
at compositeLinkFn (angular.js:8757)

app.js

var app = angular.module('MyApp',['MyApp.services']);
angular.module('app', [
'angularGAPI'
]);

Not able to download via bower

When trying to import library using bower, I get the following issue:
Permission denied (publickey).
Please make sure you have the correct access rights
and the repository exists.

Login attempt failed. Attempted to login 4 times.

What's the cause of this? I'm with REST API's. Thank you and God Bless.

--EDIT

Yes I know now what's the cause of this but how does the user authorize the use of their Google account's data to be used within a website?

Unable to call init() on GAPI

Hi, I can't seem to initialize GAPI and I'm not sure why. I get this error message:

TypeError: Cannot read property 'authorize' of undefined
at Function.GAPI.init (gapi.js:404)
at new (main.min.js:303)
at invoke (angular.js:3720)
at Object.instantiate (angular.js:3731)
at angular.js:6848
at q (angular-ui-router.min.js:7)
at A (angular-ui-router.min.js:7)
at Scope.$broadcast (angular.js:12329)
at t.transition.N.then.t.transition.t.transition (angular-ui-router.min.js:7)
at wrappedCallback (angular.js:11033)

Here's the code from my controller:
routerApp.controller('home-controller', function($scope, GAPI, Calendar) { //debugger; GAPI.init(); var cal = Calendar.getCalendars('[email protected]');

I'm not sure if this is a bug or if I'm missing something obvious 😳.

Thanks!
Alistair

How to save authentification

Is it possible to save the auth-Token in the browser session or localstorage?

Secure apiKey & clientId

Hello,

I'm just starting to develop in AngularJS and I have a question(sorry if it's idiotic):
Is there a way to prevent the end user to find the aapiKey & clientId values from the js files?

Thanks.

adding "main":"gapi.js", to bower will help in auto injection

{
"name": "ngGAPI",
"version": "0.0.0",
"main":"gapi.js",
"ignore": [
"*/.",
"node_modules",
"components"
],
"devDependencies": {
"angular": "~1.0.7",
"angular-mocks": "~1.0.7",
"angular-mocks-unstable": "~1.1.5",
"angular-unstable": "1.1.5"
}
}

There is no way to auth with immediate: false (for first time app authorization)

Currently there is no way to call gapi.auth.authorize with immediate set to false through the GAPI object. This means apps that have never been authorized by the user cannot be authorized, unless the GAPI object is bypassed.

There should be a GAPI.init option or a different method to enable this functionality.