browse-everything 1.6.0 → 2.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eedf3447096af5429b239653b707bf23e881fcd43a097cbe25804c7d48bc16e2
-  data.tar.gz: 1ccf9adb1e189a413ae6ceb9a4e67bccfae3a5179c84f583c1b165f4e051cf00
+  metadata.gz: 64351da415814ba91aa2beebfc70fa27cbcc7c09ba0175f07425870b5ff4c364
+  data.tar.gz: 4908e6bd8ec3c2e6801fe112f3fc9458dd3ccb20b3c5e5a538a813659ddf9ea3
 SHA512:
-  metadata.gz: 58511d9c04085a4a9d72246c906bb20cb46bac2e980d17bf90276807b67fe4c38eab79dbae89c10a69e735da6ee2e0acffe0399fe7993526a0454886cc3555ee
-  data.tar.gz: 5484761c6ed0b148ba8a10852dea363a1c6860b146271dd0b8bedbad65f37dfb50b0644f3da2ae533c0b84c782fadea9d808f8d1f2d10d1acb00e3ee8f9d6b34
+  metadata.gz: 1d14bf7d52f5d04fcffda8ced44b90c78aab2f9288b059a930b0c7a3c183a1b0a3c3be13ad2dc4e1e8bb780fc9744078a08ecea3988d92d3e1d6931956618fcd
+  data.tar.gz: 24ee1844450045c9985514d9f06e3db47f5275fe8ce9d2e0104e86af39a0adb931628e25e68b1dfb25fc7d9d4dc523ba73264aff12baae10df69c3573950fb4a

data/Gemfile

@@ -9,6 +9,10 @@ group :development, :test do
   gem 'pry-byebug' unless ENV['CI']
 end
 
+# "soft"/"optional" dependency, but needed for our tests of dropbox driver to pass
+gem 'dropbox_api', '>= 0.1.20'
+gem 'ruby-box'
+
 # == Extra dependencies for dummy test app ==
 #
 # Extra dependencies for dummy test app are in .gemspec as a development dependency

data/README.md

@@ -24,6 +24,31 @@ download the files.
 
 **This gem does not depend on hydra-head**
 
+## Certain drivers needing maintenance require extra setup
+
+Certain drivers need additional development work if they are to be fully
+supported again, and for now require extra opt-in setup.
+
+### Dropbox
+
+The driver has a dependency on unmaintained dropbox_api gem with it's [own
+dependency on old unmaintained `oauth2` 1.x](https://github.com/Jesus/dropbox_api/issues/96), so requires some opt-in setup and configuration. https://github.com/samvera/browse-everything/pull/448
+
+* Add `dropbox_api, '>= 0.1.20'` to your Gemfile.
+* Add `require 'browse_everything/driver/dropbox'` to a startup file, eg
+  `config/application.rb`.
+
+### Box.com
+
+The driver uses unmaintained [ruby-box](https://github.com/attachmentsme/ruby-box)
+gem, which should probably be replaced with [boxr](https://github.com/cburnette/boxr).
+See unfinished work at https://github.com/samvera/browse-everything/pull/185
+
+* Add `ruby-box` to your Gemfile.
+* Add `require 'browse_everything/driver/box'` to a startup file, eg
+  `config/application.rb`.
+
+
 ## Technical Debt/Legacy warning
 
 This project has been receiving very limited maintenance for at least 2-4 years

data/browse-everything.gemspec

@@ -20,12 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'addressable', '~> 2.5'
   spec.add_dependency 'aws-sdk-s3'
-  spec.add_dependency 'dropbox_api', '>= 0.1.20'
   spec.add_dependency 'google-apis-drive_v3'
   spec.add_dependency 'googleauth', '>= 0.6.6', '< 2.0'
   spec.add_dependency 'rails', '>= 4.2', '< 8.1'
-  spec.add_dependency 'ruby-box'
-  spec.add_dependency 'signet', '~> 0.8'
   spec.add_dependency 'faraday', "~> 2.0"
 
   # Development dependencies include dependencies necessary for running

data/lib/browse_everything/driver/box.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
-require 'ruby-box'
 require_relative 'authentication_factory'
 
+begin
+  gem 'ruby-box'
+rescue Gem::LoadError => e
+  new_raise = Gem::LoadError.new("Loading BrowseEverything::Driver:Box requires the availability of gem ruby-box #{e.requirement}, please add it to your Gemfile")
+  new_raise.requirement = e.requirement
+  raise new_raise, cause: nil # cause is confusing and unneeded here.
+end
+
 module BrowseEverything
   module Driver
     # Driver for accessing the Box API (https://www.box.com/home)

data/lib/browse_everything/driver/dropbox.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
 require 'tmpdir'
-require 'dropbox_api'
 require_relative 'authentication_factory'
 
+# We have an unspecified "optional" dependency, not great but it's what we got
+begin
+  gem 'dropbox_api', '>= 0.1.20'
+rescue Gem::LoadError => e
+  new_raise = Gem::LoadError.new("Loading BrowseEverything::Driver:Dropbox requires the availability of gem dropbox_api '#{e.requirement}', please add it to your Gemfile")
+  new_raise.requirement = e.requirement
+  raise new_raise, cause: nil # cause is confusing and unneeded here.
+end
+
 module BrowseEverything
   module Driver
     class Dropbox < Base

data/lib/browse_everything/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrowseEverything
-  VERSION = '1.6.0'
+  VERSION = '2.0.0.alpha.1'
 end

data/lib/browse_everything.rb

@@ -12,11 +12,13 @@ module BrowseEverything
   module Driver
     autoload :Base,        'browse_everything/driver/base'
     autoload :FileSystem,  'browse_everything/driver/file_system'
-    autoload :Dropbox,     'browse_everything/driver/dropbox'
-    autoload :Box,         'browse_everything/driver/box'
     autoload :GoogleDrive, 'browse_everything/driver/google_drive'
     autoload :S3,          'browse_everything/driver/s3'
 
+    # Intentionally require explicit require, as it has a non-declared dependency
+    # autoload :Dropbox,     'browse_everything/driver/dropbox'
+    # autoload :Box,         'browse_everything/driver/box'
+
     # Access the sorter set for the base driver class
     # @return [Proc]
     def sorter

data/lib/generators/browse_everything/templates/browse_everything_providers.yml.example

@@ -2,16 +2,10 @@
 # To make browse-everything aware of a provider, uncomment the info for that provider and add your API key information.
 # The file_system provider can be a path to any directory on the server where your application is running.
 #
-# dropbox:
-#   client_id: YOUR_DROPBOX_APP_KEY
-#   client_secret: YOUR_DROPBOX_APP_SECRET
-#   download_directory: tmp/
-# box:
-#   client_id: YOUR_BOX_CLIENT_ID
-#   client_secret: YOUR_BOX_CLIENT_SECRET
 # google_drive:
 #   client_id: YOUR_GOOGLE_API_CLIENT_ID
 #   client_secret: YOUR_GOOGLE_API_CLIENT_SECRET
+#
 # s3:
 #   bucket: YOUR_AWS_S3_BUCKET
 #   response_type: signed_url # set to :public_url for public urls or :s3_uri for an s3://BUCKET/KEY uri
@@ -20,3 +14,22 @@
 #   app_secret: YOUR_AWS_S3_SECRET # explicitly here, or left out to use system-configured
 #   region: YOUR_AWS_S3_REGION     # defaults.
 #   See https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/
+#
+# file_system:
+#   allow_relative_home: true
+#   home: ./browseable_files
+#
+# # Note: dropbox requires manual addition of `dropbox_api` gem to Gemfile, and
+# # `require 'browse_everything/driver/dropbox'` in a startup file.
+#
+# dropbox:
+#   client_id: YOUR_DROPBOX_APP_KEY
+#   client_secret: YOUR_DROPBOX_APP_SECRET
+#   download_directory: tmp/
+#
+# # Note: box requires addition of `ruby-box` to Gemfile, and
+# # `require 'browse_everything/driver/box'` in a startup file.
+#
+# box:
+#   client_id: YOUR_BOX_CLIENT_ID
+#   client_secret: YOUR_BOX_CLIENT_SECRET

data/spec/helper/browse_everything_controller_helper_spec.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+#
+require 'browse_everything/driver/dropbox'
 
 require File.expand_path('../spec_helper', __dir__)
 

data/spec/lib/browse_everything/browser_spec.rb

@@ -4,7 +4,7 @@ include BrowserConfigHelper
 
 describe BrowseEverything::Browser do
   let(:file_config) do
-    "file_system:\n  home: '/file/config/home'\ndropbox:\n  client_id: 'DropboxId'\n  client_secret: 'DropboxClientSecret'\n  download_directory: 'tmp/'"
+    "file_system:\n  home: '/file/config/home'\ngoogle_drive:\n  client_id: 'GoogleDriveId'\n  client_secret: 'GoogleDriveClientSecret'\n  download_directory: 'tmp/'"
   end
 
   let(:global_config) do
@@ -12,7 +12,7 @@ describe BrowseEverything::Browser do
       file_system: {
         home: '/global/config/home'
       },
-      dropbox: {
+      google_drive: {
         client_id: 'DropboxId',
         client_secret: 'DropboxClientSecret',
         download_directory: 'tmp/'
@@ -25,9 +25,9 @@ describe BrowseEverything::Browser do
       file_system: {
         home: '/local/config/home'
       },
-      dropbox: {
-        client_id: 'DropboxId',
-        client_secret: 'DropboxClientSecret',
+      google_drive: {
+        client_id: 'GoogleDriveId',
+        client_secret: 'GoogleDriveClientSecret',
         download_directory: 'tmp/'
       },
       url_options: url_options
@@ -43,9 +43,9 @@ describe BrowseEverything::Browser do
     end
 
     it 'has 2 providers' do
-      expect(browser.providers.keys).to eq(%w[file_system dropbox])
+      expect(browser.providers.keys).to eq(%w[file_system google_drive])
       expect(browser.providers[:file_system]).to be_a BrowseEverything::Driver::FileSystem
-      expect(browser.providers[:dropbox]).to be_a BrowseEverything::Driver::Dropbox
+      expect(browser.providers[:google_drive]).to be_a BrowseEverything::Driver::GoogleDrive
     end
 
     it 'uses the file configuration' do
@@ -60,9 +60,9 @@ describe BrowseEverything::Browser do
     before { BrowseEverything.configure(global_config) }
 
     it 'has 2 providers' do
-      expect(browser.providers.keys).to eq(%w[file_system dropbox])
+      expect(browser.providers.keys).to eq(%w[file_system google_drive])
       expect(browser.providers[:file_system]).to be_a BrowseEverything::Driver::FileSystem
-      expect(browser.providers[:dropbox]).to be_a BrowseEverything::Driver::Dropbox
+      expect(browser.providers[:google_drive]).to be_a BrowseEverything::Driver::GoogleDrive
     end
 
     it 'uses the global configuration' do
@@ -75,9 +75,9 @@ describe BrowseEverything::Browser do
     let(:browser) { described_class.new(local_config) }
 
     it 'has 2 providers' do
-      expect(browser.providers.keys).to eq(%w[file_system dropbox])
+      expect(browser.providers.keys).to eq(%w[file_system google_drive])
       expect(browser.providers[:file_system]).to be_a BrowseEverything::Driver::FileSystem
-      expect(browser.providers[:dropbox]).to be_a BrowseEverything::Driver::Dropbox
+      expect(browser.providers[:google_drive]).to be_a BrowseEverything::Driver::GoogleDrive
     end
 
     it 'uses the local configuration' do

data/spec/lib/browse_everything/driver/box_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'browse_everything/driver/box'
+
 include BrowserConfigHelper
 
 describe BrowseEverything::Driver::Box do

data/spec/lib/browse_everything/driver/dropbox_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'browse_everything/driver/dropbox'
+
 include BrowserConfigHelper
 
 describe BrowseEverything::Driver::Dropbox do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browse-everything
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0.alpha.1
 platform: ruby
 authors:
 - Carolyn Cole
@@ -42,20 +42,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dropbox_api
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.20
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.20
 - !ruby/object:Gem::Dependency
   name: google-apis-drive_v3
   requirement: !ruby/object:Gem::Requirement
@@ -110,34 +96,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
-- !ruby/object:Gem::Dependency
-  name: ruby-box
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: signet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement