aspera-cli 4.12.0 → 4.14.0

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

@@ -11,11 +11,9 @@ module Aspera
         private_constant :DEFAULT_FILTER_AGE_SECONDS
         def initialize(env)
           super(env)
-          options.add_opt_date(:filter_from, 'only after date')
-          options.add_opt_date(:filter_to, 'only before date')
           time_now = Time.now
-          options.set_option(:filter_from, Manager.time_to_string(time_now - DEFAULT_FILTER_AGE_SECONDS))
-          options.set_option(:filter_to, Manager.time_to_string(time_now))
+          options.declare(:filter_from, 'Only after date', values: :date, default: Manager.time_to_string(time_now - DEFAULT_FILTER_AGE_SECONDS))
+          options.declare(:filter_to, 'Only before date', values: :date, default: Manager.time_to_string(time_now))
           options.parse_options!
         end
 
@@ -54,8 +52,8 @@ module Aspera
                 return {
                   type:   :object_list,
                   data:   api_console.read('transfers', {
-                    'from' => options.get_option(:filter_from, is_type: :mandatory),
-                    'to'   => options.get_option(:filter_to, is_type: :mandatory)
+                    'from' => options.get_option(:filter_from, mandatory: true),
+                    'to'   => options.get_option(:filter_to, mandatory: true)
                   })[:data],
                   fields: %w[id contact name status]}
               end

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

@@ -11,14 +11,13 @@ module Aspera
         def initialize(env)
           super(env)
           @service_creds = nil
-          options.add_opt_simple(:bucket, 'Bucket name')
-          options.add_opt_simple(:endpoint, 'Storage endpoint url')
-          options.add_opt_simple(:apikey, 'Storage API key')
-          options.add_opt_simple(:crn, 'Resource instance id')
-          options.add_opt_simple(:service_credentials, 'IBM Cloud service credentials (Hash)')
-          options.add_opt_simple(:region, 'Storage region')
-          options.add_opt_simple(:identity, "Authentication url (#{CosNode::IBM_CLOUD_TOKEN_URL})")
-          options.set_option(:identity, CosNode::IBM_CLOUD_TOKEN_URL)
+          options.declare(:bucket, 'Bucket name')
+          options.declare(:endpoint, 'Storage endpoint url')
+          options.declare(:apikey, 'Storage API key')
+          options.declare(:crn, 'Resource instance id')
+          options.declare(:service_credentials, 'IBM Cloud service credentials', types: Hash)
+          options.declare(:region, 'Storage region')
+          options.declare(:identity, "Authentication url (#{CosNode::IBM_CLOUD_TOKEN_URL})", default: CosNode::IBM_CLOUD_TOKEN_URL)
           options.parse_options!
         end
 
@@ -28,22 +27,22 @@ module Aspera
           command = options.get_next_command(ACTIONS)
           case command
           when :node
-            bucket_name = options.get_option(:bucket, is_type: :mandatory)
+            bucket_name = options.get_option(:bucket, mandatory: true)
             # get service credentials, Hash, e.g. @json:@file:...
             service_credentials = options.get_option(:service_credentials)
             storage_endpoint = options.get_option(:endpoint)
             raise CliBadArgument, 'one of: endpoint or service_credentials is required' if service_credentials.nil? && storage_endpoint.nil?
             raise CliBadArgument, 'endpoint and service_credentials are mutually exclusive' unless service_credentials.nil? || storage_endpoint.nil?
             if service_credentials.nil?
-              service_api_key = options.get_option(:apikey, is_type: :mandatory)
-              instance_id = options.get_option(:crn, is_type: :mandatory)
+              service_api_key = options.get_option(:apikey, mandatory: true)
+              instance_id = options.get_option(:crn, mandatory: true)
             else
-              params = CosNode.parameters_from_svc_creds(service_credentials, options.get_option(:region, is_type: :mandatory))
+              params = CosNode.parameters_from_svc_creds(service_credentials, options.get_option(:region, mandatory: true))
               storage_endpoint = params[:storage_endpoint]
               service_api_key = params[:service_api_key]
               instance_id = params[:instance_id]
             end
-            api_node = CosNode.new(bucket_name, storage_endpoint, instance_id, service_api_key, options.get_option(:identity, is_type: :mandatory))
+            api_node = CosNode.new(bucket_name, storage_endpoint, instance_id, service_api_key, options.get_option(:identity, mandatory: true))
             node_plugin = Node.new(@agents.merge(skip_basic_auth_options: true, node_api: api_node))
             command = options.get_next_command(Node::COMMANDS_COS)
             return node_plugin.execute_action(command)

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

@@ -102,13 +102,12 @@ module Aspera
           @api_v3 = nil
           @api_v4 = nil
           super(env)
-          options.add_opt_simple(:link, 'public link for specific operation')
-          options.add_opt_simple(:delivery_info, 'package delivery information (extended value)')
-          options.add_opt_simple(:source_name, 'create package from remote source (by name)')
-          options.add_opt_simple(:storage, 'Faspex local storage definition')
-          options.add_opt_simple(:recipient, 'use if recipient is a dropbox (with *)')
-          options.add_opt_list(:box, ATOM_MAILBOXES, 'package box')
-          options.set_option(:box, :inbox)
+          options.declare(:link, 'Public link for specific operation')
+          options.declare(:delivery_info, 'Package delivery information', types: Hash)
+          options.declare(:source_name, 'Create package from remote source (by name)')
+          options.declare(:storage, 'Faspex local storage definition')
+          options.declare(:recipient, 'Use if recipient is a dropbox (with *)')
+          options.declare(:box, 'Package box', values: ATOM_MAILBOXES, default: :inbox)
           options.parse_options!
         end
 
