A condo for your users files
Ruby
Latest commit 88e4d34 Sep 26, 2016 Stephen von Takach (openstack) request method is now private

README.textile

Condominios aka Condo

A Rails plugin and AngularJS application that makes direct uploads to multiple cloud storage providers easy.
Only supports XMLHttpRequest Level 2 capable browsers and cloud providers that have a RESTful API with CORS support.

Why compromise?

Get started now: gem install condo or checkout the example application
Also see our github pages site

License

GNU Lesser General Public License v3 (LGPL version 3)

Concept

Condominios was created to provide direct to cloud uploads using standards based browser technology. However it is not limited to that use case.
The API is RESTful, providing an abstraction layer and signed URLs that can be utilised in native (mobile) applications.

The main advantages are:

  • Off-loads processing to client machines
  • Better guarantees against upload corruption
    • file hashing on the client side
  • Upload results are guaranteed
    • user is always aware of any failures in the process
  • Detailed progress and control over the upload

This has numerous advantages over traditional Form Data style post uploads too.

  • Progress bars
  • Resumability when uploading large files
  • Optional parallel uploads (multiple parts of the file simultaneously)

Support for all major browsers

  • Chrome
  • Firefox
  • Safari
  • Opera
  • IE10+

Usage

Terms

  • Residence == the current storage provider
  • Resident == the current user

Quick Start

See the example application which implements the steps below on an otherwise blank rails app.

  1. Add the following to your rails application gemfile:
    • gem 'condo'
    • Add a datastore
    • gem 'condo_interface' (optional – an example interface)
  2. Run migrations if using active record
    • rake railties:install:migrations FROM=condo_active_record
    • rake db:migrate
  3. Create an initialiser for any default residencies. (details further down)
  4. Create controllers that will be used as Condo endpoints
    • Typically rails g controller Uploads
    • Add the resource to your routes
  5. At the top of the new controller add the following line to the class: include Condo
    • This creates the following public methods at run time: new, create, edit, update, destroy implementing the API
    • The following protected methods are also generated: set_residence, current_residence, current_resident, current_upload
  6. You are encouraged to use standard filters to authenticate users and set the residence (if this is dynamic) + implement index / show if desired
  7. You must implement the following call-backs:
    • resident_id – this should provide a unique identifier for the current user, used for authorisation
    • upload_complete – provides the upload information for storage in the greater application logic. Return true if successful.
    • destroy_upload – provides the upload information so that a scheduled task can be created to clean up the upload. Return true if successfully scheduled.
      • This should be done in the background using something like Fog Can’t trust the client

If you are using Condo Interface then you may want to do the following:

  1. Create an index for your controller def index; end
  2. Create an index.html.erb in your view with:
  3. Make sure your AngularJS app includes: angular.module('YourApp', ['Condo', 'CondoInterface']);
    • <div data-ng-app="YourApp"><%= render "condo_interface/upload" %></div>

Alternative you could load an AngularJS template linking to <%= asset_path(‘templates/_upload.html’) %>

Defining Static Residencies

If you are creating an application that only communicates with one or two storage providers or accounts then this is the simplest way to get started.
In an initialiser do the following:


Condo::Configuration.add_residence(:AmazonS3, {
    :access_id => ENV['S3_KEY'],
    :secret_key => ENV['S3_SECRET']
    # :location => 'us-west-1'    # or 'ap-southeast-1' etc (see http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region)
                                # Defaults to 'us-east-1' or US Standard - not required for Google
    # :namespace => :admin_resident    # Allows you to assign different defaults to different controllers or users etc
})

The first residence to be defined in a namespace will be the default. To change the residence for the current request use set_residence(:name, :location) – location is optional
Currently available residencies:

  • :AmazonS3
  • :GoogleCloudStorage
  • :RackspaceCloudFiles (Works with Swift left as rackspace for backwards compatibility)

Note:: There is also a callback to dynamically set storage provider. Which is useful if your users use:

  • Their own bucket
  • Different cloud providers etc

Callbacks

These are pretty well defined here