https://github.com/defra/rpa-mit-payment

https://github.com/defra/rpa-mit-payment

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/defra/rpa-mit-payment
• Owner: DEFRA
• Created: 2023-06-29T16:10:54.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-02T11:31:57.000Z (7 months ago)
• Last Synced: 2024-05-03T15:09:07.371Z (7 months ago)
• Language: C#
• Size: 168 KB
• Stars: 1
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Payment Generation

This repository contains an azure function with a Service Bus trigger, the messages to the service bus are sent via other services, its use is as a method of sending complete validated invoices to the system that can produce a payment.

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=est-mit-payment&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=est-mit-payment) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=est-mit-payment&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=est-mit-payment) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=est-mit-payment&metric=coverage)](https://sonarcloud.io/summary/new_code?id=est-mit-payment) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=est-mit-payment&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=est-mit-payment)

## Requirements

Amend as needed for your distribution, this assumes you are using windows with WSL. 

- 

     .NET 8 SDK 

    

    #### Basic instructions for installing the .NET 8 SDK on a debian based system.

  

    Amend as needed for your distribution.

    ```bash

    wget https://packages.microsoft.com/config/debian/12/packages-microsoft-prod.deb -O packages-microsoft-prod.deb

    sudo dpkg -i packages-microsoft-prod.deb

    sudo apt-get update && sudo apt-get install -y dotnet-sdk-8.0

    ```

- 

     Azure Functions Core Tools 

    

    ```bash

    sudo apt-get install azure-functions-core-tools-4

    ```

- [Docker](https://docs.docker.com/desktop/install/linux-install/)

- Service Bus Queue

---

## Local Setup

To run this service locally complete the following steps.

### Create Local Settings

Create a local.setttings.json file with the following content.

```json

{

    "IsEncrypted": false,

    "Values": {

        "AzureWebJobsStorage": "UseDevelopmentStorage=true",

        "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated"

    }

}

```

### Set up user secrets

Use the secrets-template to create a "secrets.json" in the same folder location.

The schemes key should be a comma separated list

```json

{

	"Schemes": "Scheme1,Scheme2"

}

```

Once this is done run the following command to add the projects user secrets

```bash

cat secrets.json | dotnet user-secrets set

```

These values can also be added to the local settings file, but the preferred method is via user secrets.

### Startup

To start the function locally.

```bash

func start

```

If running multiple function apps locally you might encounter a port conflict error as they all try to run on port 7071. If this happens use a command such as this entering a port that is free.

```bash

func start --port 7072

```

---

## Usage / Endpoints

### Payment Creation

> Function Trigger: ServiceBusTrigger

> #### Endpoint

> Uses the Service Bus queue trigger named from the environment variable `%PaymentQueueName%`

> #### Action

> Receives payment requests and processes them. If the request is valid, it sends it forward using the service bus after performing some validations. Errors during processing are logged, and messages are sent to an event queue service indicating the status of the payment processing.

> 

> Below is an **encoded** example message that can be added to the service bus queue to test functionality. Json messages format must be encoded as base64 to be accepted.

> 

> ```base64

>eyAic2NoZW1lVHlwZSI6ICJBRCIsICJwYXltZW50UmVxdWVzdHNCYXRjaGVzIjogWyB7ICJpZCI6ICIxIiwgImFjY291bnRUeXBlIjogIkFEIiwgIm9yZ2FuaXNhdGlvbiI6ICJGR0giLCAic2NoZW1lVHlwZSI6ICJBRCIsICJwYXltZW50VHlwZSI6ICJBUCIsICJwYXltZW50UmVxdWVzdHMiOiBbIHsgInBheW1lbnRSZXF1ZXN0SWQiOiAiMiIsICJmcm4iOiA1Njc4OTA0MywgInNiaSI6IDQ1NjcsICJ2ZW5kb3IiOiAiQSIsICJzb3VyY2VTeXN0ZW0iOiAic291cmNlU3lzdGVtIiwgIm1hcmtldGluZ1llYXIiOiAyMDIzLCAiY3VycmVuY3kiOiAiR0JQIiwgImRlc2NyaXB0aW9uIjogIkRlc2NyaXB0aW9uIiwgIm9yaWdpbmFsSW52b2ljZU51bWJlciI6ICIyM0VSNTYiLCAib3JpZ2luYWxTZXR0bGVtZW50RGF0ZSI6ICIyMDIzLTEwLTE5VDEzOjExOjE3LjU4NDg4KzAxOjAwIiwgInJlY292ZXJ5RGF0ZSI6ICIyMDIzLTEwLTE5VDEzOjExOjE3LjU4NDg5NiswMTowMCIsICJpbnZvaWNlQ29ycmVjdGlvblJlZmVyZW5jZSI6ICJFUlE1NjciLCAicGF5bWVudFJlcXVlc3ROdW1iZXIiOiAzNDU2NywgImFncmVlbWVudE51bWJlciI6ICIxMjM0NSIsICJ2YWx1ZSI6IDIsICJkdWVEYXRlIjogInN0cmluZyIsICJpbnZvaWNlTGluZXMiOiBbIHsgInZhbHVlIjogMywgInNjaGVtZUNvZGUiOiAiRDRFUlQiLCAiZGVzY3JpcHRpb24iOiAiVGhpcyBpcyBhIGRlc2NyaXB0aW9uIiwgImZ1bmRDb2RlIjogIjJBREMiLCAibWFpbkFjY291bnQiOiAiQWNjb3VudEEiLCAibWFya2V0aW5nWWVhciI6IDIwMjIsICJkZWxpdmVyeUJvZHkiOiAiRGVsaXZlcnlCb2R5IiB9IF0gfSBdLCAic3RhdHVzIjogIkEiLCAicmVmZXJlbmNlIjogIjEyMyIsICJjcmVhdGVkIjogIjIwMjItMTEtMDVUMDA6MDA6MDAiLCAidXBkYXRlZCI6ICIyMDIzLTEwLTE5VDEzOjExOjE3LjU4NDk3OCswMTowMCIsICJjcmVhdGVkQnkiOiAidXNlcm5hbWUxIiwgInVwZGF0ZWRCeSI6ICJ1c2VybmFtZTEiIH0gXSB9

> ```