aspera-cli 4.18.0 → 4.18.1

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

@@ -5,11 +5,12 @@ require 'aspera/cli/basic_auth_plugin'
 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'
 require 'aspera/transfer/uri'
 require 'aspera/transfer/spec'
 require 'aspera/persistency_action_once'
-require 'aspera/open_application'
+require 'aspera/environment'
 require 'aspera/nagios'
 require 'aspera/id_generator'
 require 'aspera/log'
@@ -353,9 +354,9 @@ module Aspera
                 delivery_id = instance_identifier
                 raise 'empty id' if delivery_id.empty?
                 recipient = options.get_option(:recipient)
-                if delivery_id.eql?(ExtendedValue::ALL)
+                if delivery_id.eql?(SpecialValues::ALL)
                   pkg_id_uri = mailbox_filtered_entries.map{|i|{id: i[PACKAGE_MATCH_FIELD], uri: self.class.get_fasp_uri_from_entry(i, raise_no_link: false)}}
-                elsif delivery_id.eql?(ExtendedValue::INIT)
+                elsif delivery_id.eql?(SpecialValues::INIT)
                   Aspera.assert(skip_ids_persistency){'Only with option once_only'}
                   skip_ids_persistency.data.clear.concat(mailbox_filtered_entries.map{|i|{id: i[PACKAGE_MATCH_FIELD]}})
                   skip_ids_persistency.save
@@ -390,7 +391,7 @@ module Aspera
                   headers:   {'Accept' => 'application/xml'},
                   query:     {passcode: link_data[:query]['passcode']})
                 if !package_creation_data[:http].body.start_with?('<?xml ')
-                  OpenApplication.instance.uri(link_url)
+                  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})

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

@@ -4,6 +4,7 @@
 
 require 'aspera/cli/basic_auth_plugin'
 require 'aspera/cli/extended_value'
+require 'aspera/cli/special_values'
 require 'aspera/persistency_action_once'
 require 'aspera/id_generator'
 require 'aspera/nagios'
@@ -81,7 +82,7 @@ module Aspera
             if options.get_option(:client_id).nil? || options.get_option(:client_secret).nil?
               formatter.display_status('Ask the ascli client id and secret to your Administrator.'.red)
               formatter.display_status("Admin should login to: #{instance_url}")
-              OpenApplication.instance.uri(instance_url)
+              Environment.instance.open_uri(instance_url)
               formatter.display_status('Navigate to: 𓃑  → Admin → Configurations → API clients')
               formatter.display_status('Create an API client with:')
               formatter.display_status('- name: ascli')
@@ -118,7 +119,7 @@ module Aspera
           options.declare(:auth, 'OAuth type of authentication', values: STD_AUTH_TYPES, default: :jwt)
           options.declare(:private_key, 'OAuth JWT RSA private key PEM value (prefix file path with @file:)')
           options.declare(:passphrase, 'OAuth JWT RSA private key passphrase')
-          options.declare(:box, "Package inbox, either shared inbox name or one of: #{API_LIST_MAILBOX_TYPES.join(', ')} or #{ExtendedValue::ALL}", default: 'inbox')
+          options.declare(:box, "Package inbox, either shared inbox name or one of: #{API_LIST_MAILBOX_TYPES.join(', ')} or #{SpecialValues::ALL}", default: 'inbox')
           options.declare(:shared_folder, 'Send package with files from shared folder')
           options.declare(:group_type, 'Type of shared box', values: %i[shared_inboxes workgroups], default: :shared_inboxes)
           options.parse_options!
@@ -304,12 +305,12 @@ module Aspera
 
         # list all packages with optional filter
         def list_packages_with_filter(query: {})
-          filter = options.get_next_argument('filter', mandatory: false, type: Proc, default: ->(_x){true})
+          filter = options.get_next_argument('filter', mandatory: false, validation: Proc, default: ->(_x){true})
           # translate box name to API prefix (with ending slash)
           box = options.get_option(:box)
           real_path =
             case box
-            when ExtendedValue::ALL then 'packages' # only admin can list all packages globally
+            when SpecialValues::ALL then 'packages' # only admin can list all packages globally
             when *API_LIST_MAILBOX_TYPES then "#{box}/packages"
             else
               group_type = options.get_option(:group_type)
@@ -338,12 +339,12 @@ module Aspera
           end
           packages = []
           case package_ids
-          when ExtendedValue::INIT
+          when SpecialValues::INIT
             Aspera.assert(skip_ids_persistency){'Only with option once_only'}
             skip_ids_persistency.data.clear.concat(list_packages_with_filter.map{|p|p['id']})
             skip_ids_persistency.save
             return Main.result_status("Initialized skip for #{skip_ids_persistency.data.count} package(s)")
-          when ExtendedValue::ALL
+          when SpecialValues::ALL
             # TODO: if packages have same name, they will overwrite ?
             packages = list_packages_with_filter(query: {'status' => 'completed'})
             Log.log.trace1{Log.dump(:package_ids, packages.map{|p|p['id']})}
@@ -562,10 +563,12 @@ module Aspera
           res_command = options.get_next_command(available_commands)
           case res_command
           when *Plugin::ALL_OPS
-            return entity_command(res_command, adm_api, res_path, item_list_key: list_key, display_fields: display_fields, id_as_arg: id_as_arg, delete_style: delete_style) do |field, value|
-              lookup_entity_by_field(
-                type: res_type, value: value, field: field, real_path: res_path, item_list_key: list_key, query: res_id_query)['id']
-            end
+            return entity_command(
+              res_command, adm_api, res_path, item_list_key: list_key, display_fields: display_fields, id_as_arg: id_as_arg,
+              delete_style: delete_style) do |field, value|
+                     lookup_entity_by_field(
+                       type: res_type, value: value, field: field, real_path: res_path, item_list_key: list_key, query: res_id_query)['id']
+                   end
           when :shared_folders
             node_id = instance_identifier do |field, value|
               lookup_entity_by_field(type: res_type, field: field, value: value)['id']
@@ -626,7 +629,7 @@ module Aspera
                   user
                 end
               end
-              access = options.get_next_argument('level', mandatory: false, expected: %i[submit_only standard shared_inbox_admin], default: :standard)
+              access = options.get_next_argument('level', mandatory: false, accept_list: %i[submit_only standard shared_inbox_admin], default: :standard)
               # TODO: unshift to command line parameters instead of using deprecated option "value"
               options.set_option(:value, {user: users.map{|u|{id: u, access: access}}})
             end
@@ -644,7 +647,7 @@ module Aspera
           command = options.get_next_command(%i[configuration smtp resource events clean_deleted].concat(ADMIN_RESOURCES).freeze)
           case command
           when :resource
-            # resource is will be deprecated
+            # resource will be deprecated
             Log.log.warn('resource command is deprecated (4.18), directly use the specific command instead')
             return execute_resource(options.get_next_command(ADMIN_RESOURCES))
           when *ADMIN_RESOURCES
@@ -722,7 +725,7 @@ module Aspera
               when :show
                 return { type: :single_object, data: @api_v5.read('account/preferences')[:data] }
               when :modify
-                @api_v5.update('account/preferences', options.get_next_argument('modified parameters', type: Hash))
+                @api_v5.update('account/preferences', options.get_next_argument('modified parameters', validation: Hash))
                 return Main.result_status('modified')
               end
             end

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

@@ -3,6 +3,7 @@
 # cspell:ignore snid fnid bidi ssync asyncs rund asnodeadmin mkfile mklink asperabrowser asperabrowserurl watchfolders watchfolderd entsrv
 require 'aspera/cli/basic_auth_plugin'
 require 'aspera/cli/sync_actions'
+require 'aspera/cli/special_values'
 require 'aspera/transfer/spec'
 require 'aspera/nagios'
 require 'aspera/hash_ext'
@@ -162,7 +163,7 @@ module Aspera
         # translates paths results into CLI result, and removes prefix
         def c_result_translate_rem_prefix(response, type, success_msg, path_prefix)
           errors = []
-          final_result = { data: [], type: :object_list, fields: [type, 'result']}
+          final_result = {type: :object_list, data: [], fields: [type, 'result']}
           JSON.parse(response[:http].body)['paths'].each do |p|
             result = success_msg
             if p.key?('error')
@@ -179,20 +180,11 @@ module Aspera
           return c_result_remove_prefix_path(final_result, type, path_prefix)
         end
 
