19072021.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "source": [
    "# **Date: 19/07/2021 Day: 5**\r\n",
    "# **Title: Intro to REST API**"
   ],
   "metadata": {}
  },
  {
   "cell_type": "markdown",
   "source": [
    "## **Task:**\r\n",
    "\r\n",
    "### Using public open API website  https://gorest.co.in/, create a python code which can visualize the list users in pandas data frame format and allows option to create new user and delete user. At last at the of the code execution, print a data frame with all actions performed in the python execution cycle."
   ],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "source": [
    "#Importing all the required modules\r\n",
    "from dotenv import load_dotenv\r\n",
    "load_dotenv()\r\n",
    "import requests\r\n",
    "from requests.auth import HTTPBasicAuth\r\n",
    "import pandas as pd\r\n",
    "import os\r\n",
    "import json\r\n",
    "import sys\r\n",
    "from datetime import datetime as dt"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "source": [
    "#Declaring ENVs and Global Variables\r\n",
    "output=os.getenv('OUTPUT')\r\n",
    "auth_key=os.getenv('AUTH_KEY')\r\n",
    "logcat=[]"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "source": [
    "#Function for logging the action done by the user\r\n",
    "def logs(time,method,function,docs,status,msg,output):\r\n",
    "    '''Maintains log info about a particular method'''\r\n",
    "    global logcat\r\n",
    "    logcat.append(dict(time=time,http_method=method,function=function,description=docs,status_code=status,message=msg,output=output))"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "source": [
    "#Gets data of all the users in the gorest.co.in website and storing it to csv and json\r\n",
    "def get_all_users():\r\n",
    "    '''Get the ID, Name, Email, Gender, Status information of all users in the complete database'''\r\n",
    "    try:\r\n",
    "        print(\"This method takes long time to finish due to huge data! 🕐\")\r\n",
    "        all_users=[]\r\n",
    "        r=requests.get(f'https://gorest.co.in/public/v1/users')\r\n",
    "        print(f\"Getting Data from Pages... 🐌\")\r\n",
    "        for i in range(1,(r.json()[\"meta\"][\"pagination\"][\"pages\"])+1):\r\n",
    "            temp=requests.get(f'https://gorest.co.in/public/v1/users?page={i}')\r\n",
    "            temp=temp.json()\r\n",
    "            for j in temp[\"data\"]:\r\n",
    "                all_users.append(dict(id=j[\"id\"],name=j[\"name\"],email=j[\"email\"],gender=j[\"gender\"],status=j[\"status\"]))\r\n",
    "        print(f\"Successfully Retrieved ✅\")\r\n",
    "        with open(os.path.join(output,'all_users.json'),'w') as aa:\r\n",
    "            aa.write(json.dumps(all_users,indent=2))\r\n",
    "        df=pd.read_json(os.path.join(output,'all_users.json'))\r\n",
    "        df.to_csv(os.path.join(output,'all_users.csv'),index=False)\r\n",
    "        op=\"All User Data Extracted, please find the file at .\\output\\\\all_users.json\"\r\n",
    "        print(op)\r\n",
    "    finally:\r\n",
    "        logs(dt.now(),'GET',get_all_users.__name__,get_all_users.__doc__,r.status_code,op,\"Its a huge output Find file at .\\output\\\\all_users.csv\")"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "source": [
    "#Get details of a particular user\r\n",
    "def get_user(email):\r\n",
    "    '''Get User details based on Email'''\r\n",
    "    try:\r\n",
    "        r=requests.get(f'https://gorest.co.in/public/v1/users?email={email}')\r\n",
    "        if r.status_code==200:\r\n",
    "            if r.json()[\"data\"]==[]:\r\n",
    "                op=\"No User Found ❌\"\r\n",
    "                print(op)\r\n",
    "            else:\r\n",
    "                op=\"Data Successfully Retrieved ✅\"\r\n",
    "                print(op)\r\n",
    "                print(json.dumps(r.json()[\"data\"],indent=4))\r\n",
    "        elif r.status_code>=400:\r\n",
    "            op=f\"Error Code: {r.status_code}\"\r\n",
    "            print(op)\r\n",
    "            print(json.dumps(r.json()[\"data\"],indent=4))\r\n",
    "    finally:\r\n",
    "        logs(dt.now(),'GET',get_user.__name__,get_user.__doc__,r.status_code,op,r.json()[\"data\"])\r\n"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "source": [
    "#Create a new user to DB\r\n",
    "def create_user(name,email,gender,status):\r\n",
    "    '''Creating a new user to DB'''\r\n",
    "    payload={\r\n",
    "    \"access-token\": auth_key,\r\n",
    "    \"name\": name,\r\n",
    "    \"email\": email,\r\n",
    "    \"gender\": gender,\r\n",
    "    \"status\": status\r\n",
    "    }\r\n",
    "    try:\r\n",
    "        r=requests.post('https://gorest.co.in/public/v1/users',data=payload)\r\n",
    "        if r.status_code==201:\r\n",
    "            op=f\"🆕 🧑🏽 User {name} Successfully Created ✅\"\r\n",
    "            print(op)\r\n",
    "            print(json.dumps(r.json()[\"data\"],indent=4))\r\n",
    "        elif r.status_code>=400:\r\n",
    "            op=f\"Error Code: {r.status_code}\"\r\n",
    "            print(op)\r\n",
    "            print(json.dumps(r.json()[\"data\"],indent=4))\r\n",
    "    finally:\r\n",
    "        logs(dt.now(),'POST',create_user.__name__,create_user.__doc__,r.status_code,op,r.json()[\"data\"])"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "source": [
    "def delete_user(email):\r\n",
    "    '''Deleting a new user in the DB'''\r\n",
    "    payload={\r\n",
    "    \"access-token\": auth_key\r\n",
    "    }\r\n",
    "    try:\r\n",
    "        r=requests.get(f'https://gorest.co.in/public/v1/users?email={email}')\r\n",
    "        if r.status_code==200:\r\n",
    "            if r.json()[\"data\"]==[]:\r\n",
    "                op=\"No User Found ❌\\nCan't Be Deleted 🗑\"\r\n",
    "                print(op)\r\n",
    "            else:\r\n",
    "                r=requests.delete(f'https://gorest.co.in/public/v1/users/{r.json()[\"data\"][0][\"id\"]}',data=payload)\r\n",
    "                if r.status_code==204:\r\n",
    "                    op=\"User Successfully Found ✅ and Deleted 🗑\"\r\n",
    "                    print(op)\r\n",
    "                elif r.status_code>=400:\r\n",
    "                    op=f\"Error Code: {r.status_code}\"\r\n",
    "                    print(op)\r\n",
    "        elif r.status_code>=400:\r\n",
    "            op=f\"Error Code: {r.status_code}\"\r\n",
    "            print(op)\r\n",
    "            print(json.dumps(r.json()[\"data\"],indent=4))\r\n",
    "    finally:\r\n",
    "        logs(dt.now(),'DELETE',delete_user.__name__,delete_user.__doc__,r.status_code,op,op)"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "source": [
    "def update_user(email):\r\n",
    "    ''''Updates name,email,gender,status of already existing data in the DB'''\r\n",
    "    try:\r\n",
    "        r=requests.get(f'https://gorest.co.in/public/v1/users?email={email}')\r\n",
    "        if r.status_code==200:\r\n",
    "            if r.json()[\"data\"]==[]:\r\n",
    "                op=\"No User Found ❌\\nSo Can't Be Updated 🗑\"\r\n",
    "                print(op)\r\n",
    "            else:\r\n",
    "                op=\"User Successfully Found ✅\"\r\n",
    "                print(op)\r\n",
    "                print(json.dumps(r.json()[\"data\"],indent=4))\r\n",
    "                print(\"\\nEnter Updated details: \")\r\n",
    "                name=str(input(\"Please enter Name: \"))\r\n",
    "                email=str(input(\"Please enter Email: \"))\r\n",
    "                gender=str(input(\"Please enter gender: \"))\r\n",
    "                status=str(input(\"Please enter status: \"))\r\n",
    "                payload={\r\n",
    "                    \"access-token\": auth_key,\r\n",
    "                    \"name\": name,\r\n",
    "                    \"email\": email,\r\n",
    "                    \"gender\": gender,\r\n",
    "                    \"status\": status\r\n",
    "                    }\r\n",
    "                r=requests.put(f'https://gorest.co.in/public/v1/users/{r.json()[\"data\"][0][\"id\"]}',data=payload)\r\n",
    "                if r.status_code<300:\r\n",
    "                    op=\"User Successfully Updated!! ❇❇\"\r\n",
    "                    print(op)\r\n",
    "                    print(json.dumps(r.json()[\"data\"],indent=4))\r\n",
    "                elif r.status_code>=400:\r\n",
    "                    op=f\"Error Code: {r.status_code}\"\r\n",
    "                    print(op)\r\n",
    "        elif r.status_code>=400:\r\n",
    "            op=f\"Error Code: {r.status_code}\"\r\n",
    "            print(op)\r\n",
    "            print(json.dumps(r.json()[\"data\"],indent=4))\r\n",
    "    finally:\r\n",
    "        logs(dt.now(),'UPDATE',update_user.__name__,update_user.__doc__,r.status_code,op,r.json()[\"data\"])"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "source": [
    "#Quit fn. that quits the program and saves logs\r\n",
    "def quit_prg():\r\n",
    "    print(\"Exporting Logs... 🧾🧾\")\r\n",
    "    global logcat\r\n",
    "    log_cat=pd.DataFrame(logcat)\r\n",
    "    log_cat.to_csv(os.path.join(output,'logs.csv'),index=False)\r\n",
    "    logcat=[]\r\n",
    "    print(\"Logs Exported Successfully! ✅\")\r\n",
    "    sys.exit(0)\r\n",
    "    "
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "source": [
    "#Driver Code\r\n",
    "def engine_start():\r\n",
    "    if not os.path.exists(output):\r\n",
    "        os.makedirs(output)\r\n",
    "    while(1):\r\n",
    "        print('''\\t1. Get all users in the database\r\n",
    "            2. Get details about particular user\r\n",
    "            3. Create a new User\r\n",
    "            4. Delete existing user\r\n",
    "            5. Update existing user details\r\n",
    "            6. Quit''')\r\n",
    "        choices=[1,2,3,4,5,6]\r\n",
    "        choice=int(input('\\nPlease enter your choice: '))\r\n",
    "        if choice==1:\r\n",
    "            get_all_users()\r\n",
    "        if choice==2:\r\n",
    "            get_user(str(input(\"Please enter Email address of the user to be found: \")))\r\n",
    "        if choice==3:\r\n",
    "            name=str(input(\"Please enter Name: \"))\r\n",
    "            email=str(input(\"Please enter Email: \"))\r\n",
    "            gender=str(input(\"Please enter gender: \"))\r\n",
    "            status=str(input(\"Please enter status: \"))\r\n",
    "            create_user(name,email,gender,status)\r\n",
    "        if choice==4:\r\n",
    "            delete_user(str(input(\"Please enter Email address of the user to be deleted: \")))\r\n",
    "        if choice==5:\r\n",
    "            update_user(str(input(\"Please enter Email address of the user to be updated: \")))\r\n",
    "        if choice==6:\r\n",
    "            quit_prg()\r\n",
    "        if choice not in choices:\r\n",
    "            print('Please enter a valid choice!!')\r\n",
    "            engine_start()"
   ],
   "outputs": [],
   "metadata": {}
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "source": [
    "engine_start()"
   ],
   "outputs": [
    {
     "output_type": "stream",
     "name": "stdout",
     "text": [
      "\t1. Get all users in the database\n",
      "            2. Get details about particular user\n",
      "            3. Create a new User\n",
      "            4. Delete existing user\n",
      "            5. Update existing user details\n",
      "            6. Quit\n",
      "This method takes long time to finish due to huge data! 🕐\n",
      "Getting Data from Pages... 🐌\n",
      "Successfully Retrieved ✅\n",
      "All User Data Extracted, please find the file at .\\output\\all_users.json\n",
      "\t1. Get all users in the database\n",
      "            2. Get details about particular user\n",
      "            3. Create a new User\n",
      "            4. Delete existing user\n",
      "            5. Update existing user details\n",
      "            6. Quit\n",
      "Error Code: 422\n",
      "[\n",
      "    {\n",
      "        \"field\": \"email\",\n",
      "        \"message\": \"has already been taken\"\n",
      "    }\n",
      "]\n",
      "\t1. Get all users in the database\n",
      "            2. Get details about particular user\n",
      "            3. Create a new User\n",
      "            4. Delete existing user\n",
      "            5. Update existing user details\n",
      "            6. Quit\n",
      "🆕 🧑🏽 User Post Malone Successfully Created ✅\n",
      "{\n",
      "    \"id\": 1530,\n",
      "    \"name\": \"Post Malone\",\n",
      "    \"email\": \"postmalone@gg.com\",\n",
      "    \"gender\": \"male\",\n",
      "    \"status\": \"active\"\n",
      "}\n",
      "\t1. Get all users in the database\n",
      "            2. Get details about particular user\n",
      "            3. Create a new User\n",
      "            4. Delete existing user\n",
      "            5. Update existing user details\n",
      "            6. Quit\n",
      "Data Successfully Retrieved ✅\n",
      "[\n",
      "    {\n",
      "        \"id\": 1530,\n",
      "        \"name\": \"Post Malone\",\n",
      "        \"email\": \"postmalone@gg.com\",\n",
      "        \"gender\": \"male\",\n",
      "        \"status\": \"active\"\n",
      "    }\n",
      "]\n",
      "\t1. Get all users in the database\n",
      "            2. Get details about particular user\n",
      "            3. Create a new User\n",
      "            4. Delete existing user\n",
      "            5. Update existing user details\n",
      "            6. Quit\n",
      "No User Found ❌\n",
      "\t1. Get all users in the database\n",
      "            2. Get details about particular user\n",
      "            3. Create a new User\n",
      "            4. Delete existing user\n",
      "            5. Update existing user details\n",
      "            6. Quit\n",
      "User Successfully Found ✅\n",
      "[\n",
      "    {\n",
      "        \"id\": 1530,\n",
      "        \"name\": \"Post Malone\",\n",
      "        \"email\": \"postmalone@gg.com\",\n",
      "        \"gender\": \"male\",\n",
      "        \"status\": \"active\"\n",
      "    }\n",
      "]\n",
      "\n",
      "Enter Updated details: \n",
      "Error Code: 422\n",
      "\t1. Get all users in the database\n",
      "            2. Get details about particular user\n",
      "            3. Create a new User\n",
      "            4. Delete existing user\n",
      "            5. Update existing user details\n",
      "            6. Quit\n",
      "Exporting Logs... 🧾🧾\n",
      "Logs Exported Successfully! ✅\n"
     ]
    },
    {
     "output_type": "error",
     "ename": "SystemExit",
     "evalue": "0",
     "traceback": [
      "An exception has occurred, use %tb to see the full traceback.\n",
      "\u001b[1;31mSystemExit\u001b[0m\u001b[1;31m:\u001b[0m 0\n"
     ]
    },
    {
     "output_type": "stream",
     "name": "stderr",
     "text": [
      "C:\\Users\\vijay\\anaconda3\\envs\\py37\\lib\\site-packages\\IPython\\core\\interactiveshell.py:3449: UserWarning: To exit: use 'exit', 'quit', or Ctrl-D.\n",
      "  warn(\"To exit: use 'exit', 'quit', or Ctrl-D.\", stacklevel=1)\n"
     ]
    }
   ],
   "metadata": {}
  }
 ],
 "metadata": {
  "orig_nbformat": 4,
  "language_info": {
   "name": "python",
   "version": "3.7.4",
   "mimetype": "text/x-python",
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "pygments_lexer": "ipython3",
   "nbconvert_exporter": "python",
   "file_extension": ".py"
  },
  "kernelspec": {
   "name": "python3",
   "display_name": "Python 3.7.4 64-bit ('py37': conda)"
  },
  "interpreter": {
   "hash": "a9fb0a45b40aef916b561b34e6bb4288a8db4d86c9a22cf65408b784b1f3a3e4"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}