aspera-cli 4.24.1 → 4.25.0.pre

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

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
+require 'aspera/cli/plugins/basic_auth'
 require 'aspera/cli/plugins/node'
 require 'aspera/assert'
 module Aspera
   module Cli
     module Plugins
       # Plugin for Aspera Shares v1
-      class Shares < Cli::BasicAuthPlugin
+      class Shares < BasicAuth
         # path for node API after base url
         NODE_API_PATH = 'node_api'
         # path for node admin after base url
@@ -15,18 +16,13 @@ module Aspera
           def detect(address_or_url)
             address_or_url = "https://#{address_or_url}" unless address_or_url.match?(%r{^[a-z]{1,6}://})
             api = Rest.new(base_url: address_or_url, redirect_max: 1)
-            found = false
-            begin
-              # shall fail: shares requires auth, but we check error message
-              # TODO: use ping instead ?
-              api.read("#{NODE_API_PATH}/app")
-            rescue RestCallError => e
-              found = true if e.response.code.to_s.eql?('401') && e.response.body.eql?('{"error":{"user_message":"API user authentication failed"}}')
-            end
-            return unless found
+            # TODO: use ping instead ?
+            resp = api.read("#{NODE_API_PATH}/app", exception: false, ret: :resp)
+            # shall fail: shares requires auth, but we check error message
+            return unless resp.code.to_s.eql?('401') && resp.body.eql?('{"error":{"user_message":"API user authentication failed"}}')
             version = 'unknown'
-            test_page = api.call(operation: 'GET', subpath: 'login')
-            if (m = test_page[:http].body.match(/\(v(1\..*)\)/))
+            http = api.read('login', headers: {'Accept'=>'*/*'}, ret: :resp)
+            if (m = http.body.match(/\(v(1\..*)\)/))
               version = m[1]
             end
             return {
@@ -34,18 +30,20 @@ module Aspera
               url:     address_or_url
             }
           end
+        end
 
-          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:    'files br /'
-            }
-          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:    'files browse /'
+          }
         end
 
         def initialize(**_)
@@ -65,19 +63,15 @@ module Aspera
           when :health
             nagios = Nagios.new
             begin
-              res = Rest
+              http = Rest
                 .new(base_url: "#{options.get_option(:url, mandatory: true)}/#{NODE_API_PATH}")
-                .call(
-                  operation: 'GET',
-                  subpath: 'ping',
-                  headers: {'content-type': Rest::MIME_JSON}
-                )
-              raise Error, 'Shares not detected' unless res[:http].body.eql?(' ')
+                .read('ping', ret: :resp)
+              raise Error, 'Shares not detected' unless http.body.eql?(' ')
               nagios.add_ok('shares api', 'accessible')
             rescue StandardError => e
               nagios.add_critical('API', e.to_s)
             end
-            return nagios.result
+            Main.result_object_list(nagios.status_list)
           when :files
             api_shares_node = basic_auth_api(NODE_API_PATH)
             repo_command = options.get_next_command(Node::COMMANDS_SHARES)
@@ -87,21 +81,23 @@ module Aspera
           when :admin
             api_shares_admin = basic_auth_api(ADMIN_API_PATH)
             admin_command = options.get_next_command(%i[node share transfer_settings user group].freeze)
+            lookup_share = ->(field, value){lookup_entity_generic(entity: 'share', field: field, value: value){api_shares_admin.read('data/shares')}['id']}
             case admin_command
             when :node
               return entity_execute(api: api_shares_admin, entity: 'data/nodes')
             when :share
-              share_command = options.get_next_command(%i[user_permissions group_permissions].concat(Plugin::ALL_OPS))
+              share_command = options.get_next_command(%i[user_permissions group_permissions].concat(ALL_OPS))
               case share_command
-              when *Plugin::ALL_OPS
+              when *ALL_OPS
                 return entity_execute(
-                  api: api_shares_admin,
-                  entity: 'data/shares',
-                  command: share_command,
-                  display_fields: %w[id name node_id directory percent_free]
+                  api:            api_shares_admin,
+                  entity:         'data/shares',
+                  command:        share_command,
+                  display_fields: %w[id name node_id directory percent_free],
+                  &lookup_share
                 )
               when :user_permissions, :group_permissions
-                share_id = instance_identifier
+                share_id = instance_identifier(&lookup_share)
                 return entity_execute(api: api_shares_admin, entity: "data/shares/#{share_id}/#{share_command}")
               end
             when :transfer_settings
@@ -134,20 +130,22 @@ module Aspera
                 entity_commands = %i[import].freeze
               end
               entity_verb = options.get_next_command(entity_commands)
+              lookup_block = ->(field, value){lookup_entity_generic(entity: entity_type, field: field, value: value){api_shares_admin.read(entities_path)}['id']}
               case entity_verb
-              when *Plugin::ALL_OPS # list, show, delete, create, modify
-                display_fields = entity_type.eql?(:user) ? %w[id username first_name last_name email] : nil
+              when *ALL_OPS # list, show, delete, create, modify
+                display_fields = entity_type.eql?(:user) ? %w[id user_id username first_name last_name email] : nil
                 display_fields.push(:directory_user) if entity_type.eql?(:user) && entities_location.eql?(:all)
                 return entity_execute(
-                  api: api_shares_admin,
-                  entity: entities_path,
-                  command: entity_verb,
-                  display_fields: display_fields
+                  api:            api_shares_admin,
+                  entity:         entities_path,
+                  command:        entity_verb,
+                  display_fields: display_fields,
+                  &lookup_block
                 )
               when *USR_GRP_SETTINGS # transfer_settings, app_authorizations, share_permissions
-                group_id = instance_identifier
+                group_id = instance_identifier(&lookup_block)
                 entities_path = "#{entities_path}/#{group_id}/#{entity_verb}"
-                return entity_execute(api: api_shares_admin, entity: entities_path, is_singleton: !entity_verb.eql?(:share_permissions))
+                return entity_execute(api: api_shares_admin, entity: entities_path, is_singleton: !entity_verb.eql?(:share_permissions), &lookup_share)
               when :import # saml
                 return do_bulk_operation(command: entity_verb, descr: 'user information') do |entity_parameters|
                   entity_parameters = entity_parameters.transform_keys{ |k| k.gsub(/\s+/, '_').downcase}
@@ -163,7 +161,7 @@ module Aspera
                   api_shares_admin.create(entities_path, {entity_type=>entity_name})
                 end
               when :users # group
-                return entity_execute(api: api_shares_admin, entity: "#{entities_path}/#{instance_identifier}/#{entities_prefix}users")
+                return entity_execute(api: api_shares_admin, entity: "#{entities_path}/#{instance_identifier(&lookup_block)}/#{entities_prefix}users")
               else Aspera.error_unexpected_value(entity_verb)
               end
             end

data/lib/aspera/cli/sync_actions.rb

@@ -7,9 +7,9 @@ require 'pathname'
 
 module Aspera
   module Cli
-    # Manage command line arguments to provide to Sync::Run, Sync::Database and Sync::Operations
+    # Manage command line arguments to provide to Sync::Operations and Sync::Database
     module SyncActions
-      # translate state id (int) to string
+      # Translate state id (int) to string
       STATE_STR = (['Nil'] +
         (1..18).map{ |i| "P(#{i})"} +
         %w[Syncd Error Confl Pconf] +
@@ -19,15 +19,19 @@ module Aspera
         end
       end
 
-      # Read command line arguments (1 to 3) and converts to sync_info format
-      # @param sync [Bool] Set to `true` for non-admin
+      # Read 1 or 2 command line arguments and converts to `sync_info` format
+      # The resulting sync_info has `args` format only if it contains one of the `sessions` or `instance` keys.
+      # It has the `conf` format (default) otherwise.
+      # If the `conf` format is detected, then both `local` and `remote` keys are set.
+      # @param direction [Symbol,NilClass] One of directions, or `nil` if only for admin command
       # @return [Hash] sync info
       def async_info_from_args(direction: nil)
         path = options.get_next_argument('path')
         sync_info = options.get_next_argument('sync info', mandatory: false, validation: Hash, default: {})
+        # is the positional path a remote path ?
         path_is_remote = direction.eql?(:pull)
         if sync_info.key?('sessions') || sync_info.key?('instance')
-          # "args"
+          # `args`
           sync_info['sessions'] ||= [{}]
           Aspera.assert(sync_info['sessions'].length == 1){'Only one session is supported'}
           session = sync_info['sessions'].first
@@ -41,7 +45,7 @@ module Aspera
             local_remote = %w[local remote].map{ |i| session["#{i}_dir"]}
           end
         else
-          # "conf"
+          # `conf`
           session = sync_info
           dir_key = path_is_remote ? 'remote' : 'local'
           session[dir_key] ||= {}
@@ -54,7 +58,7 @@ module Aspera
             session[dir_key]['path'] = transfer.destination_folder(path_is_remote ? Transfer::Spec::DIRECTION_RECEIVE : Transfer::Spec::DIRECTION_SEND)
             local_remote = %w[local remote].map{ |i| session[i]['path']}
           end
-          # "conf" is quiet by default
+          # `conf` is quiet by default
           session['quiet'] = false if !session.key?('quiet') && Environment.terminal?
         end
         if direction
@@ -62,17 +66,20 @@ module Aspera
           session['direction'] = direction.to_s
           # generate name if not provided by user
           if !session.key?('name')
+            safe_char = Environment.instance.safe_filename_character
+            # from async man page:
+            # -N : can contain only ASCII alphanumeric, hyphen, and underscore characters
             session['name'] = Environment.instance.sanitized_filename(
               ([direction.to_s] + local_remote).map do |value|
-                Pathname(value).each_filename.to_a.last(2).join(Environment.instance.safe_filename_character)
-              end.join(Environment.instance.safe_filename_character)
+                Pathname(value).each_filename.to_a.last(2).join(safe_char)
+              end.join(safe_char).gsub(/[^A-Za-z0-9_-]/, safe_char)
             )
           end
         end
         sync_info
       end
 
-      # provide database object from command line arguments for admin ops
+      # Provide database object from command line arguments for admin ops
       def db_from_args
         sync_info = async_info_from_args
         session = sync_info.key?('sessions') ? sync_info['sessions'].first : sync_info
@@ -86,43 +93,47 @@ module Aspera
         Sync::Database.new(Sync::Operations.session_db_file(sync_info))
       end
 
+      def execute_sync_admin
+        command2 = options.get_next_command(%i[status find meta counters file_info overview])
+        require 'aspera/sync/database' unless command2.eql?(:status)
+        case command2
+        when :status
+          return Main.result_single_object(Sync::Operations.admin_status(async_info_from_args))
+        when :find
+          folder = options.get_next_argument('path')
+          dbs = Sync::Operations.list_db_files(folder)
+          return Main.result_object_list(dbs.keys.map{ |n| {name: n, path: dbs[n]}})
+        when :meta, :counters
+          return Main.result_single_object(db_from_args.send(command2))
+        when :file_info
+          result = db_from_args.send(command2)
+          result.each do |r|
+            r['sstate'] = SyncActions::STATE_STR[r['state']] if r['state']
+          end
+          return Main.result_object_list(
+            result,
+            fields: %w[sstate record_id f_meta_path message]
+          )
+        when :overview
+          return Main.result_object_list(
+            db_from_args.overview,
+            fields: %w[table name type]
+          )
+        else Aspera.error_unexpected_value(command2)
+        end
+      end
+
       # Execute sync action
-      # @param &block [nil, Proc] block to generate transfer spec, takes: direction (one of DIRECTIONS), local_dir, remote_dir
+      # @param &block [nil, Proc] block to generate transfer spec, takes: `direction` (one of DIRECTIONS), `local_dir`, `remote_dir`
       def execute_sync_action(&block)
         command = options.get_next_command(%i[admin] + Sync::Operations::DIRECTIONS)
         # try to get 3 arguments as simple arguments
         case command
         when *Sync::Operations::DIRECTIONS
-          Sync::Operations.start(async_info_from_args(direction: command), transfer.option_transfer_spec, &block)
+          Sync::Operations.start(async_info_from_args(direction: command), transfer.user_transfer_spec, &block)
           return Main.result_success
         when :admin
-          command2 = options.get_next_command(%i[status find meta counters file_info overview])
-          require 'aspera/sync/database' unless command2.eql?(:status)
-          case command2
-          when :status
-            return Main.result_single_object(Sync::Operations.admin_status(async_info_from_args))
-          when :find
-            folder = options.get_next_argument('path')
-            dbs = Sync::Operations.list_db_files(folder)
-            return Main.result_object_list(dbs.keys.map{ |n| {name: n, path: dbs[n]}})
-          when :meta, :counters
-            return Main.result_single_object(db_from_args.send(command2))
-          when :file_info
-            result = db_from_args.send(command2)
-            result.each do |r|
-              r['sstate'] = SyncActions::STATE_STR[r['state']] if r['state']
-            end
-            return Main.result_object_list(
-              result,
-              fields: %w[sstate record_id f_meta_path message]
-            )
-          when :overview
-            return Main.result_object_list(
-              db_from_args.overview,
-              fields: %w[table name type]
-            )
-          else Aspera.error_unexpected_value(command2)
-          end
+          return execute_sync_admin
         else Aspera.error_unexpected_value(command)
         end
       end

data/lib/aspera/cli/transfer_agent.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'aspera/agent/base'
+require 'aspera/agent/factory'
 require 'aspera/transfer/spec'
 require 'aspera/cli/info'
 require 'aspera/log'
@@ -9,8 +9,8 @@ require 'aspera/assert'
 module Aspera
   module Cli
     # The Transfer agent is a common interface to start a transfer using
-    # one of the supported transfer agents
-    # provides CLI options to select one of the transfer agents (FASP/ascp client)
+    # one of the supported transfer agents.
+    # Provide CLI options to select one of the transfer agents (FASP/ascp client)
     class TransferAgent
       # @args special value for --sources : read file list from arguments
       FILE_LIST_FROM_ARGS = '@args'
@@ -27,12 +27,11 @@ module Aspera
         <%=ts.to_yaml%>
       END_OF_TEMPLATE
       CP4I_REMOTE_HOST_LB = 'N/A'
-      # % (formatting bug in eclipse)
       private_constant :FILE_LIST_FROM_ARGS,
         :FILE_LIST_FROM_TRANSFER_SPEC,
         :FILE_LIST_OPTIONS,
         :DEFAULT_TRANSFER_NOTIFY_TEMPLATE
-      TRANSFER_AGENTS = Agent::Base.agent_list.freeze
+      TRANSFER_AGENTS = Agent::Factory.instance.list.freeze
 
       class << self
         # @return :success if all sessions statuses returned by "start" are success
@@ -44,12 +43,13 @@ module Aspera
         end
       end
 
-      # @param env external objects: option manager, config file manager
+      # @param opt_mgr       [Manager] Option manager
+      # @param config_plugin [Config]  Config plugin
       def initialize(opt_mgr, config_plugin)
         @opt_mgr = opt_mgr
         @config = config_plugin
-        # command line can override transfer spec
-        @transfer_spec_command_line = {
+        # Command line can override transfer spec
+        @user_transfer_spec = {
           'create_dir'    => true,
           'resume_policy' => 'sparse_csum'
         }
@@ -61,12 +61,12 @@ module Aspera
         @transfer_paths = nil
         # HTTPGW URL provided by webapp
         @httpgw_url_lambda = nil
-        @opt_mgr.declare(:ts, 'Override transfer spec values', types: Hash, handler: {o: self, m: :option_transfer_spec})
+        @opt_mgr.declare(:ts, 'Override transfer spec values', allowed: Hash, handler: {o: self, m: :user_transfer_spec})
         @opt_mgr.declare(:to_folder, 'Destination folder for transferred files')
         @opt_mgr.declare(:sources, "How list of transferred files is provided (#{FILE_LIST_OPTIONS.join(',')})", default: FILE_LIST_FROM_ARGS)
-        @opt_mgr.declare(:src_type, 'Type of file list', values: %i[list pair], default: :list)
-        @opt_mgr.declare(:transfer, 'Type of transfer agent', values: TRANSFER_AGENTS, default: :direct)
-        @opt_mgr.declare(:transfer_info, 'Parameters for transfer agent', types: Hash, handler: {o: self, m: :transfer_info})
+        @opt_mgr.declare(:src_type, 'Type of file list', allowed: %i[list pair], default: :list)
+        @opt_mgr.declare(:transfer, 'Type of transfer agent', allowed: TRANSFER_AGENTS, default: :direct)
+        @opt_mgr.declare(:transfer_info, 'Parameters for transfer agent', allowed: Hash, handler: {o: self, m: :transfer_info})
         @opt_mgr.parse_options!
         @notification_cb = nil
         if !@opt_mgr.get_option(:notify_to).nil?
@@ -80,42 +80,27 @@ module Aspera
         end
       end
 
-      def option_transfer_spec; @transfer_spec_command_line; end
-
-      # multiple option are merged
-      def option_transfer_spec=(value)
-        Aspera.assert_type(value, Hash){'ts'}
-        @transfer_spec_command_line.deep_merge!(value)
-      end
-
-      # add other transfer spec parameters
-      def option_transfer_spec_deep_merge(value); @transfer_spec_command_line.deep_merge!(value); end
-
-      attr_reader :transfer_info
-
-      # multiple option are merged
-      def transfer_info=(value)
-        @transfer_info.deep_merge!(value)
-      end
+      attr_accessor :user_transfer_spec, :transfer_info
 
       def agent_instance=(instance)
         @agent = instance
       end
 
       # analyze options and create new agent if not already created or set
-      # TODO: make a Factory pattern
       def agent_instance
         return @agent unless @agent.nil?
         agent_type = @opt_mgr.get_option(:transfer, mandatory: true)
         # set keys as symbols
         agent_options = @opt_mgr.get_option(:transfer_info).symbolize_keys
+        agent_options[:progress] = @config.progress_bar
+        agent_options[:config_dir] = @config.main_folder
         # special cases
         case agent_type
         when :node
-          if agent_options.empty?
+          if !agent_options.key?(:url)
             param_set_name = @config.get_plugin_default_config_name(:node)
             raise Cli::BadArgument, "No default node configured. Please specify #{Manager.option_name_to_line(:transfer_info)}" if param_set_name.nil?
-            agent_options = @config.preset_by_name(param_set_name).symbolize_keys
+            agent_options.merge!(@config.preset_by_name(param_set_name).symbolize_keys)
           end
         when :direct
           # by default do not display ascp native progress bar
@@ -129,21 +114,20 @@ module Aspera
             agent_options[:url] = @httpgw_url_lambda.call
           end
         end
-        agent_options[:progress] = @config.progress_bar
         # get agent instance
-        self.agent_instance = Agent::Base.factory_create(agent_type, agent_options)
+        self.agent_instance = Agent::Factory.instance.create(agent_type, agent_options)
         Log.log.debug{"transfer agent is a #{@agent.class}"}
         return @agent
       end
 
-      # return destination folder for transfers
-      # sets default if needed
-      # param: 'send' or 'receive'
+      # Get destination folder
+      # @param direction [String] `send`` or `receive``
+      # @return [String] Destination folder for transfers (with default based on direction)
       def destination_folder(direction)
         dest_folder = @opt_mgr.get_option(:to_folder)
         # do not expand path, if user wants to expand path: user @path:
         return dest_folder unless dest_folder.nil?
-        dest_folder = @transfer_spec_command_line['destination_root']
+        dest_folder = @user_transfer_spec['destination_root']
         return dest_folder unless dest_folder.nil?
         # default: / on remote, . on local
         case direction.to_s
@@ -161,12 +145,14 @@ module Aspera
         end
       end
 
+      # @param httpgw_url_proc [Proc]
       def httpgw_url_cb=(httpgw_url_proc)
         Aspera.assert_type(httpgw_url_proc, Proc){'httpgw_url_cb'}
         @httpgw_url_lambda = httpgw_url_proc
       end
 
-      # transform the list of paths to a list of hash with source/dest
+      # Transform the list of paths to a list of hash with source/dest
+      # @param file_list [Array]
       def list_to_paths(file_list)
         source_type = @opt_mgr.get_option(:src_type, mandatory: true)
         case source_type
@@ -189,7 +175,7 @@ module Aspera
         # return cache if set
         return @transfer_paths unless @transfer_paths.nil?
         # start with lower priority : get paths from transfer spec on command line
-        @transfer_paths = @transfer_spec_command_line['paths'] if @transfer_spec_command_line.key?('paths')
+        @transfer_paths = @user_transfer_spec['paths'] if @user_transfer_spec.key?('paths')
         # is there a source list option ?
         sources = @opt_mgr.get_option(:sources)
         @transfer_paths =
@@ -212,7 +198,7 @@ module Aspera
             @transfer_paths
           when Array
             Log.log.debug('getting file list as extended value')
-            Aspera.assert(sources.all?(String), type: Cli::BadArgument){'sources must be a Array of String'}
+            Aspera.assert_array_all(sources, String, type: Cli::BadArgument){'sources must be a Array of String'}
             list_to_paths(sources)
           else Aspera.error_unexpected_value(sources){'sources'}
           end
@@ -220,9 +206,9 @@ module Aspera
         return @transfer_paths
       end
 
-      # start a transfer and wait for completion, plugins shall use this method
+      # Start a transfer and wait for completion, plugins shall use this method
       # @param transfer_spec [Hash]
-      # @param rest_token [Rest] if oauth token regeneration supported
+      # @param rest_token    [Rest] if oauth token regeneration supported
       def start(transfer_spec, rest_token: nil)
         # check parameters
         Aspera.assert_type(transfer_spec, Hash){'transfer_spec'}
@@ -231,25 +217,25 @@ module Aspera
         case transfer_spec['direction']
         when Transfer::Spec::DIRECTION_RECEIVE
           # init default if required in any case
-          @transfer_spec_command_line['destination_root'] ||= destination_folder(transfer_spec['direction'])
+          @user_transfer_spec['destination_root'] ||= destination_folder(transfer_spec['direction'])
         when Transfer::Spec::DIRECTION_SEND
           if transfer_spec.dig('tags', Transfer::Spec::TAG_RESERVED, 'node', 'access_key')
             # gen4
-            @transfer_spec_command_line.delete('destination_root') if @transfer_spec_command_line.key?('destination_root_id')
+            @user_transfer_spec.delete('destination_root') if @user_transfer_spec.key?('destination_root_id')
           elsif transfer_spec.key?('token')
             # gen3
             # in that case, destination is set in return by application (API/upload_setup)
             # but to_folder was used in initial API call
-            @transfer_spec_command_line.delete('destination_root')
+            @user_transfer_spec.delete('destination_root')
           else
             # init default if required
-            @transfer_spec_command_line['destination_root'] ||= destination_folder(transfer_spec['direction'])
+            @user_transfer_spec['destination_root'] ||= destination_folder(transfer_spec['direction'])
           end
         end
         # update command line paths, unless destination already has one
-        @transfer_spec_command_line['paths'] = transfer_spec['paths'] || ts_source_paths
+        @user_transfer_spec['paths'] = transfer_spec['paths'] || ts_source_paths
         # updated transfer spec with command line
-        transfer_spec.deep_merge!(@transfer_spec_command_line)
+        transfer_spec.deep_merge!(@user_transfer_spec)
         # recursively remove values that are nil (user wants to delete)
         transfer_spec.deep_do{ |hash, key, value, _unused| hash.delete(key) if value.nil?}
         # if TS from app has content_protection (e.g. F5), that means content is protected: ask password if not provided

data/lib/aspera/cli/transfer_progress.rb

@@ -13,7 +13,7 @@ module Aspera
     class TransferProgress
       def initialize
         @progress_bar = nil
-        # key is session id
+        # Key is session id
         @sessions = {}
         @completed = false
         @title = nil
@@ -42,21 +42,21 @@ module Aspera
         progress_provided = false
         case type
         when :sessions_init
-          # give opportunity to show progress of initialization with multiple status
+          # Give opportunity to show progress of initialization with multiple status
           Aspera.assert(session_id.nil?)
           Aspera.assert_type(info, String)
-          # initialization of progress bar
+          # Initialization of progress bar
           @title = info
         when :session_start
           Aspera.assert_type(session_id, String)
           Aspera.assert(info.nil?)
           raise "Session #{session_id} already started" if @sessions[session_id]
           @sessions[session_id] = {
-            job_size: 0, # total size of transfer (pre-calc)
+            job_size: 0, # Total size of transfer (pre-calc)
             current:  0,
             running:  true
           }
-          # remove last pre-start message if any
+          # Remove last pre-start message if any
           @title = nil
         when :session_size
           Aspera.assert_type(session_id, String)
@@ -77,7 +77,7 @@ module Aspera
         when :session_end
           Aspera.assert_type(session_id, String)
           Aspera.assert(info.nil?)
-          # a session may be too short and finish before it has been started
+          # A session may be too short and finish before it has been started
           @sessions[session_id][:running] = false if @sessions[session_id].is_a?(Hash)
         when :end
           Aspera.assert(session_id.nil?)

data/lib/aspera/cli/version.rb

@@ -2,8 +2,8 @@
 
 module Aspera
   module Cli
-    # for beta add extension : .beta1
-    # for dev version add extension : .pre
-    VERSION = '4.24.1'
+    # For beta add extension : .beta1
+    # For dev version add extension : .pre
+    VERSION = '4.25.0.pre'
   end
 end