Wf4Ever - Prototype 1 - Dropbox Connector App
Ruby JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
autotest
config
db
doc
features cucumber/rails/active_record not found anymore - simply 'cucumber/rai… Apr 15, 2011
lib
public
script
spec
vendor/plugins Added the better_logging plugin for nicer production logs Feb 25, 2011
.autotest
.gitignore
.project
.rspec Initial skeletion application. Time to fill it in chums! Feb 25, 2011
.rvmrc When using RVM, create gemset if not already available Apr 7, 2011
Gemfile Sync from ROSRS to Dropbox (first draft!) Oct 4, 2011
Gemfile.lock
README.md Don't need so many rake db tasks, just need the one rake db:setup May 20, 2011
Rakefile
config.ru
version_info.yml Upgraded and locked down dependencies; updated version; updated Sass … Sep 1, 2011

README.md

ROBox - Connecting Research Objects in your Dropbox

This is being developed as part of the Prototype 1 work in the Wf4Ever project.

It allows users to register their Dropbox accounts and have their folders of Research Objects sychronise with a Research Object repository.

How it Works

See the wiki page for Dropbox RO Connector (ROBox)

Check out the doc directory for some diagrams

Installation (for Production use)

Dependencies

  • Ruby 1.9.2 and development headers (ruby-dev)
  • MySQL 5 and development headers (mysql-dev)
  • Git 1.7+

Set up (not finished)

  • gem install bundler
  • git clone git://github.com/wf4ever/prototype1-dropbox.git
  • bundle --deployment
  • Set up config/database.yml
  • Set up config/settings/custom.yml
  • rake db:setup
  • jammit
  • gem install passenger
  • Set up passenger in Apache
  • Set up application in Apache
  • ... more to come

Running

Test the web server

rails server RAILS_ENV=production

Then open http://localhost:3000 in your browser

How to run the background sync jobs

First, run the background job worker:

ruby script/delayed_job start

This will run in the background until you stop it using:

ruby script/delayed_job stop

To then submit a fresh batch of sync jobs:

rake robox:sync_jobs

Development

Follow the installation instructions above, except:

  • Do git clone git@github.com:wf4ever/prototype1-dropbox.git instead.
  • Run bundle install instead of bundle --deployment.
  • Don't do the Passenger and Apache set up.

To run the tests

rake spec

To have tests running continually in the background

autotest

This will run the appropriate test(s) when file(s) are changed

To run a local development server

rails server

Then open http://localhost:3000 in your browser

To completely delete your database and create a fresh new one

rake db:drop && rake db:create && rake db:migrate && rake db:seed && rake db:test:prepare

To re-annotate Models with database schema info

annotate --position=before --show-migration --show-indexes

To re-annotate the Routes file with a list of routes

annotate --routes

To generate the diagrams in the doc folder

rake diagram:all

MUST have dot, neato and sed available on the command line

Useful development links