aspera-cli 4.27.5 → 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.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/BUGS.md +5 -10
- data/CHANGELOG.md +301 -4
- data/CODE_OF_CONDUCT.md +18 -0
- data/CONTRIBUTING.md +139 -58
- data/GOVERNANCE.md +30 -0
- data/LICENSE +201 -0
- data/README.md +103 -26
- data/SECURITY.md +70 -0
- data/bin/ascli +8 -5
- data/bin/asession +10 -7
- data/docs/README.md +2551 -772
- data/docs/test-mcp-with-ai.md +13 -11
- data/lib/aspera/agent/base.rb +23 -2
- data/lib/aspera/agent/connect.rb +16 -12
- data/lib/aspera/agent/desktop.rb +10 -7
- data/lib/aspera/agent/direct.rb +34 -22
- data/lib/aspera/agent/factory.rb +8 -4
- data/lib/aspera/agent/httpgw.rb +7 -5
- data/lib/aspera/agent/node.rb +15 -7
- data/lib/aspera/agent/transferd.rb +167 -43
- data/lib/aspera/api/alee.rb +4 -1
- data/lib/aspera/api/aoc.rb +14 -11
- data/lib/aspera/api/ats.rb +4 -2
- data/lib/aspera/api/cos_node.rb +8 -5
- data/lib/aspera/api/faspex.rb +16 -9
- data/lib/aspera/api/httpgw.rb +9 -6
- data/lib/aspera/api/node.rb +23 -19
- data/lib/aspera/ascmd.rb +8 -5
- data/lib/aspera/ascp/installation.rb +84 -42
- data/lib/aspera/ascp/log.schema.yaml +1084 -0
- data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
- data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
- data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
- data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
- data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
- data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
- data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
- data/lib/aspera/ascp/log_analyzer.rb +354 -0
- data/lib/aspera/ascp/management.rb +102 -48
- data/lib/aspera/ascp/session_errors.rb +217 -0
- data/lib/aspera/assert.rb +4 -0
- data/lib/aspera/cli/ascp_actions.rb +16 -37
- data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
- data/lib/aspera/cli/async_transfer_store.rb +7 -4
- data/lib/aspera/cli/bootstrapper.rb +37 -34
- data/lib/aspera/cli/command_line.rb +24 -6
- data/lib/aspera/cli/command_registry.rb +49 -4
- data/lib/aspera/cli/command_spec.rb +34 -4
- data/lib/aspera/cli/completion/ascli.bash +53 -5
- data/lib/aspera/cli/completion/ascli.fish +27 -8
- data/lib/aspera/cli/completion/ascli.ps1 +63 -0
- data/lib/aspera/cli/completion/ascli.zsh +36 -4
- data/lib/aspera/cli/completion_actions.rb +594 -0
- data/lib/aspera/cli/context.rb +9 -4
- data/lib/aspera/cli/deprecation.rb +5 -2
- data/lib/aspera/cli/error.rb +45 -0
- data/lib/aspera/cli/extended_value.rb +83 -24
- data/lib/aspera/cli/formatter.rb +142 -73
- data/lib/aspera/cli/gem_checker.rb +9 -6
- data/lib/aspera/cli/hints.rb +22 -11
- data/lib/aspera/cli/http.rb +17 -13
- data/lib/aspera/cli/info.rb +17 -6
- data/lib/aspera/cli/mailer.rb +7 -4
- data/lib/aspera/cli/mcp/http_servlet.rb +155 -0
- data/lib/aspera/cli/mcp/secrets.rb +146 -0
- data/lib/aspera/cli/mcp/tool.rb +232 -0
- data/lib/aspera/cli/option_declarator.rb +10 -4
- data/lib/aspera/cli/option_registry.rb +6 -3
- data/lib/aspera/cli/option_types.rb +17 -2
- data/lib/aspera/cli/option_value.rb +72 -11
- data/lib/aspera/cli/options.schema.yaml +856 -81
- data/lib/aspera/cli/parser.rb +64 -31
- data/lib/aspera/cli/plugins/alee.rb +7 -4
- data/lib/aspera/cli/plugins/aoc.rb +250 -44
- data/lib/aspera/cli/plugins/ats.rb +9 -8
- data/lib/aspera/cli/plugins/base.rb +51 -25
- data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
- data/lib/aspera/cli/plugins/config.rb +207 -141
- data/lib/aspera/cli/plugins/console.rb +9 -4
- data/lib/aspera/cli/plugins/cos.rb +8 -4
- data/lib/aspera/cli/plugins/factory.rb +22 -8
- data/lib/aspera/cli/plugins/faspex5.rb +37 -44
- data/lib/aspera/cli/plugins/faspio.rb +41 -8
- data/lib/aspera/cli/plugins/httpgw.rb +8 -4
- data/lib/aspera/cli/plugins/mcp.rb +186 -121
- data/lib/aspera/cli/plugins/node.rb +41 -34
- data/lib/aspera/cli/plugins/oauth.rb +5 -1
- data/lib/aspera/cli/plugins/orchestrator.rb +572 -59
- data/lib/aspera/cli/plugins/preview.rb +69 -44
- data/lib/aspera/cli/plugins/server.rb +66 -12
- data/lib/aspera/cli/plugins/shares.rb +288 -48
- data/lib/aspera/cli/plugins/transferd.rb +223 -0
- data/lib/aspera/cli/preset_actions.rb +155 -33
- data/lib/aspera/cli/preset_manager.rb +72 -16
- data/lib/aspera/cli/prompt.rb +7 -2
- data/lib/aspera/cli/result.rb +28 -11
- data/lib/aspera/cli/runner.rb +193 -80
- data/lib/aspera/cli/secret_finder.rb +4 -1
- data/lib/aspera/cli/security.rb +204 -0
- data/lib/aspera/cli/special_values.rb +4 -1
- data/lib/aspera/cli/sync_actions.rb +13 -10
- data/lib/aspera/cli/table_fitter.rb +119 -0
- data/lib/aspera/cli/terminal_formatter.rb +32 -40
- data/lib/aspera/cli/transfer_actions.rb +11 -8
- data/lib/aspera/cli/transfer_agent.rb +31 -19
- data/lib/aspera/cli/transfer_progress.rb +13 -45
- data/lib/aspera/cli/vault_actions.rb +45 -0
- data/lib/aspera/cli/vault_manager.rb +197 -50
- data/lib/aspera/cli/version.rb +4 -1
- data/lib/aspera/cli/web_secret.html.erb +61 -0
- data/lib/aspera/cli/web_secret.rb +222 -0
- data/lib/aspera/cli/wizard.rb +58 -45
- data/lib/aspera/command_line_builder.rb +35 -5
- data/lib/aspera/command_line_converter.rb +4 -1
- data/lib/aspera/coverage.rb +103 -33
- data/lib/aspera/data_repository.rb +42 -25
- data/lib/aspera/dot_container.rb +4 -1
- data/lib/aspera/duration.rb +45 -0
- data/lib/aspera/environment.rb +106 -33
- data/lib/aspera/exec_spec.rb +9 -5
- data/lib/aspera/faspex_gw.rb +105 -35
- data/lib/aspera/faspex_postproc.rb +193 -47
- data/lib/aspera/formatter_interface.rb +4 -2
- data/lib/aspera/graphql.rb +5 -1
- data/lib/aspera/hash_ext.rb +3 -0
- data/lib/aspera/id_generator.rb +6 -3
- data/lib/aspera/json_rpc/client.rb +55 -35
- data/lib/aspera/json_rpc/version.rb +4 -0
- data/lib/aspera/line_logger.rb +4 -1
- data/lib/aspera/link_header.rb +4 -1
- data/lib/aspera/log.rb +20 -10
- data/lib/aspera/markdown.rb +155 -115
- data/lib/aspera/mime.rb +9 -0
- data/lib/aspera/nagios.rb +9 -5
- data/lib/aspera/node_emulator.rb +111 -112
- data/lib/aspera/oauth/client/base.rb +163 -0
- data/lib/aspera/oauth/{boot.rb → client/boot.rb} +8 -4
- data/lib/aspera/oauth/{factory.rb → client/factory.rb} +13 -3
- data/lib/aspera/oauth/{generic.rb → client/generic.rb} +5 -1
- data/lib/aspera/oauth/{json_credentials.rb → client/json_credentials.rb} +4 -1
- data/lib/aspera/oauth/{jwt.rb → client/jwt.rb} +6 -3
- data/lib/aspera/oauth/client/shares_web.rb +85 -0
- data/lib/aspera/oauth/{url_json.rb → client/url_json.rb} +4 -1
- data/lib/aspera/oauth/client/web.rb +84 -0
- data/lib/aspera/oauth/server/authorize.html.erb +34 -0
- data/lib/aspera/oauth/server/pkce.rb +427 -0
- data/lib/aspera/orchestrator_workflow_checker.rb +679 -0
- data/lib/aspera/persistency_action_once.rb +5 -3
- data/lib/aspera/persistency_folder.rb +6 -3
- data/lib/aspera/preview/file_types.rb +6 -3
- data/lib/aspera/preview/generator.rb +9 -5
- data/lib/aspera/preview/options.schema.yaml +3 -3
- data/lib/aspera/preview/terminal.rb +11 -6
- data/lib/aspera/preview/utils.rb +6 -4
- data/lib/aspera/products/connect.rb +5 -2
- data/lib/aspera/products/desktop.rb +4 -1
- data/lib/aspera/products/other.rb +4 -2
- data/lib/aspera/products/transferd.rb +6 -2
- data/lib/aspera/products/transferd_service.rb +610 -0
- data/lib/aspera/proxy_auto_config.js +2 -2
- data/lib/aspera/proxy_auto_config.rb +5 -2
- data/lib/aspera/rainbow.rb +30 -1
- data/lib/aspera/rest/aspera_errors.rb +55 -60
- data/lib/aspera/rest/call_error.rb +3 -0
- data/lib/aspera/rest/client.rb +42 -42
- data/lib/aspera/rest/error_analyzer.rb +14 -2
- data/lib/aspera/rest/list.rb +14 -10
- data/lib/aspera/rest/parameters.rb +3 -0
- data/lib/aspera/rest/util.rb +13 -4
- data/lib/aspera/rest.rb +9 -7
- data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -11
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +4089 -0
- data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0-enhanced.yaml +1097 -0
- data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
- data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
- data/lib/aspera/schema/IBM_Aspera_Shares.yaml +819 -7
- data/lib/aspera/schema/async_tables.yaml +11 -10
- data/lib/aspera/schema/documentation.rb +56 -78
- data/lib/aspera/schema/reader.rb +46 -11
- data/lib/aspera/schema/registry.rb +45 -24
- data/lib/aspera/schema/transferd-config.schema.json +333 -0
- data/lib/aspera/schema/validator.rb +4 -1
- data/lib/aspera/sealed_hash.rb +166 -0
- data/lib/aspera/secret/hider.rb +201 -0
- data/lib/aspera/secret/reference.rb +150 -0
- data/lib/aspera/secret/resolver.rb +212 -0
- data/lib/aspera/secret/store/base.rb +153 -0
- data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
- data/lib/aspera/secret/store/factory.rb +103 -0
- data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
- data/lib/aspera/secret/store/keeper.rb +141 -0
- data/lib/aspera/secret/store/macos_security.rb +284 -0
- data/lib/aspera/secret/store/one_password_api.rb +99 -0
- data/lib/aspera/secret/store/one_password_base.rb +42 -0
- data/lib/aspera/secret/store/one_password_cli.rb +110 -0
- data/lib/aspera/secret/store/secret_service.rb +125 -0
- data/lib/aspera/secret/strength.rb +119 -0
- data/lib/aspera/servlet_helpers.rb +114 -0
- data/lib/aspera/ssh.rb +10 -7
- data/lib/aspera/ssl.rb +5 -2
- data/lib/aspera/string_ext.rb +3 -0
- data/lib/aspera/sync/args.schema.yaml +6 -1
- data/lib/aspera/sync/conf.schema.yaml +25 -10
- data/lib/aspera/sync/database.rb +3 -0
- data/lib/aspera/sync/operations.rb +34 -12
- data/lib/aspera/temp_file_manager.rb +85 -22
- data/lib/aspera/timer_limiter.rb +3 -0
- data/lib/aspera/transfer/error.rb +4 -1
- data/lib/aspera/transfer/faux_file.rb +4 -1
- data/lib/aspera/transfer/parameters.rb +22 -14
- data/lib/aspera/transfer/result.rb +3 -0
- data/lib/aspera/transfer/resumer.rb +6 -4
- data/lib/aspera/transfer/spec.rb +45 -18
- data/lib/aspera/transfer/spec.schema.yaml +8 -5
- data/lib/aspera/transfer/units.rb +75 -0
- data/lib/aspera/uri_reader.rb +57 -7
- data/lib/aspera/web_auth/index.html.erb +20 -0
- data/lib/aspera/web_auth/paste.rb +109 -0
- data/lib/aspera/web_auth/receiver.rb +50 -0
- data/lib/aspera/web_auth/relay.rb +76 -0
- data/lib/aspera/web_auth/reply.html.erb +150 -0
- data/lib/aspera/web_auth/server.rb +59 -14
- data/lib/aspera/web_page.html.erb +262 -0
- data/lib/aspera/web_page.rb +66 -0
- data/lib/aspera/web_server_simple.rb +82 -13
- data/lib/aspera/yaml.rb +5 -1
- data/llms.txt +81 -0
- data/skills/ascli/SKILL.md +88 -0
- data.tar.gz.sig +0 -0
- metadata +116 -48
- metadata.gz.sig +0 -0
- data/lib/aspera/cli/mcp_tool.rb +0 -189
- data/lib/aspera/keychain/base.rb +0 -25
- data/lib/aspera/keychain/encrypted_hash.rb +0 -188
- data/lib/aspera/keychain/factory.rb +0 -59
- data/lib/aspera/keychain/hashicorp_vault.rb +0 -74
- data/lib/aspera/keychain/macos_security.rb +0 -171
- data/lib/aspera/keychain/one_password_api.rb +0 -86
- data/lib/aspera/keychain/one_password_base.rb +0 -34
- data/lib/aspera/keychain/one_password_cli.rb +0 -98
- data/lib/aspera/oauth/base.rb +0 -141
- data/lib/aspera/oauth/web.rb +0 -57
- data/lib/aspera/oauth.rb +0 -9
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml +0 -1784
- data/lib/aspera/schema/IBM Aspera faspio Gateway API-1.0.0.yaml +0 -249
- data/lib/aspera/secret_hider.rb +0 -117
- data/lib/aspera/web_auth/index.html +0 -147
data/lib/aspera/markdown.rb
CHANGED
|
@@ -1,141 +1,181 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative 'assert'
|
|
7
|
+
|
|
3
8
|
module Aspera
|
|
4
9
|
# Formatting for Markdown
|
|
5
|
-
|
|
10
|
+
module Markdown
|
|
11
|
+
extend self
|
|
12
|
+
|
|
6
13
|
# Matches: **bold**, `code`, or an HTML entity (&, ©, 💩)
|
|
7
|
-
|
|
14
|
+
INLINE_MARKUP_RE = /(?:\*\*(?<bold>[^*]+?)\*\*)|(?:`(?<code>[^`]+)`)|&(?<entity>(?:[A-Za-z][A-Za-z0-9]{1,31}|#\d{1,7}|#x[0-9A-Fa-f]{1,6}));/m
|
|
15
|
+
# HTML line-break tag used in Markdown table cells to separate multi-line values.
|
|
8
16
|
HTML_BREAK = '<br/>'
|
|
17
|
+
# Matches a Markdown heading line (e.g. `## Title`); group 1 = `#` chars, group 2 = text.
|
|
18
|
+
HEADING_RE = /^(\#{1,6})[ \t]+(\S.*)$/
|
|
19
|
+
# Matches the start or end of a fenced code block; group 1 = fence (``` or ~~~).
|
|
20
|
+
FENCE_RE = /^ {0,3}(`{3,}|~{3,})/
|
|
21
|
+
# Maximum column width (in characters) for generated Markdown tables.
|
|
22
|
+
COL_WIDTH = 80
|
|
23
|
+
# Accepted admonition types.
|
|
24
|
+
ADMONITION_TYPES = %w[NOTE CAUTION WARNING IMPORTANT TIP INFO].freeze
|
|
9
25
|
|
|
10
|
-
|
|
11
|
-
COL_WIDTH = 80
|
|
12
|
-
|
|
13
|
-
# Convert a Markdown heading text to a GitHub-flavoured anchor.
|
|
14
|
-
# Rules: downcase, keep letters/digits/spaces/hyphens, replace spaces with hyphens.
|
|
15
|
-
# Duplicate anchors are disambiguated by appending -1, -2, … (pass a seen Hash to track).
|
|
16
|
-
# @param text [String] raw heading text (without leading # and spaces)
|
|
17
|
-
# @param seen [Hash{String=>Integer}, nil] mutable counter; pass the same Hash across a document
|
|
18
|
-
# @return [String] anchor slug (without leading #)
|
|
19
|
-
def heading_to_anchor(text, seen: nil)
|
|
20
|
-
slug = text
|
|
21
|
-
.downcase
|
|
22
|
-
.gsub(/[`*_]/, '') # strip inline code/bold/italic markers
|
|
23
|
-
.gsub(/&[a-z]+;/, '') # strip HTML entities
|
|
24
|
-
.gsub(/[^\w\s-]/, '') # keep word chars, spaces, hyphens
|
|
25
|
-
.gsub(/\s+/, '-') # spaces → hyphens
|
|
26
|
-
.squeeze('-') # collapse consecutive hyphens
|
|
27
|
-
.strip
|
|
28
|
-
if seen
|
|
29
|
-
count = seen[slug].to_i
|
|
30
|
-
seen[slug] = count + 1
|
|
31
|
-
slug = "#{slug}-#{count}" if count > 0
|
|
32
|
-
end
|
|
33
|
-
slug
|
|
34
|
-
end
|
|
26
|
+
# --- Parsing ---
|
|
35
27
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
28
|
+
# Convert a Markdown heading text to a GitHub-flavoured anchor.
|
|
29
|
+
# Rules: downcase, keep letters/digits/spaces/hyphens, replace spaces with hyphens.
|
|
30
|
+
# Duplicate anchors are disambiguated by appending -1, -2, … (pass a seen Hash to track).
|
|
31
|
+
# @param text [String] raw heading text (without leading # and spaces)
|
|
32
|
+
# @param seen [Hash{String=>Integer}, nil] mutable counter; pass the same Hash across a document
|
|
33
|
+
# @return [String] anchor slug (without leading #)
|
|
34
|
+
def heading_to_anchor(text, seen: nil)
|
|
35
|
+
slug = text
|
|
36
|
+
.downcase
|
|
37
|
+
.gsub(/[`*_]/, '') # strip inline code/bold/italic markers
|
|
38
|
+
.gsub(/&[a-z]+;/, '') # strip HTML entities
|
|
39
|
+
.gsub(/[^\w\s-]/, '') # keep word chars, spaces, hyphens
|
|
40
|
+
.gsub(/\s+/, '-') # spaces → hyphens
|
|
41
|
+
.squeeze('-') # collapse consecutive hyphens
|
|
42
|
+
.strip
|
|
43
|
+
if seen
|
|
44
|
+
count = seen[slug].to_i
|
|
45
|
+
seen[slug] = count + 1
|
|
46
|
+
slug = "#{slug}-#{count}" if count > 0
|
|
49
47
|
end
|
|
48
|
+
slug
|
|
49
|
+
end
|
|
50
50
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
if
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
next unless slug == anchor
|
|
66
|
-
section_level = m[1].length
|
|
67
|
-
elsif m[1].length <= section_level
|
|
68
|
-
# already in section: stop at same/higher level heading
|
|
69
|
-
break
|
|
70
|
-
end
|
|
51
|
+
# Iterate on the lines of a Markdown document, with the heading match of each line.
|
|
52
|
+
# A line in a fenced code block is not a heading (e.g. a shell comment `# ...`).
|
|
53
|
+
# @param content [String] full Markdown source
|
|
54
|
+
# @yieldparam line [String] the line
|
|
55
|
+
# @yieldparam heading [MatchData, nil] match of HEADING_RE, or nil if not a heading
|
|
56
|
+
def each_line_with_heading(content)
|
|
57
|
+
fence = nil
|
|
58
|
+
content.each_line do |line|
|
|
59
|
+
if (f = line.match(FENCE_RE))
|
|
60
|
+
# a code block ends with the same kind of fence, at least as long, without info string
|
|
61
|
+
if fence.nil?
|
|
62
|
+
fence = f[1]
|
|
63
|
+
elsif f[1].start_with?(fence) && line.strip.eql?(f[1])
|
|
64
|
+
fence = nil
|
|
71
65
|
end
|
|
72
|
-
|
|
66
|
+
yield(line, nil)
|
|
67
|
+
else
|
|
68
|
+
yield(line, fence.nil? ? line.match(HEADING_RE) : nil)
|
|
73
69
|
end
|
|
74
|
-
result.empty? ? nil : result.join
|
|
75
70
|
end
|
|
71
|
+
end
|
|
76
72
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
lines = table.map { |line| "| #{line.map { |i| i.to_s.gsub('\\', '\\\\').gsub('|', '\|') }.join(' | ')} |\n" }
|
|
91
|
-
lines[1] = lines[1].tr(' ', '-')
|
|
92
|
-
return lines.join.chomp
|
|
73
|
+
# Extract the table of contents from a Markdown document.
|
|
74
|
+
# @param content [String] full Markdown source
|
|
75
|
+
# @param max_level [Integer, nil] maximum level of headings, or nil for all
|
|
76
|
+
# @return [Array<Hash>] array of { level, title, anchor } (String keys, as other results: `--select` applies)
|
|
77
|
+
def toc(content, max_level: nil)
|
|
78
|
+
seen = {}
|
|
79
|
+
result = []
|
|
80
|
+
each_line_with_heading(content) do |_line, m|
|
|
81
|
+
next unless m
|
|
82
|
+
title = m[2].strip
|
|
83
|
+
# anchor of every heading, so that duplicate anchors are numbered as in the whole document
|
|
84
|
+
anchor = heading_to_anchor(title, seen: seen)
|
|
85
|
+
result.push({'level' => m[1].length, 'title' => title, 'anchor' => anchor}) if max_level.nil? || m[1].length <= max_level
|
|
93
86
|
end
|
|
87
|
+
result
|
|
88
|
+
end
|
|
94
89
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
90
|
+
# Extract the content of a single section (heading + body until next heading of same/higher level).
|
|
91
|
+
# @param content [String] full Markdown source
|
|
92
|
+
# @param anchor [String] GitHub anchor slug (without #)
|
|
93
|
+
# @return [String, nil] the section content, or nil if not found
|
|
94
|
+
def extract_section(content, anchor)
|
|
95
|
+
seen = {}
|
|
96
|
+
section_level = nil
|
|
97
|
+
result = []
|
|
98
|
+
each_line_with_heading(content) do |line, m|
|
|
99
|
+
if m
|
|
100
|
+
slug = heading_to_anchor(m[2].strip, seen: seen)
|
|
101
|
+
if section_level.nil?
|
|
102
|
+
# not yet found: check if this heading matches
|
|
103
|
+
next unless slug == anchor
|
|
104
|
+
section_level = m[1].length
|
|
105
|
+
elsif m[1].length <= section_level
|
|
106
|
+
# already in section: stop at same/higher level heading
|
|
107
|
+
break
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
result << line if section_level
|
|
100
111
|
end
|
|
112
|
+
result.empty? ? nil : result.join
|
|
113
|
+
end
|
|
101
114
|
|
|
102
|
-
|
|
103
|
-
# @param title [String] heading text
|
|
104
|
-
# @param level [Integer] heading level (1–6)
|
|
105
|
-
# @return [String] markdown heading
|
|
106
|
-
def heading(title, level: 1)
|
|
107
|
-
"#{'#' * level} #{title}\n\n"
|
|
108
|
-
end
|
|
115
|
+
# --- Generation ---
|
|
109
116
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
end
|
|
117
|
+
# Wrap text in inline code backticks
|
|
118
|
+
# @param text [String] text to wrap
|
|
119
|
+
# @return [String] inline code span
|
|
120
|
+
def icode(text)
|
|
121
|
+
"`#{text}`"
|
|
122
|
+
end
|
|
117
123
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
end
|
|
124
|
+
# Wrap text in a markdown paragraph (trailing blank line)
|
|
125
|
+
# @param text [String] paragraph content
|
|
126
|
+
# @return [String] paragraph with trailing newlines
|
|
127
|
+
def paragraph(text)
|
|
128
|
+
"#{text}\n\n"
|
|
129
|
+
end
|
|
125
130
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
131
|
+
# Generate a markdown heading
|
|
132
|
+
# @param title [String] heading text
|
|
133
|
+
# @param level [Integer] heading level (1–6)
|
|
134
|
+
# @return [String] markdown heading
|
|
135
|
+
def heading(title, level: 1)
|
|
136
|
+
paragraph("#{'#' * level} #{title}")
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Generate a fenced code block
|
|
140
|
+
# @param lines [Array<String>] lines of code
|
|
141
|
+
# @param type [String] language identifier for syntax highlighting
|
|
142
|
+
# @return [String] markdown fenced code block
|
|
143
|
+
def code(lines, type: 'shell')
|
|
144
|
+
paragraph("```#{type}\n#{lines.join("\n")}\n```")
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# Generate a GitHub-flavoured admonition block
|
|
148
|
+
# @param lines [Array<String>] lines of the admonition body
|
|
149
|
+
# @param type [String] admonition type, one of {ADMONITION_TYPES}
|
|
150
|
+
# @return [String] markdown admonition block
|
|
151
|
+
def admonition(lines, type: 'INFO')
|
|
152
|
+
Aspera.assert_values(type, ADMONITION_TYPES) { 'admonition type' }
|
|
153
|
+
paragraph((["[!#{type}]"] + lines).map { |l| "> #{l}" }.join("\n"))
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
# Generate markdown list from the provided list
|
|
157
|
+
# @param items [Array<String>] list of items
|
|
158
|
+
# @return [String] markdown unordered list
|
|
159
|
+
def list(items)
|
|
160
|
+
items.map { |i| "- #{i}" }.join("\n")
|
|
161
|
+
end
|
|
132
162
|
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
163
|
+
# Generate markdown from the provided 2D table
|
|
164
|
+
# @param table [Array<Array<String>>] 2D array of strings
|
|
165
|
+
# @return [String] markdown table
|
|
166
|
+
def table(table)
|
|
167
|
+
# get max width of each columns
|
|
168
|
+
col_widths = table.transpose.map do |col|
|
|
169
|
+
[col.flat_map { |c| c.to_s.delete('`').split(HTML_BREAK).map(&:size) }.max, COL_WIDTH].min
|
|
138
170
|
end
|
|
171
|
+
# do not modify caller's table
|
|
172
|
+
table = table.dup
|
|
173
|
+
headings = table.shift
|
|
174
|
+
table.unshift(col_widths.map { |col_width| '-' * col_width })
|
|
175
|
+
table.unshift(headings)
|
|
176
|
+
# Separator row with spaces around pipes, as other rows (markdownlint MD060, style `compact`)
|
|
177
|
+
lines = table.map { |line| "| #{line.map { |i| i.to_s.gsub('\\', '\\\\').gsub('|', '\|') }.join(' | ')} |\n" }
|
|
178
|
+
return lines.join.chomp
|
|
139
179
|
end
|
|
140
180
|
end
|
|
141
181
|
end
|
data/lib/aspera/mime.rb
CHANGED
|
@@ -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
|
# MIME types used in `Content-Type` and `Accept`
|
|
5
8
|
module Mime
|
|
@@ -9,8 +12,14 @@ module Aspera
|
|
|
9
12
|
WWW = 'application/x-www-form-urlencoded'
|
|
10
13
|
# Plain text body
|
|
11
14
|
TEXT = 'text/plain'
|
|
15
|
+
# XML body
|
|
16
|
+
XML = 'application/xml'
|
|
17
|
+
# Multipart form body (file upload)
|
|
18
|
+
MULTIPART = 'multipart/form-data'
|
|
12
19
|
# JSON:API body (https://jsonapi.org)
|
|
13
20
|
JSON_API = 'application/vnd.api+json'
|
|
21
|
+
# Server-Sent Events stream
|
|
22
|
+
EVENT_STREAM = 'text/event-stream'
|
|
14
23
|
# Check if a media type is JSON: `application/json` or structured syntax suffix `+json` (RFC 6839)
|
|
15
24
|
# @param mime [String] Media type, without parameters (see `Rest.parse_header`)
|
|
16
25
|
# @return [Boolean] `true` if JSON
|
data/lib/aspera/nagios.rb
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative 'log'
|
|
7
|
+
require_relative 'assert'
|
|
6
8
|
|
|
7
9
|
module Aspera
|
|
8
10
|
class Nagios
|
|
@@ -13,6 +15,8 @@ module Aspera
|
|
|
13
15
|
DATE_WARN_OFFSET = 2
|
|
14
16
|
DATE_CRIT_OFFSET = 5
|
|
15
17
|
private_constant :LEVELS, :ADD_PREFIX, :DATE_WARN_OFFSET, :DATE_CRIT_OFFSET
|
|
18
|
+
# Exit code when the check itself fails
|
|
19
|
+
UNKNOWN = LEVELS.index(:unknown)
|
|
16
20
|
|
|
17
21
|
# add methods to add nagios error levels, each take component name and message
|
|
18
22
|
LEVELS.each_index do |code|
|
|
@@ -32,7 +36,7 @@ module Aspera
|
|
|
32
36
|
# keep only errors in case of problem, other ok are assumed so
|
|
33
37
|
data = res_errors unless res_errors.empty?
|
|
34
38
|
# first is most critical
|
|
35
|
-
data.sort
|
|
39
|
+
data = data.sort { |a, b| LEVELS.index(a['status'].to_sym) <=> LEVELS.index(b['status'].to_sym) }
|
|
36
40
|
# build message: if multiple components: concatenate
|
|
37
41
|
# message = data.map{|i|"#{i['component']}:#{i['message']}"}.join(', ').gsub("\n",' ')
|
|
38
42
|
message = data
|
|
@@ -44,7 +48,7 @@ module Aspera
|
|
|
44
48
|
# display status for nagios
|
|
45
49
|
puts("#{status} - [#{message}]\n")
|
|
46
50
|
# provide exit code to nagios
|
|
47
|
-
Process.exit(LEVELS.index(data.first['status'].to_sym))
|
|
51
|
+
::Process.exit(LEVELS.index(data.first['status'].to_sym))
|
|
48
52
|
end
|
|
49
53
|
end
|
|
50
54
|
|