browse-everything 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 217e127add171d887e8e372ba7505f20bfd3c862
-  data.tar.gz: f6de9170c170e8df631283bf3817259285798508
+SHA256:
+  metadata.gz: f010bc868532bf8d950f23deb2057dbf1ef250d3e3ea6a8350cdd4d5652406e5
+  data.tar.gz: 61b2d58f7cec21225de6e85392fb0603d768ac2859aa842763dfdd65d535a0a5
 SHA512:
-  metadata.gz: d9cfc43d9f3a117f5e2da42ffd6af90e92897c193c07559da01f7a3789c85212298d74da49fbeeb3fd5c461962cf8f246548d03b60f9a64f31ffffcf76ce1bc6
-  data.tar.gz: ad1002469c1cddbd63c268f83ef083bcf56d0a1b8c5a6a6177626fe02e83f534eaafbf870223da4b7a8f28e649ec0b072ef34202fccc3856f6f3cad192dde3d1
+  metadata.gz: c0580e42f8762c2f29e64860c5e7444f82f4c569e724edd9cac32e894506a62f9a192591e7dbf294f6747906170223f6cd4ff59c09e7a56c9c65ece3065cd275
+  data.tar.gz: 311ab92c994db67da4a8f4206edc00a6d50006dbd3a9492a06ea87002067b20121cce4e8afb3110a2f46aef84fbb43682b520d7a47f63709e0d82370ef755236

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.4
   DisplayCopNames: true
   Include:
     - '**/Rakefile'
@@ -10,35 +10,87 @@ AllCops:
 
 Rails:
   Enabled: true
+Rails/FilePath:
+  Exclude:
+    - 'lib/generators/browse_everything/config_generator.rb'
 
 Metrics/ClassLength:
   Max: 130
-
-# Configuration parameters: AllowURI, URISchemes.
+  Exclude:
+    - 'lib/browse_everything/driver/google_drive.rb'
 Metrics/LineLength:
   Max: 400
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/views/browse_everything/_files.html.erb_spec.rb'
+    - 'spec/unit/browse_everything_helper_spec.rb'
+    - 'spec/unit/browse_everything/retriever_spec.rb'
+    - 'spec/unit/browse_everything/file_entry_spec.rb'
+    - 'spec/unit/browse_everything/driver/s3_spec.rb'
+    - 'spec/unit/browse_everything/driver/google_drive_spec.rb'
+    - 'spec/unit/browse_everything/driver/file_system_spec.rb'
+    - 'spec/unit/browse_everything/driver/dropbox_spec.rb'
+    - 'spec/unit/browse_everything/driver/box_spec.rb'
+    - 'spec/unit/browse_everything/browser_spec.rb'
+    - 'spec/services/browser_factory_spec.rb'
+    - 'spec/services/browse_everything_session/provider_session_spec.rb'
+    - 'spec/helper/browse_everything_controller_helper_spec.rb'
+    - 'spec/controllers/browse_everything_controller_spec.rb'
+    - 'browse-everything.gemspec'
 
 RSpec/NestedGroups:
   Enabled: false
 
-RSpec/FilePath:
-  Enabled: false
-
 RSpec/LeadingSubject:
   Enabled: false
 
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/unit/dropbox_spec.rb'
+    - 'spec/unit/browse_everything/driver/base_spec.rb'
+    - 'spec/unit/browse_everything/driver/box_spec.rb'
+    - 'spec/unit/browse_everything/driver/dropbox_spec.rb'
+    - 'spec/unit/browse_everything/driver/file_system_spec.rb'
+    - 'spec/unit/browse_everything/driver/google_drive_spec.rb'
+    - 'spec/unit/browse_everything/driver/s3_spec.rb'
     - 'spec/features/select_files_spec.rb'
     - 'spec/javascripts/jasmine_spec.rb'
 
 RSpec/MultipleExpectations:
   Exclude:
-    - 'spec/unit/dropbox_spec.rb'
+    - 'spec/unit/browse_everything/driver/base_spec.rb'
+    - 'spec/unit/browse_everything/driver/box_spec.rb'
+    - 'spec/unit/browse_everything/driver/dropbox_spec.rb'
+    - 'spec/unit/browse_everything/driver/file_system_spec.rb'
+    - 'spec/unit/browse_everything/driver/google_drive_spec.rb'
+    - 'spec/unit/browse_everything/driver/s3_spec.rb'
+    - 'spec/features/**/*'
+    - 'spec/controllers/browse_everything_controller_spec.rb'
+    - 'spec/unit/browse_everything/browser_spec.rb'
 
 Style/NumericLiterals:
   MinDigits: 7
 
-Style/IndentationConsistency:
+Layout/IndentationConsistency:
   EnforcedStyle: rails
+
+Naming/FileName:
+  Exclude:
+    - 'browse-everything.gemspec'
+    - 'Gemfile'
+    - 'lib/browse-everything.rb'
+
+Style/MixinUsage:
+  Exclude:
+    - 'spec/unit/browse_everything/driver/s3_spec.rb'
+    - 'spec/unit/browse_everything/driver/google_drive_spec.rb'
+    - 'spec/unit/browse_everything/driver/file_system_spec.rb'
+    - 'spec/unit/browse_everything/driver/dropbox_spec.rb'
+    - 'spec/unit/browse_everything/driver/box_spec.rb'
+    - 'spec/unit/browse_everything/driver/base_spec.rb'
+    - 'spec/unit/browse_everything/browser_spec.rb'
+    - 'spec/services/browser_factory_spec.rb'
+    - 'spec/helper/browse_everything_controller_helper_spec.rb'
+
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'

data/.rubocop_todo.yml

@@ -36,13 +36,6 @@ RSpec/DescribeClass:
   Exclude:
     - 'spec/javascripts/jasmine_spec.rb'
 
-# Offense count: 2
-# Configuration parameters: Max.
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/features/select_files_spec.rb'
-    - 'spec/javascripts/jasmine_spec.rb'
-
 # Offense count: 2
 RSpec/MultipleExpectations:
   Max: 2
@@ -83,12 +76,6 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
-# Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
-Style/FileName:
-  Exclude:
-    - 'lib/browse-everything.rb'
-
 # Offense count: 2
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
@@ -102,7 +89,7 @@ Style/MultilineBlockChain:
 
 # Offense count: 1
 # Cop supports --auto-correct.
-Style/MultilineBlockLayout:
+Layout/MultilineBlockLayout:
   Exclude:
     - 'spec/unit/dropbox_spec.rb'
 
@@ -111,7 +98,7 @@ Style/MultilineBlockLayout:
 # NamePrefix: is_, has_, have_
 # NamePrefixBlacklist: is_, has_, have_
 # NameWhitelist: is_a?
-Style/PredicateName:
+Naming/PredicateName:
   Exclude:
     - 'spec/**/*'
     - 'app/helpers/browse_everything_helper.rb'

data/.travis.yml

@@ -1,27 +1,27 @@
 language: ruby
 sudo: false
+dist: trusty
+sudo: required
+addons:
+  chrome: stable
 cache:
   bundler: true
-  directories:
-    - "travis_phantomjs"
+
 before_install:
-  - "phantomjs --version"
-  - "export PATH=$PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64/bin:$PATH"
-  - "phantomjs --version"
-  - "if [ $(phantomjs --version) != '2.1.1' ]; then rm -rf $PWD/travis_phantomjs; mkdir -p $PWD/travis_phantomjs; fi"
-  - "if [ $(phantomjs --version) != '2.1.1' ]; then wget https://assets.membergetmember.co/software/phantomjs-2.1.1-linux-x86_64.tar.bz2 -O $PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64.tar.bz2; fi"
-  - "if [ $(phantomjs --version) != '2.1.1' ]; then tar -xvf $PWD/travis_phantomjs/phantomjs-2.1.1-linux-x86_64.tar.bz2 -C $PWD/travis_phantomjs; fi"
-  - "phantomjs --version"
+  - gem update --system # https://docs.travis-ci.com/user/languages/ruby/#Upgrading-RubyGems
+  - gem install bundler
+  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
 
 rvm:
-  - "2.4.1"
-global_env:
-  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+
 env:
-  - "RAILS_VERSION=5.1.0"
-matrix:
-  include:
-    - rvm: "2.3.4"
-      env: "RAILS_VERSION=5.0.2"
-    - rvm: 2.2.7
-      env: "RAILS_VERSION=4.2.8"
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  matrix:
+    - "RAILS_VERSION=5.2.0"
+    - "RAILS_VERSION=5.1.6"
+    - "RAILS_VERSION=5.0.7"
+    - "RAILS_VERSION=4.2.10"

data/CONTRIBUTING.md

@@ -1,21 +1,21 @@
 # How to Contribute
 
-We want your help to make Project Hydra great.
+We want your help to make Samvera Community 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.
 
 ## Code of Conduct
 
-The Hydra community is dedicated to providing a welcoming and positive experience for all its
+The Samvera Community is dedicated to providing a welcoming and positive experience for all its
 members, whether they are at a formal gathering, in a social setting, or taking part in activities
-online.  Please see our [Code of Conduct](https://wiki.duraspace.org/display/hydra/Code+of+Conduct)
+online.  Please see our [Code of Conduct](https://wiki.duraspace.org/display/samvera/Code+of+Conduct)
 for more information.
 
-## Hydra Project Intellectual Property Licensing and Ownership
+## Samvera Community 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
+https://wiki.duraspace.org/display/samvera/Samvera+Community+Intellectual+Property+Licensing+and+Ownership
 
 You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
 
@@ -61,7 +61,7 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
   * This work greatly increases the usability of the code base and supports the on-ramping of new committers.
   * We will all be understanding of one another's time constraints in this area.
 * YARD examples:
-  * [Hydra::Works::RemoveGenericFile](https://github.com/projecthydra-labs/hydra-works/blob/master/lib/hydra/works/services/generic_work/remove_generic_file.rb)
+  * [Hyrax::AdminSet](https://github.com/samvera/hyrax/blob/master/app/models/admin_set.rb)
   * [ActiveTriples::LocalName::Minter](https://github.com/ActiveTriples/active_triples-local_name/blob/master/lib/active_triples/local_name/minter.rb)
 * [Getting started with YARD](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
 

data/Gemfile

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in browse_everything.gemspec
 gemspec
 
+group :development, :test do
+  gem 'pry-byebug' unless ENV['CI']
+end
+
 # BEGIN ENGINE_CART BLOCK
 # engine_cart: 0.10.0
 # engine_cart stanza: 0.10.0
@@ -28,17 +34,15 @@ else
   end
 
   case ENV['RAILS_VERSION']
-  when /^5.1/
-    gem 'capybara', '~> 2.13.0'
-  when /^4.2/
-    gem 'responders', '~> 2.0'
-    gem 'sass-rails', '>= 5.0'
+  when /^5\./
+    gem 'capybara', '~> 2.18.0'
+  when /^4\.2/
     gem 'coffee-rails', '~> 4.1.0'
     gem 'json', '~> 1.8'
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
   end
 end
 # END ENGINE_CART BLOCK
 
-unless File.exist?(file)
-  eval_gemfile File.expand_path('spec/test_app_templates/Gemfile.extra', File.dirname(__FILE__))
-end
+eval_gemfile File.expand_path('spec/test_app_templates/Gemfile.extra', File.dirname(__FILE__)) unless File.exist?(file)

data/README.md

@@ -16,6 +16,20 @@ download the files.
 
 **This gem does not depend on hydra-head**
 
+## Supported Ruby Releases
+Currently, the following releases of Ruby are supported:
+- 2.5.1
+- 2.4.4
+- 2.3.7
+  - Please note that this is the last release in the 2.3.x series, and support is [scheduled to be withdrawn](https://www.ruby-lang.org/en/news/2018/03/28/ruby-2-3-7-released/).  We would strongly recommend that one upgrades from 2.3.7 in response to this.
+
+## Supported Rails Releases
+- 5.2.0
+- 5.1.6
+- 5.0.7
+- 4.2.10
+  - The supported Rail releases follow those specified by [the security policy of the Rails Community](https://rubyonrails.org/security/).  As is the case with the supported Ruby releases, it is recommended that one upgrades from any Rails release no longer receiving security updates.
+
 ## Installation
 
 Add this lines to your application's Gemfile:
@@ -52,6 +66,22 @@ In `app/assets/javascripts/application.js` include jquery and the BrowseEverythi
 //= require browse_everything
 ```
 
+## Testing
+This is a Rails Engine which is tested using the [engine_cart](https://github.com/cbeer/engine_cart) Gem.  Test suites may be executed with the following invocation:
+
+```bash
+bundle exec rake
+```
+
+### Testing Problems
+Should you attempt to execute the test suite and encounter the following error:
+```bash
+Your Ruby version is 2.x.x, but your Gemfile specified 2.y.z
+```
+...then you must clean the internal test app generated by `engine_cart` with the following:
+```bash
+bundle exec rake engine_cart:clean
+```
 
 ## Usage
 

data/Rakefile

@@ -1,4 +1,5 @@
-#!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 Dir.glob('tasks/*.rake').each { |r| import r }

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

@@ -323,6 +323,11 @@ $ ->
 
 auto_toggle = ->
   triggers = $('*[data-toggle=browse-everything]')
+  if Rails?
+    $.ajaxSetup({
+        headers: { 'X-CSRF-TOKEN': (Rails || $.rails).csrfToken() || '' }
+    });
+
   triggers.each () ->
     ctx = $(this).data('ev-state')
     $(this).browseEverything($(this).data()) unless ctx?

data/app/controllers/browse_everything_controller.rb

@@ -1,4 +1,6 @@
-require File.expand_path('../../helpers/browse_everything_helper', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('../helpers/browse_everything_helper', __dir__)
 
 class BrowseEverythingController < ActionController::Base
   layout 'browse_everything'
@@ -6,66 +8,115 @@ class BrowseEverythingController < ActionController::Base
 
   protect_from_forgery with: :exception
 
-  after_action { session["#{provider_name}_token"] = provider.token unless provider.nil? }
+  after_action do
+    provider_session.token = provider.token unless provider.nil? || provider.token.blank?
+  end
+
+  def provider_contents
+    raise BrowseEverything::NotImplementedError, 'No provider supported' if provider.nil?
+    raise BrowseEverything::NotAuthorizedError, 'Not authorized' unless provider.authorized?
+
+    provider.contents(browse_path)
+  end
 
   def index
     render layout: !request.xhr?
   end
 
+  # Either render the link to authorization or render the files
+  # provider#show method is invoked here
   def show
-    render layout: !request.xhr?
+    render partial: 'files', layout: !request.xhr?
+  rescue StandardError => error
+    reset_provider_session!
+
+    # Should an error be raised, log the error and redirect the use to reauthenticate
+    logger.warn "Failed to retrieve the hosted files: #{error}"
+    render partial: 'auth', layout: !request.xhr?
   end
 
+  # Action for the OAuth2 callback
+  # Authenticate against the Google API and store the token in the session
   def auth
-    session["#{provider_name}_token"] = provider.connect(params, session["#{provider_name}_data"])
+    # params contains the access code with with the key :code
+    provider_session.token = provider.connect(params, provider_session.data)
   end
 
   def resolve
     selected_files = params[:selected_files] || []
-    @links = selected_files.collect do |file|
-      p, f = file.split(/:/)
-      (url, extra) = browser.providers[p].link_for(f)
+    selected_links = selected_files.collect do |file|
+      provider_key_value, uri = file.split(/:/)
+      provider_key = provider_key_value.to_sym
+      (url, extra) = browser.providers[provider_key].link_for(uri)
       result = { url: url }
       result.merge!(extra) unless extra.nil?
       result
     end
+
     respond_to do |format|
       format.html { render layout: false }
-      format.json { render json: @links }
+      format.json { render json: selected_links }
     end
   end
 
   private
 
+    # Constructs or accesses an existing session manager Object
+    # @return [BrowseEverythingSession::ProviderSession] the session manager
+    def provider_session
+      BrowseEverythingSession::ProviderSession.new(session: session, name: provider_name)
+    end
+
+    # Clears all authentication tokens, codes, and other data from the Rails session
+    def reset_provider_session!
+      return unless @provider_session
+      @provider_session.token = nil
+      @provider_session.code = nil
+      @provider_session.data = nil
+      @provider_session = nil
+    end
+
+    # Generates the authentication link for a given provider service
+    # @return [String] the authentication link
     def auth_link
       @auth_link ||= if provider.present?
                        link, data = provider.auth_link
-                       session["#{provider_name}_data"] = data
+                       provider_session.data = data
                        link = "#{link}&state=#{provider.key}" unless link.to_s.include?('state')
                        link
-                     end # else nil, implicitly
+                     end
     end
 
-    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
+    # Accesses the relative path for browsing from the Rails session
+    # @return [String]
+    def browse_path
+      params[:path] || ''
     end
 
-    def browse_path
-      @path ||= params[:path] || ''
+    # Generate the provider name from the Rails session state value
+    # @return [String]
+    def provider_name_from_state
+      params[:state].to_s.split(/\|/).last
     end
 
+    # Generates the name of the provider using Rails session values
+    # @return [String]
+    def provider_name
+      params[:provider] || provider_name_from_state || browser.providers.each_key.to_a.first
+    end
+
+    # Retrieve the Driver for each request
+    # @return [BrowseEverything::Driver::Base]
     def provider
-      @provider ||= browser.providers[provider_name]
+      browser.providers[provider_name.to_sym] || browser.first_provider
     end
 
-    def provider_name
-      @provider_name ||= params[:provider] || params[:state].to_s.split(/\|/).last
+    # Constructs a browser manager Object
+    # Browser state cannot persist between requests to the Controller
+    # Hence, a Browser must be reinstantiated for each request using the state provided in the Rails session
+    # @return [BrowseEverything::Browser]
+    def browser
+      BrowserFactory.build(session: session, url_options: url_options)
     end
 
     helper_method :auth_link
@@ -73,4 +124,5 @@ class BrowseEverythingController < ActionController::Base
     helper_method :browse_path
     helper_method :provider
     helper_method :provider_name
+    helper_method :provider_contents
 end