Reddrop

---

Description

Reddrop is a plugin for Redmine that allows users of that service to sync their documents and files using Dropbox. Reddrop is a replacement for the files and documents tabs in Redmine and allows to browse a Dropbox's folder hierarchically.

Also, the user can upload his files from Dropbox to Redmine only by clicking a link. These files will be available in the Redmine documents tab.

Compatibility

Reddrop is compatible with the following versions :

• 2.0.3 (tested)
• 2.3.0 (tested)
• 2.4.2 (tested)
• 2.5.1 (tested)

Let me know if you succeeded run it on other versions.

Install & Uninstall

Before install

You have to get your own Dropbox's API keys :

1. Go to https://www.dropbox.com/developers/apps
2. Create app (Dropbox API app, Files and datastores, No My app needs access to files already on Dropbox, All file types)
3. Apply for production
4. Configure the appkey and appsecret in redmine_reddrop/app/models/daccess.rb
5. Configure the URLs as explained in the file comments in redmine_reddrop/app/models/uploadurls.rb
6. Be sure to check Enable REST web service in Administration -> Settings -> Authentication

How to install

Once you've configured your Dropbox's keys, simply follow this steps :

1. add the redmine_reddrop folder in the #{RAILS_ROOT}/plugins folder of your Redmine installation.
2. run $ bundle install
3. run $ rake redmine:plugins:migrate RAILS_ENV=production (you should make a DB backup before)
4. restart Redmine

And that's all, you should be able to view the plugin in Administration -> Plugins and start using it.

How to uninstall

To uninstall Reddrop, simply follow this steps :

1. run $ rake redmine:plugins:migrate NAME=redmine_reddrop VERSION=0 RAILS_ENV=production (you should make a DB backup before)
2. remove redmine_reddrop from #{RAILS_ROOT}/plugins
3. run $ bundle install
4. restart Redmine

And that's all, the plugin is removed from your Redmine.

Functionalities

User functionalities

Link your Dropbox account to Redmine

You have to link your account before you can use the plugin.

In order to link you Dropbox account to Redmine go to "Reddrop Linking" page with the top left menu. On this page, you can link or unlink a Dropbox account depending on whether you have already linked your account or not.

Reddrop a project

When you've linked your Dropbox account with your Redmine account, you're able to "Reddrop" a project.

Go on a project page and then Reddrop tab. You will find a "Reddrop this project" link on the sidebar of each Reddrop tab. Once you've Reddroped a project, the structure of folders will be generated on your Dropbox and other users will be able to consult them. The generated folders are located at /Reddrop/project-id/ in your Dropbox. Each changes in your Dropbox folders will be reflected in Redmine.

Consult folders of a project

Go on a project page and then Reddrop Tab. In the main part of the page, you'll find all users that have reddroped this project. Select a user and you will be able to browse its folders, add and remove files.

Perform a Dropbox -> Redmine synchronisation

Once a project is Reddroped, the user can synchronise all the files present in his Dropbox folder project with the Redmine Documents tab. This will upload all the files from Dropbox to Redmine.

Share a Reddrop folder

You can use the Dropbox "shared folders" option to share folders that are linked to Redmine with Reddrop. Simply share any folders you want to but remember that only one person have to Reddrop this folder to avoid duplication.

Usual process for a group

Only one person reddrop the project on Redmine and share it with others with Dropbox "shared folders" functionality.

Admin functionalities

Configure permissions

There is two permissions that you can manage : "Reddrop consult projectfolders" which allows consulting linked Dropboxs and "Reddrop interact projectfolders" which allows to add and remove files in the linked Dropboxs.

In order to modify this permissions, simply go to Administration -> Roles and permissions. They are grouped as "Reddrop".

Configure generated folders

As an admin, you can configure folders that are generated in the user's Dropbox when they Reddrop a project.

In order to access this functionality, go to Administration -> Reddrop settings. On this page you can add, remove or rename folders that are generated.

Inspect database

If a problem occurs during the synchronisation, some files could be added in the database but not accessible by the user. In order to prevent "trash files" in the database a little menu allows the administrator to delete these entries simply.

License

Copyright (c) 2012 Alrick Deillon

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.