browse-everything 0.15.1 → 0.16.0

data/app/helpers/browse_everything_helper.rb

@@ -1,12 +1,6 @@
-module BrowseEverythingHelper
-  def array_to_hidden_fields(array, key)
-    fields = array.to_query(key).split(Rack::Utils::DEFAULT_SEP).collect do |pair|
-      key, value = pair.split('=', 2).map { |str| Rack::Utils.unescape(str) }
-      hidden_field_tag(key, value)
-    end
-    fields.join("\n").html_safe
-  end
+# frozen_string_literal: true
 
+module BrowseEverythingHelper
   # Extracted from Rack::Mime 1.5.2 for use with earlier versions of Rack/Rails
   # @param [String] value
   # @param [String] matcher

data/app/helpers/font_awesome_version_helper.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 module FontAwesomeVersionHelper
+
+  # Determines if the App uses Font Awesome releases 3.x or 4.x
+  # @return [TrueClass, FalseClass]
   def font_awesome_four?
     Bundler.environment.specs['font-awesome-rails'].first.version >= Gem::Version.new('4')
   end
 
-  def fa3(if3)
-    fa3or4(if3, '')
-  end
-
-  def fa4(if4)
-    fa3or4('', if4)
-  end
-
+  # Selects one of two HTML element classes depending upon the release of Font Awesome used by the App
+  # @param if3 [String] the Font Awesome 3 HTML class
+  # @param if4 [String] the Font Awesome 4 HTML class
+  # @return [String] the Font Awesome HTML class
   def fa3or4(if3, if4)
     font_awesome_four? ? if4 : if3
   end

data/app/services/browse_everything_session.rb

@@ -0,0 +1,10 @@
+
+# frozen_string_literal: true
+
+class BrowseEverythingSession
+  class Base
+    def initialize(session:)
+      @session = session
+    end
+  end
+end

data/app/services/browse_everything_session/provider_session.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Object for handling session cookies containing cached values
+class BrowseEverythingSession
+  class ProviderSession < Base
+    class_attribute :sessions
+    self.sessions = {}
+
+    def self.for(session:, name:)
+      ProviderSession.new(session: session, name: name)
+    end
+
+    def initialize(session:, name:)
+      @name = name
+      super(session: session)
+    end
+
+    def token=(value)
+      @session["#{@name}_token"] = value
+    end
+
+    def token
+      @session["#{@name}_token"]
+    end
+
+    def code=(value)
+      @session["#{@name}_code"] = value
+    end
+
+    def code
+      @session["#{@name}_code"]
+    end
+
+    def data=(value)
+      @session["#{@name}_data"] = value
+    end
+
+    def data
+      @session["#{@name}_data"]
+    end
+  end
+end

data/app/services/browser_factory.rb

@@ -0,0 +1,25 @@
+
+# frozen_string_literal: true
+
+class BrowserFactory
+  class << self
+    def build(session:, url_options:)
+      browser = BrowseEverything::Browser.new(url_options)
+      browser.providers.each_value do |provider_handler|
+        # The authentication token must be set here
+        provider_session = BrowseEverythingSession::ProviderSession.for(session: session, name: provider_handler.key.to_sym)
+        provider_handler.token = provider_session.token if provider_session.token
+      end
+      browser
+    end
+
+    def for(name:, url_options: {})
+      browser(url_options: url_options).providers[name]
+    end
+  end
+
+  def self.browser(url_options: {})
+    BrowseEverything::Browser.new(url_options)
+  end
+  private_class_method :browser
+end

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

@@ -8,9 +8,59 @@
         <th role="columnheader">Modified</th>
       </tr>
     </thead>
-    <% provider.contents(browse_path).each_with_index do |file, index| %>
-      <% next if file.relative_parent_path? or file.size.nil? %>
-      <%= render :partial => 'file', :locals => { :file => file, :index => index,
-        :path => browse_everything_engine.contents_path(provider_name, file.id), :parent => params[:parent] } %>
-    <% end %>
-  </table>
+    <% provider_contents.each_with_index do |file, index| %>
+      <% path = browse_everything_engine.contents_path(provider_name, file.id) %>
+      <% parent = params[:parent] %>
+      <% if file.container? || provider.config[:max_upload_file_size].blank? %>
+         <% disabled = false %>
+      <% else %>
+         <% max_size = provider.config[:max_upload_file_size].to_i %>
+         <% disabled = file.size > max_size %>
+      <% end %>
+
+      <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" title="<%= file.name %>" class="<%=file.container? ? 'ev-container' : 'ev-file'%> ev-file-name">
+          <% if disabled %>
+            <span title="<%= t('browse_everything.size_disabled', max_size: number_to_human_size(max_size)) %>"
+                  class="<%=file.container? ? 'folder' : 'file'%>" aria-hidden="true">
+              <%= file.name %>
+            </span>
+            <span class="sr-only"><%= file.container? ? ', folder' : ', file' %> </span>
+          <% else %>
+            <%= 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 %>
+          <% end %>
+        </td>
+        <% if file.container? %>
+          <td role="gridcell" class="ev-directory-select">
+            <%= check_box_tag(:select_all, "0", false, class: "ev-select-all") %>
+          </td>
+        <% else %>
+          <td role="gridcell" class="ev-file-select">
+            <%= check_box_tag(file.id.to_s.parameterize, "0", false, class: "ev-select-file") %>
+          </td>
+        <% end %>
+
+        <td role="gridcell" class="ev-file-size">
+          <%= number_to_human_size(file.size).sub(/Bytes/,'bytes') %>
+        </td>
+
+        <td role="gridcell" class="ev-file-kind">
+          <%= file.type %>
+        </td>
+
+        <td role="gridcell" class="ev-file-date">
+          <%= file.mtime.strftime('%F %R') %>
+        </td>
+    </tr>
+  <% end %>
+</table>

