ExUssd

Hex.pm Hex.pm

Goals:

An idiomatic, readable, and comfortable API for Elixir developers
Extensibility based on small parts that do one thing well.
Detailed error messages and documentation.
A focus on robustness and production-level performance.

Why Use ExUssd
Documentation
Installation
Configuration
Usage
Contribution
Contributors
Licence

Why Use ExUssd?

ExUssd lets you create simple, flexible, and customizable USSD interface. Under the hood ExUssd uses Elixir Registry to create and route individual USSD session.

https://user-images.githubusercontent.com/23293150/124460086-95ebf080-dd97-11eb-87ab-605f06291563.mp4

Documentation

The docs can be found at https://hexdocs.pm/ex_ussd.

Installation

If available in Hex, the package can be installed by adding ex_ussd to your list of dependencies in mix.exs:

defp deps do
  [
    {:ex_ussd, "~> 1.0.0-rc-1"}
  ]
end

Configuration

Add to your config.exs

# config/config.exs
# TODO: This are example values, replace them with your own
config :ex_ussd,
  nav: [
    ExUssd.Nav.new(type: :home, name: "HOME", match: "00", reverse: true, orientation: :vertical),
    ExUssd.Nav.new(type: :back, name: "BACK", match: "0", right: 1),
    ExUssd.Nav.new(type: :next, name: "MORE", match: "98")
      ],
  delimiter: ").",
  default_error: "invalid input,try again\n"

Usage

ExUssd Callbacks

ExUssd provides you with 3 callbacks

Example

Create a new module:

defmodule ApiWeb.HomeResolver do
  use ExUssd
  def ussd_init(menu, _) do
    ExUssd.set(menu, title: "Enter your PIN")
  end

  def ussd_callback(menu, payload, %{attempt: attempt}) do
    if payload.text == "5555" do
      ExUssd.set(menu, resolve: &success_menu/2)
    else
      ExUssd.set(menu, error: "Wrong PIN, #{3 - attempt} attempt left\n")
    end
  end

  def ussd_after_callback(%{error: true} = menu, _payload, %{attempt: 3}) do
    menu
    |> ExUssd.set(title: "Account is locked, Dial *234# to reset your account")
    |> ExUssd.set(should_close: true)
  end

  def success_menu(menu, _) do
    menu
    |> ExUssd.set(title: "You have Entered the Secret Number, 5555")
    |> ExUssd.set(should_close: true)
  end
end

Contribution

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question. If you don't see your idea listed, Open an issue.

Check the Contribution guide on how to contribute.