@defra-fish/sales-api-service 1.62.0-rc.0 → 1.62.0-rc.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.62.0-rc.0",
+  "version": "1.62.0-rc.2",
   "description": "Rod Licensing Sales API",
   "type": "module",
   "engines": {
@@ -35,9 +35,9 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.62.0-rc.0",
-    "@defra-fish/connectors-lib": "1.62.0-rc.0",
-    "@defra-fish/dynamics-lib": "1.62.0-rc.0",
+    "@defra-fish/business-rules-lib": "1.62.0-rc.2",
+    "@defra-fish/connectors-lib": "1.62.0-rc.2",
+    "@defra-fish/dynamics-lib": "1.62.0-rc.2",
     "@hapi/boom": "^9.1.2",
     "@hapi/hapi": "^20.1.3",
     "@hapi/inert": "^6.0.3",
@@ -52,5 +52,5 @@
     "moment-timezone": "^0.5.34",
     "uuid": "^8.3.2"
   },
-  "gitHead": "d56e1a0d0f4b22f1dded800c0ed511b737cb91a7"
+  "gitHead": "6a3a2c6a81067424144382557214c49c27559cdf"
 }

package/src/schema/__tests__/recurring-payments.schema.spec.js

@@ -1,7 +1,8 @@
 import {
   dueRecurringPaymentsRequestParamsSchema,
   dueRecurringPaymentsResponseSchema,
-  processRPResultRequestParamsSchema
+  processRPResultRequestParamsSchema,
+  cancelRecurringPaymentRequestParamsSchema
 } from '../recurring-payments.schema.js'
 
 jest.mock('../validators/validators.js', () => ({
@@ -149,3 +150,19 @@ describe('processRPResultRequestParamsSchema', () => {
     expect(() => processRPResultRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
   })
 })
+
+describe('cancelRecurringPaymentRequestParamsSchema', () => {
+  it('validates expected object', async () => {
+    const sampleData = { id: 'abc123' }
+    expect(() => cancelRecurringPaymentRequestParamsSchema.validateAsync(sampleData)).not.toThrow()
+  })
+
+  it('throws an error if id missing', async () => {
+    expect(() => cancelRecurringPaymentRequestParamsSchema.validateAsync({}).rejects.toThrow())
+  })
+
+  it('throws an error if id is not the correct type', async () => {
+    const sampleData = { id: 99 }
+    expect(() => cancelRecurringPaymentRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
+  })
+})

package/src/schema/recurring-payments.schema.js

@@ -29,3 +29,7 @@ export const processRPResultRequestParamsSchema = Joi.object({
   paymentId: Joi.string().required(),
   createdDate: Joi.string().isoDate().required()
 })
+
+export const cancelRecurringPaymentRequestParamsSchema = Joi.object({
+  id: Joi.string().required()
+})

package/src/server/routes/__tests__/recurring-payments.spec.js

@@ -1,6 +1,10 @@
 import recurringPayments from '../recurring-payments.js'
-import { getRecurringPayments, processRPResult } from '../../../services/recurring-payments.service.js'
-import { dueRecurringPaymentsRequestParamsSchema, processRPResultRequestParamsSchema } from '../../../schema/recurring-payments.schema.js'
+import { getRecurringPayments, processRPResult, cancelRecurringPayment } from '../../../services/recurring-payments.service.js'
+import {
+  dueRecurringPaymentsRequestParamsSchema,
+  processRPResultRequestParamsSchema,
+  cancelRecurringPaymentRequestParamsSchema
+} from '../../../schema/recurring-payments.schema.js'
 
 const [
   {
@@ -8,17 +12,22 @@ const [
   },
   {
     options: { handler: prpHandler }
+  },
+  {
+    options: { handler: crpHandler }
   }
 ] = recurringPayments
 
 jest.mock('../../../services/recurring-payments.service.js', () => ({
   getRecurringPayments: jest.fn(),
-  processRPResult: jest.fn()
+  processRPResult: jest.fn(),
+  cancelRecurringPayment: jest.fn()
 }))
 
 jest.mock('../../../schema/recurring-payments.schema.js', () => ({
   dueRecurringPaymentsRequestParamsSchema: jest.fn(),
-  processRPResultRequestParamsSchema: jest.fn()
+  processRPResultRequestParamsSchema: jest.fn(),
+  cancelRecurringPaymentRequestParamsSchema: jest.fn()
 }))
 
 const getMockRequest = ({
@@ -27,9 +36,10 @@ const getMockRequest = ({
   paymentId = 'payment-id',
   createdDate = 'created-date',
   existingRecurringPaymentId = 'existing-recurring-payment-id',
-  agreementId = 'agreement-id'
+  agreementId = 'agreement-id',
+  id = 'abc123'
 }) => ({
-  params: { date, transactionId, paymentId, createdDate, existingRecurringPaymentId, agreementId }
+  params: { date, transactionId, paymentId, createdDate, existingRecurringPaymentId, agreementId, id }
 })
 
 const getMockResponseToolkit = () => ({
@@ -86,4 +96,26 @@ describe('recurring payments', () => {
       expect(recurringPayments[1].options.validate.params).toBe(processRPResultRequestParamsSchema)
     })
   })
+
+  describe('cancelRecurringPayment', () => {
+    it('handler should return continue response', async () => {
+      const request = getMockRequest({})
+      const responseToolkit = getMockResponseToolkit()
+      expect(await crpHandler(request, responseToolkit)).toEqual(responseToolkit.continue)
+    })
+
+    it('should call cancelRecurringPayment with id', async () => {
+      const id = Symbol('recurring-payment-id')
+      const request = getMockRequest({ id })
+      await crpHandler(request, getMockResponseToolkit())
+      expect(cancelRecurringPayment).toHaveBeenCalledWith(id)
+    })
+
+    it('should validate with cancelRecurringPaymentRequestParamsSchema', async () => {
+      const id = Symbol('recurring-payment-id')
+      const request = getMockRequest({ id })
+      await crpHandler(request, getMockResponseToolkit())
+      expect(recurringPayments[2].options.validate.params).toBe(cancelRecurringPaymentRequestParamsSchema)
+    })
+  })
 })

package/src/server/routes/recurring-payments.js

@@ -1,9 +1,10 @@
 import {
   dueRecurringPaymentsRequestParamsSchema,
   dueRecurringPaymentsResponseSchema,
-  processRPResultRequestParamsSchema
+  processRPResultRequestParamsSchema,
+  cancelRecurringPaymentRequestParamsSchema
 } from '../../schema/recurring-payments.schema.js'
-import { getRecurringPayments, processRPResult } from '../../services/recurring-payments.service.js'
+import { getRecurringPayments, processRPResult, cancelRecurringPayment } from '../../services/recurring-payments.service.js'
 
 const SWAGGER_TAGS = ['api', 'recurring-payments']
 
@@ -55,5 +56,29 @@ export default [
         }
       }
     }
+  },
+  {
+    method: 'GET',
+    path: '/cancelRecurringPayment/{id}',
+    options: {
+      handler: async (request, h) => {
+        const { id } = request.params
+        const result = await cancelRecurringPayment(id)
+        return h.response(result)
+      },
+      description: 'Cancel a recurring payment',
+      tags: SWAGGER_TAGS,
+      validate: {
+        params: cancelRecurringPaymentRequestParamsSchema
+      },
+      plugins: {
+        'hapi-swagger': {
+          responses: {
+            200: { description: 'Recurring payment cancelled' }
+          },
+          order: 3
+        }
+      }
+    }
   }
 ]

package/src/services/__tests__/recurring-payments.service.spec.js

@@ -3,6 +3,7 @@ import {
   executeQuery,
   findDueRecurringPayments,
   findRecurringPaymentsByAgreementId,
+  findById,
   Permission,
   RecurringPayment
 } from '@defra-fish/dynamics-lib'
@@ -11,7 +12,8 @@ import {
   processRecurringPayment,
   generateRecurringPaymentRecord,
   processRPResult,
-  findNewestExistingRecurringPaymentInCrm
+  findNewestExistingRecurringPaymentInCrm,
+  cancelRecurringPayment
 } from '../recurring-payments.service.js'
 import { calculateEndDate, generatePermissionNumber } from '../permissions.service.js'
 import { getObfuscatedDob } from '../contacts.service.js'
@@ -27,6 +29,7 @@ const { docClient, sqs } = AWS.mock.results[0].value
 jest.mock('@defra-fish/dynamics-lib', () => ({
   ...jest.requireActual('@defra-fish/dynamics-lib'),
   executeQuery: jest.fn(),
+  findById: jest.fn(),
   findDueRecurringPayments: jest.fn(),
   findRecurringPaymentsByAgreementId: jest.fn(() => ({ toRetrieveRequest: () => {} })),
   dynamicsClient: {
@@ -733,4 +736,31 @@ describe('recurring payments service', () => {
       expect(rcp).toBeFalsy()
     })
   })
+
+  describe('cancelRecurringPayment', () => {
+    it('should call findById with RecurringPayment and the provided id', async () => {
+      const id = 'abc123'
+      await cancelRecurringPayment(id)
+      expect(findById).toHaveBeenCalledWith(RecurringPayment, id)
+    })
+
+    it('should log a RecurringPayment record when there is one match', async () => {
+      const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
+      const recurringPayment = { entity: getMockRecurringPayment() }
+      findById.mockReturnValueOnce(recurringPayment)
+
+      await cancelRecurringPayment('id')
+
+      expect(consoleLogSpy).toHaveBeenCalledWith('RecurringPayment for cancellation: ', recurringPayment)
+    })
+
+    it('should log no matches when there are no matches', async () => {
+      const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
+      findById.mockReturnValueOnce(undefined)
+
+      await cancelRecurringPayment('id')
+
+      expect(consoleLogSpy).toHaveBeenCalledWith('No matches found for cancellation')
+    })
+  })
 })

package/src/services/recurring-payments.service.js

@@ -1,5 +1,6 @@
 import {
   executeQuery,
+  findById,
   findDueRecurringPayments,
   findRecurringPaymentsByAgreementId,
   RecurringPayment,
@@ -138,3 +139,12 @@ export const findNewestExistingRecurringPaymentInCrm = async agreementId => {
   }
   return false
 }
+
+export const cancelRecurringPayment = async id => {
+  const recurringPayment = await findById(RecurringPayment, id)
+  if (recurringPayment) {
+    console.log('RecurringPayment for cancellation: ', recurringPayment)
+  } else {
+    console.log('No matches found for cancellation')
+  }
+}