browse-everything 1.1.0 → 1.2.0

data/lib/browse_everything/driver/file_system.rb

@@ -9,13 +9,17 @@ module BrowseEverything
 
       def validate_config
         raise BrowseEverything::InitializationError, 'FileSystem driver requires a :home argument' if config[:home].blank?
+
+        unless config[:home].start_with?("/") || config[:allow_relative_home] == true
+          raise BrowseEverything::InitializationError, 'FileSystem driver :home argument must be absolute unless :allow_relative_home is set'
+        end
       end
 
       # Retrieve the contents of a directory
       # @param path [String] the path to a file system resource
       # @return [Array<BrowseEverything::FileEntry>]
       def contents(path = '')
-        real_path = File.join(config[:home], path)
+        real_path = File.join(home_path, path)
         values = if File.directory?(real_path)
                    make_directory_entry real_path
                  else
@@ -55,25 +59,34 @@ module BrowseEverything
 
       private
 
-        # Construct an array of FileEntry objects for the contents of a
-        # directory
-        # @param real_path [String] path to the file system directory
-        # @return [Array<BrowseEverything::FileEntry>]
-        def make_directory_entry(real_path)
-          entries = []
-          entries + Dir[File.join(real_path, '*')].collect { |f| details(f) }
-        end
+      def home_path
+        @home_path ||= if config[:allow_relative_home] == true
+                         # expand relative to Rails.root, mainly test CI use-case
+                         File.expand_path(config[:home], Rails.root)
+                       else
+                         config[:home]
+                       end
+      end
 
-        def make_pathname(path)
-          Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(config[:home]))
-        end
+      # Construct an array of FileEntry objects for the contents of a
+      # directory
+      # @param real_path [String] path to the file system directory
+      # @return [Array<BrowseEverything::FileEntry>]
+      def make_directory_entry(real_path)
+        entries = []
+        entries + Dir[File.join(real_path, '*')].collect { |f| details(f) }
+      end
 
-        def file_size(path)
-          File.size(path).to_i
-        rescue StandardError => error
-          Rails.logger.error "Failed to find the file size for #{path}: #{error}"
-          0
-        end
+      def make_pathname(path)
+        Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(home_path))
+      end
+
+      def file_size(path)
+        File.size(path).to_i
+      rescue StandardError => error
+        Rails.logger.error "Failed to find the file size for #{path}: #{error}"
+        0
+      end
     end
   end
 end

data/lib/browse_everything/driver/google_drive.rb

@@ -191,50 +191,50 @@ module BrowseEverything
 
       private
 
