browse-everything 1.6.1 → 2.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faa729e0e6ae6d2ae76c0c9364b44017d689bbb89153b3c1e98bde8c17fa1427
-  data.tar.gz: 7a29fe7df1a1dd5bdd309e23e4edc22af28d3fb618bceaf01d852537d37fdb3b
+  metadata.gz: 64351da415814ba91aa2beebfc70fa27cbcc7c09ba0175f07425870b5ff4c364
+  data.tar.gz: 4908e6bd8ec3c2e6801fe112f3fc9458dd3ccb20b3c5e5a538a813659ddf9ea3
 SHA512:
-  metadata.gz: 4a97f843dafad43ddb8a58cf30f663d586dcdecaec0ba1fde64f38c2189c6a3c731d9fd0e1c9c39437ce63f8ad294ded4befac02d651b9de2063eedf3b13311b
-  data.tar.gz: 487830c4ba65dbd1810774a87fef7ecd4202e805a4153bbfdb4c333e9c833afdcfaab24de26e285c198e2bc29d1ea944f387bf1011cb21c76e697da88a23e2d3
+  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
@@ -25,12 +29,6 @@ end
 
 ENV['RAILS_VERSION'] ||= "8.0.0"
 
-# json 3 dropped the quirks_mode option that ActiveSupport before 8.1 passes
-# when encoding, so Hash#to_json raises ArgumentError under it.
-if ENV['RAILS_VERSION'] != 'edge' && Gem::Version.new(ENV['RAILS_VERSION']) < Gem::Version.new('8.1')
-  gem 'json', '< 3'
-end
-
 if ENV['RAILS_VERSION']
   if ENV['RAILS_VERSION'] == 'edge'
     gem 'rails', github: 'rails/rails'

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/app/assets/javascripts/browse_everything/behavior.js

