Attributions (#2591)

* rebumped * Adding REST endpoit for getting user attributions * fixed test and updated doc * sorting by last updated * getting max via post instead of url * added changelog * TreeMap throws NPE when calling containsKey Co-authored-by: Nathan Dunn <ndunn@me.com> Co-authored-by: Nathan Dunn <nathandunn@lbl.gov>
GMOD · Mar 12, 2021 · 956b78f · 956b78f
1 parent c4b53ef
commit 956b78f
Show file tree

Hide file tree

Showing 5 changed files with 1,476 additions and 1,347 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,12 +1,16 @@
 
 
-## 2.6.4
+## 2.6.4 
 
+Features
+
+- Added getAttributions method [2591](https://github.com/GMOD/Apollo/pull/2591) via @mbc32.
 
 Infrastructure Changes
 
 - Upgrade to [JBrowse 1.16.11](https://github.com/GMOD/jbrowse/releases/tag/1.16.11-release)
 
+
 ## 2.6.3
 
 Features

diff --git a/grails-app/controllers/org/bbop/apollo/AnnotationEditorController.groovy b/grails-app/controllers/org/bbop/apollo/AnnotationEditorController.groovy
@@ -1246,6 +1246,25 @@ class AnnotationEditorController extends AbstractApolloController implements Ann
         }
     }
 
+    @RestApiMethod(description = "Gets edits made by the annotator, Returns JSON hash user:[edit_type]", path = "/annotationEditor/getAttributions", verb = RestApiVerb.POST)
+    @RestApiParams(params = [
+            @RestApiParam(name = "username", type = "email", paramType = RestApiParamType.QUERY)
+            , @RestApiParam(name = "password", type = "password", paramType = RestApiParamType.QUERY)
+            , @RestApiParam(name = "max", type = "integer", paramType = RestApiParamType.QUERY,description ="(optional) Max number of attributions to return (default 1000)")
+    ])
+    def getAttributions() {
+        JSONObject inputObject = permissionService.handleInput(request, params)
+        if (!permissionService.hasPermissions(inputObject, PermissionEnum.EXPORT)) {
+            render status: HttpStatus.UNAUTHORIZED
+            return
+        }
+        int max = inputObject.max ?: 1000
+        JSONObject attributions =  featureEventService.generateAttributions( max )
+        render attributions
+    }
+
+
+
 
     @MessageMapping("/AnnotationNotification")
     @SendTo("/topic/AnnotationNotification")

diff --git a/grails-app/services/org/bbop/apollo/FeatureEventService.groovy b/grails-app/services/org/bbop/apollo/FeatureEventService.groovy
@@ -7,6 +7,7 @@ import org.bbop.apollo.gwt.shared.FeatureStringEnum
 import org.bbop.apollo.history.FeatureOperation
 import org.codehaus.groovy.grails.web.json.JSONArray
 import org.codehaus.groovy.grails.web.json.JSONObject
+import groovy.json.JsonBuilder
 import org.grails.plugins.metrics.groovy.Timed
 
 import java.text.DateFormat
@@ -893,4 +894,29 @@ class FeatureEventService {
         }
         return historyContainer
     }
+
+    /**
+     * Create Annotator (user) attributions by getting all Feature Events
+     * @param None
+     * @return json of all edits by user
+     */
+    JSONObject generateAttributions(int max = 1000) {
+        List<FeatureEvent> featureEvents = FeatureEvent.listOrderByLastUpdated([order: 'desc', max:max])
+        log.debug("Generating attrubtions: "+ featureEvents.size())
+        def attributions = new HashMap<String,List<FeatureOperation>>()
+        featureEvents.each {
+            log.debug("Generating operation: "+ it.operation)
+            if(attributions.containsKey(it.getEditor()?.username)){
+                List<FeatureOperation> operations = attributions.get(it.getEditor()?.username) as List<FeatureOperation>
+                operations.add(it.operation)
+                attributions.put(it.getEditor()?.username, operations)
+            }else {
+                List<FeatureOperation> operations = []
+                operations.add(it.operation)
+                attributions.put(it.getEditor()?.username, operations)
+            }
+        }
+
+        return new JSONObject(attributions)
+    }
 }
diff --git a/test/unit/org/bbop/apollo/FeatureEventServiceSpec.groovy b/test/unit/org/bbop/apollo/FeatureEventServiceSpec.groovy
@@ -3,6 +3,7 @@ package org.bbop.apollo
 import grails.test.mixin.Mock
 import grails.test.mixin.TestFor
 import org.bbop.apollo.history.FeatureOperation
+import groovy.json.JsonBuilder
 import org.codehaus.groovy.grails.web.json.JSONArray
 import org.codehaus.groovy.grails.web.json.JSONObject
 import spock.lang.Ignore
@@ -12,7 +13,7 @@ import spock.lang.Specification
  * See the API for {@link grails.test.mixin.services.ServiceUnitTestMixin} for usage instructions
  */
 @TestFor(FeatureEventService)
-@Mock([FeatureEvent])
+@Mock([FeatureEvent,User])
 class FeatureEventServiceSpec extends Specification {
 
     Date today = new Date()
@@ -1198,4 +1199,19 @@ class FeatureEventServiceSpec extends Specification {
 
     }
 
+void "test generateAttributions"(){
+        given:
+        User editor = new User(username:"someRandomUser",passwordHash: "supersecret",firstName: "User",lastName: "Editor").save()
+        new FeatureEvent(operation: FeatureOperation.ADD_FEATURE, editor: editor, name: "Gene123", uniqueName: "someUniqueName", dateCreated: today - 7, current: true).save(failOnError: true,flush: true)
+
+        when:
+        def attributions = service.generateAttributions()
+
+        then:
+        assert attributions.containsKey("someRandomUser")
+        def attributionArray = attributions.get("someRandomUser")
+        assert attributionArray.size()==1
+        def attributionsObject = attributionArray[0]
+        assert attributionsObject == FeatureOperation.ADD_FEATURE
+    }
 }