aspera-cli 4.24.1 → 4.24.2

data/lib/aspera/cli/plugins/console.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'aspera/cli/basic_auth_plugin'
+require 'aspera/cli/plugins/basic_auth'
 require 'aspera/nagios'
 
 module Aspera
   module Cli
     module Plugins
-      class Console < Cli::BasicAuthPlugin
+      class Console < BasicAuth
         STANDARD_PATH = '/aspera/console'
         DEFAULT_FILTER_AGE_SECONDS = 24 * 3600
         EXPR_RE = /\A(\S+) (\S+) (.*)\z/
@@ -44,20 +44,20 @@ module Aspera
             raise error if error
             return
           end
+        end
 
-          # @param object [Plugin] An instance of this class
-          # @return [Hash] :preset_value, :test_args
-          def wizard(object:)
-            options = object.options
-            return {
-              preset_value: {
-                url:      options.get_option(:url, mandatory: true),
-                username: options.get_option(:username, mandatory: true),
-                password: options.get_option(:password, mandatory: true)
-              },
-              test_args:    'transfer list'
-            }
-          end
+        # @param wizard  [Wizard] The wizard object
+        # @param app_url [Wizard] The wizard object
+        # @return [Hash] :preset_value, :test_args
+        def wizard(wizard, app_url)
+          return {
+            preset_value: {
+              url:      app_url,
+              username: options.get_option(:username, mandatory: true),
+              password: options.get_option(:password, mandatory: true)
+            },
+            test_args:    'transfer list'
+          }
         end
 
         def initialize(**_)

data/lib/aspera/cli/plugins/cos.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'aspera/cli/plugin'
+require 'aspera/cli/plugins/base'
 require 'aspera/cli/plugins/node'
 require 'aspera/api/cos_node'
 require 'aspera/assert'
@@ -8,7 +8,7 @@ require 'aspera/assert'
 module Aspera
   module Cli
     module Plugins
-      class Cos < Cli::Plugin
+      class Cos < Base
         def initialize(**_)
           super
           options.declare(:bucket, 'Bucket name')

data/lib/aspera/cli/plugins/factory.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'aspera/assert'
+require 'aspera/cli/error'
+require 'aspera/environment'
+
+module Aspera
+  module Cli
+    # Instantiate plugin from well-known locations
+    module Plugins
+      class Factory
+        include Singleton
+
+        attr_reader :lookup_folders
+
+        def initialize
+          @lookup_folders = []
+          # information on plugins
+          @plugins = {}
+        end
+
+        # @return list of registered plugins
+        def plugin_list
+          @plugins.keys
+        end
+
+        # add a folder to the list of folders to look for plugins
+        def add_lookup_folder(folder)
+          @lookup_folders.unshift(folder)
+        end
+
+        # find plugins in defined paths
+        def add_plugins_from_lookup_folders
+          @lookup_folders.each do |folder|
+            next unless File.directory?(folder)
+            # TODO: add gem root to load path ? and require short folder ?
+            # $LOAD_PATH.push(folder) if i[:add_path]
+            Dir.entries(folder).each do |source|
+              next unless source.end_with?(Environment::RB_EXT)
+              path = File.join(folder, source)
+              plugin_symbol = File.basename(path, Environment::RB_EXT).to_sym
+              next if IGNORE_PLUGINS.include?(plugin_symbol)
+              req = path.sub(/#{Environment::RB_EXT}$/o, '')
+              Aspera.assert(!@plugins.key?(plugin_symbol), type: :warn){"Plugin already registered: #{plugin_symbol}"}
+              @plugins[plugin_symbol] = {source: path, require_stanza: req}
+            end
+          end
+        end
+
+        # @return path to source file of plugin
+        def plugin_source(plugin_name_sym)
+          Aspera.assert(@plugins.key?(plugin_name_sym), type: NoSuchElement){"plugin not found: #{plugin_name_sym}"}
+          @plugins[plugin_name_sym][:source]
+        end
+
+        # @return Class object for plugin
+        def plugin_class(plugin_name_sym)
+          Aspera.assert(@plugins.key?(plugin_name_sym), type: NoSuchElement){"plugin not found: #{plugin_name_sym}"}
+          require @plugins[plugin_name_sym][:require_stanza]
+          # Module.nesting[1] is Aspera::Cli::Plugins
+          return Object.const_get("#{Module.nesting[1]}::#{plugin_name_sym.to_s.snake_to_capital}")
+        end
+
+        # Create specified plugin
+        # @param plugin_name_sym [Symbol] name of plugin
+        # @param args [Hash] arguments to pass to plugin constructor
+        def create(plugin_name_sym, **args)
+          # TODO: check that ancestor is Plugin?
+          plugin_class(plugin_name_sym).new(**args)
+        end
+
+        IGNORE_PLUGINS = %i[factory base basic_auth oauth]
+        private_constant :IGNORE_PLUGINS
+      end
+    end
+  end
+end

data/lib/aspera/cli/plugins/faspex.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
 # cspell:ignore passcode xrds workgroups dmembership wmembership
-require 'aspera/cli/basic_auth_plugin'
+require 'aspera/cli/plugins/basic_auth'
 require 'aspera/cli/plugins/node'
-require 'aspera/cli/plugins/config'
 require 'aspera/cli/extended_value'
 require 'aspera/cli/special_values'
 require 'aspera/cli/transfer_agent'
@@ -17,12 +16,11 @@ require 'aspera/log'
 require 'aspera/assert'
 require 'xmlsimple'
 require 'json'
-require 'cgi'
 
 module Aspera
   module Cli
     module Plugins
-      class Faspex < Cli::BasicAuthPlugin
+      class Faspex < BasicAuth
         # required hash key for source in config
         KEY_NODE = 'node' # value must be hash with url, username, password
         KEY_PATH = 'path' # value must be same sub-path as in Faspex's node
@@ -74,20 +72,6 @@ module Aspera
             return
           end
 
-          # @param object [Plugin] An instance of this class
-          # @return [Hash] :preset_value, :test_args
-          def wizard(object:)
-            options = object.options
-            return {
-              preset_value: {
-                url:      options.get_option(:url, mandatory: true),
-                username: options.get_option(:username, mandatory: true),
-                password: options.get_option(:password, mandatory: true)
-              },
-              test_args:    'me'
-            }
-          end
-
           # extract elements from faspex public link
           def get_link_data(public_url)
             public_uri = URI.parse(public_url)
@@ -122,6 +106,20 @@ module Aspera
           end
         end
 
+        # @param wizard  [Wizard] The wizard object
+        # @param app_url [Wizard] The wizard object
+        # @return [Hash] :preset_value, :test_args
+        def wizard(wizard, app_url)
+          return {
+            preset_value: {
+              url:      app_url,
+              username: options.get_option(:username, mandatory: true),
+              password: options.get_option(:password, mandatory: true)
+            },
+            test_args:    'me'
+          }
+        end
+
         def initialize(**_)
           super
           @api_v3 = nil
@@ -227,8 +225,7 @@ module Aspera
             # no next link
             break if link.nil?
             # replace parameters with the ones from next link
-            params = CGI.parse(URI.parse(link['href']).query)
-            mailbox_query = params.keys.each_with_object({}){ |i, m| m[i] = params[i].first}
+            mailbox_query = Rest.query_to_h(URI.parse(link['href']).query)
             Log.log.debug{"query: #{mailbox_query}"}
             break if !max_pages.nil? && (mailbox_query['page'].to_i > max_pages)
           end