browse-everything 0.15.1 → 0.16.0

data/spec/javascripts/jasmine_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 
 # Run the jasmine tests by running the jasmine:ci rake command and parses the output for failures.

data/spec/javascripts/support/jasmine_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Use this file to set/override Jasmine configuration options
 # You can remove it if you don't need it.
 # This file is loaded *after* jasmine.yml is interpreted.

data/spec/lib/browse_everything/auth/google/credentials_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+describe BrowseEverything::Auth::Google::Credentials do
+  subject(:credentials) { described_class.new }
+
+  describe '#fetch_access_token' do
+    let(:response) { double }
+    before do
+      WebMock.disable!
+
+      allow(response).to receive(:status_code).and_return('200')
+      allow(response).to receive(:body).and_return('{}')
+      allow(response).to receive(:header).and_return({ content_type: 'application/json' })
+
+      connection = instance_double(Faraday::Connection)
+      allow(connection).to receive(:post).and_return(response)
+      faraday = class_double('Faraday').as_stubbed_const(transfer_nested_constants: true)
+      allow(faraday).to receive(:default_connection).and_return(connection)
+
+    end
+
+    context 'when an access has already been retrieved' do
+      before do
+        credentials.access_token = 'test-token'
+      end
+      it 'generates a Hash if an access token has already been set' do
+        expect(credentials.fetch_access_token).to be_a Hash
+        expect(credentials.fetch_access_token).to include('access_token' => 'test-token')
+      end
+    end
+
+    it 'requests a new token from the OAuth provider' do
+      expect(credentials.fetch_access_token).to be_a Hash
+      expect(credentials.fetch_access_token).to eq({})
+    end
+
+    after do
+      WebMock.enable!
+    end
+  end
+end

data/spec/{unit → lib/browse_everything}/browse_everything_helper_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe BrowseEverythingHelper do
   let(:test_class) do
     Class.new do

data/spec/lib/browse_everything/browser_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+include BrowserConfigHelper
+
+describe BrowseEverything::Browser do
+  let(:file_config) do
+    "file_system:\n  home: '/file/config/home'\ndropbox:\n  client_id: 'DropboxId'\n  client_secret: 'DropboxClientSecret'"
+  end
+
+  let(:global_config) do
+    {
+      file_system: {
+        home: '/global/config/home'
+      },
+      dropbox: {
+        client_id: 'DropboxId',
+        client_secret: 'DropboxClientSecret'
+      }
+    }
+  end
+
+  let(:local_config) do
+    {
+      file_system: {
+        home: '/local/config/home'
+      },
+      dropbox: {
+        client_id: 'DropboxId',
+        client_secret: 'DropboxClientSecret'
+      },
+      url_options: url_options
+    }
+  end
+
+  describe 'file config' do
+    let(:browser) { described_class.new(url_options) }
+
+    before do
+      BrowseEverything.config = nil
+      allow(File).to receive(:read).and_return file_config
+    end
+
+    it 'has 2 providers' do
+      expect(browser.providers.keys).to eq(%w[file_system dropbox])
+      expect(browser.providers[:file_system]).to be_a BrowseEverything::Driver::FileSystem
+      expect(browser.providers[:dropbox]).to be_a BrowseEverything::Driver::Dropbox
+    end
+
+    it 'uses the file configuration' do
+      expect(browser.providers[:file_system].config[:home]).to eq('/file/config/home')
+      expect(browser.providers['file_system'].config['home']).to eq('/file/config/home')
+    end
+  end
+
+  describe 'global config' do
+    let(:browser) { described_class.new(url_options) }
+
+    before { BrowseEverything.configure(global_config) }
+
+    it 'has 2 providers' do
+      expect(browser.providers.keys).to eq(%w[file_system dropbox])
+      expect(browser.providers[:file_system]).to be_a BrowseEverything::Driver::FileSystem
+      expect(browser.providers[:dropbox]).to be_a BrowseEverything::Driver::Dropbox
+    end
+
+    it 'uses the global configuration' do
+      expect(browser.providers[:file_system].config[:home]).to eq('/global/config/home')
+      expect(browser.providers['file_system'].config['home']).to eq('/global/config/home')
+    end
+  end
+
+  describe 'local config' do
+    let(:browser) { described_class.new(local_config) }
+
+    it 'has 2 providers' do
+      expect(browser.providers.keys).to eq(%w[file_system dropbox])
+      expect(browser.providers[:file_system]).to be_a BrowseEverything::Driver::FileSystem
+      expect(browser.providers[:dropbox]).to be_a BrowseEverything::Driver::Dropbox
+    end
+
+    it 'uses the local configuration' do
+      file_provider = browser.providers[:file_system]
+      expect(file_provider.config[:home]).to eq('/local/config/home')
+      expect(file_provider.config['home']).to eq('/local/config/home')
+    end
+  end
+
+  context 'with an unknown provider' do
+    let(:browser) do
+      described_class.new(foo: { key: 'bar', secret: 'baz' }, url_options: url_options)
+    end
+
+    before do
+      allow(Rails.logger).to receive(:warn)
+    end
+
+    it 'logs a warning' do
+      browser
+      expect(Rails.logger).to have_received(:warn).with('Unknown provider: foo')
+    end
+  end
+
+  describe '#first_provider' do
+    subject(:browser) { described_class.new(url_options) }
+    it 'retrieves the first configured provider' do
+      expect(browser.first_provider).to be_a BrowseEverything::Driver::FileSystem
+    end
+  end
+end

