Class: Aspera::Cli::Plugins::Aoc

Inherits:
Oauth show all
Defined in:
lib/aspera/cli/plugins/aoc.rb

Constant Summary collapse

ADMIN_ACTIONS = 
%i[ats bearer_token resource usage_reports analytics subscription auth_providers].concat(ADMIN_OBJECTS).freeze
ACTIONS =

must be public

%i[reminder servers bearer_token organization tier_restrictions user packages files admin automation gateway].freeze

Constants inherited from Oauth

Oauth::AUTH_OPTIONS, Oauth::AUTH_TYPES

Constants inherited from Base

Base::ALL_OPS, Base::GLOBAL_OPS, Base::INSTANCE_OPS, Base::MAX_ITEMS, Base::MAX_PAGES

Instance Attribute Summary

Attributes inherited from Base

#context

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Oauth

args_from_options

Methods inherited from BasicAuth

#basic_auth_api, #basic_auth_params, declare_options

Methods inherited from Base

#add_manual_header, #config, declare_options, #do_bulk_operation, #entity_execute, #formatter, #instance_identifier, #list_entities_limit_offset_total_count, #lookup_entity_by_field, #lookup_entity_generic, #options, percent_selector, #persistency, #query_read_delete, #transfer, #value_create_modify

Constructor Details

#initialize(**_) ⇒ Aoc

Returns a new instance of Aoc.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 205

def initialize(**_)
  super
  @cache_workspace_info = nil
  @cache_home_node_file = nil
  @cache_api_aoc = nil
  @scope = Api::AoC::Scope::USER
  options.declare(:workspace, 'Name of workspace', allowed: [String, NilClass], default: Api::AoC::DEFAULT_WORKSPACE)
  options.declare(:new_user_option, 'New user creation option for unknown package recipients', allowed: Hash)
  options.declare(:validate_metadata, 'Validate shared inbox metadata', allowed: Allowed::TYPES_BOOLEAN, default: true)
  options.declare(:package_folder, 'Handling of reception of packages in folders', allowed: Hash, default: {})
  options.parse_options!
  # add node plugin options (for manual)
  Node.declare_options(options)
end

Class Method Details

.application_name ⇒ Object 



61
62
63
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 61

def application_name
  'Aspera on Cloud'
end

.detect(base_url) ⇒ Hash, NilClass

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 66

