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.

Sign up for GitHub

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

Jump to bottom

Allow serializers to return hooks and a serializer function. Port all image serializers to use new functionality #630

Merged
merged 23 commits into from
Aug 6, 2020
Merged

Allow serializers to return hooks and a serializer function. Port all image serializers to use new functionality #630

merged 23 commits into from
Aug 6, 2020

Conversation

schloerke
Copy link
Collaborator

@schloerke schloerke commented Aug 4, 2020 •
edited
Loading

Now users will be able to register their own image serializers that require preexec and postexec hooks.

  • Added png, jpeg, svg, tiff, bmp, and pdf for the default set.
  • (Also added a tsv serializer)
  • Moved content type to top level argument to allow routes to set the content type of the serializer

No more need to hand coding all of the image serializers and custom searching.

PR task list:

  • Update NEWS
  • Add tests
  • Update documentation with devtools::document()
  • Update vignettes

@schloerke
Add device serializers
bf0c066 
* serializer_{jpeg, png, bmp, tiff, svg, pdf}()
* Allow serializers to return hooks and a serializer with `hooks_and_serializer()`
* Endpoints and filters now handle serializer output from `hooks_and_serializer()`
@schloerke
merge master
3137cca
@schloerke
add tsv serializer
d9f6646
@schloerke schloerke marked this pull request as draft August 4, 2020 17:17
@schloerke schloerke marked this pull request as ready for review August 4, 2020 18:59
@schloerke schloerke added this to the v1.0.0 - Next CRAN release milestone Aug 4, 2020
cpsievert
cpsievert reviewed Aug 4, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 4, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 4, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/serializer.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/plumber-step.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/globals.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
R/plumb-block.R Outdated Show resolved Hide resolved
cpsievert
cpsievert reviewed Aug 5, 2020
View reviewed changes
NEWS.md Show resolved Hide resolved
@cpsievert cpsievert self-requested a review August 5, 2020 19:02
cpsievert
cpsievert approved these changes Aug 5, 2020
View reviewed changes
Copy link
Contributor

@cpsievert cpsievert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with suggestions

schloerke
schloerke commented Aug 5, 2020
View reviewed changes
R/plumber-step.R Outdated Show resolved Hide resolved
schloerke and others added 10 commits August 5, 2020 15:25
@schloerke @cpsievert
Remove unnecessary code
92c6f88 
Co-authored-by: Carson Sievert <cpsievert1@gmail.com>
@schloerke @cpsievert
Add roxygen suggestions
66c4604 
Co-authored-by: Carson Sievert <cpsievert1@gmail.com>
@schloerke
remove name arg from registered_serializer()
67d9778
@schloerke
Merge branch 'register_device' of https://github.com/rstudio/plumber …
0a61b18 
…into register_device
@schloerke
document
593f2e0
@schloerke @cpsievert
Do not use a charset if the main mime type is application
413eec6 
https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types

> For example, for any MIME type whose main type is text, the optional charset parameter can be used to specify the character set used for the characters in the data.

Co-authored-by: Carson Sievert <cpsievert1@gmail.com>
@schloerke
Rename hooks_and_serializer() -> enpoint_serializer
184a4fa
@schloerke
Merge branch 'register_device' of https://github.com/rstudio/plumber …
622beea 
…into register_device
@schloerke
More docs and news items. Document
8bf4ae9
@schloerke
Fix tests
c30a959
@schloerke schloerke merged commit c7ce15a into master Aug 6, 2020
@schloerke schloerke deleted the register_device branch August 6, 2020 17:07
schloerke added a commit that referenced this pull request Aug 7, 2020
@schloerke
Merge branch 'master' into validate_openapi
d2d1d5f 
* master:
  Add `plumb_api()` and `available_apis()` (#631)
  Allow serializers to return hooks and a serializer function. Port all image serializers to use new functionality (#630)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cpsievert cpsievert cpsievert approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v1.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@schloerke @cpsievert