Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ruby Client for Faraday: fix file downloading #17333

Merged
merged 2 commits into from Dec 9, 2023

Conversation

lumpidu
Copy link
Contributor

@lumpidu lumpidu commented Dec 6, 2023

In MR #16876, a bug was introduced that causes file downloading to fail for the Faraday adapter.

@meganemura @dkliban

This commit fixes the obvious missing parameter for the method call to download_file() and the missing variable request for saving the response value of the call to build_request().

Tested so far only locally, but would like to add an appropriate test case for binary data download but need some feedback, how to integrate this kind of tests into this MR.

There is an appropriate test scenario for the Python client that could be used as reference:

https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/echo_api/python/test/test_manual.py#L110

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

In MR OpenAPITools#16876, a bug was introduced that causes file downloading to fail
for the Faraday adapter.

This commit fixes the obvious missing parameter for the method
call to download_file() and the missing variable `request` for saving the
response value of the call to build_request().

Signed-off-by: Daniel Schnell <dschnell@grammatek.com>
@wing328 wing328 added this to the 7.2.0 milestone Dec 7, 2023
@wing328
Copy link
Member

wing328 commented Dec 7, 2023

thanks for the PR.

cc @cliffano (2017/07) @zlx (2017/09) @autopp (2019/02)

@wing328
Copy link
Member

wing328 commented Dec 9, 2023

thanKs again for the fix. I'll add a test or two after adding this PR.

@wing328 wing328 merged commit 5831848 into OpenAPITools:master Dec 9, 2023
16 checks passed
@wing328 wing328 mentioned this pull request Dec 9, 2023
5 tasks
@wing328
Copy link
Member

wing328 commented Dec 9, 2023

filed #17362 to add tests to ensure the file download works as expected in all ruby libraries supported

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants