pynkode/notebooks/Enrollment_Login_Renewal_Simplified.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "source": [
    "import sys\n",
    "import os\n",
    "sys.path.append(os.path.abspath('..'))  # Adds the parent directory to path\n",
    "from src.nkode_api import NKodeAPI\n",
    "from src.models import NKodePolicy, KeypadSize\n",
    "from src.utils import select_keys_with_passcode_values\n",
    "from secrets import choice\n",
    "from string import ascii_lowercase\n",
    "import numpy as np\n",
    "\n",
    "def random_username() -> str:\n",
    "    return \"test_username\" + \"\".join([choice(ascii_lowercase) for _ in range(6)])\n"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2025-03-24T20:18:04.947152Z",
     "start_time": "2025-03-24T20:18:04.916604Z"
    }
   },
   "outputs": [],
   "execution_count": 1
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": "## Initialize nKode API"
  },
  {
   "cell_type": "code",
   "source": [
    "api = NKodeAPI()\n",
    "policy = NKodePolicy(\n",
    "    max_nkode_len=10,\n",
    "    min_nkode_len=4,\n",
    "    distinct_positions=0,\n",
    "    distinct_properties=4,\n",
    ")\n",
    "keypad_size = KeypadSize(\n",
    "    numb_of_keys = 5,\n",
    "    props_per_key = 6\n",
    ")\n",
    "customer_id = api.create_new_customer(keypad_size, policy)\n",
    "customer = api.get_customer(customer_id)"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2025-03-24T20:18:04.960698Z",
     "start_time": "2025-03-24T20:18:04.950723Z"
    }
   },
   "outputs": [],
   "execution_count": 2
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "## nKode Enrollment\n",
    "Users enroll in three steps:\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-24T20:18:04.989029Z",
     "start_time": "2025-03-24T20:18:04.986797Z"
    }
   },
   "cell_type": "code",
   "source": [
    "username = random_username()\n",
    "signup_session_id, set_signup_keypad = api.generate_signup_keypad(customer_id, username)"
   ],
   "outputs": [],
   "execution_count": 3
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### Set nKode\n",
    "The client receives `user_icons`, `set_signup_keypad`\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-24T20:18:04.997252Z",
     "start_time": "2025-03-24T20:18:04.995177Z"
    }
   },
   "cell_type": "code",
   "source": [
    "passcode_len = 4\n",
    "passcode_property_indices = np.random.choice(set_signup_keypad.reshape(-1), size=passcode_len, replace=False).tolist()\n",
    "selected_keys_set = select_keys_with_passcode_values(passcode_property_indices, set_signup_keypad, keypad_size.numb_of_keys)"
   ],
   "outputs": [],
   "execution_count": 4
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### Confirm nKode\n",
    "Submit the set key entry to render the confirm keypad."
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-24T20:18:05.239384Z",
     "start_time": "2025-03-24T20:18:05.002825Z"
    }
   },
   "cell_type": "code",
   "source": [
    "confirm_keypad = api.set_nkode(username, customer_id, selected_keys_set, signup_session_id)\n",
    "selected_keys_confirm = select_keys_with_passcode_values(passcode_property_indices, confirm_keypad, keypad_size.numb_of_keys)\n",
    "success = api.confirm_nkode(username, customer_id, selected_keys_confirm, signup_session_id)\n",
    "assert success"
   ],
   "outputs": [],
   "execution_count": 5
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### User Login\n",
    "1. Get login keypad\n",
    "2. Select keys with passcode icons (in our case, passcode property indices)\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-24T20:18:05.478978Z",
     "start_time": "2025-03-24T20:18:05.245767Z"
    }
   },
   "cell_type": "code",
   "source": [
    "login_keypad = api.get_login_keypad(username, customer_id)\n",
    "selected_keys_login = select_keys_with_passcode_values(passcode_property_indices, login_keypad, keypad_size.props_per_key)\n",
    "success = api.login(customer_id, username, selected_keys_login)\n",
    "assert success"
   ],
   "outputs": [],
   "execution_count": 6
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "## Renew Properties\n",
    "1. Renew Customer Properties\n",
    "2. Renew User Keys\n",
    "3. Refresh User on Login\n",
    "\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-24T20:18:05.950627Z",
     "start_time": "2025-03-24T20:18:05.484941Z"
    }
   },
   "cell_type": "code",
   "source": [
    "api.renew_keys(customer_id) # Steps 1 and 2\n",
    "login_keypad = api.get_login_keypad(username, customer_id)\n",
    "selected_keys_login = select_keys_with_passcode_values(passcode_property_indices, login_keypad, keypad_size.props_per_key)\n",
    "success = api.login(customer_id, username, selected_keys_login) # Step 3\n",
    "assert success"
   ],
   "outputs": [],
   "execution_count": 7
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.6"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}