browse-everything 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1321ca84320f83f10929d0559cb09f897f30f24
-  data.tar.gz: 1dca717478b686eebded6fb96b4822f636bdc8c3
+  metadata.gz: 517bf8920fbeb90a14f3f2e1d3c33f73d68c0578
+  data.tar.gz: 3abe80da837a6adafc95893c3a9a0cbba89bdd1c
 SHA512:
-  metadata.gz: 2cbc9788fa805c061a81278640f3cca1f736f63a0df3e618d5761773a511c534cc3b4598f81989d3eeef0997ceb58ee26272bda85e57c9c495a68f8eda72493e
-  data.tar.gz: eddf4834ffde69d653627116e60178015152238258fbb2e56f3ce3257dc8ae082b3daf5e0da47b11c21227289e827e329d0bfcc0d19afd8e5b6e1e2bf0414987
+  metadata.gz: efdb8266d087e847282d2822a49a4363e33c5e070f65df84a16156077df9fd8704a0c1289ec7ece5df5244fec5a08f18c0a7fa64fc2daf78a9cef21f9bbdd6e5
+  data.tar.gz: 1b5a31483ea411070cc6fcbeb790ada41cc34afd102f5df8d28561e70e7f8a05fa5f7df98608adc51c543dcd12b7ee9bd6c32c4c8b4f64249db0354fc6d05f87

data/.engine_cart.yml

@@ -0,0 +1 @@
+rails_options: "<%= '--skip-listen' if ENV.fetch('RAILS_VERSION', '') < '5.0' %>"

data/.rubocop.yml

@@ -11,6 +11,9 @@ AllCops:
 Rails:
   Enabled: true
 
+Metrics/ClassLength:
+  Max: 130
+  
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 400
@@ -26,3 +29,6 @@ RSpec/LeadingSubject:
 
 Style/NumericLiterals:
   MinDigits: 7
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails

data/.rubocop_todo.yml

@@ -2,7 +2,7 @@ require: rubocop-rspec
 
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-02-28 11:01:25 -0500 using RuboCop version 0.42.0.
+# on 2017-03-22 15:27:02 -0400 using RuboCop version 0.42.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,15 +13,15 @@ Lint/Loop:
   Exclude:
     - 'lib/browse_everything/driver/google_drive.rb'
 
-# Offense count: 11
+# Offense count: 6
 Metrics/AbcSize:
-  Max: 43
+  Max: 31
 
-# Offense count: 3
+# Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 7
 
-# Offense count: 14
+# Offense count: 10
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 26
@@ -31,10 +31,6 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 7
 
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 9
-
 # Offense count: 1
 RSpec/DescribeClass:
   Exclude:
@@ -62,13 +58,11 @@ Rails/OutputSafety:
   Exclude:
     - 'app/helpers/browse_everything_helper.rb'
 
-# Offense count: 14
+# Offense count: 11
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: strict, flexible
 Rails/TimeZone:
   Exclude:
-    - 'lib/browse_everything/driver/box.rb'
-    - 'lib/browse_everything/driver/dropbox.rb'
     - 'lib/browse_everything/driver/google_drive.rb'
     - 'lib/browse_everything/driver/sky_drive.rb'
     - 'lib/browse_everything/retriever.rb'
@@ -87,7 +81,7 @@ Style/ClassAndModuleChildren:
     - 'lib/generators/browse_everything/config_generator.rb'
     - 'lib/generators/browse_everything/install_generator.rb'
 
-# Offense count: 19
+# Offense count: 18
 Style/Documentation:
   Enabled: false
 
@@ -97,13 +91,10 @@ Style/FileName:
   Exclude:
     - 'lib/browse-everything.rb'
 
-# Offense count: 5
+# Offense count: 2
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'lib/browse_everything/driver/box.rb'
-    - 'lib/browse_everything/driver/dropbox.rb'
-    - 'lib/browse_everything/driver/file_system.rb'
     - 'lib/browse_everything/driver/google_drive.rb'
     - 'lib/browse_everything/driver/sky_drive.rb'
 
@@ -143,18 +134,3 @@ Style/PredicateName:
   Exclude:
     - 'spec/**/*'
     - 'app/helpers/browse_everything_helper.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'lib/browse_everything/driver/box.rb'
-    - 'lib/browse_everything/driver/dropbox.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RescueModifier:
-  Exclude:
-    - 'lib/browse_everything/driver/file_system.rb'

data/README.md

@@ -7,7 +7,8 @@
 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.