data/browse-everything.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'browse_everything/version'
 
@@ -13,39 +14,42 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/projecthydra/browse-everything'
   spec.license       = 'Apache 2'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files -z`.split(/\000/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rails', '>= 3.1'
   spec.add_dependency 'addressable', '~> 2.5'
-  spec.add_dependency 'google_drive'
+  spec.add_dependency 'aws-sdk-s3'
+  spec.add_dependency 'bootstrap-sass', '~> 3.2'
   spec.add_dependency 'dropbox_api', '>= 0.1.10'
+  spec.add_dependency 'font-awesome-rails'
+  spec.add_dependency 'google-api-client', '~> 0.21'
+  spec.add_dependency 'google_drive', '~> 2.1'
+  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'rails', '>= 4.2'
   spec.add_dependency 'ruby-box'
   spec.add_dependency 'sass-rails'
-  spec.add_dependency 'bootstrap-sass', '~> 3.2'
-  spec.add_dependency 'font-awesome-rails'
-  spec.add_dependency 'google-api-client', '~> 0.9'
-  spec.add_dependency 'signet'
-  spec.add_dependency 'httparty'
-  spec.add_dependency 'aws-sdk-s3'
+  spec.add_dependency 'signet', '~> 0.8'
+  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'chromedriver-helper'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'engine_cart', '~> 2.0'
+  spec.add_development_dependency 'factory_bot_rails'
+  spec.add_development_dependency 'jasmine', '~> 2.3'
+  spec.add_development_dependency 'rails-controller-testing'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'rubocop', '~> 0.42.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.8.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop', '~> 0.53'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.23'
+  spec.add_development_dependency 'selenium-webdriver'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'factory_girl_rails'
-  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'
-  spec.add_development_dependency 'poltergeist', '~> 1.10'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 end

data/config/routes.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 BrowseEverything::Engine.routes.draw do
   get 'connect', to: 'browse_everything#auth', as: 'connector_response'
-  match 'resolve', to: 'browse_everything#resolve', as: 'resolver', via: [:get, :post]
-  match ':provider(/*path)', to: 'browse_everything#show', as: 'contents', via: [:get, :post]
+  match 'resolve', to: 'browse_everything#resolve', as: 'resolver', via: %i[get post]
+  # The "format: false" argument ensures that directory paths containing period characters can be parsed
+  # By default, ""/dir1/dir.somedirectory.2" will be parsed as "/dir1/dir" with the format requested as "somedirectory.2"
+  # Please see http://guides.rubyonrails.org/routing.html#route-globbing-and-wildcard-segments
+  match ':provider(/*path)', to: 'browse_everything#show', as: 'contents', via: %i[get post], format: false
   root to: 'browse_everything#index'
 end

data/lib/browse-everything.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bootstrap-sass'
 require 'font-awesome-rails'
 require 'browse_everything'

data/lib/browse_everything.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'browse_everything/version'
 require 'browse_everything/engine'
 require 'browse_everything/retriever'
 
 module BrowseEverything
-  class InitializationError < RuntimeError; end
-
   autoload :Browser,   'browse_everything/browser'
   autoload :FileEntry, 'browse_everything/file_entry'
+
   module Driver
     autoload :Base,        'browse_everything/driver/base'
     autoload :FileSystem,  'browse_everything/driver/file_system'
@@ -15,28 +16,60 @@ module BrowseEverything
     autoload :Box,         'browse_everything/driver/box'
     autoload :GoogleDrive, 'browse_everything/driver/google_drive'
     autoload :S3,          'browse_everything/driver/s3'
+
+    # Access the sorter set for the base driver class
+    # @return [Proc]
+    def sorter
+      BrowseEverything::Driver::Base.sorter
+    end
+
+    # Provide a custom sorter for all driver classes
+    # @param [Proc] the sorting lambda (or proc)
+    def sorter=(sorting_proc)
+      BrowseEverything::Driver::Base.sorter = sorting_proc
+    end
+
+    module_function :sorter, :sorter=
   end
 
+  module Auth
+    module Google
+      autoload :Credentials,        'browse_everything/auth/google/credentials'
+      autoload :RequestParameters,  'browse_everything/auth/google/request_parameters'
+    end
+  end
+
+  class InitializationError < RuntimeError; end
+  class NotImplementedError < StandardError; end
+  class NotAuthorizedError < StandardError; end
+
   class << self
+    attr_writer :config
+
     def configure(value)
-      if value.nil? || value.is_a?(Hash)
-        @config = value
+      return if value.nil?
+      if value.is_a?(Hash)
+        @config = ActiveSupport::HashWithIndifferentAccess.new value
       elsif value.is_a?(String)
-        @config = YAML.load(ERB.new(File.read(value)).result)
-
-        if @config.include? 'drop_box'
-          warn '[DEPRECATION] `drop_box` is deprecated.  Please use `dropbox` instead.'
-          @config['dropbox'] = @config.delete('drop_box')
-        end
-
+        config_file_content = File.read(value)
+        config_file_template = ERB.new(config_file_content)
+        config_values = YAML.safe_load(config_file_template.result)
+        @config = ActiveSupport::HashWithIndifferentAccess.new config_values
+        @config.deep_symbolize_keys
       else
         raise InitializationError, "Unrecognized configuration: #{value.inspect}"
       end
+
+      if @config.include? 'drop_box'
+        warn '[DEPRECATION] `drop_box` is deprecated.  Please use `dropbox` instead.'
+        @config['dropbox'] = @config.delete('drop_box')
+      end
     end
 
     def config
       if @config.nil?
-        configure(File.join(Rails.root.to_s, 'config', 'browse_everything_providers.yml'))
+        config_path = Rails.root.join 'config', 'browse_everything_providers.yml'
+        configure config_path.to_s
       end
       @config
     end

data/lib/browse_everything/auth/google/credentials.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'googleauth'
+
+# Object structuring the credentials retrieved for the Google API's
+module BrowseEverything
+  module Auth
+    module Google
+      class Credentials < ::Google::Auth::UserRefreshCredentials
+        # Ensures that every call to retrieve an access token does *not* require an HTTP request
+        # @see Google::Auth::UserRefreshCredentials#fetch_access_token
+        # @param options [Hash] the access token values
+        def fetch_access_token(options = {})
+          return build_token_hash if access_token
+          super(options)
+        end
+
+        private
+
+          # Structure a hash from existing access token values (usually cached within a Cookie)
+          # @return [Hash]
+          def build_token_hash
+            { 'access_token' => access_token }
+          end
+      end
+    end
+  end
+end

data/lib/browse_everything/auth/google/request_parameters.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Manages request parameters for the request to the Google Drive API
+module BrowseEverything
+  module Auth
+    module Google
+      class RequestParameters < OpenStruct
+        # Overrides the constructor for an OpenStruct instance
+        # Provides default parameters
+        def initialize(params = {})
+          @params = default_params.merge(params)
+          super(@params)
+        end
+
+        private
+
+          # The default query parameters for the Google Drive API
+          # @return [Hash]
+          def default_params
+            {
+              q: default_query,
+              order_by: 'modifiedTime desc,folder,name',
+              fields: 'nextPageToken,files(name,id,mimeType,size,modifiedTime,parents,web_content_link)',
+              supports_team_drives: true,
+              include_team_drive_items: true,
+              corpora: 'user,allTeamDrives',
+              page_size: 1000
+            }
+          end
+
+          def default_query
+            field_queries = []
+            contraints.each_pair do |field, constraints|
+              field_constraint = constraints.join(" and #{field} ")
+              field_queries << "#{field} #{field_constraint}"
+            end
+            field_queries.join(' ')
+          end
+
+          def contraints
+            {
+              'mimeType' => [
+                '!= \'application/vnd.google-apps.audio\'',
+                '!= \'application/vnd.google-apps.document\'',
+                '!= \'application/vnd.google-apps.drawing\'',
+                '!= \'application/vnd.google-apps.form\'',
+                '!= \'application/vnd.google-apps.fusiontable\'',
+                '!= \'application/vnd.google-apps.map\'',
+                '!= \'application/vnd.google-apps.photo\'',
+                '!= \'application/vnd.google-apps.presentation\'',
+                '!= \'application/vnd.google-apps.script\'',
+                '!= \'application/vnd.google-apps.site\'',
+                '!= \'application/vnd.google-apps.spreadsheet\'',
+                '!= \'application/vnd.google-apps.video\''
+              ]
+            }
+          end
+      end
+    end
+  end
+end