aspera-cli 4.27.3 → 4.27.5

data/lib/aspera/schema/IBM_Aspera_Shares.yaml

@@ -2930,21 +2930,25 @@ components:
         name:
           type: string
           minLength: 1
-        description:
-          type: string
         node_id:
           type: integer
-        path:
+        directory:
           type: string
+          description: Path of share folder on node
+        create_directory:
+          type: boolean
+          description: Create the share folder on node
     ShareUpdate:
       type: object
       properties:
         name:
           type: string
-        description:
-          type: string
-        path:
+        node_id:
+          type: integer
+          description: Admin only
+        directory:
           type: string
+          description: Path of share folder on node (admin only)
     # Node Schemas
     Node:
       type: object
@@ -3206,9 +3210,10 @@ components:
         name:
           type: string
           example: engineers
-        description:
-          type: string
-          nullable: true
+        group_id:
+          type: integer
+          format: int32
+          description: Identifier in groups from all sources
         created_at:
           type: string
           format: date-time
@@ -3224,16 +3229,12 @@ components:
         name:
           type: string
           example: engineers
-        description:
-          type: string
     LocalGroupUpdate:
       type: object
       properties:
         name:
           type: string
           example: engineers
-        description:
-          type: string
     LdapConfig:
       type: object
       properties:

data/lib/aspera/schema/reader.rb

@@ -116,15 +116,12 @@ module Aspera
           # Yield current property to block
           yield(property_schema, name, property_full_name)
 
-          # Recursively process nested structures
-          case node['type']
-          when 'object'
-            property_schema.each_property("#{property_full_name}.", on_variant: on_variant, &block) if node['properties']
-          when 'array'
-            if node['items']
-              array_item_schema = property_schema.dig('items')
-              array_item_schema.each_property("#{property_full_name}[].", on_variant: on_variant, &block) if array_item_schema.current['properties']
-            end
+          # Recursively process nested structures (`type` is a list for a nullable value, e.g. `[array, 'null']`)
+          types = Array(node['type'])
+          property_schema.each_property("#{property_full_name}.", on_variant: on_variant, &block) if types.include?('object') && node['properties']
+          if types.include?('array') && node['items']
+            array_item_schema = property_schema.dig('items')
+            array_item_schema.each_property("#{property_full_name}[].", on_variant: on_variant, &block) if array_item_schema.current['properties']
           end
           # allOf without explicit type: object — recurse to merge all branches
           property_schema.each_property("#{property_full_name}.", on_variant: on_variant, &block) if node['allOf']
@@ -180,15 +177,12 @@ module Aspera
           row['default'] = node['default'] if node.key?('default')
           row['enum']    = node['enum']    if node.key?('enum')
           rows << row
-          # Recurse into nested object or array-of-objects
-          case node['type']
-          when 'object'
-            collect_rows(rows, prop_reader, "#{full_name}.") if node['properties']
-          when 'array'
-            if node['items']
-              item_reader = prop_reader.dig('items')
-              collect_rows(rows, item_reader, "#{full_name}[].") if item_reader.current['properties']
-            end
+          # Recurse into nested object or array-of-objects (`type` is a list for a nullable value)
+          types = Array(node['type'])
+          collect_rows(rows, prop_reader, "#{full_name}.") if types.include?('object') && node['properties']
+          if types.include?('array') && node['items']
+            item_reader = prop_reader.dig('items')
+            collect_rows(rows, item_reader, "#{full_name}[].") if item_reader.current['properties']
           end
           collect_rows(rows, prop_reader, "#{full_name}.") if node['allOf']
         end

data/lib/aspera/schema/registry.rb

@@ -58,6 +58,7 @@ module Aspera
         args:         'aspera/sync/args.schema.yaml',
         conf:         'aspera/sync/conf.schema.yaml',
         opts:         'aspera/cli/options.schema.yaml',
+        preview:      'aspera/preview/options.schema.yaml',
         aoc:          'aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml',
         automation:   'aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml',
         faspex:       'aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml',
@@ -65,27 +66,31 @@ module Aspera
         console:      'aspera/schema/IBM Aspera Console-enhanced.yaml',
         node:         'aspera/schema/IBM Aspera Node API-4.4.6.yaml',
         shares:       'aspera/schema/IBM_Aspera_Shares.yaml',
+        orchestrator: 'aspera/schema/IBM Aspera Orchestrator API-v1.yaml',
         async_tables: 'aspera/schema/async_tables.yaml'
       }
 
       # Schemas owned by ascli: values are validated against them (vendor API schemas are validated by the API)
-      OWNED = %i[spec args conf opts async_tables].freeze
+      OWNED = %i[spec args conf opts preview async_tables].freeze
 
       OPTIONS = 'opts'
       TRANSFER_SPEC = 'spec'
       SYNC_CONF = 'conf'
       SYNC_ARGS = 'args'
+      PREVIEW_OPTIONS = 'preview'
       AOC = 'aoc'
       AUTOMATION = 'automation'
       FASPEX = 'faspex'
       FASPIO = 'faspio'
       CONSOLE = 'console'
       NODE = 'node'
+      ORCHESTRATOR = 'orchestrator'
       SHARES = 'shares+/api/v1'
       ASYNC_TABLES = 'async_tables'
       LOG_OPTIONS             = "#{OPTIONS}:components.schemas.LogOptions"
       DIRECT_AGENT_OPTIONS    = "#{OPTIONS}:components.schemas.DirectAgentOptions"
       NODE_AGENT_OPTIONS      = "#{OPTIONS}:components.schemas.NodeAgentOptions"
+      NODE_EMULATOR_OPTIONS   = "#{OPTIONS}:components.schemas.NodeEmulatorOptions"
       HTTPGW_AGENT_OPTIONS    = "#{OPTIONS}:components.schemas.HttpgwAgentOptions"
       TRANSFERD_AGENT_OPTIONS = "#{OPTIONS}:components.schemas.TransferdAgentOptions"
       TRANSFER_AGENT_OPTIONS  = "#{OPTIONS}:components.schemas.TransferAgentOptions"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.27.3
+  version: 4.27.5
 platform: ruby
 authors:
 - Laurent Martin
@@ -452,12 +452,13 @@ files:
 - lib/aspera/markdown.rb
 - lib/aspera/mime.rb
 - lib/aspera/nagios.rb
-- lib/aspera/node_simulator.rb
+- lib/aspera/node_emulator.rb
 - lib/aspera/oauth.rb
 - lib/aspera/oauth/base.rb
 - lib/aspera/oauth/boot.rb
 - lib/aspera/oauth/factory.rb
 - lib/aspera/oauth/generic.rb
+- lib/aspera/oauth/json_credentials.rb
 - lib/aspera/oauth/jwt.rb
 - lib/aspera/oauth/url_json.rb
 - lib/aspera/oauth/web.rb
@@ -466,7 +467,7 @@ files:
 - lib/aspera/preview/file_types.rb
 - lib/aspera/preview/generator.rb
 - lib/aspera/preview/image_error.png
-- lib/aspera/preview/options.rb
+- lib/aspera/preview/options.schema.yaml
 - lib/aspera/preview/terminal.rb
 - lib/aspera/preview/utils.rb
 - lib/aspera/preview/video_error.png
@@ -488,6 +489,7 @@ files:
 - lib/aspera/schema/IBM Aspera Console-enhanced.yaml
 - lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml
 - lib/aspera/schema/IBM Aspera Node API-4.4.6.yaml
+- lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml
 - lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0.yaml
 - lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml
 - lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml

data/lib/aspera/node_simulator.rb

@@ -1,345 +0,0 @@
-# frozen_string_literal: true
-
-require 'aspera/assert'
-require 'aspera/mime'
-require 'aspera/ascp/installation'
-require 'aspera/agent/direct'
-require 'aspera/log'
-require 'webrick'
-require 'json'
-
-module Aspera
-  class NodeSimulator
-    def initialize
-      @agent = Agent::Direct.new(management_cb: ->(event) { process_event(event) })
-      @sessions = {}
-    end
-
-    def start(ts)
-      @agent.start_transfer(ts)
-    end
-
-    def all_sessions
-      @agent.sessions.map { |session| session[:job_id] }.uniq.each.map { |job_id| job_to_transfer(job_id) }
-    end
-
-    # status: ('waiting', 'partially_completed', 'unknown', 'waiting(read error)',] 'running', 'completed', 'failed'
-    def job_to_transfer(job_id)
-      jobs = @agent.sessions_by_job(job_id)
-      ts = nil
-      sessions = jobs.map do |j|
-        ts ||= j[:ts]
-        {
-          id:                    j[:id],
-          client_node_id:        '',
-          server_node_id:        '2bbdcc39-f789-4d47-8163-6767fc14f421',
-          client_ip_address:     '192.168.0.100',
-          server_ip_address:     '5.10.114.4',
-          status:                'running',
-          retry_timeout:         3600,
-          retry_count:           0,
-          start_time_usec:       1701094040000000,
-          end_time_usec:         nil,
-          elapsed_usec:          405312,
-          bytes_transferred:     26,
-          bytes_written:         26,
-          bytes_lost:            0,
-          files_completed:       1,
-          directories_completed: 0,
-          target_rate_kbps:      500000,
-          min_rate_kbps:         0,
-          calc_rate_kbps:        9900,
-          network_delay_usec:    40000,
-          avg_rate_kbps:         0.51,
-          error_code:            0,
-          error_desc:            '',
-          source_statistics:     {
-            args_scan_attempted:  1,
-            args_scan_completed:  1,
-            paths_scan_attempted: 1,
-            paths_scan_failed:    0,
-            paths_scan_skipped:   0,
-            paths_scan_excluded:  0,
-            dirs_scan_completed:  0,
-            files_scan_completed: 1,
-            dirs_xfer_attempted:  0,
-            dirs_xfer_fail:       0,
-            files_xfer_attempted: 1,
-            files_xfer_fail:      0,
-            files_xfer_noxfer:    0
-          },
-          precalc:               {
-            enabled:              true,
-            status:               'ready',
-            bytes_expected:       0,
-            directories_expected: 0,
-            files_expected:       0,
-            files_excluded:       0,
-            files_special:        0,
-            files_failed:         1
-          }
-        }
-      end
-      ts ||= {}
-      result = {
-        id:                    job_id,
-        status:                'running',
-        start_spec:            ts,
-        sessions:              sessions,
-        bytes_transferred:     26,
-        bytes_written:         26,
-        bytes_lost:            0,
-        avg_rate_kbps:         0.51,
-        files_completed:       1,
-        files_skipped:         0,
-        directories_completed: 0,
-        start_time_usec:       1701094040000000,
-        end_time_usec:         1701094040405312,
-        elapsed_usec:          405312,
-        error_code:            0,
-        error_desc:            '',
-        precalc:               {
-          status:               'ready',
-          bytes_expected:       0,
-          files_expected:       0,
-          directories_expected: 0,
-          files_special:        0,
-          files_failed:         1
-        },
-        files:                 [{
-          id:              'd1b5c112-82b75425-860745fc-93851671-64541bdd',
-          path:            '/workspaces/45071/packages/bYA_ilq73g.asp-package/contents/data_file.bin',
-          start_time_usec: 1701094040000000,
-          elapsed_usec:    105616,
-          end_time_usec:   1701094040001355,
-          status:          'completed',
-          error_code:      0,
-          error_desc:      '',
-          size:            26,
-          type:            'file',
-          checksum_type:   'none',
-          checksum:        nil,
-          start_byte:      0,
-          bytes_written:   26,
-          session_id:      'bafc72b8-366c-4501-8095-47208183d6b8'
-        }]
-      }
-      Log.dump(:job, result, level: :trace2)
-      return result
-    end
-
-    # Process event from management port
-    def process_event(event)
-      # Code duplicated on purpose, as implementation goes, blocks will be replaced
-      case event['Type']
-      when 'NOP' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      # rubocop:disable Lint/DuplicateBranch
-      when 'START' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'QUERY' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'QUERYRSP' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'STATS' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'STOP' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'ERROR' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'CANCEL' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'DONE' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'RATE' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'FILEERROR' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'SESSION' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'NOTIFICATION' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'INIT' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'VLINK' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'PUT' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'WRITE' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'CLOSE' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'SKIP' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      when 'ARGSTOP' then Aspera.Log.debug { "event not managed: #{event['Type']}" }
-      # rubocop:enable Lint/DuplicateBranch
-      else Aspera.error_unreachable_line
-      end
-    end
-  end
-
-  # this class answers the Faspex /send API and creates a package on Aspera on Cloud
-  # a new instance is created for each request
-  class NodeSimulatorServlet < WEBrick::HTTPServlet::AbstractServlet
-    PATH_TRANSFERS = '/ops/transfers'
-    PATH_ONE_TRANSFER = %r{/ops/transfers/(.+)$}
-    PATH_BROWSE = '/files/browse'
-    # @param credentials [Hash]
-    # @param simulator   [NodeSimulator]
-    def initialize(server, credentials, simulator)
-      super(server)
-      @credentials = credentials
-      @simulator = simulator
-      # Resolve once at startup; default to current working directory
-      @browse_root = File.realpath(credentials[:browse_root] || Dir.pwd)
-    end
-
-    require 'json'
-    require 'time'
-
-    def folder_to_structure(folder_path)
-      # Resolve and confine to browse_root (prevents path traversal via client-supplied path)
-      resolved = File.realpath(folder_path)
-      Aspera.assert(resolved.start_with?("#{@browse_root}/") || resolved.eql?(@browse_root)) { 'Browse path traversal attempt detected' }
-      Aspera.assert(Dir.exist?(resolved)) { "Path does not exist or is not a directory: #{resolved}" }
-      folder_path = resolved
-
-      # Build self structure
-      folder_stat = File.stat(folder_path)
-      structure = {
-        'self'  => {
-          'path'        => folder_path,
-          'basename'    => File.basename(folder_path),
-          'type'        => 'directory',
-          'size'        => folder_stat.size,
-          'mtime'       => folder_stat.mtime.utc.iso8601,
-          'permissions' => [
-            {'name' => 'view'},
-            {'name' => 'edit'},
-            {'name' => 'delete'}
-          ]
-        },
-        'items' => []
-      }
-
-      # Iterate over folder contents
-      Dir.foreach(folder_path) do |entry|
-        next if entry == '.' || entry == '..' # Skip current and parent directory
-
-        item_path = File.join(folder_path, entry)
-        item_type = File.ftype(item_path) rescue 'unknown' # Get the type of file
-        item_stat = File.lstat(item_path) # Use lstat to handle symbolic links correctly
-
-        item = {
-          'path'        => item_path,
-          'basename'    => entry,
-          'type'        => item_type,
-          'size'        => item_stat.size,
-          'mtime'       => item_stat.mtime.utc.iso8601,
-          'permissions' => [
-            {'name' => 'view'},
-            {'name' => 'edit'},
-            {'name' => 'delete'}
-          ]
-        }
-
-        # Add additional details for specific types
-        case item_type
-        when 'file'
-          item['partial_file'] = false
-        when 'link'
-          item['target'] = File.readlink(item_path) rescue nil # Add the target of the symlink
-        when 'unknown'
-          item['note'] = 'File type could not be determined'
-        end
-
-        structure['items'] << item
-      end
-
-      structure
-    end
-
-    def do_POST(request, response)
-      case request.path
-      when PATH_TRANSFERS
-        job_id = @simulator.start(JSON.parse(request.body))
-        sleep(0.5)
-        set_json_response(request, response, @simulator.job_to_transfer(job_id))
-      when PATH_BROWSE
-        req = JSON.parse(request.body)
-        # req['count']
-        set_json_response(request, response, folder_to_structure(req['path'] || @browse_root))
-      else
-        set_json_response(request, response, [{error: 'Bad request'}], code: 400)
-      end
-    end
-
-    def do_GET(request, response)
-      case request.path
-      when '/info'
-        info = Ascp::Installation.instance.ascp_info
-        set_json_response(request, response, {
-          application:                           'node',
-          current_time:                          Time.now.utc.iso8601(0),
-          version:                               info['sdk_ascp_version'].gsub(/ .*$/, ''),
-          license_expiration_date:               info['expiration_date'],
-          license_max_rate:                      info['maximum_bandwidth'],
-          os:                                    %x(uname -srv).chomp,
-          aej_status:                            'disconnected',
-          async_reporting:                       'no',
-          transfer_activity_reporting:           'no',
-          transfer_user:                         'xfer',
-          docroot:                               'file:////data/aoc/eudemo-sedemo',
-          node_id:                               '2bbdcc39-f789-4d47-8163-6767fc14f421',
-          cluster_id:                            '6dae2844-d1a9-47a5-916d-9b3eac3ea466',
-          acls:                                  ['impersonation'],
-          access_key_configuration_capabilities: {
-            transfer: %w[
-              cipher
-              policy
-              target_rate_cap_kbps
-              target_rate_kbps
-              preserve_timestamps
-              content_protection_secret
-              aggressiveness
-              token_encryption_key
-              byok_enabled
-              bandwidth_flow_network_rc_module
-              file_checksum_type
-            ],
-            server:   %w[
-              activity_event_logging
-              activity_file_event_logging
-              recursive_counts
-              aej_logging
-              wss_enabled
-              activity_transfer_ignore_skipped_files
-              activity_files_max
-              access_key_credentials_encryption_type
-              discovery
-              auto_delete
-              allow
-              deny
-            ]
-          },
-          capabilities:                          [
-            {name:  'sync', value: true},
-            {name:  'watchfolder', value: true},
-            {name:  'symbolic_links', value: true},
-            {name:  'move_file', value: true},
-            {name:  'move_directory', value: true},
-            {name:  'filelock', value: false},
-            {name:  'ssh_fingerprint', value: false},
-            {name:  'aej_version', value: '1.0'},
-            {name:  'page', value: true},
-            {name:  'file_id_version', value: '2.0'},
-            {name:  'auto_delete', value: false}
-          ],
-          settings:                              [
-            {name:  'content_protection_required', value: false},
-            {name:  'content_protection_strong_pass_required', value: false},
-            {name:  'filelock_restriction', value: 'none'},
-            {name:  'ssh_fingerprint', value: nil},
-            {name:  'wss_enabled', value: false},
-            {name:  'wss_port', value: 443}
-          ]
-        })
-      when PATH_TRANSFERS
-        set_json_response(request, response, @simulator.all_sessions)
-      when PATH_ONE_TRANSFER
-        job_id = request.path.match(PATH_ONE_TRANSFER)[1]
-        set_json_response(request, response, @simulator.job_to_transfer(job_id))
-      else
-        set_json_response(request, response, [{error: 'Unknown request'}], code: 400)
-      end
-    end
-
-    def set_json_response(request, response, json, code: 200)
-      response.status = code
-      response['Content-Type'] = Mime::JSON
-      response.body = json.to_json
-      Log.log.trace1 { Log.obj_dump("response for #{request.request_method} #{request.path}", json) }
-    end
-  end
-end

data/lib/aspera/preview/options.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# cspell:ignore reencode conv transframes pauseframes
-
-module Aspera
-  module Preview
-    # generator options. Used as parameter to preview generator object.
-    # also settable by command line.
-    class Options
-      # types of generation for video files
-      VIDEO_CONVERSION_METHODS = %i[reencode blend clips].freeze
-      VIDEO_THUMBNAIL_METHODS = %i[fixed animated].freeze
-      # @type [Array<Symbol>] methods for office document conversion
-      OFFICE_CONVERSION_METHODS = %i[soffice unoconv].freeze
-      # Options used in generator
-      # For scaling see: https://trac.ffmpeg.org/wiki/Scaling
-      # iw/ih : input width or height
-      # -x : keep aspect ratio, having value a multiple of x
-      DESCRIPTIONS = [
-        {name: :office_conversion,    default: :soffice,           description: 'office: method for office document conversion', values: OFFICE_CONVERSION_METHODS},
-        {name: :max_size,             default: 1 << 24,            description: 'maximum size (in bytes) of preview file'},
-        {name: :thumb_vid_scale,      default: '-1:min(ih,100)',   description: 'png: video: size (ffmpeg scale argument)'},
-        {name: :thumb_vid_fraction,   default: 0.1,                description: 'png: video: time percent position of snapshot'},
-        {name: :thumb_img_size,       default: 800,                description: 'png: non-video: height (and width)'},
-        {name: :thumb_text_font,      default: 'Courier',          description: 'png: plaintext: font for text rendering: `magick identify -list font`'},
-        {name: :video_conversion,     default: :reencode,          description: 'mp4: method for preview generation', values: VIDEO_CONVERSION_METHODS},
-        {name: :video_png_conv,       default: :fixed,             description: 'mp4: method for thumbnail generation', values: VIDEO_THUMBNAIL_METHODS},
-        {name: :video_scale,          default: 'min(iw,360):-2',   description: 'mp4: all: video scale (ffmpeg scale argument)'},
-        {name: :video_start_sec,      default: 10,                 description: 'mp4: all: start offset (seconds) of video preview'},
-        {name: :video_codec,          default: nil,                description: 'mp4: reencode: video codec for ffmpeg (e.g. libx264, h264_videotoolbox, h264_nvenc), default: auto-detect'},
-        {name: :reencode_ffmpeg,      default: {},                 description: 'mp4: reencode: options to ffmpeg, keys: `in`, `out`'},
-        {name: :blend_keyframes,      default: 30,                 description: 'mp4: blend: # key frames'},
-        {name: :blend_pauseframes,    default: 3,                  description: 'mp4: blend: # pause frames'},
-        {name: :blend_transframes,    default: 5,                  description: 'mp4: blend: # transition blend frames'},
-        {name: :blend_fps,            default: 15,                 description: 'mp4: blend: frame per second'},
-        {name: :clips_count,          default: 5,                  description: 'mp4: clips: number of clips'},
-        {name: :clips_length,         default: 5,                  description: 'mp4: clips: length in seconds of each clips'}
-      ].freeze
-      # add accessors
-      DESCRIPTIONS.each do |opt|
-        attr_accessor opt[:name]
-      end
-    end
-  end
-end