feat: 540 configurable dataverse list (#551)

* refactor(dataverse): update DataverseHub to use InstallationsParser

* feat(dataverse): add services for Dataverse installations

* refactor(dataverse): rename dataverse_hub to dataverse_installation_service

* test(dataverse): add fixture for partial installations response

* docs(configuration): update Dataverse Hub URL instructions

* chore: update .gitignore and remove obsolete files

Author: doprdele

.gitignore

@@ -43,3 +43,10 @@ application/vendor/bundle
 /data
 
 .DS_Store
+
+# Deployment
+application/DEPLOYMENT
+
+# Agents
+AGENTS.md
+

application/app/connectors/dataverse/handlers/landing.rb

@@ -15,8 +15,8 @@ def params_schema
 
     def show(request_params)
       begin
-        hub = ::Configuration.dataverse_hub
-        installations = hub.installations
+        installation_service = ::Configuration.dataverse_installation_service
+        installations = installation_service.installations
         page = request_params[:page] ? request_params[:page].to_i : 1
         installations_page = Page.new(installations, page, ::Configuration.default_pagination_items,
                                       query: request_params[:query], filter_by: :name)
@@ -37,4 +37,3 @@ def show(request_params)
     end
   end
 end
-

application/app/services/dataverse/dataverse_hub.rb

@@ -1,6 +1,8 @@
 module Dataverse
   class DataverseHub
     include LoggingCommon
+    include Dataverse::InstallationsParser
+
     DEFAULT_CACHE_EXPIRY = 24.hours.freeze
 
     def initialize(
@@ -34,25 +36,10 @@ def cache_expired?
       @last_fetched_at.nil? || Time.current - @last_fetched_at > @expires_in
     end
 
-    private
-
     def fetch_installations
       response = @http_client.get(@url)
       if response.success?
-        json = JSON.parse(response.body)
-        installations = json.map do |entry|
-          {
-            id: entry['dvHubId'],
-            name: entry['name'],
-            hostname: entry['hostname'],
-            active: entry.fetch('isActive', true),
-          }
-        end.compact
-
-        active, inactive = installations.partition { |item| item[:active] }
-
-        log_info('Completed loading Dataverse installations', {active: active.size, inactive: inactive.size})
-        active
+        parse_installations(response.body, source: @url)
       else
         log_error('Failed to fetch Dataverse Hub data', {url: @url, response: response.status}, nil)
         []

application/app/services/dataverse/dataverse_installation_file.rb

@@ -0,0 +1,42 @@
+module Dataverse
+  class DataverseInstallationFile
+    include LoggingCommon
+    include Dataverse::InstallationsParser
+
+    def initialize(path:, expires_in: Dataverse::DataverseHub::DEFAULT_CACHE_EXPIRY)
+      @path = path
+      @expires_in = expires_in
+      @installations = []
+      @last_loaded_at = nil
+    end
+
+    def installations
+      if cache_expired?
+        log_info('Loading Dataverse installations from file', { path: @path })
+        result = load_installations
+        if result.present?
+          @installations = result
+          @last_loaded_at = Time.current
+        end
+      end
+
+      @installations
+    end
+
+    private
+
+    def cache_expired?
+      @last_loaded_at.nil? || Time.current - @last_loaded_at > @expires_in
+    end
+
+    def load_installations
+      raise ArgumentError, 'Missing dataverse installations file path' if @path.blank?
+
+      payload = File.read(@path)
+      parse_installations(payload, source: @path)
+    rescue => e
+      log_error('Failed to read Dataverse Hub file data', { path: @path }, e)
+      []
+    end
+  end
+end

application/app/services/dataverse/dataverse_installation_service.rb

@@ -0,0 +1,31 @@
+module Dataverse
+  class DataverseInstallationService
+    SUPPORTED_SCHEMES = %w[http https file].freeze
+
+    def initialize(url:, http_client: Common::HttpClient.new, expires_in: Dataverse::DataverseHub::DEFAULT_CACHE_EXPIRY)
+      @url = url
+      @http_client = http_client
+      @expires_in = expires_in
+    end
+
+    def installations
+      provider.installations
+    end
+
+    private
+
+    def provider
+      @provider ||= begin
+        uri = URI.parse(@url)
+        scheme = uri.scheme&.downcase
+        raise ArgumentError, "Unsupported Dataverse installations URI: #{@url}" if scheme.present? && !SUPPORTED_SCHEMES.include?(scheme)
+
+        if scheme == 'file'
+          Dataverse::DataverseInstallationFile.new(path: uri.path, expires_in: @expires_in)
+        else
+          Dataverse::DataverseHub.new(url: @url, http_client: @http_client, expires_in: @expires_in)
+        end
+      end
+    end
+  end
+end

application/app/services/dataverse/installations_parser.rb

@@ -0,0 +1,21 @@
+module Dataverse
+  module InstallationsParser
+    private
+
+    def parse_installations(payload, source:)
+      json = JSON.parse(payload)
+      installations = json.map do |entry|
+        {
+          id: entry['dvHubId'],
+          name: entry['name'],
+          hostname: entry['hostname'],
+          active: entry.fetch('isActive', true),
+        }
+      end.compact
+
+      active, inactive = installations.partition { |item| item[:active] }
+      log_info('Completed loading Dataverse installations', {source: source, active: active.size, inactive: inactive.size})
+      active
+    end
+  end
+end

application/config/configuration_singleton.rb

@@ -81,10 +81,10 @@ def connector_config(connector_type)
     config.fetch(connector_type.to_sym, {})
   end
 
-  def dataverse_hub
-    @dataverse_hub ||= begin
-      LoggingCommon.log_info('[Configuration] Created Dataverse::DataverseHub', {dataverse_hub_url: dataverse_hub_url})
-      Dataverse::DataverseHub.new(url: dataverse_hub_url)
+  def dataverse_installation_service
+    @dataverse_installation_service ||= begin
+      LoggingCommon.log_info('[Configuration] Created Dataverse::DataverseInstallationService', {dataverse_hub_url: dataverse_hub_url})
+      Dataverse::DataverseInstallationService.new(url: dataverse_hub_url)
     end
   end
 

application/test/config/configuration_singleton_test.rb

@@ -205,13 +205,13 @@ def setup
     assert_same first_call, second_call
   end
 
-  test 'dataverse_hub memoizes and logs creation' do
-    hub = mock('hub')
-    Dataverse::DataverseHub.expects(:new).once.returns(hub)
+  test 'dataverse_installation_service memoizes and logs creation' do
+    service = mock('dataverse_installations_service')
+    Dataverse::DataverseInstallationService.expects(:new).once.returns(service)
 
     config = ConfigurationSingleton.new
-    assert_same hub, config.dataverse_hub
-    assert_same hub, config.dataverse_hub
+    assert_same service, config.dataverse_installation_service
+    assert_same service, config.dataverse_installation_service
   end
 
   test 'repo_db memoizes and logs creation' do

application/test/connectors/dataverse/handlers/landing_test.rb

@@ -16,7 +16,7 @@ def setup
       { id: 'dv-test-02', name: 'DV Test 02', hostname: 'https://dv-02.org' }
     ]
     hub = mock('hub'); hub.stubs(:installations).returns(dvs)
-    ::Configuration.stubs(:dataverse_hub).returns(hub)
+    ::Configuration.stubs(:dataverse_installation_service).returns(hub)
     res = @action.show({})
     assert res.success?
     assert_equal 2, res.locals[:installations_page].page_items.size
@@ -28,7 +28,7 @@ def setup
       { id: 'dv-test-02', name: 'Another DV', hostname: 'https://dv-02.org' }
     ]
     hub = mock('hub'); hub.stubs(:installations).returns(dvs)
-    ::Configuration.stubs(:dataverse_hub).returns(hub)
+    ::Configuration.stubs(:dataverse_installation_service).returns(hub)
     res = @action.show(query: 'Test 01')
     assert res.success?
     items = res.locals[:installations_page].page_items
@@ -37,7 +37,7 @@ def setup
   end
 
   test 'show returns error on service failure' do
-    ::Configuration.stubs(:dataverse_hub).raises(StandardError.new('boom'))
+    ::Configuration.stubs(:dataverse_installation_service).raises(StandardError.new('boom'))
     res = @action.show({})
     assert_not res.success?
     assert_equal I18n.t('dataverse.landing.index.dataverse_installations_service_error'), res.message[:alert]