def detect(base_url)
  # no protocol ?
  base_url = "https://#{base_url}" unless base_url.match?(%r{^[a-z]{1,6}://})
  # only org provided ?
  base_url = "#{base_url}.#{Api::AoC::SAAS_DOMAIN_PROD}" unless base_url.include?('.')
  # AoC is only https
  return unless base_url.start_with?('https://')
  location = Rest.new(base_url: base_url, redirect_max: 0).call(operation: 'GET', subpath: 'auth/ping', exception: false, ret: :resp)['Location']
  return if location.nil?
  redirect_uri = URI.parse(location)
  od = Api::AoC.split_org_domain(URI.parse(base_url))
  return unless redirect_uri.path.end_with?("oauth2/#{od[:organization]}/login")
  # either in standard domain, or product name in page
  return {
    version: Api::AoC.saas_url?(base_url) ? 'SaaS' : 'Self-managed',
    url:     base_url
  }
end

.next_available_folder(base, always: false) ⇒ String

Get folder path that does not exist

Parameters:

  • base (String) —

    Base folder path

  • always (Boolean) (defaults to: false) —

    true always add number, false only if base folder already exists

Returns:

  • (String) —

    Folder path that does not exist, with possible .<number> extension



89
90
91
92
93
94
95
96
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 89

def next_available_folder(base, always: false)
  counter = always ? 1 : 0
  loop do
    result = counter.zero? ? base : "#{base}.#{counter}"
    return result unless Dir.exist?(result)
    counter += 1
  end
end

.unique_folder(package_info, destination_folder, fld: nil, seq: false, opt: false) ⇒ Object

Get folder path that does not exist If it exists, an extension is added or a sequential number if extension == :seq

Parameters:

  • package_info (Hash) —

    Package information

  • destination_folder (String) —

    Base folder

  • fld. (Array) —

    List of fields of package



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 104

def unique_folder(package_info, destination_folder, fld: nil, seq: false, opt: false)
  Aspera.assert_array_all(fld, String, type: BadArgument){'fld'}
  Aspera.assert([1, 2].include?(fld.length)){'fld must have 1 or 2 elements'}
  folder = Environment.instance.sanitized_filename(package_info[fld[0]])
  if seq
    folder = next_available_folder(folder, always: !opt)
  elsif fld[1] && (Dir.exist?(folder) || !opt)
    # NOTE: it might already exist
    folder = "#{folder}.#{Environment.instance.sanitized_filename(fld[1])}"
  end
  puts("sub= #{folder}")
  File.join(destination_folder, folder)
end

Instance Method Details

#aoc_api ⇒ Api::AoC

AoC Rest object

Returns:

  • (Api::AoC) —

    API object for AoC (is Rest)



243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 243

def aoc_api
  if @cache_api_aoc.nil?
    @cache_api_aoc = api_from_options(Api::AoC::API_V1)
    transfer.httpgw_url_cb = lambda do
      organization = @cache_api_aoc.read('organization')
      # @cache_api_aoc.current_user_info['connect_disabled']
      organization['http_gateway_server_url'] if organization['http_gateway_enabled'] && organization['http_gateway_server_url']
    end
  end
  return @cache_api_aoc
end

#api_from_options(aoc_base_path) ⇒ Api::AoC

Create an API object with the options from CLI, but with a different subpath

Parameters:

  • aoc_base_path (String) —

    New subpath

Returns:

  • (Api::AoC) —

    API object for AoC (is Rest)



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 230

def api_from_options(aoc_base_path)
  return Api::AoC.new(**Oauth.args_from_options(
    options,
    defaults:      {workspace: nil},
    scope:         @scope,
    subpath:       aoc_base_path,
    secret_finder: config,
    progress_disp: formatter
  ))
end

#change_api_scope(new_scope) ⇒ Object

Change API scope for subsequent calls, re-instantiate API object

Parameters:

  • new_scope (String) —

    New scope



222
223
224
225
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 222

def change_api_scope(new_scope)
  @cache_api_aoc = nil
  @scope = new_scope
end

#execute_action ⇒ Object 



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 895

def execute_action
  command = options.get_next_command(ACTIONS)
  if %i[files packages].include?(command)
    default_flag = ' (default)' if options.get_option(:workspace).eql?(:default)
    formatter.display_status("Workspace: #{aoc_api.workspace[:name].to_s.red}#{default_flag}")
    if !aoc_api.private_link.nil?
      folder_name = aoc_api.node_api_from(node_id: aoc_api.home[:node_id]).read("files/#{aoc_api.home[:file_id]}")['name']
      formatter.display_status("Private Folder: #{folder_name}")
    end
  end
  case command
  when :reminder
    # send an email reminder with list of orgs
    user_email = options.get_option(:username, mandatory: true)
    Rest.new(base_url: "#{Api::AoC.api_base_url}/#{Api::AoC::API_V1}").create('organization_reminders', {email: user_email})
    return Main.result_status("List of organizations user is member of, has been sent by e-mail to #{user_email}")
  when :servers
    return Main.result_object_list(Rest.new(base_url: "#{Api::AoC.api_base_url}/#{Api::AoC::API_V1}").read('servers'))
  when :bearer_token
    return Main.result_text(aoc_api.oauth.authorization)
  when :organization
    return Main.result_single_object(aoc_api.read('organization'))
  when :tier_restrictions
    return Main.result_single_object(aoc_api.read('tier_restrictions'))
  when :user
    case options.get_next_command(%i[workspaces profile preferences contacts])
    when :contacts
      return execute_resource_action(:contact)
    # when :settings
    # return Main.result_object_list(aoc_api.read('client_settings/'))
    when :workspaces
      case options.get_next_command(%i[list current])
      when :list
        return result_list('workspaces', fields: %w[id name])
      when :current
        return Main.result_single_object(aoc_api.workspace)
      end
    when :profile
      case options.get_next_command(%i[show modify])
      when :show
        return Main.result_single_object(aoc_api.(exception: true))
      when :modify
        aoc_api.update("users/#{aoc_api.(exception: true)['id']}", options.get_next_argument('properties', validation: Hash))
        return Main.result_status('modified')
      end
    when :preferences
      user_preferences_res = "users/#{aoc_api.(exception: true)['id']}/user_interaction_preferences"
      case options.get_next_command(%i[show modify])
      when :show
        return Main.result_single_object(aoc_api.read(user_preferences_res))
      when :modify
        aoc_api.update(user_preferences_res, options.get_next_argument('properties', validation: Hash))
        return Main.result_status('modified')
      end
    end
  when :packages
    package_command = options.get_next_command(%i[shared_inboxes send receive list show delete modify].concat(Node::NODE4_READ_ACTIONS), aliases: {recv: :receive})
    case package_command
    when :shared_inboxes
      case options.get_next_command(%i[list show short_link])
      when :list
        default_query = {'embed[]' => 'dropbox', 'aggregate_permissions_by_dropbox' => true, 'sort' => 'dropbox_name'}
        workspace_id_hash(default_query, string: true)
        return result_list('dropbox_memberships', fields: %w[dropbox_id dropbox.name], default_query: default_query)
      when :show
        return Main.result_single_object(aoc_api.read(get_resource_path_from_args('dropboxes')))
      when :short_link
        # TODO: check name
        return short_link_command(dropbox_id: get_resource_id_from_args('dropboxes'), name: '')
      end
    when :send
      package_data = value_create_modify(command: package_command)
      new_user_option = options.get_option(:new_user_option)
      option_validate = options.get_option(:validate_metadata)
      # Works for both normal user auth and link auth.
      workspace_id_hash(package_data, string: true) unless package_data.key?('workspace_id')
      if !aoc_api.public_link.nil?
        aoc_api.assert_public_link_types(%w[send_package_to_user send_package_to_dropbox])
        box_type = aoc_api.public_link['purpose'].split('_').last
        package_data['recipients'] = [{'id' => aoc_api.public_link['data']["#{box_type}_id"], 'type' => box_type}]
        # enforce workspace id from link (should be already ok, but in case user wanted to override)
        package_data['workspace_id'] = aoc_api.public_link['data']['workspace_id']
      end
      package_data['encryption_at_rest'] = true if transfer.user_transfer_spec['content_protection'].eql?('encrypt')
      # transfer may raise an error
      created_package = aoc_api.create_package_simple(package_data, option_validate, new_user_option)
      Main.result_transfer(transfer.start(created_package[:spec], rest_token: created_package[:node]))
      # return all info on package (especially package id)
      return Main.result_single_object(created_package[:info])
    when :receive
      ids_to_download = nil
      if !aoc_api.public_link.nil?
        aoc_api.assert_public_link_types(['view_received_package'])
        # Set the package id from link
        ids_to_download = aoc_api.public_link['data']['package_id']
      end
      # Get from command line unless it was a public link
      ids_to_download ||= instance_identifier
      skip_ids_persistency = package_persistency
      case ids_to_download
      when SpecialValues::INIT
        all_packages = list_all_packages_with_query[:items]
        Aspera.assert(skip_ids_persistency){'INIT requires option once_only'}
        skip_ids_persistency.data.clear.concat(all_packages.map{ |e| e['id']})
        skip_ids_persistency.save
        return Main.result_status("Initialized skip for #{skip_ids_persistency.data.count} package(s)")
      when SpecialValues::ALL
        all_packages = list_all_packages_with_query[:items]
        # remove from list the ones already downloaded
        reject_packages_from_persistency(all_packages, skip_ids_persistency)
        ids_to_download = all_packages.map{ |e| e['id']}
        formatter.display_status("Found #{ids_to_download.length} package(s).")
      else
        # single id to array
        ids_to_download = [ids_to_download] unless ids_to_download.is_a?(Array)
      end
      # download all files, or specified list only
      ts_paths = transfer.ts_source_paths(default: ['.'])
      per_package_def = options.get_option(:package_folder).symbolize_keys
      save_metadata = per_package_def.delete(:inf)
      # get value outside of loop
      destination_folder = transfer.destination_folder(Transfer::Spec::DIRECTION_RECEIVE)
      result_transfer = []
      ids_to_download.each do |package_id|
        package_info = aoc_api.read("packages/#{package_id}")
        package_node_api = aoc_api.node_api_from(
          node_id: package_info['node_id'],
          package_info: package_info,
          **workspace_id_hash(name: true)
        )
        transfer_spec = package_node_api.transfer_spec_gen4(
          package_info['contents_file_id'],
          Transfer::Spec::DIRECTION_RECEIVE,
          {'paths'=> ts_paths}
        )
        transfer.user_transfer_spec['destination_root'] = self.class.unique_folder(package_info, destination_folder, **per_package_def) unless per_package_def.empty?
        dest_folder = transfer.user_transfer_spec['destination_root'] || destination_folder
        formatter.display_status(%Q{Downloading package: [#{package_info['id']}] "#{package_info['name']}" to [#{dest_folder}]})
        statuses = transfer.start(
          transfer_spec,
          rest_token: package_node_api
        )
        File.write(File.join(dest_folder, "#{package_id}.info.json"), package_info.to_json) if save_metadata
        result_transfer.push({'package' => package_id, Main::STATUS_FIELD => statuses})
        # update skip list only if all transfer sessions completed
        if skip_ids_persistency && TransferAgent.session_status(statuses).eql?(:success)
          skip_ids_persistency.data.push(package_id)
          skip_ids_persistency.save
        end
      end
      return Main.result_transfer_multiple(result_transfer)
    when :show
      package_id = instance_identifier
      package_info = aoc_api.read("packages/#{package_id}")
      return Main.result_single_object(package_info)
    when :list
      result = list_all_packages_with_query
      skip_ids_persistency = package_persistency
      reject_packages_from_persistency(result[:items], skip_ids_persistency)
      display_fields = PACKAGE_LIST_DEFAULT_FIELDS
      display_fields += ['workspace_id'] if aoc_api.workspace[:id].nil?
      return Main.result_object_list(result[:items], fields: display_fields, total: result[:total])
    when :delete
      return do_bulk_operation(command: package_command, values: instance_identifier) do |id|
        Aspera.assert_type(id, String, Integer){'identifier'}
        aoc_api.delete("packages/#{id}")
      end
    when :modify
      id = instance_identifier
      package_data = value_create_modify(command: package_command)
      aoc_api.update("packages/#{id}", package_data)
      return Main.result_status('modified')
    when *Node::NODE4_READ_ACTIONS
      package_id = instance_identifier
      package_info = aoc_api.read("packages/#{package_id}")
      return execute_nodegen4_command(package_command, package_info['node_id'], file_id: package_info['contents_file_id'], scope: Api::Node::Scope::USER)
    end
  when :files
    command_repo = options.get_next_command([:short_link].concat(NODE4_EXT_COMMANDS))
    case command_repo
    when *NODE4_EXT_COMMANDS
      return execute_nodegen4_command(command_repo, aoc_api.home[:node_id], file_id: aoc_api.home[:file_id], scope: Api::Node::Scope::USER)
    when :short_link
      folder_dest = options.get_next_argument('path', validation: String)
      home_node_api = aoc_api.node_api_from(
        node_id: aoc_api.home[:node_id],
        **workspace_id_hash(name: true)
      )
      shared_apfid = home_node_api.resolve_api_fid(aoc_api.home[:file_id], folder_dest)
      return short_link_command(
        node_id:        shared_apfid[:api].app_info[:node_info]['id'],
        file_id:        shared_apfid[:file_id]
      ) do |op, id, access_levels|
        case op
        when :create
          # `id` is the resource id
          perm_data = {
            'file_id'       => shared_apfid[:file_id],
            'access_id'     => id,
            'access_type'   => 'user',
            'access_levels' => Api::AoC.expand_access_levels(access_levels),
            'tags'          => {
              'url_token'        => true,
              'folder_name'      => File.basename(folder_dest),
              'created_by_name'  => aoc_api.['name'],
              'created_by_email' => aoc_api.['email'],
              'access_key'       => shared_apfid[:api].app_info[:node_info]['access_key'],
              'node'             => shared_apfid[:api].app_info[:node_info]['name'],
              **workspace_id_hash(string: true, name: true)
            }
          }
          created_data = shared_apfid[:api].create('permissions', perm_data)
          aoc_api.permissions_send_event(event_data: created_data, app_info: shared_apfid[:api].app_info)
        when :update
          # `id` is the permission_id
          found = shared_apfid[:api].read('permissions', {file_id: shared_apfid[:file_id], inherited: false, access_type: 'user', access_id: id}).find{ |i| i['access_id'].eql?(id)}
          raise Error, 'Short link not found: #{id}' if found.nil?
          shared_apfid[:api].update("permissions/#{found['id']}", {access_levels: Api::AoC.expand_access_levels(access_levels)})
        when :delete
          # `id` is the resource id, i.e. `access_id`
          found = shared_apfid[:api].read('permissions', {file_id: shared_apfid[:file_id], inherited: false, access_type: 'user', access_id: id}).first
          raise Error, 'Short link not found: #{id}' if found.nil?
          shared_apfid[:api].delete("permissions/#{found['id']}")
        else Aspera.error_unexpected_value(op)
        end
      end
    end
  when :automation
    change_api_scope(Api::AoC::Scope::ADMIN_USER)
    Log.log.warn('BETA: work under progress')
    # automation api is not in the same place
    automation_api = Rest.new(**aoc_api.params, base_url: aoc_api.base_url.gsub('/api/', '/automation/'))
    command_automation = options.get_next_command(%i[workflows instances])
    case command_automation
    when :instances
      return entity_execute(api: aoc_api, entity: 'workflow_instances')
    when :workflows
      wf_command = options.get_next_command(%i[action launch].concat(ALL_OPS))
      case wf_command
      when *ALL_OPS
        return entity_execute(
          api: automation_api,
          entity: 'workflows',
          command: wf_command
        )
      when :launch
        wf_id = instance_identifier
        data = automation_api.create("workflows/#{wf_id}/launch", {})
        return Main.result_single_object(data)
      when :action
        # TODO: not complete
        wf_id = instance_identifier
        wf_action_cmd = options.get_next_command(%i[list create show])
        Log.log.warn{"Not implemented: #{wf_action_cmd}"}
        step = automation_api.create('steps', {'workflow_id' => wf_id})
        automation_api.update("workflows/#{wf_id}", {'step_order' => [step['id']]})
        action = automation_api.create('actions', {'step_id' => step['id'], 'type' => 'manual'})
        automation_api.update("steps/#{step['id']}", {'action_order' => [action['id']]})
        wf = automation_api.read("workflows/#{wf_id}")
        return Main.result_single_object(wf)
      end
    end
  when :admin
    return execute_admin_action
  when :gateway
    require 'aspera/faspex_gw'
    parameters = value_create_modify(command: command, default: {}).symbolize_keys
    uri = URI.parse(parameters.delete(:url){WebServerSimple::DEFAULT_URL})
    server = WebServerSimple.new(uri, **parameters.slice(*WebServerSimple::PARAMS))
    Aspera.assert(parameters.except(*WebServerSimple::PARAMS).empty?)
    server.mount(uri.path, Faspex4GWServlet, aoc_api, aoc_api.workspace[:id])
    server.start
    return Main.result_status('Gateway terminated')
  else Aspera.error_unreachable_line
  end
  Aspera.error_unreachable_line
end

#execute_nodegen4_command(command_repo, node_id, file_id: nil, scope: nil) ⇒ Object

Execute a node gen4 command

Parameters:

  • command_repo (Symbol) —

    command to execute

  • node_id (String) —

    Node identifier

  • file_id (String) (defaults to: nil) —

    Root file id for the operation (can be AK root, or other, e.g. package, or link). If nil use AK root file id.

  • scope (String) (defaults to: nil) —

    node scope (Node::SCOPE_<USER|ADMIN>), or nil (requires secret)



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 336

def execute_nodegen4_command(command_repo, node_id, file_id: nil, scope: nil)
  top_node_api = aoc_api.node_api_from(
    node_id:        node_id,
    scope:          scope,
    **workspace_id_hash(name: true)
  )
  file_id = top_node_api.read("access_keys/#{top_node_api.app_info[:node_info]['access_key']}")['root_file_id'] if file_id.nil?
  node_plugin = Node.new(context: context, api: top_node_api)
  case command_repo
  when *Node::COMMANDS_GEN4
    return node_plugin.execute_command_gen4(command_repo, file_id)
  when :transfer
    # client side is agent
    # server side is transfer server
    # in same workspace
    push_pull = options.get_next_argument('direction', accept_list: %i[push pull])
    source_folder = options.get_next_argument('folder or source files', validation: String)
    case push_pull
    when :push
      client_direction = Transfer::Spec::DIRECTION_SEND
      client_folder = source_folder
      server_folder = transfer.destination_folder(client_direction)
    when :pull
      client_direction = Transfer::Spec::DIRECTION_RECEIVE
      client_folder = transfer.destination_folder(client_direction)
      server_folder = source_folder
    else Aspera.error_unreachable_line
    end
    client_apfid = top_node_api.resolve_api_fid(file_id, client_folder)
    server_apfid = top_node_api.resolve_api_fid(file_id, server_folder)
    # force node as transfer agent
    transfer.agent_instance = Agent::Node.new(
      url:      client_apfid[:api].base_url,
      username: client_apfid[:api].app_info[:node_info]['access_key'],
      password: client_apfid[:api].oauth.authorization,
      root_id:  client_apfid[:file_id]
    )
    # additional node to node TS info
    add_ts = {
      'remote_access_key'   => server_apfid[:api].app_info[:node_info]['access_key'],
      'destination_root_id' => server_apfid[:file_id],
      'source_root_id'      => client_apfid[:file_id]
    }
    return Main.result_transfer(transfer.start(server_apfid[:api].transfer_spec_gen4(
      server_apfid[:file_id],
      client_direction,
      add_ts
    )))
  else Aspera.error_unexpected_value(command_repo){'command'}
  end
  Aspera.error_unreachable_line
end

#execute_resource_action(resource_type) ⇒ Object

Parameters:

  • resource_type (Symbol) —

    One of ADMIN_OBJECTS



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 390

def execute_resource_action(resource_type)
  # get path on API, resource type is singular, but api is plural
  resource_class_path =
    case resource_type
    # special cases: singleton, in admin, with x
    when :self, :organization then resource_type
    when :client_registration_token, :client_access_key then "admin/#{resource_type}s"
    when :application then 'admin/apps_new'
    when :dropbox then "#{resource_type}es"
    when :kms_profile then "integrations/#{resource_type}s"
    else "#{resource_type}s"
    end
  # build list of supported operations
  singleton_object = %i[self organization].include?(resource_type)
  global_operations =  %i[create list]
  supported_operations = %i[show modify]
  supported_operations.push(:delete, *global_operations) unless singleton_object
  supported_operations.push(:do, :bearer_token) if resource_type.eql?(:node)
  supported_operations.push(:set_pub_key) if resource_type.eql?(:client)
  supported_operations.push(:shared_folder, :dropbox) if resource_type.eql?(:workspace)
  command = options.get_next_command(supported_operations)
  # require identifier for non global commands
  if !singleton_object && !global_operations.include?(command)
    res_id = get_resource_id_from_args(resource_class_path)
    resource_instance_path = "#{resource_class_path}/#{res_id}"
  end
  resource_instance_path = resource_class_path if singleton_object
  case command
  when :create
    id_result = 'id'
    id_result = 'token' if resource_class_path.eql?('admin/client_registration_tokens')
    # TODO: report inconsistency: creation url is !=, and does not return id.
    resource_class_path = 'admin/client_registration/token' if resource_class_path.eql?('admin/client_registration_tokens')
    return do_bulk_operation(command: command, descr: 'creation data', id_result: id_result) do |params|
      aoc_api.create(resource_class_path, params)
    end
  when :list
    default_fields = ['id']
    default_query = {}
    case resource_type
    when :application
      default_query = {organization_apps: true}
      default_fields.push('app_type', 'app_name', 'available', 'direct_authorizations_allowed', 'workspace_authorizations_allowed')
    when :client, :client_access_key, :dropbox, :group, :package, :saml_configuration, :workspace then default_fields.push('name')
    when :client_registration_token then default_fields.push('value', 'data.client_subject_scopes', 'created_at')
    when :contact
      default_fields = %w[source_type source_id name email]
      default_query = {'include_only_user_personal_contacts' => true} if @scope == Api::AoC::Scope::USER
    when :node then default_fields.push('name', 'host', 'access_key')
    when :operation then default_fields = nil
    when :short_link then default_fields.push('short_url', 'data.url_token_data.purpose')
    when :user then default_fields.push('name', 'email')
    when :group_membership then default_fields.push('group_id', 'member_type', 'member_id')
    when :workspace_membership then default_fields.push('workspace_id', 'member_type', 'member_id')
    end
    return result_list(resource_class_path, fields: default_fields, default_query: default_query)
  when :show
    object = aoc_api.read(resource_instance_path)
    # default: show all, but certificate
    fields = object.keys.reject{ |k| k.eql?('certificate')}
    return Main.result_single_object(object, fields: fields)
  when :modify
    changes = options.get_next_argument('properties', validation: Hash)
    return do_bulk_operation(command: command, values: res_id) do |one_id|
      aoc_api.update("#{resource_class_path}/#{one_id}", changes)
      {'id' => one_id}
    end
  when :delete
    return do_bulk_operation(command: command, values: res_id) do |one_id|
      aoc_api.delete("#{resource_class_path}/#{one_id}")
      {'id' => one_id}
    end
  when :set_pub_key
    # special : reads private and generate public
    the_private_key = options.get_next_argument('private_key PEM value', validation: String)
    the_public_key = OpenSSL::PKey::RSA.new(the_private_key).public_key.to_s
    aoc_api.update(resource_instance_path, {jwt_grant_enabled: true, public_key: the_public_key})
    return Main.result_success
  when :do
    command_repo = options.get_next_command(NODE4_EXT_COMMANDS)
    return execute_nodegen4_command(command_repo, res_id, scope: Api::Node::Scope::ADMIN)
  when :bearer_token
    node_api = aoc_api.node_api_from(
      node_id: res_id,
      scope:   options.get_next_argument('scope', default: Api::Node::Scope::ADMIN)
    )
    return Main.result_text(node_api.oauth.authorization)
  when :dropbox
    command_shared = options.get_next_command(%i[list])
    case command_shared
    when :list
      query = options.get_option(:query) || {}
      res_data = aoc_api.read('dropboxes', query.merge({'workspace_id'=>res_id}))
      return Main.result_object_list(res_data, fields: %w[id name description])
    end
  when :shared_folder
    query = options.get_option(:query) || Api::AoC.workspace_access(res_id).merge({'admin' => true})
    shared_folders = aoc_api.read_with_paging("#{resource_instance_path}/permissions", query)[:items]
    # inside a workspace
    command_shared = options.get_next_command(%i[list member])
    case command_shared
    when :list
      return Main.result_object_list(shared_folders, fields: %w[id node_name node_id file_id file.path tags.aspera.files.workspace.share_as])
    when :member
      shared_folder_id = instance_identifier
      shared_folder = shared_folders.find{ |i| i['id'].eql?(shared_folder_id)}
      Aspera.assert(shared_folder)
      command_shared_member = options.get_next_command(%i[list])
      case command_shared_member
      when :list
        node_api = aoc_api.node_api_from(
          node_id: shared_folder['node_id'],
          workspace_id: res_id,
          workspace_name: nil,
          scope: Api::Node::Scope::USER
        )
        result = node_api.read(
          'permissions',
          {'file_id' => shared_folder['file_id'], 'tag' => "aspera.files.workspace.id=#{res_id}"}
        )
        result.each do |item|
          item['member'] = begin
            if Api::AoC.workspace_access?(item)
              {'name'=>'[Internal permission]'}
            else
              aoc_api.read("admin/#{item['access_type']}s/#{item['access_id']}") rescue {'name': 'not found'}
            end
          rescue => e
            {'name'=>e.to_s}
          end
        end
        # TODO : read users and group name and add, if query "include_members"
        return Main.result_object_list(result, fields: %w[access_type access_id access_level last_updated_at member.name member.email member.system_group_type member.system_group])
      end
    end
  else Aspera.error_unexpected_value(command)
  end
end

#get_resource_id_from_args(resource_class_path) ⇒ Object

Get resource identifier from command line, either directly specifying the id or from name (percent selector).

Parameters:

  • resource_class_path —

    url path for resource

Returns:

  • identifier



276
277
278
279
280
281
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 276

def get_resource_id_from_args(resource_class_path)
  return instance_identifier do |field, value|
    Aspera.assert(field.eql?('name'), type: BadArgument){'only selection by name is supported'}
    aoc_api.lookup_by_name(resource_class_path, value)['id']
  end
end

#get_resource_path_from_args(resource_class_path) ⇒ Object

Get resource path from command line



284
285
286
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 284

def get_resource_path_from_args(resource_class_path)
  return "#{resource_class_path}/#{get_resource_id_from_args(resource_class_path)}"
end

#list_all_packages_with_query ⇒ Hash

List all packages according to query option.

Parameters:

  • (none)

Returns:

  • (Hash) —

    items,total with all packages according to combination of user’s query and default query



320
321
322
323
324
325
326
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 320

def list_all_packages_with_query
  query = query_read_delete(default: {})
  Aspera.assert_type(query, Hash){'query'}
  PACKAGE_RECEIVED_BASE_QUERY.each{ |k, v| query[k] = v unless query.key?(k)}
  resolve_dropbox_name_default_ws_id(query)
  return aoc_api.read_with_paging('packages', query.compact)
end

#package_persistency ⇒ Object

Returns persistency object if option once_only is used.

Returns:

  • persistency object if option once_only is used.



871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 871

def package_persistency
  return unless options.get_option(:once_only, mandatory: true)
  # TODO: add query info to id
  PersistencyActionOnce.new(
    manager: persistency,
    data: [],
    id: IdGenerator.from_list(
      'aoc_recv',
      options.get_option(:url, mandatory: true),
      aoc_api.workspace[:id],
      aoc_api.additional_persistence_ids
    )
  )
end

#reject_packages_from_persistency(all_packages, skip_ids_persistency) ⇒ Object 



886
887
888
889
890
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 886

def reject_packages_from_persistency(all_packages, skip_ids_persistency)
  return if skip_ids_persistency.nil?
  skip_package = skip_ids_persistency.data.each_with_object({}){ |i, m| m[i] = true}
  all_packages.reject!{ |pkg| skip_package[pkg['id']]}
end

#resolve_dropbox_name_default_ws_id(query) ⇒ Object

Translates dropbox_name to dropbox_id and fills current workspace_id



305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 305

def resolve_dropbox_name_default_ws_id(query)
  if query.key?('dropbox_name')
    # convenience: specify name instead of id
    raise BadArgument, 'Use field dropbox_name or dropbox_id, not both' if query.key?('dropbox_id')
    # TODO : craft a query that looks for dropbox only in current workspace
    query['dropbox_id'] = aoc_api.lookup_by_name('dropboxes', query.delete('dropbox_name'))['id']
  end
  workspace_id_hash(query, string: true)
  # by default show dropbox packages only for dropboxes
  query['exclude_dropbox_packages'] = !query.key?('dropbox_id') unless query.key?('exclude_dropbox_packages')
end

#result_list(resource_class_path, fields: nil, base_query: {}, default_query: {}) {|query| ... } ⇒ Object

List all entities, given additional, default and user’s queries

Parameters:

  • resource_class_path —

    path to query on API

  • fields (defaults to: nil) —

    fields to display

  • base_query (defaults to: {}) —

    a query applied always

  • default_query (defaults to: {}) —

    default query unless overridden by user

  • &block (Optional) —

    calls block with user’s or default query

Yields:

  • (query) 


294
295
296
297
298
299
300
301
302
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 294

def result_list(resource_class_path, fields: nil, base_query: {}, default_query: {})
  Aspera.assert_type(base_query, Hash)
  Aspera.assert_type(default_query, Hash)
  query = query_read_delete(default: default_query)
  # caller may add specific modifications or checks to query
  yield(query) if block_given?
  result = aoc_api.read_with_paging(resource_class_path, base_query.merge(query).compact)
  return Main.result_object_list(result[:items], fields: fields, total: result[:total])
end

#short_link_command(**shared_data, &perm_block) ⇒ Object

Create a short link for the given entity: Shared folder or Shared Inbox Short link entity: short_links have:

  • a numerical id, e.g. 764412

  • a resource type, e.g. UrlToken

  • a ressource id, e.g. scQ7uXPbvQ

  • a short URL path, e.g. dxyRpT9

Parameters:

  • shared_data (Hash) —

    Information for shared data: dropbox_id+name or file_id+node_id

  • &perm_block (Proc) —

    Optional: create/modify/delete permissions on node



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 749

def short_link_command(**shared_data, &perm_block)
  link_type = options.get_next_argument('link access (public or private)', accept_list: %i[public private])
  if shared_data.keys.sort == %i[dropbox_id name]
    # Packages app, Shared inbox
    token_purpose = 'send_package_to_dropbox'
    short_link_purpose = link_type.eql?(:public) ? 'send_package_to_dropbox' : 'shared_folder_auth_link'
  elsif shared_data.keys.sort == %i[file_id node_id]
    # Files app, Shared folder
    token_purpose = 'view_shared_file'
    short_link_purpose = link_type.eql?(:public) ? 'token_auth_redirection' : 'shared_folder_auth_link'
  else
    Aspera.error_unexpected_value(shared_data.keys)
  end
  command = options.get_next_command(%i[create delete list show] + (link_type.eql?(:public) ? %i[modify] : []))
  case command
  when :create
    # Add workspace id
    workspace_id_hash(shared_data)
    create_payload = {
      purpose:            short_link_purpose,
      user_selected_name: nil
    }
    case link_type
    when :private
      create_payload[:data] = shared_data
    when :public
      create_payload[:expires_at]       = nil
      create_payload[:password_enabled] = false
      shared_data[:name] = ''
      create_payload[:data] = {
        aoc:            true,
        url_token_data: {
          data:    shared_data,
          purpose: token_purpose
        }
      }
    end
    custom_data = value_create_modify(command: command, default: {})
    access_levels = custom_data.delete('access_levels')
    if (pass = custom_data.delete('password'))
      create_payload[:data][:url_token_data][:password] = pass
      create_payload[:password_enabled] = true
    end
    create_payload.deep_merge!(custom_data)
    result_create_short_link = aoc_api.create('short_links', create_payload)
    # Creation: perm_block: permission on node
    yield(:create, result_create_short_link['resource_id'], access_levels) if block_given? && link_type.eql?(:public)
    return Main.result_single_object(result_create_short_link)
  when :delete, :list, :show, :modify
    workspace_id_hash(shared_data)
    query = if link_type.eql?(:private)
      shared_data
    else
      {
        url_token_data: {
          data:    shared_data,
          purpose: token_purpose
        }
      }
    end
    list_params = {
      json_query:  query.to_json,
      purpose:     short_link_purpose,
      edit_access: true,
      # embed: 'updated_by_user',
      sort:        '-created_at'
    }
    short_list = aoc_api.read_with_paging('short_links', list_params.merge(query_read_delete(default: {})).compact)
    case command
    when :delete
      one_id = instance_identifier(description: 'short link id')
      if link_type.eql?(:public)
        found = short_list[:items].find{ |item| item['id'].eql?(one_id)}
        raise BadIdentifier.new('Short link', one_id) if found.nil?
        yield(:delete, found['resource_id'], nil)
      end
      aoc_api.delete("short_links/#{one_id}", {
        edit_access: true,
        json_query:  shared_data.to_json
      })
      return Main.result_status('deleted')
    when :list
      return Main.result_object_list(short_list[:items], fields: Formatter.all_but('data'), total: short_list[:total])
    when :show
      one_id = instance_identifier(description: 'short link id')
      found = short_list[:items].find{ |item| item['id'].eql?(one_id)}
      raise BadIdentifier.new('Short link', one_id) if found.nil?
      return Main.result_single_object(found, fields: Formatter.all_but('data'))
    when :modify
      one_id = instance_identifier(description: 'short link id')
      node_file = shared_data.slice(:node_id, :file_id)
      modify_payload = {
        edit_access: true,
        json_query:  node_file
      }
      custom_data = value_create_modify(command: command)
      if (pass = custom_data.delete('password'))
        modify_payload[:password_enabled] = true
        modify_payload[:data] = {
          url_token_data: {
            password: pass,
            data:     node_file
          }
        }
      else
        modify_payload[:password_enabled] = false
      end
      if custom_data.delete('access_levels')
        # Modification: perm_block: permission on node
        found = short_list[:items].find{ |item| item['id'].eql?(one_id)}
        raise BadIdentifier.new('Short link', one_id) if found.nil?
        yield(:update, found['resource_id'], access_levels)
      end
      modify_payload.deep_merge!(custom_data)
      aoc_api.update("short_links/#{one_id}", modify_payload)
      return Main.result_status('modified')
    end
  else Aspera.error_unexpected_value(command)
  end
end

#wizard(wizard, app_url) ⇒ Hash

Returns :preset_value, :test_args.

Parameters:

  • wizard (Wizard) —

    The wizard object

  • app_url (String) —

    Tested URL

Returns:

  • (Hash) —

    :preset_value, :test_args



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 122

def wizard(wizard, app_url)
  pub_link_info = Api::AoC.link_info(app_url)
  # public link case
  if pub_link_info.key?(:token)
    pub_api = Rest.new(base_url: "https://#{URI.parse(pub_link_info[:url]).host}/api/v1")
    pub_info = pub_api.read('env/url_token_check', {token: pub_link_info[:token]})
    preset_value = {
      link: app_url
    }
    preset_value[:password] = options.get_option(:password, mandatory: true) if pub_info['password_protected']
    return {
      preset_value: preset_value,
      test_args:    'organization'
    }
  end
  options.declare(:use_generic_client, 'Wizard: AoC: use global or org specific jwt client id', allowed: Allowed::TYPES_BOOLEAN, default: Api::AoC.saas_url?(app_url))
  options.parse_options!
  # make username mandatory for jwt, this triggers interactive input
  wiz_username = options.get_option(:username, mandatory: true)
  wizard.check_email(wiz_username)
  # Set the pub key and jwt tag in the user's profile automatically
  auto_set_pub_key = false
  auto_set_jwt = false
  # use browser authentication to bootstrap
  use_browser_authentication = false
  private_key_path = wizard.ask_private_key(
    user: wiz_username,
    url: app_url,
    page: '👤 → Account Settings → Profile → Public Key'
  )
  client_id = options.get_option(:client_id)
  client_secret = options.get_option(:client_secret)
  if client_id.nil? || client_secret.nil?
    if options.get_option(:use_generic_client)
      client_id = client_secret = nil
      formatter.display_status('Using global client_id.')
    else
      formatter.display_status('Using organization specific client_id.')
      formatter.display_status('Please login to your Aspera on Cloud instance.'.red)
      formatter.display_status('Navigate to: 𓃑  → Admin → Integrations → API Clients')
      formatter.display_status('Check or create in integration:')
      formatter.display_status('- name: cli')
      formatter.display_status("- redirect uri: #{REDIRECT_LOCALHOST}")
      formatter.display_status('- origin: localhost')
      formatter.display_status('Use the generated client id and secret in the following prompts.'.red)
      Environment.instance.open_uri("#{app_url}/admin/integrations/api-clients")
      client_id = options.get_option(:client_id, mandatory: true)
      client_secret = options.get_option(:client_secret, mandatory: true)
      # use_browser_authentication = true
    end
  end
  if use_browser_authentication
    formatter.display_status('We will use web authentication to bootstrap.')
    auto_set_pub_key = true
    auto_set_jwt = true
    Aspera.error_not_implemented
    # aoc_api.oauth.grant_method = :web
    # aoc_api.oauth.scope = Api::AoC::Scope::ADMIN
    # aoc_api.oauth.specific_parameters[:redirect_uri] = REDIRECT_LOCALHOST
  end
  myself = aoc_api.read('self')
  if auto_set_pub_key
    Aspera.assert(myself['public_key'].empty?, type: Error){'Public key is already set in profile (use --override=yes)'} unless option_override
    formatter.display_status('Updating profile with the public key.')
    aoc_api.update("users/#{myself['id']}", {'public_key' => pub_key_pem})
  end
  if auto_set_jwt
    formatter.display_status('Enabling JWT for client')
    aoc_api.update("clients/#{options.get_option(:client_id)}", {'jwt_grant_enabled' => true, 'explicit_authorization_required' => false})
  end
  return {
    preset_value: {
      url:           app_url,
      username:      myself['email'],
      auth:          :jwt.to_s,
      private_key:   "@file:#{private_key_path}",
      client_id:     client_id,
      client_secret: client_secret
    }.compact,
    test_args:    'user profile show'
  }
end

#workspace_id_hash(hash = nil, string: false, name: false) ⇒ Hash

Generate or update Hash with workspace id and name (option), if not already set

Parameters:

  • hash (Hash, nil) (defaults to: nil) —

    Optional base Hash (modified)

  • string (Boolean) (defaults to: false) —

    true to set key as String, else as Symbol

  • name (Boolean) (defaults to: false) —

    Include name

Returns:

  • (Hash) —

    with key ‘workspace_` (symbol or string) only if defined



260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 260

def workspace_id_hash(hash = nil, string: false, name: false)
  info = aoc_api.workspace
  hash = {} if hash.nil?
  fields = %i[id]
  fields.push(:name) if name
  fields.each do |i|
    k = "workspace_#{i}"
    k = k.to_sym unless string
    hash[k] = info[i] unless info[i].nil? || hash.key?(k)
  end
  return hash
end