-        # get path arguments from command line, and add prefix
-        def get_next_arg_add_prefix(path_prefix, name, number=:single)
-          path_or_list = options.get_next_argument(name, expected: number)
-          return path_or_list if path_prefix.nil?
-          return File.join(path_prefix, path_or_list) if path_or_list.is_a?(String)
-          return path_or_list.map {|p| File.join(path_prefix, p)} if path_or_list.is_a?(Array)
-          raise StandardError, 'expect: nil, String or Array'
-        end
-
         # directory: node, container: shares
         FOLDER_TYPE = %w[directory container].freeze
 
         def browse_gen3(prefix_path)
-          folders_to_process = [get_next_arg_add_prefix(prefix_path, 'path')]
+          folders_to_process = [get_one_argument_with_prefix(prefix_path, 'path')]
           query = options.get_option(:query, default: {})
           # special parameter: max number of entries in result
           max_items = query.delete('max')
@@ -254,11 +246,12 @@ module Aspera
         def execute_command_gen3(command, prefix_path)
           case command
           when :delete
-            paths_to_delete = get_next_arg_add_prefix(prefix_path, 'file list', :multiple)
+            # TODO: add query for recursive
+            paths_to_delete = get_all_arguments_with_prefix(prefix_path, 'file list')
             resp = @api_node.create('files/delete', { paths: paths_to_delete.map{|i| {'path' => i.start_with?('/') ? i : "/#{i}"} }})
             return c_result_translate_rem_prefix(resp, 'file', 'deleted', prefix_path)
           when :search
-            search_root = get_next_arg_add_prefix(prefix_path, 'search root')
+            search_root = get_one_argument_with_prefix(prefix_path, 'search root')
             parameters = {'path' => search_root}
             other_options = query_option
             parameters.merge!(other_options) unless other_options.nil?
@@ -270,31 +263,30 @@ module Aspera
             formatter.display_status("params: #{resp[:data]['parameters'].keys.map{|k|"#{k}:#{resp[:data]['parameters'][k]}"}.join(',')}")
             return c_result_remove_prefix_path(result, 'path', prefix_path)
           when :space
-            path_list = get_next_arg_add_prefix(prefix_path, 'folder path or ext.val. list')
-            path_list = [path_list] unless path_list.is_a?(Array)
+            path_list = get_all_arguments_with_prefix(prefix_path, 'folder path or ext.val. list')
             resp = @api_node.create('space', { 'paths' => path_list.map {|i| { path: i} } })
-            result = { data: resp[:data]['paths'], type: :object_list}
+            result = { type: :object_list, data: resp[:data]['paths']}
             # return c_result_translate_rem_prefix(resp,'folder','created',prefix_path)
             return c_result_remove_prefix_path(result, 'path', prefix_path)
           when :mkdir
-            path_list = get_next_arg_add_prefix(prefix_path, 'folder path or ext.val. list')
-            path_list = [path_list] unless path_list.is_a?(Array)
-            resp = @api_node.create('files/create', { 'paths' => [{ type: :directory, path: path_list }] })
+            path_list = get_all_arguments_with_prefix(prefix_path, 'folder path or ext.val. list')
+            resp = @api_node.create('files/create', { 'paths' => path_list.map{|i|{ type: :directory, path: i }}})
             return c_result_translate_rem_prefix(resp, 'folder', 'created', prefix_path)
           when :mklink
-            target = get_next_arg_add_prefix(prefix_path, 'target')
-            path_list = get_next_arg_add_prefix(prefix_path, 'link path')
-            resp = @api_node.create('files/create', { 'paths' => [{ type: :symbolic_link, path: path_list, target: { path: target} }] })
+            target = get_one_argument_with_prefix(prefix_path, 'target')
+            one_path = get_one_argument_with_prefix(prefix_path, 'link path')
+            resp = @api_node.create('files/create', { 'paths' => [{ type: :symbolic_link, path: one_path, target: { path: target} }] })
             return c_result_translate_rem_prefix(resp, 'folder', 'created', prefix_path)
           when :mkfile
-            path_list = get_next_arg_add_prefix(prefix_path, 'file path')
+            one_path = get_one_argument_with_prefix(prefix_path, 'file path')
             contents64 = Base64.strict_encode64(options.get_next_argument('contents'))
-            resp = @api_node.create('files/create', { 'paths' => [{ type: :file, path: path_list, contents: contents64 }] })
+            resp = @api_node.create('files/create', { 'paths' => [{ type: :file, path: one_path, contents: contents64 }] })
             return c_result_translate_rem_prefix(resp, 'folder', 'created', prefix_path)
           when :rename
-            path_base = get_next_arg_add_prefix(prefix_path, 'path_base')
-            path_src = get_next_arg_add_prefix(prefix_path, 'path_src')
-            path_dst = get_next_arg_add_prefix(prefix_path, 'path_dst')
+            # TODO: multiple ?
+            path_base = get_one_argument_with_prefix(prefix_path, 'path_base')
+            path_src = get_one_argument_with_prefix(prefix_path, 'path_src')
+            path_dst = get_one_argument_with_prefix(prefix_path, 'path_dst')
             resp = @api_node.create('files/rename', { 'paths' => [{ 'path' => path_base, 'source' => path_src, 'destination' => path_dst }] })
             return c_result_translate_rem_prefix(resp, 'entry', 'moved', prefix_path)
           when :browse
@@ -346,7 +338,7 @@ module Aspera
             transfer_spec.delete('paths') if command.eql?(:upload)
             return Main.result_transfer(transfer.start(transfer_spec))
           when :http_node_download
-            remote_path = get_next_arg_add_prefix(prefix_path, 'remote path')
+            remote_path = get_one_argument_with_prefix(prefix_path, 'remote path')
             file_name = File.basename(remote_path)
             @api_node.call(
               operation: 'GET',
@@ -390,7 +382,7 @@ module Aspera
             when :set_bearer_key
               access_key_id = options.get_next_argument('access key id')
               access_key_id = @api_node.read('access_keys/self')[:data]['id'] if access_key_id.eql?('self')
-              bearer_key_pem = options.get_next_argument('public or private RSA key PEM value', type: String)
+              bearer_key_pem = options.get_next_argument('public or private RSA key PEM value', validation: String)
               key = OpenSSL::PKey.read(bearer_key_pem)
               key = key.public_key if key.private?
               bearer_key_pem = key.to_pem
@@ -581,7 +573,7 @@ module Aspera
             return {type: :single_object, data: items}
           when :modify
             apifid = apifid_from_next_arg(top_file_id)
-            update_param = options.get_next_argument('update data', type: Hash)
+            update_param = options.get_next_argument('update data', validation: Hash)
             apifid[:api].update("files/#{apifid[:file_id]}", update_param)[:data]
             return Main.result_status('Done')
           when :thumbnail
@@ -612,7 +604,7 @@ module Aspera
                 {'id' => one_id}
               end
             when :create
-              create_param = options.get_next_argument('creation data', type: Hash)
+              create_param = options.get_next_argument('creation data', validation: Hash)
               raise 'no file_id' if create_param.key?('file_id')
               create_param['file_id'] = apifid[:file_id]
               create_param['access_levels'] = Api::Node::ACCESS_LEVELS unless create_param.key?('access_levels')
@@ -638,7 +630,7 @@ module Aspera
             async_name = options.get_option(:sync_name)
             if async_name.nil?
               async_id = instance_identifier
-              if async_id.eql?(ExtendedValue::ALL) && %i[show delete].include?(command)
+              if async_id.eql?(SpecialValues::ALL) && %i[show delete].include?(command)
                 async_ids = @api_node.read('async/list')[:data]['sync_ids']
               else
                 Integer(async_id) # must be integer
@@ -661,7 +653,7 @@ module Aspera
           when :show
             resp = @api_node.create('async/summary', post_data)[:data]['sync_summaries']
             return Main.result_empty if resp.empty?
-            return { type: :object_list, data: resp, fields: %w[snid name local_dir remote_dir] } if async_id.eql?(ExtendedValue::ALL)
+            return { type: :object_list, data: resp, fields: %w[snid name local_dir remote_dir] } if async_id.eql?(SpecialValues::ALL)
             return { type: :single_object, data: resp.first }
           when :delete
             resp = @api_node.create('async/delete', post_data)[:data]
@@ -815,7 +807,7 @@ module Aspera
               resp = @api_node.read(one_res_path)
               return { type: :other_struct, data: resp[:data] }
             when :modify
-              resp = @api_node.update(one_res_path, options.get_next_argument('update value', type: Hash))
+              resp = @api_node.update(one_res_path, options.get_next_argument('update value', validation: Hash))
               return { type: :other_struct, data: resp[:data] }
             when :bandwidth_average
               transfers_data = @api_node.read(res_class_path, query_read_delete)[:data]
@@ -876,7 +868,7 @@ module Aspera
               return { type: :object_list, data: resp[:data]['services'] }
             when :create
               # @json:'{"type":"WATCHFOLDERD","run_as":{"user":"user1"}}'
-              params = options.get_next_argument('Run creation data (structure)')
+              params = options.get_next_argument('creation data', validation: Hash)
               resp = @api_node.create('rund/services', params)
               return Main.result_status("#{resp[:data]['id']} created")
             when :delete
@@ -952,13 +944,13 @@ module Aspera
             }
             # encode parameters so that it looks good in url
             encoded_params = Base64.strict_encode64(Zlib::Deflate.deflate(JSON.generate(browse_params))).gsub(/=+$/, '').tr('+/', '-_').reverse
-            OpenApplication.instance.uri("#{options.get_option(:asperabrowserurl)}?goto=#{encoded_params}")
+            Environment.instance.open_uri("#{options.get_option(:asperabrowserurl)}?goto=#{encoded_params}")
             return Main.result_status('done')
           when :basic_token
             return Main.result_status(Rest.basic_token(options.get_option(:username, mandatory: true), options.get_option(:password, mandatory: true)))
           when :bearer_token
-            private_key = OpenSSL::PKey::RSA.new(options.get_next_argument('private RSA key PEM value', type: String))
-            token_info = options.get_next_argument('user and group identification', type: Hash)
+            private_key = OpenSSL::PKey::RSA.new(options.get_next_argument('private RSA key PEM value', validation: String))
+            token_info = options.get_next_argument('user and group identification', validation: Hash)
             access_key = options.get_option(:username, mandatory: true)
             return Main.result_status(Api::Node.bearer_token(payload: token_info, access_key: access_key, private_key: private_key))
           when :simulator
@@ -974,6 +966,22 @@ module Aspera
           end
           raise 'ERROR: shall not reach this line'
         end
+
+        private
+
+        # get remaining path arguments from command line, and add prefix
+        def get_all_arguments_with_prefix(path_prefix, name)
+          path_args = options.get_next_argument(name, multiple: true)
+          return path_args if path_prefix.nil?
+          return path_args.map {|p| File.join(path_prefix, p)}
+        end
+
+        # get next path argument from command line, and add prefix
+        def get_one_argument_with_prefix(path_prefix, name)
+          path_arg = options.get_next_argument(name, validation: String)
+          return path_arg if path_prefix.nil?
+          return File.join(path_prefix, path_arg)
+        end
       end
     end
   end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'aspera/cli/basic_auth_plugin'
+require 'aspera/cli/special_values'
 require 'aspera/nagios'
 require 'aspera/log'
 require 'aspera/assert'
@@ -150,7 +151,7 @@ module Aspera
             end
             case command
             when :status
-              wf_id = nil if wf_id.eql?(ExtendedValue::ALL)
+              wf_id = nil if wf_id.eql?(SpecialValues::ALL)
               result = call_ao('workflows_status', id: wf_id)[:data]
               return {type: :object_list, data: result['workflows']['workflow']}
             when :list
@@ -176,7 +177,7 @@ module Aspera
               }
               call_params = {format: :json}
               # get external parameters if any
