https://github.com/christiansmith/ngDropbox

AngularJS Dropbox Client
https://github.com/christiansmith/ngDropbox

Last synced: 3 months ago
JSON representation

AngularJS Dropbox Client

• Host: GitHub
• URL: https://github.com/christiansmith/ngDropbox
• Owner: christiansmith
• License: mit
• Created: 2013-07-31T18:45:32.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-11-19T12:04:48.000Z (about 9 years ago)
• Last Synced: 2024-06-22T21:12:06.001Z (6 months ago)
• Language: JavaScript
• Size: 347 KB
• Stars: 66
• Watchers: 8
• Forks: 22
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ngDropbox

ngDropbox is a [Dropbox Core API](https://www.dropbox.com/developers/core/docs) Client for AngularJS adapted from [dropbox-js](https://github.com/dropbox/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](http://bower.io/) is the quickest way to include ngDropbox in your project.

    $ bower install [email protected]:christiansmith/ngDropbox.git --save

    

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

    

## Usage

After you create an app in the [Dropbox App Console](https://www.dropbox.com/developers/apps), add an OAuth Redirect URI pointing to `https:///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(, );

      })

      // 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()**](https://www.dropbox.com/developers/core/docs#account-info)

* [**Dropbox.userInfo()**](https://www.dropbox.com/developers/core/docs#account-info) (alias Dropbox.accountInfo())

* [**Dropbox.readFile(path, params)**](https://www.dropbox.com/developers/core/docs#files-GET)

* [**Dropbox.writeFile(path, content, params)**](https://www.dropbox.com/developers/core/docs#files_put)

* [**Dropbox.stat(path, params)**](https://www.dropbox.com/developers/core/docs#metadata)

* [**Dropbox.metadata(path, params)**](https://www.dropbox.com/developers/core/docs#metadata) (alias Dropbox.stat(path, params))

* [**Dropbox.readdir(path, params)**](https://www.dropbox.com/developers/core/docs#metadata)

* makeUrl 

* [**Dropbox.history(path, params)**](https://www.dropbox.com/developers/core/docs#revisions)

* [**Dropbox.revisions(path, params)**](https://www.dropbox.com/developers/core/docs#revisions) (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)**](https://www.dropbox.com/developers/core/docs#fileops-create-folder)

* [**Dropbox.remove(path)**](https://www.dropbox.com/developers/core/docs#fileops-delete)

* [**Dropbox.unlink(path)**](https://www.dropbox.com/developers/core/docs#fileops-delete) (alias Dropbox.remove(path))

* [**Dropbox.delete(path)**](https://www.dropbox.com/developers/core/docs#fileops-delete) (alias Dropbox.remove(path))

* [**Dropbox.copy(from, to)**](https://www.dropbox.com/developers/core/docs#fileops-copy)

* [**Dropbox.move(from, to)**](https://www.dropbox.com/developers/core/docs#fileops-move)

## 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.