+[Box](http://www.box.com), [Amazon S3](https://aws.amazon.com/s3/),
+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

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

@@ -118,8 +118,7 @@ $ ->
         table.treetable("unloadBranch", node)
       onNodeExpand: ->
         node = this
-        $('body').css('cursor','wait')
-        $("html").addClass("wait")
+        startWait()
         size = $(node.row).find('td.ev-file-size').text().trim()
         start = 1
         increment = 1
@@ -173,17 +172,28 @@ $ ->
         selectAll(rows)
     .always ->
         clearInterval progressIntervalID
-        $('body').css('cursor','default')
-        $("html").removeClass("wait")
+        stopWait()
 
   setProgress = (done)->
-    $('#loading_progress').css('width',done+'%')
-    $('#loading_progress').html(done+'% complete')
-    $('#loading_progress').attr('aria-valuenow', done)
+    $('.loading-text').text(done+'% complete')
 
   refreshFiles = ->
     $('.ev-providers select').change()
 
+  startWait = ->
+    $('.loading-progress').removeClass("hidden")
+    $('body').css('cursor','wait')
+    $("html").addClass("wait")
+    $(".ev-browser").addClass("loading")
+    $('.ev-submit').attr('disabled', true)
+
+  stopWait = ->
+    $('.loading-progress').addClass("hidden")
+    $('body').css('cursor','default')
+    $("html").removeClass("wait")
+    $(".ev-browser").removeClass("loading")
+    $('.ev-submit').attr('disabled', false)
+
   $(window).on('resize', -> sizeColumns($('table#file-list')))
 
   $.fn.browseEverything = (options) ->
@@ -224,7 +234,7 @@ $ ->
   $(document).on 'click', 'button.ev-submit', (event) ->
     event.preventDefault()
     $(this).button('loading')
-    $('body').css('cursor','wait')
+    startWait()
     main_form = $(this).closest('form')
     resolver_url = main_form.data('resolver')
     ctx = dialog.data('ev-state')
@@ -255,7 +265,7 @@ $ ->
 
   $(document).on 'change', '.ev-providers select', (event) ->
     event.preventDefault()
-    $('body').css('cursor','wait')
+    startWait()
     $.ajax
       url: $(this).val(),
       data:
@@ -272,7 +282,7 @@ $ ->
       else
         $('.ev-files').html(xhr.responseText)
     .always ->
-      $('body').css('cursor','default')
+      stopWait()
 
   $(document).on 'click', '.ev-providers a', (event) ->
     $('.ev-providers li').removeClass('ev-selected')

data/app/assets/stylesheets/browse_everything/_browse_everything.scss

@@ -73,22 +73,6 @@
     padding: 4px;
   }
 
-  .fa3 .ev-selected .indenter {
-    font-family: FontAwesome;
-    font-weight: normal;
-    font-style: normal;
-    text-decoration: inherit;
-    -webkit-font-smoothing: antialiased;
-    *margin-right: .3em;
-    @extend .icon-check !optional;
-  }
-
-  .fa4 .ev-selected .indenter {
-    background-color: inherit;
-    @extend .fa;
-    @extend .fa-check !optional;
-  }
-
   .ev-files {
     table {
       width: 100%;
@@ -114,4 +98,19 @@
     select { width: 30% }
   }
 
+  .loading {
+    pointer-events: none;
+    opacity: 0.2;
+  }
+
+  .loading-progress {
+    position: absolute;
+    top: 8em;
+    left: 4em;
+  }
+
+  // Massively large text instead of something more artistic
+  .loading-text {
+    font-size: 4em;
+  }
 }

data/app/controllers/browse_everything_controller.rb

@@ -37,40 +37,40 @@ class BrowseEverythingController < ActionController::Base
 
   private
 
-  def auth_link
-    @auth_link ||= if provider.present?
-                     link, data = provider.auth_link
-                     session["#{provider_name}_data"] = data
-                     link = "#{link}&state=#{provider.key}" unless link.to_s.include?('state')
-                     link
-                   end # else nil, implicitly
-  end
+    def auth_link
+      @auth_link ||= if provider.present?
+                       link, data = provider.auth_link
+                       session["#{provider_name}_data"] = data
+                       link = "#{link}&state=#{provider.key}" unless link.to_s.include?('state')
+                       link
+                     end # else nil, implicitly
+    end
 
-  def browser
-    if @browser.nil?
-      @browser = BrowseEverything::Browser.new(url_options)
-      @browser.providers.values.each do |p|
-        p.token = session["#{p.key}_token"]
+    def browser
+      if @browser.nil?
+        @browser = BrowseEverything::Browser.new(url_options)
+        @browser.providers.values.each do |p|
+          p.token = session["#{p.key}_token"]
+        end
       end
+      @browser
     end
-    @browser
-  end
 
-  def browse_path
-    @path ||= params[:path] || ''
-  end
+    def browse_path
+      @path ||= params[:path] || ''
+    end
 
-  def provider
-    @provider ||= browser.providers[provider_name]
-  end
+    def provider
+      @provider ||= browser.providers[provider_name]
+    end
 
-  def provider_name
-    @provider_name ||= params[:provider] || params[:state].to_s.split(/\|/).last
-  end
+    def provider_name
+      @provider_name ||= params[:provider] || params[:state].to_s.split(/\|/).last
+    end
 
-  helper_method :auth_link
-  helper_method :browser
-  helper_method :browse_path
-  helper_method :provider
-  helper_method :provider_name
+    helper_method :auth_link
+    helper_method :browser
+    helper_method :browse_path
+    helper_method :provider
+    helper_method :provider_name
 end

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

@@ -1,8 +1,3 @@
-  <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 role="row" tabindex="-1">

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

@@ -6,6 +6,9 @@
     </div>
   </div>
   <div class="modal-body ev-body" tabindex="-1">
+    <div class="loading-progress" aria-live="assertive">
+      <span class="loading-text">Loading...</span>
+    </div>
     <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' if provider.present? %>

data/browse-everything.gemspec

@@ -44,7 +44,7 @@ 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', '~> 0.10'
+  spec.add_development_dependency 'engine_cart', '~> 1.0'
   spec.add_development_dependency 'capybara'
   spec.add_development_dependency 'jasmine', '~> 2.3'
   spec.add_development_dependency 'coveralls'

data/lib/browse_everything/browser.rb

@@ -16,7 +16,7 @@ module BrowseEverything
         begin
           driver_klass = BrowseEverything::Driver.const_get((config[:driver] || driver.to_s).camelize.to_sym)
           @providers[driver] = driver_klass.new(config.merge(url_options: url_options))
-        rescue
+        rescue NameError
           Rails.logger.warn "Unknown provider: #{driver}"
         end
       end

data/lib/browse_everything/driver/base.rb

@@ -53,15 +53,15 @@ module BrowseEverything
 
       private
 
-      def callback
-        connector_response_url(callback_options)
-      end
+        def callback
+          connector_response_url(callback_options)
+        end
 
-      # remove the script_name parameter from the url_options since that is causing issues
-      #   with the route not containing the engine path in rails 4.2.0
-      def callback_options
-        config[:url_options].reject { |k, _v| k == :script_name }
-      end
+        # remove the script_name parameter from the url_options since that is causing issues
+        #   with the route not containing the engine path in rails 4.2.0
+        def callback_options
+          config[:url_options].reject { |k, _v| k == :script_name }
+        end
     end
   end
 end

data/lib/browse_everything/driver/box.rb

@@ -1,5 +1,6 @@
 module BrowseEverything
   module Driver
+    # Driver for accessing the Box API (https://www.box.com/home)
     class Box < Base
       require 'ruby-box'
 
@@ -10,104 +11,112 @@ module BrowseEverything
       end
 
       def validate_config
-        unless config[:client_id]
-          raise BrowseEverything::InitializationError, 'Box driver requires a :client_id argument'
-        end
-        unless config[:client_secret]
-          raise BrowseEverything::InitializationError, 'Box driver requires a :client_secret argument'
-        end
+        return if config[:client_id] && config[:client_secret]
+        raise BrowseEverything::InitializationError, 'Box driver requires both :client_id and :client_secret argument'
       end
 
-      def contents(path = '')
-        path.sub!(/^[\/.]+/, '')
-        result = []
-        unless path.empty?
-          result << BrowseEverything::FileEntry.new(
-            Pathname(path).join('..'),
-            '', '..', 0, Time.now, true
-          )
+      # @param [String] id of the file or folder in Box
+      # @return [Array<RubyBox::File>]
+      def contents(id = '')
+        if id.empty?
+          folder = box_client.root_folder
+          results = []
+        else
+          folder = box_client.folder_by_id(id)
+          results = [parent_directory(folder)]
         end
-        folder = path.empty? ? box_client.root_folder : box_client.folder(path)
-        result += folder.items(ITEM_LIMIT, 0, %w(name size created_at)).collect do |f|
-          BrowseEverything::FileEntry.new(
-            File.join(path, f.name), # id here
-            "#{key}:#{File.join(path, f.name)}", # single use link
-            f.name,
-            f.size,
-            f.created_at,
-            f.type == 'folder'
-          )
+
+        folder.items(ITEM_LIMIT, 0, %w(name size created_at)).collect do |f|
+          results << directory_entry(f)
         end
