Implement access methods

[uniqueg]

This is a meta-issue to help keep track on what access methods are still left to implement. Please don't close this issue until all boxes are checked (note that additional boxes may be added later).

To implement one of the methods, open a specific issue for the access method you would like to implement (if it doesn't already exist), assign yourself to that issue, implement it (look at #5, #6 and #7 for examples), implement tests, update the README.md, file a PR and mention the specific issue in the PR description. Then, once done, tick off the corresponding item in the lists below.

TRS access methods to implement:

• .get_service_info() for GET /service-info (Implement "GET /service-info" #38 / feat: add 'GET /service-info' #40)
• .get_tool_classes() for GET /toolClasses (feat: add "GET /toolClasses" #11)
• .get_tools() for GET /tools (Implement "GET /tools" access method with appropriate query parameters #15 / feat: add "GET /tools" #16)
• .get_tool() for GET /tools/{id} (feat: add "POST /toolClasses" #12)
• .get_versions() for GET /tools/{id}/versions (Implement "GET /tools/{id}/versions" access method #17 / feat: add "GET /tools/{id}/versions" #19)
• .get_version() for GET /tools/{id}/versions/{version_id} (Implement "GET /tools/{id}/versions/{version_id}" access method #18 / feat: add "GET /tool/{id}/version/{version_id}" #20)
• .get_containerfiles() for GET /tools/{id}/versions/{version_id}/containerfile (Implement "GET /tools/{id}/versions/{version_id}/containerfile" #41 / feat: add 'GET .../containerfile' #43)
• .get_descriptor() for GET /tools/{id}/versions/{version_id}/{type}/descriptor (feat: add "GET .../descriptor" #5)
• .get_descriptor_by_path() for GET /tools/{id}/versions/{version_id}/{type}/descriptor/{relative_path} (feat: add "GET .../descriptor/{relative_path}" #7)
• .get_files() for GET /tools/{id}/versions/{version_id}/{type}/files (feat: add "GET .../files" #6)
• .get_tests() for GET /tools/{id}/versions/{version_id}/{type}/tests (Implement "GET /tools/{id}/versions/{version_id}/{type}/tests" #42 / 44)

TRS-Filer access methods to implement:

• .post_service_info() for POST ​/service-info (Implement "POST /service-info" #37 / feat: add 'POST /service-info' #39)
• .post_tool_class() for POST ​/toolClasses (feat: add "POST /toolClasses" #12)
• .delete_tool_class() for DELETE ​/toolClasses​/{id} (Implement "DELETE ​/toolClasses​/{id}" access method #25 / feat: add "DELETE /toolClasses/{id}" #27)
• .put_tool_class() for PUT ​/toolClasses​/{id} (Implement "PUT /toolClasses/{id}" access method #31 / feat: add "PUT /toolClasses/{id}" #34)
• .post_tool() for POST ​/tools (Implement "POST ​/tools" access method #21 / feat: add "POST /tools" #23)
• .delete_tool() for DELETE ​/tools​/{id} (Implement "DELETE ​/tools​/{id}" access method #26 / feat: add "DELETE /tools/{id}" #29)
• .put_tool() for PUT ​/tools​/{id} (Implement "PUT /tools​/{id}" access method #32 / feat: add 'PUT /tools/{id}' #35)
• .post_version() for POST ​/tools​/{id}​/versions (Implement "POST ​/tools​/{id}​/versions" access method #22 / feat: add 'POST /tools/{id}/versions' #24)
• .delete_version() for DELETE ​/tools​/{id}​/versions​/{version_id} (Implement "DELETE ​/tools​/{id}​/versions​/{version_id}" access method #28 / feat: add "DELETE .../versions/{version_id}" #30)
• .put_version() for PUT ​/tools​/{id}​/versions​/{version_id} (Implement "PUT ​/tools​/{id}​/versions​/{version_id}" access method #33 / feat: add "PUT /tools/{id}/versions/{id}" #36)

Composite access methods to implement:

Please do not implement before issue is discussed/approved

• .import_tool(): import a tool from one TRS into another
• .get_checksums(): return dictionary of checksums for all files of a given descriptor type
• .retrieve_files(): download all files of a given descriptor type (feat: add method to retrieve files #8 / feat: return type info for file retrieval #9)
• .search_tools(): filter values of .get_tools() results for optionally exact (default) or partial matches in any field

[uniqueg]

The client is potentially very useful in our web portal CWLab. It's already used there (in v0.3.1 to retrieve workflow files if a "versioned TRS URI" is passed. But the TRS also offers a discovery endpoint (GET /tools with appropriate query parameters). To support the functionality of discovering a workflow that you don't know exists, implementing access methods for GET /tools, and then GET /tool/{id}, GET /tool/{id}/versions, and GET /tools/{id}/versions/{version_id} to allow the user to pick a version of a tool they have just discovered, are probably highest priority (pretty much in that order).

Afterwards, probably the POST, PUT and DELETE endpoints to manage resources available on the service (i.e., POST /tools and POST /tools/{id}/versions etc) are probably the next most important set of access methods.