browse-everything 1.5.0 → 2.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a514ad33ec151f78c54fd74220a6d385bde4107894e2b6beb69e30eab6c27e
-  data.tar.gz: e688ee1ba6a0a9b8f519ca33077acda6bbc062033fc122c33876da850ff36146
+  metadata.gz: 64351da415814ba91aa2beebfc70fa27cbcc7c09ba0175f07425870b5ff4c364
+  data.tar.gz: 4908e6bd8ec3c2e6801fe112f3fc9458dd3ccb20b3c5e5a538a813659ddf9ea3
 SHA512:
-  metadata.gz: 8b3b2068517c326ca832b8adf020dff2e297576bb19189f0707e5f812cc01b09ceef932cc8903fd1f60d6d0031d02d66685d5ba72829c89c22ee84474c2527d4
-  data.tar.gz: cf3298fd572ca0666e9a808ffb1d359cc48050ad6a512d8777d2c9fb0635b8546c0fa7c9312198ea2113440cfc24d4a6ef28302c98d343c2dde7b5edefcae260
+  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
@@ -45,6 +49,10 @@ if ENV['RAILS_VERSION']
 
     # sprockets is optional for rails 7, but we currently require it, and test with it.
     gem "sprockets-rails"
+
+    # workaround bug in old rails
+    # https://github.com/rails/rails/pull/54264
+    gem "concurrent-ruby", "< 1.3.5"
   when /^6\.1\./
     # rails previous to 7.1 can't use sqlite 2
     gem "sqlite3", "~> 1.4"
@@ -53,17 +61,18 @@ if ENV['RAILS_VERSION']
     # Once mail 2.8.0 final is released this will not be required.
     # https://github.com/mikel/mail/pull/1472
     gem "mail", ">= 2.8.0.rc1"
+
+    # workaround bug in old rails
+    # https://github.com/rails/rails/pull/54264
+    gem "concurrent-ruby", "< 1.3.5"
   when /^6\.0\./
     # rails previous to 7.1 can't use sqlite 2
     gem "sqlite3", "~> 1.4"
 
     gem 'sass-rails', '>= 6'
-  when /^5\.[12]\./
-    # rails previous to 7.1 can't use sqlite 2
-    gem "sqlite3", "~> 1.4"
 
-    gem 'sass-rails', '~> 5.0'
-    gem 'sprockets', '~> 3.7'
-    gem 'thor', '~> 0.20'
+    # workaround bug in old rails
+    # https://github.com/rails/rails/pull/54264
+    gem "concurrent-ruby", "< 1.3.5"
   end
 end

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,13 +20,10 @@ 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 'typhoeus'
+  spec.add_dependency 'faraday', "~> 2.0"
 
   # Development dependencies include dependencies necessary for running
   # the dummy test app at ./spec/dummy_test_app

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/driver/google_drive.rb

@@ -70,7 +70,7 @@ module BrowseEverything
       # @param path [String] the path (default to the root)
       # @return [Array<BrowseEverything::FileEntry>] file entries for the path
       def list_files(drive, request_params, path: '')
-        drive.list_files(request_params.to_h) do |file_list, error|
+        drive.list_files(**request_params.to_h) do |file_list, error|
           # Raise an exception if there was an error Google API's
           if error.present?
             # In order to properly trigger reauthentication, the token must be cleared

data/lib/browse_everything/retriever.rb

@@ -2,25 +2,25 @@
 
 require 'addressable'
 require 'tempfile'
-require 'typhoeus'
+require 'faraday'
 
 module BrowseEverything
   # Class for raising errors when a download is invalid
   class DownloadError < StandardError
-    attr_reader :response
+    attr_accessor :response_body
 
     # Constructor
     # @param msg [String]
-    # @param response [Typhoeus::Response] response from the server
-    def initialize(msg, response)
-      @response = response
+    # @param response [String] response from the server
+    def initialize(msg, response_body)
+      @response_body = response_body
       super(msg)
     end
 
     # Generate the message for the exception
     # @return [String]
     def message
-      "#{super}: #{response.body}"
+      "#{super}: #{response_body}"
     end
   end
 
