@sails-pay/paystack 0.0.1 → 0.2.0

package/adapter.js

@@ -2,5 +2,6 @@ const methods = require('./machines')
 module.exports = {
   identity: 'sails-paystack',
   config: {},
-  checkout: methods.checkout
+  checkout: methods.checkout,
+  verify: methods.verify
 }

package/helpers/parameters.js

@@ -6,16 +6,34 @@
  */
 
 module.exports = {
-  PAYSTACK_API_KEY: {
+  PAYSTACK_SECRET_KEY: {
     type: 'string',
-    friendlyName: 'API Key',
-    description: 'A valid Paystack API Key',
+    friendlyName: 'Secret Key',
+    description: 'A valid Paystack Secret Key',
     protect: true,
     whereToGet: {
       url: 'https://dashboard.paystack.com/#/settings/developers',
-      description: 'Generate an API key in your Paystack dashboard.',
+      description: 'Generate a secret key in your Paystack dashboard.',
       extendedDescription:
-        'To generate an API key, you will first need to log in to your Paystack account, or sign up for one if you have not already done so.'
+        'To generate a secret key, you will first need to log in to your Paystack account, or sign up for one if you have not already done so.'
     }
+  },
+  PAYSTACK_PUBLIC_KEY: {
+    type: 'string',
+    friendlyName: 'Public Key',
+    description: 'A valid Paystack Public Key',
+    whereToGet: {
+      url: 'https://dashboard.paystack.com/#/settings/developers',
+      description: 'Get your public key from your Paystack dashboard.',
+      extendedDescription:
+        'To get your public key, you will first need to log in to your Paystack account, or sign up for one if you have not already done so.'
+    }
+  },
+  PAYSTACK_CALLBACK_URL: {
+    type: 'string',
+    friendlyName: 'Callback URL',
+    description: 'The default callback URL for Paystack transactions',
+    extendedDescription:
+      'This URL will be used as the default callback for all transactions unless overridden per request.'
   }
 }

package/machines/checkout.js

@@ -4,7 +4,7 @@ module.exports = require('machine').build({
   description: 'Creates and return a checkout authorization URL',
   moreInfoUrl: 'https://paystack.com/docs/api/transaction/#initialize',
   inputs: {
-    apiKey: require('../helpers/parameters').PAYSTACK_API_KEY,
+    secretKey: require('../helpers/parameters').PAYSTACK_SECRET_KEY,
     amount: {
       type: 'number',
       description: 'Amount should be in the subunit of the supported currency'
@@ -89,7 +89,7 @@ module.exports = require('machine').build({
   },
   fn: async function (
     {
-      apiKey,
+      secretKey,
       amount,
       email,
       currency,
@@ -107,12 +107,13 @@ module.exports = require('machine').build({
     exits
   ) {
     const adapterConfig = require('../adapter').config
+    const resolvedCallbackUrl = callbackUrl || adapterConfig.callbackUrl
     const payload = JSON.stringify({
       amount,
       email,
       currency,
       reference,
-      callback_url: callbackUrl,
+      ...(resolvedCallbackUrl && { callback_url: resolvedCallbackUrl }),
       plan,
       invoice_limit: invoiceLimit,
       metadata,
@@ -125,7 +126,7 @@ module.exports = require('machine').build({
     const checkout = await fetch('/transaction/initialize', {
       method: 'POST',
       headers: {
-        authorization: `Bearer ${apiKey || adapterConfig.apiKey}`
+        authorization: `Bearer ${secretKey || adapterConfig.secretKey}`
       },
       body: payload
     })

package/machines/index.js

@@ -1,3 +1,4 @@
 module.exports = {
-  checkout: require('./checkout')
+  checkout: require('./checkout'),
+  verify: require('./verify')
 }

package/machines/verify.js

@@ -0,0 +1,45 @@
+const fetch = require('../helpers/fetch')
+module.exports = require('machine').build({
+  friendlyName: 'Verify transaction',
+  description: 'Verifies the status of a Paystack transaction by its reference',
+  moreInfoUrl: 'https://paystack.com/docs/api/transaction/#verify',
+  inputs: {
+    secretKey: require('../helpers/parameters').PAYSTACK_SECRET_KEY,
+    reference: {
+      type: 'string',
+      required: true,
+      description: 'The transaction reference used to initiate the transaction.'
+    }
+  },
+  exits: {
+    success: {
+      description: 'Transaction verified successfully.',
+      outputVariableName: 'transaction',
+      outputType: 'ref'
+    },
+    couldNotVerifyTransaction: {
+      description: 'Transaction could not be verified.',
+      extendedDescription:
+        'This indicates that an error was encountered while verifying the transaction.',
+      outputFriendlyName: 'Verify transaction error report.',
+      outputVariableName: 'errors'
+    }
+  },
+  fn: async function ({ secretKey, reference }, exits) {
+    const adapterConfig = require('../adapter').config
+    const result = await fetch(
+      `/transaction/verify/${encodeURIComponent(reference)}`,
+      {
+        method: 'GET',
+        headers: {
+          authorization: `Bearer ${secretKey || adapterConfig.secretKey}`
+        }
+      }
+    )
+    if (!result.status) {
+      return exits.couldNotVerifyTransaction(result)
+    }
+
+    return exits.success(result.data)
+  }
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sails-pay/paystack",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Paystack adapter for Sails Pay",
   "main": "adapter.js",
   "scripts": {