ulsdevteam/alma-payment-microservice

Microservice for fines & fees payment in Alma thru Authorize.net

alma-payment-microservice's Issues

Throw additional exceptions on webhook processing

alma-payment-microservice/receipt.php

Lines 25 to 63 in ff69d9e

	$notification = json_decode($body);
	switch ($notification->eventType) {
	case 'net.authorize.payment.authcapture.created':
	$transactionId = $notification->payload->id;
	$request = new AnetApi\GetTransactionDetailsRequest();
	$request->setMerchantAuthentication(getMerchantAuthentication());
	$request->setTransId($transactionId);
	// get the transaction details so we can read the fee ids off of the line items
	$controller = new AnetController\GetTransactionDetailsController($request);
	$response = $controller->executeWithApiResponse(AUTHORIZE_ENVIRONMENT);
	if ($response == null) {
	throw new Exception("An error occurred when retrieving transaction details.");
	} else if ($response->getMessages()->getResultCode() != "Ok") {
	$errorMessages = $response->getMessages()->getMessage();
	throw new Exception($errorMessages[0]->getCode() . " " . $errorMessages[0]->getText());
	}
	$transaction = $response->getTransaction();
	$userId = $transaction->getCustomer()->getId();
	$alma = new AlmaClient(ALMA_API_KEY, ALMA_REGION);
	foreach ($transaction->getLineItems() as $lineItem) {
	$feeId = $lineItem->getItemId();
	// mark each fee as paid
	$url = $alma->buildUrl('/users/' . $userId . '/fees/' . $feeId, [
	'op' => 'pay',
	'amount' => strval($lineItem->getUnitPrice()),
	'method' => 'ONLINE',
	'external_transaction_id' => $transactionId
	]);
	$alma->post($url, null);
	}
	break;
	default:
	break;

Check for success of json_decode and throw exception if not an object/array.

Throw an exception on the default case of the switch.

Should the invoice number be formatted based on the admin's choice?

alma-payment-microservice/index.php

Lines 37 to 40 in ff69d9e

	} catch (Throwable $e) {
	http_response_code(500);
	echo $e;
	exit;

Minimally, add a delimiter between the primary id and the timestamp.

Break out Authorize.net options into a config

alma-payment-microservice/index.php

Lines 77 to 85 in ff69d9e

	$buttonOptionsSetting = new AnetAPI\SettingType();
	$buttonOptionsSetting->setSettingName("hostedPaymentButtonOptions");
	$buttonOptionsSetting->setSettingValue("{\"text\":\"Pay\"}");
	$orderOptionsSetting = new AnetAPI\SettingType();
	$orderOptionsSetting->setSettingName("hostedPaymentOrderOptions");
	$orderOptionsSetting->setSettingValue("{\"show\":true}");
	$returnOptionsSetting = new AnetAPI\SettingType();
	$returnOptionsSetting->setSettingName("hostedPaymentReturnOptions");
	$returnOptionsSetting->setSettingValue("{\"showReceipt\":true, \"url\":\"" . RETURN_URL . "\", \"cancelUrl\":\"" . RETURN_URL . "\"}");

These should be represented in the configuration, perhaps as a JSON?

Document usage expectations in the README

In the readme, we should document the integration process with Alma and Authorize.net:

• Alma / Primo
  • Reference these instructions: https://knowledge.exlibrisgroup.com/Primo/Product_Documentation/020Primo_VE/Primo_VE_(English)/060Library_Card_Configuration/Configuring_the_Pay_Fine_Link_for_Primo_VE
  • Note the requirement to append a ? to the URL to pass the jwt successfully.
  • Document required API permissions ("Users - Production Read/write")
• Authorize.net
  • Point to documentation for establishing / locating the API keys
  • Point to documentation for establishing / using the web service callback

Data capture in event of webhook failure

alma-payment-microservice/receipt.php

Lines 68 to 70 in ff69d9e

	} catch (Throwable $e) {
	http_response_code(500);
	exit;

We need some additional error capture here. To log? To email?

Catch specific case when when the user has no fines and fees

alma-payment-microservice/index.php

Lines 37 to 40 in ff69d9e

	} catch (Throwable $e) {
	http_response_code(500);
	echo $e;
	exit;

Cache directory should be configured in config.php

alma-payment-microservice/common.php

Lines 47 to 48 in ff69d9e

	$cache_file_path = __DIR__ . '/cache/public-key.pem';
	$log_file_path = __DIR__ . '/cache/public-key.log';

The expectation of a writable cache directory should be documented in the README and configurable by the admin in config.php.