aspera-cli 4.24.1 → 4.25.0.pre

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/
@@ -22,17 +22,18 @@ module Aspera
               next unless base_url.start_with?('https://')
               api = Rest.new(base_url: base_url, redirect_max: 2)
               test_endpoint = 'login'
-              test_page = api.call(
+              http = api.call(
                 operation: 'GET',
                 subpath:   test_endpoint,
-                query:     {local: true}
+                query:     {local: true},
+                ret:       :resp
               )
-              next unless test_page[:http].body.include?('Aspera Console')
+              next unless http.body.include?('Aspera Console')
               version = 'unknown'
-              if (m = test_page[:http].body.match(/\(v([1-9]\..*)\)/))
+              if (m = http.body.match(/\(v([1-9]\..*)\)/))
                 version = m[1]
               end
-              url = test_page[:http].uri.to_s
+              url = http.uri.to_s
               return {
                 version: version,
                 url:     url[0..url.index(test_endpoint) - 2]
@@ -45,21 +46,25 @@ 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:    'transfer list'
-            }
+          def time_to_string(time)
+            return time.strftime('%Y-%m-%d %H:%M:%S')
           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:    'transfer list'
+          }
+        end
+
         def initialize(**_)
           super
         end
@@ -91,7 +96,7 @@ module Aspera
             rescue StandardError => e
               nagios.add_critical('console api', e.to_s)
             end
-            return nagios.result
+            Main.result_object_list(nagios.status_list)
           when :transfer
             command = options.get_next_command(%i[current smart])
             case command
@@ -113,8 +118,8 @@ module Aspera
                 query = query_read_delete(default: {})
                 if query['from'].nil? && query['to'].nil?
                   time_now = Time.now
-                  query['from'] = Manager.time_to_string(time_now - DEFAULT_FILTER_AGE_SECONDS)
-                  query['to'] = Manager.time_to_string(time_now)
+                  query['from'] = self.class.time_to_string(time_now - DEFAULT_FILTER_AGE_SECONDS)
+                  query['to'] = self.class.time_to_string(time_now)
                 end
                 if (filter = query.delete('filter'))
                   parse_extended_filter(filter, query)

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,14 +8,14 @@ require 'aspera/assert'
 module Aspera
   module Cli
     module Plugins
-      class Cos < Cli::Plugin
+      class Cos < Base
         def initialize(**_)
           super
           options.declare(:bucket, 'Bucket name')
           options.declare(:endpoint, 'Storage endpoint (URL)')
           options.declare(:apikey, 'Storage API key')
           options.declare(:crn, 'Resource instance id (CRN)')
-          options.declare(:service_credentials, 'IBM Cloud service credentials', types: Hash)
+          options.declare(:service_credentials, 'IBM Cloud service credentials', allowed: [Hash, NilClass])
           options.declare(:region, 'Storage region')
           options.declare(:identity, "Authentication URL (#{Api::CosNode::IBM_CLOUD_TOKEN_URL})", default: Api::CosNode::IBM_CLOUD_TOKEN_URL)
           options.parse_options!

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
@@ -49,22 +47,23 @@ module Aspera
             urls.each do |base_url|
               next unless base_url.start_with?('https://')
               api = Rest.new(base_url: base_url, redirect_max: 1)
-              result = api.call(
+              http = api.call(
                 operation:        'POST',
                 headers:          {
                   'Content-type' => Rest::MIME_TEXT,
                   'Accept'       => 'application/xrds+xml'
-                }
+                },
+                ret: :resp
               )
               # 4.x
-              next unless result[:http].body.start_with?('<?xml')
-              res_s = XmlSimple.xml_in(result[:http].body, {'ForceArray' => false})
-              Log.log.debug{"version: #{result[:http][HEADER_FASPEX_VERSION]}"}
+              next unless http.body.start_with?('<?xml')
+              res_s = XmlSimple.xml_in(http.body, {'ForceArray' => false})
+              Log.log.debug{"version: #{http[HEADER_FASPEX_VERSION]}"}
               version = res_s['XRD']['application']['version']
               # take redirect if any
               return {
                 version: version,
-                url:     result[:http].uri.to_s
+                url:     http.uri.to_s
               }
             rescue StandardError => e
               error = e
@@ -74,20 +73,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,16 +107,30 @@ 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
           @api_v4 = nil
           options.declare(:link, 'Public link for specific operation')
-          options.declare(:delivery_info, 'Package delivery information', types: Hash)
+          options.declare(:delivery_info, 'Package delivery information', allowed: Hash)
           options.declare(:remote_source, 'Remote source for package send (id or %name:)')
           options.declare(:storage, 'Faspex local storage definition (for browsing source)')
           options.declare(:recipient, 'Use if recipient is a dropbox (with *)')
-          options.declare(:box, 'Package box', values: ATOM_MAILBOXES, default: :inbox)
+          options.declare(:box, 'Package box', allowed: ATOM_MAILBOXES, default: :inbox)
           options.parse_options!
         end
 
@@ -186,8 +185,9 @@ module Aspera
               operation: 'GET',
               subpath:   "#{mailbox}.atom",
               headers:   {'Accept' => 'application/xml'},
-              query:     mailbox_query
-            )[:http].body
+              query:     mailbox_query,
+              ret:       :resp
+            ).body
             box_data = XmlSimple.xml_in(atom_xml, {'ForceArray' => %w[entry field link to]})
             Log.dump(:box_data, box_data)
             items = box_data.key?('entry') ? box_data['entry'] : []
@@ -227,8 +227,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
@@ -254,8 +253,9 @@ module Aspera
             subpath:      create_path,
             content_type: Rest::MIME_JSON,
             body:         package_create_params,
-            headers:      {'Accept' => 'text/javascript'}
-          )[:http].body
+            headers:      {'Accept' => 'text/javascript'},
+            ret:          :resp
+          ).body
           # get arguments of function call
           package_creation_data.delete!("\n") # one line
           package_creation_data.gsub!(/^[^"]+\("\{/, '{') # delete header
@@ -283,7 +283,7 @@ module Aspera
             rescue StandardError => e
               nagios.add_critical('faspex api', e.to_s)
             end
-            return nagios.result
+            Main.result_object_list(nagios.status_list)
           when :package
             command_pkg = options.get_next_command(%i[send receive list show], aliases: {recv: :receive})
             case command_pkg
@@ -303,10 +303,11 @@ module Aspera
                 delivery_info['sources'] ||= [{'paths' => []}]
                 first_source = delivery_info['sources'].first
                 first_source['paths'].concat(transfer.source_list)
-                source_id = instance_identifier(as_option: :remote_source) do |field, value|
-                  Aspera.assert(field.eql?('name'), type: Cli::BadArgument){'only name as selector, or give id'}
+                source_id = options.get_option(:remote_source)
+                if source_id && (m = Base.percent_selector(source_id))
+                  Aspera.assert(m[:field].eql?('name'), type: Cli::BadArgument){'only name as selector, or give id'}
                   source_list = api_v3.read('source_shares')['items']
-                  self.class.get_source_id_by_name(value, source_list)
+                  source_id = self.class.get_source_id_by_name(m[:value], source_list)
                 end
                 first_source['id'] = source_id.to_i unless source_id.nil?
                 pkg_created = api_v3.create('send', package_create_params)
@@ -365,7 +366,7 @@ module Aspera
                     when :inbox, :archive then'received'
                     when :sent then 'sent'
                     end
-                  entry_xml = api_v3.call(operation: 'GET', subpath: "#{endpoint}/#{delivery_id}", headers: {'Accept' => 'application/xml'})[:http].body
+                  entry_xml = api_v3.call(operation: 'GET', subpath: "#{endpoint}/#{delivery_id}", headers: {'Accept' => 'application/xml'}, ret: :resp).body
                   package_entry = XmlSimple.xml_in(entry_xml, {'ForceArray' => true})
                   pkg_id_uri = [{id: delivery_id, uri: self.class.get_fasp_uri_from_entry(package_entry)}]
                 end
@@ -376,17 +377,18 @@ module Aspera
                 raise Cli::BadArgument, "Pub link is #{link_data[:subpath]}. Expecting #{PUB_LINK_EXTERNAL_MATCH}" if !link_data[:subpath].start_with?(PUB_LINK_EXTERNAL_MATCH)
                 # NOTE: unauthenticated API (authorization is in url params)
                 api_public_link = Rest.new(base_url: link_data[:base_url])
-                package_creation_data = api_public_link.call(
+                pkg_xml = api_public_link.call(
                   operation: 'GET',
                   subpath:   link_data[:subpath],
                   headers:   {'Accept' => 'application/xml'},
-                  query:     {passcode: link_data[:query]['passcode']}
-                )
-                if !package_creation_data[:http].body.start_with?('<?xml ')
+                  query:     {passcode: link_data[:query]['passcode']},
+                  ret:       :resp
+                ).body
+                if !pkg_xml.start_with?('<?xml ')
                   Environment.instance.open_uri(link_url)
                   raise Cli::Error, 'Unexpected response: package not found ?'
                 end
-                package_entry = XmlSimple.xml_in(package_creation_data[:http].body, {'ForceArray' => false})
+                package_entry = XmlSimple.xml_in(pkg_xml, {'ForceArray' => false})
                 Log.dump(:package_entry, package_entry)
                 transfer_uri = self.class.get_fasp_uri_from_entry(package_entry)
                 pkg_id_uri = [{id: package_entry['id'], uri: transfer_uri}]
@@ -415,8 +417,9 @@ module Aspera
                       query:        {'direction' => 'down'},
                       content_type: Rest::MIME_TEXT,
                       body:         xml_payload,
-                      headers:      {'Accept' => Rest::MIME_TEXT, 'Content-Type' => 'application/vnd.aspera.url-list+xml'}
-                    )[:http].body
+                      headers:      {'Accept' => Rest::MIME_TEXT, 'Content-Type' => 'application/vnd.aspera.url-list+xml'},
+                      ret:          :resp
+                    ).body
                   end
                   transfer_spec['direction'] = Transfer::Spec::DIRECTION_RECEIVE
                   statuses = transfer.start(transfer_spec)
@@ -458,7 +461,7 @@ module Aspera
               when :info
                 return Main.result_single_object(source_info)
               when :node
-                node_config = ExtendedValue.instance.evaluate(source_info[KEY_NODE])
+                node_config = ExtendedValue.instance.evaluate(source_info[KEY_NODE], context: 'faspex node')
                 Log.log.debug{"node=#{node_config}"}
                 Aspera.assert_type(node_config, Hash, type: Cli::Error){source_info[KEY_NODE]}
                 api_node = Rest.new(
@@ -522,7 +525,7 @@ module Aspera
             end
             return Main.result_object_list(users)
           when :login_methods
-            login_meths = api_v3.call(operation: 'GET', subpath: 'login/new', headers: {'Accept' => 'application/xrds+xml'})[:http].body
+            login_meths = api_v3.call(operation: 'GET', subpath: 'login/new', headers: {'Accept' => 'application/xrds+xml'}, ret: :resp).body
             login_methods = XmlSimple.xml_in(login_meths, {'ForceArray' => false})
             return Main.result_object_list(login_methods['XRD']['Service'])
           end