browse-everything 0.12.0 → 0.13.0

data/lib/browse_everything/driver/dropbox.rb

@@ -3,39 +3,45 @@ require 'dropbox_sdk'
 module BrowseEverything
   module Driver
     class Dropbox < Base
+      CONFIG_KEYS = [:app_key, :app_secret].freeze
+
       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'
-        end
+        return if CONFIG_KEYS.all? { |key| config[key].present? }
+        raise BrowseEverything::InitializationError, "Dropbox driver requires #{CONFIG_KEYS.inspect}"
       end
 
+      # @return [Array<BrowseEverything::FileEntry>]
       def contents(path = '')
-        path.sub!(/^[\/.]+/, '')
-        result = []
-        unless path.empty?
-          result << BrowseEverything::FileEntry.new(
-            Pathname(path).join('..'),
-            '', '..', 0, Time.now, true
-          )
-        end
-        result += client.metadata(path)['contents'].collect do |info|
-          path = info['path']
-          BrowseEverything::FileEntry.new(
-            path,
-            [key, path].join(':'),
-            File.basename(path),
-            info['bytes'],
-            Time.parse(info['modified']),
-            info['is_dir']
-          )
-        end
+        path.sub!(%r{ /^[\/.]+/}, '')
+        result = add_directory_entry(path)
+        result += client.metadata(path)['contents'].collect { |info| make_file_entry(info) }
         result
       end
 
+      def add_directory_entry(path)
+        return [] if path.empty?
+        [BrowseEverything::FileEntry.new(
+          Pathname(path).join('..'),
+          '', '..', 0, Time.zone.now, true
+        )]
+      end
+
+      def make_file_entry(info)
+        path = info['path']
+        BrowseEverything::FileEntry.new(
+          path,
+          [key, path].join(':'),
+          File.basename(path),
+          info['bytes'],
+          Time.zone.parse(info['modified']),
+          info['is_dir']
+        )
+      end
+
       def link_for(path)
         [client.media(path)['url'], { expires: 4.hours.from_now, file_name: File.basename(path), file_size: client.metadata(path)['bytes'].to_i }]
       end
@@ -60,14 +66,14 @@ module BrowseEverything
 
       private
 
-      def auth_flow
-        @csrf ||= {}
-        DropboxOAuth2Flow.new(config[:app_key], config[:app_secret], callback.to_s, @csrf, 'token')
-      end
+        def auth_flow
+          @csrf ||= {}
+          DropboxOAuth2Flow.new(config[:app_key], config[:app_secret], callback.to_s, @csrf, 'token')
+        end
 
-      def client
-        DropboxClient.new(token)
-      end
+        def client
+          DropboxClient.new(token)
+        end
     end
   end
 end

data/lib/browse_everything/driver/file_system.rb

@@ -6,54 +6,74 @@ module BrowseEverything
       end
 
       def validate_config
-        unless config[:home]
-          raise BrowseEverything::InitializationError, 'FileSystem driver requires a :home argument'
-        end
+        return if config[:home].present?
+        raise BrowseEverything::InitializationError, 'FileSystem driver requires a :home argument'
       end
 
       def contents(path = '')
         relative_path = path.sub(%r{^[\/.]+}, '')
         real_path = File.join(config[:home], relative_path)
-        result = []
-        if File.directory?(real_path)
-          if relative_path.present?
-            result << details(File.expand_path('..', real_path), '..')
-          end
-          result += Dir[File.join(real_path, '*')].collect { |f| details(f) }
-        elsif File.exist?(real_path)
-          result += [details(real_path)]
-        end
-        result.sort do |a, b|
-          if b.container?
-            a.container? ? a.name.downcase <=> b.name.downcase : 1
-          else
-            a.container? ? -1 : a.name.downcase <=> b.name.downcase
-          end
-        end
+        entries = if File.directory?(real_path)
+                    make_directory_entry(relative_path, real_path)
+                  else
+                    [details(real_path)]
+                  end
+
+        sort_entries(entries)
       end
 
-      def details(path, display = nil)
+      def link_for(path)
+        full_path = File.expand_path(path)
+        file_size = file_size(full_path)
+        ["file://#{full_path}", { file_name: File.basename(path), file_size: file_size }]
+      end
+
+      def authorized?
+        true
+      end
+
+      def details(path, display = File.basename(path))
         return nil unless File.exist?(path)
         info = File::Stat.new(path)
         BrowseEverything::FileEntry.new(
-          Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(config[:home])),
+          make_pathname(path),
           [key, path].join(':'),
-          display || File.basename(path),
+          display,
           info.size,
           info.mtime,
           info.directory?
         )
       end
 
-      def link_for(path)
-        full_path = File.expand_path(path)
-        file_size = File.size(full_path).to_i rescue 0
-        ["file://#{full_path}", { file_name: File.basename(path), file_size: file_size }]
-      end
+      private
 
-      def authorized?
-        true
-      end
+        def make_directory_entry(relative_path, real_path)
+          entries = []
+          if relative_path.present?
+            entries << details(File.expand_path('..', real_path), '..')
+          end
+          entries + Dir[File.join(real_path, '*')].collect { |f| details(f) }
+        end
+
+        def sort_entries(entries)
+          entries.sort do |a, b|
+            if b.container?
+              a.container? ? a.name.downcase <=> b.name.downcase : 1
+            else
+              a.container? ? -1 : a.name.downcase <=> b.name.downcase
+            end
+          end
+        end
+
+        def make_pathname(path)
+          Pathname.new(File.expand_path(path)).relative_path_from(Pathname.new(config[:home]))
+        end
+
+        def file_size(path)
+          File.size(path).to_i
+        rescue
+          0
+        end
     end
   end
 end

data/lib/browse_everything/driver/google_drive.rb

@@ -85,22 +85,22 @@ module BrowseEverything
 
       private
 
-      def authorization
-        return @auth_client unless @auth_client.nil?
-        return nil unless token.present?
-        auth_client.update_token!(token)
-        self.token = auth_client.fetch_access_token! if auth_client.expired?
-        auth_client
-      end
+        def authorization
+          return @auth_client unless @auth_client.nil?
+          return nil unless token.present?
+          auth_client.update_token!(token)
+          self.token = auth_client.fetch_access_token! if auth_client.expired?
+          auth_client
+        end
 
-      def auth_client
-        @auth_client ||= Signet::OAuth2::Client.new token_credential_uri: 'https://www.googleapis.com/oauth2/v3/token',
-                                                    authorization_uri: 'https://accounts.google.com/o/oauth2/auth',
-                                                    scope: 'https://www.googleapis.com/auth/drive',
-                                                    client_id: config[:client_id],
-                                                    client_secret: config[:client_secret],
-                                                    redirect_uri: callback
-      end
+        def auth_client
+          @auth_client ||= Signet::OAuth2::Client.new token_credential_uri: 'https://www.googleapis.com/oauth2/v3/token',
+                                                      authorization_uri: 'https://accounts.google.com/o/oauth2/auth',
+                                                      scope: 'https://www.googleapis.com/auth/drive',
+                                                      client_id: config[:client_id],
+                                                      client_secret: config[:client_secret],
+                                                      redirect_uri: callback
+        end
     end
   end
 end

data/lib/browse_everything/driver/s3.rb

@@ -3,10 +3,17 @@ require 'aws-sdk'
 module BrowseEverything
   module Driver
     class S3 < Base
-      DEFAULTS = { signed_url: true, region: 'us-east-1' }.freeze
-      CONFIG_KEYS = [:app_key, :app_secret, :bucket].freeze
+      DEFAULTS = { response_type: :signed_url }.freeze
+      RESPONSE_TYPES = [:signed_url, :public_url, :s3_uri].freeze
+      CONFIG_KEYS = [:bucket].freeze
+
+      attr_reader :entries
 
       def initialize(config, *args)
+        if config.key?(:signed_url) && config.delete(:signed_url) == false
+          warn '[DEPRECATION] Amazon S3 driver: `:signed_url` is deprecated.  Please use `:response_type` instead.'
+          config[:response_type] = :public_url
+        end
         config = DEFAULTS.merge(config)
         super
       end
@@ -16,27 +23,48 @@ module BrowseEverything
       end
 
       def validate_config
+        if config.values_at(:app_key, :app_secret).compact.length == 1
+          raise BrowseEverything::InitializationError, 'Amazon S3 driver: If either :app_key or :app_secret is provided, both must be.'
+        end
+        unless RESPONSE_TYPES.include?(config[:response_type].to_sym)
+          raise BrowseEverything::InitializationError, "Amazon S3 driver: Valid response types: #{RESPONSE_TYPES.join(',')}"
+        end
         return if CONFIG_KEYS.all? { |key| config[key].present? }
         raise BrowseEverything::InitializationError, "Amazon S3 driver requires #{CONFIG_KEYS.join(',')}"
       end
 
+      # @return [Array<BrowseEverything::FileEntry>]
+      # Appends / to the path before querying S3
       def contents(path = '')
         path = File.join(path, '') unless path.empty?
-        result = []
-        listing = client.list_objects(bucket: config[:bucket], delimiter: '/', prefix: path)
-        unless path.empty?
-          result << BrowseEverything::FileEntry.new(
-            Pathname(path).join('..'),
-            '', '..', 0, Time.current, true
-          )
-        end
+        init_entries(path)
+        generate_listing(path)
+        sort_entries
+      end
+
+      def generate_listing(path)
+        listing = client.list_objects(bucket: config[:bucket], delimiter: '/', prefix: full_path(path))
+        add_directories(listing)
+        add_files(listing, path)
+      end
+
+      def add_directories(listing)
         listing.common_prefixes.each do |prefix|
-          result << entry_for(prefix.prefix, 0, Time.current, true)
+          entries << entry_for(from_base(prefix.prefix), 0, Time.current, true)
         end
-        listing.contents.reject { |entry| entry.key == path }.each do |entry|
-          result << entry_for(entry.key, entry.size, entry.last_modified, false)
+      end
+
+      def add_files(listing, path)
+        listing.contents.each do |entry|
+          key = from_base(entry.key)
+          unless strip(key) == strip(path)
+            entries << entry_for(key, entry.size, entry.last_modified, false)
+          end
         end
-        result.sort do |a, b|
+      end
+
+      def sort_entries
+        entries.sort do |a, b|
           if b.container?
             a.container? ? a.name.downcase <=> b.name.downcase : 1
           else
@@ -45,28 +73,34 @@ module BrowseEverything
         end
       end
 
+      def init_entries(path)
+        @entries = if path.empty?
+                     []
+                   else
+                     [BrowseEverything::FileEntry.new(Pathname(path).join('..').to_s, '', '..',
+                                                      0, Time.current, true)]
+                   end
+      end
+
       def entry_for(name, size, date, dir)
         BrowseEverything::FileEntry.new(name, [key, name].join(':'), File.basename(name), size, date, dir)
       end
 
       def details(path)
-        entry = client.head_object(path)
+        entry = client.head_object(full_path(path))
         BrowseEverything::FileEntry.new(
-          entry.key,
-          [key, entry.key].join(':'),
-          File.basename(entry.key),
-          entry.size,
-          entry.last_modified,
-          false
+          entry.key, [key, entry.key].join(':'),
+          File.basename(entry.key), entry.size,
+          entry.last_modified, false
         )
       end
 
       def link_for(path)
-        obj = bucket.object(path)
-        if config[:signed_url]
-          obj.presigned_url(:get, expires_in: 14400)
-        else
-          obj.public_url
+        obj = bucket.object(full_path(path))
+        case config[:response_type].to_sym
+        when :signed_url then obj.presigned_url(:get, expires_in: 14400)
+        when :public_url then obj.public_url
+        when :s3_uri     then "s3://#{obj.bucket_name}/#{obj.key}"
         end
       end
 
@@ -79,8 +113,29 @@ module BrowseEverything
       end
 
       def client
-        @client ||= Aws::S3::Client.new(credentials: Aws::Credentials.new(config[:app_key], config[:app_secret]), region: config[:region])
+        @client ||= Aws::S3::Client.new(aws_config)
       end
+
+      private
+
+        def strip(path)
+          path.sub %r{^/?(.+?)/?$}, '\1'
+        end
+
+        def from_base(key)
+          Pathname.new(key).relative_path_from(Pathname.new(config[:base].to_s)).to_s
+        end
+
+        def full_path(path)
+          config[:base].present? ? File.join(config[:base], path) : path
+        end
+
+        def aws_config
+          result = {}
+          result[:credentials] = Aws::Credentials.new(config[:app_key], config[:app_secret]) if config[:app_key].present?
+          result[:region] = config[:region] if config.key?(:region)
+          result
+        end
     end
   end
 end

data/lib/browse_everything/driver/sky_drive.rb

@@ -100,26 +100,26 @@ module BrowseEverything
 
       private
 
-      def oauth_client
-        Skydrive::Oauth::Client.new(config[:client_id], config[:client_secret], callback.to_s, 'wl.skydrive')
-        # TODO: error checking here
-      end
+        def oauth_client
+          Skydrive::Oauth::Client.new(config[:client_id], config[:client_secret], callback.to_s, 'wl.skydrive')
+          # TODO: error checking here
+        end
 
-      def rehydrate_token
-        return @rehydrate_token if @rehydrate_token
-        token_str = @token[:token]
-        token_expires = @token[:expires_at]
-        Rails.logger.warn "\n\n Rehydrating: #{@token} #{token_str} #{token_expires}"
-        @rehydrate_token = oauth_client.get_access_token_from_hash(token_str, expires_at: token_expires)
-      end
+        def rehydrate_token
+          return @rehydrate_token if @rehydrate_token
+          token_str = @token[:token]
+          token_expires = @token[:expires_at]
+          Rails.logger.warn "\n\n Rehydrating: #{@token} #{token_str} #{token_expires}"
+          @rehydrate_token = oauth_client.get_access_token_from_hash(token_str, expires_at: token_expires)
+        end
 
-      def safe_id(id)
-        id.tr('.', '-')
-      end
+        def safe_id(id)
+          id.tr('.', '-')
+        end
 
-      def real_id(id)
-        id.tr('-', '.')
-      end
+        def real_id(id)
+          id.tr('-', '.')
+        end
     end
   end
 end

data/lib/browse_everything/version.rb

@@ -1,3 +1,3 @@
 module BrowseEverything
-  VERSION = '0.12.0'.freeze
+  VERSION = '0.13.0'.freeze
 end

data/lib/generators/browse_everything/templates/browse_everything_providers.yml.example

@@ -12,11 +12,12 @@
 #   :client_id: YOUR_GOOGLE_API_CLIENT_ID
 #   :client_secret: YOUR_GOOGLE_API_CLIENT_SECRET
 # s3:
-#   :app_key: YOUR_AWS_S3_KEY
-#   :app_secret: YOUR_AWS_S3_SECRET
 #   :bucket: YOUR_AWS_S3_BUCKET
-#   :region: YOUR_AWS_S3_REGION # default: us-east-1
-#   :signed_url: true # set to false for public urls
+#   :response_type: :signed_url # set to :public_url for public urls or :s3_uri for an s3://BUCKET/KEY uri
+#   :app_key: YOUR_AWS_S3_KEY       # :app_key, :app_secret, and :region can be specified
+#   :app_secret: YOUR_AWS_S3_SECRET # explicitly here, or left out to use system-configured
+#   :region: YOUR_AWS_S3_REGION     # defaults.
+#   See https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/
 # sky_drive:
 #   :client_id: YOUR_MS_LIVE_CONNECT_CLIENT_ID
 #   :client_secret: YOUR_MS_LIVE_CONNECT_CLIENT_SECRET