-        def client_secrets
-          {
-            Google::Auth::ClientId::WEB_APP => {
-              Google::Auth::ClientId::CLIENT_ID => config[:client_id],
-              Google::Auth::ClientId::CLIENT_SECRET => config[:client_secret]
-            }
+      def client_secrets
+        {
+          Google::Auth::ClientId::WEB_APP => {
+            Google::Auth::ClientId::CLIENT_ID => config[:client_id],
+            Google::Auth::ClientId::CLIENT_SECRET => config[:client_secret]
           }
-        end
+        }
+      end
 
-        # This is required for using the googleauth Gem
-        # @see http://www.rubydoc.info/gems/googleauth/Google/Auth/Stores/FileTokenStore FileTokenStore for googleauth
-        # @return [Tempfile] temporary file within which to cache credentials
-        def file_token_store_path
-          Tempfile.new('gdrive.yaml')
-        end
+      # This is required for using the googleauth Gem
+      # @see http://www.rubydoc.info/gems/googleauth/Google/Auth/Stores/FileTokenStore FileTokenStore for googleauth
+      # @return [Tempfile] temporary file within which to cache credentials
+      def file_token_store_path
+        Tempfile.new('gdrive.yaml')
+      end
 
-        def scope
-          Google::Apis::DriveV3::AUTH_DRIVE
-        end
+      def scope
+        Google::Apis::DriveV3::AUTH_DRIVE
+      end
 
-        # Provides the user ID for caching access tokens
-        # (This is a hack which attempts to anonymize the access tokens)
-        # @return [String] the ID for the user
-        def user_id
-          'current_user'
-        end
+      # Provides the user ID for caching access tokens
+      # (This is a hack which attempts to anonymize the access tokens)
+      # @return [String] the ID for the user
+      def user_id
+        'current_user'
+      end
 
-        # Please see https://developers.google.com/drive/v3/web/manage-downloads
-        # @param id [String] the ID for the Google Drive File
-        # @return [String] the URL for the file download
-        def download_url(id)
-          "https://www.googleapis.com/drive/v3/files/#{id}?alt=media"
-        end
+      # Please see https://developers.google.com/drive/v3/web/manage-downloads
+      # @param id [String] the ID for the Google Drive File
+      # @return [String] the URL for the file download
+      def download_url(id)
+        "https://www.googleapis.com/drive/v3/files/#{id}?alt=media"
+      end
 
-        # Restore the credentials for the Google API
-        # @param access_token [String] the access token redeemed using an authorization code
-        # @return Credentials credentials restored from a cached access token
-        def restore_credentials(access_token)
-          client = Auth::Google::Credentials.new
-          client.client_id = client_id.id
-          client.client_secret = client_id.secret
-          client.update_token!('access_token' => access_token)
-          @credentials = client
-        end
+      # Restore the credentials for the Google API
+      # @param access_token [String] the access token redeemed using an authorization code
+      # @return Credentials credentials restored from a cached access token
+      def restore_credentials(access_token)
+        client = Auth::Google::Credentials.new
+        client.client_id = client_id.id
+        client.client_secret = client_id.secret
+        client.update_token!('access_token' => access_token)
+        @credentials = client
+      end
     end
   end
 end

data/lib/browse_everything/driver/s3.rb

@@ -79,79 +79,79 @@ module BrowseEverything
 
       private
 
-        def strip(path)
-          path.sub %r{^/?(.+?)/?$}, '\1'
-        end
+      def strip(path)
+        path.sub %r{^/?(.+?)/?$}, '\1'
+      end
 
-        def from_base(key)
-          Pathname.new(key).relative_path_from(Pathname.new(config[:base].to_s)).to_s
-        end
+      def from_base(key)
+        Pathname.new(key).relative_path_from(Pathname.new(config[:base].to_s)).to_s
+      end
 
-        def full_path(path)
-          config[:base].present? ? File.join(config[:base], path) : path
-        end
+      def full_path(path)
+        config[:base].present? ? File.join(config[:base], path) : path
+      end
 
-        def aws_config
-          result = {}
-          result[:credentials] = Aws::Credentials.new(config[:app_key], config[:app_secret]) if config[:app_key].present?
-          result[:region] = config[:region] if config.key?(:region)
-          result
-        end
+      def aws_config
+        result = {}
+        result[:credentials] = Aws::Credentials.new(config[:app_key], config[:app_secret]) if config[:app_key].present?
+        result[:region] = config[:region] if config.key?(:region)
+        result
+      end
 
-        def session
-          AuthenticationFactory.new(
-            self.class.authentication_klass,
-            aws_config
-          )
-        end
+      def session
+        AuthenticationFactory.new(
+          self.class.authentication_klass,
+          aws_config
+        )
+      end
 
-        def authenticate
-          session.authenticate
-        end
+      def authenticate
+        session.authenticate
+      end
 
-        def client
-          @client ||= authenticate
-        end
+      def client
+        @client ||= authenticate
+      end
 
-        # Construct a BrowseEverything::FileEntry object
-        # @param name [String]
-        # @param size [String]
-        # @param date [DateTime]
-        # @param dir [String]
-        # @return [BrowseEverything::FileEntry]
-        def entry_for(name, size, date, dir)
-          BrowseEverything::FileEntry.new(name, [key, name].join(':'), File.basename(name), size, date, dir)
-        end
+      # Construct a BrowseEverything::FileEntry object
+      # @param name [String]
+      # @param size [String]
+      # @param date [DateTime]
+      # @param dir [String]
+      # @return [BrowseEverything::FileEntry]
+      def entry_for(name, size, date, dir)
+        BrowseEverything::FileEntry.new(name, [key, name].join(':'), File.basename(name), size, date, dir)
+      end
 
-        # Populate the entries with FileEntry objects from an S3 listing
-        # @param listing [Seahorse::Client::Response]
-        def add_directories(listing)
-          listing.common_prefixes.each do |prefix|
-            new_entry = entry_for(from_base(prefix.prefix), 0, Time.current, true)
-            @entries << new_entry unless new_entry.nil?
-          end
+      # Populate the entries with FileEntry objects from an S3 listing
+      # @param listing [Seahorse::Client::Response]
+      def add_directories(listing)
+        listing.common_prefixes.each do |prefix|
+          new_entry = entry_for(from_base(prefix.prefix), 0, Time.current, true)
+          @entries << new_entry unless new_entry.nil?
         end
+      end
 
-        # Given a listing and a S3 listing and path, populate the entries
-        # @param listing [Seahorse::Client::Response]
-        # @param path [String]
-        def add_files(listing, path)
-          listing.contents.each do |entry|
-            key = from_base(entry.key)
-            new_entry = entry_for(key, entry.size, entry.last_modified, false)
-            @entries << new_entry unless strip(key) == strip(path) || new_entry.nil?
-          end
+      # Given a listing and a S3 listing and path, populate the entries
+      # @param listing [Seahorse::Client::Response]
+      # @param path [String]
+      def add_files(listing, path)
+        listing.contents.each do |entry|
+          key = from_base(entry.key)
+          new_entry = entry_for(key, entry.size, entry.last_modified, false)
+          @entries << new_entry unless strip(key) == strip(path) || new_entry.nil?
         end
+      end
 
-        # For a given path to a S3 resource, retrieve the listing object and
-        # construct the file entries
-        # @param path [String]
-        def generate_listing(path)
-          client
-          listing = client.list_objects(bucket: config[:bucket], delimiter: '/', prefix: full_path(path))
-          add_directories(listing)
-          add_files(listing, path)
-        end
+      # For a given path to a S3 resource, retrieve the listing object and
+      # construct the file entries
+      # @param path [String]
+      def generate_listing(path)
+        client
+        listing = client.list_objects(bucket: config[:bucket], delimiter: '/', prefix: full_path(path))
+        add_directories(listing)
+        add_files(listing, path)
+      end
     end
   end
 end

data/lib/browse_everything/engine.rb

@@ -2,8 +2,15 @@
 
 module BrowseEverything
   class Engine < ::Rails::Engine
-    config.assets.paths << config.root.join('vendor', 'assets', 'javascripts')
-    config.assets.paths << config.root.join('vendor', 'assets', 'stylesheets')
-    config.assets.precompile += %w[browse_everything.js browse_everything.css]
+    # As of Rails 7, sprockets is optional in Rails. If you don't have sprockets-rails
+    # installed, you don't have a config.assets.  Without sprockets, you may
+    # or may not be able to figure out how to get browse-everything JS and CSS to load,
+    # but we should at least let you load the engine and try, so we don't try
+    # to configure sprockets unless it is installed...
+    if config.respond_to?(:assets)
+      config.assets.paths << config.root.join('vendor', 'assets', 'javascripts')
+      config.assets.paths << config.root.join('vendor', 'assets', 'stylesheets')
+      config.assets.precompile += %w[browse_everything.js browse_everything.css]
+    end
   end
 end

data/lib/browse_everything/file_entry.rb

@@ -15,7 +15,7 @@ module BrowseEverything
     end
 
     def relative_parent_path?
-      name =~ /^\.\.?$/ ? true : false
+      name.match?(/^\.\.?$/)
     end
 
     def container?

data/lib/browse_everything/retriever.rb

@@ -89,81 +89,81 @@ module BrowseEverything
 
     private
 
-      # Extract and parse options used to download a file or resource from an HTTP API
-      # @param options [Hash]
-      # @return [Hash]
-      def extract_download_options(options)
-        url = options.fetch('url')
-
-        # This avoids the potential for a KeyError
-        headers = options.fetch('headers', {}) || {}
-
-        file_size_value = options.fetch('file_size', 0)
-        file_size = file_size_value.to_i
-
-        output = {
-          url: ::Addressable::URI.parse(url),
-          headers: headers,
-          file_size: file_size
-        }
-
-        output[:file_size] = get_file_size(output) if output[:file_size] < 1
-        output
-      end
+    # Extract and parse options used to download a file or resource from an HTTP API
+    # @param options [Hash]
+    # @return [Hash]
+    def extract_download_options(options)
+      url = options.fetch('url')
 
-      # Retrieve the file from the file system
-      # @param options [Hash]
-      def retrieve_file(options)
-        file_uri = options.fetch(:url)
-        file_size = options.fetch(:file_size)
-
-        retrieved = 0
-        File.open(file_uri.path, 'rb') do |f|
-          until f.eof?
-            chunk = f.read(chunk_size)
-            retrieved += chunk.length
-            yield(chunk, retrieved, file_size)
-          end
-        end
-      end
+      # This avoids the potential for a KeyError
+      headers = options.fetch('headers', {}) || {}
 
-      # Retrieve a resource over the HTTP
-      # @param options [Hash]
-      def retrieve_http(options)
-        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
-        end
-        request.on_body do |chunk|
-          retrieved += chunk.bytesize
+      file_size_value = options.fetch('file_size', 0)
+      file_size = file_size_value.to_i
+
+      output = {
+        url: ::Addressable::URI.parse(url),
+        headers: headers,
+        file_size: file_size
+      }
+
+      output[:file_size] = get_file_size(output) if output[:file_size] < 1
+      output
+    end
+
+    # Retrieve the file from the file system
+    # @param options [Hash]
+    def retrieve_file(options)
+      file_uri = options.fetch(:url)
+      file_size = options.fetch(:file_size)
+
+      retrieved = 0
+      File.open(file_uri.path, 'rb') do |f|
+        until f.eof?
+          chunk = f.read(chunk_size)
+          retrieved += chunk.length
           yield(chunk, retrieved, file_size)
         end
-        request.run
       end
+    end
 
-      # Retrieve the file size
-      # @param options [Hash]
-      # @return [Integer] the size of the requested file
-      def get_file_size(options)
-        url = options.fetch(:url)
-        headers = options.fetch(:headers)
-        file_size = options.fetch(:file_size)
-
-        case url.scheme
-        when 'file'
-          File.size(url.path)
-        when /https?/
-          response = Typhoeus.head(url.to_s, headers: headers)
-          length_value = response.headers['Content-Length'] || file_size
-          length_value.to_i
-        else
-          raise URI::BadURIError, "Unknown URI scheme: #{url.scheme}"
-        end
+    # Retrieve a resource over the HTTP
+    # @param options [Hash]
+    def retrieve_http(options)
+      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
       end
+      request.on_body do |chunk|
+        retrieved += chunk.bytesize
+        yield(chunk, retrieved, file_size)
+      end
+      request.run
+    end
+
+    # Retrieve the file size
+    # @param options [Hash]
+    # @return [Integer] the size of the requested file
+    def get_file_size(options)
+      url = options.fetch(:url)
+      headers = options.fetch(:headers)
+      file_size = options.fetch(:file_size)
+
+      case url.scheme
+      when 'file'
+        File.size(url.path)
+      when /https?/
+        response = Typhoeus.head(url.to_s, headers: headers)
+        length_value = response.headers['Content-Length'] || file_size
+        length_value.to_i
+      else
+        raise URI::BadURIError, "Unknown URI scheme: #{url.scheme}"
+      end
+    end
   end
 end

data/lib/browse_everything/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrowseEverything
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/browse_everything.rb

@@ -55,7 +55,7 @@ module BrowseEverything
         begin
           config_file_content = File.read(value)
           config_file_template = ERB.new(config_file_content)
-          config_values = YAML.safe_load(config_file_template.result, [Symbol])
+          config_values = YAML.safe_load(config_file_template.result, permitted_classes: [Symbol])
           @config = ActiveSupport::HashWithIndifferentAccess.new config_values
           @config.deep_symbolize_keys
         rescue Errno::ENOENT

data/spec/dummy_test_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy_test_app/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link application.css
+//= link application.js

data/spec/dummy_test_app/app/assets/javascripts/application.js

@@ -0,0 +1,25 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+
+// We want to test with turbolinks, which our code also requires rails-ujs to deal with:
+
+//= require rails-ujs
+//= require turbolinks
+
+// Actual stack required for current browse-everything JS
+
+//= require jquery3
+//= require bootstrap
+//= require browse_everything
+
+//= require_tree .

data/spec/dummy_test_app/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy_test_app/app/assets/stylesheets/application.scss

@@ -0,0 +1,18 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+@import "bootstrap";
+@import "browse_everything/browse_everything_bootstrap4";

data/spec/dummy_test_app/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy_test_app/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy_test_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy_test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy_test_app/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy_test_app/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy_test_app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy_test_app/app/views/file_handler/index.html.erb

@@ -0,0 +1,10 @@
+<div class="panel panel-default">
+  <div class="panel-body">
+    <a href="main" class="btn btn-large btn-primary" role="button">Enter Test App (Turbolinks)</a>
+
+    <%# this doesn't REALLY test no Turbolinks, as there will still be a `window.Turbolinks` object,
+        and a `turbolinks:load` event. It just tests as if the page we are navigating to were the FIRST
+        page loaded under turbolinks %>
+    <a href="main" class="btn btn-large btn-primary" role="button" data-turbolinks="false" data-no-turbolink>Enter Test App (No Turbolinks)</a>
+  </div>
+</div>