[City OFN Voucher] A shopper can use a VINE voucher

[rioug]

⚠️ When working on this use the Clockify code: Citi Food Vouchers: #1A. https://github.com/openfoodfoundation/openfoodnetwork/issues/11922 Citi OFN Voucher - VINE Integration ⚠️

What? Why?

• Closes #12859

  It lets a customer use a VINE voucher on their order. OFN will communicate with the VINE Api :

• First, to validate a voucher when it's added to the order
• Then on checkout, to redeem the voucher VINE voucher are managed on the VINE platform : https://vine-staging.openfoodnetwork.org.au/login , as such they won't show on the voucher admin page.

What should we test?

Set up: _!! Make sure "connectedapps" feature is turned on Logged as an enterprise to VINE, in the backoffice as an enterprise manager :

• Visit the enterprise setting and click on "connected apps" in the left hand side menu
• Enter you api key and associated secret in the "Voucher Integration Engine (VINE)" section

Log into VINE https://vine-staging.openfoodnetwork.org.au/ :

• set your team to "OFN test - service" by clicking on your name in the top right hand side choosing "OFN test - service"
• Click on "Voucher sets" on the top right hand side menu, you should now see a voucher set ( NOTE: the two last voucher set have $1 voucher, I would recommend using those ones for testing, unless testing partial redemption/redemption by multiple enterprises)
• Clicking on the voucher set, you'll get access to a list of voucher you can use for testing

Normal checkout

Make sure you have an order cycle set up with the enterprise you connected to VINE set as a distributor, set your team in VINE to "OFN test - merchant"

• start an order and proceed to checkout
• advance to payment method --> you should see a voucher input
  • try adding a random code --> you should get a not found error
  • try adding a voucher using the short code --> the 1$ voucher should be added to the order
  • switch to a different team in VINE, and try adding a voucher using the short code --> you should get There was an error while adding the voucher
• with a voucher added to the order, proceed to order summary --> you should see the voucher applied to the order in the right hand side
• Complete the order --> you should see the voucher on the order confirmation page --> you should see the voucher in the confirmation email
  • Login in VINE, set your team to "OFN test - service",
  • Navigate to the voucher you used --> you should see "0$ Remaining value" and " 1 # Redemptions"

Same voucher used by multiple enterprise

Same as above, but this time use a $50 voucher from the first voucher set and place order under $50 so we can use the voucher with another enterprise.

• Connect a different enterprise to VINE, you can use the same credentials for multiple enterprises.
• Make sure you have an order cycle set up with the enterprise you just connected to VINE
• Set your team in VINE to "OFN test - merchant 2"
• Place an order with the same voucher you used above --> you should see the voucher on the order confirmation page --> you should see the voucher in the confirmation email
  • Login in VINE, set your team to "OFN test - service",
  • Navigate to the voucher you used --> you should see " 2 # Redemptions" and under the "Voucher Redemptions" section, you should see a redemption for each "OFN test - merchant" and OFN test - mechant 2"

Failed redemption :

• same as before, start an order, proceed to checkout, add a voucher and proceed to "Order summary"
• Login in VINE and switch your team "OFN test - service"
• Complete your order --> you should get "Redeeming the voucher failed" error

Admin - capture a payment

• same as before , start an order, proceed to checkout, add a voucher and proceed to "Order summary"
• go to the backoffice Orders screen
• Select the order you just created, it should be in the "confirmation" state --> you should see the voucher as an "Order Adjustments"
• Click on "payments" on the right hand side menu
• Capture and complete the order by clicking on the :white_check_mark: button --> The payment status should be "Complete" and order status on the right hand side should also be "Compete"

Failed redemption:

• Same as before up to the payment screen
• Capture and complete the order by clicking on the :white_check_mark: button --> you should get "Redeeming the voucher failed" error

Admin - create a payment

• same as before , start an order, proceed to checkout, add a voucher and proceed to "Order summary"
• go to the backoffice Orders screen
• Select the order you just created, it should be in the "confirmation" state
• Click on "payments" on the right hand side menu
• Click on "+ New Payment" button
• Enter details and click on "Update" --> you should get redirected to the payment page and the new payment should be listed, order status should be "complete"

Failed redemption:

• Same as before up to the new payment screen
• Enter details and click on "Update" --> should get redirected to the payment page and get "Redeeming the voucher failed" error

Report

Check the voucher are showing up correctly on the following reports:

• Order Cycle Customer Totals
• Enterprise Fees With Tax Report By Order
• Revenues By Hub
• Sales Tax Totals By Order

Release notes

Changelog Category (reviewers may add a label for the release notes):

• [x] User facing changes
• [ ] API changes (V0, V1, DFC or Webhook)
• [ ] Technical changes only
• [x] Feature toggled

The title of the pull request will be included in the release notes.

[rioug]

I am yet to address all the review comments, but I had to do a bit more work to handle this requirement:

• a voucher to be able to be redeemed by multiple merchants

I ended up creating Vouchers::Vine because in the end it is different enough from Vouchers::FlatRate to have its' own class, mainly because we now have different requirement on the uniqueness of a voucher code.

@dacook I started looking into handling API error with exception, and you are right it should be a bit cleaner than the current solution.

Moving back into code review because I think it's worth Maikel having a look even if it's not totally finished