browse-everything 0.15.1 → 0.16.0

data/spec/lib/browse_everything_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+describe BrowseEverything do
+  describe '.configure' do
+
+    let(:config) do
+      {
+        dropbox: {
+          app_key: 'test-key',
+          app_secret: 'test-secret'
+        },
+        box: {
+          client_id: 'test-id',
+          client_secret: 'test-secret'
+        },
+        google_drive: {
+          client_id: 'test-id',
+          client_secret: 'test-secret'
+        }
+      }
+    end
+    before do
+      BrowseEverything.configure(config)
+    end
+    it 'registers the configuration for the drivers' do
+      expect(BrowseEverything.config).to be_a ActiveSupport::HashWithIndifferentAccess
+
+      expect(BrowseEverything.config).to include 'dropbox'
+      expect(BrowseEverything.config['dropbox']).to include({ 'app_key' => 'test-key' })
+      expect(BrowseEverything.config['dropbox']).to include({ 'app_secret' => 'test-secret' })
+
+      expect(BrowseEverything.config).to include 'box'
+      expect(BrowseEverything.config['box']).to include({ 'client_id' => 'test-id' })
+      expect(BrowseEverything.config['box']).to include({ 'client_secret' => 'test-secret' })
+
+      expect(BrowseEverything.config).to include 'google_drive'
+      expect(BrowseEverything.config['google_drive']).to include({ 'client_id' => 'test-id' })
+      expect(BrowseEverything.config['google_drive']).to include({ 'client_secret' => 'test-secret' })
+    end
+
+    context 'with an entry for the drop_box provider' do
+      let(:config) do
+        {
+          drop_box: {
+            app_key: 'test-key',
+            app_secret: 'test-secret'
+          }
+        }
+      end
+
+      it 'logs a deprecation warning and sets it to the dropbox key' do
+        expect(BrowseEverything.config).not_to include 'drop_box'
+        expect(BrowseEverything.config).to include 'dropbox'
+        expect(BrowseEverything.config['dropbox']).to include({ 'app_key' => 'test-key' })
+        expect(BrowseEverything.config['dropbox']).to include({ 'app_secret' => 'test-secret' })
+      end
+    end
+  end
+
+  context 'with an unsupported or invalid configuration' do
+    let(:config) { 1234 }
+
+    it 'raises an initialization error' do
+      expect { BrowseEverything.configure(config) }.to raise_error(BrowseEverything::InitializationError, 'Unrecognized configuration: 1234')
+    end
+  end
+end

data/spec/services/browse_everything_session/provider_session_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+describe BrowseEverythingSession::ProviderSession do
+  subject(:provider_session) { described_class.new(session: session, name: name) }
+
+  let(:session) { instance_double(ActionDispatch::Request::Session) }
+  let(:name) { 'test_session' }
+
+  describe '.for' do
+    it 'provides a new session object' do
+      expect(described_class.for(session: session, name: name)).to be_a described_class
+    end
+  end
+
+  describe '.token' do
+    before do
+      allow(session).to receive(:[]=)
+      allow(session).to receive(:[]).and_return('test-token')
+      provider_session.token = 'test-token'
+    end
+    it 'sets and accesses the access token' do
+      expect(provider_session.token).to eq 'test-token'
+      expect(session).to have_received(:[]).with('test_session_token')
+    end
+  end
+
+  describe '.code' do
+    before do
+      allow(session).to receive(:[]=)
+      allow(session).to receive(:[]).and_return('test-code')
+      provider_session.code = 'test-code'
+    end
+    it 'sets and accesses the access code' do
+      expect(provider_session.code).to eq 'test-code'
+      expect(session).to have_received(:[]).with('test_session_code')
+    end
+  end
+
+  describe '.data' do
+    before do
+      allow(session).to receive(:[]=)
+      allow(session).to receive(:[]).and_return('test' => 'data')
+      provider_session.data = { 'test' => 'data' }
+    end
+    it 'sets and accesses the access data' do
+      expect(provider_session.data).to eq('test' => 'data')
+      expect(session).to have_received(:[]).with('test_session_data')
+    end
+  end
+end

data/spec/services/browser_factory_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+include BrowserConfigHelper
+
+describe BrowserFactory do
+  subject(:browser_factory) { described_class.new }
+
+  let(:session) { instance_double(BrowseEverythingSession::ProviderSession) }
+  let(:provider_session_class) { class_double(BrowseEverythingSession::ProviderSession).as_stubbed_const(transfer_nested_constants: true) }
+  let(:provider_session) { instance_double(BrowseEverythingSession::ProviderSession) }
+  let(:provider) { instance_double(BrowseEverything::Driver::Base) }
+  let(:browser_class) { class_double(BrowseEverything::Browser).as_stubbed_const(transfer_nested_constants: true) }
+  let(:browser) { instance_double(BrowseEverything::Browser) }
+
+  before do
+    allow(provider).to receive(:key).and_return('test-provider')
+    allow(provider).to receive(:token=)
+    allow(browser).to receive(:providers).and_return('test-provider' => provider)
+    allow(browser_class).to receive(:new).and_return(browser)
+    allow(provider_session).to receive(:token).and_return('test-token')
+    allow(provider_session_class).to receive(:for).and_return(provider_session)
+  end
+
+  describe '.for' do
+    it 'retrieves a driver by name' do
+      expect(described_class.for(name: 'test-provider')).to eq provider
+    end
+  end
+
+  describe '.build' do
+    before do
+      described_class.build(session: session, url_options: url_options)
+    end
+
+    it 'initializes a Browser Object and provides it with a sessionized access token' do
+      expect(browser_class).to have_received(:new).with(url_options)
+      expect(provider_session_class).to have_received(:for).with(session: session, name: 'test-provider'.to_sym)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,22 +1,46 @@
+# frozen_string_literal: true
+ENV["RAILS_ENV"] ||= 'test'
+require "bundler/setup"
+
+def coverage_needed?
+  ENV['COVERAGE'] || ENV['TRAVIS']
+end
+
+if coverage_needed?
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.root(File.expand_path('../..', __FILE__))
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+    [
+      SimpleCov::Formatter::HTMLFormatter,
+      Coveralls::SimpleCov::Formatter
+    ]
+  )
+  SimpleCov.start('rails') do
+    add_filter '/.internal_test_app'
+    add_filter '/lib/browse_everything/engine.rb'
+    add_filter '/lib/browse_everything/version.rb'
+    add_filter '/lib/generators'
+    add_filter '/spec'
+    add_filter '/tasks'
+  end
+end
+
 require 'engine_cart'
 require File.expand_path('config/environment', EngineCart.destination)
+EngineCart.load_application!
+
+require 'capybara/rails'
+require 'capybara/rspec'
 require 'rspec'
 require 'rspec/rails'
 require 'rspec/its'
-require 'webmock/rspec'
-require 'simplecov'
 require 'vcr'
-require 'capybara/rails'
-require 'capybara/rspec'
-require 'support/rake'
-require 'coveralls'
-
-Coveralls.wear!
-EngineCart.load_application!
+require 'webmock/rspec'
 
-SimpleCov.start do
-  add_filter '/spec/'
-end
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Pathname.new(File.expand_path('support/**/*.rb', __dir__))].each { |f| require f }
 
 VCR.configure do |c|
   c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
@@ -25,14 +49,11 @@ VCR.configure do |c|
   c.ignore_localhost = true
 end
 
-Capybara.default_driver = :rack_test      # This is a faster driver
-Capybara.javascript_driver = :poltergeist # This is slower
-Capybara.default_max_wait_time = ENV['TRAVIS'] ? 30 : 15
-
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
-    c.syntax = [:should, :expect]
+    c.syntax = %i[should expect]
   end
+  config.include WaitForAjax, type: :feature
 end
 
 module BrowserConfigHelper
@@ -46,7 +67,7 @@ module BrowserConfigHelper
 
   def stub_configuration
     BrowseEverything.configure('file_system' => {
-                                 home: File.expand_path('../fixtures/file_system', __FILE__)
+                                 home: File.expand_path('fixtures/file_system', __dir__)
                                },
                                'box' => {
                                  client_id: 'BoxClientId',

data/spec/support/app/controllers/file_handler_controller.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 class FileHandlerController < ApplicationController
-  def index
-  end
+  def index; end
 
-  def main
-  end
+  def main; end
 
   def update
     render json: params[:selected_files].to_json

data/spec/support/app/views/file_handler/main.html.erb

@@ -6,7 +6,7 @@
   <%= form_tag('/file', id: 'main_form', method: 'post') do %>
     <%= button_tag("Browse", type: 'button', class: 'btn btn-large btn-success', id: "browse-btn",
       'data-toggle' => 'browse-everything', 'data-route' => browse_everything_engine.root_path,
-      'data-target' => '#main_form' ) %>
+      'data-target' => '#main_form') %>
     <%= button_tag("Submit", type: 'submit', class: 'btn btn-large btn-primary', id: "submit-btn") %>
   <% end %>
 

data/spec/support/capybara.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'selenium-webdriver'
+
+Capybara.javascript_driver = :headless_chrome
+
+Capybara.register_driver :headless_chrome do |app|
+  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
+    chromeOptions: { args: %w[headless disable-gpu no-sandbox] }
+  )
+
+  Capybara::Selenium::Driver.new(app,
+                                 browser: :chrome,
+                                 desired_capabilities: capabilities)
+end
+
+Capybara.default_max_wait_time = 5

data/spec/support/rake.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 
 module RakeHelper
@@ -29,7 +31,7 @@ module RakeHelper
     rescue SystemExit => e
       puts "error = #{e.inspect}"
     end
-    return "Output: #{out.string}\n Errors:#{err.string}"
+    "Output: #{out.string}\n Errors:#{err.string}"
   ensure
     $stdout = STDOUT
     $stdout = STDERR

data/spec/support/wait_for_ajax.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WaitForAjax
+  def wait_for_ajax
+    Timeout.timeout(Capybara.default_max_wait_time) do
+      loop until finished_all_ajax_requests?
+    end
+    sleep 1
+  end
+
+  def finished_all_ajax_requests?
+    page.evaluate_script('jQuery.active').zero?
+  end
+end

data/spec/test_app_templates/Gemfile.extra

@@ -1 +1,2 @@
 gem 'jquery-rails'
+gem 'puma-rails'

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base
-  source_root File.expand_path('../../../../spec/support', __FILE__)
+  source_root File.expand_path('../../../../spec/test_app_templates/', __FILE__)
+
+  def install_engine
+    generate 'browse_everything:install -f'
+  end
 
   def run_config_generator
     generate 'browse_everything:config'
@@ -42,8 +48,8 @@ class TestAppGenerator < Rails::Generators::Base
   end
 
   def create_test_route
-    copy_file 'app/controllers/file_handler_controller.rb', 'app/controllers/file_handler_controller.rb'
-    copy_file 'app/views/file_handler/main.html.erb', 'app/views/file_handler/main.html.erb'
-    copy_file 'app/views/file_handler/index.html.erb', 'app/views/file_handler/index.html.erb'
+    copy_file '../support/app/controllers/file_handler_controller.rb', 'app/controllers/file_handler_controller.rb'
+    copy_file '../support/app/views/file_handler/main.html.erb', 'app/views/file_handler/main.html.erb'
+    copy_file '../support/app/views/file_handler/index.html.erb', 'app/views/file_handler/index.html.erb'
   end
 end

data/spec/views/browse_everything/{_file.html.erb_spec.rb → _files.html.erb_spec.rb}

@@ -1,17 +1,20 @@
-describe 'browse_everything/_file.html.erb', type: :view do
+# frozen_string_literal: true
+
+describe 'browse_everything/_files.html.erb', type: :view do
   let(:file) do
     BrowseEverything::FileEntry.new(
       'file_id_01234', 'my_provider:/location/pa/th/file.m4v',
-      'file.m4v', 1024 * 1024 * 1024, Time.now, false
+      'file.m4v', 1024 * 1024 * 1024, Time.current, false
     )
   end
   let(:container) do
     BrowseEverything::FileEntry.new(
       'dir_id_01234', 'my_provider:/location/pa/th/dir',
-      'dir', 0, Time.now, true
+      'dir', 0, Time.current, true
     )
   end
-  let(:provider) { double('provider') }
+
+  let(:provider) { instance_double(BrowseEverything::Driver::Base) }
   let(:page) { Capybara::Node::Simple.new(rendered) }
 
   before do
@@ -21,15 +24,21 @@ describe 'browse_everything/_file.html.erb', type: :view do
     allow(view).to receive(:parent).and_return('parent')
     allow(view).to receive(:provider_name).and_return('my provider')
     allow(provider).to receive(:config).and_return(config)
+
+    allow(view).to receive(:provider_contents).and_return provider_contents
   end
 
   describe 'a file' do
+    let(:config) { {} }
+    let(:provider_contents) { [file] }
+
     before do
       allow(view).to receive(:file).and_return(file)
       render
     end
-    context 'file not too big' do
+    context 'when a file is not too big' do
       let(:config) { { max_upload_file_size: (5 * 1024 * 1024 * 1024) } }
+
       it 'draws link' do
         expect(page).to have_selector('a.ev-link')
       end
@@ -39,38 +48,35 @@ describe 'browse_everything/_file.html.erb', type: :view do
       end
     end
 
-    context 'max not configured' do
-      let(:config) { {} }
+    context 'when a maximum file size is not configured' do
       it 'draws link' do
         expect(page).to have_selector('a.ev-link')
       end
     end
 
-    context 'file too big' do
+    context 'when a file is too big' do
       let(:config) { { max_upload_file_size: 1024 } }
+
       it 'draws link' do
         expect(page).not_to have_selector('a.ev-link')
       end
     end
 
-    context 'multi-select' do
-      let(:config) { {} }
-      it 'does not have a checkbox' do
-        expect(page).not_to have_selector('input.ev-select-all')
-      end
+    it 'does not have a checkbox' do
+      expect(page).not_to have_selector('input.ev-select-all')
     end
   end
 
   describe 'a directory' do
+    let(:provider_contents) { [container] }
+
     before do
       allow(view).to receive(:file).and_return(container)
       render
     end
-    context 'multi-select' do
-      let(:config) { {} }
-      it 'has the select-all checkbox' do
-        expect(page).to have_selector('input.ev-select-all')
-      end
+
+    it 'has the select-all checkbox' do
+      expect(page).to have_selector('input.ev-select-all')
     end
   end
 end