ngDropbox

ngDropbox is a Dropbox Core API Client for AngularJS adapted from dropbox-js. It should be familiar to dropbox-js users as well as idiomatic to AngularJS.

Status

This module is extracted from an AngularJS application. It mostly satisfies the needs of that project but I'm working (as of 1/4/2014) in my spare time to implement the rest of the API. If you want to use ngDropbox but something is missing or doesn't work as expected, please submit an issue or get in touch to pair program. Thanks in advance!

Install

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

$ bower install git@github.com:christiansmith/ngDropbox.git --save

<script src="bower_components/ngDropbox/dropbox.js"></script>

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

$ curl -O https://raw.github.com/christiansmith/ngDropbox/master/dropbox.js

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

Usage

After you create an app in the Dropbox App Console, add an OAuth Redirect URI pointing to https://<HOST>/components/ngDropbox/callback.html.

In your AngularJS app, load the module. Inform your app of the App key and Redirect URI, then inject the service into your controllers and start making API calls. All methods that communicate with the API return promises.

// load the module
angular.module('myApp', ['dropbox'])

  .config(function (DropboxProvider) {
    DropboxProvider.config(<APP_KEY>, <REDIRECT_URI>);
  })

  // inject the service
  .controller('DropboxCtrl', function ($scope, Dropbox) {
    
    // assign a promise to scope
    $scope.accountInfo = Dropbox.accountInfo();

    // or use callbacks
    Dropbox.copy('dir/image1.jpg', 'dir/image2.jpg').then(function (res) {
      Dropbox.move('dir/image1.jpg', 'dir/image.jpg').then(function (res) {
        $scope.photos = Dropbox.stat('dir');
      });
    });

  });

API

• Dropbox.accountInfo()
• Dropbox.userInfo() (alias Dropbox.accountInfo())
• Dropbox.readFile(path, params)
• Dropbox.writeFile(path, content, params)
• Dropbox.stat(path, params)
• Dropbox.metadata(path, params) (alias Dropbox.stat(path, params))
• Dropbox.readdir(path, params)
• makeUrl
• Dropbox.history(path, params)
• Dropbox.revisions(path, params) (alias Dropbox.history(path, params))
• Dropbox.thumbnailUrl(path, params)
• readThumbnail
• Dropbox.revertFile(path, rev)
• Dropbox.restore(path, rev)
• Dropbox.findByName(path, pattern, params)
• Dropbox.search(path, pattern, params)
• makeCopyReference/copyRef
• pullChanges/delta
• Dropbox.mkdir(path)
• Dropbox.remove(path)
• Dropbox.unlink(path) (alias Dropbox.remove(path))
• Dropbox.delete(path) (alias Dropbox.remove(path))
• Dropbox.copy(from, to)
• Dropbox.move(from, to)

TODO

Methods yet to be implemented (as of 8/1/2013).

• signOut/signOff
• writeFile
• resumableUpload
• makeUrl
• readThumbnail
• makeCopyReference/copyRef
• pullChanges/delta

Other

• Support redirect and other authentication methods in addition to browser popup
• Test in multiple browsers
• Test error cases

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.