Middleware for requesting a PDF file in a get request #1355

bradbergeron-us · 2021-12-30T21:14:13Z

bradbergeron-us
Dec 30, 2021

Hey I'm contributing to a rails api project that uses faraday for standardizing service requests to third party endpoints. I'm looking for some insight on what middleware is needed when requesting a PDF file in a GET request or what the connection block should look like.

Answered by iMacTia

Jan 11, 2022

Hey @bradbergeron-us, sorry for the late reply, the last few days have been really busy with the Faraday v2 release!

I'm glad to hear you're now able to complete the request and you're getting the binary data as expected.
However I'm afraid that's pretty much as far as Faraday can help you with.
Now that you got the information you need, it's up to you to decide what to do with it.

There are several options available, below are some:

Store the binary data into the DB for persistent storage
Store the binary data into a temporary file accessible from the outside and return the URL to it
Return the raw data to the front end

If you don't need to reference this file in future, then the last …

View full answer

olleolleolle · 2021-12-31T08:26:53Z

olleolleolle
Dec 31, 2021
Maintainer

You can navigate the documentation site for specifics, BUT one thing that you may find is that your request retuns a redirect (an HTTP status in 3xx series), and you'd like the redirect to be automatically "followed". There's a specific FollowRedirects middleware for this, making a redirected URL seamless, a bit like a Web browser works. Hope this inspires you to find the stuff you are looking for!

3 replies

bradbergeron-us Jan 1, 2022
Author

Thanks for responding Olle in this case my request is responding with a 406 error.

olleolleolle Jan 1, 2022
Maintainer

https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406 ah then perhaps you want to add an accept header noting you'd like application/pdf of something like that.

olleolleolle Jan 3, 2022
Maintainer

I was thinking, the server may require the client to ask for a PDF in the "please give me content types I can handle", the Accept request header:

connection = Faraday.new(url: "https://example.com") do |c|
  # ... connection configuration here
end

response = connection.get("/example-server-path/my.pdf") do |request|
  request.headers["Accept"] = "application/pdf"
end

Perhaps this lets you move forward?

iMacTia · 2022-01-02T10:18:38Z

iMacTia
Jan 2, 2022
Maintainer

@bradbergeron-us to my knowledge, we don't currently have a specific middleware that takes care of this scenario.
This doesn't mean it should be hard to achieve with Faraday though, and it could be a good opportunity to create a new middleware specifically.

Do you happen to have a cURL or a Net::HTTP working snippet that we could use as a base to replicate in Faraday?

5 replies

bradbergeron-us Jan 2, 2022
Author

I don't have a snippet of anything working right now. I'm not really sure how to go about writing one that's why I was hoping someone may have some knowledge of a pre-existing middleware for this type of scenario when trying to fetch a file. I'd be happy to document some this particular use case in the faraday middleware docs. Does anyone have a snippet of what this might look like to retrieve a PDF binary endpoint through faraday middleware?

iMacTia Jan 2, 2022
Maintainer

I've never found myself having to retrieve a PDF using Faraday, but that shouldn't be hard. I'd expect the endpoint returning some binary data representing the file, which could then be stored somewhere.

Are any of the endpoints you'd like to call publicly available? If so I could definitely have a look and try this myself, then share the snippet here and we can decide if it's worth writing a middleware or just adding it to the docs

bradbergeron-us Jan 3, 2022
Author

Hi @iMacTia I have a VCR Response against the local request. The endpoints are not publicly available but this is an example response with a 200 status. This was achieved by using the faraday.request :multipart in the configuration setup block. Here is a VCR Response example:

