browse-everything 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef33c2e0a8c1c1206dce56eedad11b136195a6d094ce585ff4799323a442cb34
-  data.tar.gz: 76a840d66d3fc96fb6a1193515889980aba59a2469cbe76bdbabb4a7bc8bd204
+  metadata.gz: 5c44e6fe17fdd953916e2e9daee9dc2923123e3aa8b16e1b2413714e5c7e10a0
+  data.tar.gz: 05656d696be1683da78311011c2274ab422186d072c4005b32ceee87b63d3264
 SHA512:
-  metadata.gz: fc3f2a4506d217583eb05c32e1b632578772c13eb21accf2f40eea87d104c06228f38d172e110c0f2e5524697ef7560aa54164ca92536e010c8746f9b7aeb397
-  data.tar.gz: 86ef8ad24edeec846bf81c1887f038befcdcb06c3cc6c0730ca2beb8834cb67ea9e86167067913feab7fa84a5c45a898de79280a66b9725391c6437f274965a8
+  metadata.gz: cb7a332399ae1928ea4883ea8931b72410edd3f5b2ce59527f50b3df6c2b0e620812e58c742f09f0386c8f077ef3ae836bf379227287c82d94a32274b1f759c0
+  data.tar.gz: a036a93cb63e5880323cbe5bf9a505e5f7289926ab392029254f463b62993eb88f4c40351238ad98af299f5612727dee47d00419128c5cc79d6c6a4f9850bc88

data/.gitignore

@@ -13,6 +13,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/fixtures/Getting Started.pdf
 test/tmp
 test/version_tmp
 tmp

data/app/views/browse_everything/_files.html.erb

@@ -9,6 +9,7 @@
       </tr>
     </thead>
     <% provider_contents.each_with_index do |file, index| %>
+      <% next if file.nil? %>
       <% path = browse_everything_engine.contents_path(provider_name, file.id) %>
       <% parent = params[:parent] %>
       <% if file.container? || provider.config[:max_upload_file_size].blank? %>

data/browse-everything.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'typhoeus'
 
   spec.add_development_dependency 'bixby', '>= 1.0'
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '>= 1.3'
   spec.add_development_dependency 'capybara'
   spec.add_development_dependency 'chromedriver-helper', '~> 2.1'
   spec.add_development_dependency 'coveralls'

data/lib/browse_everything/driver/box.rb

@@ -33,15 +33,18 @@ module BrowseEverything
         raise InitializationError, 'Box driver requires both :client_id and :client_secret argument'
       end
 
+      # Retrieves the file entry objects for a given path to Box resource
       # @param [String] id of the file or folder in Box
-      # @return [Array<RubyBox::File>]
+      # @return [Array<BrowseEverything::FileEntry>]
       def contents(id = '')
         folder = id.empty? ? box_client.root_folder : box_client.folder_by_id(id)
-        @entries = []
+        values = []
 
         folder.items(ITEM_LIMIT, 0, %w[name size created_at]).collect do |f|
-          @entries << directory_entry(f)
+          values << directory_entry(f)
         end
+        @entries = values.compact
+
         @sorter.call(@entries)
       end
 
@@ -133,6 +136,10 @@ module BrowseEverything
           @token.fetch('expires_at', nil).to_i
         end
 
+        # Constructs a BrowseEverything::FileEntry object for a Box file
+        # resource
+        # @param file [String] ID to the file resource
+        # @return [BrowseEverything::File]
         def directory_entry(file)
           BrowseEverything::FileEntry.new(file.id, "#{key}:#{file.id}", file.name, file.size, file.created_at, file.type == 'folder')
         end

data/lib/browse_everything/driver/dropbox.rb

@@ -83,7 +83,8 @@ module BrowseEverything
       def contents(path = '')
         path = '/' + path unless path == ''
         response = client.list_folder(path)
-        @entries = response.entries.map { |entry| FileEntryFactory.build(metadata: entry, key: key) }
+        values = response.entries.map { |entry| FileEntryFactory.build(metadata: entry, key: key) }
+        @entries = values.compact
         @sorter.call(@entries)
       end
 

data/lib/browse_everything/driver/file_system.rb

@@ -11,13 +11,17 @@ module BrowseEverything
         raise BrowseEverything::InitializationError, 'FileSystem driver requires a :home argument' if config[:home].blank?
       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)
-        @entries = if File.directory?(real_path)
-                     make_directory_entry real_path
-                   else
-                     [details(real_path)]
-                   end
+        values = if File.directory?(real_path)
+                   make_directory_entry real_path
+                 else
+                   [details(real_path)]
+                 end
+        @entries = values.compact
 
         @sorter.call(@entries)
       end
@@ -32,6 +36,10 @@ module BrowseEverything
         true
       end
 
+      # Construct a FileEntry objects for a file-system resource
+      # @param path [String] path to the file
+      # @param display [String] display label for the resource
+      # @return [BrowseEverything::FileEntry]
       def details(path, display = File.basename(path))
         return nil unless File.exist? path
         info = File::Stat.new(path)
@@ -47,6 +55,10 @@ 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) }

data/lib/browse_everything/driver/google_drive.rb

@@ -79,9 +79,10 @@ module BrowseEverything
             raise error
           end
 
-          @entries += file_list.files.map do |gdrive_file|
+          values = file_list.files.map do |gdrive_file|
             details(gdrive_file, path)
           end
+          @entries += values.compact
 
           request_params.page_token = file_list.next_page_token
         end

data/lib/browse_everything/driver/s3.rb

@@ -113,23 +113,39 @@ module BrowseEverything
           @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
 
+        # 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|
-            @entries << entry_for(from_base(prefix.prefix), 0, Time.current, true)
+            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)
-            @entries << entry_for(key, entry.size, entry.last_modified, false) unless strip(key) == strip(path)
+            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))

data/lib/browse_everything/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browse-everything
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Carolyn Cole
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -187,14 +187,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency