fix: Multipart support

[erickskrauch]

Fixes #657

This PR adds support for the multipart/form-data to upload files. It also introduces the File entity to allow the HTTP client adapter to determine that request must be made as a multipart. The current implementation allows to upload file by file path, by resource obtained via fopen or by raw file contents. It also allows to use any other file contents format, supported by the specific HTTP adapter implementation (for example PSR-7 StreamInterface implementation for Guzzle).

The problem is that Twilio's backend doesn't recognize file, uploaded with the multipart/form-data :( I have tested my implementation with the different backend implementations and in every case I successfully managed to parse and store uploaded files. Twilio just don't recognize files. I already compared body formed by my implementation with a body formed with the raw curl command (see this comments). I will gladly adjust body format to suit necessary Twilio's format if you will tip me how :)

Checklist

• I acknowledge that all my contributions will be made under the project's license
• I have made a material change to the repo (functionality, testing, spelling, grammar)
• I have read the Contribution Guidelines and my PR follows them
• I have titled the PR appropriately
• I have updated my branch with the main branch
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation about the functionality in the appropriate .md file
• I have added inline documentation to the code I modified

[thinkingserious]

Hello @erickskrauch,

Thanks for creating the PR! I am adding an internal identifier to track progress. We will update this ticket when we have a solution: DI-647

In the meantime, please see the associated issue for the current workarounds.

Thank you!

With best regards,

Elmer

[erickskrauch]

@thinkingserious, thanks!

Any chance to have a multipart fix on Twilio's backend side soon? I want to use this PR on the job's project to finish the task.

[childish-sambino]

The Twilio backend does actually support file uploads, it's just that we use a different subdomain for this. The support document upload example here uses numbers-upload.twilio.com (instead of numbers.twilio.com).

We're currently investigating including such upload subdomains in this library, but it will mostly be generated code from an internal API definition schema.

Given all this, I'm inclined to review/approve the changes if all the regulatory-specific changes are reverted (since that particular API does not support file uploads, and it will be blown away on the next release anyway).

[erickskrauch]

@childish-sambino, hey, thanks a lot for the mention about the different domains. I didn't pay attention to it and didn't understand why my implementation doesn't work and the curl command works.

I removed all changes to the generated code as you requested. I also created a separate branch where I made the necessary changes to support document uploading. I checked my implementation: the document is uploaded successfully! I'm sure my solution isn't perfect, but it's more than enough to use in the job's project until the support of documents uploading will be included in the SDK.

[childish-sambino]

FYI, this is a generated file (should be refactored so this particular part isn't generated) so we'll need to update the generator before merging.

[erickskrauch]

Is there a chance to have this merged?

[childish-sambino]

Moving this up the internal backlog. Should have a look to implement the upstream changes in a few sprints.