Show IP & details on endpoints

Author: s3m3dov

.gitignore

@@ -3,8 +3,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
+# C extensions & Java Class files
 *.so
+*.class
 
 # Distribution / packaging
 .Python
@@ -55,9 +56,14 @@ coverage.xml
 *.mo
 *.pot
 
+# Docker
+docker-compose-*.yml
+*.swp*
+*.save*
+*cache
+
 # Django stuff:
-*.log
-local_settings.py
+local*.py
 db.sqlite3
 db.sqlite3-journal
 
@@ -71,6 +77,11 @@ instance/
 # Sphinx documentation
 docs/_build/
 
+# Log files
+*.log
+log/
+logs/
+
 # PyBuilder
 target/
 
@@ -96,19 +107,25 @@ __pypackages__/
 
 # Celery stuff
 celerybeat-schedule
-celerybeat.pid
+*.pid
+*.bak
+*.dat
+*.dir
 
 # SageMath parsed files
 *.sage.py
 
 # Environments
-.env
-.venv
+.env*
+.venv*
 env/
 venv/
+venv*/
+env*/
 ENV/
-env.bak/
-venv.bak/
+*old
+*env
+virtualenv.bat
 
 # Spyder project settings
 .spyderproject
@@ -128,5 +145,28 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# Jetbeans IDE
-.idea/
+# Code Editor & IDE
+.vscode/
+.idea/
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Customer
+core/

README.md

@@ -7,28 +7,15 @@
 
 
 ## Initial Set-up ##
-### Virtual Environment ###
-```
-virtualenv .env
-```
-```
-source .env/bin/activate
-```
-
 ### Run using docker-compose ###
 * Make sure docker is running on your hardware
 ```
 docker-compose up -d --build
 ```
-* Go to [localhost](http://localhost:8000)
-
-### Install & Run Fast Api ###
-```
-pip install fastapi
-```
+or
 ```
-pip install "uvicorn[standard]"
+docker-compose -f docker-compose-local.yml up -d --build
 ```
-```
-uvicorn main:app --reload
-```
+* Go to [localhost](http://localhost:8000)
+
+### Install Ngrok for testing ###

docker-compose.yml

@@ -4,11 +4,12 @@ services:
   web:
     build: .
     command: bash -c "python main.py"
+    environment:
+      - IPDATA_API_KEY=test
     volumes:
       - .:/code
     ports:
       - "8000:8000"
-
     depends_on:
       - db
 
@@ -25,7 +26,6 @@ services:
       - MYSQL_PORT=3307
     ports:
       - "3307:3306"
-
     volumes:
       - mysql_data:/var/lib/mysql/
 

main.py

@@ -1,17 +1,36 @@
-import os, time
+import json
+import time
 from typing import List
 
+import aiohttp
 import uvicorn
-from fastapi import Depends, FastAPI, HTTPException
+from environs import Env
 
-from sql_app import crud, schemas, database, models
+# Environment
+env = Env()
+env.read_env()
+
+
+from fastapi import (
+    FastAPI,
+    HTTPException,
+    Depends,
+    Request
+)
+
+from sql_app import (
+    crud,
+    schemas,
+    database,
+    models
+)
 from sql_app.database import db_state_default
+from sql_app.utils import json_prettify
 
 database.db.connect()
 database.db.create_tables([models.User, models.Item])
 database.db.close()
 
-
 app = FastAPI()
 sleep_time = 10
 
@@ -41,6 +60,23 @@ async def say_hello(name: str):
     return {"message": f"Hello {name}"}
 
 
+@app.get("/my-ip")
+async def show_ip(request: Request):
+    client_host = request.client.host
+    return {"client_host": client_host}
+
+
+@app.get("/my-info")
+async def slow_route(request: Request):
+    client_ip = request.client.host
+    ipdata_key = env("IPDATA_API_KEY", default="test")  # Your Key Here
+    ipdata_url = f"https://api.ipdata.co/{client_ip}?api-key={ipdata_key}"
+    async with aiohttp.ClientSession() as session:
+        async with session.get(ipdata_url) as response:
+            json_dict = await response.json()
+    return json_prettify(json_dict)
+
+
 @app.post("/users/", response_model=schemas.User, dependencies=[Depends(get_db)])
 def create_user(user: schemas.UserCreate):
     db_user = crud.get_user_by_email(email=user.email)
@@ -93,4 +129,10 @@ def read_slow_users(skip: int = 0, limit: int = 100):
 
 # Run Fast API app
 if __name__ == "__main__":
-    uvicorn.run(app, host="0.0.0.0", port=8000)
+    uvicorn.run(
+        app,
+        host="0.0.0.0",
+        port=8000,
+        proxy_headers=True,
+        forwarded_allow_ips='*',
+    )

requirements.txt

@@ -6,3 +6,4 @@ contextvars~=2.4.0
 pymysql~=1.0.2
 cryptography~=36.0.1
 environs~=9.5.0
+aiohttp~=3.8.1

sql_app/utils.py

@@ -0,0 +1,13 @@
+import json
+
+
+def json_prettify(json_dict):
+    return json.loads(
+        json.dumps(
+            json_dict,
+            ensure_ascii=False,
+            allow_nan=False,
+            indent=4,
+            separators=(", ", ": "),
+        ).encode("utf-8")
+    )