@@ -121,13 +120,13 @@ module Aspera
 
         def api_v4
           if @api_v4.nil?
-            faspex_api_base = options.get_option(:url, is_type: :mandatory)
+            faspex_api_base = options.get_option(:url, mandatory: true)
             @api_v4 = Rest.new({
               base_url: faspex_api_base + '/api',
               auth:     {
                 type:         :oauth2,
                 base_url:     faspex_api_base + '/auth/oauth2',
-                auth:         {type: :basic, username: options.get_option(:username, is_type: :mandatory), password: options.get_option(:password, is_type: :mandatory)},
+                auth:         {type: :basic, username: options.get_option(:username, mandatory: true), password: options.get_option(:password, mandatory: true)},
                 grant_method: :generic,
                 generic:      {grant_type: 'password'},
                 scope:        'admin'
@@ -138,11 +137,11 @@ module Aspera
 
         # query supports : {"startIndex":10,"count":1,"page":109,"max":2,"pmax":1}
         def mailbox_filtered_entries(stop_at_id: nil)
-          recipient_names = [options.get_option(:recipient) || options.get_option(:username, is_type: :mandatory)]
+          recipient_names = [options.get_option(:recipient) || options.get_option(:username, mandatory: true)]
           # some workgroup messages have no star in recipient name
           recipient_names.push(recipient_names.first[1..-1]) if recipient_names.first.start_with?('*')
           # mailbox is in ATOM_MAILBOXES
-          mailbox = options.get_option(:box, is_type: :mandatory)
+          mailbox = options.get_option(:box, mandatory: true)
           # parameters
           mailbox_query = options.get_option(:query)
           max_items = nil
@@ -170,6 +169,7 @@ module Aspera
             stop_condition = false
             # results will be sorted in reverse id
             items.reverse_each do |package|
+              # create the package id, based on recipient's box
               package[PACKAGE_MATCH_FIELD] =
                 case mailbox
                 when :inbox, :archive
@@ -180,7 +180,7 @@ module Aspera
                 end
               # if we look for a specific package
               stop_condition = true if !stop_at_id.nil? && stop_at_id.eql?(package[PACKAGE_MATCH_FIELD])
-              # keep only those for the specified recipient,
+              # keep only those for the specified recipient
               result.push(package) unless package[PACKAGE_MATCH_FIELD].nil?
             end
             break if stop_condition
@@ -264,7 +264,7 @@ module Aspera
                 textify: lambda {|table_data|Faspex.textify_package_list(table_data)}
               }
             when :send
-              delivery_info = options.get_option(:delivery_info, is_type: :mandatory)
+              delivery_info = options.get_option(:delivery_info, mandatory: true)
               raise CliBadArgument, 'delivery_info must be hash, refer to doc' unless delivery_info.is_a?(Hash)
               # actual parameter to faspex API
               package_create_params = {'delivery' => delivery_info}
@@ -307,15 +307,15 @@ module Aspera
               skip_ids_persistency = nil
               case link_url
               when nil # usual case: no link
-                if options.get_option(:once_only, is_type: :mandatory)
+                if options.get_option(:once_only, mandatory: true)
                   skip_ids_persistency = PersistencyActionOnce.new(
                     manager: @agents[:persistency],
                     data:    skip_ids_data,
                     id:      IdGenerator.from_list([
                       'faspex_recv',
-                      options.get_option(:url, is_type: :mandatory),
-                      options.get_option(:username, is_type: :mandatory),
-                      options.get_option(:box, is_type: :mandatory).to_s
+                      options.get_option(:url, mandatory: true),
+                      options.get_option(:username, mandatory: true),
+                      options.get_option(:box, mandatory: true).to_s
                     ]))
                 end
                 # get command line parameters
@@ -331,7 +331,7 @@ module Aspera
                 else
                   # TODO: delivery id is the right one if package was receive by workgroup
                   endpoint =
-                    case options.get_option(:box, is_type: :mandatory)
+                    case options.get_option(:box, mandatory: true)
                     when :inbox, :archive then'received'
                     when :sent then 'sent'
                     end
@@ -378,13 +378,13 @@ module Aspera
                   # NOTE: only external users have token in faspe: link !
                   if !transfer_spec.key?('token')
                     sanitized = id_uri[:uri].gsub('&', '&')
-                    xmlpayload =
+                    xml_payload =
                       %Q(<?xml version="1.0" encoding="UTF-8"?><url-list xmlns="http://schemas.asperasoft.com/xml/url-list"><url href="#{sanitized}"/></url-list>)
                     transfer_spec['token'] = api_v3.call({
                       operation:        'POST',
                       subpath:          'issue-token?direction=down',
                       headers:          {'Accept' => 'text/plain', 'Content-Type' => 'application/vnd.aspera.url-list+xml'},
-                      text_body_params: xmlpayload})[:http].body
+                      text_body_params: xml_payload})[:http].body
                   end
                   transfer_spec['direction'] = Fasp::TransferSpec::DIRECTION_RECEIVE
                   statuses = transfer.start(transfer_spec)
@@ -411,7 +411,7 @@ module Aspera
               # get id and name
               source_name = source_ids.first['name']
               # source_id=source_ids.first['id']
-              source_hash = options.get_option(:storage, is_type: :mandatory)
+              source_hash = options.get_option(:storage, mandatory: true)
               # check value of option
               raise CliError, 'storage option must be a Hash' unless source_hash.is_a?(Hash)
               source_hash.each do |name, storage|