browse-everything 1.1.2 → 1.2.0

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/browse_everything/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy_test_app/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/browse-everything.gemspec

@@ -15,29 +15,30 @@ Gem::Specification.new do |spec|
   spec.license       = 'Apache 2'
 
   spec.files         = `git ls-files -z`.split(/\000/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_dependency 'addressable', '~> 2.5'
   spec.add_dependency 'aws-sdk-s3'
-  spec.add_dependency 'dropbox_api', '>= 0.1.10'
-  spec.add_dependency 'google-api-client', '~> 0.23'
-  spec.add_dependency 'google_drive', '>= 2.1', "< 4"
-  spec.add_dependency 'googleauth', '>= 0.6.6', '< 1.0'
-  spec.add_dependency 'rails', '>= 4.2', '< 7.0'
+  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', '< 7.1'
   spec.add_dependency 'ruby-box'
   spec.add_dependency 'signet', '~> 0.8'
   spec.add_dependency 'typhoeus'
 
-  spec.add_development_dependency 'bixby', '~> 3.0'
+  # Development dependencies include dependencies necessary for running
+  # the dummy test app at ./spec/dummy_test_app
+
+  spec.add_development_dependency 'bixby', '~> 5.0'
+  spec.add_development_dependency 'bootstrap', "~> 4.0" # we do not support bootstrap 5
   spec.add_development_dependency 'bundler', '>= 1.3'
   spec.add_development_dependency 'capybara'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'engine_cart', '~> 2.0'
   spec.add_development_dependency 'factory_bot_rails'
-  spec.add_development_dependency 'jasmine', '~> 2.3'
+  spec.add_development_dependency 'jquery-rails'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'puma'
   spec.add_development_dependency 'rails-controller-testing'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
@@ -45,9 +46,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'sass-rails'
   spec.add_development_dependency 'selenium-webdriver'
-  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'turbolinks'
   spec.add_development_dependency 'webdrivers'
   spec.add_development_dependency 'webmock'
 end

data/lib/browse_everything/driver/base.rb

@@ -32,6 +32,7 @@ module BrowseEverything
         # @param subclass [Class] the class inheriting from BrowseEverything::Driver::Base
         def inherited(subclass)
           subclass.sorter = sorter
+          super
         end
       end
 

data/lib/browse_everything/driver/dropbox.rb

@@ -124,11 +124,14 @@ module BrowseEverything
       end
 
       def auth_link(url_options)
-        authenticator.authorize_url redirect_uri: redirect_uri(url_options)
+        authenticator.auth_code.authorize_url redirect_uri: redirect_uri(url_options)
       end
 
       def connect(params, _data, url_options)
-        auth_bearer = authenticator.get_token params[:code], redirect_uri: redirect_uri(url_options)
+        built_redirect_uri = redirect_uri(url_options)
+        token_code = params[:code]
+
+        auth_bearer = authenticator.auth_code.get_token(token_code, redirect_uri: built_redirect_uri)
         self.token = auth_bearer.token
       end
 

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,6 +59,15 @@ module BrowseEverything
 
       private
 
+      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
+
       # Construct an array of FileEntry objects for the contents of a
       # directory
       # @param real_path [String] path to the file system directory
@@ -65,7 +78,7 @@ module BrowseEverything
       end
 
       def make_pathname(path)
-        Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(config[:home]))
+        Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(home_path))
       end
 
       def file_size(path)

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/version.rb

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

data/spec/{support → dummy_test_app}/app/views/file_handler/main.html.erb

@@ -14,9 +14,12 @@
 
   <script>
     $(document).on('turbolinks:load', function() {
-      $('#browse-btn').browseEverything()
-        .done(function(data) { $('#status').html(data.length.toString() + " items selected") })
-        .cancel(function()   { window.alert('Canceled!') });
+      // Have to make sure onReady is ALSO passed, in case it's first load.
+      $(function() {
+        $('#browse-btn').browseEverything()
+          .done(function(data) { $('#status').html(data.length.toString() + " items selected") })
+          .cancel(function()   { window.alert('Canceled!') });
+      });
     });
   </script>
 </div>

data/spec/dummy_test_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy_test_app/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy_test_app/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy_test_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy_test_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy_test_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy_test_app/bin/setup

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy_test_app/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy_test_app/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+VENDOR_PATH = File.expand_path('..', __dir__)
+Dir.chdir(VENDOR_PATH) do
+  begin
+    exec "yarnpkg #{ARGV.join(" ")}"
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/spec/dummy_test_app/config/application.rb

@@ -0,0 +1,27 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "browse_everything"
+
+# Since we don't actually have an app-specific Gemfile,
+# Some development dependencies listed in .gemspec need to be required here,
+# that would ordinarily be auto-required by being in a Gemfile instead of gemspec.
+require 'bootstrap'
+require 'sprockets/railtie'
+require 'jquery-rails'
+require 'turbolinks'
+
+module Dummy
+  class Application < Rails::Application
+    # ~Initialize configuration defaults for originally generated Rails version.~
+    # Changed to: For currently running Rails version, eg 5.2 or 7.0:
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end
+

data/spec/dummy_test_app/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy_test_app/config/browse_everything_providers.yml

@@ -0,0 +1,25 @@
+#
+# 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.
+#
+file_system:
+  allow_relative_home: true
+  home: ./
+# 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
+#   expires_in: 14400 # for signed_url response_type, number of seconds url will be valid for.
+#   app_key: YOUR_AWS_S3_KEY       # :app_key, :app_secret, and :region can be specified
+#   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/

data/spec/dummy_test_app/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1
+  channel_prefix: dummy_production

data/spec/dummy_test_app/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy_test_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy_test_app/config/environments/development.rb

@@ -0,0 +1,54 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.seconds.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end