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

[PR] Adding API that consumes image files #61

Merged
merged 34 commits into from
Jun 14, 2023
Merged

[PR] Adding API that consumes image files #61

merged 34 commits into from
Jun 14, 2023

Conversation

LuchoTurtle
Copy link
Member

fixes #53

Creates an API endpoint that can receive multipart/form-data image files and uploads to S3.

@LuchoTurtle LuchoTurtle added enhancement New feature or enhancement of existing functionality in-progress An issue or pull request that is being worked on by the assigned person labels Jun 5, 2023
@LuchoTurtle LuchoTurtle self-assigned this Jun 5, 2023
@LuchoTurtle LuchoTurtle assigned nelsonic and unassigned LuchoTurtle Jun 7, 2023
@LuchoTurtle LuchoTurtle added awaiting-review An issue or pull request that needs to be reviewed and removed in-progress An issue or pull request that is being worked on by the assigned person labels Jun 7, 2023
@LuchoTurtle LuchoTurtle marked this pull request as ready for review June 7, 2023 14:22
@LuchoTurtle
Copy link
Member Author

This should now be mergeable. It adds an API that accepts files and limits the content type and size of the file. It uploads to the S3 bucket normally.

A dedicated guide has also been created for this effect.

@nelsonic nelsonic added this to More ToDo ThanCanEver Be Done in Nelson's List via automation Jun 7, 2023
@nelsonic nelsonic added in-review Issue or pull request that is currently being reviewed by the assigned person and removed awaiting-review An issue or pull request that needs to be reviewed labels Jun 7, 2023
@nelsonic nelsonic moved this from More ToDo ThanCanEver Be Done to In progress in Nelson's List Jun 7, 2023
nelsonic
nelsonic reviewed Jun 7, 2023
View reviewed changes
api.md Outdated Show resolved Hide resolved
nelsonic
nelsonic reviewed Jun 7, 2023
View reviewed changes
test/app_web/api_test.exs Outdated Show resolved Hide resolved
@nelsonic nelsonic moved this from In progress to Awaiting Feedback/Review in Nelson's List Jun 7, 2023
@nelsonic nelsonic added question A question needs to be answered before progress can be made on this issue and removed in-review Issue or pull request that is currently being reviewed by the assigned person labels Jun 7, 2023
nelsonic
nelsonic reviewed Jun 13, 2023
View reviewed changes
api.md Outdated Show resolved Hide resolved
@nelsonic nelsonic mentioned this pull request Jun 13, 2023
Closed
3 tasks
@nelsonic
abstract S3 upload code into separate library lib/app/upload.ex #61 (…
4ffce22 
…review)
@nelsonic
create test/app/upload_test.exs to test the generic upload function #…
147f6e6 
…61 (review) #53
@nelsonic
substantially simplify api_controller and actually test everything. #53
374ce3a
@nelsonic
add AWS_ACCESS_KEY_ID to .github/workflows/ci.yml fixes #67
52b6cbd
@nelsonic
attempt to use aws-actions/configure-aws-credentials@v2 to set AWS en…
c3723ad 
…v vars #67
@nelsonic
comment out echo set-env https://github.com/dwyl/imgup/actions/runs/5…
1070fcb 
…261770262/jobs/9510260164#step:3:6
@nelsonic
define role-to-assume in ci.yml #67
114d917
@nelsonic
use secrets.CI_AWS_SECRET_ACCESS_KEY #67
bd8bac7
@nelsonic
use secrets.CI_AWS_SECRET_ACCESS_KEY #67
741e525
@nelsonic
comment out "aws-actions/configure-aws-credentials@v2" #67
2db960f
@nelsonic
move environment variable definition higher in ci.yml #67
06a6254
@nelsonic
System.get_env("CI_AWS_SECRET_ACCESS_KEY") #67
e3a2da5
@nelsonic
replace System.fetch_env!/1 with System.get_env/1 #67
6bba2cf
@nelsonic
replace System.fetch_env!/1 with System.get_env/1 #67 (comment)
6791bf3
@nelsonic
replace System.fetch_env!/1 with System.get_env/1 #67 (comment)
82b55fd
@nelsonic
ensure env in ci.yml #67
ce7ac23
@nelsonic nelsonic mentioned this pull request Jun 14, 2023
Closed
nelsonic
nelsonic approved these changes Jun 14, 2023
View reviewed changes
Copy link
Member

@nelsonic nelsonic left a comment

Choose a reason for hiding this comment

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

@LuchoTurtle thanks for creating this. 👌
As noted in the review notes, I split the upload/1 function into it's own file with an ultra-simple test which in turn simplified the API Controller.
Also extended the docs in api.md to include testing with Hoppscotch.

This should be good to ship as a first version now. :shipit:

@nelsonic nelsonic merged commit aaa7760 into main Jun 14, 2023
2 checks passed
Nelson's List automation moved this from Awaiting Feedback/Review to Done Jun 14, 2023
@nelsonic nelsonic deleted the api-#53 branch June 14, 2023 03:18
@nelsonic nelsonic mentioned this pull request Jun 14, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nelsonic nelsonic nelsonic approved these changes

Assignees

@nelsonic nelsonic

Labels
awaiting-review An issue or pull request that needs to be reviewed enhancement New feature or enhancement of existing functionality
Projects
Nelson's List
  
Done
dwyl app kanban
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Feat: Image Upload API
2 participants
@LuchoTurtle @nelsonic