Merge pull request larymak#334 from MBSA-INFINITY/url_shortening_app_flask

URL  Shortening Application in Flask #hacktoberfest

Author: larymak

FLASK PROJECTS/Url Shortening App in Flask/.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+/__pycache__
+.env
+client_secret.json
+do_not_commit

FLASK PROJECTS/Url Shortening App in Flask/README.md

@@ -0,0 +1,66 @@
+<!--Please do not remove this part-->
+![Star Badge](https://img.shields.io/static/v1?label=%F0%9F%8C%9F&message=If%20Useful&style=style=flat&color=BC4E99)
+![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)
+
+# URL Shortening Application in Flask
+
+## 🛠️ Description
+This project is about developing a url shortening application in **Flask** and **MongoDB**. User will paste their long URLs in this application and will get a shortened url, which will redirect to the same long url once used in a browser.
+
+## ⚙️ Languages or Frameworks Used
+ - Flask, MongoDB
+ - HTML, CSS, Bootstrap
+
+
+## 🌟 How to run
+ - ### Install all the requirements
+    Run `pip install -r requirements.txt` to install all the requirements.
+ - ### MongoDB Setup for Project
+
+   - Download monogdb from the [official website](https://www.mongodb.com/try/download/community) and setup in your local system for testing.
+   - Once it is setup locally, try creating documents and collections in mongodb to familiarize yourself with it.
+   - You can also download the `MongoDB Compass`, which is the GUI version of Mongo Shell.
+   - Once all the local testing is done, you can create a free cloud version of MongoDB in [MongoDB Atlas](https://www.mongodb.com/cloud/atlas/register) and get the following credentials from the dashboard of atlas:
+ ```bash
+export MONGO_URI=YOUR_MONGO_URI
+export MONGO_USERNAME=YOUR_MONGO_USERNAME
+export MONGO_PASSWORD=YOUR_MONGO_PASSWORD
+``` 
+     
+
+- ### Setup Environment for the project
+   - Now create a `.env` file in your project dreictory and include the following parameters as it is :-
+```bash
+export ENVIRONMENT=local | production (choose on the basis of local or production environment)
+export APP_SECRET=YOUR_APP_SECRET
+export APP_URL=YOUR_APP_URL (the short url)
+export MONGO_URI=YOUR_MONGO_URI
+export MONGO_USERNAME=YOUR_MONGO_USERNAME
+export MONGO_PASSWORD=YOUR_MONGO_PASSWORD
+export DB_NAME=YOUR_DATABASE_NAME
+``` 
+
+- ###  Now Just, Run the project
+  - To the run the project, go to the `bash` terminal of VSCode or any other code editor and run `./start_server.sh`.
+  - You don't have to care about setting `.env` then yourself then.
+
+
+## 📺 Demo
+- Main screen of the application.
+![image](https://github.com/MBSA-INFINITY/Python-project-Scripts/assets/85332648/94825306-1803-4e48-95d1-4f65bd94fcc1)
+- Paste you long URL in the input.
+![image](https://github.com/MBSA-INFINITY/Python-project-Scripts/assets/85332648/a5dd5bf5-b311-4d72-b84f-ebf197e30009)
+- Click on Shorten and copy the `short url` to clipboard
+![image](https://github.com/MBSA-INFINITY/Python-project-Scripts/assets/85332648/4eeb3d39-ddfe-48b0-9c2c-23ffe01036cd)
+
+
+
+## 🤖 Author
+
+Github - [MBSA-INFINITY](https://github.com/MBSA-INFINITY)
+LinkedIn - [MBSAIADITYA](https://www.linkedin.com/in/mbsaiaditya/)
+Portfolio - [MBSA](https://mbsaiaditya.in/)
+
+
+
+

FLASK PROJECTS/Url Shortening App in Flask/app.py

@@ -0,0 +1,65 @@
+from flask import Flask, request, render_template, redirect, flash
+from helpers import random_string_generator, random_string_generator_only_alpha, is_valid_url
+from db import url_data_collection
+import os
+from datetime import datetime
+
+
+app = Flask(__name__)
+app.secret_key = os.environ['APP_SECRET']
+
+url_ = os.environ['APP_URL']
+
+reserved_keywords = ['login', 'logout', 'shorten-url']
+
+
+@app.route("/", methods = ['GET'])
+def start():
+    return render_template("index.html")
+
+@app.route("/shorten-url", methods=['POST'])
+def shorten_url():
+    data = request.form
+    url_input = data.get("url_input")
+    data_id = random_string_generator_only_alpha(10)
+    if not is_valid_url(str(url_input)):
+        flash({'type':'error', 'data':"Inavlid URL"})
+        return redirect("/")
+    random_slug = random_string_generator(7)
+    shortened_url = f"{url_}/{random_slug}"
+    shortened_url_ = shortened_url[len(url_)+1:]
+    if shortened_url == url_input:
+        flash({'type':'error', 'data':"Infinite Redirect Error!"})
+        return redirect("/")
+    first_keyword = shortened_url_.split("/")[0]
+    if first_keyword in reserved_keywords:
+        flash({'type':'error', 'data':f"{first_keyword} is a reserved keyword! Please use any other word!"})
+        return redirect("/")
+    incoming_data = {
+        "no_of_/": shortened_url_.count("/"),
+        "order": shortened_url_.split("/"),
+        "redirect_url": url_input,
+        "shortened_url": shortened_url,
+        "data_id": data_id,
+        "created_at": datetime.now()
+    }
+    if url_details := url_data_collection.find_one({"no_of_/": incoming_data['no_of_/'], "order":incoming_data['order']}):
+        flash({'type':'error', 'data':"This Domain is Already Taken!"})
+        return redirect("/")
+    url_data_collection.insert_one(incoming_data)
+    flash({'type':'data', 'data':shortened_url})
+    return redirect("/")
+
+
+@app.before_request
+def before_request_func():
+    host_url = request.host_url
+    url = request.url
+    url = url[len(host_url):]
+    incoming_data = {
+        "no_of_/":url.count("/"),
+        "order":url.split("/")
+    }
+    if url_details := url_data_collection.find_one({"no_of_/": incoming_data['no_of_/'], "order":incoming_data['order']}):
+        redirect_url = url_details.get("redirect_url")
+        return redirect(redirect_url)

FLASK PROJECTS/Url Shortening App in Flask/db.py

@@ -0,0 +1,20 @@
+import os
+import pymongo
+
+ENVIRONMENT = os.environ["ENVIRONMENT"]
+if ENVIRONMENT == "local":
+    connection_string = "mongodb://localhost:27017"
+    DB_NAME = "url_shortener"
+else:    
+    MONGO_CLUSTER = os.environ["MONGO_URI"]
+    MONGO_USERNAME = os.environ["MONGO_USERNAME"]
+    MONGO_PASSWORD = os.environ["MONGO_PASSWORD"]
+    DB_NAME = os.environ["DB_NAME"]
+    connection_string = f"mongodb+srv://{MONGO_USERNAME}:{MONGO_PASSWORD}@{MONGO_CLUSTER}/?retryWrites=true&ssl=true&ssl_cert_reqs=CERT_NONE&w=majority"
+
+
+db_client = pymongo.MongoClient(connection_string)
+db_client = db_client.get_database(DB_NAME)
+
+url_data_collection = db_client['url_data']
+

FLASK PROJECTS/Url Shortening App in Flask/helpers.py

@@ -0,0 +1,26 @@
+import string
+import random
+import re
+
+def random_string_generator(N):
+    res = ''.join(random.choices(string.ascii_lowercase +
+                             string.digits, k=N))
+    return str(res)
+
+def random_string_generator_only_alpha(N):
+    res = ''.join(random.choices(string.ascii_lowercase +
+                             string.ascii_uppercase, k=N))
+    return str(res)
+
+
+def is_valid_url(url):
+    # Define a regular expression pattern to match URLs
+    url_pattern = re.compile(
+        r'^(https?|ftp)://'  # Match the scheme (http, https, or ftp)
+        r'(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+[A-Z]{2,6}\.?|'  # Match domain
+        r'localhost|'  # Match "localhost"
+        r'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})'  # Match IP address
+        r'(?::\d+)?'  # Match optional port number
+        r'(?:/?|[/?]\S+)$', re.IGNORECASE)
+
+    return bool(url_pattern.match(url))

FLASK PROJECTS/Url Shortening App in Flask/requirements.txt

@@ -0,0 +1,2 @@
+Flask==2.0.1
+pymongo[srv]==4.3.3

FLASK PROJECTS/Url Shortening App in Flask/run.py

@@ -0,0 +1,3 @@
+from app import app
+if __name__ == '__main__':
+    app.run(debug=True)

FLASK PROJECTS/Url Shortening App in Flask/start_server.sh

@@ -0,0 +1,2 @@
+source .env
+python run.py