browse-everything 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/internal
+browse_everything_providers.yml

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+notifications:
+  irc: "irc.freenode.org#projecthydra"

data/CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# How to Contribute
+
+We want your help to make Project Hydra great.
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+
+## Hydra Project Intellectual Property Licensing and Ownership
+
+All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
+If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
+
+https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+
+You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
+
+## Contribution Tasks
+
+* Reporting Issues
+* Making Changes
+* Submitting Changes
+* Merging Changes
+
+### Reporting Issues
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a [Github issue](./issues) by:
+  * Clearly describing the issue
+    * Provide a descriptive summary
+    * Explain the expected behavior
+    * Explain the actual behavior
+    * Provide steps to reproduce the actual behavior
+
+### Making Changes
+
+* Fork the repository on GitHub
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
+  * Then checkout the new branch with `git checkout fix/master/my_contribution`.
+  * Please avoid working directly on the `master` branch.
+  * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
+* Make commits of logical units.
+  * Your commit should include a high level description of your work in HISTORY.textile 
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
+
+```
+    Present tense short summary (50 characters or less)
+
+    More detailed description, if necessary. It should be wrapped to 72
+    characters. Try to be as descriptive as you can, even if you think that
+    the commit content is obvious, it may not be obvious to others. You
+    should add such description also if it's already present in bug tracker,
+    it should not be necessary to visit a webpage to check the history.
+
+    Include Closes #<issue-number> when relavent.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_with Post.limit(10)
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks
+
+    - also, try to indent next line of a point for readability, if it's too
+      long to fit in 72 characters
+```
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+* When you are ready to submit a pull request
+
+### Submitting Changes
+
+[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
+
+* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
+* Make sure your branch is up to date with its parent branch (i.e. master)
+  * `git checkout master`
+  * `git pull --rebase`
+  * `git checkout <your-branch>`
+  * `git rebase master`
+  * It is likely a good idea to run your tests again.
+* Squash the commits for your branch into one commit
+  * `git rebase --interactive HEAD~<number-of-commits>` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * To determine the number of commits on your branch: `git log master..<your-branch> --oneline | wc -l`
+  * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request from your fork to the project.
+
+### Merging Changes
+
+* It is considered "poor from" to merge your own request.
+* Please take the time to review the changes and get a sense of what is being changed. Things to consider:
+  * Does the commit message explain what is going on?
+  * Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
+  * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
+  * Did the Travis tests complete successfully?
+* If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
+* If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
+* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in browse_everything.gemspec
+gemspec

data/HISTORY.md

@@ -0,0 +1,2 @@
+### 0.1.0 (2013-09-24)
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Klein
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,164 @@
+[![Build Status](https://travis-ci.org/projecthydra/browse-everything.png?branch=master)](https://travis-ci.org/projecthydra/browse-everything)
+
+# BrowseEverything
+
+This Gem allows your rails application to access user files from cloud storage.  
+Currently there are drivers implemented for [DropBox](http://www.dropbox.com), 
+[Skydrive](https://skydrive.live.com/), [Google Drive](http://drive.google.com), 
+[Box](http://www.box.com), and a server-side directory share.
+
+The gem uses [OAuth](http://oauth.net/) to connect to a user's account and 
+generate a list of single use urls that your application can then use to 
+download the files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'browse-everything'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install browse-everything
+
+## Usage
+
+### Configuration
+
+To use the gem you will need to configure the providers by providing applcation keys that are required by each provider
+
+An example config/browse_everything_providers.yml:
+
+```yaml
+---
+file_system:
+  :home: /<location for server file drop>
+sky_drive:
+  :client_id: <your client id>
+  :client_secret: <your client secret>
+box:
+  :client_id: <your client id>
+  :client_secret: <your client secret>
+drop_box:
+  :app_key: <your client id>
+  :app_secret: <your app secret>
+google_drive:
+  :client_id: <your client id>
+  :client_secret: <your client secret>
+```
+
+You must register your application with each cloud provider separately:
+
+* Skydrive: [https://account.live.com/developers/applications/create](https://account.live.com/developers/applications/create)
+* Dropbox: [https://www.dropbox.com/developers/apps/create](https://www.dropbox.com/developers/apps/create)
+* Box: [https://app.box.com/developers/services/edit/](https://app.box.com/developers/services/edit/)
+* GoogleDrive: [https://code.google.com/apis/console](https://code.google.com/apis/console)
+
+### CSS and JavaScript Modifications
+
+Add `@import "browse_everything` to your application.css.scss
+
+Add `//= require browse_everything` to your application.js
+
+### Routes
+
+Mount the engine in your routes.rb
+
+```
+  mount BrowseEverything::Engine => '/browse'
+```
+
+### Views
+
+browse-everything can be triggered in one of two ways:
+
+#### Via data attributes
+
+```html
+<button type="button" data-toggle="browse-everything" data-route="<%=browse_everything_engine.root_path%>" 
+  data-target="#myForm" class="btn btn-large btn-success" id="browse">Browse!</button>
+```
+
+#### Via JavaScript
+
+```javascript
+$('#browse').browseEverything(options)
+```
+
+#### Options
+
+Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, 
+as in `data-target="#myForm"`.
+
+| Name            | type            | default         | description                                                    |
+|-----------------|-----------------|-----------------|----------------------------------------------------------------|
+| route           | path (required) | ''              | The base route of the browse-everything engine.                |
+| target          | xpath or jQuery | null            | A form object to add the results to as hidden fields.          |
+
+If a `target` is provided, browse-everything will automatically convert the JSON response to a series of hidden form fields
+that can be posted back to Rails to re-create the array on the server side. 
+
+#### Methods
+
+##### .browseEverything(options)
+
+Attaches the browsing behavior to the click event of the receiver.
+
+```javascript
+$('#browse').browseEverything({
+  route: "/browse",
+  target: "#myForm"
+}).done(function(data) {
+  // User has submitted files; data contains an array of URLs and their options
+}).cancel(function() {
+  // User cancelled the browse operation
+}).fail(function(status, error, text) {
+  // URL retrieval experienced a techical failure
+});
+```
+
+##### .browseEverything()
+
+Returns the existing callback object for the receiver, allowing for a mix of data attribute and JavaScript modes.
+
+```html
+<button type="button" data-toggle="browse-everything" data-route="/browse" 
+  data-target="#myForm" class="btn btn-large btn-success" id="browse">Browse!</button>
+
+<script>
+  $(document).ready(function() {
+    $('#browse').browseEverything().done(function(data) {
+      // Set the "done" callback for the already-defined #browse button
+    })
+  });
+</script>
+```
+
+#### Data Structure
+
+browse-everything returns a JSON data structure consisting of an array of URL specifications. Each URL specification
+is a plain object with the following properties:
+
+| Property           | Description                                                                          |
+|--------------------|--------------------------------------------------------------------------------------|
+| url                | The URL of the selected remote file.                                                 |
+| auth_header        | Any headers that need to be added to the request in order to access the remote file. |
+| expires            | The expiration date/time of the specified URL.                                       |
+
+### Examples
+
+See `spec/support/app/views/file_handler/index.html` for an example use case. You can also run `rake app:generate` to
+create a fully-functioning demo app in `spec/internal` (though you will have to create 
+`spec/internal/config/browse_everything.providers.yml` file with your own configuration info.)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/*.rake').each { |r| import r }
+
+ENV["RAILS_ROOT"] ||= 'spec/internal'
+
+require 'rspec/core/rake_task'
+
+task :default => [:ci]

data/app/assets/javascripts/browse_everything.js

@@ -0,0 +1,3 @@
+//= require jquery
+//= require bootstrap
+//= require browse_everything/behavior

data/app/assets/javascripts/browse_everything/behavior.js.coffee

@@ -0,0 +1,110 @@
+$(document).ready ->
+  context = {}
+  active = null
+  dialog = $('div#browse-everything')
+
+  initialize = (obj,options) ->
+    if dialog.length == 0
+      dialog = $('<div id="browse-everything" class="ev-browser modal hide fade"></div>').appendTo('body')
+    dialog.modal({ backdrop: 'static', show: false });
+    context[obj] = 
+      opts: $.extend(true, {}, options)
+      callbacks:
+        done: $.Callbacks()
+        cancel: $.Callbacks()
+        fail: $.Callbacks()
+    ctx = context[obj]
+    ctx.callback_proxy = 
+      done:   (func) -> ctx.callbacks.done.add(func)   ; return this
+      cancel: (func) -> ctx.callbacks.cancel.add(func) ; return this
+      fail:   (func) -> ctx.callbacks.fail.add(func)   ; return this
+    ctx
+
+  toHiddenFields = (data) ->
+    fields = $.param(data)
+      .split('&')
+      .map (t) -> t.split('=',2)
+    elements = $(fields).map () ->
+      "<input type='hidden' name='#{decodeURIComponent(this[0])}' value='#{decodeURIComponent(this[1])}'/>"
+    $(elements.toArray().join("\n"))
+
+  $.fn.browseEverything = (options) ->
+    if options?
+      initialize(this[0], options)
+      $(this).click () ->
+        active = context[this]
+        dialog.load active.opts.route, () -> dialog.modal('show')
+    else
+      context[this[0]].callback_proxy
+
+  triggers = $('*[data-toggle=browse-everything]')
+  triggers.each () -> $(this).browseEverything($(this).data())
+
+  $(document).on 'click', 'button.ev-cancel', (event) ->
+    event.preventDefault()
+    active.callbacks.cancel.fire()
+    $('.ev-browser').modal('hide')
+
+  $(document).on 'click', 'button.ev-submit', (event) ->
+    event.preventDefault()
+    $(this).button('loading')
+    $('body').css('cursor','wait')
+    main_form = $(this).closest('form')
+    resolver_url = main_form.data('resolver')
+    $.ajax resolver_url,
+      type: 'POST'
+      dataType: 'json'
+      data: main_form.serialize()
+    .done (data) ->
+      if active.opts.target?
+        fields = toHiddenFields({selected_files: data})
+        $(active.opts.target).append($(fields))
+      active.callbacks.done.fire(data)
+    .fail (xhr,status,error) ->
+      active.callbacks.fail.fire(status, error, xhr.responseText)
+    .always ->
+      $('body').css('cursor','default')
+      $('.ev-browser').modal('hide')
+
+  $(document).on 'click', '.ev-container a', (event) ->
+    event.preventDefault()
+    $('body').css('cursor','wait')
+    $.ajax($(this).attr('href'))
+    .done (data) ->
+      $('.ev-files').html(data)
+      $('input.ev-url').each () ->
+        $("*[data-ev-location='#{$(this).val()}']").addClass('ev-selected')
+    .fail (xhr,status,error) ->
+      $('.ev-files').html(xhr.responseText)
+    .always ->
+      $('body').css('cursor','default')
+
+  $(document).on 'click', '.ev-providers a', (event) ->
+    $('.ev-providers li').removeClass('ev-selected')
+    $(this).closest('li').addClass('ev-selected')
+
+  $(document).on 'click', '.ev-file a', (event) ->
+    event.preventDefault()
+    target = $(this).closest('*[data-ev-location]')
+    target_form = $('form.ev-submit-form')
+    file_location = target.data('ev-location')
+    target.toggleClass('ev-selected')
+    if target.hasClass('ev-selected')
+      hidden_input = $("<input type='hidden' class='ev-url' name='selected_files[]' value='#{file_location}'>")
+      target_form.append(hidden_input)
+    else
+      $("form.ev-submit-form input[value='#{file_location}']").remove()
+
+    count = $('input.ev-url').length
+    files = if count == 1 then "file" else "files"
+    $('.ev-status').html("#{count} #{files} selected")
+
+  $(document).on 'click', '.ev-auth', (event) ->
+    event.preventDefault()
+    auth_win = window.open($(this).attr('href'))
+    check_func = ->
+      if auth_win.closed
+        $('.ev-providers .ev-selected a').click()
+      else
+        window.setTimeout check_func, 1000
+    check_func()