@defra-fish/connectors-lib 1.64.0-rc.8 → 1.65.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/connectors-lib",
-  "version": "1.64.0-rc.8",
+  "version": "1.65.0-rc.0",
   "description": "Shared connectors",
   "type": "module",
   "engines": {
@@ -46,5 +46,5 @@
     "node-fetch": "2.7.0",
     "redlock": "4.2.0"
   },
-  "gitHead": "88a60cab95e119b46cec17336d784aec1aeabae8"
+  "gitHead": "cdf9253964871c4afe0ff85d085364ffe4e890cf"
 }

package/src/__tests__/sales-api-connector.spec.js

@@ -821,103 +821,38 @@ describe('sales-api-connector', () => {
       await expect(salesApi.retrieveStagedTransaction('id')).rejects.toThrow('Internal Server Error')
     })
   })
+})
 
-  describe('retrieveRecurringPaymentAgreement', () => {
-    describe.each([['id'], ['abc-123']])("Retrieving recurring payment agreement id '%s'", agreementId => {
-      beforeEach(() => {
-        fetch.mockReturnValueOnce({
-          ok: true,
-          status: 200,
-          statusText: 'OK',
-          text: async () => JSON.stringify({ agreementId })
-        })
-      })
-
-      it('calls the endpoint with the correct parameters', async () => {
-        await salesApi.retrieveRecurringPaymentAgreement(agreementId)
-
-        expect(fetch).toHaveBeenCalledWith(`http://0.0.0.0:4000/retrieveRecurringPaymentAgreement/${agreementId}`, {
-          method: 'get',
-          headers: expect.any(Object),
-          timeout: 20000
-        })
-      })
-
-      it('returns the expected response data', async () => {
-        const processedResult = await salesApi.retrieveRecurringPaymentAgreement(agreementId)
-
-        expect(processedResult).toEqual({ agreementId })
-      })
-    })
-
-    it('throws an error on non-2xx response', async () => {
-      fetch.mockReturnValueOnce({
-        ok: false,
-        status: 500,
-        statusText: 'Internal Server Error',
-        text: async () => 'Server Error'
-      })
-
-      await expect(salesApi.retrieveRecurringPaymentAgreement('agreementId')).rejects.toThrow('Internal Server Error')
-    })
+describe('rcp authentication', () => {
+  it('returns parsed JSON with successful fetch', async () => {
+    const expectedResponse = { woo: 'hoo' }
+    fetch.mockReturnValueOnce({ ok: true, status: 200, statusText: 'OK', text: async () => JSON.stringify(expectedResponse) })
+    const response = await salesApi.authenticateRecurringPayment('AAAAAA', '1980-03-02', 'BS9 4PT')
+    expect(response).toEqual(expectedResponse)
   })
 
-  describe('updateRecurringTransaction', () => {
-    it.each([['Debit card'], ['Credit card']])('updates the transaction with payment method "%s"', async method => {
-      const transactionId = 'transaction-id'
-      const payload = {
-        payment: {
-          source: 'Gov Pay',
-          method
-        }
-      }
-      const expectedResponse = { id: transactionId, ...payload }
-
-      fetch.mockReturnValueOnce({
-        ok: true,
-        status: 200,
-        statusText: 'OK',
-        text: async () => JSON.stringify(expectedResponse)
-      })
-
-      await expect(salesApi.updateRecurringTransaction(transactionId, payload)).resolves.toEqual(expectedResponse)
-
-      expect(fetch).toHaveBeenCalledWith(
-        `http://0.0.0.0:4000/update-recurring-transactions/${transactionId}`,
-        expect.objectContaining({
-          method: 'patch',
-          body: JSON.stringify(payload)
-        })
-      )
-    })
-
-    it('throws on a non-ok response', async () => {
-      const transactionId = 'transaction-id'
-      const payload = {
-        payment: {
-          source: 'Gov Pay',
-          method: 'Debit card'
-        }
+  it('calls fetch with the RCP authenticate URL and query params', async () => {
+    const expectedResponse = { woo: 'hoo' }
+    fetch.mockReturnValueOnce({ ok: true, status: 200, statusText: 'OK', text: async () => JSON.stringify(expectedResponse) })
+    await salesApi.authenticateRecurringPayment('AAAAAA', '1980-03-02', 'BS9 4PT')
+    expect(fetch).toHaveBeenCalledWith(
+      'http://0.0.0.0:4000/authenticate/rcp/AAAAAA?licenseeBirthDate=1980-03-02&licenseePostcode=BS9%204PT',
+      {
+        method: 'get',
+        headers: expect.any(Object),
+        timeout: 20000
       }
+    )
+  })
 
-      fetch.mockReturnValueOnce({
-        ok: false,
-        status: 422,
-        statusText: 'Unprocessable Entity',
-        text: async () => JSON.stringify({ error: 'Description' })
-      })
-
-      await expect(salesApi.updateRecurringTransaction(transactionId, payload)).rejects.toThrow(
-        /Unexpected response from the Sales API:.*"status": 422.*"statusText": "Unprocessable Entity"/s
-      )
-
-      expect(fetch).toHaveBeenCalledWith(
-        `http://0.0.0.0:4000/update-recurring-transactions/${transactionId}`,
-        expect.objectContaining({
-          method: 'patch',
-          body: JSON.stringify(payload)
-        })
-      )
+  it('returns null when the sales API responds with a non-2xx status', async () => {
+    fetch.mockReturnValueOnce({
+      ok: false,
+      status: 400,
+      statusText: 'Bad Request',
+      text: async () => 'Bad Request'
     })
+    const response = await salesApi.authenticateRecurringPayment('AAAAAA', '1980-03-02', 'BS9 4PT')
+    expect(response).toBeNull()
   })
 })

package/src/sales-api-connector.js

@@ -100,17 +100,6 @@ export const createTransactions = async transactionArr =>
  */
 export const finaliseTransaction = async (id, payload) => exec2xxOrThrow(call(new URL(`/transactions/${id}`, urlBase), 'patch', payload))
 
-/**
- * Update a transaction in the sales API
- *
- * @param id the transaction id to finalise
- * @param payload the update-transaction payload to supply on the request
- * @returns {Promise<*>}
- * @throws on a non-2xx response
- */
-export const updateRecurringTransaction = async (id, payload) =>
-  exec2xxOrThrow(call(new URL(`/update-recurring-transactions/${id}`, urlBase), 'patch', payload))
-
 /**
  * Retrieve the details of a transaction file.  Returns null if not found.
  *
@@ -280,6 +269,27 @@ export const authenticate = async (referenceNumber, birthDate, postcode) =>
     )
   )
 
+/**
+ * Support for cancelling recurring payment authentication
+ * @param referenceNumber
+ * @param birthDate
+ * @param postcode
+ * @returns {Promise<*>}
+ */
+export const authenticateRecurringPayment = (referenceNumber, birthDate, postcode) =>
+  exec2xxOrNull(
+    call(
+      new URL(
+        `/authenticate/rcp/${referenceNumber}?${querystring.stringify({
+          licenseeBirthDate: birthDate,
+          licenseePostcode: postcode
+        })}`,
+        urlBase
+      ),
+      'get'
+    )
+  )
+
 /**
  * Helper to check if an HTTP status code is classed as a system error
  *
@@ -341,13 +351,3 @@ export const cancelRecurringPayment = async id => {
 export const retrieveStagedTransaction = async id => {
   return exec2xxOrThrow(call(new URL(`/retrieveStagedTransaction/${id}`, urlBase), 'get'))
 }
-
-/**
- * Retrieve recurring payment agreement details
- *
- * @param {string} agreementId
- * @returns {Promise<*>}
- * @throws on a non-2xx response
- */
-export const retrieveRecurringPaymentAgreement = async agreementId =>
-  exec2xxOrThrow(call(new URL(`/retrieveRecurringPaymentAgreement/${agreementId}`, urlBase), 'get'))