feat: third party apps #1832

Konrad1991 · 2024-03-25T15:06:07Z

Code to enable communication between the ELN and TPAs

A dmin can register TPA in the ELN as { url, app_name }
Registered apps are available to users in Research Plan -> attachments
Generate a callback URL which with the TPA can GET the related attachment from the ELN and POST new attachments next to the original attachment
token authorization with cached counter limit

github-actions · 2024-04-15T10:25:06Z

app/api/api.rb

@@ -62,6 +62,7 @@ def authenticate!
    def is_public_request?
      request.path.start_with?(
        '/api/v1/public/',
+        '/api/v1/public_third_party_app/',


Metrics/BlockLength: Block has too many lines. [83/25]

app/api/chemotion/third_party_app_api.rb

github-actions · 2024-04-15T10:25:07Z

app/api/chemotion/third_party_app_api.rb

+        result = ThirdPartyApp.all_names
+        if result.nil?
+          { message: 'Name is unique' }
+        elsif ThirdPartyApp.all_names.exclude?(params[:name])


Lint/DuplicateBranch: Duplicate branch body detected.

github-actions · 2024-04-15T10:25:07Z

app/api/chemotion/third_party_app_api.rb

+
+      desc 'get public ip address of ELN'
+      get 'public_IP' do
+        uri = URI.parse(ENV['PUBLIC_URL'] || 'http://localhost:3000')


Lint/UselessAssignment: Useless assignment to variable - uri.

github-actions · 2024-04-15T10:25:07Z

app/api/chemotion/third_party_app_api.rb

+      get 'public_IP' do
+        uri = URI.parse(ENV['PUBLIC_URL'] || 'http://localhost:3000')
+      end
+


Layout/TrailingWhitespace: Trailing whitespace detected.

github-actions · 2024-04-15T10:25:07Z

spec/models/label_info_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe LabelInfo, type: :model do


RSpecRails/InferredSpecType: Remove redundant spec type.

github-actions · 2024-04-15T10:25:07Z

spec/models/third_party_app_spec.rb

+
+require 'rails_helper'
+
+RSpec.describe ThirdPartyApp, type: :model do


RSpecRails/InferredSpecType: Remove redundant spec type.

github-actions · 2024-04-15T10:25:07Z

spec/models/third_party_app_spec.rb

+  describe '.all_names' do
+    context 'when entries exist' do
+      before do
+        described_class.create(IPAddress: "http://test.com", name: "Test1")


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

github-actions · 2024-04-15T10:25:07Z

spec/models/third_party_app_spec.rb

+    context 'when entries exist' do
+      before do
+        described_class.create(IPAddress: "http://test.com", name: "Test1")
+        described_class.create(IPAddress: "http://test.com", name: "Test2")


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

github-actions · 2024-04-15T10:25:07Z

spec/models/third_party_app_spec.rb

+      end
+
+      it 'returns an array of names' do
+        expected_names = ['Test1', 'Test2']


Style/WordArray: Use %w or %W for an array of words.

app/api/chemotion/third_party_app_api.rb

github-actions · 2024-04-15T11:40:24Z

app/api/chemotion/ui_api.rb

@@ -29,6 +29,7 @@ class UiAPI < Grape::API
          has_converter: converter_config.present?,
          has_radar: radar_config.present?,
          collector_address: collector_address.presence,
+          third_party_apps: ThirdPartyApp.all


Style/TrailingCommaInHashLiteral: Put a comma after the last item of a multiline hash.

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 removed the namespaces in the grape api file third_party_apps.rb. Adapted the fetchers to the modifications Combined three migration files into one. - json web token is now created using the model class json_web_token - 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 - During creation of a new third party app entry the check whether the name is unique is now handled at the backend site - the token for the third party app is now cached - Moreover, a counter for each token is cached. Any third party app is only allowed to upload 30 files. squash dev commit + merge main Squashed commit of the following: commit 7346f79 Author: PiTrem <pierre.tremouilhac@kit.edu> Date: Mon Apr 15 12:17:28 2024 +0200 TPA-mix (#1873) commit a38559d Merge: 63a3ee2 faf6f62 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Tue Jan 2 09:58:12 2024 +0100 the public url is now passed as query parameters to the third party app Merge remote-tracking branch 'local/Third-Party-Apps' into Third-Party-Apps commit faf6f62 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Tue Jan 2 09:56:30 2024 +0100 the public url of the ELN is send now as query parameter to third party apps. The third party app uses this ip address to make get and post request commit 63a3ee2 Merge: 53b59de 2f37f8b Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Mon Oct 30 10:04:19 2023 +0100 Removed error which occured due to nil instead of an empty array for ThirdPartyAppNames Merge remote-tracking branch 'local/Third-Party-Apps' into Third-Party-Apps commit 2f37f8b Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Mon Oct 30 10:01:29 2023 +0100 removed bug of empty ThirdPartyApp array when no TPA's exists commit 53b59de Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Mon Oct 16 09:50:52 2023 +0200 enabled file-cache in development and production environment. commit ad49f4c Merge: db2a9ce f07eca3 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Mon Oct 16 09:42:55 2023 +0200 Merge remote-tracking branch 'local/Third-Party-Apps' into Third-Party-Apps commit f07eca3 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Mon Oct 16 09:42:18 2023 +0200 run ESLINT and removed errors for TPA stuff commit db2a9ce Merge: 4fe35ba 236f34a Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Wed Jul 19 09:45:26 2023 +0200 Merge remote-tracking branch 'local/Third-Party-Apps' into Third-Party-Apps commit 236f34a Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Wed Jul 19 09:44:00 2023 +0200 - The token which is generated for the third party app is now cached - 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 commit 4fe35ba Merge: 39d2824 73260b3 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Wed Jul 19 09:42:22 2023 +0200 Merge remote-tracking branch 'upstream/main' into Third-Party-Apps commit 39d2824 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Thu Jul 13 15:01:09 2023 +0200 - the token for the third party app is now cached - Moreover, a counter for each token is cached. Any third party app is only allowed to upload 30 files. commit ede8e53 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Fri Jul 7 12:00:23 2023 +0200 - During creation of a new third party app entry the check whether the name is unique is now handled at the backend site commit 80caa1a Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Fri Jul 7 10:54:33 2023 +0200 - json web token is now created using the model class json_web_token - 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 commit c6b3956 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Tue Jun 27 12:46:11 2023 +0200 Combined three migration files into one. commit f008d73 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Mon Jun 26 10:37:55 2023 +0200 removed the namespaces in the grape api file third_party_apps.rb. Adapted the fetchers to the modifications commit 091bb30 Author: Konrad1991 <konrad_kraemer@yahoo.de> Date: Mon Jun 19 14:01:43 2023 +0200 Communication with Third Party App 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

Internal: revamp TPA api - instantiate local file cache - UI: rm former TPA Btn internal: fix admin TPA edit - filename parameters optional on upload - handle api record not found / invalid

PiTrem marked this pull request as draft March 25, 2024 15:06

PiTrem changed the title ~~Third party apps~~ feat: third party apps Mar 25, 2024

PiTrem force-pushed the Third-Party-Apps branch from 7346f79 to 06b75d2 Compare April 15, 2024 10:23

github-actions bot reviewed Apr 15, 2024

View reviewed changes

Konrad1991 force-pushed the Third-Party-Apps branch from c791ac3 to 6cc4cfc Compare April 15, 2024 10:34

github-actions bot reviewed Apr 15, 2024

View reviewed changes

app/api/chemotion/third_party_app_api.rb Show resolved Hide resolved

PiTrem force-pushed the Third-Party-Apps branch from 4e4f66a to aac906c Compare April 15, 2024 11:39

github-actions bot reviewed Apr 15, 2024

View reviewed changes

PiTrem added this to the v2.0.0 milestone Apr 16, 2024

PiTrem force-pushed the Third-Party-Apps branch from 4b801bc to 934dbd2 Compare April 29, 2024 06:16

PiTrem mentioned this pull request May 8, 2024

Communication between Third Party Apps and the ELN #1353

Closed

3 tasks

Konrad1991 and others added 2 commits June 11, 2024 14:26

intern: rename ipadress to url

fcfe760

Internal: revamp TPA api - instantiate local file cache - UI: rm former TPA Btn internal: fix admin TPA edit - filename parameters optional on upload - handle api record not found / invalid

PiTrem force-pushed the Third-Party-Apps branch from 934dbd2 to fcfe760 Compare June 11, 2024 12:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: third party apps #1832

feat: third party apps #1832

Konrad1991 commented Mar 25, 2024 •

edited by PiTrem

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

github-actions bot Apr 15, 2024

		@@ -0,0 +1,5 @@
		require 'rails_helper'

		RSpec.describe LabelInfo, type: :model do


		require 'rails_helper'

		RSpec.describe ThirdPartyApp, type: :model do

feat: third party apps #1832

Are you sure you want to change the base?

feat: third party apps #1832

Conversation

Konrad1991 commented Mar 25, 2024 • edited by PiTrem

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

github-actions bot Apr 15, 2024

Choose a reason for hiding this comment

Konrad1991 commented Mar 25, 2024 •

edited by PiTrem