browse-everything 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1bbd0aea13e58513c925280595410ffeba0ceef0e8788edd2c91464e2c9ed23
-  data.tar.gz: ee947852e47f4ffd65373df2c9e07639a79dcac7630024f180b2aaeddb3052a0
+  metadata.gz: eedf3447096af5429b239653b707bf23e881fcd43a097cbe25804c7d48bc16e2
+  data.tar.gz: 1ccf9adb1e189a413ae6ceb9a4e67bccfae3a5179c84f583c1b165f4e051cf00
 SHA512:
-  metadata.gz: 4b7849dc7f82467af80ff48502e4c585bbfece43c9b3c688460af3a9ab64b3de7dc4ccde0eac8921d3cd20c8212affe68fd49b83ff725167113b0fca73c52e7a
-  data.tar.gz: b4a3532171ab1fd2b65575445aa9a1d83713ee29e6f0d3903090db010c2548a77e51a077cf5a49a20cdb744a2d7d6eb3523cc48313cffd70e7d456bf2304f38d
+  metadata.gz: 58511d9c04085a4a9d72246c906bb20cb46bac2e980d17bf90276807b67fe4c38eab79dbae89c10a69e735da6ee2e0acffe0399fe7993526a0454886cc3555ee
+  data.tar.gz: 5484761c6ed0b148ba8a10852dea363a1c6860b146271dd0b8bedbad65f37dfb50b0644f3da2ae533c0b84c782fadea9d808f8d1f2d10d1acb00e3ee8f9d6b34

data/.circleci/config.yml

@@ -13,7 +13,7 @@ jobs:
         type: string
       bundler_version:
         type: string
-        default: 2.4.3
+        default: 2.5.21
     executor:
       name: 'samvera/ruby'
       ruby_version: << parameters.ruby_version >>
@@ -45,52 +45,30 @@ jobs:
 workflows:
   ci:
     jobs:
+      - build:
+          name: "ruby3-3_rails8-0"
+          ruby_version: 3.3.6
+          rails_version: 8.0.0.1
       - build:
           name: "ruby3-3_rails7-2"
-          ruby_version: 3.3.3
-          rails_version: "7.2.0"
-
-
+          ruby_version: 3.3.6
+          rails_version: 7.2.1
       - build:
           name: "ruby3-2_rails7-1"
-          ruby_version: 3.2.1
-          rails_version: 7.1.1
+          ruby_version: 3.2.5
+          rails_version: 7.1.4
       - build:
           name: "ruby3-2_rails7-0"
-          ruby_version: 3.2.0
-          rails_version: 7.0.4
+          ruby_version: 3.2.5
+          rails_version: 7.0.8.4
       - build:
           name: "ruby3-1_rails7-0"
-          ruby_version: 3.1.2
-          rails_version: 7.0.4
-
+          ruby_version: 3.1.6
+          rails_version: 7.0.8.4
       - build:
           name: "ruby3-1_rails6-1"
-          ruby_version: 3.1.2
-          rails_version: 6.1.6
-      - build:
-          name: "ruby3-0_rails6-1"
-          ruby_version: 3.0.3
-          rails_version: 6.1.6
-
-      - build:
-          name: "ruby3-0_rails6-0"
-          ruby_version: 3.0.3
-          rails_version: 6.0.4.7
-      - build:
-          name: "ruby2-7_rails6-0"
-          ruby_version: 2.7.7
-          rails_version: 6.0.4.7
-
-      - build:
-          name: "ruby2-7_rails5-2"
-          ruby_version: 2.7.7
-          rails_version: 5.2.7
-
-      - build:
-          name: "ruby2-7_rails5-1"
-          ruby_version: 2.7.7
-          rails_version: 5.1.7
+          ruby_version: 3.1.6
+          rails_version: 6.1.7.8
 
   nightly:
     triggers:
@@ -101,45 +79,28 @@ workflows:
               only:
                 - main
     jobs:
+      - build:
+          name: "ruby3-3_rails8-0"
+          ruby_version: 3.3.6
+          rails_version: 8.0.0.1
       - build:
           name: "ruby3-3_rails7-2"
-          ruby_version: 3.3.3
-          rails_version: "7.2.0"
-
+          ruby_version: 3.3.5
+          rails_version: 7.2.1
+      - build:
+          name: "ruby3-2_rails7-1"
+          ruby_version: 3.2.5
+          rails_version: 7.1.4
       - build:
           name: "ruby3-2_rails7-0"
-          ruby_version: 3.2.0
-          rails_version: 7.0.4
+          ruby_version: 3.2.5
+          rails_version: 7.0.8.4
       - build:
           name: "ruby3-1_rails7-0"
-          ruby_version: 3.1.2
-          rails_version: 7.0.4
-
+          ruby_version: 3.1.6
+          rails_version: 7.0.8.4
       - build:
           name: "ruby3-1_rails6-1"
-          ruby_version: 3.1.2
-          rails_version: 6.1.6
-      - build:
-          name: "ruby3-0_rails6-1"
-          ruby_version: 3.0.3
-          rails_version: 6.1.6
-
-      - build:
-          name: "ruby3-0_rails6-0"
-          ruby_version: 3.0.3
-          rails_version: 6.0.4.7
-      - build:
-          name: "ruby2-7_rails6-0"
-          ruby_version: 2.7.7
-          rails_version: 6.0.4.7
-
-      - build:
-          name: "ruby2-7_rails5-2"
-          ruby_version: 2.7.7
-          rails_version: 5.2.7
-
-      - build:
-          name: "ruby2-7_rails5-1"
-          ruby_version: 2.7.7
-          rails_version: 5.1.7
+          ruby_version: 3.1.6
+          rails_version: 6.1.7.8
 

