browse-everything 0.6.3 → 0.7.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTM5M2NhYWU1YjhlZGRmNjkwNDdmZWI5MGFkMjQ5MTliY2E0M2E4Mg==
-  data.tar.gz: !binary |-
-    NTg2NmE1MWZlMjQzZGUwYzAyZjljNWNmZTJlYjlhODdiMGY4NTIyYw==
+SHA1:
+  metadata.gz: 6a4e41392cdc521780aedf3a678593444dd23663
+  data.tar.gz: a34d71298ffa7a50258c4b7e9f1129c71bfa7b9c
 SHA512:
-  metadata.gz: !binary |-
-    NTY1MzhjMGVlOGZlOTNhMDlmMzAzOWYwMGI1NWYyMzlmMmU4N2U1MGU5NDdj
-    ZjQxMWMyYmM4NWZhN2E4NTQyMmVlZDVhOWI5NmNiYjVkNDU3ODhiNjgyZDFk
-    MmE2ZWFhMmNjMzRmNjIzZjYyZDdkZjUwNDE2MTA3YWVlMTU4MWU=
-  data.tar.gz: !binary |-
-    NjAxMDg3M2JmZmRiZTAwMWE4NTc4YTU0MmI0NmQzNTI5OTQ5YzNlZjZhY2Nk
-    N2MxOTBiZjAzMzljOGVkYjk5NzRkOTY4Njg0YTMzZTI3YzVjMmFkOTcwYmVh
-    NjhmMmE1NDRjMThjODE5NjhiOGIwYzVmYmZhOTNhZjM0ZGY2MTE=
+  metadata.gz: a92791fc15d5ea12d87ee7d33716cc1b5cf7e14507a7127b99bb2d7faf12747db4d652012cfbc15d16182593302e9a833ea767ee235f985d329c3b1c3e03ff63
+  data.tar.gz: 4cd5134d5e4204172e18dc5dff19d057b20f69a595c769f3666fdb8b08ad6cdfc63d893d8d13dc3045ad3f6010828ca8c5a1007713f1022ec2587d7cb1f0f435

data/.travis.yml

@@ -2,8 +2,9 @@ language: ruby
 rvm:
   - "1.9.3"
   - "2.0.0"
+  - "2.1.0"
 notifications:
   irc: "irc.freenode.org#projecthydra"
 env:
   global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true  
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true  

data/Gemfile

@@ -4,3 +4,9 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'spring',        group: :development
+
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+end

data/HISTORY.md

