aspera-cli 4.0.0.pre1

data/docs/README.md

@@ -0,0 +1,13 @@
+docs/README.erb.md uses markdown format with embeded ruby macros (erb)
+
+/README.md is generated after compilation of README.erb.md
+
+docs/README.erb.md contains the following macros:
+
+* `<%=cmd%>` just the command line tool name
+* `<%=tool%>` the tool name in courrier to be included in text paragraphs
+* `<%=evp%>` env var prefix
+* `<%=opprst%>` option preset
+* `<%=prst%>` link to preset section, name and link to preset
+* `<%=prstt%>` preset in title
+

data/docs/diagrams.txt

@@ -0,0 +1,49 @@
+
+The following section contains the diagrams posted on support KB.
+mde with:  https://www.websequencediagrams.com/
+
+
+-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+title general Aspera Files APIs use
+Client->+Files API: GET authorization(parameters)
+Files API-->-Client: Result=Bearer token
+Client-->Files API: use APIs with Authorization=Bearer
+
+
+-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+title basic OAuth with grant_type=password (username/password, only local users, not google, SAML)
+Client->+Files API: GET authorization(username/password)
+Files API-->-Client: Result=Bearer token
+Client-->Files API: use APIs with Authorization=Bearer
+
+
+-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+title OAuth with grant_type=code (any user: local users, google, SAML)
+note right of Client
+    * Client is registered in "Files", with redirect_uri
+    * Files generates client_id and secret
+    * Listen on "redirect_uri" end point (TCP port)
+    * build "login address" for user:
+    api.asperafiles.com/oauth2/<org>/authorize
+    * open a browser for user with this URL
+end note
+Client->*Local Port: listen
+Client->Browser: open login url in browser (give redirect_uri and scope)
+Browser->Files: load login page
+note right of Browser: user clicks on "google auth"
+Browser->+Google: display google login page
+note right of Browser: user authenticates
+Google-->-Browser: browser is redirected to the "redirect URI" providing a "code"
+Browser->Local Port: browser provides code to client
+Local Port-->Client: read code
+Client->Local Port: close
+destroy Local Port
+note right of Client: close listening port after use
+Client->+Files: GET oauth/token(grant_type=code)
+Files-->-Client: Bearer token
+Client-->Files API: use APIs with Authorization=Bearer
+
+
+
+
+

data/docs/secrets.make

@@ -0,0 +1,38 @@
+# Private data for test systems
+# Do not share, github contains only empty values
+# fill this file and place in folder "local"
+
+
+# Incoming asset processing
+
+# received package public link : https://sedemo.ibmaspera.com/packages/public/receive?token=_value_here_
+CF_AOC_PUBLINK_RECV_PACKAGE=_value_here_
+# shared inbox public link: https://aspera.pub/xxxxxxx
+CF_AOC_PUBLINK_SEND_DROPBOX=_value_here_
+# public link to send package to user: https://aspera.pub/xxxxxx
+CF_AOC_PUBLINK_SEND_USER=_value_here_
+# public link to send files to user's shared folder: https://aspera.pub/xxxxxx
+CF_AOC_PUBLINK_FOLDER=_value_here_
+# workspace with shared inbox
+CF_AOC_SH_BX_WS=_value_here_
+# name of shared inbox in this workspace
+CF_AOC_SH_BX_NAME=_value_here_
+# name of node to test "node resource"
+CF_AOC_NODE1_NAME=_value_here_
+CF_AOC_NODE1_SECRET=_value_here_
+
+
+CF_AWS_ACCESS_KEY=_value_here_
+CF_AWS_SECRET_KEY=_value_here_
+CF_AWS_BUCKET=_value_here_
+CF_AWS_REGION=_value_here_
+
+CF_ICOS_AK_ID=_value_here_
+CF_ICOS_SECRET_AK=_value_here_
+CF_ICOS_BUCKET=_value_here_
+CF_ICOS_REGION=_value_here_
+
+CF_EMAIL_ADDR=_value_here_
+CF_AOC_EXTERNAL_EMAIL=_value_here_
+CF_AOC_ORG=_value_here_
+CF_AOC_USER=_value_here_

data/docs/test_env.conf

