browse-everything 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a514ad33ec151f78c54fd74220a6d385bde4107894e2b6beb69e30eab6c27e
-  data.tar.gz: e688ee1ba6a0a9b8f519ca33077acda6bbc062033fc122c33876da850ff36146
+  metadata.gz: faa729e0e6ae6d2ae76c0c9364b44017d689bbb89153b3c1e98bde8c17fa1427
+  data.tar.gz: 7a29fe7df1a1dd5bdd309e23e4edc22af28d3fb618bceaf01d852537d37fdb3b
 SHA512:
-  metadata.gz: 8b3b2068517c326ca832b8adf020dff2e297576bb19189f0707e5f812cc01b09ceef932cc8903fd1f60d6d0031d02d66685d5ba72829c89c22ee84474c2527d4
-  data.tar.gz: cf3298fd572ca0666e9a808ffb1d359cc48050ad6a512d8777d2c9fb0635b8546c0fa7c9312198ea2113440cfc24d4a6ef28302c98d343c2dde7b5edefcae260
+  metadata.gz: 4a97f843dafad43ddb8a58cf30f663d586dcdecaec0ba1fde64f38c2189c6a3c731d9fd0e1c9c39437ce63f8ad294ded4befac02d651b9de2063eedf3b13311b
+  data.tar.gz: 487830c4ba65dbd1810774a87fef7ecd4202e805a4153bbfdb4c333e9c833afdcfaab24de26e285c198e2bc29d1ea944f387bf1011cb21c76e697da88a23e2d3

data/Gemfile

@@ -25,6 +25,12 @@ 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'
@@ -45,6 +51,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 +63,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/app/assets/javascripts/browse_everything/behavior.js

@@ -323,7 +323,12 @@ $(function () {
 
   $(document).on('click', 'button.ev-submit', function (event) {
     event.preventDefault();
-    $(this).button('loading');
+    // 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');
+    }
     startWait();
     $('form.ev-submit-form').append(Array.from(selected_files.values()));
     var main_form = $(this).closest('form');

data/browse-everything.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   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/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/driver/s3.rb

@@ -55,17 +55,19 @@ module BrowseEverything
       def link_for(path)
         obj = bucket.object(full_path(path))
 
-        extras = {
-          file_name: File.basename(path),
-          expires: (config[:expires_in] if config[:response_type] == :signed_url)
-        }.compact
-
-        url = case config[:response_type].to_sym
+        response_type = config[:response_type].to_sym
+        url = case response_type
               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
 
@@ -79,6 +81,26 @@ 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/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 = '1.6.1'
 end

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

@@ -134,28 +134,68 @@ 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('https://s3.amazonaws.com/presigned_url')
+          allow(object).to receive(:presigned_url).and_return(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 ['https://s3.amazonaws.com/presigned_url', { file_name: 'quux.png', expires: 14400 }]
+          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
         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' }]
+          expect(provider.link_for('foo/quux.png')).to eq ['https://s3.amazonaws.com/public_url', { file_name: 'quux.png', file_size: 1_511_860 }]
         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' }]
+          expect(provider.link_for('foo/quux.png')).to eq ['s3://s3.bucket/foo/quux.png', { file_name: 'quux.png', file_size: 1_511_860 }]
         end
       end
     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.5.0
+  version: 1.6.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
@@ -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
@@ -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: 4.0.22
 specification_version: 4
 summary: AJAX/Rails engine file browser for cloud storage services
 test_files: