#3004

- added organisation download - generalised download code - refactored code
AtlasOfLivingAustralia · Nov 14, 2023 · 72825ae · 72825ae
1 parent efb516d
commit 72825ae
Show file tree

Hide file tree

Showing 13 changed files with 199 additions and 119 deletions.
diff --git a/...ssets/javascripts/managementUnitReport.js → ...ls-app/assets/javascripts/entityReport.js b/...ssets/javascripts/managementUnitReport.js → ...ls-app/assets/javascripts/entityReport.js
@@ -1,4 +1,4 @@
-function ManagementUnitReportSelectorViewModel(options) {
+function EntityReportSelectorViewModel(options) {
     var self = this;
     var config = _.defaults(options);
 
@@ -8,20 +8,20 @@ function ManagementUnitReportSelectorViewModel(options) {
     self.fromDate = ko.observable(d).extend({simpleDate:false});
     self.toDate = ko.observable(now).extend({simpleDate:false});
 
-    self.muReportDownload = function () {
+    self.entityReportDownload = function () {
         var summaryFlag = false;
-        return generateMuReport(summaryFlag)
+        return generateEntityReport(summaryFlag)
     };
 
-    self.muReportDownloadSummary = function() {
+    self.entityReportDownloadSummary = function() {
         var summaryFlag = true;
-        generateMuReport(summaryFlag);
+        generateEntityReport(summaryFlag);
     };
 
-    function generateMuReport(summaryFlag) {
+    function generateEntityReport(summaryFlag) {
         var json = {fromDate:self.fromDate(), toDate:self.toDate(), summaryFlag: summaryFlag}
         return $.ajax({
-            url: config.generateMUReportInPeriodUrl,
+            url: config.generateEntityReportInPeriodUrl,
             type: 'GET',
             data: json,
             dataType:'json',
@@ -33,7 +33,7 @@ function ManagementUnitReportSelectorViewModel(options) {
                 var details = data['details']
                 var message = data['message']
                 var detailsIcon = ' <i class="fa fa-info-circle showDownloadDetailsIcon" data-toggle="collapse" href="#downloadDetails"></i>'
-                var detailsPanel = '<div class="collapse" id="downloadDetails"><a id="muReportDownloadLink" href='+config.generateMUReportInPeriodUrl +'/' + details+'>Try this link, if you cannot get an email confirmation</a></div>'
+                var detailsPanel = '<div class="collapse" id="downloadDetails"><a id="entityReportDownloadLink" href='+config.downloadUrl +'/' + details+'>Try this link, if you cannot get an email confirmation</a></div>'
                 bootbox.alert(message + detailsIcon + detailsPanel)
             }
         }).fail(function() {

diff --git a/grails-app/controllers/au/org/ala/merit/ManagementUnitController.groovy b/grails-app/controllers/au/org/ala/merit/ManagementUnitController.groovy
@@ -9,8 +9,6 @@ import grails.converters.JSON
 import grails.core.GrailsApplication
 import grails.web.mapping.LinkGenerator
 import org.apache.http.HttpStatus
-import java.text.ParseException
-
 /**
  * Processes requests relating to MUs
  */
@@ -352,39 +350,6 @@ class ManagementUnitController {
         render featureCollection as JSON
     }
 
-    @PreAuthorise(accessLevel='siteReadOnly')
-    def generateReportsInPeriod(){
-
-        String startDate = params.fromDate
-        String endDate = params.toDate
-
-        try{
-
-            def user = userService.getUser()
-            def extras =[:]
-            extras.summaryFlag = params.summaryFlag
-
-            String email = user.userName
-            extras.put("systemEmail", grailsApplication.config.getProperty('fieldcapture.system.email.address'))
-            extras.put("senderEmail", grailsApplication.config.getProperty('fieldcapture.system.email.address'))
-            extras.put("email", email)
-
-            String reportDownloadBaseUrl= grailsLinkGenerator.link(controller:'download',action:'get', absolute: true)
-            extras.put("reportDownloadBaseUrl", reportDownloadBaseUrl)
-
-            def resp = managementUnitService.generateReports(startDate, endDate,extras)
-            render resp as JSON
-
-        }catch (ParseException e){
-            def message = [message: 'Error: You need to provide startDate and endDate in the format of yyyy-MM-dd ']
-            response.setContentType("application/json")
-            render message as JSON
-        }catch(Exception e){
-            def message = [message: 'Fatal: '+ e.message]
-            render message as JSON
-        }
-    }
-
     /**
      * Star or unstar a management unit for a user
      * Action is determined by the URI endpoint, either: /add | /remove

diff --git a/grails-app/controllers/au/org/ala/merit/ReportController.groovy b/grails-app/controllers/au/org/ala/merit/ReportController.groovy
@@ -1,17 +1,16 @@
 package au.org.ala.merit
 
-import au.ala.org.ws.security.RequireApiKey
-import au.org.ala.merit.command.MeriPlanReportCommand
-import au.org.ala.merit.command.ProjectSummaryReportCommand
+
 import au.org.ala.merit.command.Reef2050PlanActionReportCommand
 import au.org.ala.merit.command.Reef2050PlanActionReportSummaryCommand
 import grails.converters.JSON
-import org.apache.http.HttpStatus
 import org.joda.time.DateTime
 import org.joda.time.Interval
 import org.joda.time.Period
 
-import static au.org.ala.merit.DashboardTagLib.*
+import java.text.ParseException
+
+import static au.org.ala.merit.DashboardTagLib.estimateHeight
 
 class ReportController {
 
@@ -518,4 +517,39 @@ class ReportController {
         render view: '/report/_reportingHistory', model: [reportingHistory: reportingHistory]
     }
 
+    @PreAuthorise(accessLevel='siteReadOnly')
+    def generateReportsInPeriod(){
+
+        String startDate = params.fromDate
+        String endDate = params.toDate
+
+        try{
+
+            def user = userService.getUser()
+            def extras =[:]
+            extras.summaryFlag = params.summaryFlag
+
+            String email = user.userName
+            extras.put("hubId", SettingService.hubConfig?.hubId)
+            extras.put("entity", params.entity)
+            extras.put("systemEmail", grailsApplication.config.getProperty('fieldcapture.system.email.address'))
+            extras.put("senderEmail", grailsApplication.config.getProperty('fieldcapture.system.email.address'))
+            extras.put("email", email)
+
+            String reportDownloadBaseUrl= grailsLinkGenerator.link(controller:'download',action:'get', absolute: true)
+            extras.put("reportDownloadBaseUrl", reportDownloadBaseUrl)
+
+            def resp = reportService.generateReports(startDate, endDate,extras)
+            render resp as JSON
+
+        }catch (ParseException e){
+            def message = [message: 'Error: You need to provide startDate and endDate in the format of yyyy-MM-dd ']
+            response.setContentType("application/json")
+            render message as JSON
+        }catch(Exception e){
+            def message = [message: 'Fatal: '+ e.message]
+            render message as JSON
+        }
+    }
+
 }
diff --git a/grails-app/services/au/org/ala/merit/ManagementUnitService.groovy b/grails-app/services/au/org/ala/merit/ManagementUnitService.groovy
@@ -8,7 +8,6 @@ import grails.core.GrailsApplication
 import grails.plugin.cache.Cacheable
 import groovy.util.logging.Slf4j
 import org.grails.web.json.JSONArray
-import org.joda.time.DateTimeZone
 
 @Slf4j
 class ManagementUnitService {
@@ -263,24 +262,4 @@ class ManagementUnitService {
         String url = "${grailsApplication.config.getProperty('ecodata.baseUrl')}" + "managementunit/"+id+"/report"
         webService.getJson(url)
     }
-    /**
-     * Download [all] management unit reports in a given period
-     * @param startDate
-     * @param endDate
-     * @param emails for sending email to user
-     * @return
-     */
-    def generateReports(String startDate, String endDate, Map extras = null){
-
-        // The end date is the last day of the period (e.g. 2020-06-30) but reports will end at midnight of the next day (e.g. 2020-07-01T00:00:00)
-        // so add a day or two to achieve this.
-
-        String isoStartDate = DateUtils.format(DateUtils.parse(startDate).plusDays(1).withZone(DateTimeZone.UTC))
-        String isoEndDate = DateUtils.format(DateUtils.parse(endDate).plusDays(1).withZone(DateTimeZone.UTC))
-
-        String url = "${grailsApplication.config.getProperty('ecodata.baseUrl')}" + "managementunit/generateReportsInPeriod?startDate=${isoStartDate}&endDate=${isoEndDate}"
-        url += '&' + extras.collect { k,v -> "$k=$v" }.join('&')
-        def resp = webService.getJson(url)
-        return resp
-    }
 }
diff --git a/grails-app/services/au/org/ala/merit/ReportService.groovy b/grails-app/services/au/org/ala/merit/ReportService.groovy
@@ -9,6 +9,7 @@ import grails.plugin.cache.Cacheable
 import groovy.util.logging.Slf4j
 import org.apache.commons.io.FilenameUtils
 import org.joda.time.DateTime
+import org.joda.time.DateTimeZone
 import org.joda.time.Period
 
 @Slf4j
@@ -981,4 +982,25 @@ class ReportService {
         history
     }
 
+    /**
+     * Download [all] management unit reports in a given period
+     * @param startDate
+     * @param endDate
+     * @param emails for sending email to user
+     * @return
+     */
+    def generateReports(String startDate, String endDate, Map extras = null){
+
+        // The end date is the last day of the period (e.g. 2020-06-30) but reports will end at midnight of the next day (e.g. 2020-07-01T00:00:00)
+        // so add a day or two to achieve this.
+
+        String isoStartDate = DateUtils.format(DateUtils.parse(startDate).plusDays(1).withZone(DateTimeZone.UTC))
+        String isoEndDate = DateUtils.format(DateUtils.parse(endDate).plusDays(1).withZone(DateTimeZone.UTC))
+
+        String url = "${grailsApplication.config.getProperty('ecodata.baseUrl')}" + "report/generateReportsInPeriod?startDate=${isoStartDate}&endDate=${isoEndDate}"
+        url += '&' + extras.collect { k,v -> "$k=$v" }.join('&')
+        def resp = webService.getJson(url)
+        return resp
+    }
+
 }
diff --git a/grails-app/views/admin/adminReports.gsp b/grails-app/views/admin/adminReports.gsp
@@ -31,18 +31,39 @@
         <div class="col-sm-2 pl-0 pr-1">
             <label for="fromDate">Start date</label>
             <div class="input-group input-append">
-                <fc:datePicker targetField="fromDate.date" bs4="bs4" class="form-control form-control-sm dateControl" name="fromDate"  data-validation-engine="validate[date]"  size="form-control form-control-sm dateControl"/>
+                <fc:datePicker targetField="fromDate.date" bs4="bs4" class="form-control form-control-sm dateControl" name="muFromDate"  data-validation-engine="validate[date]"  size="form-control form-control-sm dateControl"/>
             </div>
         </div>
         <div class="col-sm-2 pl-0 pr-1">
             <label for="toDate">End date</label>
             <div class="input-group input-append">
-                <fc:datePicker targetField="toDate.date" bs4="bs4" class="form-control form-control-sm dateControl" name="toDate" data-validation-engine="validate[date]"  size="form-control form-control-sm dateControl"/>
+                <fc:datePicker targetField="toDate.date" bs4="bs4" class="form-control form-control-sm dateControl" name="muToDate" data-validation-engine="validate[date]"  size="form-control form-control-sm dateControl"/>
             </div>
         </div>
     </div>
-    <a id="muReportDownload" data-bind="click:muReportDownload" class="btn btn-sm" href="#">Management Unit - Activities</a>
-    <a id="muReportDownloadSummary" data-bind="click:muReportDownloadSummary" class="btn btn-sm" href="#">Core Reports - Status</a>
+    <a id="muReportDownload" data-bind="click:entityReportDownload" class="btn btn-sm" href="#">Management Unit - Activities</a>
+    <a id="muReportDownloadSummary" data-bind="click:entityReportDownloadSummary" class="btn btn-sm" href="#">Core Reports - Status</a>
+</form>
+
+<h4>Organisation report download:</h4>
+<form id="org-report-selector">
+    <label class="control-label">Select reporting period: </label>
+    <div class="row mb-2">
+        <div class="col-sm-2 pl-0 pr-1">
+            <label for="orgFromDate">Start date</label>
+            <div class="input-group input-append">
+                <fc:datePicker targetField="fromDate.date" bs4="bs4" class="form-control form-control-sm dateControl" name="orgFromDate"  data-validation-engine="validate[date]"  size="form-control form-control-sm dateControl"/>
+            </div>
+        </div>
+        <div class="col-sm-2 pl-0 pr-1">
+            <label for="orgToDate">End date</label>
+            <div class="input-group input-append">
+                <fc:datePicker targetField="toDate.date" bs4="bs4" class="form-control form-control-sm dateControl" name="orgToDate" data-validation-engine="validate[date]"  size="form-control form-control-sm dateControl"/>
+            </div>
+        </div>
+    </div>
+    <a id="orgReportDownload" data-bind="click:entityReportDownload" class="btn btn-sm" href="#">Organisation - Activities</a>
+    <a id="orgReportDownloadSummary" data-bind="click:entityReportDownloadSummary" class="btn btn-sm" href="#">Core Reports - Status</a>
 </form>
 
 
@@ -92,7 +113,7 @@
 
 <asset:javascript src="common-bs4.js"/>
 <asset:javascript src="reef2050Report.js"/>
-<asset:javascript src="managementUnitReport.js"/>
+<asset:javascript src="entityReport.js"/>
 <script>
     $(function () {
         var SELECTED_REPORT_KEY = 'selectedAdminReport';
@@ -143,11 +164,18 @@
 
     });
 
-    var generateMUReportInPeriodUrl = "${g.createLink(controller:'managementUnit', action:'generateReportsInPeriod')}";
+    var generateMUReportInPeriodUrl = "${g.createLink(controller:'report', action:'generateReportsInPeriod', params: [entity: 'managementUnit'])}";
     var optionsReport = {
-        generateMUReportInPeriodUrl: generateMUReportInPeriodUrl
+        generateEntityReportInPeriodUrl: generateMUReportInPeriodUrl,
+        downloadUrl: "${g.createLink(controller:"download",action:"get")}"
+    };
+    ko.applyBindings(new EntityReportSelectorViewModel(optionsReport), document.getElementById('mu-report-selector'));
+
+    var optionsOrgReport = {
+        generateEntityReportInPeriodUrl: "${g.createLink(controller:'report', action:'generateReportsInPeriod', params: [entity: 'organisation'])}",
+        downloadUrl: "${g.createLink(controller:"download",action:"get")}"
     };
-    ko.applyBindings(new ManagementUnitReportSelectorViewModel(optionsReport), document.getElementById('mu-report-selector'));
+    ko.applyBindings(new EntityReportSelectorViewModel(optionsOrgReport), document.getElementById('org-report-selector'));
 
 
 </script>

diff --git a/src/integration-test/groovy/au/org/ala/fieldcapture/AdminSpec.groovy b/src/integration-test/groovy/au/org/ala/fieldcapture/AdminSpec.groovy
@@ -109,6 +109,28 @@ class AdminSpec extends StubbedCasSpec {
             messages[0].getSubject() == "Your download is ready"
         }
 
+        when:"I clicked the Organisation Activities Report button"
+        downloadOrgReport(fromDate, toDate)
+        okBootbox()
+
+        then:
+        waitFor 20, {
+            MimeMessage[] messages = greenMail.getReceivedMessages()
+            messages?.length == 1
+            messages[0].getSubject() == "Your download is ready"
+        }
+
+        when:"I clicked the Organisation Report Status button"
+        downloadOrgReportSummary(fromDate, toDate)
+        okBootbox()
+
+        then:
+        waitFor 20, {
+            MimeMessage[] messages = greenMail.getReceivedMessages()
+            messages?.length == 2
+            messages[0].getSubject() == "Your download is ready"
+        }
+
     }
 
 

diff --git a/src/integration-test/groovy/pages/AdminReportsPage.groovy b/src/integration-test/groovy/pages/AdminReportsPage.groovy
@@ -12,10 +12,14 @@ class AdminReportsPage extends Page {
         period {$('select#reportPeriodOfManagementUnit',0)}
         downloadReportBtn(required:false) {$('a#muReportDownload')}
         downloadReportSummaryBtn(required:false) {$('a#muReportDownloadSummary')}
+        orgDownloadReportBtn(required:false) {$('a#muReportDownload')}
+        orgDownloadReportSummaryBtn(required:false) {$('a#muReportDownloadSummary')}
         showDownloadDetailsIcon(required:false) { $('i.showDownloadDetailsIcon')}
-        muReportDownloadLink(required:false) {$('a#muReportDownloadLink')}
-        startDate{$("#fromDate")}
-        endDate{$("#toDate")}
+        muReportDownloadLink(required:false) {$('a#entityReportDownloadLink')}
+        startDate{$("#muFromDate")}
+        endDate{$("#muToDate")}
+        orgStartDate{$("#orgFromDate")}
+        orgEndDate{$("#orgToDate")}
         reportFormats { $('#reportFormats')}
         viewReportBtn(required:false) {$('#viewReportBtn')}
 
@@ -37,6 +41,18 @@ class AdminReportsPage extends Page {
         downloadReportSummaryBtn.click()
     }
 
+    def downloadOrgReport(String fromDate, String toDate) {
+        orgStartDate = fromDate
+        orgEndDate = toDate
+        orgDownloadReportBtn.click()
+    }
+
+    def downloadOrgReportSummary(String fromDate, String toDate) {
+        orgStartDate = fromDate
+        orgEndDate = toDate
+        orgDownloadReportSummaryBtn.click()
+    }
+
     def generateReef2050Pdf() {
         reportFormats = "pdf"
         viewReportBtn.click()

diff --git a/src/test/groovy/au/org/ala/merit/ManagementUnitControllerSpec.groovy b/src/test/groovy/au/org/ala/merit/ManagementUnitControllerSpec.groovy
@@ -1,11 +1,10 @@
 package au.org.ala.merit
 
 import au.org.ala.merit.command.SaveReportDataCommand
-import au.org.ala.merit.hub.HubSettings
 import au.org.ala.merit.util.ProjectGroupingHelper
+import grails.testing.web.controllers.ControllerUnitTest
 import org.apache.http.HttpStatus
 import spock.lang.Specification
-import grails.testing.web.controllers.ControllerUnitTest
 
 class ManagementUnitControllerSpec extends Specification implements ControllerUnitTest<ManagementUnitController>{
 
@@ -444,22 +443,6 @@ class ManagementUnitControllerSpec extends Specification implements ControllerUn
         return program
     }
 
-    def "The controller delegates to the managementUnitService to produce reports"() {
-        setup:
-        String fromDate = '01-07-2020'
-        String toDate = '31-12-2020'
-
-        when:
-        params.fromDate = fromDate
-        params.toDate = toDate
-        controller.generateReportsInPeriod()
-
-        then:
-        1 * userService.getUser() >> [userName:'[email protected]']
-        1 * managementUnitService.generateReports(fromDate, toDate, _) >> [status:HttpStatus.SC_OK]
-        response.json == [status:HttpStatus.SC_OK]
-    }
-
     def "User adds star to the management unit "() {
         setup:
         String managementUnitId = 'p1'