Enable reports packaging

[miha42-github]

Introduction

mrcli includes a --package option when creating a report that is presently not working. The old implementation assumed that S3 was the backing store. The new model has GitHub as the backing store. This issue is meant to change that behavior to convert from S3 to GitHub.

Potential steps

• [x] Review current code to understand the S3 implementation
• [x] Change download code from S3 to GitHub
• [x] Enable packaging for Interactions
• [ ] Enable packaging for Companies

Thinking

• It could be that some of the overall code needs to be cleaned up and stripped out of the respective sub-commands. This should be pursued as the reimplementation is performed.
• While it appears the external links work there are problems with intra-document hyperlinks and this means that local file system links need to be verified. If they do not work then this feature should remain disabled until that can be sorted and instead a download URL for the Interaction content.

Implementation progress

Change download code from S3 to GitHub

Using axis the conversion was relatively simple to enable downloading of content. The shift to axis now downloads an Interaction to the working directory in the .mediumroast/ folder.

Enable packaging for Interactions

While an Interaction's report with the --package flag currently can download the Interaction's content getting the report to completely run given the change to how Companies data is structured/pulled needs to be sorted. The current effort likely needs to do the following:

• Fetch all Interactions and Companies like in mrcli-companies,
• Pass this into and capture the results in the object constructor or the makeDOCX method,
• It appears that --package is not fully wired into the Interaction report which must be remedied. Perhaps the best way to achieve this is to put the link in a few places throughout the document including the dashboard and as a link on later pages.
• Finally we need to verify that there is a cleanup of the resulting raw data after the package is created. This likely exists for Companies but was never implemented for Interactions.

[miha42-github]

Packaging for interactions is now operable in the development branch. The behavior is to get the interaction object, download the content into a working directory, create a ZIP package in DOCUMENTS, and then cleanup all of the working directory data. The CLI is now verified to work both with and without the --package switch when a report is generated.

[miha42-github]

Encountered what appears to be a bug in GitHub and have opened an issue to understand more, essentially the download URL isn't properly encoded so axios cannot GET the file. The issue is The GitHub API fails to properly encode a URL for download #2962411.

Will attempt to write a workaround that only tries the download should the URL be encoded,

[miha42-github]

Found a workaround that looks to see if the download URL is encoded and if not it will replace it with an encoded version. One discovery is that if the file has a ? in the name special treatment should be taken as the ? is usually a signal of query parameters being added to the URL. The workaround has been shown to work with one company so far. On a more general basis, testing will occur with additional companies and interactions.

[miha42-github]

The packager now works for companies and interactions with a clear workaround for downloads. Testing will occur as documentation work is processed.