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

Communication between Third Party Apps and the ELN #1353

Closed
wants to merge 16 commits into from

Conversation

Konrad1991
Copy link

This code enables the communication of the ELN with third-party apps (TPAs)

  • in the admin dashboard code is added to register TPAs (name and IP address)

  • in the research plan/attachment the user can send files to TPAs

  • The public API contains methods for TPAs to download or upload a file

  • [x ] rather 1-story 1-commit than sub-atomic commits

  • [ x] commit title is meaningful => git history search

  • [ x] commit description is helpful => helps the reviewer to understand the changes

  • [ x] code is up-to-date with the latest developments of the target branch (rebased to it or whatever) => ⏩-merge for linear history is favoured

  • [ x] added code is linted

  • [ x] tests are passing (at least locally): we still have some random test failure on CI. thinking of asking spec/examples.txt to be commited

  • in case the changes are visible to the end-user,  video or screenshots should be added to the PR => helps with user testing.
    - I have written a documentation. Pierre has the file. I'm not sure what is the best way to make it public.

  • testing coverage improvement is improved.

    • I'm not sure how to do this.
  • CHANGELOG :  add a bullet point on top (optional: reference to github issue/PR )

    • I'm not sure how to do this.

This code enables the communication of the ELN with third party apps (TPAs)

- in the admin dashboard code is added to register TPAs (name and ip address)
- in the research plan/attachment the user can send files to TPAs
- The public api contains method for TPAs to download or upload a file
@PiTrem PiTrem marked this pull request as draft June 19, 2023 13:26
- the download and upload routes are moved from public_api.rb to third_party_apps_api.rb
- updated tests
- test that user is admin is now conducted analogous as in admin_api.rb
…e name is unique is now handled at the backend site
- Moreover, a counter for each token is cached. Any third party app is only allowed to upload 30 files.
- within the cache the token itself, a counter and the name of the third party app is stored+
- the upload and download to/from the ELN by the third party app is limited by the counter
…ThirdPartyAppNames

Merge remote-tracking branch 'local/Third-Party-Apps' into Third-Party-Apps
…ty apps. The third party app uses this ip address to make get and post request
Merge remote-tracking branch 'local/Third-Party-Apps' into Third-Party-Apps
@PiTrem
Copy link
Member

PiTrem commented May 8, 2024

moved to #1832

@PiTrem PiTrem closed this May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants