Merge pull request #143 from TomHarrop/filesender_mods

[DON'T MERGE]  tracking changes to filesender

tools/aarnetfilesender/.shed.yml → tools/aarnet_filesender/.shed.yml

@@ -1,13 +1,12 @@
 name: aarnet_filesender
 owner: galaxy-australia
 homepage_url: https://filesender.aarnet.edu.au
-remote_repository_url: https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnetfilesender
+remote_repository_url: https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender
 categories:
   - Data Export
 type: unrestricted
 description: Transfer files to AARNet's FileSender Service
 long_description: Transfer files to AARNet's FileSender Service
-include:
-  - filesender.xml
-  - macros.xml
-  - test-data
+exclude:
+  - tool_test_output.html
+  - tool_test_output.json

tools/aarnetfilesender/filesender.xml → tools/aarnet_filesender/aarnet_filesender.xml

@@ -1,5 +1,5 @@
 <tool id="aarnet_filesender" name="AARNet FileSender" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
-    <description>transfer files to AARNet's FileSender Service</description>
+    <description>transfer files with AARNet's FileSender Service</description>
     <macros>
         <import>macros.xml</import>
     </macros>
@@ -34,10 +34,10 @@ mkdir filestosend &&
     ln -s "$file" "filestosend/${file.element_identifier}" &&
 #end for
 
-filesender -p -u '$apiuser' -a '$apikey' -b https://filesender.aarnet.edu.au/rest.php -f "galaxy-no-reply@usegalaxy.org.au" -r '$to' filestosend >$output 2>&1
+filesender -p -u '$apiuser' -a '$apikey' -b https://filesender.aarnet.edu.au/rest.php -f '$__user_email__' -r '$to' -s 'Data sent from Galaxy' filestosend >$output 2>&1
     ]]></command>
     <inputs>
-        <param name="data" type="data" format="txt,data" multiple="true" optional="false" label="Datasets to be sent:"/>
+        <param name="data" type="data" format="data" multiple="true" optional="false" label="Datasets to be sent:"/>
         <param name="to" type="text" optional="true" label="Email address of recipent:">
             <sanitizer sanitize="False"/>
         </param>
@@ -62,12 +62,32 @@ filesender -p -u '$apiuser' -a '$apikey' -b https://filesender.aarnet.edu.au/res
         </test>
     </tests>
     <help>
-**What it does**
-        Send dataset(s) from Galaxy to anyone via AARNet's FileSender service.
+        **What it does**
 
-**Remarks**
-        This tool leverages AARNet's FileSender (https://filesender.aarnet.edu.au)
-        to send files out of Galaxy.
+        Uses `AARNet’s FileSender service`_ to send dataset(s) from Galaxy. The
+        recipient will receive an email with a link to download the files.
+
+        **Who can use it**
+
+        AARNet FileSender is available to all institutions affiliated with the
+        `Australian Access Federation (AAF)`_. You can use your institution
+        login details to access and use FileSender.
+
+        **How to connect your Galaxy account to FileSender**
+
+        To send files from Galaxy you will need to connect your Galaxy account
+        to FileSender. This is done by entering your FileSender API key into your
+        Galaxy user preferences.
+
+        1. Log in to FileSender, and copy your API key from the “API Secret” section on the FileSender “My
+           Profile” page. See the `AARNet Knowledge Base`_ for more information.
+        2. In Galaxy, add your API key to the “AARNet FileSender API Key” field
+           in User &gt; Preferences &gt; Manage Information. Your AARNet FileSender
+           Username is the email address you used to log in to FileSender.
+
+        .. _AARNet’s FileSender service: https://filesender.aarnet.edu.au
+        .. _Australian Access Federation (AAF): https://aaf.edu.au/subscribers/
+        .. _AARNet Knowledge Base: https://support.aarnet.edu.au/hc/en-us/articles/235972948-FileSender-API
     </help>
     <citations>
         <citation type="bibtex">

tools/aarnetfilesender/macros.xml → tools/aarnet_filesender/macros.xml

@@ -1,6 +1,6 @@
 <macros>
     <token name="@TOOL_VERSION@">v3.0.0</token>
-    <token name="@VERSION_SUFFIX@">1</token>
+    <token name="@VERSION_SUFFIX@">2</token>
     <token name="@PROFILE@">22.05</token>
     <xml name="requirements">
          <requirements>