@defra-fish/connectors-lib 1.62.0-rc.6 → 1.62.0-rc.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/connectors-lib",
-  "version": "1.62.0-rc.6",
+  "version": "1.62.0-rc.8",
   "description": "Shared connectors",
   "type": "module",
   "engines": {
@@ -46,5 +46,5 @@
     "node-fetch": "^2.7.0",
     "redlock": "^4.2.0"
   },
-  "gitHead": "99bf15ee471b05eb6f99d1051ddf955c1cbed9bf"
+  "gitHead": "5d9e947d9ce87f6f43aa6ca7ac8d78f797ecebdf"
 }

package/src/__tests__/govuk-pay-api.spec.js

@@ -147,4 +147,23 @@ describe('govuk-pay-api-connector', () => {
       expect(consoleErrorSpy).toHaveBeenCalled()
     })
   })
+
+  describe('getRecurringPaymentAgreementInformation', () => {
+    it('retrieves recurring payment agreement information', async () => {
+      fetch.mockReturnValue({ ok: true, status: 200, json: () => {} })
+      await expect(govUkPayApi.getRecurringPaymentAgreementInformation(123)).resolves.toEqual(
+        expect.objectContaining({ ok: true, status: 200 })
+      )
+      expect(fetch).toHaveBeenCalledWith('http://0.0.0.0/agreement/123', { headers: recurringHeaders, method: 'get', timeout: 10000 })
+    })
+
+    it('logs and throws errors', async () => {
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
+      fetch.mockImplementation(() => {
+        throw new Error('test event error')
+      })
+      await expect(govUkPayApi.getRecurringPaymentAgreementInformation(123)).rejects.toEqual(Error('test event error'))
+      expect(consoleErrorSpy).toHaveBeenCalled()
+    })
+  })
 })

package/src/govuk-pay-api.js

@@ -86,3 +86,21 @@ export const fetchPaymentEvents = async (paymentId, recurring = false) => {
     throw err
   }
 }
+
+/**
+ * Gets payment information linked too a payment
+ * @param agreementId - agreementId set up when  creating recurring payment
+ * @returns {Promise<*>}
+ */
+export const getRecurringPaymentAgreementInformation = async agreementId => {
+  try {
+    return fetch(`${process.env.GOV_PAY_RCP_API_URL}/${agreementId}`, {
+      headers: headers(true),
+      method: 'get',
+      timeout: process.env.GOV_PAY_REQUEST_TIMEOUT_MS || GOV_PAY_REQUEST_TIMEOUT_MS_DEFAULT
+    })
+  } catch (err) {
+    console.error(`Error fetching recurring payment agreement information in the GOV.UK API service - agreementId: ${agreementId}`, err)
+    throw err
+  }
+}