recorded_at: Mon, 03 Jan 2022 19:37:06 GMT
- request:
    method: get
    uri: {example pdf endpoint}
    body:
      encoding: US-ASCII
      string: ''
    headers:
      Accept:
      - application/pdf
      Content-Type:
      - application/json
      User-Agent:
      - User Agent
      Authorization:
      - Bearer {Token}
      Accept-Encoding:
      - gzip, deflate, br
      Connection:
      - keep-alive
  response:
    status:
      code: 200
      message: ''
    headers:
      Access-Control-Allow-Origin:
      - "*"
      Access-Control-Allow-Methods:
      - GET, POST, PUT
      Access-Control-Allow-Headers:
      - Content-Type
      Content-Disposition:
      - filename= test
      Cache-Control:
      - no-cache, no-store, must-revalidate
      Pragma:
      - no-cache
      Expires:
      - '0'
      Content-Type:
      - application/pdf
      Content-Length:
      - '14177'
      Date:
      - Mon, 03 Jan 2022 19:57:02 GMT
      Keep-Alive:
      - timeout=60
      Connection:
      - keep-alive
    body:
      encoding: ASCII-8BIT
      string: !binary |-
        JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPDwgL0xlbmd0aCA1IDAgUiAvRmlsdGVyIC9GbGF0ZURlY29kZSA+PgpzdHJlYW0KeAGNkDsLwjAUhff+iuOjmgimN68+VsXFrXA361RwEDqU/n8wTZEWEZEMOTcJ38k5PWr0yM6DRjuA4hracETKuGkehS7hS6sqg7bDieGnl2EzxsPrCtwlGbOBBj8gVhL8xIUj/TeKFBFZcLuEukJVhc1HcsIdZvINYr2RwUVsJe7g638m838tWUVFbr6i050MwR3EXuJIKrikjYjSQzQyqnB7+Ms6+azKOaNM6aN16GuRagzz7qt+AWbtUfsKZW5kc3RyZWFtCmVuZG9iago1IDAgb2JqCjE4OAplbmRvYmoKMiAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDMgMCBSIC9SZXNvdXJjZXMgNiAwIFIgL0NvbnRlbnRzIDQgMCBSIC9NZWRpYUJveCBbMCAwIDYxMiA3OTJdCj4+CmVuZG9iago2IDAgb2JqCjw8IC9Qcm9jU2V0IFsgL1BERiAvVGV4dCBdIC9Db2xvclNwYWNlIDw8IC9DczEgNyAwIFIgPj4gL0ZvbnQgPDwgL1RUMiA5IDAgUgo+PiA+PgplbmRvYmoKMTAgMCBvYmoKPDwgL0xlbmd0aCAxMSAwIFIgL04gMyAvQWx0ZXJuYXRlIC9EZXZpY2VSR0IgL0ZpbHRlciAvRmxhdGVEZWNvZGUgPj4Kc3RyZWFtCngBnZZ3VFPZFofPvTe90BIiICX0GnoJINI7SBUEUYlJgFAChoQmdkQFRhQRKVZkVMABR4ciY0UUC4OCYtcJ8hBQxsFRREXl3YxrCe+tNfPemv3HWd/Z57fX2Wfvfde6AFD8ggTCdFgBgDShWBTu68FcEhPLxPcCGBABDlgBwOFmZgRH+EQC1Py9PZmZqEjGs/buLoBku9ssv1Amc9b/f5EiN0MkBgAKRdU2PH4mF+UClFOzxRky/wTK9JUpMoYxMhahCaKsIuPEr2z2p+Yru8mYlybkoRpZzhm8NJ6Mu1DemiXho4wEoVyYJeBno3wHZb1USZoA5fco09P4nEwAMBSZX8znJqFsiTJFFBnuifICAAiUxDm8cg6L+TlongB4pmfkigSJSWKmEdeYaeXoyGb68bNT+WIxK5TDTeGIeEzP9LQMjjAXgK9vlkUBJVltmWiR7a0c7e1Z1uZo+b/Z3x5+U/09yHr7VfEm7M+eQYyeWd9s7KwvvRYA9iRamx2zvpVVALRtBkDl4axP7yAA8gUAtN6c8x6GbF6SxOIMJwuL7OxscwGfay4r6Df7n4Jvyr+GOfeZy+77VjumFz+BI0kVM2VF5aanpktEzMwMDpfPZP33EP/jwDlpzcnDLJyfwBfxhehVUeiUCYSJaLuFPIFYkC5kCoR/1eF/GDYnBxl+nWsUaHVfAH2FOVC4SQfIbz0AQyMDJG4/egJ961sQMQrIvrxorZGvc48yev7n+h8LXIpu4UxBIlPm9gyPZHIloiwZo9+EbMECEpAHdKAKNIEuMAIsYA0cgDNwA94gAISASBADlgMuSAJpQASyQT7YAApBMdgBdoNqcADUgXrQBE6CNnAGXARXwA1wCwyAR0AKhsFLMAHegWkIgvAQFaJBqpAWpA+ZQtYQG1oIeUNBUDgUA8VDiZAQkkD50CaoGCqDqqFDUD30I3Qaughdg/qgB9AgNAb9AX2EEZgC02EN2AC2gNmwOxwIR8LL4ER4FZwHF8Db4Uq4Fj4Ot8IX4RvwACyFX8KTCEDICAPRRlgIG/FEQpBYJAERIWuRIqQCqUWakA6kG7mNSJFx5AMGh6FhmBgWxhnjh1mM4WJWYdZiSjDVmGOYVkwX5jZmEDOB+YKlYtWxplgnrD92CTYRm40txFZgj2BbsJexA9hh7DscDsfAGeIccH64GFwybjWuBLcP14y7gOvDDeEm8Xi8Kt4U74IPwXPwYnwhvgp/HH8e348fxr8nkAlaBGuCDyGWICRsJFQQGgjnCP2EEcI0UYGoT3QihhB5xFxiKbGO2EG8SRwmTpMUSYYkF1IkKZm0gVRJaiJdJj0mvSGTyTpkR3IYWUBeT64knyBfJQ+SP1CUKCYUT0ocRULZTjlKuUB5QHlDpVINqG7UWKqYup1aT71EfUp9L0eTM5fzl+PJrZOrkWuV65d7JU+U15d3l18unydfIX9K/qb8uAJRwUDBU4GjsFahRuG0wj2FSUWaopViiGKaYolig+I1xVElvJKBkrcST6lA6bDSJaUhGkLTpXnSuLRNtDraZdowHUc3pPvTk+nF9B/ovfQJZSVlW+Uo5RzlGuWzylIGwjBg+DNSGaWMk4y7jI/zNOa5z+PP2zavaV7/vCmV+SpuKnyVIpVmlQGVj6pMVW/VFNWdqm2qT9QwaiZqYWrZavvVLquNz6fPd57PnV80/+T8h+qwuol6uPpq9cPqPeqTGpoavhoZGlUalzTGNRmabprJmuWa5zTHtGhaC7UEWuVa57VeMJWZ7sxUZiWzizmhra7tpy3RPqTdqz2tY6izWGejTrPOE12SLls3Qbdct1N3Qk9LL1gvX69R76E+UZ+tn6S/R79bf8rA0CDaYItBm8GooYqhv2GeYaPhYyOqkavRKqNaozvGOGO2cYrxPuNbJrCJnUmSSY3JTVPY1N5UYLrPtM8Ma+ZoJjSrNbvHorDcWVmsRtagOcM8yHyjeZv5Kws9i1iLnRbdFl8s7SxTLessH1kpWQVYbbTqsPrD2sSaa11jfceGauNjs86m3ea1rakt33a/7X07ml2w3Ra7TrvP9g72Ivsm+zEHPYd4h70O99h0dii7hH3VEevo4bjO8YzjByd7J7HTSaffnVnOKc4NzqMLDBfwF9QtGHLRceG4HHKRLmQujF94cKHUVduV41rr+sxN143ndsRtxN3YPdn9uPsrD0sPkUeLx5Snk+cazwteiJevV5FXr7eS92Lvau+nPjo+iT6NPhO+dr6rfS/4Yf0C/Xb63fPX8Of61/tPBDgErAnoCqQERgRWBz4LMgkSBXUEw8EBwbuCHy/SXyRc1BYCQvxDdoU8CTUMXRX6cxguLDSsJux5uFV4fnh3BC1iRURDxLtIj8jSyEeLjRZLFndGyUfFRdVHTUV7RZdFS5dYLFmz5EaMWowgpj0WHxsVeyR2cqn30t1Lh+Ps4grj7i4zXJaz7NpyteWpy8+ukF/BWXEqHhsfHd8Q/4kTwqnlTK70X7l35QTXk7uH+5LnxivnjfFd+GX8kQSXhLKE0USXxF2JY0muSRVJ4wJPQbXgdbJf8oHkqZSQlKMpM6nRqc1phLT4tNNCJWGKsCtdMz0nvS/DNKMwQ7rKadXuVROiQNGRTChzWWa7mI7+TPVIjCSbJYNZC7Nqst5nR2WfylHMEeb05JrkbssdyfPJ+341ZjV3dWe+dv6G/ME17msOrYXWrlzbuU53XcG64fW+649tIG1I2fDLRsuNZRvfbore1FGgUbC+YGiz7+bGQrlCUeG9Lc5bDmzFbBVs7d1ms61q25ciXtH1YsviiuJPJdyS699ZfVf53cz2hO29pfal+3fgdgh33N3puvNYmWJZXtnQruBdreXM8qLyt7tX7L5WYVtxYA9pj2SPtDKosr1Kr2pH1afqpOqBGo+a5r3qe7ftndrH29e/321/0wGNA8UHPh4UHLx/yPdQa61BbcVh3OGsw8/rouq6v2d/X39E7Ujxkc9HhUelx8KPddU71Nc3qDeUNsKNksax43HHb/3g9UN7E6vpUDOjufgEOCE58eLH+B/vngw82XmKfarpJ/2f9rbQWopaodbc1om2pDZpe0x73+mA050dzh0tP5v/fPSM9pmas8pnS8+RzhWcmzmfd37yQsaF8YuJF4c6V3Q+urTk0p2usK7ey4GXr17xuXKp2737/FWXq2euOV07fZ19ve2G/Y3WHruell/sfmnpte9tvelws/2W462OvgV95/pd+y/e9rp95Y7/nRsDiwb67i6+e/9e3D3pfd790QepD14/zHo4/Wj9Y+zjoicKTyqeqj+t/dX412apvfTsoNdgz7OIZ4+GuEMv/5X5r0/DBc+pzytGtEbqR61Hz4z5jN16sfTF8MuMl9Pjhb8p/rb3ldGrn353+71nYsnE8GvR65k/St6ovjn61vZt52To5NN3ae+mp4req74/9oH9oftj9MeR6exP+E+Vn40/d3wJ/PJ4Jm1m5t/3hPP7CmVuZHN0cmVhbQplbmRvYmoKMTEgMCBvYmoKMjYxMgplbmRvYmoKNyAwIG9iagpbIC9JQ0NCYXNlZCAxMCAwIFIgXQplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMgL01lZGlhQm94IFswIDAgNjEyIDc5Ml0gL0NvdW50IDEgL0tpZHMgWyAyIDAgUiBdID4+CmVuZG9iagoxMiAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMyAwIFIgPj4KZW5kb2JqCjkgMCBvYmoKPDwgL1R5cGUgL0ZvbnQgL1N1YnR5cGUgL1RydWVUeXBlIC9CYXNlRm9udCAvVFBWTE1IK0NhbGlicmkgL0ZvbnREZXNjcmlwdG9yCjEzIDAgUiAvVG9Vbmljb2RlIDE0IDAgUiAvRmlyc3RDaGFyIDMzIC9MYXN0Q2hhciA0MiAvV2lkdGhzIFsgNDU5IDUyNyAzNDkKMjI2IDMzNSA0OTggMzkxIDIyOSA1MjUgNDcxIF0gPj4KZW5kb2JqCjE0IDAgb2JqCjw8IC9MZW5ndGggMTUgMCBSIC9GaWx0ZXIgL0ZsYXRlRGVjb2RlID4+CnN0cmVhbQp4AV2Ry2rDMBBF9/oKLdNFsOwkdgPGUFICXvRB3X6AI42DoJaFrCz8972jpCl0cRZnRleMRtmhfW6djTJ7D5PuKMrBOhNoni5BkzzR2TqRF9JYHW+WanrsvcgQ7pY50ti6YZJ1LaTMPhCZY1jk6slMJ3rg2lswFKw7y9XXoUuV7uL9N43kolSiaaShAde99P61H0lmKbpuDfo2Lmuk/k58Lp4kJkIiv46kJ0Oz7zWF3p1J1Eo19fHYCHLmXytX18RpuB0t8qZmlNqWjaiLAgqUKgfWDRQoVRWsWyhQqlCsOyhAd8taQgGyO9YKCtDdsD5CAbp71j0UQIm1hwJoleb+HZCfwKu+r0ZfQsBW0n+khfEirKP7l/nJ88MTP8IzjJ4KZW5kc3RyZWFtCmVuZG9iagoxNSAwIG9iagoyODgKZW5kb2JqCjEzIDAgb2JqCjw8IC9UeXBlIC9Gb250RGVzY3JpcHRvciAvRm9udE5hbWUgL1RQVkxNSCtDYWxpYnJpIC9GbGFncyA0IC9Gb250QkJveCBbLTUwMyAtMzEzIDEyNDAgMTAyNl0KL0l0YWxpY0FuZ2xlIDAgL0FzY2VudCA5NTIgL0Rlc2NlbnQgLTI2OSAvQ2FwSGVpZ2h0IDYzMiAvU3RlbVYgMCAvWEhlaWdodAo0NjQgL0F2Z1dpZHRoIDUyMSAvTWF4V2lkdGggMTMyOCAvRm9udEZpbGUyIDE2IDAgUiA+PgplbmRvYmoKMTYgMCBvYmoKPDwgL0xlbmd0aCAxNyAwIFIgL0xlbmd0aDEgMTgyODAgL0ZpbHRlciAvRmxhdGVEZWNvZGUgPj4Kc3RyZWFtCngB1XsJWFNX2v+59wYSEkISICwGSDCCYlhUEEEtRDZZXECITVCUXVRUxH3Hrba0tp3palfbaetM7XKJWtFutuN0m2r3drqOnWmndrHLzLTTsVW+37kvx6Uz/f7/5/me73nmC/nl93vf855zz3nPcq8Bl3evaGMm1sMUNqplUVMX0175flB6y8rlLrJTSxgLeay9a94istNBZs+8zjXtZOffBvv+jramVrLZj+DcDjjIlnLAwzoWLV9Ndj5vIL1zSctgef422HGLmlYPXp+9B9u1uGlRG8VPLud2V3fbYLmE/g37fGJXVycvHxh8UewFnxK0STeexUoGZmAys7IstoOxyFx5LNMxCT+MhWZn3xV2+5m5lonfsniDVvnRz9e/yMUbN/a2/3D6TE/YF4ZcmGFogV6op7/jzDuMGXf/cPr07rAvtJYGCzUy9YUpk2rl5+RnWB5zys8O8vssT36H+eS3wW+B/zDIb4LfgP06+DXwq+BXwE+CnwA/Dn6M+ZhOfpflAHWAck61wroHeB0IYQvRksRMqC+xaPlpVgK0AsuB64EQxD6BsnvQosRc8rb9YXFSpatf3irEFiE2C9EjxCYhNgqxQYj1QqwTYq0Qa4RYLcQqIVYKsUKI5UIsE2KpEF1CLBFisRCLhOgUYqEQC4SYL0SHEPOEaBeiTYhWIVqEaBaiSYhGIeYKMUeIBiFmCzFLiHohAkL4hbhUiJlC+ISoE6JWiBlC1AhRLcR0IaYJMVWIKUJUCVEpRIUQ5UJMFqJMiFIhSoQoFqJIiElCeIUoFKJAiEuEmCjEBCHGC5EvRJ4Q44TIFWKsEDlCZAsxRojRQowSIkuITCEyhEgXwiPESCHShBghxHAhUoVIEWKYEG4hhgqRLIRLCKcQSUIkCpEghEOIIULECxEnRKwQMULYhYgWIkqISCFsQliFsAgRIYRZiHAhTEIYhQgTwiCEXohQIUKE0AmhCCELIQnBBoU0IMRZIc4I8aMQPwhxWoh/CvG9EP8Q4jshvhXi70L8TYi/CvGNEF8L8ZUQXwpxSogvhPhciM+E+FSIk0J8IsRfhPhYiI+E+LMQfxLiQyFOCPFHIT4Q4n0h3hPiXSHeEeJtIf4gxFtCvCnEG0K8LsRrQrwqxCtCvCzES0IcF+KYEC8K8XshXhDieSGeE+JZIZ4R4ndCHBXit0I8LcRTQhwR4kkhnhDicSEeE+JRIQ4LcUiIfiEOCvGIEAeE2C/EPiGCQvQJoQrxsBAPCfGgEA8IsVeI+4X4jRC/FmKPEPcJca8Q9wjxKyHuFuIuIXYLcacQdwhxuxC3CXGrELcIsUuIm4W4SYgbhbhBiOuFuE6IXwrxCyGuFeIaIa4WYqcQVwlxpRC9QlwhxOVC7BDiMiG2C7FNiK1CbBFisxA9QmwSYqMQG4RYL8Q6IdYKsUaI1UKsEmKlECuEWC7EMiG6hVgqRJcQS4RYLMQiITqFWCjEAiHmC9EhxDwh2oVoE6JViBYhmoVoEqJRiLlCzBGiQYjZQswSol6IgBB+IS4VYqYQPiHqhKgVYoYQ1UJMF2KaEFOEqBKiUogKIcqFmCxEmRClQpQIUbyPPy33y9uCSQVOPDMHk+ygLWRtDiaNh9VD1iaijcGkcDg3kLWeaB3RWqI1wcRJCFkdTCwGrSJaSbSCypaTtYyom5xLg4lFqNBFtIRoMYUsIuokWhhMKEXkAqL5RB1E84jagwklCGkjq5WohaiZqImokWgu0Ryq10DWbKJZRPVEASI/0aVEM4l8RHVEtUQziGqIqommE00jmko0haiKqDLoqMAYKojKg45KWJOJyoKOKlilQccUUAlRMVERlU2iel6iQqpXQHQJ0USKnEA0nqrnE+URjSPKJRpLjeUQZVMrY4hGE42ixrKIMqleBlE6kYdoJFEa0Qii4dR0KlEKtTmMyE00lJpOJnJRPSdRElEiUQKRg2hIcMg0JCueKC44ZDqsWKIYctqJoskZRRRJZKMyK5GFnBFEZqJwKjMRGYnCqMxApCcKDcZX4+ohwfgakI5IIadMlkTENJIGiM5qIdIZsn4k+oHoNJX9k6zvif5B9B3Rt8G4Ome/9PdgXC3ob2T9legboq+p7CuyviQ6RfQFlX1O9Bk5PyU6SfQJ0V8o5GOyPiLrz2T9iehDohNU9keiD8j5PtF7RO8SvUMhb5P1B6K3grGXYihvBmNngt4gep2crxG9SvQK0csU8hLRcXIeI3qR6PdEL1DI80TPkfNZomeIfkd0lOi3FPk0WU8RHSF6ksqeIHqcnI8RPUp0mOgQUT9FHiTrEaIDRPuJ9gVjCjHoYDBmFqiPSCV6mOghogeJHiDaS3R/MAanvvQbauXXRHuo7D6ie4nuIfoV0d1EdxHtJrqTGruDWrmd6DYqu5XoFqJdRDdThZvIupHoBqLrqew6auWXRL+gsmuJriG6mmgn0VUUeSVZvURXEF1OtIPosqC9CWPfHrQ3g7YRbQ3a22FtIdoctPtg9QTtuNlIm4L2XNBGog1UfT3VW0e0NmhvRcgaqr6aaBXRSqIVRMuJllHT3VR9KVFX0N6CVpZQY4spchFRJ9FCogVE86leB9E86lk7VW8jaqXIFqJmoiaiRqK5RHNo0A3Us9lEs2jQ9dR0gC7kJ7qUujuTLuSjVuqIaolmENUEo70YWHUwmqd1ejCab9hpweitoKnB6AzQFAqpIqoMRuNBQqogq5xoMjnLgtEbUVYajN4BKglGbwIVB6N7QEXByDLQJCIvUSFRQTASzwXSJWRNDNoCsCYQjQ/a+D7KJ8oL2ibDGhe0+UG5QVs9aCyV5RBlB23pcI6hyNFBGx/YqKCNH0hZRJlUPYOukE7kocZGEqVRYyOIhhOlEqUEbTxLw4jc1OZQajOZGnNRK06iJKqXSJRA5CAaQhQftDagzbigdQ4oNmidC4ohshNFE0URRVIFG1WwktNCFEFkJgqnSBNFGskZRmQg0hOFUmQIRerIqRDJRBIR8w5Ymp0cZy0tzjOWVueP0D8Ap4F/wvc9fP8AvgO+Bf4O/9+Av6LsG9hfA18BXwKn4P8C+Bxln8H+FDgJfAL8JWKe8+OIDudHwJ+BPwEfwncC/EfgA+B92O+B3wXeAd4G/mBe6HzLPNr5JvgNc6fzdXOq8zXgVehXzB7ny8BLwHGUH4PvRfMi5++hX4B+Hvo58wLns+b5zmfMHc7fmec5j6Lub9He08BTgHfgCD6fBJ4AHg9f6nwsvNv5aPgy5+Hw5c5DQD9wEP5HgAMo24+yffAFgT5ABR42rXE+ZFrrfNC03vmAaYNzr2mj837gN8CvgT3AfcC9pgznPeBfAXejzl3g3aaFzjuh74C+HbgN+la0dQva2oW2bobvJuBG4AbgeuA64Jeo9wu0d61xmvMa43Tn1cZ5zp3Ge51XGfc4tyspzm1KnnOrlOfc4uvxbd7b49vk2+DbuHeDz7RBMm1wbKjasG7D3g3vbvBGhhrX+9b61u1d61vjW+VbvXeV77B8GWuXt3sn+lbuXeHTrYhesXyF8vcV0t4VUskKadQKSWYrrCtcK5Tw5b5u37K93T7WXd3d06126yao3Se6ZdYtGfsHjuzrdiSVgb3ru83WsqW+Jb6uvUt8i9sX+Ragg/Pz5vk69s7ztee1+tr2tvpa8pp9TXmNvrl5Db45ext8s/PqfbP21vsCeX7fpYifmVfn8+2t89Xm1fhm7K3xTc+b5psG/9S8Kt+UvVW+yrxyX8Xect/kvDJfKQbPEqwJrgTFyjswLQE9YQ6paJTD6zjh+NqhYw7VccShRFqGOIfIaZZ4qXh6vLQkflP8NfGKJe6lONkbl5ZeZol9KfaPsV/F6qK8sWmZZSzGGuOKUex8bDFT6/jY9sUUlhCPHquN1RnjTi2z2CWL3WmXS7+yS5cxRXJJ+B2SFaQYUGe/ZHeWKY9rv1YKYZJ0LavzVPUb2Iwq1VA9S5UuV1Nq+ae3pl4NvVxlvvpZ/j5JujrQJ8nFdWp0VU092dt37mSJRVVqYq0/qOzenVgUqFJ7uPZ6NT3ANUNIwDNn2YplHr/3EmY7YfvaptiftL5klS0WyWIZsMheCzpviXBGyPxjIELxRoweV2YxO80y/xgwKzFeMzw8lcPDq+vKLCanSfYVmqabZK+psLjMa8oYVfYv49zHx0lX9iyfs8wDudyjvWEFpBXcxAsleC9bDpv/gGAzXvLzLwpD3NxleGnNUPM/X+X/QIn0f6CP/+Fd7GPYIv5JA/I2/C5zK7AF2Az0AJuAjcAGYD2wDlgLrAFWA6uAlcAKYDmwDFgKdAFLgMXAIqATWAgsAOYDHcA8oB1oA1qBFqAZaAIagbnAHKABmA3MAuqBAOAHLgVmAj6gDqgFZgA1QDUwHZgGTAWmAFVAJVABlAOTgTKgFCgBioEiYBLgBQqBAuASYCIwARgP5AN5wDggFxgL5ADZwBhgNDAKyAIygQwgHfAAI4E0YAQwHEgFUoBhgBsYCiQDLsAJJAGJQALgAIYA8UAcEAvEAHYgGogCIgEbYAUsQARgBsIBE2AEwgADoAdCgRBAN2kAnwogAxLAWKsEn3QWOAP8CPwAnAb+CXwP/AP4DvgW+DvwN+CvwDfA18BXwJfAKeAL4HPgM+BT4CTwCfAX4GPgI+DPwJ+AD4ETwB+BD4D3gfeAd4F3gLeBPwBvAW8CbwCvA68BrwKvAC8DLwHHgWPAi8DvgReA54HngGeBZ4DfAUeB3wJPA08BR4AngSeAx4HHgEeBw8AhoB84CDwCHAD2A/uAINAHqMDDwEPAg8ADwF7gfuA3wK+BPcB9wL3APcCvgLuBu4DdwJ3AHcDtwG3ArcAtwC7gZuAm4EbgBuB64Drgl8AvgGuBa4CrgZ3AVcCVQC9wBXA5sAO4DNjOWif1SNugtgJbgM1AD7AJ2AhsANYD64C1wBpgNbAKWAmsAJYDy4BuYCnQBSwBFgOLgE5gIbAAmA90APOAdqANaAVagGagCWgE5gJzgAZgNjALqAcCgB+4FJgJ+IA6oBaYAVQD04FpwBSgCqgEKoByYDJQBpQCJUAxa/0PP6b/07sX+E/v4H94/xh/LDv3YMY7Gzd3Dv7gSX8HY2evu/APoFg1W8CWsR78XMZ2suvYk+xd1sy2Qu1iu9l97DdMZU+x59lbF9X6Hxpn14QsYuHKQRbKovB3YacHTp29D+gPibjAcx2sKJ3rvGfAOvDlT3xfnr1uwHq2PzSSGbW6ZvlVtPY36czAadxyQ5l5IJfb8g5oi3alb/R3nH347J6LBlDNalg9m8VmswbWyJow/lbWweYjMwtZJ1vEFmvWYpTNg26HNRdROF40fT5qCetiS1g3W85WsJX46YJeNmjxsqWavYKtws9qtoatZevYerZh8HOV5lmPkrWadzVKNrJNmJnNbIumBJNnK9vGtmPWdrDL2RWYsZ+3rjgX1cuuZFdhnq9m17Cf0zsvKrmWXct+wX6J9XA9u4HdyG7GuriV3fYT702a/xZ2B7sTa4bXuAGeOzV1I7uJPcaeYQfYQ+xh9oiWyxbkljIi8tKuZboLOViPMW+9oMeUzVXnsrUR2eDj7h0c92rkb8sFNVYO5pFnbysieXZ6B+eBt7Jh0CMycS1GRvr8OHmO+BiuuWicosb/y8tHzPN0G/IlMsNzdiN8t/yL98KIC/WN7HbswLvwybPK1d3QpO7U9IX+O87F7tbKfsXuYfdiLvYwrgST5z749rBfY2/fz/ayB/BzXl+oqPQh9qA2cyrrY0G2j+3HTD7CDrJ+zf/flT2Ms+OndfYNthU818ohdpg9ihXyBDuCk+Zp/AjP4/A9Oeg9qkWR/TT7LTuqRfHSp7G2nsUJ9QL7PXuRvcR+B+u49vkcrJfZq+w19pZkhnqFfYrPM+zlkI9YBJuEv5U9jNm4jc3Bz//iK2QIs7PdA98PrBr4Xiln7VIdHiAfwCztZ1fhm4nF5y8tOZlR9ycWzfYPfKfMBo84805Ix9m7B77y1l+2ffmy7qVdSxYv6ly4YH7HvPa21ua5cxpmz6oP+H11tTNqqqdPmzqlqrKifHJZaUlx0SRvYcElEyeMz88blzs2KzMjfURqyjD3UGdctM1qMZuMYQZ9aIhOwfN5eqm7rNGlpjaqulR3eXkGt91NcDRd4GhUXXCVXRyjuni9JhRdFOlFZPtPIr0U6T0XKVldE9nEjHRXqdulHitxu/ql+ho/9M4Sd8ClntL0VE3rUjXDDCM5GTVcpXEdJS5VanSVqmUrO3pLG0sy0qU+k7HYXdxmzEhnfUYTpAlKHeHu6pNGFEiakEeUju+TmcHML6sqKaVNrWp1jb+0xJGcHNB8rFhrSw0tVvVaW675KvrMrnT1pR/pvarfypobPeGt7tam2X5VaUKlXqW0t3eHavOoae4SNW3tR3FIYJua7i4pVT1udKxqxrkLSGpIitXt6v2WofPuU1+g1xd4mgY9oSnWbxkv5EM8lyZVahKaoW/oIcaXnMz7cmW/lzXDUHtq/GS7WLMjyLxZnoAqN/KSI6LE7uMlPaLkXPVGNzJb6i5tHHyv7IhTe5pdGemYWe2doupSUO5SldTG5pYOzk1tve4SjBC5ZHV+1VsC4W0aTGZp36gsxDc1YhDzeRpq/GqWu0uNdhdRtuFAIyml82v9WhXylqrRxSprbBmspWaVoi6WSGkvnxjeQd6Wu8Z/iGUPnOjLcTn2ZbMcFuD9UGOKMSmppb3+1nbV2ehoxfpsd/kdyao3gPQF3P62AJ8lt1VNO4HL4YUJ1GphbD+JFsEYtqpPMbj8skMJ8NmCw1WGD3fRRBRY1VAy+YwWTXT5JQcTYbjKYARXF7UDQ0kpLkdlMKoWlzuSsbi113/TJQcNAN1QDef6pEMnQs73ia7zs12jaN6hNFdpW8kFHbyoURhaBwdb+/f9lHkuBpOBLhj4dJbzMWSky9AuFBtUGePUXHwW41wqq3b53W3ugBtryFvt55PDc63Nb1Wtm3+9qs324Cqpu8ii8jwqU1lyVZ1fGPybJ7XMo80rn1bNnqzZ58zynxRXiGKcO6y6t7e1jykpfCk7+iRNhBRfGVCnewJutdnjTub9zEjvM7Dw5LrGYuzeMpyc7rImt8vqKutt6h/oae7t83p7u0obO8ZjX/S6K1p73bX+iZhc7SDY4FjL+xLJqqSquiI0JbOiPrd0eU2fV7q8tt5/yMqY6/I6f1DGd82NRYG+YSjzH3Ix5tW8MvdyJw9xcYO3NAOGQYt3HPIy1qOV6jSHZrf0S0zzURB8Emvpl8ln1eL6UrULefF/J1r6dVTiFS3o4DOQr4eiRwxGG1Bi5SWHGW4k+PIPfaYXfRPoNYZ4Dd4wb7hslpFSPiVBeA4jNkxi+8Ils+ToQ5sYAdz4lXRfmNdxSGuJXIelHkRyXw9aHwyTGQ+7oCFckgbuAw2OwFfv3xfO0L72iYgi/sIREteBNYYbTamrla+/9YGO3sYAPz1YDNYq3pIquQuYKrsL0OPQcNXobitSTe4i7i/k/kLyh3K/3l2kSjESJrsfh25voxsHMfaUH7/uCGD5W/n2llNc/QMDdf7kY45TgWTs+dlAvV8N8+BGF5JSibjJHI1wT1Z7Wpp4P5gPZxk/eipaAtjsokGEVKhhaCFssAVElGl1+H5DpRasNSxIrX4PDLUnoAY8/KL++bxHLpdVZeXu8WpoKrUZksovlBXojXSP4TsXoaoxZQenMPSN1frJ44CJi+GOwkekD0fPW9woaml0IetYI7XYy3SzMPJ1CE8bznxdapsGo2OwkPFhKSkms1ENy0SDeHNtykSDeOsDSAofvGbtGAzAta2qCT1KvSCVgxWQHRRV8L7gvQOd56FP8WZq+tkM92qc/bzT2qX0KFbNKRVNuLtRfRM87jxRGW0ZUriLt3GUvHo+8nDkHUdC/8Ae9xp+xIlXRrqb3/34+mOOQ9ioLND7U4c6y5ORbvip16y5e3sN5n9fgfJlMJ9j3goG0sJva2C+4LT15irlN1h3ZZ88DRFgSePeSjduanIKBx50FGyfZFdrgEehy9XaWeb+uSA0cS6I36a1xnutE/hTCbdQrlkw8O5V511sdpwzy1BchofBlExAe6diYvi5v8ChdmJlolgL4TPi6nVZ3ePd/ANDVbAbgEbM07ltgeWPVcc3TU+Ly9+MxY70lDX2lvXiIq6WJlTja3DwSupiz0VNYl9I2IdICM+C2lPtagy4GvFoKtX4k5Md2I1gV3uT6nU38VtBNa6PdzVuSaCmXr7EWQAXdah63Jjam9rcybjhwBfQ8qrND65O24Y5envdvap2EJQhGM2nYttVcMK7y+NuauOP0Lieq6lNq1uG7mrZ4f1zlLqxl9vQW553jAv/+4s184+WXjdaa2j0IBO23sheV34vjuAG3D10qS0zG3Gr4ncklzbVTQ5YyGsFtwJoiALDUnggbQHem0WevgZ9ynkP34vqEg8FG7RW0bMZfrVaVNL2E49a6lHl2DwUoqeqNAMnG/LPzykkLySlAun1Yuk5eG2XKuP2StOj1a/gVXE00IRRNXi0m4i2xXCTFHcbcR+a7UBOf9bPdBGM4et6pjzIHlB+YA3KUTYWX+1v1+WwXbo8Vi+/wHYpyaxGfoglY9NqvwgGh+M7oiRwMjPiHqLH/0SUoBT8f8IQlOhQwvCv0SelCdJpxahcq8vWvRoyO7Q49A2Us7PLlFfxDZSCevlsKpvGblK3e/yP4f4zg8Ww8dKBA/aSEkOG/gmpGI278P0ympeKvRadbD44ZEih++DY0J2KraJfythfqN+J35wUnvngzPGsMx+ciszPOiVlvf/hBx9avzluy8/K/vD1D0fjN+nRQ8wHO1F1rPtg51gldGenYivk9b1hnYVeWb+zE43EFXqGHPccz/Ic96AZz6jRAcmWbNMQHSHr9dGh7qGZ8tjhqbnZ2WMK5LE5qe6hEbLmy8kdV6Bkj0mSFUSSp0DmtqS8+mO9Mv1MqLzRXTgzOyRpiCXaHBoiJ8RFZkxMsdbOSpmYmahX9KFKiEE/YlzR0KrO0qHv6G2J9pjESIMhMjHGnmjTn3k3JOL0X0MifijWdf5wvRI6YXbhMOVmo0HWhYb2J8XFj5yQXDHTEmXVmaKsthiDPtIWPqJk9pnL7Am8jQS7ndo6MxWz9MDAaaUO2R/OtvKs9+mj+gdO7rNKU8Ff77MMslnj7/DQwf0n95k4y7YD5kSWlKjvl8L3RUXFh/ZLI/YNrYn3scLCwcxnHbXlf6h94TsGae+L4qEHOhE7lAfv79Si4woLz2WY5yvZloxU2UmKBNpycrO5W6nTGc36s6nSEb3ZqNO01xDtGhI3NNqQFiuXad6jUQk2w9lyvdVhj3LYws58rDfrQ0LwoXtouBNZxDJqGDil7FJeYB78A+gzPnLvyKzcwtwluUqUi4/WxYcelZxuxZDT4zDedCvc6VaLVZqS3i/980CJ5x6P7EGSDiDSk6PrHzixDxHgL3maNBvVwCf380q6ftnoTU5Of7ZHd61OPqKTXtZJOl1C1nuplXGfNUZ0RcgRYZ8lTMXafb3hlJa/hqXdWLxa+sa872nQBF+JntGjGhzeobr0ZztXam2kZr3XmVoZEfdZJ4uw4i8hlIiEsM860RaW8FF8z+HR8tugLWGs2uToJCxGWpDIMi3jnEF7eK62jPXKruHxZ4JJZV013taKrHC9KVSRFb0pd+ZS75I93eMnLt3dsuCGxoz7lDWrLpldMFSW5eHJVatnZtqH2PUR8ZHmKEu4KT4uqmBt/9rlhzaXliy71R+15frMKW3jcLiwsWevU65QnmMF2O1zpRgt//bIjMlW5HKyAemb7LJGSVMmZxf2D3zP0wnWViP4xCO8qFA/HdJrtkRKU6Y7dJZRSrZez+cAS9fB/9rDDJGRrXc49NkZOsZjczAdzM8v4XdZUc0/MsVrAqdYRumVvMp3wmtP2u2NecqnE8tHuorezquc9bZrOivUJqPwlI2fJW+eiozNl7I82cc8nqOe2PwsvDweG5zWYx68PeKDHzLDtXbDK9/pDLfba0928sYnKp928ubzit7uzKt0zXq7E5fANPEZKkRDmF7rMx60x48bzJU7JkbbCENTh4eG2qNjYmOTFHLg6MGcjUtNHYvThn/yCYyJTR4TI9FJhGg+y1E5qcOHR6CSZilXRFk2uxPGNPRMG9fiiIydlPt5cdeMzJyF9y1dtKs53Zo82jU6a0yKc1jO7M1T0iY7JavNdvZsW8OoyVmxbbNGl2fF1s6t+dSVFhe2bWVVW4FDWe52Drs0a9rq2vTEmMjMJHembJSTLwlMKOjyjU7xBnKSC/Ky4+OnpF/SmJrSUDR1bV1GmCH57Dez57nyKkYE2p3jys/MGV8oG+Iz0kbYJxUnjipg2J3bB05LNSFZ+O4vme3hq+NgoXu6e4lbieGnD7YZWDuNNDtKs7Wph62tE82P+Y55VF7KEpgdXtTCnz9ptcDaGQb+Wtuc9n7p+0eMTi/WBv7ssWB/vLUiZAqOsTdPeQZ34Ot0jGl7ry+eBx3opCgcX8/wrZVy/qga3EtR/BbB5wcTIxUYIl3xca4ovT7KFRfvijREpU8Y7+GIN5gMOh0+lG36cK7C9dKo8SPT8gGc0LtwQu/GSTWG9Wv7xBJpxcCi+EdhjjRSO6f/v85r6XuvI8lkRayJn2UmvhNMRmwuEz/fTEjBQeaFyZKs/VKo15hROTJ+WEX8FC0ThVifOI2yPJQHK1E+jiL8vZOjL0OrYuq8oA7ywiv9JDWZuB+G6m3/kit7LrKEU1/ZjTxp+YnLrBhVsL5EpC00MiE2JtGqn3LT1Pp1U5LPJU22TJ1TMszvO3Pl+TQaTGGKEmYyrPJNv6T9ika+oupx3n+ALEbhTve8lseEwjRpRKSUZpNSzVJquJRqkFL10khFSpOlJL5AkCiwtpzA2ukO1k53rRxJS+KHelKWUTJGxyE8mqc0mt8/oiORyGie1+jD+GMPNnDkoIVN7cJ0xvdLUtBS6e6X5L4QHPc4XqSshsG0ZtEpz1eZeDn6LLzK/k5LZQivFOxELe3E0I6Ii58v9Dk8vxG4eSZpR7zywfhlD3YvuXdxbv6yB5aBxz3kKFgwvWJ+SbKjcMH08gUlLunjxYcuqyrauL8bXAleX7GlOT9n7paplVua8nPmbOFPeViD8h5kL5tdxnO3v2uslGoZ3ExgbTOBaTNxwXebBSvKG8m82J7Ma8MHTwwbYuyXUrxhnspUi91VYee7LDJfW1tHcXxqy4qvKkefRws0dp6PxIrioXQfo4Hzwf671aQ9foXKe+TQMIMhNnGYPX7U2PHun66llEnj8xPNycMSw3WKpDTHJNnCwsIM0ZlTxp1R/3U1bc0tGW5RDEZjWIQDOakZOCUfR04qJKu2nsKzqgqrpldtqnq4KmTSYArA2oGj2Vgb4CP7kA/NxoLRGItkUr/0ntc5bMywMeEOvjcdfFs6+FZ18H3u4OvKcRh/44OF5DXCYOFe+MP5jS4V7RWGPxwuh2e+P874ua3a1mjrsinjbONsMRPfneQISauMOUkrDdk7ZcvHXavBesqqLTvP64MrD0VZ9Kwx+HyRMi7z/U6b8fNOZrPaXDYlglpMm/hup9ZmSMxJsRJR16M1y581LpgdHd2UaCmOzckMHbRxIzs/e1iqofLx7Dlbpo26tHRUjFEXatKbPIUz80aWjHEM91b7arzD02asmzGsfHyaXa8oit4YGjY0tyJrpDfNPsI7w1frHS5FlHZiPcXGRw9zRg2x6h0uR6Q7NyU1Z4RzqKdg5sSxTRXp4ZF2a7glxmqLt+pj4mOi3KMSho8d4Ro6cmIdX+HJA1/Ji3QPsvHsCm2FpzGbO2Nw92uMWQFrswnWTgeNMQ0ZfKGHx5ozTrnLE82nYstH90u6Pj1t7mN8f2fTcTnm2FH+HOxF06c6ERvrjTWf6owt1/MKwU7U0Db2EOsxcWzqtH892LTbCO4q2SKjdrt2WvInBBvd2bktLzJYXWmZsWWt3sSNlsgQg9mwQdxuPjGEh+kiLZ+Mmxw7LCHaEBIWopuVONQaERaaUrVsmhzhGhY1xKZ/U48oXVg4hG1I1DDXWWPD3DBjWEhEnPZvOIlFIlf8FYrfArK66plTppZ7ips65zd3z/8v1VcGwwplbmRzdHJlYW0KZW5kb2JqCjE3IDAgb2JqCjkwOTYKZW5kb2JqCjEgMCBvYmoKPDwgL1RpdGxlIChNaWNyb3NvZnQgV29yZCAtIFBERlRlc3RpbmcuZG9jeCkgL1Byb2R1Y2VyIChtYWNPUyBWZXJzaW9uIDEwLjE1LjcgXChCdWlsZCAxOUgxMjE3XCkgUXVhcnR6IFBERkNvbnRleHQpCi9DcmVhdG9yIChXb3JkKSAvQ3JlYXRpb25EYXRlIChEOjIwMjEwNjI5MTgyMzE5WjAwJzAwJykgL01vZERhdGUgKEQ6MjAyMTA2MjkxODIzMTlaMDAnMDAnKQo+PgplbmRvYmoKeHJlZgowIDE4CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAxMzQzNSAwMDAwMCBuIAowMDAwMDAwMzAzIDAwMDAwIG4gCjAwMDAwMDMyNzYgMDAwMDAgbiAKMDAwMDAwMDAyMiAwMDAwMCBuIAowMDAwMDAwMjg0IDAwMDAwIG4gCjAwMDAwMDA0MDcgMDAwMDAgbiAKMDAwMDAwMzI0MCAwMDAwMCBuIAowMDAwMDAwMDAwIDAwMDAwIG4gCjAwMDAwMDM0MDkgMDAwMDAgbiAKMDAwMDAwMDUwNCAwMDAwMCBuIAowMDAwMDAzMjE5IDAwMDAwIG4gCjAwMDAwMDMzNTkgMDAwMDAgbiAKMDAwMDAwMzk5MSAwMDAwMCBuIAowMDAwMDAzNjA3IDAwMDAwIG4gCjAwMDAwMDM5NzEgMDAwMDAgbiAKMDAwMDAwNDIyNyAwMDAwMCBuIAowMDAwMDEzNDE0IDAwMDAwIG4gCnRyYWlsZXIKPDwgL1NpemUgMTggL1Jvb3QgMTIgMCBSIC9JbmZvIDEgMCBSIC9JRCBbIDxjNDk1ZmQwNTZkMmJkMmM2ZTE5ZTlkYTJkMGU1ODBmZj4KPGM0OTVmZDA1NmQyYmQyYzZlMTllOWRhMmQwZTU4MGZmPiBdID4+CnN0YXJ0eHJlZgoxMzY1OQolJUVPRgo=
  recorded_at: Mon, 03 Jan 2022 19:57:02 GMT
recorded_with: VCR 6.0.0

Below is a snippet of the response headers I'm getting back from running the route in a pry context.

response=#<Faraday::Response:0x00007fd538e31538 @env=#<struct Faraday::Env:...>, @on_complete_callbacks=[]>,
 response_headers=
  {"access-control-allow-origin"=>"*",
   "access-control-allow-methods"=>"GET, POST, PUT",
   "access-control-allow-headers"=>"Content-Type",
   "content-disposition"=>"filename= test",
   "cache-control"=>"no-cache, no-store, must-revalidate",
   "pragma"=>"no-cache",
   "expires"=>"0",
   "content-type"=>"application/pdf",
   "content-length"=>"14177",
   "date"=>"Mon, 03 Jan 2022 22:12:33 GMT",
   "keep-alive"=>"timeout=60",
   "connection"=>"keep-alive"},
 status=200,

Here is how the multipart request is configured:

# frozen_string_literal: true

require 'rack/mime'

module Common
  module Client
    module Middleware
      module Request
        class MultipartRequest < Faraday::Middleware
          include Rack::Mime

          def call(env)
            return @app.call(env) unless env[:body].is_a?(Hash)

            io_keys = []

            env[:body].each do |key, value|
              env[:body][key] = io_object_for(key, value, io_keys)
            end

            if io_keys.any?
              env[:body].except(*io_keys.uniq).each do |key, value|
                env[:body][key] = make_io_for_body(key, value)
              end
            end

            @app.call(env)
          end

          private

          def io_object_for(key, value, io_keys)
            if value.respond_to?(:to_io)
              io_keys << key
              Faraday::UploadIO.new(
                value,
                mime_type(File.extname(value.path)),
                file_name(value)
              )
            elsif value.is_a?(Array)
              value.map { |each_value| io_object_for(key, each_value, io_keys) }
            else
              value
            end
          end

          def make_io_for_body(key, value)
            Faraday::UploadIO.new(
              StringIO.new(value.to_json),
              'application/json',
              key.to_s
            )
          end

          def file_name(value)
            value.original_filename || value.path
          end
        end
      end
    end
  end
