browse-everything 0.10.5 → 0.11.0

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

@@ -8,7 +8,7 @@
   <div class="modal-body ev-body" tabindex="-1">
     <div class="ev-browser row<%=bs2('-fluid')%>" aria-live="polite">
       <div class="<%=fa3or4('fa3','fa4')%> <%=bs2or3('bs2 span','bs3 col-xs-')%>12 ev-files list">
-        <%= render :partial => 'files' %>
+        <%= render :partial => 'files' if provider.present? %>
       </div>
     </div>
   </div>

data/browse-everything.gemspec

@@ -4,44 +4,47 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'browse_everything/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "browse-everything"
+  spec.name          = 'browse-everything'
   spec.version       = BrowseEverything::VERSION
-  spec.authors       = ["Carolyn Cole", "Jessie Keck", "Michael B. Klein", "Thomas Scherz", "Xiaoming Wang", "Jeremy Friesen"]
-  spec.email         = ["cam156@psu.edu", "jkeck@stanford.edu", "mbklein@gmail.com", "scherztc@ucmail.uc.edu", "xw5d@virginia.edu", "jeremy.n.friesen@gmail.com"]
-  spec.description   = %q{AJAX/Rails engine file browser for cloud storage services}
-  spec.summary       = %q{AJAX/Rails engine file browser for cloud storage services}
-  spec.homepage      = "https://github.com/projecthydra/browse-everything"
-  spec.license       = "Apache 2"
+  spec.authors       = ['Carolyn Cole', 'Jessie Keck', 'Michael B. Klein', 'Thomas Scherz', 'Xiaoming Wang', 'Jeremy Friesen']
+  spec.email         = ['cam156@psu.edu', 'jkeck@stanford.edu', 'mbklein@gmail.com', 'scherztc@ucmail.uc.edu', 'xw5d@virginia.edu', 'jeremy.n.friesen@gmail.com']
+  spec.description   = 'AJAX/Rails engine file browser for cloud storage services'
+  spec.summary       = 'AJAX/Rails engine file browser for cloud storage services'
+  spec.homepage      = 'https://github.com/projecthydra/browse-everything'
+  spec.license       = 'Apache 2'
 
   spec.files         = `git ls-files`.split($/)
   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.require_paths = ['lib']
 
-  spec.add_dependency "rails", ">= 3.1"
-  spec.add_dependency "google_drive"
-  spec.add_dependency "dropbox-sdk", ">= 1.6.2"
-  spec.add_dependency "skydrive"
-  spec.add_dependency "ruby-box"
-  spec.add_dependency "sass-rails"
-  spec.add_dependency "bootstrap-sass"
-  spec.add_dependency "font-awesome-rails"
-  spec.add_dependency "google-api-client", "~> 0.8.6"
-  spec.add_dependency "httparty"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-rails"
-  spec.add_development_dependency "rspec-its"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "factory_girl_rails"
-  spec.add_development_dependency "engine_cart", '~> 0.10'
-  spec.add_development_dependency "capybara"
-  spec.add_development_dependency "jasmine", '~> 2.3'
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "poltergeist", "~> 1.10"
+  spec.add_dependency 'rails', '>= 3.1'
+  spec.add_dependency 'google_drive'
+  spec.add_dependency 'dropbox-sdk', '>= 1.6.2'
+  spec.add_dependency 'skydrive'
+  spec.add_dependency 'ruby-box'
+  spec.add_dependency 'sass-rails'
+  spec.add_dependency 'bootstrap-sass'
+  spec.add_dependency 'font-awesome-rails'
+  spec.add_dependency 'google-api-client', '~> 0.9'
+  spec.add_dependency 'signet'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'aws-sdk'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'factory_girl_rails'
+  spec.add_development_dependency 'engine_cart', '~> 0.10'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'jasmine', '~> 2.3'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'poltergeist', '~> 1.10'
 end

data/config/routes.rb

@@ -1,6 +1,6 @@
 BrowseEverything::Engine.routes.draw do
-  get "connect", to: 'browse_everything#auth', as: 'connector_response'
-  match "resolve", to: 'browse_everything#resolve', as: 'resolver', via: [:get, :post]
-  match ":provider(/*path)", to: 'browse_everything#show', as: 'contents', via: [:get, :post]
+  get 'connect', to: 'browse_everything#auth', as: 'connector_response'
+  match 'resolve', to: 'browse_everything#resolve', as: 'resolver', via: [:get, :post]
+  match ':provider(/*path)', to: 'browse_everything#show', as: 'contents', via: [:get, :post]
   root to: 'browse_everything#index'
 end

data/lib/browse-everything.rb

@@ -1,3 +1,3 @@
 require 'bootstrap-sass'
 require 'font-awesome-rails'
-require 'browse_everything'
+require 'browse_everything'

data/lib/browse_everything.rb

@@ -1,7 +1,7 @@
-require "rails"
-require "browse_everything/version"
-require "browse_everything/engine"
-require "browse_everything/retriever"
+require 'rails'
+require 'browse_everything/version'
+require 'browse_everything/engine'
+require 'browse_everything/retriever'
 
 module BrowseEverything
   class InitializationError < RuntimeError; end
@@ -15,17 +15,18 @@ module BrowseEverything
     autoload :SkyDrive,    'browse_everything/driver/sky_drive'
     autoload :Box,         'browse_everything/driver/box'
     autoload :GoogleDrive, 'browse_everything/driver/google_drive'
+    autoload :S3,          'browse_everything/driver/s3'
   end
 
   class << self
     def configure(value)
-      if value.nil? or value.kind_of?(Hash)
+      if value.nil? || value.is_a?(Hash)
         @config = value
-      elsif value.kind_of?(String)
+      elsif value.is_a?(String)
         @config = YAML.load(ERB.new(File.read(value)).result)
 
         if @config.include? 'drop_box'
-          warn "[DEPRECATION] `drop_box` is deprecated.  Please use `dropbox` instead."
+          warn '[DEPRECATION] `drop_box` is deprecated.  Please use `dropbox` instead.'
           @config['dropbox'] = @config.delete('drop_box')
         end
 
@@ -36,7 +37,7 @@ module BrowseEverything
 
     def config
       if @config.nil?
-        configure(File.join(Rails.root.to_s,'config','browse_everything_providers.yml'))
+        configure(File.join(Rails.root.to_s, 'config', 'browse_everything_providers.yml'))
       end
       @config
     end

data/lib/browse_everything/browser.rb

@@ -1,10 +1,10 @@
 module BrowseEverything
   class Browser
     attr_reader :providers
-    
+
     def initialize(opts = {})
       url_options = {}
-      if opts.has_key?(:url_options)
+      if opts.key?(:url_options)
         url_options = opts.delete(:url_options)
       else
         url_options = opts
@@ -12,12 +12,12 @@ module BrowseEverything
       end
 
       @providers = {}
-      opts.each_pair do |driver,config|
+      opts.each_pair do |driver, config|
         begin
           driver_klass = BrowseEverything::Driver.const_get((config[:driver] || driver.to_s).camelize.to_sym)
           @providers[driver] = driver_klass.new(config.merge(url_options: url_options))
         rescue
-          Rails.logger.warn "Unknown provider: #{driver.to_s}"
+          Rails.logger.warn "Unknown provider: #{driver}"
         end
       end
     end

data/lib/browse_everything/driver/base.rb

@@ -5,8 +5,8 @@ module BrowseEverything
 
       attr_reader :config, :name
       attr_accessor :token
-      
-      def initialize(config,session_info={})
+
+      def initialize(config, _session_info = {})
         @config = config
         validate_config
       end
@@ -26,11 +26,11 @@ module BrowseEverything
       def validate_config
       end
 
-      def contents(path)
+      def contents(_path)
         []
       end
 
-      def details(path)
+      def details(_path)
         nil
       end
 
@@ -42,26 +42,26 @@ module BrowseEverything
         false
       end
 
+      # @return [Array{URI,Object}] 2 elements: the URI, and session data to store under "#{provider_name}_data"
       def auth_link
         []
       end
 
-      def connect(params,data)
+      def connect(_params, _data)
         nil
       end
 
       private
 
-        def callback
-          connector_response_url(callback_options)
-        end
-
-        # 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
-        def callback_options
-          config[:url_options].reject {|k,v| k == :script_name}
-        end
+      def callback
+        connector_response_url(callback_options)
+      end
 
+      # 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
+      def callback_options
+        config[:url_options].reject { |k, _v| k == :script_name }
+      end
     end
   end
 end

data/lib/browse_everything/driver/box.rb

@@ -4,38 +4,38 @@ module BrowseEverything
       require 'ruby-box'
 
       ITEM_LIMIT = 99999
-      
+
       def icon
         'cloud'
       end
 
       def validate_config
         unless config[:client_id]
-          raise BrowseEverything::InitializationError, "Box driver requires a :client_id argument"
+          raise BrowseEverything::InitializationError, 'Box driver requires a :client_id argument'
         end
         unless config[:client_secret]
-          raise BrowseEverything::InitializationError, "Box driver requires a :client_secret argument"
+          raise BrowseEverything::InitializationError, 'Box driver requires a :client_secret argument'
         end
       end
 
-      def contents(path='')
-        path.sub!(/^[\/.]+/,'')
+      def contents(path = '')
+        path.sub!(/^[\/.]+/, '')
         result = []
         unless path.empty?
           result << BrowseEverything::FileEntry.new(
-              Pathname(path).join('..'),
-              '', '..', 0, Time.now, true
+            Pathname(path).join('..'),
+            '', '..', 0, Time.now, true
           )
         end
         folder = path.empty? ? box_client.root_folder : box_client.folder(path)
-        result += folder.items(ITEM_LIMIT,0,['name','size','created_at']).collect do |f|
+        result += folder.items(ITEM_LIMIT, 0, %w(name size created_at)).collect do |f|
           BrowseEverything::FileEntry.new(
-              File.join(path,f.name),#id here
-              "#{self.key}:#{File.join(path,f.name)}",#single use link
-              f.name,
-              f.size,
-              f.created_at,
-              f.type == 'folder'
+            File.join(path, f.name), # id here
+            "#{key}:#{File.join(path, f.name)}", # single use link
+            f.name,
+            f.size,
+            f.created_at,
+            f.type == 'folder'
           )
         end
         result
@@ -44,12 +44,9 @@ module BrowseEverything
       def link_for(path)
         file = box_client.file(path)
         download_url = file.download_url
-        auth_header = {'Authorization' => "Bearer #{@token}"}
+        auth_header = { 'Authorization' => "Bearer #{@token}" }
         extras = { auth_header: auth_header, expires: 1.hour.from_now, file_name: file.name, file_size: file.size.to_i }
-        [download_url,extras]
-      end
-
-      def details(f)
+        [download_url, extras]
       end
 
       def auth_link
@@ -57,68 +54,60 @@ module BrowseEverything
       end
 
       def authorized?
-        #false
-        @token.present?  and @token['token'].present?
+        @token.present? && @token['token'].present?
       end
 
-      def connect(params,data)
-        access_token=oauth_client.get_access_token(params[:code])
-        @token = {'token' => access_token.token, 'refresh_token' => access_token.refresh_token}
+      def connect(params, _data)
+        access_token = oauth_client.get_access_token(params[:code])
+        @token = { 'token' => access_token.token, 'refresh_token' => access_token.refresh_token }
       end
 
       private
-      def oauth_client
-        session = RubyBox::Session.new({
-                                           client_id: config[:client_id],
-                                           client_secret: config[:client_secret]
-                                       })
 
-         session
-        #todo error checking here
+      def oauth_client
+        RubyBox::Session.new(client_id: config[:client_id],
+                             client_secret: config[:client_secret])
+        # TODO: error checking here
       end
 
       def token_expired?(token)
-        begin
-          return false unless @token.present?  and @token['token'].present?
-          new_session = RubyBox::Session.new({
-                                                 client_id: config[:client_id],
-                                                 client_secret: config[:client_secret],
-                                                 access_token: token
-                                             })
-          result = new_session.get( "#{RubyBox::API_URL}/users/me" )
-          (result["status"] != 200)
-        rescue RubyBox::AuthError => e
-          Rails.logger.error("AuthError occured when checking token. Exception #{e.class.name} : #{e.message}. token as expired and need to refresh it")
-          return true
-        end
+        return false unless @token.present? && @token['token'].present?
+        new_session = RubyBox::Session.new(
+          client_id: config[:client_id],
+          client_secret: config[:client_secret],
+          access_token: token
+        )
+        result = new_session.get("#{RubyBox::API_URL}/users/me")
+        result['status'] != 200
+      rescue RubyBox::AuthError => e
+        Rails.logger.error("AuthError occured when checking token. Exception #{e.class.name} : #{e.message}. token as expired and need to refresh it")
+        return true
       end
 
       def refresh_token
         refresh_token = @token['refresh_token']
         token = @token['token']
-        session = RubyBox::Session.new({
-                                     client_id: config[:client_id],
-                                     client_secret: config[:client_secret],
-                                     access_token: token
-                                  })
+        session = RubyBox::Session.new(
+          client_id: config[:client_id],
+          client_secret: config[:client_secret],
+          access_token: token
+        )
         access_token = session.refresh_token(refresh_token)
-        @token = {'token' => access_token.token, 'refresh_token' => access_token.refresh_token}
+        @token = { 'token' => access_token.token, 'refresh_token' => access_token.refresh_token }
       end
 
       def box_client
         refresh_token if token_expired?(@token['token'])
         token = @token['token']
         refresh_token = @token['refresh_token']
-        session = RubyBox::Session.new({
-                                           client_id: config[:client_id],
-                                           client_secret: config[:client_secret],
-                                           access_token: token,
-                                           refresh_token: refresh_token
-                                       })
-       RubyBox::Client.new(session)
+        session = RubyBox::Session.new(
+          client_id: config[:client_id],
+          client_secret: config[:client_secret],
+          access_token: token,
+          refresh_token: refresh_token
+        )
+        RubyBox::Client.new(session)
       end
-
     end
-
   end
 end

data/lib/browse_everything/driver/dropbox.rb

@@ -3,19 +3,18 @@ require 'dropbox_sdk'
 module BrowseEverything
   module Driver
     class Dropbox < Base
-
       def icon
         'dropbox'
       end
 
       def validate_config
-        unless [:app_key,:app_secret].all? { |key| config[key].present? }
-          raise BrowseEverything::InitializationError, "Dropbox driver requires :app_key and :app_secret"
+        unless [:app_key, :app_secret].all? { |key| config[key].present? }
+          raise BrowseEverything::InitializationError, 'Dropbox driver requires :app_key and :app_secret'
         end
       end
 
-      def contents(path='')
-        path.sub!(/^[\/.]+/,'')
+      def contents(path = '')
+        path.sub!(/^[\/.]+/, '')
         result = []
         unless path.empty?
           result << BrowseEverything::FileEntry.new(
@@ -27,7 +26,7 @@ module BrowseEverything
           path = info['path']
           BrowseEverything::FileEntry.new(
             path,
-            [self.key,path].join(':'),
+            [key, path].join(':'),
             File.basename(path),
             info['bytes'],
             Time.parse(info['modified']),
@@ -46,12 +45,12 @@ module BrowseEverything
       end
 
       def auth_link
-        [ auth_flow.start('dropbox'), @csrf ]
+        [auth_flow.start('dropbox'), @csrf]
       end
 
-      def connect(params,data)
+      def connect(params, data)
         @csrf = data
-        @token, user, state = auth_flow.finish(params)
+        @token, _user, _state = auth_flow.finish(params)
         @token
       end
 
@@ -60,15 +59,15 @@ module BrowseEverything
       end
 
       private
+
       def auth_flow
         @csrf ||= {}
-        DropboxOAuth2Flow.new(config[:app_key], config[:app_secret], callback.to_s,@csrf,'token')
+        DropboxOAuth2Flow.new(config[:app_key], config[:app_secret], callback.to_s, @csrf, 'token')
       end
 
       def client
         DropboxClient.new(token)
       end
     end
-
   end
 end