@@ -0,0 +1,117 @@
+---
+config:
+  version: 4.0.0.pre1
+default:
+  config: cli_default
+  oncloud: tst_oncloud
+  faspex: tst_faspex
+  faspex5: tst_faspex5
+  shares: tst_shares
+  shares2: tst_shares2
+  node: tst_node
+  server: tst_server
+  orchestrator: orch_eudemo
+  console: tst_console
+  preview: tst_ak_preview
+  ats: tst_ats
+  bss: tst_bss
+  cos: tst_cos
+cli_default:
+  interactive: your value here
+  smtp: your value here
+  ascp_path: your value here
+misc:
+  upload_folder: your value here
+  syncuser: your value here
+  faspex_publink_recv_from_fxuser: your value here
+  faspex_publink_send_to_fxuser: your value here
+  faspex_publink_send_to_dropbox: your value here
+  shares_upload: your value here
+  orch_workflow_id: your value here
+  file_dcm: your value here
+  file_pdf: your value here
+  file_docx: your value here
+  file_mxf: your value here
+local_user:
+  ssh_keys: your value here
+smtp_config:
+  server: your value here
+  port: your value here
+  domain: your value here
+  tls: your value here
+  from_email: your value here
+  from_name: your value here
+  username: your value here
+  password: your value here
+tst_oncloud:
+  url: your value here
+  username: your value here
+  auth: your value here
+  private_key: your value here
+tst_faspex:
+  url: your value here
+  username: your value here
+  password: your value here
+  storage: your value here
+tst_hstsfaspex_ssh:
+  url: your value here
+  username: your value here
+tst_node_faspex:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_faspex5:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_shares:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_shares_1:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_shares2:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_node:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_console:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_server:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_server_bykey:
+  url: your value here
+  username: your value here
+orch_eudemo:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_ats:
+  ibm_api_key: your value here
+  ats_key: your value here
+  ats_secret: your value here
+  instance: your value here
+tst_bss:
+  password: your value here
+tst_ak_preview:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_node_preview:
+  url: your value here
+  username: your value here
+  password: your value here
+tst_cos:
+  apikey: your value here
+  crn: your value here
+  bucket: your value here
+  endpoint: your value here

data/docs/transfer_spec.html

@@ -0,0 +1,99 @@
+<html>
+<head>
+<title>Transfer Specification</title>
+<style type="text/css">
+table {border-collapse: collapse;}
+table, th, td {border: 1px solid black;}
+.yes {color:white;background-color:green;font-weight:bold;}
+.no  {color:white;background-color:red;font-weight:bold;}
+</style>
+</head>
+<body>
+<p>
+Columns:
+<ul>
+<li>F=Fasp Manager(local FASP execution)</li>
+<li>N=remote node(node API)</li>
+<li>C=Connect Client(web plugin)</li>
+</ul>
+</p>
+<p>
+Req/Def : Required or default value (- means emty)
+</p>
+<p>
+Fields with EX_ prefix are specific extensions to local mode.
+</p>
+<p>
+arg: related ascp argument or env var suffix (PASS for ASPERA_SCP_PASS)
+</p>
+<p>
+UNDER CONSTRUCTION<br/>
+<a href="https://developer.ibm.com/api/view/aspera-prod:ibm-aspera:title-IBM_Aspera#id90944">Documentation&rarr;Node API&rarr;/opt/transfers</a><br/>
+</p>
+
+<table>
+<tr><th>Field</th><th>Req/Def</th><th>Type</th><th>F</th><th>N</th><th>C</th><th>arg</th><th>Description</th></tr>
+<tr><td>direction</td><td>Required</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>--mode</td><td>Direction: "send" or "receive"</td></tr>
+<tr><td>remote_host</td><td>Required</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>--host</td><td>IP or fully qualified domain name of the remote server</td></tr>
+<tr><td>remote_user</td><td>Required</td><td>string</td></td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>--user</td><td>Remote user. Default value is "xfer" on node or connect.</td></tr>
+<tr><td>destination_root</td><td>Required</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>last arg</td><td>Destination root directory.</td></tr>
+<tr><td>title</td><td>-</td><td>string</td><td class="no">N</td><td class="yes">Y</td><td class="yes">Y</td><td>-</td><td>Title of the transfer</td></tr>
+<tr><td>tags</td><td>-</td><td>hash</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>--tags<br>--tags64</td><td>Metadata for transfer</td></tr>
+<tr><td>token</td><td>-</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>TOKEN<br/>-W</td><td>Authorization token: Bearer, Basic or ATM</td></tr>
+<tr><td>cookie</td><td>-</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>COOKIE</td><td>Metadata for transfer (older,string)</td></tr>
+<tr><td>remote_access_key</td><td>TODO</td><td>string</td><td></td><td></td><td></td><td>?</td><td>Node only?</td></tr>
+<tr><td>source_root</td><td>-</td><td>string</td><td></td><td></td><td></td><td>--source-prefix<br/>--source-prefix64</td><td>Source root directory.(TODO: verify option)</td></tr>
+<tr><td>fasp_port</td><td>33001</td><td>integer</td></td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>-O</td><td>Specifies fasp (UDP) port.</td></tr>
+<tr><td>ssh_port</td><td>22 or 33001</td><td>integer</td></td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>-P</td><td>Specifies ssh (TCP) port.</td></tr>
+<tr><td>rate_policy</td><td>server config</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>--policy</td><td>Valid literals include "low","fair","high" and "fixed".</td></tr>
+<tr><td>symlink_policy</td><td>follow</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>--symbolic-links</td><td>copy, follow, copy+force, skip.  Default is follow.  Handle source side symbolic links by following the link (follow), copying the link itself (copy),  skipping (skip), or forcibly copying the link itself (copy+force).</td></tr>
+<tr><td>target_rate_kbps</td><td>-</td><td>integer</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>-l</td><td>Specifies desired speed for the transfer.</td></tr>
+<tr><td>min_rate_kbps</td><td>0</td><td>integer</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>-m</td><td>Set the minimum transfer rate in kilobits per second.</td></tr>
+<tr><td>cipher</td><td>none</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>-c</td><td>in transit encryption type.<br/>none, aes-128, aes-256</td></tr>
+<tr><td>content_protection</td><td>encrypt<br/>decrypt</td><td>string</td><td></td><td></td><td></td><td>--file-crypt=</td><td>encryption at rest</td></tr>
+<tr><td>content_protection_password</td><td>-</td><td>string</td><td></td><td></td><td></td><td>PASS</td><td>Specifies a string password.</td></tr>
+<tr><td>overwrite</td><td>diff</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>--overwrite</td><td>Overwrite destination files with the source files of the same name.<br/>never, always, diff, older, or diff+older</td></tr>
+<tr><td>retry_duration</td><td></td><td>string</td><td></td><td></td><td></td><td>TODO</td><td>Specifies how long to wait before retrying transfer. (e.g. "5min")</td></tr>
+<tr><td>http_fallback</td><td></td><td>bool (node), integer</td><td></td><td></td><td></td><td>-y<br/>TODO</td><td>When true(1), attempts to perform an HTTP transfer if a fasp transfer cannot be performed.</td></tr>
+<tr><td>create_dir</td><td></td><td>boolean</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>-d</td><td>Specifies whether to create new directories.</td></tr>
+<tr><td>precalculate_job_size</td><td>srv. def.</td><td>boolean</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>--precalculate-job-size</td><td>Specifies whether to precalculate the job size.</td></tr>
+<tr><td>delete_source</td><td></td><td>boolean</td><td></td><td class="yes">Y</td><td></td><td>?</td><td>?</td></tr>
+<tr><td>remove_after_transfer</td><td></td><td>boolean</td><td></td><td class="yes">Y</td><td></td><td>?</td><td>Specifies whether to remove file after transfer.</td></tr>
+<tr><td>remove_empty_directories</td><td></td><td>boolean</td><td></td><td class="yes">Y</td><td></td><td>?</td><td>Specifies whether to remove empty directories.</td></tr>
+<tr><td>multi_session</td><td>1</td><td>integer</td><td class="no">N</td><td class="yes">Y</td><td class="no">N</td><td>-C</td><td>Specifies how many parts the transfer is in.</td></tr>
+<tr><td>multi_session_threshold</td><td>null</td><td>integer</td><td class="no">N</td><td class="yes">Y</td><td class="no">N</td><td>-</td><td>in bytes</td></tr>
+<tr><td>exclude_newer_than</td><td></td><td>integer</td><td class="yes">Y</td><td></td><td></td><td>--exclude-newer-than</td><td>-</td></tr>
+<tr><td>exclude_older_than</td><td></td><td>integer</td><td class="yes">Y</td><td></td><td></td><td>--exclude-older-than</td><td>-</td></tr>
+<tr><td>preserve_acls</td><td></td><td>string</td><td class="yes">Y</td><td></td><td></td><td>--preserve-acls</td><td>-</td></tr>
+<tr><td>dgram_size</td><td></td><td>integer</td><td class="yes">Y</td><td></td><td></td><td>-Z</td><td>in bytes</td></tr>
+<tr><td>compression</td><td></td><td>integer</td><td></td><td></td><td></td><td></td><td>ascp4 only, 0 / 1?</td></tr>
+<tr><td>read_threads</td><td></td><td>integer</td><td></td><td></td><td></td><td>-</td><td>ascp4 only</td></tr>
+<tr><td>write_threads</td><td></td><td>integer</td><td></td><td></td><td></td><td>-</td><td>ascp4 only</td></tr>
+<tr><td>use_ascp4</td><td>false</td><td>boolean</td><td></td><td class="yes">Y</td><td></td><td>-</td><td>specify version of protocol</td></tr>
+<tr><td>paths</td><td>source files (dest)</td><td>array</td><td></td><td></td><td></td><td>positional<br/>--file-list<br/>--file-pair-list</td><td>Contains a path to the source (required) and a path to the destination.</td></tr>
+<tr><td>http_fallback_port</td><td></td><td>integer</td><td class="yes">Y</td><td></td><td></td><td>-t</td><td>Specifies http port.</td></tr>
+<tr><td>https_fallback_port</td><td></td><td>integer</td><td></td><td></td><td></td><td>todo</td><td>Specifies https port.</td></tr>
+<tr><td>cipher_allowed</td><td></td><td>string</td><td></td><td></td><td></td><td>-</td><td>returned by node API. Valid literals include "aes-128" and "none".</td></tr>
+<tr><td>target_rate_cap_kbps</td><td></td><td></td><td class="no">N</td><td class="no">?</td><td class="yes">?</td><td>-</td><td>Returned by upload/download_setup node api.</td></tr>
+<tr><td>rate_policy_allowed</td><td></td><td></td><td></td><td></td><td></td><td>-</td><td>returned by node API. Specifies most aggressive rate policy that is allowed. Valid literals include "low", "fair","high" and "fixed".</td></tr>
+<tr><td>ssh_private_key</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>KEY</td><td>Private key used for SSH authentication, Shall look like: `-----BEGIN RSA PRIVATE KEY-----\nMII`<br/>Note the JSON encoding `\` + `n` for newlines.</td></tr>
+<tr><td>remote_password</td><td>-</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>PASS</td><td>SSH session password</td></tr>
+<tr><td>resume_policy</td><td>faspmgr:<br/>none<br/>other:<br/>sparse_csum</td><td>string</td><td class="yes">Y</td><td class="yes">Y</td><td class="yes">Y</td><td>-k</td><td>none,attrs,sparse_csum,full_csum</td></tr>
+<tr><td>authentication</td><td>-</td><td class="no">N</td><td class="no">N</td><td class="yes">Y</td><td>-</td><td>token: Aspera web keys are provided to allow transparent web based session initiation. on connect: password is not asked. Else, password is asked, and keys are not provided.</td></tr>
+<tr><td>EX_ssh_key_paths</td><td>-</td><td>array</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>-i</td><td>Use public key authentication and specify the private key file</td></tr>
+<tr><td>EX_at_rest_password</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>FILEPASS</td><td>Passphrase used for at rest encryption or decryption</td></tr>
+<tr><td>EX_proxy_password</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>PROXY_PASS</td><td>TODO</td></tr>
+<tr><td>EX_fasp_proxy_url</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>--proxy</td><td>Specify the address of the Aspera high-speed proxy server</td></tr>
+<tr><td>EX_http_proxy_url</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>-x</td><td>Specify the proxy server address used by HTTP Fallback</td></tr>
+<tr><td>EX_ascp_args</td><td>-</td><td>array</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>same</td><td>Add command line arguments to ascp</td></tr>
+<tr><td>EX_http_transfer_jpeg</td><td>0</td><td>integer</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>-j</td><td>HTTP transfers as JPEG file</td></tr>
+<tr><td>EX_license_text</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>LICENSE</td><td>license file text</td></tr>
+<tr><td>EX_file_list</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>--file-list</td><td>source file list</td></tr>
+<tr><td>EX_file_pair_list</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>--file-pair-list</td><td>source file pair list</td></tr>
+<tr><td>EX_multi_session_part</td><td>-</td><td>string</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>-C</td><td>part for multisession</td></tr>
+<tr><td>EX_no_read</td><td>-</td><td>-</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>--no-read</td><td>no read source</td></tr>
+<tr><td>EX_no_write</td><td>-</td><td>-</td><td class="yes">Y</td><td class="no">N</td><td class="no">N</td><td>--no-write</td><td>no write estination</td></tr>
+</table>
+</body>
+</html>
+

data/examples/aoc.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'aspera/on_cloud'
+require 'aspera/log'
+
+Aspera::Log.instance.level=:debug
+
+aocapi=Aspera::OnCloud.new(
+url: 'https://myorg.ibmaspera.com',
+auth: :jwt,
+private_key: File.read('path/to_your_private_key.pem'),
+username: 'my.email@example.com',
+scope: 'user:all',
+subpath: 'api/v1')
+
+self_user_data=aocapi.read('self')
+
+Aspera::Log.dump('self',self_user_data)

data/examples/proxy.pac

@@ -0,0 +1,60 @@
+/* demo proxy pac for Amelia */
+function FindProxyForURL(url, host) {
+	/* Normalize the URL for pattern matching */
+	url = url.toLowerCase();
+	host = host.toLowerCase();
+
+	/* Don't proxy local hostnames */
+	if (isPlainHostName(host)) {
+		return 'DIRECT';
+	}
+
+	/* Don't proxy local domains */
+	if (dnsDomainIs(host, ".example1.com") || (host == "example1.com")
+			|| dnsDomainIs(host, ".example2.com") || (host == "example2.com")
+			|| dnsDomainIs(host, ".example3.com") || (host == "example3.com")) {
+		return 'DIRECT';
+	}
+
+	/* Don't proxy Windows Update */
+	if ((host == "download.microsoft.com")
+			|| (host == "ntservicepack.microsoft.com")
+			|| (host == "cdm.microsoft.com") || (host == "wustat.windows.com")
+			|| (host == "windowsupdate.microsoft.com")
+			|| (dnsDomainIs(host, ".windowsupdate.microsoft.com"))
+			|| (host == "update.microsoft.com")
+			|| (dnsDomainIs(host, ".update.microsoft.com"))
+			|| (dnsDomainIs(host, ".windowsupdate.com"))) {
+		return 'DIRECT';
+	}
+
+	if (isResolvable(host)) {
+		var hostIP = dnsResolve(host);
+
+		/* Don't proxy non-routable addresses (RFC 3330) */
+		if (isInNet(hostIP, '0.0.0.0', '255.0.0.0')
+				|| isInNet(hostIP, '10.0.0.0', '255.0.0.0')
+				|| isInNet(hostIP, '127.0.0.0', '255.0.0.0')
+				|| isInNet(hostIP, '169.254.0.0', '255.255.0.0')
+				|| isInNet(hostIP, '172.16.0.0', '255.240.0.0')
+				|| isInNet(hostIP, '192.0.2.0', '255.255.255.0')
+				|| isInNet(hostIP, '192.88.99.0', '255.255.255.0')
+				|| isInNet(hostIP, '192.168.0.0', '255.255.0.0')
+				|| isInNet(hostIP, '198.18.0.0', '255.254.0.0')
+				|| isInNet(hostIP, '224.0.0.0', '240.0.0.0')
+				|| isInNet(hostIP, '240.0.0.0', '240.0.0.0')) {
+			return 'DIRECT';
+		}
+	}
+
+	if (url.substring(0, 5) == 'http:' || url.substring(0, 6) == 'https:'
+			|| url.substring(0, 4) == 'ftp:') {
+		return 'PROXY proxy.example.com:8080';
+	}
+
+	if (url.substring(0, 4) == 'ssh:') {
+		return 'PROXY proxy.aspera.com:9092';
+	}
+
+	return 'DIRECT';
+}

data/examples/transfer.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+# Example: transfer a file using one of the provided transfer agents
+
+require 'aspera/fasp/local'
+require 'aspera/fasp/listener'
+require 'aspera/fasp/installation'
+require 'aspera/log'
+require 'aspera/rest'
+require 'aspera/rest_errors_aspera'
+require 'json'
+
+tmpdir=ENV['tmp'] || '.'
+
+##############################################################
+# generic initialisation : configuration of FaspManager
+
+# set trace level for sample, set to :debug to see complete list of debug information
+Aspera::Log.instance.level=:debug
+
+# set path to your copy of ascp binary
+Aspera::Fasp::Installation.instance.ascp_path=ENV['ascp'] || '/Library/aspera/bin/ascp'
+# some required files are generated here (keys, certs)
+Aspera::Fasp::Installation.instance.config_folder = tmpdir
+
+# register aspera REST call error handlers
+Aspera::RestErrorsAspera.registerHandlers
+
+# another way is to detect installed products and use one of them
+#Aspera::Fasp::Installation.instance.installed_products.each{|p|puts("found: #{p[:name]}")}
+#Aspera::Fasp::Installation.instance.use_ascp_from_product('Aspera Connect')
+
+# get FASP Manager singleton based on above ascp location
+fasp_manager=Aspera::Fasp::Local.new
+
+# Note that it would also be possible to start transfers using other agents
+#require 'aspera/fasp/connect'
+#fasp_manager=Aspera::Fasp::Connect.new
+#require 'aspera/fasp/node'
+#fasp_manager=Aspera::Fasp::Node.new(Aspera::Rest.new(...))
+
+##############################################################
+# Optional : register an event listener
+
+# example of event listener that displays events on stdout
+class MyListener < Aspera::Fasp::Listener
+  # this is the callback called during transfers, here we only display the received information
+  # but it could be used to get detailed error information, check "type" field is "ERROR"
+  def event_enhanced(data);STDOUT.puts(JSON.generate(data));STDOUT.flush;end
+end
+
+# register the sample listener to display events
+fasp_manager.add_listener(MyListener.new)
+
+##############################################################
+# first example: download by SSH credentials
+
+# manually build teansfer spec
+transfer_spec={
+  #'remote_host'     =>'demo.asperasoft.com',
+  'remote_host'     =>'eudemo.asperademo.com',
+  'remote_user'     =>'asperaweb',
+  'remote_password' =>'demoaspera',
+  'direction'       =>'receive',
+  'ssh_port'        =>33001,
+  'destination_root'=>tmpdir,
+  'paths'           =>[{'source'=>'aspera-test-dir-tiny/200KB.1'}]
+}
+# start transfer in separate thread
+# method returns as soon as transfer thread is created
+# it des not wait for completion, or even for session startup
+fasp_manager.start_transfer(transfer_spec)
+
+# optional: helper method: wait for completion of transfers
+# here we started a single transfer session (no multisession parameter)
+# get array of status, one for each session (so, a single value array)
+# each status is either :success or "error message"
+transfer_result=fasp_manager.wait_for_transfers_completion
+STDOUT.puts(JSON.generate(transfer_result))
+# get list of errors only
+errors=transfer_result.select{|i|!i.eql?(:success)}
+# the transfer was not success, as there is at least one error
+raise "Error(s) occured: #{errors.join(',')}" if !errors.empty?
+
+##############################################################
+# second example: upload with node authorization
+
+# create rest client for Node API on a public demo system, using public demo credentials
+node_api=Aspera::Rest.new({
+  :base_url => 'https://eudemo.asperademo.com:9092',
+  :auth     => {
+  :type     => :basic,
+  :username => 'node_asperaweb',
+  :password => 'demoaspera'
+  }})
+# define sample file(s) and destination folder
+sources=["#{tmpdir}/sample_file.txt"]
+destination='/Upload'
+# create sample file(s)
+sources.each{|p|File.write(p,"Hello World!")}
+# request transfer authorization to node for a single transfer (This is a node api v3 call)
+send_result=node_api.create('files/upload_setup',{ :transfer_requests => [ { :transfer_request => { :paths => [ { :destination => destination } ] } } ] } )[:data]
+# we normally have only one transfer spec in list, so just get the first transfer_spec
+transfer_spec=send_result['transfer_specs'].first['transfer_spec']
+# add list of files to upload
+transfer_spec['paths']=sources.map{|p|{'source'=>p}}
+# set authentication type to "token" (will trigger use of bypass SSH key)
+transfer_spec['authentication']='token'
+# from here : same as example 1
+fasp_manager.start_transfer(transfer_spec)
+# optional: wait for transfer completion helper function to get events
+transfer_result=fasp_manager.wait_for_transfers_completion
+errors=transfer_result.select{|i|!i.eql?(:success)}
+# the transfer was not success, as there is at least one error
+raise "Error(s) occured: #{errors.join(',')}" if !errors.empty?
+