@@ -1,3 +1,8 @@
+### 0.7.0 (2014-12-10)
+- Add BrowseEverything::Retriever
+- Accessibility improvements
+- Bug fixes
+
 ### 0.6.3 (2014-08-06)
 - Treat FontAwesome version issues independently of Bootstrap version issues
 

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/browse-everything.png)](http://badge.fury.io/rb/browse-everything)
-[![Build Status](https://travis-ci.org/projecthydra/browse-everything.png?branch=master)](https://travis-ci.org/projecthydra/browse-everything)
+[![Build Status](https://travis-ci.org/projecthydra-labs/browse-everything.svg?branch=master)](https://travis-ci.org/projecthydra-labs/browse-everything)
 
 # BrowseEverything
 
@@ -12,6 +12,8 @@ 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.
 
+**This gem does not depend on hydra-head**
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -121,7 +123,7 @@ If you initialized browse-everything via JavaScript, the results data passed to
   }, {
     "url": "https://dl.dropbox.com/fake/Getting%20Started.pdf",
     "expires": "2014-03-31T20:37:36.731Z",
-    "file_name": "Getting+Started.pdf"
+    "file_name": "Getting Started.pdf"
   }
 ]
 ```
@@ -138,11 +140,37 @@ If you initialized browse-everything via data-attributes and set the _target_ op
   "1"=>{
     "url"=>"https://dl.dropbox.com/fake/Getting%20Started.pdf", 
     "expires"=>"2014-03-31T20:37:36.731Z", 
-    "file_name"=>"Getting+Started.pdf"
+    "file_name"=>"Getting Started.pdf"
   }
 }
 ```
 
+### Retrieving Files
+
+The `BrowseEverything::Retriever` class has two methods, `#retrieve` and `#download`, that
+can be used to retrieve selected content. `#retrieve` streams the file by yielding it, chunk
+by chunk, to a block, while `#download` saves it to a local file.
+
+Given the above response data:
+
+```ruby
+retriever = BrowseEverything::Retriever.new
+download_spec = params['selected_files']['1']
+
+# Retrieve the file, yielding each chunk to a block
+retriever.retrieve(download_spec) do |chunk, retrieved, total|
+  # do something with the `chunk` of data received, and/or
+  # display some progress using `retrieved` and `total` bytes.
+end
+
+# Download the file. If `target_file` isn't specified, the
+# retriever will create a tempfile and return the name.
+retriever.download(download_spec, target_file) do |filename, retrieved, total|
+  # The block is still useful for showing progress, but the
+  # first argument is the filename instead of a chunk of data.
+end
+```
+
 ### Examples
 
 See `spec/support/app/views/file_handler/index.html` for an example use case. You can also run `rake app:generate` to
@@ -156,3 +184,7 @@ create a fully-functioning demo app in `spec/internal` (though you will have to
 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
+
+## Help 
+
+For help with Questioning Authority, contact <hydra-tech@googlegroups.com>.

data/Rakefile

@@ -6,5 +6,6 @@ Dir.glob('tasks/*.rake').each { |r| import r }
 ENV["RAILS_ROOT"] ||= 'spec/internal'
 
 require 'rspec/core/rake_task'
+require 'engine_cart/rake_task'
 
-task :default => [:ci]
+task :default => [:ci]

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

@@ -3,7 +3,8 @@ $ ->
 
   initialize = (obj,options) ->
     if $('div#browse-everything').length == 0
-      dialog = $('<div id="browse-everything" class="ev-browser modal fade"></div>').hide().appendTo('body')
+      dialog = $('<div tabindex="-1" id="browse-everything" class="ev-browser modal fade" aria-live="polite" role="dialog" aria-labelledby="beModalLabel"></div>').hide().appendTo('body')
+
     dialog.modal
       backdrop: 'static'
       show:     false 
@@ -25,7 +26,7 @@ $ ->
   toHiddenFields = (data) ->
     fields = $.param(data)
       .split('&')
-      .map (t) -> t.split('=',2)
+      .map (t) -> t.replace('+',' ','g').split('=',2)
     elements = $(fields).map () ->
       $("<input type='hidden'/>")
         .attr('name',decodeURIComponent(this[0]))
@@ -45,22 +46,29 @@ $ ->
       onNodeExpand: ->
         node = this
         $('body').css('cursor','wait')
-        $.ajax
-          async: false # Must be false, otherwise loadBranch happens after showChildren?
-          url: $('a.ev-link',node.row).attr('href')
-          data:
-            parent: node.row.data('tt-id')
-            accept: dialog.data('context').opts.accept
-            context: dialog.data('context').opts.context
-        .done (html) ->
-          rows = $('tbody tr',$(html))
-          table.treetable("loadBranch", node, rows)
-          sizeColumns(table)
-          indicateSelected()
-        .always ->
-          $('body').css('cursor','default')
+        $("html").addClass("wait")
+        size = $(node.row).find('td.ev-file-size').text().trim()
+        start = 1
+        increment = 1
+        if (size.indexOf("MB") >-1)
+          start = 10
+          increment = 5
+        if (size.indexOf("KB") >-1)
+          start = 50
+          increment = 10
+        setProgress(start)
+        progressIntervalID = setInterval (->
+          start = start + increment
+          if start > 99
+            start = 99
+          setProgress(start)
+        ), 2000
+        setTimeout (->
+          loadFiles(node, table, progressIntervalID)
+        ), 10
+    $("#file-list tr:first").focus()
     sizeColumns(table)
-    
+
   sizeColumns = (table) ->
     full_width = $('.ev-files').width()
     table.width(full_width)
@@ -71,6 +79,32 @@ $ ->
     set_size '.ev-kind', 0.3
     set_size '.ev-date', 0.2
 
+  loadFiles = (node, table, progressIntervalID)->
+    $.ajax
+      async: true # Must be false, otherwise loadBranch happens after showChildren?
+      url: $('a.ev-link',node.row).attr('href')
+      data:
+        parent: node.row.data('tt-id')
+        accept: dialog.data('context').opts.accept
+        context: dialog.data('context').opts.context
+    .done (html) ->
+      setProgress('100')
+      clearInterval progressIntervalID
+      rows = $('tbody tr',$(html))
+      table.treetable("loadBranch", node, rows)
+      $(node).show()
+      sizeColumns(table)
+      indicateSelected()
+    .always ->
+        clearInterval progressIntervalID
+        $('body').css('cursor','default')
+        $("html").removeClass("wait")
+
+  setProgress = (done)->
+    $('#loading_progress').css('width',done+'%')
+    $('#loading_progress').html(done+'% complete')
+    $('#loading_progress').attr('aria-valuenow', done)
+
   refreshFiles = ->
     $('.ev-providers select').change()
     
@@ -86,6 +120,7 @@ $ ->
           setTimeout refreshFiles, 500
           ctx.callbacks.show.fire()
           dialog.modal('show')
+
     if ctx
       ctx.callback_proxy
     else 
@@ -125,6 +160,7 @@ $ ->
     .always ->
       $('body').css('cursor','default')
       $('.ev-browser').modal('hide')
+      $('#browse-btn').focus()
 
   $(document).on 'click', '.ev-files table tr', (event) ->
     $('a.ev-link',this).click() unless event.target.nodeName == 'A'
@@ -148,9 +184,13 @@ $ ->
     .done (data) ->
       $('.ev-files').html(data)
       indicateSelected();
+      $('#provider_auth').focus();
       tableSetup($('table#file-list'))
     .fail (xhr,status,error) ->
-      $('.ev-files').html(xhr.responseText)
+      if (xhr.responseText.indexOf("Refresh token has expired")>-1)
+        $('.ev-files').html("Your sessison has expired please clear your cookies.")
+      else
+        $('.ev-files').html(xhr.responseText)
     .always ->
       $('body').css('cursor','default')
 

data/app/views/browse_everything/_auth.html.erb

@@ -1,3 +1,3 @@
 <h2><%=t('browse_everything.auth_prompt.head', provider: provider.name)%></h2>
 <p><%=t('browse_everything.auth_prompt.text', provider: provider.name)%></p>
-<p><%= link_to t('browse_everything.auth_prompt.button_text', provider: provider.name), auth_link, class:"btn btn-primary ev-auth", target:'blank' %></p>
+<p><%= link_to t('browse_everything.auth_prompt.button_text', provider: provider.name), auth_link, class:"btn btn-primary ev-auth", target:'blank', id:'provider_auth' %></p>

data/app/views/browse_everything/_file.html.erb

@@ -1,17 +1,19 @@
 <% unless file.relative_parent_path? %>
-<tr data-ev-location="<%= file.location %>" data-tt-id="<%=path%>" data-tt-parent-id="<%=parent%>" data-tt-branch="<%=file.container? ? 'true' : 'false'%>">
-  <td class="<%=file.container? ? 'ev-container' : 'ev-file'%> ev-file-name">
-    <span class="<%=file.container? ? 'folder' : 'file'%>">
-      <%= link_to(file.name, browse_everything_engine.contents_path(provider_name,file.id), {:class=>'ev-link'}) %>
-    </span>
+<tr role="row" tabindex="-1" data-ev-location="<%= file.location %>" data-tt-id="<%=path%>" data-tt-parent-id="<%=parent%>" data-tt-branch="<%=file.container? ? 'true' : 'false'%>">
+  <td role="gridcell" class="<%=file.container? ? 'ev-container' : 'ev-file'%> ev-file-name">
+      <%= link_to browse_everything_engine.contents_path(provider_name,file.id), {:class=>'ev-link'} do %>
+        <span class="<%=file.container? ? 'folder' : 'file'%>" aria-hidden="true"/>
+        <%= file.name %>
+        <span class="sr-only"><%= file.container? ? ', folder' : ', file' %> </span>
+      <% end %>
   </td>
-  <td class="ev-file-size">
+  <td role="gridcell" class="ev-file-size">
     <%= number_to_human_size(file.size).sub(/Bytes/,'bytes') %>
   </td>
-  <td class="ev-file-kind">
+  <td role="gridcell" class="ev-file-kind">
     <%= file.type %>
   </td>
-  <td class="ev-file-date">
+  <td role="gridcell" class="ev-file-date">
     <%= file.mtime.strftime('%F %R') %>
   </td>
 </tr>

data/app/views/browse_everything/_files.html.erb

@@ -1,11 +1,16 @@
 <% if provider.present? %>
-  <table id="file-list">
+  <div class="progress" id="loading_progress" aria-live="polite">
+    <div class="progress-bar" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 100%;">
+      100% Complete
+    </div>
+  </div>
+  <table id="file-list" role="grid" tabindex="-1" title="Choose files to upload from the table below" aria-live="polite">
     <thead>
-      <tr>
-        <th>Name</th>
-        <th>Size</th>
-        <th>Kind</th>
-        <th>Modified</th>
+      <tr role="row" tabindex="-1">
+        <th role="columnheader">Name</th>
+        <th role="columnheader">Size</th>
+        <th role="columnheader">Kind</th>
+        <th role="columnheader">Modified</th>
       </tr>
     </thead>
     <% provider.contents(browse_path).each_with_index do |file,index| %>

data/app/views/browse_everything/index.html.erb

@@ -1,11 +1,12 @@
-<% if bootstrap_three? %><div class="modal-content"><% end %>
+<% if bootstrap_three? %><div class="modal-dialog"><div class="modal-content"><% end %>
   <div class="modal-header">
+    <h4 class="sr-only" id="beModalLabel">Select a provider in the list to browse your files.</h4>
     <div class="ev-providers">
       <%= render :partial => 'providers' %>
     </div>
   </div>
-  <div class="modal-body ev-body">
-    <div class="ev-browser row<%=bs2('-fluid')%>">
+  <div class="modal-body ev-body" tabindex="-1">
+    <div class="ev-browser row<%=bs2('-fluid')%>" aria-live="polite">
       <div class="<%=fa3or4('fa3','fa4')%> <%=bs2or3('bs2 span','bs3 col-xs-')%>12 ev-files list">
         <%= render :partial => 'files' %>
       </div>
@@ -19,4 +20,4 @@
       <button class="ev-submit btn btn-primary" data-loading-text="Loading..."><%= t('browse_everything.modal_form.submit')%></button>
     <% end %>
   </div>
-<% if bootstrap_three? %></div><% end %>
+<% if bootstrap_three? %></div></div><% end %>

data/browse-everything.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bootstrap-sass"
   spec.add_dependency "font-awesome-rails"
   spec.add_dependency "google-api-client"
+  spec.add_dependency "httparty"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "rspec-its"
@@ -38,5 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "factory_girl_rails"
+  spec.add_development_dependency "engine_cart"
 
 end

data/lib/browse_everything.rb

@@ -1,6 +1,7 @@
 require "rails"
 require "browse_everything/version"
 require "browse_everything/engine"
+require "browse_everything/retriever"
 
 module BrowseEverything
   class InitializationError < RuntimeError; end

data/lib/browse_everything/driver/box.rb

@@ -43,7 +43,7 @@ module BrowseEverything
         file = box_client.file(path)
         download_url = file.download_url
         auth_header = {'Authorization' => "Bearer #{@token}"}
-        extras = { auth_header: auth_header, expires: 1.hour.from_now, file_name:file.name }
+        extras = { auth_header: auth_header, expires: 1.hour.from_now, file_name: file.name, file_size: file.size.to_i }
         [download_url,extras]
       end
 
@@ -120,4 +120,4 @@ module BrowseEverything
     end
 
   end
-end
+end

data/lib/browse_everything/driver/drop_box.rb

@@ -38,7 +38,7 @@ module BrowseEverything
       end
 
       def link_for(path)
-        [client.media(path)['url'], { expires: 4.hours.from_now, file_name: File.basename(path) }]
+        [client.media(path)['url'], { expires: 4.hours.from_now, file_name: File.basename(path), file_size: client.metadata(path)['bytes'].to_i }]
       end
 
       def details(path)

data/lib/browse_everything/driver/file_system.rb

@@ -50,7 +50,9 @@ module BrowseEverything
       end
 
       def link_for(path)
-        ["file://#{File.expand_path(path)}", { file_name: File.basename(path) }]
+        full_path = File.expand_path(path)
+        file_size = File.size(full_path).to_i rescue 0
+        ["file://#{full_path}", { file_name: File.basename(path), file_size: file_size }]
       end
 
       def authorized?
@@ -59,4 +61,4 @@ module BrowseEverything
     end
 
   end
-end
+end

data/lib/browse_everything/driver/google_drive.rb

@@ -61,7 +61,12 @@ module BrowseEverything
         api_result = oauth_client.execute(api_method: api_method, parameters: {fileId: id})
         download_url = JSON.parse(api_result.response.body)["downloadUrl"]
         auth_header = {'Authorization' => "Bearer #{oauth_client.authorization.access_token.to_s}"}
-        extras = { auth_header: auth_header, expires: 1.hour.from_now, file_name:api_result.data.title }
+        extras = { 
+          auth_header: auth_header,
+          expires: 1.hour.from_now, 
+          file_name: api_result.data.title,
+          file_size: api_result.data.fileSize.to_i
+        }
         [download_url, extras]
       end
 
@@ -123,4 +128,4 @@ module BrowseEverything
     end
 
   end
-end
+end

data/lib/browse_everything/driver/sky_drive.rb

@@ -47,7 +47,7 @@ module BrowseEverything
 
       def link_for(path)
         response = Skydrive::Client.new(rehydrate_token).get("/#{real_id(path)}/")
-        [response.download_link, {expires: 1.hour.from_now, file_name: File.basename(path)}]
+        [response.download_link, {expires: 1.hour.from_now, file_name: File.basename(path), file_size: response.size.to_i}]
       end
 
 

data/lib/browse_everything/retriever.rb

@@ -0,0 +1,60 @@
+require 'httparty'
+require 'tempfile'
+
+module BrowseEverything
+  class Retriever
+    attr_accessor :chunk_size
+    
+    def initialize
+      @chunk_size = 16384
+    end
+    
+    def download(spec, target=nil)
+      if target.nil?
+        ext = File.extname(spec['file_name'])
+        base = File.basename(spec['file_name'],ext)
+        target = Dir::Tmpname.create([base,ext]) {}
+      end
+      
+      File.open(target, 'wb') do |output|
+        self.retrieve(spec) do |chunk, retrieved, total| 
+          output.write(chunk) 
+          yield(target, retrieved, total) if block_given?
+        end
+      end
+      return target
+    end
+    
+    def retrieve(spec, &block)
+      if spec.has_key?('expires') and Time.parse(spec['expires']) < Time.now
+        raise ArugumentError, "Download spec expired at #{spec['expires']}"
+      end
+      
+      url = URI.parse(spec['url'])
+      retrieved = 0
+      case url.scheme
+      when 'file'
+        File.open(url.path,'rb') do |f|
+          while not f.eof?
+            chunk = f.read(chunk_size)
+            retrieved += chunk.length
+            yield(chunk, retrieved, spec['file_size'].to_i)
+          end
+        end
+      when /https?/
+        headers = spec['auth_header'] || {}
+        headers.each_pair do |k,v|
+          headers[k] = v.gsub(/\+/,' ')
+        end
+        
+        HTTParty.get(url.to_s, headers: headers) do |chunk| 
+          retrieved += chunk.length
+          yield(chunk, retrieved, spec['file_size'].to_i)
+        end
+      else
+        raise URI::BadURIError, "Unknown URI scheme: #{uri.scheme}"
+      end
+    end
+
+  end
+end