aspera-cli 4.25.3 → 4.25.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +40 -6
- data/CONTRIBUTING.md +122 -111
- data/README.md +9 -7
- data/lib/aspera/agent/direct.rb +10 -8
- data/lib/aspera/agent/factory.rb +3 -3
- data/lib/aspera/agent/node.rb +1 -1
- data/lib/aspera/api/alee.rb +1 -0
- data/lib/aspera/api/aoc.rb +15 -14
- data/lib/aspera/api/ats.rb +1 -1
- data/lib/aspera/api/cos_node.rb +5 -0
- data/lib/aspera/api/faspex.rb +27 -20
- data/lib/aspera/api/httpgw.rb +19 -3
- data/lib/aspera/api/node.rb +122 -29
- data/lib/aspera/ascp/installation.rb +9 -10
- data/lib/aspera/cli/error.rb +8 -0
- data/lib/aspera/cli/formatter.rb +27 -11
- data/lib/aspera/cli/info.rb +2 -1
- data/lib/aspera/cli/main.rb +30 -12
- data/lib/aspera/cli/manager.rb +43 -31
- data/lib/aspera/cli/plugins/aoc.rb +7 -5
- data/lib/aspera/cli/plugins/base.rb +1 -88
- data/lib/aspera/cli/plugins/config.rb +2 -1
- data/lib/aspera/cli/plugins/faspex.rb +6 -6
- data/lib/aspera/cli/plugins/faspex5.rb +64 -64
- data/lib/aspera/cli/plugins/node.rb +33 -78
- data/lib/aspera/cli/plugins/shares.rb +4 -2
- data/lib/aspera/cli/special_values.rb +1 -0
- data/lib/aspera/cli/transfer_agent.rb +3 -0
- data/lib/aspera/cli/version.rb +1 -1
- data/lib/aspera/cli/wizard.rb +2 -1
- data/lib/aspera/dot_container.rb +10 -10
- data/lib/aspera/log.rb +1 -1
- data/lib/aspera/markdown.rb +1 -1
- data/lib/aspera/persistency_folder.rb +1 -1
- data/lib/aspera/rest.rb +39 -54
- data/lib/aspera/rest_list.rb +121 -0
- data/lib/aspera/sync/operations.rb +1 -1
- data/lib/aspera/transfer/parameters.rb +8 -8
- data/lib/aspera/transfer/spec.rb +1 -0
- data/lib/aspera/yaml.rb +1 -1
- data.tar.gz.sig +0 -0
- metadata +4 -3
- metadata.gz.sig +0 -0
data/lib/aspera/cli/wizard.rb
CHANGED
|
@@ -62,7 +62,7 @@ module Aspera
|
|
|
62
62
|
detection_info = nil
|
|
63
63
|
begin
|
|
64
64
|
Log.log.debug{"detecting #{plugin_name_sym} at #{app_url}"}
|
|
65
|
-
|
|
65
|
+
RestParameters.instance.spinner_cb.call(plugin_name_sym.to_s)
|
|
66
66
|
detection_info = plugin_klass.detect(app_url)
|
|
67
67
|
rescue OpenSSL::SSL::SSLError => e
|
|
68
68
|
Log.log.warn(e.message)
|
|
@@ -78,6 +78,7 @@ module Aspera
|
|
|
78
78
|
# If there is a redirect, then the detector can override the url.
|
|
79
79
|
found_apps.push({product: plugin_name_sym, name: app_name, url: app_url, version: 'unknown'}.merge(detection_info))
|
|
80
80
|
end
|
|
81
|
+
RestParameters.instance.spinner_cb.call(action: :success)
|
|
81
82
|
raise "No known application found at #{app_url}" if found_apps.empty?
|
|
82
83
|
Aspera.assert(found_apps.all?{ |a| a.keys.all?(Symbol)})
|
|
83
84
|
return found_apps
|
data/lib/aspera/dot_container.rb
CHANGED
|
@@ -7,13 +7,14 @@ module Aspera
|
|
|
7
7
|
class DotContainer
|
|
8
8
|
class << self
|
|
9
9
|
# Insert extended value `value` into struct `result` at `path`
|
|
10
|
-
# @param path [String]
|
|
11
|
-
# @param value [
|
|
12
|
-
# @param result [
|
|
13
|
-
# @return [Hash, Array]
|
|
10
|
+
# @param path [Array<String>] Path in container
|
|
11
|
+
# @param value [Object] Value to insert in deep container
|
|
12
|
+
# @param result [nil, Hash, Array] Current container to use (or nil to create a new one)
|
|
13
|
+
# @return [Hash, Array] Container
|
|
14
14
|
def dotted_to_container(path, value, result = nil)
|
|
15
|
+
Aspera.assert_array_all(path, String)
|
|
15
16
|
# Typed keys
|
|
16
|
-
keys = path.
|
|
17
|
+
keys = path.map{ |k| int_or_string(k)}
|
|
17
18
|
# Create, or re-use first level container
|
|
18
19
|
current = (result ||= new_hash_or_array_from_key(keys.first))
|
|
19
20
|
# walk the path, and create sub-containers if necessary
|
|
@@ -78,7 +79,7 @@ module Aspera
|
|
|
78
79
|
to_insert = current.map{ |i| i['name']}
|
|
79
80
|
# Array of Hashes with only 'name' and 'value' keys -> Hash of key/values
|
|
80
81
|
elsif current.all?{ |i| i.is_a?(Hash) && i.keys.sort == %w[name value]}
|
|
81
|
-
add_elements(path, current.
|
|
82
|
+
add_elements(path, current.to_h{ |i| [i['name'], i['value']]})
|
|
82
83
|
else
|
|
83
84
|
add_elements(path, current.each_with_index.map{ |v, i| [i, v]})
|
|
84
85
|
end
|
|
@@ -86,7 +87,7 @@ module Aspera
|
|
|
86
87
|
to_insert = current
|
|
87
88
|
end
|
|
88
89
|
end
|
|
89
|
-
result[path.
|
|
90
|
+
result[path.join(SEPARATOR)] = to_insert unless to_insert.nil?
|
|
90
91
|
end
|
|
91
92
|
result
|
|
92
93
|
end
|
|
@@ -101,8 +102,7 @@ module Aspera
|
|
|
101
102
|
nil
|
|
102
103
|
end
|
|
103
104
|
|
|
104
|
-
#
|
|
105
|
-
|
|
106
|
-
private_constant :OPTION_DOTTED_SEPARATOR
|
|
105
|
+
# Dot-path separator: `.`
|
|
106
|
+
SEPARATOR = '.'
|
|
107
107
|
end
|
|
108
108
|
end
|
data/lib/aspera/log.rb
CHANGED
|
@@ -26,7 +26,7 @@ class Logger
|
|
|
26
26
|
# Hash
|
|
27
27
|
# key [Integer] Log level (e.g. 0 for DEBUG)
|
|
28
28
|
# value [Symbol] Uppercase log level label (e.g. :DEBUG)
|
|
29
|
-
SEVERITY_LABEL = Severity.constants.
|
|
29
|
+
SEVERITY_LABEL = Severity.constants.to_h{ |name| [Severity.const_get(name), name]}
|
|
30
30
|
|
|
31
31
|
# Override
|
|
32
32
|
# @param severity [Integer] Log severity as int
|
data/lib/aspera/markdown.rb
CHANGED
|
@@ -33,7 +33,7 @@ module Aspera
|
|
|
33
33
|
|
|
34
34
|
# type: NOTE CAUTION WARNING IMPORTANT TIP INFO
|
|
35
35
|
def admonition(lines, type: 'INFO')
|
|
36
|
-
"> [
|
|
36
|
+
"> [!#{type}]\n#{lines.map{ |l| "> #{l}"}.join("\n")}\n\n"
|
|
37
37
|
end
|
|
38
38
|
|
|
39
39
|
def code(lines, type: 'shell')
|
|
@@ -79,7 +79,7 @@ module Aspera
|
|
|
79
79
|
end
|
|
80
80
|
|
|
81
81
|
def current_items(persist_category)
|
|
82
|
-
current_files(persist_category).
|
|
82
|
+
current_files(persist_category).to_h{ |i| [File.basename(i, FILE_SUFFIX), File.read(i)]}
|
|
83
83
|
end
|
|
84
84
|
|
|
85
85
|
private
|
data/lib/aspera/rest.rb
CHANGED
|
@@ -33,7 +33,7 @@ module Aspera
|
|
|
33
33
|
class RestParameters
|
|
34
34
|
include Singleton
|
|
35
35
|
|
|
36
|
-
attr_accessor :user_agent, :download_partial_suffix, :retry_on_error, :retry_on_timeout, :retry_on_unavailable, :retry_max, :retry_sleep, :session_cb, :progress_bar
|
|
36
|
+
attr_accessor :user_agent, :download_partial_suffix, :retry_on_error, :retry_on_timeout, :retry_on_unavailable, :retry_max, :retry_sleep, :session_cb, :progress_bar, :spinner_cb
|
|
37
37
|
|
|
38
38
|
private
|
|
39
39
|
|
|
@@ -47,6 +47,7 @@ module Aspera
|
|
|
47
47
|
@retry_sleep = 4
|
|
48
48
|
@session_cb = nil
|
|
49
49
|
@progress_bar = nil
|
|
50
|
+
@spinner_cb = nil
|
|
50
51
|
end
|
|
51
52
|
end
|
|
52
53
|
|
|
@@ -71,11 +72,6 @@ module Aspera
|
|
|
71
72
|
# rest call errors are raised as exception RestCallError
|
|
72
73
|
# and error are analyzed in RestErrorAnalyzer
|
|
73
74
|
class Rest
|
|
74
|
-
# Special query parameter: max number of items for list command
|
|
75
|
-
MAX_ITEMS = 'max'
|
|
76
|
-
# Special query parameter: max number of pages for list command
|
|
77
|
-
MAX_PAGES = 'pmax'
|
|
78
|
-
|
|
79
75
|
class << self
|
|
80
76
|
# @return [String] Basic auth token
|
|
81
77
|
def basic_authorization(user, pass); return "Basic #{Base64.strict_encode64("#{user}:#{pass}")}"; end
|
|
@@ -88,8 +84,9 @@ module Aspera
|
|
|
88
84
|
query
|
|
89
85
|
end
|
|
90
86
|
|
|
91
|
-
# Build URI from URL and parameters and check it is http or https
|
|
92
|
-
# Check
|
|
87
|
+
# Build URI from URL and parameters and check it is `http` or `https`.
|
|
88
|
+
# Check if php style is specified.
|
|
89
|
+
# `nil` values in query result in key without value, e.g. `?a`, while empty string values result in `?a=`.
|
|
93
90
|
# @param url [String] The URL without query.
|
|
94
91
|
# @param query [Hash,Array,String] The query.
|
|
95
92
|
def build_uri(url, query)
|
|
@@ -105,18 +102,19 @@ module Aspera
|
|
|
105
102
|
URI.encode_www_form(h_to_query_array(query))
|
|
106
103
|
when Array
|
|
107
104
|
Aspera.assert(query.all?{ |i| i.is_a?(Array) && i.length.eql?(2)}){'Query must be array of arrays of 2 elements'}
|
|
108
|
-
URI.encode_www_form(query)
|
|
105
|
+
URI.encode_www_form(query) # remove nil values
|
|
109
106
|
else Aspera.error_unexpected_value(query.class){'query type'}
|
|
110
107
|
end.gsub('%5B%5D=', '[]=')
|
|
111
108
|
# [] is allowed in url parameters
|
|
112
109
|
uri
|
|
113
110
|
end
|
|
114
111
|
|
|
112
|
+
# Support array for query parameter, there is no standard.
|
|
113
|
+
# Either p=1&p=2 (default)
|
|
114
|
+
# or p[]=1&p[]=2 (if `:x_array_php_style` is set to true in query)
|
|
115
115
|
# @param query [Hash] HTTP query as hash
|
|
116
116
|
def h_to_query_array(query)
|
|
117
117
|
Aspera.assert_type(query, Hash)
|
|
118
|
-
# Support array for query parameter, there is no standard.
|
|
119
|
-
# Either p[]=1&p[]=2, or p=1&p=2
|
|
120
118
|
suffix = query.delete(:x_array_php_style) ? '[]' : nil
|
|
121
119
|
query.each_with_object([]) do |(k, v), query_array|
|
|
122
120
|
case v
|
|
@@ -171,6 +169,8 @@ module Aspera
|
|
|
171
169
|
# get Net::HTTP underlying socket i/o
|
|
172
170
|
# little hack, handy because HTTP debug, proxy, etc... will be available
|
|
173
171
|
# used implement web sockets after `start_http_session`
|
|
172
|
+
# @param http_session [Net::HTTP] the session object
|
|
173
|
+
# @return [Net::BufferedIO] The underlying socket i/o
|
|
174
174
|
def io_http_session(http_session)
|
|
175
175
|
Aspera.assert_type(http_session, Net::HTTP)
|
|
176
176
|
# Net::BufferedIO in net/protocol.rb
|
|
@@ -368,8 +368,11 @@ module Aspera
|
|
|
368
368
|
end
|
|
369
369
|
result_http = nil
|
|
370
370
|
result_data = nil
|
|
371
|
+
# initialize with number of initial retries allowed, nil gives zero
|
|
372
|
+
tries_remain_redirect = @redirect_max
|
|
371
373
|
# start a block to be able to retry the actual HTTP request in case of OAuth token expiration
|
|
372
374
|
begin
|
|
375
|
+
Log.log.debug("send request (retries=#{tries_remain_redirect})")
|
|
373
376
|
# TODO: shall we percent encode subpath (spaces) test with access key delete with space in id
|
|
374
377
|
# URI.escape()
|
|
375
378
|
separator = ['', '/'].include?(subpath) ? '' : '/'
|
|
@@ -403,16 +406,13 @@ module Aspera
|
|
|
403
406
|
Log.dump(:req_body, req.body, level: :trace1)
|
|
404
407
|
# we try the call, and will retry on some error types
|
|
405
408
|
error_tries ||= 1 + RestParameters.instance.retry_max
|
|
406
|
-
# initialize with number of initial retries allowed, nil gives zero
|
|
407
|
-
tries_remain_redirect = @redirect_max if tries_remain_redirect.nil?
|
|
408
|
-
Log.log.debug("send request (retries=#{tries_remain_redirect})")
|
|
409
409
|
result_mime = nil
|
|
410
410
|
file_saved = false
|
|
411
411
|
# make http request (pipelined)
|
|
412
412
|
http_session.request(req) do |response|
|
|
413
413
|
result_http = response
|
|
414
414
|
result_mime = self.class.parse_header(result_http['Content-Type'] || Mime::TEXT)[:type]
|
|
415
|
-
Log.log.debug{"response: code=#{result_http.code}, mime=#{result_mime},
|
|
415
|
+
Log.log.debug{"response: code=#{result_http.code}, mime=#{result_mime}, content-type=#{response['Content-Type']}"}
|
|
416
416
|
# JSON data needs to be parsed, in case it contains an error code
|
|
417
417
|
if !save_to_file.nil? &&
|
|
418
418
|
result_http.code.to_s.start_with?('2') &&
|
|
@@ -453,12 +453,13 @@ module Aspera
|
|
|
453
453
|
# TODO : related to mime type encoding ?
|
|
454
454
|
# result_http.body.force_encoding('UTF-8') if result_http.body.is_a?(String)
|
|
455
455
|
# Log.log.debug{"result: body=#{result_http.body}"}
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
456
|
+
result_data = result_http.body
|
|
457
|
+
Log.dump(:result_data_raw, result_data, level: :trace1)
|
|
458
|
+
# TODO: Remove next 2 lines when bug in async node api is fixed. (Aspera/core/issues/4490)
|
|
459
|
+
node_api_bug = result_data&.index('}HTTP/1.1 400 Bad Request') if result_data.is_a?(String)
|
|
460
|
+
result_data = result_data[0..node_api_bug] if node_api_bug
|
|
461
|
+
result_data = JSON.parse(result_data) if Mime.json?(result_mime) && !result_data.nil? && !result_data.empty?
|
|
462
|
+
Log.dump(:result_data, result_data)
|
|
462
463
|
RestErrorAnalyzer.instance.raise_on_error(req, result_data, result_http)
|
|
463
464
|
unless file_saved || save_to_file.nil?
|
|
464
465
|
FileUtils.mkdir_p(File.dirname(save_to_file))
|
|
@@ -536,55 +537,39 @@ module Aspera
|
|
|
536
537
|
|
|
537
538
|
# Create: `POST`
|
|
538
539
|
def create(subpath, params, **kwargs)
|
|
539
|
-
|
|
540
|
+
kwargs[:headers] ||= {}
|
|
541
|
+
kwargs[:headers]['Accept'] = Mime::JSON unless kwargs[:headers].key?('Accept')
|
|
542
|
+
kwargs[:content_type] = Mime::JSON unless kwargs.key?(:content_type)
|
|
543
|
+
return call(operation: 'POST', subpath: subpath, body: params, **kwargs)
|
|
540
544
|
end
|
|
541
545
|
|
|
542
546
|
# Read: `GET`
|
|
543
547
|
def read(subpath, query = nil, **kwargs)
|
|
544
|
-
|
|
548
|
+
kwargs[:headers] ||= {}
|
|
549
|
+
kwargs[:headers]['Accept'] = Mime::JSON unless kwargs[:headers].key?('Accept')
|
|
550
|
+
return call(operation: 'GET', subpath: subpath, query: query, **kwargs)
|
|
545
551
|
end
|
|
546
552
|
|
|
547
553
|
# Update: `PUT`
|
|
548
554
|
def update(subpath, params, **kwargs)
|
|
549
|
-
|
|
555
|
+
kwargs[:headers] ||= {}
|
|
556
|
+
kwargs[:headers]['Accept'] = Mime::JSON unless kwargs[:headers].key?('Accept')
|
|
557
|
+
kwargs[:content_type] = Mime::JSON unless kwargs.key?(:content_type)
|
|
558
|
+
return call(operation: 'PUT', subpath: subpath, body: params, **kwargs)
|
|
550
559
|
end
|
|
551
560
|
|
|
552
561
|
# Delete: `DELETE`
|
|
553
562
|
def delete(subpath, params = nil, **kwargs)
|
|
554
|
-
|
|
563
|
+
kwargs[:headers] ||= {}
|
|
564
|
+
kwargs[:headers]['Accept'] = Mime::JSON unless kwargs[:headers].key?('Accept')
|
|
565
|
+
return call(operation: 'DELETE', subpath: subpath, query: params, **kwargs)
|
|
555
566
|
end
|
|
556
567
|
|
|
557
568
|
# Cancel: `CANCEL`
|
|
558
569
|
def cancel(subpath, **kwargs)
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
# Query entity by general search (read with parameter `q`)
|
|
563
|
-
# TODO: not generic enough ? move somewhere ? inheritance ?
|
|
564
|
-
# @param subpath [String] Path of entity in API
|
|
565
|
-
# @param search_name [String] Name of searched entity
|
|
566
|
-
# @param query [Hash] Additional search query parameters
|
|
567
|
-
# @returns [Hash] A single entity matching the search, or an exception if not found or multiple found
|
|
568
|
-
def lookup_by_name(subpath, search_name, query: nil)
|
|
569
|
-
query = {} if query.nil?
|
|
570
|
-
# returns entities matching the query (it matches against several fields in case insensitive way)
|
|
571
|
-
matching_items = read(subpath, query.merge({'q' => search_name}))
|
|
572
|
-
# API style: {totalcount:, ...} cspell: disable-line
|
|
573
|
-
matching_items = matching_items[subpath] if matching_items.is_a?(Hash)
|
|
574
|
-
Aspera.assert_type(matching_items, Array)
|
|
575
|
-
case matching_items.length
|
|
576
|
-
when 1 then return matching_items.first
|
|
577
|
-
when 0 then raise EntityNotFound, %Q{No such #{subpath}: "#{search_name}"}
|
|
578
|
-
else
|
|
579
|
-
# multiple case insensitive partial matches, try case insensitive full match
|
|
580
|
-
# (anyway AoC does not allow creation of 2 entities with same case insensitive name)
|
|
581
|
-
name_matches = matching_items.select{ |i| i['name'].casecmp?(search_name)}
|
|
582
|
-
case name_matches.length
|
|
583
|
-
when 1 then return name_matches.first
|
|
584
|
-
when 0 then raise %Q(#{subpath}: Multiple case insensitive partial match for: "#{search_name}": #{matching_items.map{ |i| i['name']}} but no case insensitive full match. Please be more specific or give exact name.)
|
|
585
|
-
else raise "Two entities cannot have the same case insensitive name: #{name_matches.map{ |i| i['name']}}"
|
|
586
|
-
end
|
|
587
|
-
end
|
|
570
|
+
kwargs[:headers] ||= {}
|
|
571
|
+
kwargs[:headers]['Accept'] = Mime::JSON unless kwargs[:headers].key?('Accept')
|
|
572
|
+
return call(operation: 'CANCEL', subpath: subpath, **kwargs)
|
|
588
573
|
end
|
|
589
574
|
|
|
590
575
|
UNAVAILABLE_CODES = ['503']
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Aspera
|
|
4
|
+
# List and lookup methods for Rest
|
|
5
|
+
# To be included in classes inheriting Rest that require those methods.
|
|
6
|
+
module RestList
|
|
7
|
+
# `max`: special query parameter: max number of items for list command
|
|
8
|
+
MAX_ITEMS = 'max'
|
|
9
|
+
# `pmax`: special query parameter: max number of pages for list command
|
|
10
|
+
MAX_PAGES = 'pmax'
|
|
11
|
+
|
|
12
|
+
# Query entity by general search (read with parameter `q`)
|
|
13
|
+
#
|
|
14
|
+
# @param subpath [String] Path of entity in API
|
|
15
|
+
# @param search_name [String] Name of searched entity
|
|
16
|
+
# @param query [Hash] Optional additional search query parameters
|
|
17
|
+
# @returns [Hash] A single entity matching the search, or an exception if not found or multiple found
|
|
18
|
+
def lookup_by_name(subpath, search_name, query: nil)
|
|
19
|
+
query = {} if query.nil?
|
|
20
|
+
# returns entities matching the query (it matches against several fields in case insensitive way)
|
|
21
|
+
matching_items = read(subpath, query.merge({'q' => search_name}))
|
|
22
|
+
# API style: {totalcount:, ...} cspell: disable-line
|
|
23
|
+
matching_items = matching_items[subpath] if matching_items.is_a?(Hash)
|
|
24
|
+
Aspera.assert_type(matching_items, Array)
|
|
25
|
+
case matching_items.length
|
|
26
|
+
when 1 then return matching_items.first
|
|
27
|
+
when 0 then raise EntityNotFound, %Q{No such #{subpath}: "#{search_name}"}
|
|
28
|
+
else
|
|
29
|
+
# multiple case insensitive partial matches, try case insensitive full match
|
|
30
|
+
# (anyway AoC does not allow creation of 2 entities with same case insensitive name)
|
|
31
|
+
name_matches = matching_items.select{ |i| i['name'].casecmp?(search_name)}
|
|
32
|
+
case name_matches.length
|
|
33
|
+
when 1 then return name_matches.first
|
|
34
|
+
when 0 then raise %Q(#{subpath}: Multiple case insensitive partial match for: "#{search_name}": #{matching_items.map{ |i| i['name']}} but no case insensitive full match. Please be more specific or give exact name.)
|
|
35
|
+
else raise "Two entities cannot have the same case insensitive name: #{name_matches.map{ |i| i['name']}}"
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Get a (full or partial) list of all entities of a given type with query: offset/limit
|
|
41
|
+
# @param entity [String,Symbol] API endpoint of entity to list
|
|
42
|
+
# @param items_key [String] Key in the result to get the list of items (Default: same as `entity`)
|
|
43
|
+
# @param query [Hash,nil] Additional query parameters
|
|
44
|
+
# @return [Array<(Array<Hash>, Integer)>] items, total_count
|
|
45
|
+
def list_entities_limit_offset_total_count(
|
|
46
|
+
entity:,
|
|
47
|
+
items_key: nil,
|
|
48
|
+
query: nil
|
|
49
|
+
)
|
|
50
|
+
entity = entity.to_s if entity.is_a?(Symbol)
|
|
51
|
+
items_key = entity.split('/').last if items_key.nil?
|
|
52
|
+
query = {} if query.nil?
|
|
53
|
+
Aspera.assert_type(entity, String)
|
|
54
|
+
Aspera.assert_type(items_key, String)
|
|
55
|
+
Aspera.assert_type(query, Hash)
|
|
56
|
+
Log.log.debug{"list_entities t=#{entity} k=#{items_key} q=#{query}"}
|
|
57
|
+
result = []
|
|
58
|
+
offset = 0
|
|
59
|
+
max_items = query.delete(MAX_ITEMS)
|
|
60
|
+
remain_pages = query.delete(MAX_PAGES)
|
|
61
|
+
# Merge default parameters, by default 100 per page
|
|
62
|
+
query = {'limit'=> PER_PAGE_DEFAULT}.merge(query)
|
|
63
|
+
total_count = nil
|
|
64
|
+
loop do
|
|
65
|
+
query['offset'] = offset
|
|
66
|
+
page_result = read(entity, query)
|
|
67
|
+
Aspera.assert_type(page_result[items_key], Array)
|
|
68
|
+
result.concat(page_result[items_key])
|
|
69
|
+
# Reach the limit set by user ?
|
|
70
|
+
if !max_items.nil? && (result.length >= max_items)
|
|
71
|
+
result = result.slice(0, max_items)
|
|
72
|
+
break
|
|
73
|
+
end
|
|
74
|
+
total_count ||= page_result['total_count']
|
|
75
|
+
break if result.length >= total_count
|
|
76
|
+
remain_pages -= 1 unless remain_pages.nil?
|
|
77
|
+
break if remain_pages == 0
|
|
78
|
+
offset += page_result[items_key].length
|
|
79
|
+
RestParameters.instance.spinner_cb.call("#{result.length} / #{total_count || '?'}")
|
|
80
|
+
end
|
|
81
|
+
RestParameters.instance.spinner_cb.call(action: :success)
|
|
82
|
+
return result, total_count
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Lookup an entity id from its name.
|
|
86
|
+
# Uses query `q` if `query` is `:default` and `field` is `name`.
|
|
87
|
+
# @param entity [String] Type of entity to lookup, by default it is the path, and it is also the field name in result
|
|
88
|
+
# @param value [String] Value to lookup
|
|
89
|
+
# @param field [String] Field to match, by default it is `'name'`
|
|
90
|
+
# @param items_key [String] Key in the result to get the list of items (override entity)
|
|
91
|
+
# @param query [Hash] Additional query parameters (Default: `:default`)
|
|
92
|
+
def lookup_entity_by_field(entity:, value:, field: 'name', items_key: nil, query: :default)
|
|
93
|
+
if query.eql?(:default)
|
|
94
|
+
Aspera.assert(field.eql?('name')){'Default query is on name only'}
|
|
95
|
+
query = {'q'=> value}
|
|
96
|
+
end
|
|
97
|
+
lookup_entity_generic(entity: entity, field: field, value: value){list_entities_limit_offset_total_count(entity: entity, items_key: items_key, query: query).first}
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Lookup entity by field and value.
|
|
101
|
+
# Extracts a single result from the list returned by the block.
|
|
102
|
+
#
|
|
103
|
+
# @param entity [String] Type of entity to lookup (path, and by default it is also the field name in result)
|
|
104
|
+
# @param value [String] Value to match against the field.
|
|
105
|
+
# @param field [String] Field to match in the hashes (defaults to 'name').
|
|
106
|
+
# @yield [] A mandatory block that returns an Array of Hashes.
|
|
107
|
+
# @return [Hash] The unique matching object.
|
|
108
|
+
# @raise [Cli::BadIdentifier] If 0 or >1 matches are found.
|
|
109
|
+
def lookup_entity_generic(entity:, value:, field: 'name')
|
|
110
|
+
Aspera.assert(block_given?)
|
|
111
|
+
found = yield
|
|
112
|
+
Aspera.assert_array_all(found, Hash)
|
|
113
|
+
found = found.select{ |i| i[field].eql?(value)}
|
|
114
|
+
return found.first if found.length.eql?(1)
|
|
115
|
+
raise Cli::BadIdentifier.new(entity, value, field: field, count: found.length)
|
|
116
|
+
end
|
|
117
|
+
PER_PAGE_DEFAULT = 1000
|
|
118
|
+
private_constant :PER_PAGE_DEFAULT
|
|
119
|
+
module_function :lookup_entity_generic
|
|
120
|
+
end
|
|
121
|
+
end
|
|
@@ -342,7 +342,7 @@ module Aspera
|
|
|
342
342
|
CONF_SCHEMA = CommandLineBuilder.read_schema(__dir__, 'conf')
|
|
343
343
|
CMDLINE_PARAMS_KEYS = %w[instance sessions].freeze
|
|
344
344
|
ASYNC_ADMIN_EXECUTABLE = 'asyncadmin'
|
|
345
|
-
PRIVATE_FOLDER = '.private-asp
|
|
345
|
+
PRIVATE_FOLDER = "#{Environment.instance.os.eql?(Environment::OS_WINDOWS) ? '~' : '.'}private-asp"
|
|
346
346
|
ASYNC_DB = 'snap.db'
|
|
347
347
|
PARAM_KEYS = %w[local sessions].freeze
|
|
348
348
|
|
|
@@ -38,19 +38,19 @@ module Aspera
|
|
|
38
38
|
@file_list_folder ||= TempFileManager.instance.new_file_path_global('asession_filelists')
|
|
39
39
|
end
|
|
40
40
|
|
|
41
|
-
# File list is provided directly with ascp arguments
|
|
42
|
-
# @columns ascp_args [Array,NilClass] ascp arguments
|
|
41
|
+
# File list is provided directly with `ascp` arguments
|
|
42
|
+
# @columns ascp_args [Array,NilClass] `ascp` arguments
|
|
43
43
|
def ascp_args_file_list?(ascp_args)
|
|
44
44
|
ascp_args&.any?{ |i| FILE_LIST_OPTIONS.include?(i)}
|
|
45
45
|
end
|
|
46
46
|
end
|
|
47
47
|
|
|
48
|
-
# @param job_spec [Hash]
|
|
49
|
-
# @param ascp_args [Array]
|
|
50
|
-
# @param quiet [Boolean]
|
|
51
|
-
# @param
|
|
52
|
-
# @param
|
|
53
|
-
# @param check_ignore_cb [Proc]
|
|
48
|
+
# @param job_spec [Hash] Transfer specification
|
|
49
|
+
# @param ascp_args [Array] Other `ascp` args
|
|
50
|
+
# @param quiet [Boolean] Remove `ascp` progress bar if `true`
|
|
51
|
+
# @param client_ssh_key [:rsa,:dsa] Type of Aspera Client SSH key to use.
|
|
52
|
+
# @param trusted_certs [Array<String>] List of path to trusted certificates stores when using WSS
|
|
53
|
+
# @param check_ignore_cb [Proc] Callback to check if WSS connection shall ignore certificate validity
|
|
54
54
|
def initialize(
|
|
55
55
|
job_spec,
|
|
56
56
|
ascp_args: nil,
|
data/lib/aspera/transfer/spec.rb
CHANGED
|
@@ -25,6 +25,7 @@ module Aspera
|
|
|
25
25
|
TRANSPORT_FIELDS = (%w[remote_host] + AK_TSPEC_BASE.keys + WSS_FIELDS).freeze
|
|
26
26
|
# reserved tag for Aspera
|
|
27
27
|
TAG_RESERVED = 'aspera'
|
|
28
|
+
SPECIFIC = %w{token paths direction source_root destination_root}.freeze
|
|
28
29
|
class << self
|
|
29
30
|
# wrong def in transferd
|
|
30
31
|
POLICY_FIX = {
|
data/lib/aspera/yaml.rb
CHANGED
|
@@ -25,7 +25,7 @@ module Aspera
|
|
|
25
25
|
counts.each do |key_str, count|
|
|
26
26
|
next if count <= 1
|
|
27
27
|
path = (parent_path + [key_str]).join('.')
|
|
28
|
-
occurrences = key_nodes[key_str].map{ |kn| kn.start_line ? kn.start_line + 1 : 'unknown'}.
|
|
28
|
+
occurrences = key_nodes[key_str].map{ |kn| kn.start_line ? kn.start_line + 1 : 'unknown'}.join(', ')
|
|
29
29
|
duplicate_keys << "#{path}: #{occurrences}"
|
|
30
30
|
end
|
|
31
31
|
else
|
data.tar.gz.sig
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: aspera-cli
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.25.
|
|
4
|
+
version: 4.25.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Laurent Martin
|
|
@@ -424,6 +424,7 @@ files:
|
|
|
424
424
|
- lib/aspera/rest_call_error.rb
|
|
425
425
|
- lib/aspera/rest_error_analyzer.rb
|
|
426
426
|
- lib/aspera/rest_errors_aspera.rb
|
|
427
|
+
- lib/aspera/rest_list.rb
|
|
427
428
|
- lib/aspera/secret_hider.rb
|
|
428
429
|
- lib/aspera/ssh.rb
|
|
429
430
|
- lib/aspera/ssl.rb
|
|
@@ -456,7 +457,7 @@ metadata:
|
|
|
456
457
|
source_code_uri: https://github.com/IBM/aspera-cli/tree/main/lib/aspera
|
|
457
458
|
changelog_uri: https://github.com/IBM/aspera-cli/blob/main/CHANGELOG.md
|
|
458
459
|
rubygems_uri: https://rubygems.org/gems/aspera-cli
|
|
459
|
-
documentation_uri: https://
|
|
460
|
+
documentation_uri: https://ibm.biz/ascli-doc
|
|
460
461
|
rdoc_options: []
|
|
461
462
|
require_paths:
|
|
462
463
|
- lib
|
|
@@ -472,7 +473,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
472
473
|
version: '0'
|
|
473
474
|
requirements:
|
|
474
475
|
- Read the manual for any requirement
|
|
475
|
-
rubygems_version: 4.0.
|
|
476
|
+
rubygems_version: 4.0.6
|
|
476
477
|
specification_version: 4
|
|
477
478
|
summary: 'Execute actions using command line on IBM Aspera Server products: Aspera
|
|
478
479
|
on Cloud, Faspex, Shares, Node, Console, Orchestrator, High Speed Transfer Server'
|
metadata.gz.sig
CHANGED
|
Binary file
|