data/.tool-versions

@@ -1,2 +1,2 @@
-ruby 2.7.5
-nodejs lts-fermium
+ruby   3.1.6
+nodejs lts-gallium

data/Gemfile

@@ -23,7 +23,7 @@ end
 
 # Set a default RAILS_VERSION so we make sure to get extra dependencies for it...
 
-ENV['RAILS_VERSION'] ||= "7.1.1"
+ENV['RAILS_VERSION'] ||= "8.0.0"
 
 if ENV['RAILS_VERSION']
   if ENV['RAILS_VERSION'] == 'edge'
@@ -33,22 +33,42 @@ if ENV['RAILS_VERSION']
   end
 
   case ENV['RAILS_VERSION']
+  when /^8./
+    # sprockets is not usually included in Rails 8, but we currently require it, and test with it.
+    gem "sprockets-rails"
   when /^7\.1\./
     # sprockets is optional for rails 7, but we currently require it, and test with it.
     gem "sprockets-rails"
   when /^7\.0\./
+    # rails previous to 7.1 can't use sqlite 2
+    gem "sqlite3", "~> 1.4"
+
     # 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"
+
     # opt into mail 2.8.0.rc1 so we get extra dependencies required for rails 6.1
     # 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]\./
-    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

@@ -26,33 +26,48 @@ download the files.
 
 ## Technical Debt/Legacy warning
 
-This is code with a long history that has a number of known problems;
-we are trying to keep it alive for existing projects using it. But caution is
-advised in introducing it, in it's present form, to new projects.
+This project has been receiving very limited maintenance for at least 2-4 years
+now  -- just enough to keep it working for present users. Caution is indicated in
+considering adoption for new projects.
 
-A significant overhaul of this gem may be desirable (with backwards-breaking
-changes), to better accomplish gem goals. But there has not been the
-interest/resources in the community to accomplish that at present.
+### Known issues (Nov 2024)
 
-Some known current issues (Jun 2022):
+* The S3 local file system adapters are known working. It's not clear if any other
+adapters are working properly -- or if the browse_everything architecture as is
+is sufficient to support OAuth2 integration flows that may be required to get them
+working.
 
-* The S3 adapter is known working; but it's not clear if other adapters using
-OAuth2 (main use case for this gem) are in fact working reliably. And there
-is some concern that the current browse-everything integration API may not be
-compatible with proper OAuth/OAuth2 flows to support OAuth integrations --
-originally the main use case of this gem.
+* CSS and Javascript were both written for use with sprockets asset pipeline, and are
+currently only tested with sprockets -- even in Rails 8, where `rails new` cannot
+generate a sprockets using app.
+  * For use with Rails 8, you could consider adding sprockets to your app manually,
+    or copying browse_everything JS and CSS assets into your local app and including
+    them that way. The browse_everything installer is not capable of doing this
+    in an automated fashion.
 
-* The CSS and Javascript were both written for use with the sprockets Rails
-asset pipeline.  Recent versions of Rails may require custom configuration
-to use sprockets (especially for JS), which is not currently covered in
-instructions here. Using other means of including CSS and JS may require
-confusing customization also not fully covered here.
+* Good news: The `bootstrap4` CSS is tentatively demonstrated working with bootstrap 5
+too.
 
-* Javascript depends on JQuery, bootstrap (3 or 4; 5 untested), as well as a
-vendored copy of a jquery.treetable plugin.
+* JS depends on JQuery, which is unfortunate in 2024. As well as a vendored copy of
+  a jquery.treetable plugin.
 
-* CSS is provided for compatibilty with bootstrap 3 or bootstrap 4, but not
-bootstrap 5 (or no bootstrap at all)
+### Possible path to a revived gem
+
+If there are interest and resources, assuming a major version release.
+
+* Rewrite JS from the ground up to be vanilla JS without JQuery.
+  * And useable by either `importmap-rails` or an npm-based rails JS bundler.
+
+* Figure out what adapters actually work, drop those that don't work from the gem.
+  * Possibly find adapters in PR's or forks that work and can be added.
+
+* Testing overhaul
+  * Adapters have their network communication with cloud mocked for good reason,
+    but that makes them false negative and unreliable at detecting breakage.
+  * Testing is done with an in-repo Rails app instead of engine_cart, which
+    is probably reasonable, but that makes it harder to really test integration
+    with differnet rails versions or test the installer works, as Rails has had
+    churn in JS.  go back to engine_cart, or consider [combustion](https://github.com/pat/combustion)
 
 ## Product Owner & Maintenance
 

data/browse-everything.gemspec

@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
   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.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
@@ -49,7 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sass-rails'
   spec.add_development_dependency 'selenium-webdriver'
   # Rails <= 7.1 can't use sqlite3 gem 2.x yet
-  spec.add_development_dependency 'sqlite3', "~> 1.4"
+  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'turbolinks'
   spec.add_development_dependency 'webdrivers'
   spec.add_development_dependency 'webmock'

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.4.0'
+  VERSION = '1.6.0'
 end

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.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Carolyn Cole
@@ -10,10 +10,9 @@ authors:
 - Thomas Scherz
 - Xiaoming Wang
 - Jeremy Friesen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -100,7 +99,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -110,7 +109,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: ruby-box
   requirement: !ruby/object:Gem::Requirement
@@ -140,19 +139,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.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
@@ -395,16 +394,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turbolinks
   requirement: !ruby/object:Gem::Requirement
@@ -616,7 +615,6 @@ homepage: https://github.com/projecthydra/browse-everything
 licenses:
 - Apache 2
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -631,8 +629,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: