UssdStateMachine 3.0.5

USSD State Machine

Introduction

This library provides a convenient way to integrate USSD functionality into your ASP.NET Core applications. Follow the steps below to get started.

Usage

1. Configure Redis Connection:

   Ensure you have a Redis connection string named Redis in your appsettings.json file.

   {
     "Redis": "your_redis_connection_string"
   }
   

2. Register USSD Dependencies:

   In your Startup.cs file, add the following code within the ConfigureServices method.

   builder.Services.AddUSSDMenus();
   

3. Implement USSD in Controller:

   Inject the USSDService into your controller, and call the ProccessRequest<InitialMenu>() function in your controller action.

   [Route("api/ussd")]
   [ApiController]
   public class USSDController : ControllerBase
   {
       private readonly USSDService _ussdService;
   
       public USSDController(USSDService ussdService) =>
           _ussdService = ussdService;    
   
       [HttpGet]
       public async Task Index([FromQuery] USSDRequest request) => 
           await _ussdService.ProcessRequest<InitialMenu>(request);
   }
   

Creating Menus

To create menus, follow these steps:

1. Define Menu Class:

   Create a class for your menu and decorate it with the [USSDMenu] attribute. Implement the IUSSDMenu interface.

   [USSDMenu]
   public class InitialMenu : IUSSDMenu
   {
       public async Task DisplayAsync(USSDRequest request)
       {
           // Implement logic for displaying menu
       }
   
       public async Task ProcessInputAsync(USSDRequest request)
       {
           // Implement logic for processing user input
       }
   }
   

2. Utilize IUSSDMenuBuilder (Optional):

   Inject the IUSSDMenuBuilder into your menu class to use the builder for implementing the DisplayAsync and ProcessInputAsync methods.

   [USSDMenu]
   public class InitialMenu : IUSSDMenu
   {
       private readonly IUSSDMenuBuilder _builder;
   
       public InitialMenu(IUSSDMenuBuilder builder) => 
           _builder = builder;
   
       public async Task DisplayAsync(USSDRequest request)
       {
           // Implement logic using the IUSSDMenuBuilder
       }
   
       public async Task ProcessInputAsync(USSDRequest request)
       {
           // Implement logic using the IUSSDMenuBuilder
       }
   }
   

Feel free to customize the logic within the menu classes to suit your USSD application requirements.