-        result
+        results
       end
 
-      def link_for(path)
-        file = box_client.file(path)
+      # @param [String] id of the file in Box
+      # @return [Array<String, Hash>]
+      def link_for(id)
+        file = box_client.file_by_id(id)
         download_url = file.download_url
         auth_header = { 'Authorization' => "Bearer #{@token}" }
         extras = { auth_header: auth_header, expires: 1.hour.from_now, file_name: file.name, file_size: file.size.to_i }
         [download_url, extras]
       end
 
+      # @return [String]
+      # Authorization url that is used to request the initial access code from Box
       def auth_link
-        oauth_client.authorize_url(callback.to_s)
+        box_session.authorize_url(callback.to_s)
       end
 
+      # @return [Boolean]
       def authorized?
-        @token.present? && @token['token'].present?
+        box_token.present? && box_refresh_token.present? && !token_expired?
       end
 
+      # @return [Hash]
+      # Gets the appropriate tokens from Box using the access code returned from :auth_link:
       def connect(params, _data)
-        access_token = oauth_client.get_access_token(params[:code])
-        @token = { 'token' => access_token.token, 'refresh_token' => access_token.refresh_token }
+        register_access_token(box_session.get_access_token(params[:code]))
       end
 
       private
 
-      def oauth_client
-        RubyBox::Session.new(client_id: config[:client_id],
-                             client_secret: config[:client_secret])
-        # TODO: error checking here
-      end
+        def token_expired?
+          return true if expiration_time.nil?
+          Time.now.to_i > expiration_time
+        end
 
-      def token_expired?(token)
-        return false unless @token.present? && @token['token'].present?
-        new_session = RubyBox::Session.new(
-          client_id: config[:client_id],
-          client_secret: config[:client_secret],
-          access_token: token
-        )
-        result = new_session.get("#{RubyBox::API_URL}/users/me")
-        result['status'] != 200
-      rescue RubyBox::AuthError => e
-        Rails.logger.error("AuthError occured when checking token. Exception #{e.class.name} : #{e.message}. token as expired and need to refresh it")
-        return true
-      end
+        def box_client
+          if token_expired?
+            session = box_session(box_token)
+            register_access_token(session.refresh_token(box_refresh_token))
+          end
+          RubyBox::Client.new(box_session(box_token, box_refresh_token))
+        end
 
-      def refresh_token
-        refresh_token = @token['refresh_token']
-        token = @token['token']
-        session = RubyBox::Session.new(
-          client_id: config[:client_id],
-          client_secret: config[:client_secret],
-          access_token: token
-        )
-        access_token = session.refresh_token(refresh_token)
-        @token = { 'token' => access_token.token, 'refresh_token' => access_token.refresh_token }
-      end
+        def box_session(token = nil, refresh_token = nil)
+          RubyBox::Session.new(client_id: config[:client_id],
+                               client_secret: config[:client_secret],
+                               access_token: token,
+                               refresh_token: refresh_token)
+        end
 
-      def box_client
-        refresh_token if token_expired?(@token['token'])
-        token = @token['token']
-        refresh_token = @token['refresh_token']
-        session = RubyBox::Session.new(
-          client_id: config[:client_id],
-          client_secret: config[:client_secret],
-          access_token: token,
-          refresh_token: refresh_token
-        )
-        RubyBox::Client.new(session)
-      end
+        # If there is an active session, {@token} will be set by {BrowseEverythingController} using data stored in the
+        # session. However, if there is no prior session, or the token has expired, we reset it here using # a new
+        # access_token received from {#box_session}.
+        #
+        # @param [OAuth2::AccessToken] access_token
+        def register_access_token(access_token)
+          @token = {
+            'token' => access_token.token,
+            'refresh_token' => access_token.refresh_token,
+            'expires_at' => access_token.expires_at
+          }
+        end
+
+        def box_token
+          return unless @token
+          @token.fetch('token', nil)
+        end
+
+        def box_refresh_token
+          return unless @token
+          @token.fetch('refresh_token', nil)
+        end
+
+        def expiration_time
+          return unless @token
+          @token.fetch('expires_at', nil).to_i
+        end
+
+        # Used to represent the ".." parent directory of the folder
+        def parent_directory(folder)
+          BrowseEverything::FileEntry.new(Pathname(folder.name).join('..'), '', '..', 0, Time.current, true)
+        end
+
+        def directory_entry(f)
+          BrowseEverything::FileEntry.new(f.id, "#{key}:#{f.id}", f.name, f.size, f.created_at, f.type == 'folder')
+        end
     end
   end
 end