@@ -323,12 +323,7 @@ $(function () {
 
   $(document).on('click', 'button.ev-submit', function (event) {
     event.preventDefault();
-    // button('loading') is Bootstrap 3's button plugin. When jQuery UI's
-    // button widget owns $.fn.button instead, it throws on the call and the
-    // selection is never submitted. startWait() disables the button either way.
-    if ($.fn.button && $.fn.button.Constructor) {
-      $(this).button('loading');
-    }
+    $(this).button('loading');
     startWait();
     $('form.ev-submit-form').append(Array.from(selected_files.values()));
     var main_form = $(this).closest('form');

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

@@ -55,19 +55,17 @@ module BrowseEverything
       def link_for(path)
         obj = bucket.object(full_path(path))
 
-        response_type = config[:response_type].to_sym
-        url = case response_type
+        extras = {
+          file_name: File.basename(path),
+          expires: (config[:expires_in] if config[:response_type] == :signed_url)
+        }.compact
+
+        url = case config[:response_type].to_sym
               when :signed_url then obj.presigned_url(:get, expires_in: config[:expires_in])
               when :public_url then obj.public_url
               when :s3_uri     then "s3://#{obj.bucket_name}/#{obj.key}"
               end
 
-        extras = {
-          file_name: File.basename(path),
-          file_size: object_size(obj),
-          expires: (signed_url_expiry(url) if response_type == :signed_url)
-        }.compact
-
         [url, extras]
       end
 
@@ -81,26 +79,6 @@ module BrowseEverything
 
       private
 
-      # The size is a convenience for consumers, so credentials that can list
-      # but not read an object (enough for an :s3_uri link) leave it out
-      # rather than fail the link.
-      def object_size(obj)
-        obj.content_length
-      rescue Aws::S3::Errors::ServiceError, Seahorse::Client::NetworkingError
-        nil
-      end
-
-      # Retriever#retrieve parses `expires` as a time, so send when the link
-      # expires, as the Box and Google Drive drivers do. It is read from the
-      # signed URL itself because the SDK can sign for less than expires_in,
-      # for example when the signing credentials are temporary.
-      def signed_url_expiry(url)
-        params = Rack::Utils.parse_query(URI(url).query)
-        return unless params['X-Amz-Date'] && params['X-Amz-Expires']
-
-        Time.strptime(params['X-Amz-Date'], '%Y%m%dT%H%M%S%z') + params['X-Amz-Expires'].to_i
-      end
-
       def strip(path)
         path.sub %r{^/?(.+?)/?$}, '\1'
       end

data/lib/browse_everything/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrowseEverything
-  VERSION = '1.6.1'
+  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/driver/s3_spec.rb

@@ -134,68 +134,28 @@ describe BrowseEverything::Driver::S3 do
       context 'when retrieving the link for an asset' do
         subject { contents[2] }
 
-        let(:signed_at) { Time.now.utc.change(usec: 0) }
-        let(:presigned_url) do
-          "https://s3.amazonaws.com/presigned_url?X-Amz-Date=#{signed_at.strftime('%Y%m%dT%H%M%SZ')}&X-Amz-Expires=3600"
-        end
-
         before do
           object = instance_double(Aws::S3::Object)
-          allow(object).to receive(:presigned_url).and_return(presigned_url)
+          allow(object).to receive(:presigned_url).and_return('https://s3.amazonaws.com/presigned_url')
           allow(object).to receive(:public_url).and_return('https://s3.amazonaws.com/public_url')
           allow(object).to receive(:bucket_name).and_return('s3.bucket')
           allow(object).to receive(:key).and_return('foo/quux.png')
-          allow(object).to receive(:content_length).and_return(1_511_860)
           allow(provider.bucket).to receive(:object).and_return(object)
         end
 
         it ':signed_url' do
           provider.config[:response_type] = :signed_url
-          expect(provider.link_for('foo/quux.png')).to eq [presigned_url, { file_name: 'quux.png', file_size: 1_511_860, expires: signed_at + 3600 }]
-        end
-
-        it ':signed_url reports the lifetime the URL was signed for, not expires_in' do
-          provider.config[:response_type] = :signed_url
-          provider.config[:expires_in] = 14400
-          expect(provider.link_for('foo/quux.png').last[:expires]).to eq signed_at + 3600
-        end
-
-        it ':signed_url configured as a string still sends the expiry' do
-          provider.config[:response_type] = 'signed_url'
-          expect(provider.link_for('foo/quux.png').last[:expires]).to eq signed_at + 3600
-        end
-
-        [Aws::S3::Errors::Forbidden.new(nil, 'Forbidden'), Seahorse::Client::NetworkingError.new(Errno::ECONNRESET.new)].each do |error|
-          it "leaves out the size when reading it raises #{error.class}" do
-            provider.config[:response_type] = :s3_uri
-            allow(provider.bucket.object('foo/quux.png')).to receive(:content_length).and_raise(error)
-            expect(provider.link_for('foo/quux.png')).to eq ['s3://s3.bucket/foo/quux.png', { file_name: 'quux.png' }]
-          end
-        end
-
-        it ':s3_uri keeps a key that is not a valid URI' do
-          provider.config[:response_type] = :s3_uri
-          allow(provider.bucket.object('foo/quux.png')).to receive(:key).and_return('foo/résumé file.pdf')
-          expect(provider.link_for('foo/quux.png').first).to eq 's3://s3.bucket/foo/résumé file.pdf'
-        end
-
-        it ':signed_url gives an expiry the retriever accepts' do
-          provider.config[:response_type] = :signed_url
-          url, extras = provider.link_for('foo/quux.png')
-          spec = { 'url' => url, 'expires' => extras[:expires].to_s, 'file_size' => extras[:file_size] }
-          retriever = BrowseEverything::Retriever.new
-          allow(retriever).to receive(:retrieve_http)
-          expect { retriever.retrieve(spec) }.not_to raise_error
+          expect(provider.link_for('foo/quux.png')).to eq ['https://s3.amazonaws.com/presigned_url', { file_name: 'quux.png', expires: 14400 }]
         end
 
         it ':public_url' do
           provider.config[:response_type] = :public_url
-          expect(provider.link_for('foo/quux.png')).to eq ['https://s3.amazonaws.com/public_url', { file_name: 'quux.png', file_size: 1_511_860 }]
+          expect(provider.link_for('foo/quux.png')).to eq ['https://s3.amazonaws.com/public_url', { file_name: 'quux.png' }]
         end
 
         it ':s3_uri' do
           provider.config[:response_type] = :s3_uri
-          expect(provider.link_for('foo/quux.png')).to eq ['s3://s3.bucket/foo/quux.png', { file_name: 'quux.png', file_size: 1_511_860 }]
+          expect(provider.link_for('foo/quux.png')).to eq ['s3://s3.bucket/foo/quux.png', { file_name: 'quux.png' }]
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browse-everything
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  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
@@ -629,7 +587,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.22
+rubygems_version: 3.7.1
 specification_version: 4
 summary: AJAX/Rails engine file browser for cloud storage services
 test_files: