aspera-cli 4.28.0 → 4.29.0

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.
Files changed (237) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +143 -2
  5. data/CODE_OF_CONDUCT.md +18 -0
  6. data/CONTRIBUTING.md +135 -56
  7. data/GOVERNANCE.md +30 -0
  8. data/LICENSE +201 -0
  9. data/README.md +103 -26
  10. data/SECURITY.md +70 -0
  11. data/bin/ascli +8 -5
  12. data/bin/asession +9 -6
  13. data/docs/README.md +1633 -609
  14. data/docs/test-mcp-with-ai.md +8 -8
  15. data/lib/aspera/agent/base.rb +23 -2
  16. data/lib/aspera/agent/connect.rb +16 -12
  17. data/lib/aspera/agent/desktop.rb +10 -7
  18. data/lib/aspera/agent/direct.rb +20 -19
  19. data/lib/aspera/agent/factory.rb +6 -3
  20. data/lib/aspera/agent/httpgw.rb +7 -5
  21. data/lib/aspera/agent/node.rb +15 -7
  22. data/lib/aspera/agent/transferd.rb +167 -43
  23. data/lib/aspera/api/alee.rb +4 -1
  24. data/lib/aspera/api/aoc.rb +14 -11
  25. data/lib/aspera/api/ats.rb +4 -2
  26. data/lib/aspera/api/cos_node.rb +7 -4
  27. data/lib/aspera/api/faspex.rb +16 -9
  28. data/lib/aspera/api/httpgw.rb +9 -6
  29. data/lib/aspera/api/node.rb +20 -20
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +71 -65
  32. data/lib/aspera/ascp/log.schema.yaml +1084 -0
  33. data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
  34. data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
  35. data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
  36. data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
  37. data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
  38. data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
  39. data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
  40. data/lib/aspera/ascp/log_analyzer.rb +354 -0
  41. data/lib/aspera/ascp/management.rb +16 -8
  42. data/lib/aspera/ascp/session_errors.rb +217 -0
  43. data/lib/aspera/assert.rb +4 -0
  44. data/lib/aspera/cli/ascp_actions.rb +12 -19
  45. data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
  46. data/lib/aspera/cli/async_transfer_store.rb +7 -4
  47. data/lib/aspera/cli/bootstrapper.rb +37 -33
  48. data/lib/aspera/cli/command_line.rb +24 -6
  49. data/lib/aspera/cli/command_registry.rb +6 -1
  50. data/lib/aspera/cli/command_spec.rb +34 -7
  51. data/lib/aspera/cli/completion/ascli.bash +19 -5
  52. data/lib/aspera/cli/completion/ascli.fish +13 -2
  53. data/lib/aspera/cli/completion/ascli.ps1 +31 -9
  54. data/lib/aspera/cli/completion/ascli.zsh +22 -6
  55. data/lib/aspera/cli/completion_actions.rb +303 -69
  56. data/lib/aspera/cli/context.rb +9 -4
  57. data/lib/aspera/cli/deprecation.rb +5 -2
  58. data/lib/aspera/cli/error.rb +3 -0
  59. data/lib/aspera/cli/extended_value.rb +61 -27
  60. data/lib/aspera/cli/formatter.rb +29 -22
  61. data/lib/aspera/cli/gem_checker.rb +9 -6
  62. data/lib/aspera/cli/hints.rb +22 -10
  63. data/lib/aspera/cli/http.rb +12 -9
  64. data/lib/aspera/cli/info.rb +12 -7
  65. data/lib/aspera/cli/mailer.rb +6 -3
  66. data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
  67. data/lib/aspera/cli/mcp/secrets.rb +8 -5
  68. data/lib/aspera/cli/mcp/tool.rb +15 -14
  69. data/lib/aspera/cli/option_declarator.rb +10 -4
  70. data/lib/aspera/cli/option_registry.rb +6 -3
  71. data/lib/aspera/cli/option_types.rb +17 -2
  72. data/lib/aspera/cli/option_value.rb +65 -12
  73. data/lib/aspera/cli/options.schema.yaml +487 -63
  74. data/lib/aspera/cli/parser.rb +56 -32
  75. data/lib/aspera/cli/plugins/alee.rb +7 -4
  76. data/lib/aspera/cli/plugins/aoc.rb +244 -35
  77. data/lib/aspera/cli/plugins/ats.rb +9 -8
  78. data/lib/aspera/cli/plugins/base.rb +17 -12
  79. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  80. data/lib/aspera/cli/plugins/config.rb +198 -103
  81. data/lib/aspera/cli/plugins/console.rb +6 -3
  82. data/lib/aspera/cli/plugins/cos.rb +8 -4
  83. data/lib/aspera/cli/plugins/factory.rb +21 -7
  84. data/lib/aspera/cli/plugins/faspex5.rb +28 -25
  85. data/lib/aspera/cli/plugins/faspio.rb +7 -5
  86. data/lib/aspera/cli/plugins/httpgw.rb +7 -4
  87. data/lib/aspera/cli/plugins/mcp.rb +28 -22
  88. data/lib/aspera/cli/plugins/node.rb +31 -30
  89. data/lib/aspera/cli/plugins/oauth.rb +5 -1
  90. data/lib/aspera/cli/plugins/orchestrator.rb +272 -72
  91. data/lib/aspera/cli/plugins/preview.rb +69 -44
  92. data/lib/aspera/cli/plugins/server.rb +63 -11
  93. data/lib/aspera/cli/plugins/shares.rb +86 -16
  94. data/lib/aspera/cli/plugins/transferd.rb +223 -0
  95. data/lib/aspera/cli/preset_actions.rb +144 -30
  96. data/lib/aspera/cli/preset_manager.rb +52 -18
  97. data/lib/aspera/cli/prompt.rb +4 -1
  98. data/lib/aspera/cli/result.rb +12 -8
  99. data/lib/aspera/cli/runner.rb +69 -46
  100. data/lib/aspera/cli/secret_finder.rb +4 -1
  101. data/lib/aspera/cli/security.rb +79 -9
  102. data/lib/aspera/cli/special_values.rb +4 -1
  103. data/lib/aspera/cli/sync_actions.rb +13 -10
  104. data/lib/aspera/cli/table_fitter.rb +3 -0
  105. data/lib/aspera/cli/terminal_formatter.rb +9 -6
  106. data/lib/aspera/cli/transfer_actions.rb +11 -8
  107. data/lib/aspera/cli/transfer_agent.rb +29 -20
  108. data/lib/aspera/cli/transfer_progress.rb +13 -45
  109. data/lib/aspera/cli/vault_actions.rb +45 -0
  110. data/lib/aspera/cli/vault_manager.rb +188 -42
  111. data/lib/aspera/cli/version.rb +4 -1
  112. data/lib/aspera/cli/web_secret.rb +12 -10
  113. data/lib/aspera/cli/wizard.rb +42 -39
  114. data/lib/aspera/command_line_builder.rb +9 -5
  115. data/lib/aspera/command_line_converter.rb +4 -1
  116. data/lib/aspera/coverage.rb +103 -33
  117. data/lib/aspera/data_repository.rb +4 -1
  118. data/lib/aspera/dot_container.rb +4 -1
  119. data/lib/aspera/duration.rb +5 -2
  120. data/lib/aspera/environment.rb +21 -12
  121. data/lib/aspera/exec_spec.rb +3 -0
  122. data/lib/aspera/faspex_gw.rb +13 -9
  123. data/lib/aspera/faspex_postproc.rb +15 -12
  124. data/lib/aspera/formatter_interface.rb +4 -1
  125. data/lib/aspera/graphql.rb +5 -1
  126. data/lib/aspera/hash_ext.rb +3 -0
  127. data/lib/aspera/id_generator.rb +4 -2
  128. data/lib/aspera/json_rpc/client.rb +6 -5
  129. data/lib/aspera/json_rpc/version.rb +3 -0
  130. data/lib/aspera/line_logger.rb +4 -1
  131. data/lib/aspera/link_header.rb +4 -1
  132. data/lib/aspera/log.rb +18 -5
  133. data/lib/aspera/markdown.rb +5 -2
  134. data/lib/aspera/mime.rb +3 -0
  135. data/lib/aspera/nagios.rb +6 -4
  136. data/lib/aspera/node_emulator.rb +15 -13
  137. data/lib/aspera/oauth/client/base.rb +91 -70
  138. data/lib/aspera/oauth/client/boot.rb +7 -4
  139. data/lib/aspera/oauth/client/factory.rb +6 -3
  140. data/lib/aspera/oauth/client/generic.rb +5 -1
  141. data/lib/aspera/oauth/client/json_credentials.rb +4 -1
  142. data/lib/aspera/oauth/client/jwt.rb +6 -3
  143. data/lib/aspera/oauth/client/shares_web.rb +85 -0
  144. data/lib/aspera/oauth/client/url_json.rb +4 -1
  145. data/lib/aspera/oauth/client/web.rb +39 -12
  146. data/lib/aspera/oauth/server/pkce.rb +6 -5
  147. data/lib/aspera/orchestrator_workflow_checker.rb +119 -1
  148. data/lib/aspera/persistency_action_once.rb +5 -3
  149. data/lib/aspera/persistency_folder.rb +6 -3
  150. data/lib/aspera/preview/file_types.rb +6 -3
  151. data/lib/aspera/preview/generator.rb +9 -5
  152. data/lib/aspera/preview/options.schema.yaml +3 -3
  153. data/lib/aspera/preview/terminal.rb +8 -4
  154. data/lib/aspera/preview/utils.rb +6 -4
  155. data/lib/aspera/products/connect.rb +5 -2
  156. data/lib/aspera/products/desktop.rb +4 -1
  157. data/lib/aspera/products/other.rb +4 -2
  158. data/lib/aspera/products/transferd.rb +6 -2
  159. data/lib/aspera/products/transferd_service.rb +610 -0
  160. data/lib/aspera/proxy_auto_config.js +2 -2
  161. data/lib/aspera/proxy_auto_config.rb +5 -2
  162. data/lib/aspera/rainbow.rb +3 -0
  163. data/lib/aspera/rest/aspera_errors.rb +4 -1
  164. data/lib/aspera/rest/call_error.rb +3 -0
  165. data/lib/aspera/rest/client.rb +22 -29
  166. data/lib/aspera/rest/error_analyzer.rb +5 -2
  167. data/lib/aspera/rest/list.rb +8 -4
  168. data/lib/aspera/rest/parameters.rb +3 -0
  169. data/lib/aspera/rest/util.rb +8 -5
  170. data/lib/aspera/rest.rb +9 -6
  171. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
  172. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
  173. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  174. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  175. data/lib/aspera/schema/async_tables.yaml +11 -10
  176. data/lib/aspera/schema/documentation.rb +8 -2
  177. data/lib/aspera/schema/reader.rb +7 -0
  178. data/lib/aspera/schema/registry.rb +43 -28
  179. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  180. data/lib/aspera/schema/validator.rb +4 -1
  181. data/lib/aspera/sealed_hash.rb +166 -0
  182. data/lib/aspera/secret/hider.rb +201 -0
  183. data/lib/aspera/secret/reference.rb +150 -0
  184. data/lib/aspera/secret/resolver.rb +212 -0
  185. data/lib/aspera/secret/store/base.rb +153 -0
  186. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  187. data/lib/aspera/secret/store/factory.rb +103 -0
  188. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  189. data/lib/aspera/secret/store/keeper.rb +141 -0
  190. data/lib/aspera/secret/store/macos_security.rb +284 -0
  191. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  192. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  193. data/lib/aspera/secret/store/one_password_cli.rb +110 -0
  194. data/lib/aspera/secret/store/secret_service.rb +125 -0
  195. data/lib/aspera/secret/strength.rb +119 -0
  196. data/lib/aspera/servlet_helpers.rb +5 -2
  197. data/lib/aspera/ssh.rb +10 -7
  198. data/lib/aspera/ssl.rb +5 -2
  199. data/lib/aspera/string_ext.rb +3 -0
  200. data/lib/aspera/sync/args.schema.yaml +3 -0
  201. data/lib/aspera/sync/conf.schema.yaml +9 -4
  202. data/lib/aspera/sync/database.rb +3 -0
  203. data/lib/aspera/sync/operations.rb +16 -14
  204. data/lib/aspera/temp_file_manager.rb +8 -4
  205. data/lib/aspera/timer_limiter.rb +3 -0
  206. data/lib/aspera/transfer/error.rb +4 -1
  207. data/lib/aspera/transfer/faux_file.rb +4 -1
  208. data/lib/aspera/transfer/parameters.rb +17 -14
  209. data/lib/aspera/transfer/result.rb +3 -0
  210. data/lib/aspera/transfer/resumer.rb +6 -4
  211. data/lib/aspera/transfer/spec.rb +9 -22
  212. data/lib/aspera/transfer/units.rb +75 -0
  213. data/lib/aspera/uri_reader.rb +57 -7
  214. data/lib/aspera/web_auth/index.html.erb +6 -2
  215. data/lib/aspera/web_auth/paste.rb +109 -0
  216. data/lib/aspera/web_auth/receiver.rb +50 -0
  217. data/lib/aspera/web_auth/relay.rb +76 -0
  218. data/lib/aspera/web_auth/reply.html.erb +150 -0
  219. data/lib/aspera/web_auth/server.rb +47 -10
  220. data/lib/aspera/web_page.rb +7 -2
  221. data/lib/aspera/web_server_simple.rb +6 -3
  222. data/lib/aspera/yaml.rb +5 -1
  223. data/llms.txt +81 -0
  224. data/skills/ascli/SKILL.md +88 -0
  225. data.tar.gz.sig +0 -0
  226. metadata +72 -19
  227. metadata.gz.sig +0 -0
  228. data/lib/aspera/keychain/base.rb +0 -30
  229. data/lib/aspera/keychain/encrypted_hash.rb +0 -192
  230. data/lib/aspera/keychain/factory.rb +0 -58
  231. data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
  232. data/lib/aspera/keychain/macos_security.rb +0 -277
  233. data/lib/aspera/keychain/one_password_api.rb +0 -91
  234. data/lib/aspera/keychain/one_password_base.rb +0 -39
  235. data/lib/aspera/keychain/one_password_cli.rb +0 -100
  236. data/lib/aspera/secret_hider.rb +0 -196
  237. data/lib/aspera/secret_strength.rb +0 -114
@@ -1,21 +1,23 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # cspell:ignore csvt jsonpp stdbin
4
- require 'aspera/uri_reader'
5
- require 'aspera/environment'
6
- require 'aspera/yaml'
7
- require 'aspera/log'
8
- require 'aspera/assert'
9
- require 'aspera/secret_hider'
10
- require 'aspera/cli/error'
11
- require 'aspera/cli/prompt'
12
- require 'aspera/cli/security'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../uri_reader'
7
+ require_relative '../environment'
8
+ require_relative '../yaml'
9
+ require_relative '../log'
10
+ require_relative '../assert'
11
+ require_relative '../secret/hider'
12
+ require_relative 'error'
13
+ require_relative 'prompt'
14
+ require_relative 'security'
15
+ require_relative '../rainbow'
13
16
  require 'json'
14
17
  require 'base64'
15
18
  require 'zlib'
16
19
  require 'csv'
17
20
  require 'singleton'
18
- require 'aspera/rainbow'
19
21
  using Rainbow
20
22
 
21
23
  module Aspera
@@ -29,7 +31,7 @@ module Aspera
29
31
  include Singleton
30
32
 
31
33
  # First is default
32
- DEFAULT_DECODERS = %i[none json ruby yaml]
34
+ DEFAULT_DECODERS = %i[none json ruby yaml].freeze
33
35
 
34
36
  class << self
35
37
  # Decode comma separated table text
@@ -82,7 +84,7 @@ module Aspera
82
84
  def read_secret(prompt)
83
85
  prompt = 'secret' if prompt.empty?
84
86
  return Prompt.prompt_user_input(prompt, sensitive: true) unless Environment.instance.url_method.eql?(:graphical)
85
- require 'aspera/cli/web_secret'
87
+ require_relative 'web_secret'
86
88
  WebSecret.ask(prompt)
87
89
  end
88
90
 
@@ -124,18 +126,42 @@ module Aspera
124
126
  zlib: lambda { |i| Zlib::Inflate.inflate(i) },
125
127
  extend: lambda { |i| ExtendedValue.instance.evaluate_extend(i) }
126
128
  }
129
+ # Descriptions of handlers, for shell completion
130
+ # @type [Hash{Symbol => String}]
131
+ @descriptions = {
132
+ val: 'Value as is: modifiers on the right are not evaluated',
133
+ base64: 'Decode Base64',
134
+ csvt: 'Decode titled CSV: Array of Hash',
135
+ env: 'Value of environment variable',
136
+ file: 'Content of local file',
137
+ uri: 'Content of URL: http:, https:, data:, file:',
138
+ json: 'Decode JSON',
139
+ lines: 'Split lines: Array',
140
+ list: 'Split on first character: Array',
141
+ none: 'Null value',
142
+ path: 'Local path, with ~ expanded',
143
+ re: 'Regular expression',
144
+ ruby: 'Evaluate Ruby code',
145
+ s: 'Convert to String',
146
+ secret: 'Ask secret, with prompt',
147
+ stdin: 'Read standard input: empty, bin or chomp',
148
+ yaml: 'Decode YAML',
149
+ zlib: 'Decompress zlib',
150
+ extend: 'Evaluate embedded @<modifier>:<value>@'
151
+ }
127
152
  @regex_single = nil
128
- @regex_extend = nil
153
+ @regex_inner = nil
129
154
  @default_decoder = nil
130
155
  update_regex
131
156
  end
132
157
 
133
158
  # Update the Regex to match an extended value based on @handlers
134
- # Anchored on the whole value (`\A`, `\z`), not on lines: a multi-line value is extended only if it starts with a modifier.
159
+ # Single: anchored on the whole value (`\A`, `\z`), not on lines: a multi-line value is extended only if it starts with a modifier.
160
+ # Inner: an extended value embedded in a text, for `@extend:`
135
161
  def update_regex
136
- handler_regex = "#{MARKER_START}(#{modifiers.join('|')})#{MARKER_END}"
162
+ handler_regex = "#{MARKER_START}(#{Regexp.union(modifiers.map(&:to_s)).source})#{MARKER_END}"
137
163
  @regex_single = Regexp.new("\\A#{handler_regex}(.*)\\z", Regexp::MULTILINE)
138
- @regex_extend = Regexp.new("\\A(.*)#{handler_regex}([^#{MARKER_IN_END}]*)#{MARKER_IN_END}(.*)\\z", Regexp::MULTILINE)
164
+ @regex_inner = Regexp.new("#{handler_regex}([^#{MARKER_IN_END}]*)#{MARKER_IN_END}")
139
165
  end
140
166
 
141
167
  public
@@ -152,12 +178,19 @@ module Aspera
152
178
  # List of Extended Value methods
153
179
  def modifiers; @handlers.keys; end
154
180
 
155
- # Add a new handler
156
- def on(name, &block)
181
+ # @param name [Symbol] Extended Value method
182
+ # @return [String, nil] description of the method, for shell completion
183
+ def description(name) = @descriptions[name]
184
+
185
+ # Add a new handler, or replace one
186
+ # @param name [Symbol] method, used as `@<name>:`
187
+ # @param description [String, nil] description, for shell completion; `nil` keeps the current one
188
+ def on(name, description: nil, &block)
157
189
  Aspera.assert_type(name, Symbol) { 'name' }
158
190
  Aspera.assert(block) { "block required when registering handler for #{name}" }
159
191
  Log.log.debug { "Setting handler for #{name}" }
160
192
  @handlers[name] = block
193
+ @descriptions[name] = description unless description.nil?
161
194
  update_regex
162
195
  end
163
196
 
@@ -186,30 +219,31 @@ module Aspera
186
219
  handlers_reversed.each_with_index do |handler, index|
187
220
  Security.instance.check_extended_value(handler)
188
221
  # The value read by the previous handler may be a secret
189
- Security.instance.check_secret_processing("@#{handler}") { SecretHider.instance.contains_secret?(value) } if index.positive?
222
+ Security.instance.check_secret_processing("@#{handler}") { Secret::Hider.instance.contains_secret?(value) } if index.positive?
190
223
  value = @handlers[handler].call(value)
191
224
  # Values read from a secret source are hidden wherever they appear: logs, results
192
225
  if SECRET_HANDLERS.include?(handler)
193
- value.is_a?(String) ? SecretHider.instance.add_secret_values(value) : SecretHider.instance.add_secrets_in(value)
226
+ value.is_a?(String) ? Secret::Hider.instance.add_secret_values(value) : Secret::Hider.instance.add_secrets_in(value)
194
227
  end
195
228
  rescue => e
196
- raise BadArgument, "Evaluation of #{handler} for #{context}: #{e.message}"
229
+ raise BadArgument, "Evaluation of #{MARKER_START}#{handler}#{MARKER_END} for #{context}: #{e.message}"
197
230
  end
198
231
  return value
199
232
  end
200
233
 
201
234
  # Find inner extended values
235
+ # Evaluated values are inserted as is: not evaluated again
202
236
  # Only used in above lambda
203
237
  def evaluate_extend(value)
204
- while (m = value.match(@regex_extend))
205
- sub_value = "@#{m[2]}:#{m[3]}"
238
+ value.gsub(@regex_inner) do
239
+ m = Regexp.last_match
240
+ sub_value = "@#{m[1]}:#{m[2]}"
206
241
  Log.log.debug { "evaluating #{sub_value}" }
207
242
  sub_value = evaluate(sub_value, context: 'composite extended value')
208
243
  # In a text, a secret is not the whole value
209
- Security.instance.check_secret_processing('@extend') { SecretHider.instance.contains_secret?(sub_value) }
210
- value = "#{m[1]}#{sub_value}#{m[4]}"
244
+ Security.instance.check_secret_processing('@extend') { Secret::Hider.instance.contains_secret?(sub_value) }
245
+ sub_value.to_s
211
246
  end
212
- return value
213
247
  end
214
248
  # marker "@"
215
249
  MARKER_START = '@'
@@ -1,24 +1,26 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # cspell:ignore jsonpp
4
- require 'aspera/schema/registry'
5
- require 'aspera/cli/option_declarator'
6
- require 'aspera/cli/special_values'
7
- require 'aspera/cli/terminal_formatter'
8
- require 'aspera/cli/table_fitter'
9
- require 'aspera/preview/terminal'
10
- require 'aspera/secret_hider'
11
- require 'aspera/environment'
12
- require 'aspera/log'
13
- require 'aspera/assert'
14
- require 'aspera/markdown'
15
- require 'aspera/dot_container'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../schema/registry'
7
+ require_relative 'option_declarator'
8
+ require_relative 'special_values'
9
+ require_relative 'terminal_formatter'
10
+ require_relative 'table_fitter'
11
+ require_relative '../preview/terminal'
12
+ require_relative '../secret/hider'
13
+ require_relative '../environment'
14
+ require_relative '../log'
15
+ require_relative '../assert'
16
+ require_relative '../markdown'
17
+ require_relative '../dot_container'
18
+ require_relative '../rainbow'
16
19
  require 'tty-spinner'
17
20
  require 'json'
18
21
  require 'yaml'
19
22
  require 'pp'
20
23
  require 'csv'
21
- require 'aspera/rainbow'
22
24
  using Rainbow
23
25
 
24
26
  module Aspera
@@ -45,7 +47,7 @@ module Aspera
45
47
  option :out, description: "Output rendering options (dot-notation: #{OUT_SUB_OPTIONS})", schema: Schema::Registry::OUT_OPTIONS
46
48
  option :display, description: 'Output only some information', allowed: DISPLAY_LEVELS, default: :data, deprecation: {last: '4.27.0', message: 'use --out.level'}
47
49
  option :format, description: 'Output format (also: --out.format)', allowed: DISPLAY_FORMATS, default: :table
48
- option :output, description: 'Destination for results', deprecation: {last: '4.27.0', message: 'use --out.file'}
50
+ option :output, description: 'Destination for results', deprecation: {last: '4.27.0', message: 'use --out.file'}, complete: :file, security: :low
49
51
  option :fields, description: "Comma separated list of: fields, or #{SpecialValues::ALL}, or #{SpecialValues::DEF} (also: --out.fields)", allowed: [String, Array, Regexp, Proc], default: SpecialValues::DEF
50
52
  option :select, description: 'Select only some items in lists: column, value (also: --out.select)', allowed: [Hash, Proc]
51
53
  option :table_style, description: '(Table) Display style', allowed: [Hash], deprecation: {last: '4.27.0', message: 'use --out.table'}
@@ -200,7 +202,7 @@ module Aspera
200
202
  $stdout = if @output_to_file
201
203
  File.open(value, 'w')
202
204
  else
203
- STDOUT # rubocop:disable Style/GlobalStdStream
205
+ STDOUT
204
206
  end
205
207
  apply_colors
206
208
  when :image
@@ -246,7 +248,7 @@ module Aspera
246
248
  # - `:info` messages are only displayed when display level is `:info`
247
249
  # - `:error` messages are always displayed on `stderr`
248
250
  def display_message(message_level, message, hide_secrets: true)
249
- message = SecretHider.instance.hide_secrets_in_string(message) if hide_secrets && message.is_a?(String) && hide_secrets?
251
+ message = Secret::Hider.instance.hide_secrets_in_string(message) if hide_secrets && message.is_a?(String) && hide_secrets?
250
252
  case message_level
251
253
  when :data then $stdout.puts(message) unless @options[:display].eql?(:error)
252
254
  when :info then $stdout.puts(message) if @options[:display].eql?(:info)
@@ -267,7 +269,7 @@ module Aspera
267
269
  # @param data [Object] Data of a result
268
270
  # @return [Object] Copy of data with secrets hidden (by key name, and declared values), or data itself if secrets are shown
269
271
  def hide_secrets(data)
270
- hide_secrets? ? SecretHider.instance.hidden_copy(data) : data
272
+ hide_secrets? ? Secret::Hider.instance.hidden_copy(data) : data
271
273
  end
272
274
 
273
275
  # Display results using the Visitor pattern
@@ -275,7 +277,7 @@ module Aspera
275
277
  # formatter method, eliminating the need for type checking in the formatter.
276
278
  # @param result [Result] Result object to display
277
279
  def display_results(result)
278
- require 'aspera/cli/result'
280
+ require_relative 'result'
279
281
  Aspera.assert_type(result, Cli::Result) { 'result must be a Result object' }
280
282
 
281
283
  Log.log.debug { "display_results: result class=#{result.class.name}" }
@@ -304,7 +306,7 @@ module Aspera
304
306
 
305
307
  # Hide secrets in a string
306
308
  def hide_secrets_in_string(string)
307
- SecretHider.instance.hide_secrets_in_string(string)
309
+ Secret::Hider.instance.hide_secrets_in_string(string)
308
310
  end
309
311
 
310
312
  # Get special format string
@@ -402,7 +404,11 @@ module Aspera
402
404
  raise Cli::BadArgument, "Error in user-provided ruby lambda code during select: #{e.message}"
403
405
  end
404
406
  when Hash
405
- @options[:select].reduce(data) { |items, (k, v)| items.select { |i| i[k].eql?(v) } }
407
+ data.select do |item|
408
+ # Not flattened with a structured format: a dot-path key is looked up in the flattened item, as in a table
409
+ flat = nil
410
+ @options[:select].all? { |k, v| (item.key?(k) ? item[k] : (flat ||= DotContainer.new(item).to_dotted)[k]).eql?(v) }
411
+ end
406
412
  else data
407
413
  end
408
414
  end
@@ -449,12 +455,13 @@ module Aspera
449
455
  def display_table(object_array, fields, single: false)
450
456
  Aspera.assert_array_all(object_array, Hash)
451
457
  Aspera.assert_array_all(fields, String)
458
+ # select before the empty check: no item may remain
459
+ object_array = filter_columns_on_select(object_array)
452
460
  if object_array.empty?
453
461
  # no display for csv
454
462
  display_message(:info, TerminalFormatter.special_format('empty')) if @options[:format].eql?(:table)
455
463
  return
456
464
  end
457
- object_array = filter_columns_on_select(object_array)
458
465
  format_style = @options[:table_style].symbolize_keys
459
466
  string_list_separator = format_style.delete(:str_lst_sep) || STR_LST_SEP_VERT
460
467
  # convert data to string, and keep only display fields
@@ -1,11 +1,14 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/version'
4
- require 'aspera/cli/info'
5
- require 'aspera/environment'
6
- require 'aspera/persistency_action_once'
7
- require 'aspera/rest'
8
- require 'aspera/log'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'version'
7
+ require_relative 'info'
8
+ require_relative '../environment'
9
+ require_relative '../persistency_action_once'
10
+ require_relative '../rest'
11
+ require_relative '../log'
9
12
  require 'date'
10
13
 
11
14
  module Aspera
@@ -1,13 +1,15 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/transfer/error'
4
- require 'aspera/rest'
5
- require 'aspera/log'
6
- require 'aspera/ssh'
7
- require 'aspera/assert'
8
- require 'aspera/cli/info'
9
- require 'aspera/cli/terminal_formatter'
10
- require 'net/ssh'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../transfer/error'
7
+ require_relative '../rest'
8
+ require_relative '../log'
9
+ require_relative '../ssh'
10
+ require_relative '../assert'
11
+ require_relative 'info'
12
+ require_relative 'terminal_formatter'
11
13
  require 'openssl'
12
14
 
13
15
  module Aspera
@@ -117,6 +119,16 @@ module Aspera
117
119
  'Check your public key in your AoC user profile.'
118
120
  ]
119
121
  },
122
+ {
123
+ exception: StandardError,
124
+ match: /1Password CLI failed.*(not currently signed in|no active session)/m,
125
+ remediation: [
126
+ 'The 1Password CLI (`op`) has no active session',
127
+ 'Check with: op whoami',
128
+ 'Sign in with: eval $(op signin)',
129
+ 'or enable "Integrate with 1Password CLI" in the 1Password desktop application (Settings > Developer)'
130
+ ]
131
+ },
120
132
  {
121
133
  exception: Aspera::Rest::CallError,
122
134
  match: /Please configure ACLs for this URI/,
@@ -124,7 +136,7 @@ module Aspera
124
136
  'server must have: asnodeadmin -mu <node user> --acl-add=internal --internal'
125
137
  ]
126
138
  }
127
- ]
139
+ ].freeze
128
140
  private_constant :ERROR_HINTS
129
141
 
130
142
  class << self
@@ -135,7 +147,7 @@ module Aspera
135
147
  next unless error.is_a?(hint[:exception])
136
148
  message = error.message
137
149
  matches = hint[:match]
138
- matches = [matches] unless matches.is_a?(Array)
150
+ matches = Array(matches)
139
151
  matches.each do |m|
140
152
  case m
141
153
  when String
@@ -1,14 +1,17 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/special_values'
4
- require 'aspera/log'
5
- require 'aspera/assert'
6
- require 'aspera/line_logger'
7
- require 'aspera/schema/registry'
8
- require 'aspera/cli/option_declarator'
9
- require 'aspera/rest'
10
- require 'aspera/oauth/client/factory'
11
- require 'aspera/ssl'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'special_values'
7
+ require_relative '../log'
8
+ require_relative '../assert'
9
+ require_relative '../line_logger'
10
+ require_relative '../schema/registry'
11
+ require_relative 'option_declarator'
12
+ require_relative '../rest'
13
+ require_relative '../oauth/client/factory'
14
+ require_relative '../ssl'
12
15
  require 'openssl'
13
16
 
14
17
  module Aspera
@@ -1,5 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
3
6
  module Aspera
4
7
  module Cli
5
8
  module Info
@@ -8,24 +11,26 @@ module Aspera
8
11
  # Name of the containing gem, same as in <gem name>.gemspec
9
12
  GEM_NAME = 'aspera-cli'
10
13
  DOC_URL = 'https://ibm.biz/ascli-doc'
11
- RUBYDOC_URL = "https://www.rubydoc.info/gems/#{GEM_NAME}"
12
- GEM_URL = "https://rubygems.org/gems/#{GEM_NAME}"
14
+ RUBYDOC_URL = "https://www.rubydoc.info/gems/#{GEM_NAME}".freeze
15
+ GEM_URL = "https://rubygems.org/gems/#{GEM_NAME}".freeze
13
16
  SRC_URL = 'https://github.com/IBM/aspera-cli'
17
+ SITE_URL = 'https://ibm.github.io/aspera-cli/'
18
+ LLMS_URL = "#{SITE_URL}llms.txt".freeze
14
19
  CONTAINER = 'docker.io/martinlaurent/ascli'
15
20
  # Minimum required Ruby version: single reference, used by `required_ruby_version` in gemspec file and by the documentation
16
- # Policy: a Ruby version is supported until 18 months after its end of official support
21
+ # Policy: a Ruby version is supported until 6 months after its end of official support
17
22
  # Consistency with other files: `rake tools:check_ruby`
18
- RUBY_MINIMUM_VERSION = '3.2'
23
+ RUBY_MINIMUM_VERSION = '3.3'
19
24
  # Set this to warn in advance when minimum required ruby version will increase
20
- RUBY_FUTURE_MINIMUM_VERSION = '3.3'
25
+ RUBY_FUTURE_MINIMUM_VERSION = '3.4'
21
26
  # Version with which this version of CLI was tested
22
27
  SDK_VERSION = '1.1.9'
23
28
  # Ruby version with which this version of CLI was tested, packaged in container image and portable packages
24
- RUBY_TESTED_VERSION = '4.0.7'
29
+ RUBY_TESTED_VERSION = '4.0.9'
25
30
  # Suffix of the RubyInstaller release of `RUBY_TESTED_VERSION`, packaged in the Windows zip
26
31
  # (release tag: `RubyInstaller-<Ruby version><suffix>`)
27
32
  # https://github.com/oneclick/rubyinstaller2/releases
28
- WINDOWS_RUBY_INSTALLER_EXT = '-2'
33
+ WINDOWS_RUBY_INSTALLER_EXT = '-1'
29
34
  end
30
35
  end
31
36
  end
@@ -1,8 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/environment'
4
- require 'aspera/log'
5
- require 'aspera/assert'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../environment'
7
+ require_relative '../log'
8
+ require_relative '../assert'
6
9
  require 'erb'
7
10
 
8
11
  module Aspera
@@ -1,11 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # cspell:ignore webrick
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
4
5
 
5
- require 'aspera/log'
6
- require 'aspera/servlet_helpers'
7
- require 'aspera/cli/web_secret'
8
- require 'json'
6
+ require_relative '../../log'
7
+ require_relative '../../servlet_helpers'
8
+ require_relative '../web_secret'
9
9
  require 'openssl'
10
10
  require 'stringio'
11
11
  require 'webrick'
@@ -57,6 +57,8 @@ module Aspera
57
57
 
58
58
  def dispatch(req, res)
59
59
  check_request(req, json: JSON_PATHS.include?(req.path), **@allowed)
60
+ # Page opened by the user in a browser (no bearer token), protected by the access code
61
+ return @web_secret.handle(req, res) if req.path.start_with?(WebSecret::PATH_PREFIX)
60
62
  case req.path
61
63
  when '/'
62
64
  # Discovery endpoint (server metadata, no auth required)
@@ -65,9 +67,6 @@ module Aspera
65
67
  when '/oauth/register' then oauth(req, res, :handle_register, post_only: true)
66
68
  when '/oauth/authorize' then oauth(req, res, :handle_authorize)
67
69
  when '/oauth/token' then oauth(req, res, :handle_token, post_only: true)
68
- when ->(path) { path.start_with?(WebSecret::PATH_PREFIX) }
69
- # Page opened by the user in a browser (no bearer token), protected by the access code
70
- @web_secret.handle(req, res)
71
70
  else
72
71
  # All other paths are MCP endpoints: require authorization
73
72
  return unauthorized(res) unless authorized?(req)
@@ -1,9 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/secret_hider'
4
- require 'aspera/cli/error'
5
- require 'aspera/cli/info'
6
- require 'aspera/cli/web_secret'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../../secret/hider'
7
+ require_relative '../error'
8
+ require_relative '../info'
9
+ require_relative '../web_secret'
7
10
  require 'json'
8
11
 
9
12
  module Aspera
@@ -79,7 +82,7 @@ module Aspera
79
82
  # Clients of protocol 2025-11-25: completion of the out-of-band interaction
80
83
  @server_context.notify_elicitation_complete(elicitation_id: id) unless action.nil? || @server_context.modern?
81
84
  # Never reaches the client, even if displayed by the command
82
- SecretHider.instance.add_secret_values(value)
85
+ Secret::Hider.instance.add_secret_values(value)
83
86
  value
84
87
  end
85
88
 
@@ -1,16 +1,17 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # cspell:ignore ascli
4
-
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../../log'
7
+ require_relative '../../secret/hider'
8
+ require_relative '../runner'
9
+ require_relative '../error'
10
+ require_relative 'secrets'
11
+ require_relative '../../schema/reader'
12
+ require_relative '../../schema/registry'
13
+ require_relative '../plugins/mcp'
5
14
  require 'json'
6
- require 'aspera/log'
7
- require 'aspera/secret_hider'
8
- require 'aspera/cli/runner'
9
- require 'aspera/cli/error'
10
- require 'aspera/cli/mcp/secrets'
11
- require 'aspera/schema/reader'
12
- require 'aspera/schema/registry'
13
- require 'aspera/cli/plugins/mcp'
14
15
  unless defined?(MCP::Tool)
15
16
  begin
16
17
  require 'mcp'
@@ -130,7 +131,7 @@ module Aspera
130
131
  secret_call.finish
131
132
  # Secret values (e.g. entered by the user, tokens) never reach the client, even if displayed by the command,
132
133
  # also short ones in a text (e.g. a short password in an error message)
133
- hider = SecretHider.instance
134
+ hider = Secret::Hider.instance
134
135
  return MCP::Tool::Response.new(
135
136
  hider.hidden_copy(response.content, short_in_text: true),
136
137
  structured_content: hider.hidden_copy(response.structured_content, short_in_text: true),
@@ -154,7 +155,7 @@ module Aspera
154
155
  # Secrets never reach the AI client, whatever the output format requested in args.
155
156
  # As on the command line, `--out.query` applies to the data of an object or list, after secrets are removed
156
157
  if result.is_a?(Result::SingleObject) || result.is_a?(Result::ObjectList) || result.is_a?(Result::ValueList)
157
- result = result.with_data(SecretHider.instance.hidden_copy(result.data))
158
+ result = result.with_data(Secret::Hider.instance.hidden_copy(result.data))
158
159
  result = runner.context.formatter.query_result(result)
159
160
  end
160
161
  case result
@@ -182,7 +183,7 @@ module Aspera
182
183
  end
183
184
  MCP::Tool::Response.new(content, structured_content: structured)
184
185
  else
185
- MCP::Tool::Response.new([{type: 'text', text: SecretHider.instance.hide_secrets_in_string(result.data.to_s, all: true)}])
186
+ MCP::Tool::Response.new([{type: 'text', text: Secret::Hider.instance.hide_secrets_in_string(result.data.to_s, all: true)}])
186
187
  end
187
188
  rescue Cli::SchemaRequest => e
188
189
  schema_path = e.path
@@ -196,7 +197,7 @@ module Aspera
196
197
  rescue SystemExit => e
197
198
  MCP::Tool::Response.new([{type: 'text', text: "exited with status #{e.status}"}], error: !e.status.zero?)
198
199
  rescue => e
199
- MCP::Tool::Response.new([{type: 'text', text: SecretHider.instance.hide_secrets_in_string("#{e.class}: #{dedupe_lines(e.message)}", all: true)}], error: true)
200
+ MCP::Tool::Response.new([{type: 'text', text: Secret::Hider.instance.hide_secrets_in_string("#{e.class}: #{dedupe_lines(e.message)}", all: true)}], error: true)
200
201
  end
201
202
 
202
203
  # Delegate to Schema::Reader#to_rows — semantic fields, no ANSI, MCP/JSON-ready.
@@ -1,7 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/parser'
4
- require 'aspera/cli/command_spec'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'command_spec'
5
7
 
6
8
  module Aspera
7
9
  module Cli
@@ -26,9 +28,11 @@ module Aspera
26
28
  # @param deprecation [Hash, nil] Deprecation `{last:, message:}` forwarded to options.declare (see `Deprecation`)
27
29
  # @param schema [String, nil] Schema reference (e.g. "opts:components.schemas.Foo");
28
30
  # when description: is nil, the schema title or first description line is used
31
+ # @param complete [Symbol, nil] Values proposed by shell completion, one of `Complete::KINDS`
32
+ # @param security [Symbol, nil] Most restrictive security level at which the option is available (see `Security`)
29
33
  def option(name, description: nil,
30
34
  short: nil, allowed: nil, default: nil,
31
- on_set: nil, shorthand: nil, deprecation: nil, schema: nil)
35
+ on_set: nil, shorthand: nil, deprecation: nil, schema: nil, complete: nil, security: nil)
32
36
  register_option_spec(
33
37
  OptionSpec.new(
34
38
  name: name,
@@ -39,7 +43,9 @@ module Aspera
39
43
  on_set: on_set,
40
44
  shorthand: shorthand,
41
45
  deprecation: deprecation,
42
- schema: schema
46
+ schema: schema,
47
+ complete: complete,
48
+ security: security
43
49
  )
44
50
  )
45
51
  end
@@ -1,8 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/cli/option_value'
4
- require 'aspera/cli/error'
5
- require 'aspera/assert'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'option_value'
7
+ require_relative 'error'
8
+ require_relative '../assert'
6
9
 
7
10
  module Aspera
8
11
  module Cli