browse-everything 0.12.0 → 0.13.0

data/spec/unit/box_spec.rb

@@ -0,0 +1,168 @@
+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
+    {
+      'code' => 'CODE',
+      'state' => 'box'
+    }
+  end
+
+  # To re-record the VCR responses, you will need to substitute the 'token' and 'refresh_token' values with the
+  # actual tokens returned from Box.
+  #
+  # The easiest way to do this is output @token to the Rails log from the box_client method:
+  #
+  #   def box_client
+  #     Rails.logger.info(@token)
+  #     [...]
+  #
+  # Make sure you have the internal_test_app built and have copied your client id and secret to the yaml config file.
+  # With the test app running, you can authenticate to your Box account to browse files, and should see the
+  # tokens listed in the Rails log. Once you have copied the new tokens, the spec test will run and use your tokens
+  # to authenticate to Box. To record the new responses replace `record: :none` with `record: :all`.
+  let(:token) do
+    {
+      'token' => 'TOKEN',
+      'refresh_token' => 'REFRESH_TOKEN'
+    }
+  end
+
+  subject    { provider }
+
+  its(:name) { is_expected.to eq('Box') }
+  its(:key)  { is_expected.to eq('box') }
+  its(:icon) { is_expected.to be_a(String) }
+
+  describe '#validate_config' do
+    it 'raises and error with an incomplete configuration' do
+      expect { BrowseEverything::Driver::Box.new({}) }.to raise_error(BrowseEverything::InitializationError)
+    end
+  end
+
+  describe '#auth_link' do
+    subject { provider.auth_link }
+
+    it { is_expected.to start_with('https://www.box.com/api/oauth2/authorize') }
+    it { is_expected.to include('browse%2Fconnect') }
+    it { is_expected.to include('response_type') }
+  end
+
+  describe '#authorized?' do
+    subject { provider.authorized? }
+    context 'when the access token is not registered' do
+      it { is_expected.to be(false) }
+    end
+    context 'when the access tokens are registered and not expired' do
+      before { provider.token = token.merge('expires_at' => Time.now.to_i + 360) }
+      it { is_expected.to be(true) }
+    end
+    context 'when the access tokens are registered but no expiration time' do
+      before { provider.token = token }
+      it { is_expected.to be(false) }
+    end
+    context 'when the access tokens are registered but expired' do
+      before { provider.token = token.merge('expires_at' => Time.now.to_i - 360) }
+      it { is_expected.to be(false) }
+    end
+  end
+
+  describe '#connect' do
+    it 'registers new tokens' do
+      expect(provider).to receive(:register_access_token).with(kind_of(OAuth2::AccessToken))
+      provider.connect(auth_params, 'data')
+    end
+  end
+
+  describe '#contents' do
+    before { provider.token = token }
+
+    context 'with files and folders in the root directory' do
+      let(:root_directory) { provider.contents('') }
+      let(:long_file)      { root_directory[0] }
+      let(:sas_directory)  { root_directory[6] }
+      let(:tar_file)       { root_directory[10] }
+
+      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 }
+      end
+
+      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') }
+        it             { is_expected.to be_container }
+      end
+
+      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') }
+        its(:type)     { is_expected.to eq('application/x-gzip') }
+        its(:id)       { is_expected.to eq('25581309763') }
+        it             { is_expected.not_to be_container }
+      end
+    end
+
+    context 'with files and folders in the SaS - Development Team directory' do
+      let(:sas_directory)    { provider.contents('2459961273') }
+      let(:parent_directory) { sas_directory[0] }
+      let(:apps_dir)         { sas_directory[1] }
+      let(:equipment)        { sas_directory[12] }
+
+      describe 'the first item' do
+        subject { parent_directory }
+
+        its(:name)     { is_expected.to eq('..') }
+        its(:location) { is_expected.to be_empty }
+        its(:id)       { is_expected.to be_kind_of(Pathname) }
+        it             { is_expected.to be_container }
+      end
+      describe 'the second item' do
+        subject { apps_dir }
+
+        its(:name)     { is_expected.to eq('Apps&Int') }
+        its(:id)       { is_expected.to eq('2459974427') }
+        it             { is_expected.to be_container }
+      end
+      describe 'a file' do
+        subject { equipment }
+
+        its(:name)     { is_expected.to eq('Equipment.boxnote') }
+        its(:size)     { is_expected.to eq(10140) }
+        its(:location) { is_expected.to eq('box:76960974625') }
+        its(:type)     { is_expected.to eq('application/octet-stream') }
+        its(:id)       { is_expected.to eq('76960974625') }
+        it             { is_expected.not_to be_container }
+      end
+    end
+  end
+
+  describe '#link_for' do
+    before { provider.token = token }
+
+    context 'with a file from the root directory' do
+      let(:link) { provider.link_for('25581309763') }
+
+      specify { expect(link[0]).to start_with('https://dl.boxcloud.com/d/1') }
+      specify { expect(link[1]).to have_key(:expires) }
+    end
+
+    context 'with a file from the SaS - Development Team directory' do
+      let(:link) { provider.link_for('76960974625') }
+
+      specify { expect(link[0]).to start_with('https://dl.boxcloud.com/d/1') }
+      specify { expect(link[1]).to have_key(:expires) }
+    end
+  end
+end