@@ -36,7 +36,7 @@ module BrowseEverything
       # @param headers [Hash] any custom headers required to transit the request
       def can_retrieve?(uri, headers = {})
         request_headers = headers.merge(Range: 'bytes=0-0')
-        response = Typhoeus.get(uri, headers: request_headers)
+        response = Faraday.get(uri, headers: request_headers)
         response.success?
       end
     end
@@ -133,17 +133,23 @@ module BrowseEverything
       file_size = options.fetch(:file_size)
       headers = options.fetch(:headers)
       url = options.fetch(:url)
-      retrieved = 0
-
-      request = Typhoeus::Request.new(url.to_s, method: :get, headers: headers)
-      request.on_headers do |response|
-        raise DownloadError.new("#{self.class}: Failed to download #{url}: Status Code: #{response.code}", response) unless response.code == 200
+      error_response = +""
+
+      conn = Faraday.new(url.to_s, headers: headers)
+      response = conn.get do |req|
+        req.options.on_data = proc do |chunk, overall_received_bytes, env|
+          if env.status == 200
+            # will yield to block passed in to outer retrieve_http, amazing.
+            yield(chunk, overall_received_bytes, file_size)
+          else
+            error_response << chunk
+          end
+        end
       end
-      request.on_body do |chunk|
-        retrieved += chunk.bytesize
-        yield(chunk, retrieved, file_size)
+
+      unless response.status == 200
+        raise DownloadError.new("#{self.class}: Failed to download #{url}: Status Code: #{response.status}", error_response)
       end
-      request.run
     end
 
     # Retrieve the file size
@@ -158,7 +164,7 @@ module BrowseEverything
       when 'file'
         File.size(url.path)
       when /https?/
-        response = Typhoeus.head(url.to_s, headers: headers)
+        response = Faraday.head(url.to_s, headers: headers)
         length_value = response.headers['Content-Length'] || file_size
         length_value.to_i
       else

data/lib/browse_everything/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrowseEverything
-  VERSION = '1.5.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

data/spec/lib/browse_everything/retriever_spec.rb

@@ -160,12 +160,13 @@ describe BrowseEverything::Retriever do
         stub_request(
           :get, "https://retrieve.cloud.example.com/some/dir/file_error.pdf"
         ).and_return(
-          status: 403
+          status: 403,
+          body: "Did not like this"
         )
       end
 
       it 'raises an exception' do
-        expect { retriever.download(download_options) }.to raise_error(BrowseEverything::DownloadError, /BrowseEverything::Retriever: Failed to download/)
+        expect { retriever.download(download_options) }.to raise_error(BrowseEverything::DownloadError, /BrowseEverything::Retriever: Failed to download.* Status Code: 403.*Did not like this/)
       end
     end
   end
@@ -234,7 +235,7 @@ describe BrowseEverything::Retriever do
       let(:url) { 'https://retrieve.cloud.example.com/some/dir/can_retrieve.pdf' }
       before do
         stub_request(
-          :get, "https://retrieve.cloud.example.com/some/dir/can_retrieve.pdf"
+          :get, %r{^https://retrieve.cloud.example.com/some/dir/can_retrieve.pdf\?}
         ).to_return(
           status: 206,
           body: '%'
@@ -250,7 +251,7 @@ describe BrowseEverything::Retriever do
       let(:url) { 'https://retrieve.cloud.example.com/some/dir/cannot_retrieve.pdf' }
       before do
         stub_request(
-          :get, "https://retrieve.cloud.example.com/some/dir/cannot_retrieve.pdf"
+          :get, %r{^https://retrieve.cloud.example.com/some/dir/cannot_retrieve.pdf\?}
         ).to_return(
           status: 403
         )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browse-everything
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0.alpha.1
 platform: ruby
 authors:
 - Carolyn Cole
@@ -10,10 +10,9 @@ authors:
 - Thomas Scherz
 - Xiaoming Wang
 - Jeremy Friesen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -43,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
@@ -112,47 +97,19 @@ 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
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  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'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bixby
   requirement: !ruby/object:Gem::Requirement
@@ -616,7 +573,6 @@ homepage: https://github.com/projecthydra/browse-everything
 licenses:
 - Apache 2
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -631,8 +587,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: AJAX/Rails engine file browser for cloud storage services
 test_files: