aspera-cli 4.27.1 → 4.27.3

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

@@ -22,7 +22,7 @@ module Aspera
             error = nil
             urls.each do |base_url|
               next unless base_url.start_with?('https://')
-              api = Rest.new(base_url: base_url, redirect_max: 2)
+              api = Rest::Client.new(base_url: base_url, redirect_max: 2)
               test_endpoint = 'login'
               http = api.call(
                 operation: 'GET',
@@ -67,27 +67,68 @@ module Aspera
           }
         end
 
-        def initialize(**_)
-          super
-        end
-
         # --- DSL ---
 
-        command :health,   description: 'Check Console API health', setup: :setup_api
-        command :transfer, description: 'Manage transfers',         setup: :setup_api
+        command :health,   description: 'Check Console API health'
+        command :transfer, description: 'Manage transfers'
+        command :endpoint, description: 'Manage endpoints'
+        command :ssh_key,  description: 'Manage SSH keys'
+        command :admin,    description: 'Administer Console'
 
         commands_under :transfer do
           command :current, description: 'Manage current transfers'
           command :smart,   description: 'Manage smart transfers'
+          command :queue,   description: 'Manage transfers of a queue',
+            arguments: [{name: :queue_id, type: :identifier}]
+        end
+
+        commands_under :endpoint do
+          command :list, description: operation_description(:list, 'endpoint'),
+            action: ->(**) { Result::ObjectList.new(api_console.read('endpoints')) }
+        end
+
+        # Payload is not documented in the API: optional
+        # command => name of argument
+        ADMIN_UPDATES = {email_server_update: :email_server, nodeapi_credentials_update: :credentials}.freeze
+        private_constant :ADMIN_UPDATES
+
+        commands_under :admin do
+          command :email_server_update,        description: 'Update email server configuration',
+            arguments: [{name: ADMIN_UPDATES[:email_server_update], type: Hash, mandatory: false, default: {}}]
+          command :nodeapi_credentials_update, description: 'Update Node API credentials',
+            arguments: [{name: ADMIN_UPDATES[:nodeapi_credentials_update], type: Hash, mandatory: false, default: {}}]
+        end
+
+        # POST <verb>
+        ADMIN_UPDATES.each do |verb, arg|
+          define_action_method([:admin, verb]) do |**kwargs|
+            api_console.create(verb.to_s, kwargs.fetch(arg))
+            Result::Success.new
+          end
+        end
+
+        commands_under :ssh_key do
+          command :list, description: operation_description(:list, 'SSH key'),
+            action: ->(**) { Result::ObjectList.new(api_console.read('ssh_keys')) }
         end
 
         commands_under %i[transfer current] do
           command :list,          description: 'List current transfers'
+          command :submit,        description: 'Submit a simple transfer',
+            arguments: [{name: :transfer, type: Hash, schema: Schema::Registry.req_body(Schema::Registry::CONSOLE, 'transfers.post')}],
+            action: ->(transfer:, **) { Result::SingleObject.new(api_console.create('transfers', transfer)) }
           command :show,          description: 'Show a transfer',
             arguments: [{name: :transfer_id, type: :identifier}],
-            action: ->(api_console:, transfer_id:, **) { Result::SingleObject.new(api_console.read("transfers/#{transfer_id}")) }
-          command :files,         description: 'List files in a transfer',
-            arguments: [{name: :transfer_id, type: :identifier}]
+            action: ->(transfer_id:, **) { Result::SingleObject.new(api_console.read("transfers/#{transfer_id}")) }
+          command(
+            :files, description: 'List files in a transfer',
+            arguments: [{name: :transfer_id, type: :identifier}],
+            action: lambda do |transfer_id:, **|
+              query = query_read_delete(default: {})
+              query['limit'] ||= 100
+              Result::ObjectList.new(api_console.read("transfers/#{transfer_id}/files", query))
+            end
+          )
           command :start,         description: 'Start a transfer',
             arguments: [{name: :transfer_id, type: :identifier}]
           command :pause,         description: 'Pause a transfer',
@@ -97,44 +138,77 @@ module Aspera
           command :resume,        description: 'Resume a transfer',
             arguments: [{name: :transfer_id, type: :identifier}]
           command :rerun,         description: 'Rerun a transfer',
-            arguments: [{name: :transfer_id, type: :identifier}]
+            arguments: [{name: :transfer_id, type: :identifier}],
+            action: ->(transfer_id:, **) { Result::SingleObject.new(api_console.create("transfers/#{transfer_id}/rerun", {})) }
           command :change_rate,   description: 'Change transfer rate',
-            arguments: [{name: :transfer_id, type: :identifier}]
+            arguments: [{name: :transfer_id, type: :identifier},
+                        {name: :rate, type: Hash, schema: Schema::Registry.req_body(Schema::Registry::CONSOLE, 'transfers/{id}/change_rate.put')}]
           command :change_policy, description: 'Change transfer policy',
+            arguments: [{name: :transfer_id, type: :identifier},
+                        {name: :policy, type: Hash, schema: Schema::Registry.req_body(Schema::Registry::CONSOLE, 'transfers/{id}/change_policy.put')}]
+        end
+
+        commands_under %i[transfer queue] do
+          command :list,          description: 'List transfers in queue, frontmost first',
+            action: ->(queue_id:, **) { Result::ObjectList.new(api_console.read("queues/#{queue_id}/items")) }
+          command :move_forwards, description: 'Move transfer forwards in queue',
             arguments: [{name: :transfer_id, type: :identifier}]
-          command :move_forwards, description: 'Move transfer forwards',
-            arguments: [{name: :transfer_id, type: :identifier}]
-          command :move_back,     description: 'Move transfer backwards',
+          command :move_back,     description: 'Move transfer backwards in queue',
             arguments: [{name: :transfer_id, type: :identifier}]
         end
 
+        # PUT queues/<queue_id>/items/<id>/<verb>
+        %i[move_forwards move_back].each do |verb|
+          define_action_method([:transfer, :queue, verb]) do |queue_id:, transfer_id:, **|
+            Result::SingleObject.new(api_console.update("queues/#{queue_id}/items/#{transfer_id}/#{verb}", {}))
+          end
+        end
+
         # Generate one handler per transfer/current action.
         # Convention: action_transfer_current_<verb>
-        # All share the same REST pattern: PATCH transfers/<id>/<verb>.
-        %i[start pause cancel resume rerun change_rate change_policy move_forwards move_back].each do |verb|
-          define_action_method([:transfer, :current, verb]) do |api_console:, transfer_id:, **|
-            Result::SingleObject.new(api_console.update("transfers/#{transfer_id}/#{verb}", query_read_delete))
+        # All share the same REST pattern: PUT transfers/<id>/<verb>.
+        %i[start pause cancel resume].each do |verb|
+          define_action_method([:transfer, :current, verb]) do |transfer_id:, **|
+            Result::SingleObject.new(api_console.update("transfers/#{transfer_id}/#{verb}", {}))
+          end
+        end
+
+        # PUT transfers/<id>/<verb> with request body
+        {change_rate: :rate, change_policy: :policy}.each do |verb, arg|
+          define_action_method([:transfer, :current, verb]) do |transfer_id:, **kwargs|
+            Result::SingleObject.new(api_console.update("transfers/#{transfer_id}/#{verb}", kwargs.fetch(arg)))
           end
         end
 
         commands_under %i[transfer smart] do
-          command :list,   description: 'List smart transfers', action: ->(api_console:) { Result::ObjectList.new(api_console.read('smart_transfers')) }
+          command :list,   description: 'List smart transfers', action: ->(**) { Result::ObjectList.new(api_console.read('smart_transfers')) }
           command :submit, description: 'Submit a smart transfer',
-            arguments: [{name: :smart_id}, {name: :transfer_params, type: Hash}]
+            arguments: [{name: :smart_id, type: :identifier}, {name: :transfer, type: Hash, schema: Schema::Registry.req_body(Schema::Registry::CONSOLE, 'smart_transfers/{id}.post')}],
+            action: ->(smart_id:, transfer:, **) { Result::ObjectList.new(api_console.create("smart_transfers/#{smart_id}", transfer)) }
+          command :pause,  description: 'Pause a smart transfer',
+            arguments: [{name: :smart_id, type: :identifier}],
+            action: ->(smart_id:, **) { Result::SingleObject.new(api_console.update("smart_transfers/#{smart_id}/pause", {})) }
         end
 
-        # --- setup ---
+        # --- API ---
 
-        # Build the Console REST API.
-        # @return [Hash] ctx with :api_console
-        def setup_api(**)
-          {api_console: basic_auth_api('api')}
+        # Console REST API, built from CLI options on first use.
+        # @return [Rest::Client]
+        def api_console
+          @api_console ||= basic_auth_api('api')
         end
 
         # --- health ---
 
-        def action_health(api_console:)
+        def action_health(**)
           nagios = Nagios.new
+          begin
+            # Unauthenticated, outside of the API prefix
+            Rest::Client.new(base_url: options.get_option(:url, mandatory: true)).read('health/up')
+            nagios.add_ok('console process', 'up')
+          rescue StandardError => e
+            nagios.add_critical('console process', e.to_s)
+          end
           begin
             api_console.read('ssh_keys')
             nagios.add_ok('console api', 'accessible')
@@ -146,7 +220,7 @@ module Aspera
 
         # --- transfer current ---
 
-        def action_transfer_current_list(api_console:)
+        def action_transfer_current_list(**)
           query = query_read_delete(default: {})
           if query['from'].nil? && query['to'].nil?
             time_now = Time.now
@@ -160,18 +234,8 @@ module Aspera
           )
         end
 
-        def action_transfer_current_files(api_console:, transfer_id:, **)
-          query = query_read_delete(default: {})
-          query['limit'] ||= 100
-          Result::ObjectList.new(api_console.read("transfers/#{transfer_id}/files", query))
-        end
-
         # --- transfer smart ---
 
-        def action_transfer_smart_submit(api_console:, smart_id:, transfer_params:, **)
-          Result::ObjectList.new(api_console.create("smart_transfers/#{smart_id}", transfer_params))
-        end
-
         private
 
         def parse_extended_filter(filter, query)

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

@@ -11,13 +11,8 @@ module Aspera
       class Cos < Base
         application_name 'IBM Cloud Object Storage'
 
-        command :node, description: 'Execute COS node commands', setup: :setup_cos_node
-
-        commands_under :node do
-          Node::COMMANDS_COS.each do |cmd|
-            command cmd, description: "Node #{cmd} command"
-          end
-        end
+        command :node, description: 'Execute COS node commands',
+          mount: {plugin: Node, instance: :cos_node_plugin, only: Node::COMMANDS_COS}
 
         option :bucket,              description: 'Bucket name'
         option :endpoint,            description: 'Storage endpoint (URL)'
@@ -29,14 +24,9 @@ module Aspera
 
         use_options Node
 
-        def initialize(**_)
-          super
-          options.parse_options!
-        end
-
-        # Build the COS Node API and plugin from CLI options.
-        # @return [Hash] context hash containing :node_plugin
-        def setup_cos_node(**)
+        # node - mount target: build the COS Node API and plugin from CLI options.
+        # @return [Node] Node plugin instance on the COS bucket
+        def cos_node_plugin(**)
           # get service credentials, Hash, e.g. @json:@file:...
           service_credentials = options.get_option(:service_credentials)
           cos_node_params = {
@@ -53,14 +43,7 @@ module Aspera
             cos_node_params.merge!(Api::CosNode.parameters_from_svc_credentials(service_credentials, options.get_option(:region, mandatory: true)))
           end
           api_node = Api::CosNode.new(**cos_node_params)
-          {node_plugin: Node.new(context: context, api: api_node)}
-        end
-
-        # One handler per COMMANDS_COS command - delegates to the Node plugin's dispatch_v3_command.
-        Node::COMMANDS_COS.each do |cmd|
-          define_action_method([:node, cmd]) do |node_plugin:|
-            node_plugin.dispatch_v3_command(cmd)
-          end
+          Node.new(context: context, api: api_node)
         end
       end
     end

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

@@ -4,6 +4,7 @@ require 'singleton'
 require 'aspera/assert'
 require 'aspera/cli/error'
 require 'aspera/environment'
+require 'aspera/string_ext'
 
 module Aspera
   module Cli
@@ -29,7 +30,9 @@ module Aspera
         end
 
         # add a folder to the list of folders to look for plugins
+        # (absolute, as `require` resolves a relative path against $LOAD_PATH)
         def add_lookup_folder(folder)
+          folder = File.expand_path(folder)
           @lookup_folders.unshift(folder) unless @lookup_folders.include?(folder)
         end