aspera-cli 4.13.0 → 4.14.0

data/examples/dascli

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # set env var image to specify another docker image
-: "${image:=martinlaurent/ascli}"
+: "${image:=docker.io/martinlaurent/ascli}"
 # set env var version to specify another image version (default: latest version)
 : "${version:=latest}"
 # set env var imgtag to specify a specific image/version

data/examples/rubyc

@@ -0,0 +1,24 @@
+#!/bin/bash
+# https://github.com/you54f/ruby-packer
+# https://github.com/YOU54F/ruby-packer/releases
+set -e
+FOLDER="$(dirname $0)/../tmp"
+RUBYC="$FOLDER/rubyc"
+if test ! -e "$RUBYC"; then
+    mkdir -p "$FOLDER"
+    case $(uname -sm|tr ' ' -) in
+        Darwin-arm64)
+            curl -L https://github.com/YOU54F/ruby-packer/releases/download/rel-20230812/rubyc-Darwin-arm64.tar.gz | tar -xz -C "$FOLDER"
+            mv "$FOLDER/rubyc-Darwin-arm64" "$RUBYC"
+            ;;
+        Linux-x86_64)
+            curl -L https://github.com/YOU54F/ruby-packer/releases/download/rel-20230812/rubyc-Linux-x86_64.tar.gz | tar -xz -C "$FOLDER"
+            mv "$FOLDER/rubyc-Linux-x86_64" "$RUBYC"
+            ;;
+        *)
+            echo "This architecture is not supported." >&2
+            exit 1
+            ;;
+    esac
+fi
+exec "$RUBYC" "$@"

data/lib/aspera/aoc.rb

@@ -42,6 +42,9 @@ module Aspera
     OAUTH_API_SUBPATH = 'api/v1/oauth2'
     # minimum fields for user info if retrieval fails
     USER_INFO_FIELDS_MIN = %w[name email id default_workspace_id organization_id].freeze
+    # types of events for shared folder creation
+    # Node events: permission.created permission.modified permission.deleted
+    PERMISSIONS_CREATED = ['permission.created'].freeze
 
     private_constant :MAX_REDIRECT,
       :GLOBAL_CLIENT_APPS,
@@ -50,7 +53,8 @@ module Aspera
       :PUBLIC_LINK_PATHS,
       :JWT_AUDIENCE,
       :OAUTH_API_SUBPATH,
-      :USER_INFO_FIELDS_MIN
+      :USER_INFO_FIELDS_MIN,
+      :PERMISSIONS_CREATED
 
     # various API scopes supported
     SCOPE_FILES_SELF = 'self'
@@ -63,8 +67,6 @@ module Aspera
     FILES_APP = 'files'
     PACKAGES_APP = 'packages'
     API_V1 = 'api/v1'
-    # error message when entity not found
-    ENTITY_NOT_FOUND = 'No such'
 
     # class static methods
     class << self
@@ -294,28 +296,6 @@ module Aspera
       return Node.new(params: node_rest_params, app_info: app_info)
     end
 
-    # Query entity type by name and returns the id if a single entry only
-    # @param entity_type path of entity in API
-    # @param entity_name name of searched entity
-    # @param options additional search options
-    def lookup_entity_by_name(entity_type, entity_name, options={})
-      # returns entities whose name contains value (case insensitive)
-      matching_items = read(entity_type, options.merge({'q' => CGI.escape(entity_name)}))[:data]
-      case matching_items.length
-      when 1 then return matching_items.first
-      when 0 then raise %Q{#{ENTITY_NOT_FOUND} #{entity_type}: "#{entity_name}"}
-      else
-        # multiple case insensitive partial matches, try case insensitive full match
-        # (anyway AoC does not allow creation of 2 entities with same case insensitive name)
-        name_matches = matching_items.select{|i|i['name'].casecmp?(entity_name)}
-        case name_matches.length
-        when 1 then return name_matches.first
-        when 0 then raise %Q(#{entity_type}: multiple case insensitive partial match for: "#{entity_name}": #{matching_items.map{|i|i['name']}} but no case insensitive full match. Please be more specific or give exact name.) # rubocop:disable Layout/LineLength
-        else raise "Two entities cannot have the same case insensitive name: #{name_matches.map{|i|i['name']}}"
-        end
-      end
-    end
-
     # Check metadata: remove when validation is done server side
     def validate_metadata(pkg_data)
       # validate only for shared inboxes
@@ -367,7 +347,7 @@ module Aspera
           # email: user, else dropbox
           entity_type = short_recipient_info.include?('@') ? 'contacts' : 'dropboxes'
           begin
-            full_recipient_info = lookup_entity_by_name(entity_type, short_recipient_info, {'current_workspace_id' => ws_id})
+            full_recipient_info = lookup_by_name(entity_type, short_recipient_info, {'current_workspace_id' => ws_id})
           rescue RuntimeError => e
             raise e unless e.message.start_with?(ENTITY_NOT_FOUND)
             # dropboxes cannot be created on the fly
@@ -496,7 +476,10 @@ module Aspera
 
     ID_AK_ADMIN = 'ASPERA_ACCESS_KEY_ADMIN'
     # Callback from Plugins::Node
-    def permissions_create_params(create_param:, app_info:)
+    # add application specific tags to permissions creation
+    # @param create_param [Hash] parameters for creating permissions
+    # @param app_info [Hash] application information
+    def permissions_set_create_params(create_param:, app_info:)
       # workspace shared folder:
       # access_id = "#{ID_AK_ADMIN}_WS_#{app_info[:workspace_id]}"
       default_params = {
@@ -517,7 +500,7 @@ module Aspera
                 'node'              => app_info[:node_info]['name']}}}}}
       create_param.deep_merge!(default_params)
       if create_param.key?('with')