end

Faraday::Request.register_middleware multipart_request: Common::Client::Middleware::Request::MultipartRequest

Example File in request: response.pdf

iMacTia Jan 5, 2022
Maintainer

Thank you @bradbergeron-us, this is useful.
Although now I'm a bit confused on what you're trying to achieve here 🤔.

I originally thought you had issues requesting the PDF (i.e. the server should return you the PDF data) and were getting a 406 error, but in your last message you said you were able to run the request successfully using Faraday.

The Ruby snippet you shared shows the code for a multipart_request middleware, but that would only affect the request, not the response. You should use that when you want to send a PDF to the server, not receiving one. And as you already mentioned, you should be able to use the existing multipart middleware, rather than implementing your own.

Could you please clarify where excatly you're stuck at the moment?

bradbergeron-us Jan 5, 2022
Author

Hi @iMacTia thanks for the response. It's a bit of a moving target on the issue 😅. Latest status is that I did receive the binary string representing the PDF with a 200 response trying to fetch the PDF when I removed the JSON middleware. However not sure how to handle the binary string representing the file in terms of sending the file to a frontend app through the controller action. Additional context on the multipart request middleware that is the only middleware in my connection block for this service is the multipart middleware (not sure if it's even being hit on the request). I was getting a 406 response when I had the json middleware in the connection block. Where I'm stuck now is typically when using faraday with a. json endpoint I format the response in a and serialize it for the frontend to consume. I'm just not familiar with binary data and am not sure how to format this string into a consumable response. Faraday json middleware has been so helpful in removing parsing abstractions. The next step for me is to format this request into a consumable response to pass through my controller action(rails-api app). Any thoughts on how to format the binary string in the VCR recording prior to sending this response to my Frontend server? For json I call the service in a controller action that performs the same request and then may re-format data in a response class before using Active Model Serializer on the attributes in my controller action.
What I would like this web service to do is convert this binary string to a file. This response leaves me with a few questions. Is there anything I can add in my service's configuration in the faraday connection block for this PDF endpoint in terms of middleware to make this easier to format a consumable response? Is there a string method that can decode this binary representation? Should I try to just send this binary string and try to handle it on the frontend? SO question about web service returning just a binary string of a pdf.

iMacTia · 2022-01-11T08:56:17Z

iMacTia
Jan 11, 2022
Maintainer

Hey @bradbergeron-us, sorry for the late reply, the last few days have been really busy with the Faraday v2 release!

I'm glad to hear you're now able to complete the request and you're getting the binary data as expected.
However I'm afraid that's pretty much as far as Faraday can help you with.
Now that you got the information you need, it's up to you to decide what to do with it.

There are several options available, below are some:

Store the binary data into the DB for persistent storage
Store the binary data into a temporary file accessible from the outside and return the URL to it
Return the raw data to the front end

If you don't need to reference this file in future, then the last option is the best one if you ask me, as you won't have to handle an ever-growing file system on your server 😄
And it's also pretty easy to do! A quick search shows you can use send_data in your controller: https://stackoverflow.com/questions/68744616/how-to-handle-when-api-returns-pdf-binary-stream

2 replies

iMacTia Jan 20, 2022
Maintainer

Hi @bradbergeron-us, did this help solving your issue? It would be great if you could loop back and potentially mark this as the answer so future readers will know how to approach this 😃

bradbergeron-us Jan 20, 2022
Author

Hi @iMacTia I ended up doing something in the controller to send the file to the frontend to be downloaded.
send_data response.body, filename: 'example.pdf', type: 'application/pdf', disposition: 'attachment'

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Middleware for requesting a PDF file in a get request #1355

{{title}}

Replies: 3 comments 10 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Middleware for requesting a PDF file in a get request #1355

bradbergeron-us Dec 30, 2021

Replies: 3 comments · 10 replies

olleolleolle Dec 31, 2021 Maintainer

bradbergeron-us Jan 1, 2022 Author

olleolleolle Jan 1, 2022 Maintainer

olleolleolle Jan 3, 2022 Maintainer

iMacTia Jan 2, 2022 Maintainer

bradbergeron-us Jan 2, 2022 Author

iMacTia Jan 2, 2022 Maintainer

bradbergeron-us Jan 3, 2022 Author

iMacTia Jan 5, 2022 Maintainer

bradbergeron-us Jan 5, 2022 Author

iMacTia Jan 11, 2022 Maintainer

iMacTia Jan 20, 2022 Maintainer

bradbergeron-us Jan 20, 2022 Author

bradbergeron-us
Dec 30, 2021

Replies: 3 comments 10 replies

olleolleolle
Dec 31, 2021
Maintainer

bradbergeron-us Jan 1, 2022
Author

olleolleolle Jan 1, 2022
Maintainer

olleolleolle Jan 3, 2022
Maintainer

iMacTia
Jan 2, 2022
Maintainer

bradbergeron-us Jan 2, 2022
Author

iMacTia Jan 2, 2022
Maintainer

bradbergeron-us Jan 3, 2022
Author

iMacTia Jan 5, 2022
Maintainer

bradbergeron-us Jan 5, 2022
Author

iMacTia
Jan 11, 2022
Maintainer

iMacTia Jan 20, 2022
Maintainer

bradbergeron-us Jan 20, 2022
Author