data/spec/unit/s3_spec.rb

@@ -1,13 +1,43 @@
 include BrowserConfigHelper
 
 describe BrowseEverything::Driver::FileSystem do
-  before(:all)  { stub_configuration   }
-  after(:all)   { unstub_configuration }
-  let(:browser) { BrowseEverything::Browser.new(url_options) }
+  before(:all)   { stub_configuration   }
+  after(:all)    { unstub_configuration }
+  let(:browser)  { BrowseEverything::Browser.new(url_options) }
   let(:provider) { browser.providers['s3'] }
+  subject        { provider }
 
-  it '#validate_config' do
-    expect { BrowseEverything::Driver::S3.new({}) }.to raise_error(BrowseEverything::InitializationError)
+  describe 'defaults' do
+    its(:icon)   { is_expected.to eq('amazon')  }
+    its(:itself) { is_expected.to be_authorized }
+  end
+
+  describe 'configuration' do
+    it '#validate_config' do
+      expect { BrowseEverything::Driver::S3.new({}) }.to raise_error(BrowseEverything::InitializationError)
+    end
+
+    it 'rejects app_key if app_secret is missing' do
+      expect { BrowseEverything::Driver::S3.new(bucket: 'bucket', app_key: 'APP_KEY') }.to raise_error(BrowseEverything::InitializationError)
+    end
+
+    it 'rejects app_secret if app_key is missing' do
+      expect { BrowseEverything::Driver::S3.new(bucket: 'bucket', app_secret: 'APP_SECRET') }.to raise_error(BrowseEverything::InitializationError)
+    end
+
+    it 'accepts app_key and app_secret together' do
+      expect { BrowseEverything::Driver::S3.new(bucket: 'bucket', app_key: 'APP_KEY', app_secret: 'APP_SECRET') }.not_to raise_error
+    end
+
+    it 'rejects an invalid response type' do
+      expect { BrowseEverything::Driver::S3.new(bucket: 'bucket', response_type: :foo) }.to raise_error(BrowseEverything::InitializationError)
+    end
+
+    it 'deprecates :signed_url' do
+      driver = BrowseEverything::Driver::S3.new(bucket: 'bucket', signed_url: false)
+      expect(driver.config).not_to have_key(:signed_url)
+      expect(driver.config[:response_type]).to eq(:public_url)
+    end
   end
 
   describe '#contents' do
@@ -72,6 +102,33 @@ describe BrowseEverything::Driver::FileSystem do
         its(:size)     { is_expected.to eq(1_511_860) }
         specify        { is_expected.not_to be_container }
       end
+
+      context '#link_for' do
+        subject { contents[2] }
+        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(: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(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')
+        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')
+        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')
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browse-everything
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Carolyn Cole
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -385,14 +385,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -461,6 +461,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".engine_cart.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -518,6 +519,7 @@ files:
 - spec/fixtures/file_system/dir_2/file_4.docx
 - spec/fixtures/file_system/file 1.pdf
 - spec/fixtures/file_system/file_1.pdf
+- spec/fixtures/vcr_cassettes/box.yml
 - spec/fixtures/vcr_cassettes/dropbox.yml
 - spec/fixtures/vcr_cassettes/retriever.yml
 - spec/helper/browse_everything_controller_helper_spec.rb
@@ -533,6 +535,7 @@ files:
 - spec/support/rake.rb
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/unit/base_spec.rb
+- spec/unit/box_spec.rb
 - spec/unit/browse_everything_helper_spec.rb
 - spec/unit/browser_spec.rb
 - spec/unit/dropbox_spec.rb
@@ -566,7 +569,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: AJAX/Rails engine file browser for cloud storage services
@@ -578,6 +581,7 @@ test_files:
 - spec/fixtures/file_system/dir_2/file_4.docx
 - spec/fixtures/file_system/file 1.pdf
 - spec/fixtures/file_system/file_1.pdf
+- spec/fixtures/vcr_cassettes/box.yml
 - spec/fixtures/vcr_cassettes/dropbox.yml
 - spec/fixtures/vcr_cassettes/retriever.yml
 - spec/helper/browse_everything_controller_helper_spec.rb
@@ -593,6 +597,7 @@ test_files:
 - spec/support/rake.rb
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/unit/base_spec.rb
+- spec/unit/box_spec.rb
 - spec/unit/browse_everything_helper_spec.rb
 - spec/unit/browser_spec.rb
 - spec/unit/dropbox_spec.rb