-        contact_info = lookup_entity_by_name(
+        contact_info = lookup_by_name(
           'contacts',
           create_param['with'],
           {'current_workspace_id' => app_info[:workspace_id], 'context' => 'share_folder'})
@@ -531,14 +514,20 @@ module Aspera
     end
 
     # Callback from Plugins::Node
-    def permissions_create_event(created_data:, app_info:)
+    # send shared folder event to AoC
+    # @param created_data [Hash] response from permission creation
+    # @param app_info [Hash] hash with app info
+    # @param types [Array] event types
+    def permissions_send_event(created_data:, app_info:, types: PERMISSIONS_CREATED)
+      raise "INTERNAL: (assert) Invalid event types: #{types}" unless types.is_a?(Array) && !types.empty?
       event_creation = {
-        'types'        => ['permission.created'],
+        'types'        => types,
         'node_id'      => app_info[:node_info]['id'],
         'workspace_id' => app_info[:workspace_id],
-        'data'         => created_data # Response from previous step
+        'data'         => created_data
       }
-      # (optional). The name of the folder to be displayed to the destination user. Use it if its value is different from the "share_as" field.
+      # (optional). The name of the folder to be displayed to the destination user.
+      # Use it if its value is different from the "share_as" field.
       event_creation['link_name'] = app_info[:opt_link_name] unless app_info[:opt_link_name].nil?
       create('events', event_creation)
     end

data/lib/aspera/ascmd.rb

@@ -127,6 +127,7 @@ module Aspera
           byte_array = buffer.shift(num_bytes)
           byte_array = [byte_array] unless byte_array.is_a?(Array)
           result = byte_array.pack('C*').unpack1(type_descr[:unpack])
+          result.force_encoding('UTF-8') if type_name.eql?(:zstr)
           Log.log.debug{"#{'   .' * indent_level}-> base:#{byte_array} -> #{result}"}
           result = Time.at(result) if type_name.eql?(:epoch)
         when :buffer_list

data/lib/aspera/cli/basic_auth_plugin.rb

@@ -9,9 +9,9 @@ module Aspera
     class BasicAuthPlugin < Aspera::Cli::Plugin
       class << self
         def register_options(env)
-          env[:options].add_opt_simple(:url, 'URL of application, e.g. https://org.asperafiles.com')
-          env[:options].add_opt_simple(:username, 'username to log in')
-          env[:options].add_opt_simple(:password, "user's password")
+          env[:options].declare(:url, 'URL of application, e.g. https://org.asperafiles.com')
+          env[:options].declare(:username, 'Username to log in')
+          env[:options].declare(:password, "User's password")
           env[:options].parse_options!
         end
       end
@@ -23,14 +23,14 @@ module Aspera
 
       # returns a Rest object with basic auth
       def basic_auth_params(subpath=nil)
-        api_url = options.get_option(:url, is_type: :mandatory)
+        api_url = options.get_option(:url, mandatory: true)
         api_url = api_url + '/' + subpath unless subpath.nil?
         return {
           base_url: api_url,
           auth:     {
             type:     :basic,
-            username: options.get_option(:username, is_type: :mandatory),
-            password: options.get_option(:password, is_type: :mandatory)
+            username: options.get_option(:username, mandatory: true),
+            password: options.get_option(:password, mandatory: true)
           }}
       end
 

data/lib/aspera/cli/formatter.rb

@@ -18,9 +18,10 @@ module Aspera
       # user output levels
       DISPLAY_LEVELS = %i[info data error].freeze
       CONF_OVERVIEW_KEYS = %w[config parameter value].freeze
+      KEY_VALUE = %w[key value].freeze
 
       private_constant :FIELDS_ALL, :FIELDS_DEFAULT, :DISPLAY_FORMATS, :DISPLAY_LEVELS, :CSV_RECORD_SEPARATOR, :CSV_FIELD_SEPARATOR,
-        :CONF_OVERVIEW_KEYS
+        :CONF_OVERVIEW_KEYS, :KEY_VALUE
 
       class << self
         # special for Aspera on Cloud display node
@@ -81,22 +82,14 @@ module Aspera
         @option_flat_hash = true
         @option_transpose_single = true
         @option_show_secrets = false
-        opt_mgr.set_obj_attr(:format, self, :option_format)
-        opt_mgr.set_obj_attr(:display, self, :option_display)
-        opt_mgr.set_obj_attr(:fields, self, :option_fields)
-        opt_mgr.set_obj_attr(:select, self, :option_select)
-        opt_mgr.set_obj_attr(:table_style, self, :option_table_style)
-        opt_mgr.set_obj_attr(:flat_hash, self, :option_flat_hash)
-        opt_mgr.set_obj_attr(:transpose_single, self, :option_transpose_single)
-        opt_mgr.set_obj_attr(:show_secrets, self, :option_show_secrets)
-        opt_mgr.add_opt_list(:format, DISPLAY_FORMATS, 'output format')
-        opt_mgr.add_opt_list(:display, DISPLAY_LEVELS, 'output only some information')
-        opt_mgr.add_opt_simple(:fields, "comma separated list of fields, or #{FIELDS_ALL}, or #{FIELDS_DEFAULT}")
-        opt_mgr.add_opt_simple(:select, 'select only some items in lists, extended value: hash (column, value)')
-        opt_mgr.add_opt_simple(:table_style, 'table display style')
-        opt_mgr.add_opt_boolean(:flat_hash, 'display hash values as additional keys')
-        opt_mgr.add_opt_boolean(:transpose_single, 'single object fields output vertically')
-        opt_mgr.add_opt_boolean(:show_secrets, 'show secrets on command output')
+        opt_mgr.declare(:format, 'Output format', values: DISPLAY_FORMATS, handler: {o: self, m: :option_format})
+        opt_mgr.declare(:display, 'Output only some information', values: DISPLAY_LEVELS, handler: {o: self, m: :option_display})
+        opt_mgr.declare(:fields, "Comma separated list of fields, or #{FIELDS_ALL}, or #{FIELDS_DEFAULT}", handler: {o: self, m: :option_fields})
+        opt_mgr.declare(:select, 'Select only some items in lists: column, value', types: Hash, handler: {o: self, m: :option_select})
+        opt_mgr.declare(:table_style, 'Table display style', handler: {o: self, m: :option_table_style})
+        opt_mgr.declare(:flat_hash, 'Display deep values as additional keys', values: :bool, handler: {o: self, m: :option_flat_hash})
+        opt_mgr.declare(:transpose_single, 'Single object fields output vertically', values: :bool, handler: {o: self, m: :option_transpose_single})
+        opt_mgr.declare(:show_secrets, 'Show secrets on command output', values: :bool, handler: {o: self, m: :option_show_secrets})
       end
 
       # main output method
@@ -195,7 +188,7 @@ module Aspera
           when :single_object # goes to table display
             # :single_object is a simple hash table  (can be nested)
             raise "internal error: expecting Hash: got #{res_data.class}: #{res_data}" unless res_data.is_a?(Hash)
-            final_table_columns = results[:columns] || %w[key value]
+            final_table_columns = results[:columns] || KEY_VALUE
             if @option_flat_hash
               res_data = self.class.flattened_object(res_data, expand_last: results[:option_expand_last])
               self.class.flatten_name_value_list(res_data)
@@ -207,6 +200,11 @@ module Aspera
               else user_asked_fields_list_str.split(',')
               end
             table_rows_hash_val = asked_fields.map { |i| { final_table_columns.first => i, final_table_columns.last => res_data[i] } }
+            # if only one row, and columns are key/value, then display the value only
+            if table_rows_hash_val.length == 1 && final_table_columns.eql?(KEY_VALUE)
+              display_message(:data, res_data.values.first)
+              return
+            end
           when :value_list # goes to table display
             # :value_list is a simple array of values, name of column provided in the :name
             final_table_columns = [results[:name]]
@@ -235,7 +233,7 @@ module Aspera
           # here we expect: table_rows_hash_val and final_table_columns
           raise 'no field specified' if final_table_columns.nil?
           if table_rows_hash_val.empty?
-            display_message(:info, 'empty'.gray) unless @option_format.eql?(:csv)
+            display_message(:info, 'empty'.gray) if @option_format.eql?(:table)
             return
           end
           # convert to string with special function. here table_rows_hash_val is an array of hash
@@ -252,12 +250,6 @@ module Aspera
           when :table
             style = @option_table_style.chars
             # display the table !
-            # display_message(:data,Text::Table.new(
-            # head:  final_table_columns,
-            # rows:  final_table_rows,
-            # horizontal_boundary:    style[0],
-            # vertical_boundary:      style[1],
-            # boundary_intersection:  style[2]))
             display_message(:data, Terminal::Table.new(
               headings:  final_table_columns,
               rows:      final_table_rows,

data/lib/aspera/cli/main.rb

@@ -31,7 +31,7 @@ module Aspera
       STATUS_FIELD = 'status'
 
       # for testing only
-      SELF_SIGNED_CERT = OpenSSL::SSL.const_get(:enon_yfirev.to_s.upcase.reverse)
+      SELF_SIGNED_CERT = OpenSSL::SSL.const_get(:enon_yfirev.to_s.upcase.reverse) # cspell: disable-line
 
       class << self
         # expect some list, but nothing to display
@@ -87,7 +87,7 @@ module Aspera
         if @option_insecure
           url = http.inspect.gsub(/^[^ ]* /, 'https://').gsub(/ [^ ]*$/, '')
           if !@ssl_warned_urls.include?(url)
-            @formatter.display_message(:error, "#{WARNING_FLASH} ignoring certificate for: #{url}. Do not use unsafe certificates in production.")
+            @formatter.display_message(:error, "#{WARNING_FLASH} ignoring certificate for: #{url}. Do not deactivate certificate verification in production.")
             @ssl_warned_urls.push(url)
           end
           http.verify_mode = SELF_SIGNED_CERT
@@ -187,31 +187,25 @@ module Aspera
       # define header for manual
       def init_global_options
         Log.log.debug('init_global_options')
-        @opt_mgr.add_opt_switch(:help, '-h', 'Show this message.') { @option_help = true }
-        @opt_mgr.add_opt_switch(:bash_comp, 'generate bash completion for command') { @bash_completion = true }
-        @opt_mgr.add_opt_switch(:show_config, 'Display parameters used for the provided action.') { @option_show_config = true }
-        @opt_mgr.add_opt_switch(:rest_debug, '-r', 'more debug for HTTP calls') { @option_rest_debug = true }
-        @opt_mgr.add_opt_switch(:version, '-v', 'display version') { @formatter.display_message(:data, Aspera::Cli::VERSION); Process.exit(0) } # rubocop:disable Style/Semicolon, Layout/LineLength
-        @opt_mgr.add_opt_switch(:warnings, '-w', 'check for language warnings') { $VERBOSE = true }
-        # handler must be set before declaration
-        @opt_mgr.set_obj_attr(:log_level, Log.instance, :level)
-        @opt_mgr.set_obj_attr(:logger, Log.instance, :logger_type)
-        @opt_mgr.set_obj_attr(:insecure, self, :option_insecure, :no)
-        @opt_mgr.set_obj_attr(:ui, self, :option_ui)
-        @opt_mgr.set_obj_attr(:http_options, self, :option_http_options)
-        @opt_mgr.set_obj_attr(:log_secrets, SecretHider, :log_secrets)
-        @opt_mgr.set_obj_attr(:cache_tokens, self, :option_cache_tokens)
-        @opt_mgr.add_opt_list(:ui, OpenApplication.user_interfaces, 'method to start browser')
-        @opt_mgr.add_opt_list(:log_level, Log.levels, 'Log level')
-        @opt_mgr.add_opt_list(:logger, Log::LOG_TYPES, 'logging method')
-        @opt_mgr.add_opt_simple(:lock_port, 'prevent dual execution of a command, e.g. in cron')
-        @opt_mgr.add_opt_simple(:http_options, 'options for http socket (extended value)')
-        @opt_mgr.add_opt_boolean(:insecure, 'do not validate HTTPS certificate')
-        @opt_mgr.add_opt_boolean(:once_only, 'process only new items (some commands)')
-        @opt_mgr.add_opt_boolean(:log_secrets, 'show passwords in logs')
-        @opt_mgr.add_opt_boolean(:cache_tokens, 'save and reuse Oauth tokens')
-        @opt_mgr.set_option(:ui, OpenApplication.default_gui_mode)
-        @opt_mgr.set_option(:once_only, false)
+        @opt_mgr.declare(:help, 'Show this message', values: :none, short: 'h') { @option_help = true }
+        @opt_mgr.declare(:bash_comp, 'Generate bash completion for command', values: :none) { @bash_completion = true }
+        @opt_mgr.declare(:show_config, 'Display parameters used for the provided action', values: :none) { @option_show_config = true }
+        @opt_mgr.declare(:rest_debug, 'More debug for HTTP calls (REST)', values: :none, short: 'r') { @option_rest_debug = true }
+        @opt_mgr.declare(:version, 'Display version', values: :none, short: 'v') { @formatter.display_message(:data, Aspera::Cli::VERSION); Process.exit(0) } # rubocop:disable Style/Semicolon, Layout/LineLength
+        @opt_mgr.declare(:warnings, 'Check for language warnings', values: :none, short: 'w') { $VERBOSE = true }
+        @opt_mgr.declare(
+          :ui, 'Method to start browser',
+          values: OpenApplication.user_interfaces,
+          handler: {o: self, m: :option_ui},
+          default: OpenApplication.default_gui_mode)
+        @opt_mgr.declare(:log_level, 'Log level', values: Log.levels, handler: {o: Log.instance, m: :level})
+        @opt_mgr.declare(:logger, 'Logging method', values: Log::LOG_TYPES, handler: {o: Log.instance, m: :logger_type})
+        @opt_mgr.declare(:lock_port, 'Prevent dual execution of a command, e.g. in cron')
+        @opt_mgr.declare(:http_options, 'Options for http socket', types: Hash, handler: {o: self, m: :option_http_options})
+        @opt_mgr.declare(:insecure, 'Do not validate HTTPS certificate', values: :bool, handler: {o: self, m: :option_insecure}, default: :no)
+        @opt_mgr.declare(:once_only, 'Process only new items (some commands)', values: :bool, default: false)
+        @opt_mgr.declare(:log_secrets, 'Show passwords in logs', values: :bool, handler: {o: SecretHider, m: :log_secrets})
+        @opt_mgr.declare(:cache_tokens, 'Save and reuse Oauth tokens', values: :bool, handler: {o: self, m: :option_cache_tokens})
         # parse declared options
         @opt_mgr.parse_options!
       end