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

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

Constant Summary collapse

ADMIN_ACTIONS = 
%i[ats 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 Aspera::Cli::Plugin

Aspera::Cli::Plugin::ALL_OPS, Aspera::Cli::Plugin::GLOBAL_OPS, Aspera::Cli::Plugin::INIT_PARAMS, Aspera::Cli::Plugin::INSTANCE_OPS, Aspera::Cli::Plugin::MAX_ITEMS, Aspera::Cli::Plugin::MAX_PAGES, Aspera::Cli::Plugin::REGEX_LOOKUP_ID_BY_FIELD

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BasicAuthPlugin

#basic_auth_api, #basic_auth_params, declare_options

Methods inherited from Aspera::Cli::Plugin

#add_manual_header, declare_generic_options, #do_bulk_operation, #entity_action, #entity_command, #init_params, #instance_identifier, #query_read_delete, #value_create_modify

Constructor Details

#initialize(**_) ⇒ Aoc

Returns a new instance of Aoc.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 183

def initialize(**_)
  super
  @cache_workspace_info = nil
  @cache_home_node_file = nil
  @cache_api_aoc = nil
  options.declare(:auth, 'OAuth type of authentication', values: STD_AUTH_TYPES, default: :jwt)
  options.declare(:client_id, 'OAuth API client identifier')
  options.declare(:client_secret, 'OAuth API client secret')
  options.declare(:scope, 'OAuth scope for AoC API calls', default: Api::AoC::SCOPE_FILES_USER)
  options.declare(:redirect_uri, 'OAuth API client redirect URI')
  options.declare(:private_key, 'OAuth JWT RSA private key PEM value (prefix file path with @file:)')
  options.declare(:passphrase, 'RSA private key passphrase', types: String)
  options.declare(:workspace, 'Name of workspace', types: [String, NilClass], default: Api::AoC::DEFAULT_WORKSPACE)
  options.declare(:new_user_option, 'New user creation option for unknown package recipients', types: Hash)
  options.declare(:validate_metadata, 'Validate shared inbox metadata', values: :bool, default: true)
  options.parse_options!
  # add node plugin options (for manual)
  Node.declare_options(options)
end

Class Method Details

.application_name ⇒ Object 



58
59
60
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 58

def application_name
  'Aspera on Cloud'
end

.detect(base_url) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 62

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 nil unless base_url.start_with?('https://')
  res_http = Rest.new(base_url: base_url, redirect_max: 0).call(operation: 'GET', subpath: 'auth/ping', return_error: true)[:http]
  return nil if res_http['Location'].nil?
  redirect_uri = URI.parse(res_http['Location'])
  od = Api::AoC.split_org_domain(URI.parse(base_url))
  return nil 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

.private_key_required?(url) ⇒ Bool

Returns true if private key is required for the url (i.e. no passcode).

Parameters:

  • url (String) —

    : url to check

Returns:

  • (Bool) —

    true if private key is required for the url (i.e. no passcode)



83
84
85
86
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 83

def private_key_required?(url)
  # pub link do not need private key
  return Api::AoC.link_info(url)[:token].nil?
end

.wizard(object:, private_key_path: nil, pub_key_pem: nil) ⇒ Hash

Returns :preset_value, :test_args.

Parameters:

  • env (Hash) —

    : options, formatter

  • params (Hash) —

    : plugin_sym, instance_url

Returns:

  • (Hash) —

    :preset_value, :test_args



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 91

def wizard(object:, private_key_path: nil, pub_key_pem: nil)
  # set vars to look like object
  options = object.options
  formatter = object.formatter
  instance_url = options.get_option(:url, mandatory: true)
  pub_link_info = Api::AoC.link_info(instance_url)
  if !pub_link_info[:token].nil?
    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: instance_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', values: :bool, default: Api::AoC.saas_url?(instance_url))
  options.parse_options!
  # make username mandatory for jwt, this triggers interactive input
  wiz_username = options.get_option(:username, mandatory: true)
  raise "Username shall be an email in AoC: #{wiz_username}" if !(wiz_username =~ /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i)
  # 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
  if options.get_option(:use_generic_client)
    formatter.display_status('Using global client_id.')
    formatter.display_status('Please Login to your Aspera on Cloud instance.')
    formatter.display_status('Navigate to: 👤 → Account Settings → Profile → Public Key')
    formatter.display_status('Check or update the value to:'.red.blink)
    formatter.display_status(pub_key_pem)
    if !options.get_option(:test_mode)
      formatter.display_status('Once updated or validated, press enter.')
      Environment.instance.open_uri(instance_url)
      $stdin.gets
    end
  else
    formatter.display_status('Using organization specific client_id.')
    if options.get_option(:client_id).nil? || options.get_option(:client_secret).nil?
      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)
    end
    Environment.instance.open_uri("#{instance_url}/admin/integrations/api-clients")
    options.get_option(:client_id, mandatory: true)
    options.get_option(:client_secret, mandatory: true)
    # use_browser_authentication = true
  end
  if use_browser_authentication
    formatter.display_status('We will use web authentication to bootstrap.')
    auto_set_pub_key = true
    auto_set_jwt = true
    raise 'TODO'
    # aoc_api.oauth.grant_method = :web
    # aoc_api.oauth.scope = Api::AoC::SCOPE_FILES_ADMIN
    # aoc_api.oauth.specific_parameters[:redirect_uri] = REDIRECT_LOCALHOST
  end
  myself = object.aoc_api.read('self')
  if auto_set_pub_key
    Aspera.assert(myself['public_key'].empty?, exception_class: Cli::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
  preset_result = {
    url:         instance_url,
    username:    myself['email'],
    auth:        :jwt.to_s,
    private_key: "@file:#{private_key_path}"
  }
  # set only if non nil
  %i[client_id client_secret].each do |s|
    o = options.get_option(s)
    preset_result[s.to_s] = o unless o.nil?
  end
  return {
    preset_value: preset_result,
    test_args:    'user profile show'
  }
end

Instance Method Details

#aoc_api ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 214

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

#api_call_paging(base_query = {}) ⇒ Hash

Call block with same query using paging and response information block must return a hash with :data and :http keys

Returns:

  • (Hash) —

    {data: , total: }



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 244

def api_call_paging(base_query={})
  Aspera.assert_type(base_query, Hash){'query'}
  Aspera.assert(block_given?)
  # set default large page if user does not specify own parameters. AoC Caps to 1000 anyway
  base_query['per_page'] = 1000 unless base_query.key?('per_page')
  max_items = base_query.delete(MAX_ITEMS)
  max_pages = base_query.delete(MAX_PAGES)
  item_list = []
  total_count = nil
  current_page = base_query['page']
  current_page = 1 if current_page.nil?
  page_count = 0
  loop do
    query = base_query.clone
    query['page'] = current_page
    result = yield(query)
    Aspera.assert(result[:data])
    Aspera.assert(result[:http])
    total_count = result[:http]['X-Total-Count']
    page_count += 1
    current_page += 1
    add_items = result[:data]
    break if add_items.empty?
    # append new items to full list
    item_list += add_items
    break if !max_items.nil? && item_list.count >= max_items
    break if !max_pages.nil? && page_count >= max_pages
  end
  item_list = item_list[0..max_items - 1] if !max_items.nil? && item_list.count > max_items
  return {data: item_list, total: total_count}
end

#api_from_options(new_base_path) ⇒ Object 



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 203

def api_from_options(new_base_path)
  create_values = {subpath: new_base_path, secret_finder: config}
  # create an API object with the same options, but with a different subpath
  return Api::AoC.new(**OPTIONS_NEW.each_with_object(create_values) { |i, m|m[i] = options.get_option(i) unless options.get_option(i).nil?})
rescue ArgumentError => e
  if (m = e.message.match(/missing keyword: :(.*)$/))
    raise Cli::Error, "Missing option: #{m[1]}"
  end
  raise
end

#api_read_all(resource_class_path, base_query = {}) ⇒ Hash

read using the query and paging

Returns:

  • (Hash) —

    {data: , total: }



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

def api_read_all(resource_class_path, base_query={})
  return api_call_paging(base_query) do |query|
    aoc_api.call(operation: 'GET', subpath: resource_class_path, headers: {'Accept' => 'application/json'}, query: query)
  end
end

#execute_action ⇒ Object 



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
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
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
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
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 724

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)
    aoc_api.context = command
    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 {type: :object_list, data: Rest.new(base_url: "#{Api::AoC.api_base_url}/#{Api::AoC::API_V1}").read('servers')}
  when :bearer_token
    return {type: :text, data: aoc_api.oauth.authorization}
  when :organization
    return { type: :single_object, data: aoc_api.read('organization') }
  when :tier_restrictions
    return { type: :single_object, data: aoc_api.read('tier_restrictions') }
  when :user
    case options.get_next_command(%i[workspaces profile preferences])
    # when :settings
    # return {type: :object_list,data: 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
        aoc_api.context = :files
        return { type: :single_object, data: aoc_api.read("workspaces/#{aoc_api.workspace[:id]}") }
      end
    when :profile
      case options.get_next_command(%i[show modify])
      when :show
        return { type: :single_object, data: 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 { type: :single_object, data: 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].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'}
        default_query['workspace_id'] = aoc_api.workspace[:id] unless aoc_api.workspace[:id].eql?(:undefined)
        return result_list('dropbox_memberships', fields: %w[dropbox_id dropbox.name], default_query: default_query)
      when :show
        return {type: :single_object, data: aoc_api.read(get_resource_path_from_args('dropboxes'))}
      when :short_link
        return short_link_command(
          {
            workspace_id: aoc_api.workspace[:id],
            dropbox_id:   get_resource_id_from_args('dropboxes'),
            name:         ''
          },
          purpose_public: 'send_package_to_dropbox')
      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 usr auth and link auth
      package_data['workspace_id'] ||= aoc_api.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

      # 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 { type: :single_object, data: 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, it will
        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_data = []
      skip_ids_persistency = nil
      if options.get_option(:once_only, mandatory: true)
        # TODO: add query info to id
        skip_ids_persistency = PersistencyActionOnce.new(
          manager: persistency,
          data: skip_ids_data,
          id: IdGenerator.from_list(
            ['aoc_recv',
             options.get_option(:url, mandatory: true),
             aoc_api.workspace[:id]
            ].concat(aoc_api.additional_persistence_ids)))
      end
      case ids_to_download
      when SpecialValues::ALL, SpecialValues::INIT
        query = query_read_delete(default: PACKAGE_RECEIVED_BASE_QUERY)
        Aspera.assert_type(query, Hash){'query'}
        resolve_dropbox_name_default_ws_id(query)
        # remove from list the ones already downloaded
        all_ids = api_read_all('packages', query)[:data].map{|e|e['id']}
        if ids_to_download.eql?(SpecialValues::INIT)
          Aspera.assert(skip_ids_persistency){'Only with option once_only'}
          skip_ids_persistency.data.clear.concat(all_ids)
          skip_ids_persistency.save
          return Main.result_status("Initialized skip for #{skip_ids_persistency.data.count} package(s)")
        end
        # array here
        ids_to_download = all_ids.reject{|id|skip_ids_data.include?(id)}
      else
        ids_to_download = [ids_to_download] unless ids_to_download.is_a?(Array)
      end
      file_list =
        begin
          transfer.source_list.map{|i|{'source'=>i}}
        rescue Cli::BadArgument
          [{'source' => '.'}]
        end
      # list here
      result_transfer = []
      formatter.display_status("found #{ids_to_download.length} package(s).")
      ids_to_download.each do |package_id|
        package_info = aoc_api.read("packages/#{package_id}")
        formatter.display_status("downloading package: [#{package_info['id']}] #{package_info['name']}")
        package_node_api = aoc_api.node_api_from(
          node_id: package_info['node_id'],
          workspace_id: aoc_api.workspace[:id],
          workspace_name: aoc_api.workspace[:name],
          package_info: package_info)
        statuses = transfer.start(
          package_node_api.transfer_spec_gen4(
            package_info['contents_file_id'],
            Transfer::Spec::DIRECTION_RECEIVE,
            {'paths'=> file_list}),
          rest_token: package_node_api)
        result_transfer.push({'package' => package_id, Main::STATUS_FIELD => statuses})
        # update skip list only if all transfer sessions completed
        if TransferAgent.session_status(statuses).eql?(:success)
          skip_ids_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 { type: :single_object, data: package_info }
    when :list
      display_fields = %w[id name bytes_transferred]
      display_fields.push('workspace_id') if aoc_api.workspace[:id].eql?(:undefined)
      return result_list('packages', fields: display_fields, base_query: PACKAGE_RECEIVED_BASE_QUERY) do |query|
               resolve_dropbox_name_default_ws_id(query)
             end
    when :delete
      return do_bulk_operation(command: package_command, descr: 'identifier', values: instance_identifier) do |id|
        Aspera.assert_values(id.class, [String, Integer]){'identifier'}
        aoc_api.delete("packages/#{id}")
      end
    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:   aoc_api.workspace[:id],
        workspace_name: aoc_api.workspace[:name])
      shared_apfid = home_node_api.resolve_api_fid(aoc_api.home[:file_id], folder_dest)
      return short_link_command(
        {
          workspace_id: aoc_api.workspace[:id],
          node_id:      shared_apfid[:api].app_info[:node_info]['id'],
          file_id:      shared_apfid[:file_id]
        }, purpose_public: 'view_shared_file') do |resource_id|
               # TODO: merge with node permissions ?
               # TODO: access level as arg
               access_levels = Api::Node::ACCESS_LEVELS # ['delete','list','mkdir','preview','read','rename','write']
               perm_data = {
                 'file_id'       => shared_apfid[:file_id],
                 'access_id'     => resource_id,
                 'access_type'   => 'user',
                 'access_levels' => access_levels,
                 'tags'          => {
                   # TODO: really just here ? not in tags.aspera.files.workspace ?
                   'url_token'        => true,
                   'workspace_id'     => aoc_api.workspace[:id],
                   'workspace_name'   => aoc_api.workspace[:name],
                   '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]['host']
                 }
               }
               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)
             end
    end
  when :automation
    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_action(aoc_api, 'workflow_instances')
    when :workflows
      wf_command = options.get_next_command(%i[action launch].concat(Plugin::ALL_OPS))
      case wf_command
      when *Plugin::ALL_OPS
        return entity_command(wf_command, automation_api, 'workflows')
      when :launch
        wf_id = instance_identifier
        data = automation_api.create("workflows/#{wf_id}/launch", {})
        return {type: :single_object, data: 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 {type: :single_object, data: wf}
      end
    end
  when :admin
    return execute_admin_action
  when :gateway
    require 'aspera/faspex_gw'
    url = value_create_modify(command: command, type: String)
    uri = URI.parse(url)
    server = WebServerSimple.new(uri)
    aoc_api.context = :files
    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

Parameters:

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

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

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

    node scope, or nil (admin)



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
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
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 316

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,
    workspace_id:   aoc_api.workspace[:id],
    workspace_name: aoc_api.workspace[:name],
    scope:          scope
  )
  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(**init_params, 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_unreachable_line
  end
  Aspera.error_unreachable_line
end

#execute_resource_action(resource_type) ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
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
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 369

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) if resource_type.eql?(:node)
  supported_operations.push(:set_pub_key) if resource_type.eql?(:client)
  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 then default_fields = %w[email name source_id source_type]
    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 { type: :single_object, data: object, fields: fields }
  when :modify
    changes = options.get_next_argument('properties', validation: Hash)
    return do_bulk_operation(command: command, descr: 'identifier', 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, descr: 'identifier', 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)
    # init context
    aoc_api.context = :files
    return execute_nodegen4_command(command_repo, res_id)
  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 or from name.

Parameters:

  • resource_class_path —

    url path for resource

Returns:

  • identifier



229
230
231
232
233
234
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 229

def get_resource_id_from_args(resource_class_path)
  return instance_identifier do |field, value|
    Aspera.assert(field.eql?('name'), exception_class: Cli::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



237
238
239
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 237

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

#resolve_dropbox_name_default_ws_id(query) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 298

def resolve_dropbox_name_default_ws_id(query)
  if query.key?('dropbox_name')
    # convenience: specify name instead of id
    raise 'not both dropbox_name and dropbox_id' 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['dropbox_name'])['id']
    query.delete('dropbox_name')
  end
  query['workspace_id'] ||= aoc_api.workspace[:id] unless aoc_api.workspace[:id].eql?(:undefined)
  # 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: {}) {|user_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 overriden by user

Yields:

  • (user_query) 


289
290
291
292
293
294
295
296
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 289

def result_list(resource_class_path, fields: nil, base_query: {}, default_query: {})
  Aspera.assert_type(base_query, Hash)
  Aspera.assert_type(default_query, Hash)
  user_query = query_read_delete(default: default_query)
  # caller may add specific modifications or checks
  yield(user_query) if block_given?
  return {type: :object_list, fields: fields}.merge(api_read_all(resource_class_path, base_query.merge(user_query).compact))
end

#short_link_command(shared_data, purpose_public:) ⇒ Object

Create a shared link for the given entity

Parameters:

  • shared_data (Hash) —

    information for shared data

  • block (Proc) —

    Optional: called on creation



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/aspera/cli/plugins/aoc.rb', line 649

def short_link_command(shared_data, purpose_public:)
  link_type = options.get_next_argument('link type', accept_list: %i[public private])
  purpose_local = case link_type
  when :public
    case purpose_public
    when /package/ then 'send_package_to_dropbox'
    when /shared/ then 'token_auth_redirection'
    else raise 'error'
    end
  when :private then 'shared_folder_auth_link'
  else Aspera.error_unreachable_line
  end
  case options.get_next_command(%i[create delete list])
  when :create
    creation_params = {
      purpose:            purpose_local,
      user_selected_name: nil
    }
    case link_type
    when :private
      creation_params[:data] = shared_data
    when :public
      creation_params[:expires_at]       = nil
      creation_params[:password_enabled] = false
      shared_data[:name] = ''
      creation_params[:data] = {
        aoc:            true,
        url_token_data: {
          data:    shared_data,
          purpose: purpose_public
        }
      }
    end
    result_create_short_link = aoc_api.create('short_links', creation_params)
    # public: Creation: permission on node
    yield(result_create_short_link['resource_id']) if block_given? && link_type.eql?(:public)
    return {type: :single_object, data: result_create_short_link}
  when :list
    query = if link_type.eql?(:private)
      shared_data
    else
      {
        url_token_data: {
          data:    shared_data,
          purpose: purpose_public
        }
      }
    end
    list_params = {
      json_query:  query.to_json,
      purpose:     purpose_local,
      edit_access: true,
      # embed: 'updated_by_user',
      sort:        '-created_at'
    }
    return result_list('short_links', fields: Formatter.all_but('data'), base_query: list_params)
  when :delete
    one_id = instance_identifier
    shared_data.delete(:workspace_id)
    delete_params = {
      edit_access: true,
      json_query:  shared_data.to_json
    }
    aoc_api.delete("short_links/#{one_id}", delete_params)
    if link_type.eql?(:public)
      # TODO: get permission id..
      # shared_apfid[:api].delete('permissions', {ids: })
    end
    return Main.result_status('deleted')
  end
end