data/spec/{unit → lib/browse_everything/driver}/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 include BrowserConfigHelper
 
 describe BrowseEverything::Driver::Base do
@@ -14,18 +16,17 @@ describe BrowseEverything::Driver::Base do
   end
   describe '#connect' do
     subject { driver.connect({}, {}) }
+
     it { is_expected.to be_blank }
   end
   describe '#contents' do
     subject { driver.contents('') }
+
     it { is_expected.to be_empty }
   end
-  describe '#details' do
-    subject { driver.details('/path/to/foo.txt') }
-    it { is_expected.to be_nil }
-  end
   describe '#link_for' do
     subject { driver.link_for('/path/to/foo.txt') }
+
     it { is_expected.to contain_exactly('/path/to/foo.txt', file_name: 'foo.txt') }
   end
 end

data/spec/{unit → lib/browse_everything/driver}/box_spec.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 include BrowserConfigHelper
 
 describe BrowseEverything::Driver::Box, vcr: { cassette_name: 'box', record: :none } do
-  before(:all)  { stub_configuration   }
-  after(:all)   { unstub_configuration }
-
   let(:browser) { BrowseEverything::Browser.new(url_options) }
   let(:provider) { browser.providers['box'] }
   let(:auth_params) do
@@ -33,7 +32,15 @@ describe BrowseEverything::Driver::Box, vcr: { cassette_name: 'box', record: :no
     }
   end
 
-  subject    { provider }
+  subject { provider }
+
+  before do
+    stub_configuration
+  end
+
+  after do
+    unstub_configuration
+  end
 
   its(:name) { is_expected.to eq('Box') }
   its(:key)  { is_expected.to eq('box') }
@@ -55,6 +62,7 @@ describe BrowseEverything::Driver::Box, vcr: { cassette_name: 'box', record: :no
 
   describe '#authorized?' do
     subject { provider.authorized? }
+
     context 'when the access token is not registered' do
       it { is_expected.to be(false) }
     end
@@ -73,9 +81,13 @@ describe BrowseEverything::Driver::Box, vcr: { cassette_name: 'box', record: :no
   end
 
   describe '#connect' do
+    before do
+      allow(provider).to receive(:register_access_token)
+    end
+
     it 'registers new tokens' do
-      expect(provider).to receive(:register_access_token).with(kind_of(OAuth2::AccessToken))
       provider.connect(auth_params, 'data')
+      expect(provider).to have_received(:register_access_token).with(kind_of(OAuth2::AccessToken))
     end
   end
 
@@ -90,6 +102,7 @@ describe BrowseEverything::Driver::Box, vcr: { cassette_name: 'box', record: :no
 
       describe 'the first item' do
         subject { long_file }
+
         its(:name)     { is_expected.to start_with('A very looooooooooooong box folder') }
         its(:location) { is_expected.to eq('box:20375782799') }
         it             { is_expected.to be_container }
@@ -97,6 +110,7 @@ describe BrowseEverything::Driver::Box, vcr: { cassette_name: 'box', record: :no
 
       describe 'the SaS - Development Team directory' do
         subject { sas_directory }
+
         its(:name)     { is_expected.to eq('SaS - Development Team') }
         its(:location) { is_expected.to eq('box:2459961273') }
         its(:id)       { is_expected.to eq('2459961273') }
@@ -105,6 +119,7 @@ describe BrowseEverything::Driver::Box, vcr: { cassette_name: 'box', record: :no
 
       describe 'a file' do
         subject { tar_file }
+
         its(:name)     { is_expected.to eq('failed.tar.gz') }
         its(:size)     { is_expected.to eq(28_650_839) }
         its(:location) { is_expected.to eq('box:25581309763') }

data/spec/{unit → lib/browse_everything/driver}/dropbox_spec.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 include BrowserConfigHelper
 
 describe BrowseEverything::Driver::Dropbox, vcr: { cassette_name: 'dropbox', record: :none } do
-  before(:all)  { stub_configuration   }
-  after(:all)   { unstub_configuration }
-
   let(:browser) { BrowseEverything::Browser.new(url_options) }
   let(:provider) { browser.providers['dropbox'] }
   let(:provider_yml) do
@@ -13,6 +12,14 @@ describe BrowseEverything::Driver::Dropbox, vcr: { cassette_name: 'dropbox', rec
     }
   end
 
+  before do
+    stub_configuration
+  end
+
+  after do
+    unstub_configuration
+  end
+
   describe '#validate_config' do
     it 'raises and error with an incomplete configuration' do
       expect { BrowseEverything::Driver::Dropbox.new({}) }.to raise_error(BrowseEverything::InitializationError)
@@ -25,6 +32,7 @@ describe BrowseEverything::Driver::Dropbox, vcr: { cassette_name: 'dropbox', rec
 
   describe 'simple properties' do
     subject    { provider }
+
     its(:name) { is_expected.to eq('Dropbox') }
     its(:key)  { is_expected.to eq('dropbox') }
     its(:icon) { is_expected.to be_a(String) }
@@ -32,20 +40,23 @@ describe BrowseEverything::Driver::Dropbox, vcr: { cassette_name: 'dropbox', rec
 
   context 'with a valid configuration' do
     let(:driver) { described_class.new(provider_yml) }
+
     before { driver.connect({ code: 'code' }, {}) }
 
     describe '#auth_link' do
       subject { driver.auth_link }
+
       it { is_expected.to start_with('https://www.dropbox.com/oauth2/authorize') }
     end
 
     describe '#authorized?' do
       subject { driver }
+
       it { is_expected.to be_authorized }
     end
 
     describe '#contents' do
-      context 'within the root folder' do
+      context 'when in the root folder' do
         let(:contents) { driver.contents }
 
         it 'retrieves all folders the root folders' do
@@ -62,20 +73,6 @@ describe BrowseEverything::Driver::Dropbox, vcr: { cassette_name: 'dropbox', rec
       end
     end
 
-    describe '#details' do
-      subject(:file_metadata) { driver.details('/Getting Started.pdf') }
-
-      it 'retrieves the metadata for a file' do
-        expect(file_metadata).to be_a BrowseEverything::FileEntry
-        expect(file_metadata.id).to eq '/Getting Started.pdf'
-        expect(file_metadata.location).to eq 'dropbox:/Getting Started.pdf'
-        expect(file_metadata.name).to eq 'Getting Started.pdf'
-        expect(file_metadata.size).to eq 249159
-        expect(file_metadata.mtime).to be_a Time
-        expect(file_metadata.container?).to eq false
-      end
-    end
-
     describe '#link_for' do
       subject(:link_args) { driver.link_for('/Getting Started.pdf') }
 

data/spec/{unit → lib/browse_everything/driver}/file_system_spec.rb

@@ -1,18 +1,27 @@
+# frozen_string_literal: true
+
 include BrowserConfigHelper
 
 describe BrowseEverything::Driver::FileSystem do
-  before(:all)  { stub_configuration   }
-  after(:all)   { unstub_configuration }
   let(:home)    { File.expand_path(BrowseEverything.config['file_system'][:home]) }
   let(:browser) { BrowseEverything::Browser.new(url_options) }
   let(:provider) { browser.providers['file_system'] }
 
+  before do
+    stub_configuration
+  end
+
+  after do
+    unstub_configuration
+  end
+
   it '#validate_config' do
     expect { described_class.new({}) }.to raise_error(BrowseEverything::InitializationError)
   end
 
   describe 'simple properties' do
     subject    { provider                }
+
     its(:name) { is_expected.to eq('File System') }
     its(:key)  { is_expected.to eq('file_system') }
     its(:icon) { is_expected.to be_a(String)     }
@@ -20,50 +29,44 @@ describe BrowseEverything::Driver::FileSystem do
   end
 
   describe '#contents' do
-    context 'root directory' do
+    context 'when in a root directory' do
       let(:contents) { provider.contents('/') }
-      context '[0]' do
+
+      context 'when there is one directory' do
         subject { contents[0] }
+
         its(:name) { is_expected.to eq('dir_1') }
         specify    { is_expected.to be_container }
       end
-      context '[1]' do
+      context 'when there are multiple directories' do
         subject { contents[1] }
+
         its(:name) { is_expected.to eq('dir_2') }
         specify    { is_expected.to be_container }
       end
-      context '[2]' do
+      context 'when there is a PDF' do
         subject { contents[2] }
+
         its(:name)     { is_expected.to eq('file 1.pdf')              }
         its(:size)     { is_expected.to eq(2256)                      }
         its(:location) { is_expected.to eq("file_system:#{File.join(home, 'file 1.pdf')}") }
         its(:type)     { is_expected.to eq('application/pdf') }
         specify        { is_expected.not_to be_container }
       end
-      context '[3]' do
-        subject { contents[3] }
-        its(:name)     { is_expected.to eq('file_1.pdf')              }
-        its(:size)     { is_expected.to eq(2256)                      }
-        its(:location) { is_expected.to eq("file_system:#{File.join(home, 'file_1.pdf')}") }
-        its(:type)     { is_expected.to eq('application/pdf') }
-        specify        { is_expected.not_to be_container }
-      end
     end
 
-    context 'subdirectory' do
+    context 'when there is a subdirectory' do
       let(:contents) { provider.contents('/dir_1') }
-      context '[0]' do
-        subject { contents[0] }
-        its(:name) { is_expected.to eq('..') }
-        specify    { is_expected.to be_container }
-      end
-      context '[1]' do
-        subject { contents[1] }
+
+      context 'when there is a directory' do
+        subject { contents.first }
+
         its(:name) { is_expected.to eq('dir_3') }
         specify    { is_expected.to be_container }
       end
-      context '[2]' do
-        subject { contents[2] }
+      context 'when there is a text file' do
+        subject { contents.last }
+
         its(:name)     { is_expected.to eq('file_2.txt') }
         its(:location) { is_expected.to eq("file_system:#{File.join(home, 'dir_1/file_2.txt')}") }
         its(:type)     { is_expected.to eq('text/plain') }
@@ -71,10 +74,12 @@ describe BrowseEverything::Driver::FileSystem do
       end
     end
 
-    context 'single file' do
+    context 'when there is a single file' do
       let(:contents) { provider.contents('/dir_1/dir_3/file_3.m4v') }
-      context '[0]' do
+
+      context 'when there is a m4v file' do
         subject { contents[0] }
+
         its(:name)     { is_expected.to eq('file_3.m4v') }
         its(:location) { is_expected.to eq("file_system:#{File.join(home, 'dir_1/dir_3/file_3.m4v')}") }
         its(:size)     { is_expected.to eq(3879)              }
@@ -86,6 +91,7 @@ describe BrowseEverything::Driver::FileSystem do
 
   describe "#link_for('/path/to/file')" do
     subject { provider.link_for('/path/to/file') }
+
     it { is_expected.to eq(['file:///path/to/file', { file_name: 'file', file_size: 0 }]) }
   end
 end