-              options.get_next_argument('external_parameters', mandatory: false, type: Hash, default: {}).each do |name, value|
+              options.get_next_argument('external_parameters', mandatory: false, validation: Hash, default: {}).each do |name, value|
                 call_params["external_parameters[#{name}]"] = value
               end
               # synchronous call ?

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

@@ -489,7 +489,7 @@ module Aspera
             return Main.result_status('Tools validated')
           when :test, :show
             source = options.get_next_argument('source file')
-            format = options.get_next_argument('format', expected: Aspera::Preview::Generator::PREVIEW_FORMATS, default: :png)
+            format = options.get_next_argument('format', accept_list: Aspera::Preview::Generator::PREVIEW_FORMATS, default: :png)
             generated_file_path = preview_filename(format, options.get_option(:base))
             g = Aspera::Preview::Generator.new(source, generated_file_path, @gen_options, @tmp_folder, nil)
             g.generate

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

@@ -232,7 +232,7 @@ module Aspera
           when *TRANSFER_COMMANDS
             return execute_transfer(command, server_transfer_spec)
           when *AsCmd::OPERATIONS
-            command_arguments = options.get_next_argument('ascmd command arguments', expected: :multiple, mandatory: false)
+            command_arguments = options.get_next_argument('ascmd command arguments', multiple: true, mandatory: false)
             ascmd = AsCmd.new(ascmd_executor)
             begin
               result = ascmd.execute_single(command, command_arguments)

data/lib/aspera/cli/special_values.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Aspera
+  module Cli
+    # base class for plugins modules
+    module SpecialValues
+      # special values
+      INIT = 'INIT'
+      ALL = 'ALL'
+      DEF = 'DEF'
+    end
+  end
+end

data/lib/aspera/cli/sync_actions.rb

@@ -29,9 +29,9 @@ module Aspera
           SIMPLE_ARGUMENTS_SYNC.each do |arg, check|
             value = options.get_next_argument(
               arg,
-              type: check.is_a?(Class) ? check : nil,
-              expected: check.is_a?(Class) ? :single : check,
-              mandatory: false)
+              mandatory: false,
+              validation: check.is_a?(Class) ? check : nil,
+              accept_list: check.is_a?(Class) ? nil : check)
             break if value.nil?
             simple_session_args[arg] = value.to_s
           end
@@ -57,7 +57,7 @@ module Aspera
           command2 = options.get_next_command([:status])
           case command2
           when :status
-            sync_session_name = options.get_next_argument('name of sync session', mandatory: false, type: String)
+            sync_session_name = options.get_next_argument('name of sync session', mandatory: false, validation: String)
             async_params = options.get_option(:sync_info, mandatory: true)
             return {type: :single_object, data: Transfer::Sync.admin_status(async_params, sync_session_name)}
           end

data/lib/aspera/cli/transfer_agent.rb

@@ -175,7 +175,7 @@ module Aspera
         when nil, FILE_LIST_FROM_ARGS
           Log.log.debug('getting file list as parameters')
           # get remaining arguments
-          file_list = @opt_mgr.get_next_argument('source file list', expected: :multiple)
+          file_list = @opt_mgr.get_next_argument('source file list', multiple: true)
           raise Cli::BadArgument, 'specify at least one file on command line or use ' \
             "--sources=#{FILE_LIST_FROM_TRANSFER_SPEC} to use transfer spec" if !file_list.is_a?(Array) || file_list.empty?
         when FILE_LIST_FROM_TRANSFER_SPEC
@@ -244,7 +244,7 @@ module Aspera
         updated_ts(transfer_spec)
         # if TS from app has content_protection (e.g. F5), that means content is protected: ask password if not provided
         if transfer_spec['content_protection'].eql?('decrypt') && !transfer_spec.key?('content_protection_password')
-          transfer_spec['content_protection_password'] = @opt_mgr.prompt_user_input('content protection password', true)
+          transfer_spec['content_protection_password'] = @opt_mgr.prompt_user_input('content protection password', sensitive: true)
         end
         # create transfer agent
         agent_instance.start_transfer(transfer_spec, token_regenerator: rest_token)

data/lib/aspera/cli/version.rb

@@ -4,6 +4,6 @@ module Aspera
   module Cli
     # for beta add extension : .beta1
     # for dev version add extension : .pre
-    VERSION = '4.18.0'
+    VERSION = '4.18.1'
   end
 end

data/lib/aspera/environment.rb

@@ -4,17 +4,21 @@
 require 'aspera/log'
 require 'aspera/assert'
 require 'rbconfig'
+require 'singleton'
 
 # cspell:words MEBI mswin bccwin
 
 module Aspera
   # detect OS, architecture, and specific stuff
   class Environment
