add doc line

cmd/main.go

@@ -71,6 +71,9 @@ func getHandler(appFlags *asm.FlagParser, rs *resource.DbResource, pe *persist.P
 	rs.AddLocalFunc("reset_incorrect_date_format", ussdHandlers.ResetIncorrectYob)
 	rs.AddLocalFunc("set_reset_single_edit", ussdHandlers.SetResetSingleEdit)
 	rs.AddLocalFunc("initiate_transaction", ussdHandlers.InitiateTransaction)
+	rs.AddLocalFunc("quit_with_help", ussdHandlers.QuitWithHelp)
+	rs.AddLocalFunc("save_temporary_pin", ussdHandlers.SaveTemporaryPin)
+	rs.AddLocalFunc("confirm_pin_change", ussdHandlers.ConfirmPinChange)
 
 	return ussdHandlers, nil
 }

internal/handlers/server/account_service_offline_test.go

@@ -1,129 +0,0 @@
-//go:build !online
-// +build !online
-
-package server
-
-import (
-	"testing"
-
-	"github.com/alecthomas/assert/v2"
-	"gopkg.in/dnaeon/go-vcr.v4/pkg/recorder"
-)
-
-func TestCheckBalanceOffline(t *testing.T) {
-	r, err := recorder.New("custodial/balance")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := r.GetDefaultClient()
-
-	as := AccountService{
-		Client: client,
-	}
-	tests := []struct {
-		name      string
-		balance   string
-		publicKey string
-	}{
-		{
-			name:      "Test check balance with correct public key",
-			publicKey: "0x216a4A64E1e699F9d65Dd9CbD0058dAB21DeF002",
-			balance:   "3.06000000003 CELO",
-		},
-		{
-			name:      "Test check balance with public key that doesn't exist in the custodial system",
-			balance:   "",
-			publicKey: "0x216a4A64E1e699F9d65Dd9CbD0058dAB21DeF00",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			balance, err := as.CheckBalance(tt.publicKey)
-			if err != nil {
-				t.Fatalf("Failed to get balance with error %s", err)
-			}
-			if err != nil {
-
-				return
-			}
-			assert.NoError(t, err)
-			assert.Equal(t, balance, tt.balance, "Expected balance and actual balance should be equal")
-
-		})
-	}
-
-}
-
-func TestCheckAccountStatusOffline(t *testing.T) {
-	r, err := recorder.New("custodial/status")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := r.GetDefaultClient()
-
-	as := AccountService{
-		Client: client,
-	}
-	tests := []struct {
-		name       string
-		status     string
-		trackingId string
-	}{
-		{
-			name:       "Test check status with tracking id that exists in the custodial system",
-			trackingId: "bb23945b-65cd-4110-ac2e-a5df40572e18",
-			status:     "SUCCESS",
-		},
-		{
-			name:       "Test check status with tracking id that doesn't exist in the custodial system",
-			status:     "",
-			trackingId: "bb23945b-65cd-4110-ac2e-a5df40572e1",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			status, err := as.CheckAccountStatus(tt.trackingId)
-			if err != nil {
-				t.Fatalf("Failed to account status with error %s", err)
-			}
-			if err != nil {
-				return
-			}
-			assert.NoError(t, err)
-			assert.Equal(t, status, tt.status, "Expected status and actual status should be equal")
-
-		})
-	}
-
-}
-
-func TestCreateAccountOffline(t *testing.T) {
-	r, err := recorder.New("custodial/create")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := r.GetDefaultClient()
-
-	as := AccountService{
-		Client: client,
-	}
-	accountRes, err := as.CreateAccount()
-
-	if err != nil {
-		t.Fatalf("Failed to create an account with error %s", err)
-	}
-	if err != nil {
-		return
-	}
-	assert.NoError(t, err)
-	assert.Equal(t, accountRes.Ok, true, "account response status is true")
-
-}

internal/handlers/server/account_service_online_test.go

@@ -1,130 +0,0 @@
-//go:build online
-// +build online
-
-package server
-
-import (
-	"net/http"
-	"testing"
-
-	"github.com/alecthomas/assert/v2"
-	"gopkg.in/dnaeon/go-vcr.v4/pkg/recorder"
-)
-
-func TestCheckBalance(t *testing.T) {
-	r, err := recorder.New("custodial/balance")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := &http.Client{}
-
-	as := AccountService{
-		Client: client,
-	}
-	tests := []struct {
-		name      string
-		balance   string
-		publicKey string
-	}{
-		{
-			name:      "Test check balance with correct public key",
-			publicKey: "0x216a4A64E1e699F9d65Dd9CbD0058dAB21DeF002",
-			balance:   "3.06000000003 CELO",
-		},
-		{
-			name:      "Test check balance with public key that doesn't exist in the custodial system",
-			balance:   "",
-			publicKey: "0x216a4A64E1e699F9d65Dd9CbD0058dAB21DeF00",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			balance, err := as.CheckBalance(tt.publicKey)
-			if err != nil {
-				t.Fatalf("Failed to get balance with error %s", err)
-			}
-			if err != nil {
-
-				return
-			}
-			assert.NoError(t, err)
-			assert.Equal(t, balance, tt.balance, "Expected balance and actual balance should be equal")
-
-		})
-	}
-
-}
-
-func TestCheckAccountStatus(t *testing.T) {
-	r, err := recorder.New("custodial/status")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := &http.Client{}
-
-	as := AccountService{
-		Client: client,
-	}
-	tests := []struct {
-		name       string
-		status     string
-		trackingId string
-	}{
-		{
-			name:       "Test check status with tracking id that exists in the custodial system",
-			trackingId: "bb23945b-65cd-4110-ac2e-a5df40572e18",
-			status:     "SUCCESS",
-		},
-		{
-			name:       "Test check status with tracking id that doesn't exist in the custodial system",
-			status:     "",
-			trackingId: "bb23945b-65cd-4110-ac2e-a5df40572e1",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			status, err := as.CheckAccountStatus(tt.trackingId)
-			if err != nil {
-				t.Fatalf("Failed to account status with error %s", err)
-			}
-			if err != nil {
-				return
-			}
-			assert.NoError(t, err)
-			assert.Equal(t, status, tt.status, "Expected status and actual status should be equal")
-
-		})
-	}
-
-}
-
-func TestCreateAccount(t *testing.T) {
-	r, err := recorder.New("custodial/create")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := &http.Client{}
-
-	as := AccountService{
-		Client: client,
-	}
-	accountRes, err := as.CreateAccount()
-
-	if err != nil {
-		t.Fatalf("Failed to create an account with error %s", err)
-	}
-	if err != nil {
-		return
-	}
-	assert.NoError(t, err)
-	assert.Equal(t, accountRes.Ok, true, "account response status is true")
-
-}

internal/handlers/server/accountservice.go

@@ -19,8 +19,6 @@ type AccountService struct {
 	Client *http.Client
 }
 
-
-
 // CheckAccountStatus retrieves the status of an account transaction based on the provided tracking ID.
 //
 // Parameters:
@@ -28,15 +26,12 @@ type AccountService struct {
 //     CreateAccount or a similar function that returns an AccountResponse. The `trackingId` field in the
 //     AccountResponse struct can be used here to check the account status during a transaction.
 //
-//
 // Returns:
 //   - string: The status of the transaction as a string. If there is an error during the request or processing, this will be an empty string.
 //   - error: An error if any occurred during the HTTP request, reading the response, or unmarshalling the JSON data.
 //     If no error occurs, this will be nil.
-//
 func (as *AccountService) CheckAccountStatus(trackingId string) (string, error) {
-	resp,err := as.Client.Get(config.TrackStatusURL + trackingId)
+	resp, err := as.Client.Get(config.TrackStatusURL + trackingId)
-	// resp, err := http.Get(config.TrackStatusURL + trackingId)
 	if err != nil {
 		return "", err
 	}
@@ -52,20 +47,16 @@ func (as *AccountService) CheckAccountStatus(trackingId string) (string, error)
 	if err != nil {
 		return "", err
 	}
-
 	status := trackResp.Result.Transaction.Status
 
 	return status, nil
 }
 
-
 // CheckBalance retrieves the balance for a given public key from the custodial balance API endpoint.
 // Parameters:
 //   - publicKey: The public key associated with the account whose balance needs to be checked.
 func (as *AccountService) CheckBalance(publicKey string) (string, error) {
-
+	resp, err := http.Get(config.BalanceURL + publicKey)
-	//resp, err := http.Get(config.BalanceURL + publicKey)
-	resp, err := as.Client.Get(config.BalanceURL + publicKey)
 	if err != nil {
 		return "0.0", err
 	}
@@ -86,15 +77,13 @@ func (as *AccountService) CheckBalance(publicKey string) (string, error) {
 	return balance, nil
 }
 
-
+// CreateAccount creates a new account in the custodial system.
-//CreateAccount creates a new account in the custodial system.
 // Returns:
 //   - *models.AccountResponse: A pointer to an AccountResponse struct containing the details of the created account.
 //     If there is an error during the request or processing, this will be nil.
 //   - error: An error if any occurred during the HTTP request, reading the response, or unmarshalling the JSON data.
 //     If no error occurs, this will be nil.
 func (as *AccountService) CreateAccount() (*models.AccountResponse, error) {
-	//resp, err := http.Post(config.CreateAccountURL, "application/json", nil)
 	resp, err := as.Client.Post(config.CreateAccountURL, "application/json", nil)
 	if err != nil {
 		return nil, err
@@ -111,6 +100,5 @@ func (as *AccountService) CreateAccount() (*models.AccountResponse, error) {
 	if err != nil {
 		return nil, err
 	}
-
 	return &accountResp, nil
 }

internal/handlers/server/accountservice_test.go

@@ -1,126 +0,0 @@
-package server
-
-import (
-	"testing"
-
-	"github.com/alecthomas/assert/v2"
-	"gopkg.in/dnaeon/go-vcr.v4/pkg/recorder"
-)
-
-func TestCheckBalance(t *testing.T) {
-	r, err := recorder.New("custodial/balance")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := r.GetDefaultClient()
-
-	as := AccountService{
-		Client: client,
-	}
-	tests := []struct {
-		name      string
-		balance   string
-		publicKey string
-	}{
-		{
-			name:      "Test check balance with correct public key",
-			publicKey: "0x216a4A64E1e699F9d65Dd9CbD0058dAB21DeF002",
-			balance:   "3.06000000003 CELO",
-		},
-		{
-			name:      "Test check balance with public key that doesn't exist in the custodial system",
-			balance:   "",
-			publicKey: "0x216a4A64E1e699F9d65Dd9CbD0058dAB21DeF00",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			balance, err := as.CheckBalance(tt.publicKey)
-			if err != nil {
-				t.Fatalf("Failed to get balance with error %s", err)
-			}
-			if err != nil {
-
-				return
-			}
-			assert.NoError(t, err)
-			assert.Equal(t, balance, tt.balance, "Expected balance and actual balance should be equal")
-
-		})
-	}
-
-}
-
-func TestCheckAccountStatus(t *testing.T) {
-	r, err := recorder.New("custodial/status")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := r.GetDefaultClient()
-
-	as := AccountService{
-		Client: client,
-	}
-	tests := []struct {
-		name       string
-		status     string
-		trackingId string
-	}{
-		{
-			name:       "Test check status with tracking id that exists in the custodial system",
-			trackingId: "bb23945b-65cd-4110-ac2e-a5df40572e18",
-			status:     "SUCCESS",
-		},
-		{
-			name:       "Test check status with tracking id that doesn't exist in the custodial system",
-			status:     "",
-			trackingId: "bb23945b-65cd-4110-ac2e-a5df40572e1",
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			status, err := as.CheckAccountStatus(tt.trackingId)
-			if err != nil {
-				t.Fatalf("Failed to account status with error %s", err)
-			}
-			if err != nil {
-				return
-			}
-			assert.NoError(t, err)
-			assert.Equal(t, status, tt.status, "Expected status and actual status should be equal")
-
-		})
-	}
-
-}
-
-func TestCreateAccount(t *testing.T) {
-	r, err := recorder.New("custodial/create")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer r.Stop()
-
-	client := r.GetDefaultClient()
-
-	as := AccountService{
-		Client: client,
-	}
-	accountRes, err := as.CreateAccount()
-
-	if err != nil {
-		t.Fatalf("Failed to create an account with error %s", err)
-	}
-	if err != nil {
-		return
-	}
-	assert.NoError(t, err)
-	assert.Equal(t, accountRes.Ok, true, "account response status is true")
-
-}

internal/handlers/ussd/menuhandler.go

@@ -192,6 +192,48 @@ func (h *Handlers) CreateAccount(ctx context.Context, sym string, input []byte)
 	return res, nil
 }
 
+func (h *Handlers) SaveTemporaryPin(ctx context.Context, sym string, input []byte) (resource.Result, error) {
+	var res resource.Result
+	var err error
+
+	sessionId, ok := ctx.Value("SessionId").(string)
+	if !ok {
+		return res, fmt.Errorf("missing session")
+	}
+	flag_incorrect_pin, _ := h.flagManager.GetFlag("flag_incorrect_pin")
+
+	accountPIN := string(input)
+	// Validate that the PIN is a 4-digit number
+	if !isValidPIN(accountPIN) {
+		res.FlagSet = append(res.FlagSet, flag_incorrect_pin)
+		return res, nil
+	}
+	store := h.userdataStore
+	err = store.WriteEntry(ctx, sessionId, utils.DATA_TEMPORARY_PIN, []byte(accountPIN))
+	if err != nil {
+		return res, err
+	}
+	return res, nil
+}
+
+func (h *Handlers) ConfirmPinChange(ctx context.Context, sym string, input []byte) (resource.Result, error) {
+	var res resource.Result
+	sessionId, ok := ctx.Value("SessionId").(string)
+	if !ok {
+		return res, fmt.Errorf("missing session")
+	}
+	store := h.userdataStore
+	temporaryPin, err := store.ReadEntry(ctx, sessionId, utils.DATA_TEMPORARY_PIN)
+	if err != nil {
+		return res, err
+	}
+	err = store.WriteEntry(ctx, sessionId, utils.DATA_ACCOUNT_PIN, []byte(temporaryPin))
+	if err != nil {
+		return res, err
+	}
+	return res, nil
+}
+
 // SavePin persists the user's PIN choice into the filesystem
 func (h *Handlers) SavePin(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result
@@ -260,15 +302,19 @@ func (h *Handlers) VerifyPin(ctx context.Context, sym string, input []byte) (res
 	if !ok {
 		return res, fmt.Errorf("missing session")
 	}
-
-	//AccountPin, _ := utils.ReadEntry(ctx, h.userdataStore, sessionId, utils.DATA_ACCOUNT_PIN)
 	store := h.userdataStore
 	AccountPin, err := store.ReadEntry(ctx, sessionId, utils.DATA_ACCOUNT_PIN)
 	if err != nil {
 		return res, err
 	}
+	TemporaryPIn, err := store.ReadEntry(ctx, sessionId, utils.DATA_TEMPORARY_PIN)
+	if err != nil {
+		if !db.IsNotFound(err) {
+			return res, err
+		}
+	}
 
-	if bytes.Equal(input, AccountPin) {
+	if bytes.Equal(input, AccountPin) || bytes.Equal(input, TemporaryPIn) {
 		res.FlagSet = []uint32{flag_valid_pin}
 		res.FlagReset = []uint32{flag_pin_mismatch}
 		res.FlagSet = append(res.FlagSet, flag_pin_set)
@@ -569,6 +615,21 @@ func (h *Handlers) Quit(ctx context.Context, sym string, input []byte) (resource
 	return res, nil
 }
 
+// QuitWithHelp displays helpline information then exits the menu
+func (h *Handlers) QuitWithHelp(ctx context.Context, sym string, input []byte) (resource.Result, error) {
+	var res resource.Result
+
+	flag_account_authorized, _ := h.flagManager.GetFlag("flag_account_authorized")
+
+	code := codeFromCtx(ctx)
+	l := gotext.NewLocale(translationDir, code)
+	l.AddDomain("default")
+
+	res.Content = l.Get("For more help,please call: 0757628885")
+	res.FlagReset = append(res.FlagReset, flag_account_authorized)
+	return res, nil
+}
+
 // VerifyYob verifies the length of the given input
 func (h *Handlers) VerifyYob(ctx context.Context, sym string, input []byte) (resource.Result, error) {
 	var res resource.Result

internal/handlers/ussd/menuhandler_test.go

@@ -1378,6 +1378,61 @@ func TestQuit(t *testing.T) {
 		})
 	}
 }
+
+func TestQuitWithHelp(t *testing.T) {
+	fm, err := NewFlagManager(flagsPath)
+
+	if err != nil {
+		t.Logf(err.Error())
+	}
+	flag_account_authorized, _ := fm.parser.GetFlag("flag_account_authorized")
+
+	mockDataStore := new(mocks.MockUserDataStore)
+	mockCreateAccountService := new(mocks.MockAccountService)
+
+	sessionId := "session123"
+
+	ctx := context.WithValue(context.Background(), "SessionId", sessionId)
+
+	h := &Handlers{
+		userdataStore:  mockDataStore,
+		accountService: mockCreateAccountService,
+		flagManager:    fm.parser,
+	}
+	tests := []struct {
+		name           string
+		input          []byte
+		status         string
+		expectedResult resource.Result
+	}{
+		{
+			name: "Test quit with help message",
+			expectedResult: resource.Result{
+				FlagReset: []uint32{flag_account_authorized},
+				Content:   "For more help,please call: 0757628885",
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+
+			// Call the method under test
+			res, _ := h.QuitWithHelp(ctx, "test_quit with help", tt.input)
+
+			// Assert that no errors occurred
+			assert.NoError(t, err)
+
+			//Assert that the account created flag has been set to the result
+			assert.Equal(t, res, tt.expectedResult, "Expected result should be equal to the actual result")
+
+			// Assert that expectations were met
+			mockDataStore.AssertExpectations(t)
+
+		})
+	}
+}
+
 func TestIsValidPIN(t *testing.T) {
 	tests := []struct {
 		name     string

internal/utils/db.go

@@ -22,6 +22,7 @@ const (
 	DATA_OFFERINGS
 	DATA_RECIPIENT
 	DATA_AMOUNT
+	DATA_TEMPORARY_PIN
 )
 
 func typToBytes(typ DataTyp) []byte {

services/registration/confirm_pin_change

@@ -0,0 +1 @@
+Confirm your new PIN:

services/registration/confirm_pin_change.vis

@@ -0,0 +1,7 @@
+LOAD verify_pin 0
+MOUT back 0
+HALT
+RELOAD verify_pin
+CATCH  create_pin_mismatch flag_pin_mismatch 1
+MOVE pin_reset_success
+INCMP _ 0

services/registration/help.vis

@@ -0,0 +1,2 @@
+LOAD quit_with_help 0
+HALT

services/registration/invalid_pin

@@ -0,0 +1 @@
+The PIN you entered is invalid.The PIN must be different from your current PIN.For help call +254757628885

services/registration/invalid_pin.vis

@@ -0,0 +1,4 @@
+MOUT back 0
+HALT
+INCMP _ 0
+

services/registration/locale/swa/default.po

@@ -6,3 +6,6 @@ msgstr "Ombi lako limetumwa. %s atapokea %s kutoka kwa %s."
 
 msgid "Thank you for using Sarafu. Goodbye!"
 msgstr "Asante kwa kutumia huduma ya Sarafu. Kwaheri!"
+
+msgid "For more help,please call: 0757628885"
+msgstr "Kwa usaidizi zaidi,piga: 0757628885"

services/registration/main.vis

@@ -10,6 +10,6 @@ HALT
 INCMP send 1
 INCMP quit 2
 INCMP my_account 3
-INCMP quit 4
+INCMP help 4
 INCMP quit 9
 INCMP . *

services/registration/new_pin

@@ -0,0 +1 @@
+Enter a new four number pin

services/registration/new_pin.vis

@@ -0,0 +1,7 @@
+LOAD save_temporary_pin 0
+MOUT back 0
+HALT
+RELOAD save_temporary_pin
+CATCH invalid_pin flag_incorrect_pin 1
+INCMP _ 0
+MOVE confirm_pin_change 

services/registration/old_pin

@@ -0,0 +1 @@
+Enter your old PIN

services/registration/old_pin.vis

@@ -0,0 +1,9 @@
+LOAD authorize_account 6
+MOUT back 0
+HALT
+RELOAD authorize_account
+CATCH incorrect_pin flag_incorrect_pin 1
+MOVE new_pin
+INCMP _ 0
+
+

services/registration/pin_management.vis

@@ -4,3 +4,4 @@ MOUT guard_pin 3
 MOUT back 0
 HALT
 INCMP _ 0
+INCMP old_pin  1

services/registration/pin_reset_success

@@ -0,0 +1 @@
+Your PIN change request has been successful

services/registration/pin_reset_success.vis

@@ -0,0 +1,6 @@
+LOAD confirm_pin_change 0
+MOUT back 0
+MOUT quit 9
+HALT
+INCMP _ 0
+INCMP quit 9