gh-401 Create endpoint to return single ProfileProviderService

- Also give profile providers index optional parameter to only return latest versions - Add tests to verify new endpoint
MauroDataMapper · Mar 13, 2023 · 65046bc · 65046bc
1 parent f41d64f
commit 65046bc
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 2 deletions.
diff --git a/.../grails-app/controllers/uk/ac/ox/softeng/maurodatamapper/profile/ProfileController.groovy b/.../grails-app/controllers/uk/ac/ox/softeng/maurodatamapper/profile/ProfileController.groovy
@@ -49,7 +49,17 @@ class ProfileController implements ResourcelessMdmController, DataBinder {
 
 
     def profileProviders() {
-        respond profileProviderServices: profileService.getAllProfileProviderServices(false)
+        respond profileProviderServices: profileService.getAllProfileProviderServices(params.boolean('latestVersionByMetadataNamespace', false))
+    }
+
+    def profileProvider() {
+        List<ProfileProviderService> allProviders = profileService.getAllProfileProviderServices(false)
+        ProfileProviderService profileProviderService = profileService.findProfileProviderService(allProviders, params.profileNamespace, params.profileName, params.profileVersion)
+        if (!profileProviderService) {
+            return notFound(ProfileProviderService, getProfileProviderServiceId(params))
+        }
+
+        respond profileProviderService: profileProviderService
     }
 
     def dynamicProfileProviders() {

diff --git a/...grails-app/controllers/uk/ac/ox/softeng/maurodatamapper/profile/ProfileInterceptor.groovy b/...grails-app/controllers/uk/ac/ox/softeng/maurodatamapper/profile/ProfileInterceptor.groovy
@@ -37,7 +37,7 @@ class ProfileInterceptor extends FacetInterceptor {
 
     boolean before() {
         // Public or secured at controller as using listAll
-        if (actionName in ['profileProviders', 'dynamicProfileProviders', 'listModelsInProfile', 'listValuesInProfile', 'emptyProfile']) return true
+        if (actionName in ['profileProviders', 'profileProvider', 'dynamicProfileProviders', 'listModelsInProfile', 'listValuesInProfile', 'emptyProfile']) return true
         if (!params.containsKey('multiFacetAwareItemDomainType') && actionName == 'search') return true
         facetResourceChecks()
         checkActionAllowedOnFacet()

diff --git a/...rofile/grails-app/controllers/uk/ac/ox/softeng/maurodatamapper/profile/UrlMappings.groovy b/...rofile/grails-app/controllers/uk/ac/ox/softeng/maurodatamapper/profile/UrlMappings.groovy
@@ -25,6 +25,7 @@ class UrlMappings {
             group '/profiles', {
                 get '/providers'(controller: 'profile', action: 'profileProviders')
                 get '/providers/dynamic'(controller: 'profile', action: 'dynamicProfileProviders')
+                get "/providers/$profileNamespace/$profileName/$profileVersion?"(controller: 'profile', action: 'profileProvider')
 
                 group "/$profileNamespace/$profileName", {
 

diff --git a/mdm-plugin-profile/grails-app/views/profile/profileProvider.gson b/mdm-plugin-profile/grails-app/views/profile/profileProvider.gson
@@ -0,0 +1,7 @@
+import uk.ac.ox.softeng.maurodatamapper.profile.provider.ProfileProviderService
+
+model {
+    ProfileProviderService profileProviderService
+}
+
+json tmpl.'/profileProviderService/profileProviderService'(profileProviderService)
diff --git a/...gration-test/groovy/uk/ac/ox/softeng/maurodatamapper/profile/ProfileFunctionalSpec.groovy b/...gration-test/groovy/uk/ac/ox/softeng/maurodatamapper/profile/ProfileFunctionalSpec.groovy
@@ -200,6 +200,32 @@ class ProfileFunctionalSpec extends BaseFunctionalSpec {
   }]'''
     }
 
+    void '01.1 : test getting single profile provider'() {
+        when:
+        GET('profiles/providers/uk.ac.ox.softeng.maurodatamapper.profile/ProfileSpecificationProfileService', STRING_ARG)
+
+        then:
+        verifyJsonResponse OK, '''
+{
+    "name": "ProfileSpecificationProfileService",
+    "version": "${json-unit.matches:version}",
+    "displayName": "Profile Specification Profile (Data Model)",
+    "namespace": "uk.ac.ox.softeng.maurodatamapper.profile",
+    "allowsExtraMetadataKeys": false,
+    "knownMetadataKeys": [
+      "metadataNamespace",
+      "domainsApplicable",
+      "editableAfterFinalisation"
+    ],
+    "providerType": "Profile",
+    "metadataNamespace": "uk.ac.ox.softeng.maurodatamapper.profile",
+    "domains": [
+      "DataModel"
+    ],
+    "editableAfterFinalisation": false
+}'''
+    }
+
     void '02 : test get all models in profile which doesnt exist'() {
         when:
         GET("profiles/${getProfilePath()}/DataModel")