+    include Singleton
+    USER_INTERFACES = %i[text graphical].freeze
+
     OS_WINDOWS = :windows
-    OS_X = :osx
+    OS_MACOS = :osx
     OS_LINUX = :linux
     OS_AIX = :aix
-    OS_LIST = [OS_WINDOWS, OS_X, OS_LINUX, OS_AIX].freeze
+    OS_LIST = [OS_WINDOWS, OS_MACOS, OS_LINUX, OS_AIX].freeze
     CPU_X86_64 = :x86_64
     CPU_ARM64 = :arm64
     CPU_PPC64 = :ppc64
@@ -37,7 +41,7 @@ module Aspera
         when /mswin/, /msys/, /mingw/, /cygwin/, /bccwin/, /wince/, /emc/
           return OS_WINDOWS
         when /darwin/, /mac os/
-          return OS_X
+          return OS_MACOS
         when /linux/
           return OS_LINUX
         when /aix/
@@ -122,10 +126,66 @@ module Aspera
       end
 
       # @return true if we can display Unicode characters
+      # https://www.gnu.org/software/libc/manual/html_node/Locale-Categories.html
+      # https://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html
       def terminal_supports_unicode?
-        @terminal_supports_unicode = terminal? && ENV.values_at('LC_ALL', 'LC_CTYPE', 'LANG').compact.first.include?('UTF-8') if @terminal_supports_unicode.nil?
+        @terminal_supports_unicode = terminal? && %w(LC_ALL LC_CTYPE LANG).any?{|var|ENV[var]&.include?('UTF-8')} if @terminal_supports_unicode.nil?
         return @terminal_supports_unicode
       end
+
+      def default_gui_mode
+        # assume not remotely connected on macos and windows
+        return :graphical if [Environment::OS_WINDOWS, Environment::OS_MACOS].include?(Environment.os)
+        # unix family
+        return :graphical if ENV.key?('DISPLAY') && !ENV['DISPLAY'].empty?
+        return :text
+      end
+
+      # command must be non blocking
+      def open_uri_graphical(uri)
+        case Environment.os
+        when Environment::OS_MACOS then return system('open', uri.to_s)
+        when Environment::OS_WINDOWS then return system('start', 'explorer', %Q{"#{uri}"})
+        when Environment::OS_LINUX   then return system('xdg-open', uri.to_s)
+        else
+          raise "no graphical open method for #{Environment.os}"
+        end
+      end
+
+      def open_editor(file_path)
+        if ENV.key?('EDITOR')
+          system(ENV['EDITOR'], file_path.to_s)
+        elsif Environment.os.eql?(Environment::OS_WINDOWS)
+          system('notepad.exe', %Q{"#{file_path}"})
+        else
+          open_uri_graphical(file_path.to_s)
+        end
+      end
+    end
+    attr_accessor :url_method
+
+    def initialize
+      @url_method = self.class.default_gui_mode
+    end
+
+    # Allows a user to open a Url
+    # if method is "text", then URL is displayed on terminal
+    # if method is "graphical", then the URL will be opened with the default browser.
+    # this is non blocking
+    def open_uri(the_url)
+      case @url_method
+      when :graphical
+        self.class.open_uri_graphical(the_url)
+      when :text
+        case the_url.to_s
+        when /^http/
+          puts "USER ACTION: please enter this url in a browser:\n#{the_url.to_s.red}\n"
+        else
+          puts "USER ACTION: open this:\n#{the_url.to_s.red}\n"
+        end
+      else
+        raise StandardError, "unsupported url open method: #{@url_method}"
+      end
     end
   end
 end

data/lib/aspera/oauth/web.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'aspera/oauth/base'
-require 'aspera/open_application'
+require 'aspera/environment'
 require 'aspera/web_auth'
 require 'aspera/assert'
 module Aspera
@@ -34,7 +34,7 @@ module Aspera
         # start a web server to receive request code
         web_server = WebAuth.new(@redirect_uri)
         # start browser on login page
-        OpenApplication.instance.uri(login_page_url)
+        Environment.instance.open_uri(login_page_url)
         # wait for code in request
         received_params = web_server.received_request
         Aspera.assert(random_state.eql?(received_params['state'])){'wrong received state'}