browse-everything 1.1.0 → 1.2.0

data/app/controllers/browse_everything_controller.rb

@@ -2,7 +2,7 @@
 
 require File.expand_path('../helpers/browse_everything_helper', __dir__)
 
-class BrowseEverythingController < ActionController::Base
+class BrowseEverythingController < ApplicationController
   layout 'browse_everything'
   helper BrowseEverythingHelper
 
@@ -61,72 +61,72 @@ class BrowseEverythingController < ActionController::Base
 
   private
 
-    # Constructs or accesses an existing session manager Object
-    # @return [BrowseEverythingSession::ProviderSession] the session manager
-    def provider_session
-      BrowseEverythingSession::ProviderSession.new(session: session, name: provider_name)
-    end
+  # Constructs or accesses an existing session manager Object
+  # @return [BrowseEverythingSession::ProviderSession] the session manager
+  def provider_session
+    BrowseEverythingSession::ProviderSession.new(session: session, name: provider_name)
+  end
 
-    # Clears all authentication tokens, codes, and other data from the Rails session
-    def reset_provider_session!
-      return unless @provider_session
-      @provider_session.token = nil
-      @provider_session.code = nil
-      @provider_session.data = nil
-      @provider_session = nil
-    end
+  # Clears all authentication tokens, codes, and other data from the Rails session
+  def reset_provider_session!
+    return unless @provider_session
+    @provider_session.token = nil
+    @provider_session.code = nil
+    @provider_session.data = nil
+    @provider_session = nil
+  end
 
-    def connector_response_url_options
-      { protocol: request.protocol, host: request.host, port: request.port }
-    end
+  def connector_response_url_options
+    { protocol: request.protocol, host: request.host, port: request.port }
+  end
 
-    # Generates the authentication link for a given provider service
-    # @return [String] the authentication link
-    def auth_link
-      @auth_link ||= if provider.present?
-                       link, data = provider.auth_link(connector_response_url_options)
-                       provider_session.data = data
-                       link = "#{link}&state=#{provider.key}" unless link.to_s.include?('state')
-                       link
-                     end
-    end
+  # Generates the authentication link for a given provider service
+  # @return [String] the authentication link
+  def auth_link
+    @auth_link ||= if provider.present?
+                     link, data = provider.auth_link(connector_response_url_options)
+                     provider_session.data = data
+                     link = "#{link}&state=#{provider.key}" unless link.to_s.include?('state')
+                     link
+                   end
+  end
 
-    # Accesses the relative path for browsing from the Rails session
-    # @return [String]
-    def browse_path
-      params[:path] || ''
-    end
+  # Accesses the relative path for browsing from the Rails session
+  # @return [String]
+  def browse_path
+    params[:path] || ''
+  end
 
-    # Generate the provider name from the Rails session state value
-    # @return [String]
-    def provider_name_from_state
-      params[:state].to_s.split(/\|/).last
-    end
+  # Generate the provider name from the Rails session state value
+  # @return [String]
+  def provider_name_from_state
+    params[:state].to_s.split(/\|/).last
+  end
 
-    # Generates the name of the provider using Rails session values
-    # @return [String]
-    def provider_name
-      params[:provider] || provider_name_from_state || browser.providers.each_key.to_a.first
-    end
+  # Generates the name of the provider using Rails session values
+  # @return [String]
+  def provider_name
+    params[:provider] || provider_name_from_state || browser.providers.each_key.to_a.first
+  end
 
-    # Retrieve the Driver for each request
-    # @return [BrowseEverything::Driver::Base]
-    def provider
-      browser.providers[provider_name.to_sym] || browser.first_provider
-    end
+  # Retrieve the Driver for each request
+  # @return [BrowseEverything::Driver::Base]
+  def provider
+    browser.providers[provider_name.to_sym] || browser.first_provider
+  end
 
-    # Constructs a browser manager Object
-    # Browser state cannot persist between requests to the Controller
-    # Hence, a Browser must be reinstantiated for each request using the state provided in the Rails session
-    # @return [BrowseEverything::Browser]
-    def browser
-      BrowserFactory.build(session: session, url_options: url_options)
-    end
+  # Constructs a browser manager Object
+  # Browser state cannot persist between requests to the Controller
+  # Hence, a Browser must be reinstantiated for each request using the state provided in the Rails session
+  # @return [BrowseEverything::Browser]
+  def browser
+    BrowserFactory.build(session: session, url_options: url_options)
+  end
 
-    helper_method :auth_link
-    helper_method :browser
-    helper_method :browse_path
-    helper_method :provider
-    helper_method :provider_name
-    helper_method :provider_contents
+  helper_method :auth_link
+  helper_method :browser
+  helper_method :browse_path
+  helper_method :provider
+  helper_method :provider_name
+  helper_method :provider_contents
 end

data/app/helpers/browse_everything_helper.rb

@@ -20,4 +20,8 @@ module BrowseEverythingHelper
     acceptable_types << 'application/x-directory'
     acceptable_types.any? { |type| mime_match?(file.type, type) }
   end
+
+  def file_size_to_human_size(file_size)
+    "#{file_size} bytes"
+  end
 end

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

@@ -16,6 +16,7 @@
          <% disabled = false %>
       <% else %>
          <% max_size = provider.config[:max_upload_file_size].to_i %>
+         <% max_human_size = file_size_to_human_size(max_size) %>
          <% disabled = file.size > max_size %>
       <% end %>
 
@@ -28,7 +29,7 @@
 
         <td role="gridcell" title="<%= file.name %>" class="<%=file.container? ? 'ev-container' : 'ev-file'%> ev-file-name">
           <% if disabled %>
-            <span title="<%= t('browse_everything.size_disabled', max_size: number_to_human_size(max_size)) %>"
+            <span title="<%= t('browse_everything.size_disabled', max_size: max_human_size) %>"
                   class="<%=file.container? ? 'folder' : 'file'%>" aria-hidden="true">
               <%= file.name %>
             </span>
@@ -53,7 +54,7 @@
 
         <% if file.size %>
           <td role="gridcell" class="ev-file-size">
-            <%= number_to_human_size(file.size).sub(/Bytes/,'bytes') %>
+            <%= file_size_to_human_size(file.size) %>
           </td>
         <% else %>
           <td role="gridcell" class="ev-file-size">Unknown</td>

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,30 +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', '< 6.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 'sprockets', '~> 3.7'
   spec.add_dependency 'typhoeus'
 
-  spec.add_development_dependency 'bixby', '>= 1.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'
@@ -46,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/auth/google/credentials.rb

@@ -17,11 +17,11 @@ module BrowseEverything
 
         private
 
-          # Structure a hash from existing access token values (usually cached within a Cookie)
-          # @return [Hash]
-          def build_token_hash
-            { 'access_token' => access_token }
-          end
+        # Structure a hash from existing access token values (usually cached within a Cookie)
+        # @return [Hash]
+        def build_token_hash
+          { 'access_token' => access_token }
+        end
       end
     end
   end

data/lib/browse_everything/auth/google/request_parameters.rb

@@ -14,47 +14,47 @@ module BrowseEverything
 
         private
 
-          # The default query parameters for the Google Drive API
-          # @return [Hash]
-          def default_params
-            {
-              q: default_query,
-              order_by: 'modifiedTime desc,folder,name',
-              fields: 'nextPageToken,files(name,id,mimeType,size,modifiedTime,parents,web_content_link)',
-              supports_team_drives: true,
-              include_team_drive_items: true,
-              corpora: 'user,allTeamDrives',
-              page_size: 1000
-            }
-          end
+        # The default query parameters for the Google Drive API
+        # @return [Hash]
+        def default_params
+          {
+            q: default_query,
+            order_by: 'modifiedTime desc,folder,name',
+            fields: 'nextPageToken,files(name,id,mimeType,size,modifiedTime,parents,web_content_link)',
+            supports_team_drives: true,
+            include_team_drive_items: true,
+            corpora: 'user,allTeamDrives',
+            page_size: 1000
+          }
+        end
 
-          def default_query
-            field_queries = []
-            contraints.each_pair do |field, constraints|
-              field_constraint = constraints.join(" and #{field} ")
-              field_queries << "#{field} #{field_constraint}"
-            end
-            field_queries.join(' ')
+        def default_query
+          field_queries = []
+          contraints.each_pair do |field, constraints|
+            field_constraint = constraints.join(" and #{field} ")
+            field_queries << "#{field} #{field_constraint}"
           end
+          field_queries.join(' ')
+        end
 
-          def contraints
-            {
-              'mimeType' => [
-                '!= \'application/vnd.google-apps.audio\'',
-                '!= \'application/vnd.google-apps.document\'',
-                '!= \'application/vnd.google-apps.drawing\'',
-                '!= \'application/vnd.google-apps.form\'',
-                '!= \'application/vnd.google-apps.fusiontable\'',
-                '!= \'application/vnd.google-apps.map\'',
-                '!= \'application/vnd.google-apps.photo\'',
-                '!= \'application/vnd.google-apps.presentation\'',
-                '!= \'application/vnd.google-apps.script\'',
-                '!= \'application/vnd.google-apps.site\'',
-                '!= \'application/vnd.google-apps.spreadsheet\'',
-                '!= \'application/vnd.google-apps.video\''
-              ]
-            }
-          end
+        def contraints
+          {
+            'mimeType' => [
+              '!= \'application/vnd.google-apps.audio\'',
+              '!= \'application/vnd.google-apps.document\'',
+              '!= \'application/vnd.google-apps.drawing\'',
+              '!= \'application/vnd.google-apps.form\'',
+              '!= \'application/vnd.google-apps.fusiontable\'',
+              '!= \'application/vnd.google-apps.map\'',
+              '!= \'application/vnd.google-apps.photo\'',
+              '!= \'application/vnd.google-apps.presentation\'',
+              '!= \'application/vnd.google-apps.script\'',
+              '!= \'application/vnd.google-apps.site\'',
+              '!= \'application/vnd.google-apps.spreadsheet\'',
+              '!= \'application/vnd.google-apps.video\''
+            ]
+          }
+        end
       end
     end
   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
 
@@ -100,21 +101,21 @@ module BrowseEverything
 
       private
 
-        # Generate the options for the Rails URL generation for API callbacks
-        # remove the script_name parameter from the url_options since that is causing issues
-        #   with the route not containing the engine path in rails 4.2.0
-        # @return [Hash]
-        def callback_options
-          options = config.to_hash
-          options.deep_symbolize_keys!
-          options[:url_options].reject { |k, _v| k == :script_name }
-        end
+      # Generate the options for the Rails URL generation for API callbacks
+      # remove the script_name parameter from the url_options since that is causing issues
+      #   with the route not containing the engine path in rails 4.2.0
+      # @return [Hash]
+      def callback_options
+        options = config.to_hash
+        options.deep_symbolize_keys!
+        options[:url_options].reject { |k, _v| k == :script_name }
+      end
 
-        # Generate the URL for the API callback
-        # @return [String]
-        def callback
-          connector_response_url(callback_options)
-        end
+      # Generate the URL for the API callback
+      # @return [String]
+      def callback
+        connector_response_url(callback_options)
+      end
     end
   end
 end

data/lib/browse_everything/driver/box.rb

@@ -77,72 +77,72 @@ module BrowseEverything
 
       private
 
-        def token_expired?
-          return true if expiration_time.nil?
-          Time.now.to_i > expiration_time
-        end
+      def token_expired?
+        return true if expiration_time.nil?
+        Time.now.to_i > expiration_time
+      end
 
-        def box_client
-          if token_expired?
-            session = box_session
-            register_access_token(session.refresh_token(box_refresh_token))
-          end
-          RubyBox::Client.new(box_session)
+      def box_client
+        if token_expired?
+          session = box_session
+          register_access_token(session.refresh_token(box_refresh_token))
         end
+        RubyBox::Client.new(box_session)
+      end
 
-        def session
-          AuthenticationFactory.new(
-            self.class.authentication_klass,
-            client_id: config[:client_id],
-            client_secret: config[:client_secret],
-            access_token: box_token,
-            refresh_token: box_refresh_token
-          )
-        end
+      def session
+        AuthenticationFactory.new(
+          self.class.authentication_klass,
+          client_id: config[:client_id],
+          client_secret: config[:client_secret],
+          access_token: box_token,
+          refresh_token: box_refresh_token
+        )
+      end
 
-        def authenticate
-          session.authenticate
-        end
+      def authenticate
+        session.authenticate
+      end
 
-        def box_session
-          authenticate
-        end
+      def box_session
+        authenticate
+      end
 
-        # If there is an active session, {@token} will be set by {BrowseEverythingController} using data stored in the
-        # session. However, if there is no prior session, or the token has expired, we reset it here using # a new
-        # access_token received from {#box_session}.
-        #
-        # @param [OAuth2::AccessToken] access_token
-        def register_access_token(access_token)
-          @token = {
-            'token' => access_token.token,
-            'refresh_token' => access_token.refresh_token,
-            'expires_at' => access_token.expires_at
-          }
-        end
+      # If there is an active session, {@token} will be set by {BrowseEverythingController} using data stored in the
+      # session. However, if there is no prior session, or the token has expired, we reset it here using # a new
+      # access_token received from {#box_session}.
+      #
+      # @param [OAuth2::AccessToken] access_token
+      def register_access_token(access_token)
+        @token = {
+          'token' => access_token.token,
+          'refresh_token' => access_token.refresh_token,
+          'expires_at' => access_token.expires_at
+        }
+      end
 
-        def box_token
-          return unless @token
-          @token.fetch('token', nil)
-        end
+      def box_token
+        return unless @token
+        @token.fetch('token', nil)
+      end
 
-        def box_refresh_token
-          return unless @token
-          @token.fetch('refresh_token', nil)
-        end
+      def box_refresh_token
+        return unless @token
+        @token.fetch('refresh_token', nil)
+      end
 
-        def expiration_time
-          return unless @token
-          @token.fetch('expires_at', nil).to_i
-        end
+      def expiration_time
+        return unless @token
+        @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
+      # 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
     end
   end
 end

data/lib/browse_everything/driver/dropbox.rb

@@ -16,14 +16,14 @@ module BrowseEverything
         class << self
           private
 
-            def klass_for(metadata)
-              case metadata
-              when DropboxApi::Metadata::File
-                FileFactory
-              else
-                ResourceFactory
-              end
+          def klass_for(metadata)
+            case metadata
+            when DropboxApi::Metadata::File
+              FileFactory
+            else
+              ResourceFactory
             end
+          end
         end
       end
 
@@ -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
 
@@ -138,44 +141,44 @@ module BrowseEverything
 
       private
 
-        def session
-          AuthenticationFactory.new(
-            self.class.authentication_klass,
-            config[:client_id],
-            config[:client_secret]
-          )
-        end
+      def session
+        AuthenticationFactory.new(
+          self.class.authentication_klass,
+          config[:client_id],
+          config[:client_secret]
+        )
+      end
 
-        def authenticate
-          session.authenticate
-        end
+      def authenticate
+        session.authenticate
+      end
 
-        def authenticator
-          @authenticator ||= authenticate
-        end
+      def authenticator
+        @authenticator ||= authenticate
+      end
 
-        def client
-          DropboxApi::Client.new(token)
-        end
+      def client
+        DropboxApi::Client.new(token)
+      end
 
-        def redirect_uri(url_options)
-          connector_response_url(**url_options)
-        end
+      def redirect_uri(url_options)
+        connector_response_url(**url_options)
+      end
 
-        # Ensures that the "tmp" directory is used if there is no default download
-        # directory specified in the configuration
-        # @return [String]
-        def default_download_directory
-          Rails.root.join('tmp')
-        end
+      # Ensures that the "tmp" directory is used if there is no default download
+      # directory specified in the configuration
+      # @return [String]
+      def default_download_directory
+        Rails.root.join('tmp')
+      end
 
-        # Retrieves the directory path for downloads used when retrieving the
-        # resource from Dropbox
-        # @return [String]
-        def download_directory_path
-          dir_path = config[:download_directory] || default_download_directory
-          File.expand_path(dir_path)
-        end
+      # Retrieves the directory path for downloads used when retrieving the
+      # resource from Dropbox
+      # @return [String]
+      def download_directory_path
+        dir_path = config[:download_directory] || default_download_directory
+        File.expand_path(dir_path)
+      end
     end
   end
 end