shopyo-auth 1.0.0__tar.gz

shopyo_auth-1.0.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.1
+Name: shopyo_auth
+Version: 1.0.0
+Summary: Base module containing jinja macros and templates
+Author-email: Abdur-Rahmaan Janhangeer <arj.python@gmail.com>
+Project-URL: Homepage, https://github.com/shopyo/shopyo
+Project-URL: Bug Tracker, https://github.com/shopyo/shopyo/issues
+Keywords: shopyo
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Requires-Dist: shopyo

shopyo_auth-1.0.0/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "shopyo_auth"
+authors = [{ name = "Abdur-Rahmaan Janhangeer", email = "arj.python@gmail.com" }]
+description = "Base module containing jinja macros and templates"
+# readme = "README.md"
+requires-python = ">=3.8"
+# license = { file = "LICENSE.txt" }
+keywords = ["shopyo"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+]
+dependencies = ["shopyo"]
+dynamic = ["version"]
+
+[tool.setuptools.dynamic]
+version = { attr = "shopyo_auth.__version__" }
+
+[project.urls]
+"Homepage" = "https://github.com/shopyo/shopyo"
+"Bug Tracker" = "https://github.com/shopyo/shopyo/issues"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+exclude = ["tests*", "docs*", "examples*"]
+
+[tool.setuptools.package-data]
+shopyo_auth = ["static/**", "templates/**", "*.json"]

shopyo_auth-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

shopyo_auth-1.0.0/shopyo_auth/__init__.py

@@ -0,0 +1,20 @@
+from typing import Any
+
+from flask import Flask
+from .view import module_blueprint
+
+__version__ = "1.0.0"
+
+
+class ShopyoAuth:
+    def __init__(self, app: Any = None) -> None:
+        if app is not None:
+            self.init_app(app)
+
+    def init_app(self, app: Flask) -> None:
+        if not hasattr(app, "extensions"):
+            app.extensions = {}
+
+        app.extensions["shopyo_auth"] = self
+        bp = module_blueprint
+        app.register_blueprint(bp)

shopyo_auth-1.0.0/shopyo_auth/decorators.py

@@ -0,0 +1,15 @@
+from functools import wraps
+
+from flask import redirect
+from flask import url_for
+from flask_login import current_user
+
+
+def check_confirmed(func):
+    @wraps(func)
+    def decorated_function(*args, **kwargs):
+        if current_user.is_email_confirmed:
+            return func(*args, **kwargs)
+        return redirect(url_for("auth.unconfirmed"))
+
+    return decorated_function

shopyo_auth-1.0.0/shopyo_auth/forms.py

@@ -0,0 +1,71 @@
+from flask_wtf import FlaskForm
+from sqlalchemy import func
+from wtforms import PasswordField
+from wtforms.fields import EmailField
+from wtforms.validators import DataRequired
+from wtforms.validators import Email
+from wtforms.validators import EqualTo
+from wtforms.validators import InputRequired
+from wtforms.validators import Length
+from wtforms.validators import ValidationError
+
+
+class LoginForm(FlaskForm):
+    email = EmailField(
+        "email",
+        [DataRequired(), Email(message="Not a valid email address.")],
+        render_kw={"class": "form-control", "autocomplete": "off"},
+    )
+    password = PasswordField(
+        "Password",
+        [DataRequired()],
+        render_kw={"class": "form-control", "autocomplete": "off"},
+    )
+
+
+class RegistrationForm(FlaskForm):
+    """Registration Form"""
+
+    email = EmailField(
+        "email_label",
+        [DataRequired(), Email(message="Not a valid email address.")],
+    )
+
+    password = PasswordField(
+        "New Password",
+        validators=[
+            InputRequired("Password is required"),
+            Length(
+                min=6,
+                max=25,
+                message="Password must be between 6 and 25 characters",
+            ),
+            EqualTo("confirm", message="Passwords must match"),
+        ],
+    )
+    confirm = PasswordField(
+        "Repeat Password",
+    )
+
+    def validate_email(self, field):
+        """
+        Inline validator for email. Checks to see if a user object with
+        entered email already present in the database
+
+        Args:
+            field : The form field that contains email data.
+
+        Raises:
+            ValidationError: if the username entered in the field is already
+            in the database
+        """
+        try:
+            from .models import User
+        except Exception as e:
+            raise e
+        user = User.query.filter(
+            func.lower(User.email) == func.lower(field.data)
+        ).scalar()
+
+        if user is not None:
+            raise ValidationError(f"email '{field.data}' is already in use.")

shopyo_auth-1.0.0/shopyo_auth/info.json

@@ -0,0 +1,7 @@
+{
+	"display_string": "Login",
+	"type": "hidden",
+	"fa-icon": "fas fa-clock",
+	"module_name": "shopyo_auth",
+	"url_prefix": "/shopyo-auth"
+}

shopyo_auth-1.0.0/shopyo_auth/models.py

@@ -0,0 +1,150 @@
+"""
+.. module:: AdminModels
+   :synopsis: Contains model of a user Record
+
+"""
+
+import datetime
+
+from flask import current_app
+from flask_login import AnonymousUserMixin
+from flask_login import UserMixin
+
+from init import db
+from init import login_manager
+
+from itsdangerous import URLSafeTimedSerializer
+from sqlalchemy.ext.hybrid import hybrid_property
+from werkzeug.security import check_password_hash
+from werkzeug.security import generate_password_hash
+
+from shopyo.api.models import PkModel
+
+role_user_bridge = db.Table(
+    "role_user_bridge",
+    db.Column(
+        "user_id",
+        db.Integer(),
+        db.ForeignKey("users.id", ondelete="CASCADE"),
+        primary_key=True,
+    ),
+    db.Column(
+        "role_id",
+        db.Integer(),
+        db.ForeignKey("roles.id", ondelete="CASCADE"),
+        primary_key=True,
+    ),
+)
+
+
+class AnonymousUser(AnonymousUserMixin):
+    """Anonymous user class"""
+
+    def __init__(self):
+        self.username = "guest"
+        self.email = "<anonymous-user-no-email>"
+
+    @property
+    def is_email_confirmed(self):
+        is_disabled = False
+
+        if "EMAIL_CONFIRMATION_DISABLED" in current_app.config:
+            is_disabled = current_app.config["EMAIL_CONFIRMATION_DISABLED"]
+
+            if is_disabled is not True:
+                is_disabled = False
+
+        return is_disabled
+
+    @property
+    def is_admin(self):
+        return False
+
+    def __repr__(self):
+        return f"<AnonymousUser {self.username}>"
+
+
+login_manager.anonymous_user = AnonymousUser
+
+
+class User(UserMixin, PkModel):
+    """The user of the app"""
+
+    __tablename__ = "users"
+
+    username = db.Column(db.String(100), unique=True)
+    _password = db.Column(db.String(128), nullable=False)
+    first_name = db.Column(db.String(128))
+    last_name = db.Column(db.String(128))
+    is_admin = db.Column(db.Boolean, default=False)
+    email = db.Column(db.String(120), unique=True, nullable=False)
+    date_registered = db.Column(
+        db.DateTime, nullable=False, default=datetime.datetime.now()
+    )
+    is_email_confirmed = db.Column(db.Boolean(), nullable=False, default=False)
+    email_confirm_date = db.Column(db.DateTime)
+
+    # A user can have many roles and a role can have many users
+    roles = db.relationship(
+        "Role",
+        secondary=role_user_bridge,
+        backref="users",
+    )
+
+    def __repr__(self):
+        return f"<User-id: {self.id}, User-email: {self.email}>"
+
+    @hybrid_property
+    def password(self):
+        return self._password
+
+    @password.setter
+    def password(self, plaintext):
+        # the default hashing method is pbkdf2:sha256
+        self._password = generate_password_hash(plaintext)
+
+    def check_password(self, password):
+        return check_password_hash(self._password, password)
+
+    def generate_confirmation_token(self):
+        serializer = URLSafeTimedSerializer(current_app.config["SECRET_KEY"])
+        return serializer.dumps(self.email, salt=current_app.config["PASSWORD_SALT"])
+
+    def confirm_token(self, token, expiration=3600):
+        serializer = URLSafeTimedSerializer(current_app.config["SECRET_KEY"])
+        email = False
+        try:
+            email = serializer.loads(
+                token,
+                salt=current_app.config["PASSWORD_SALT"],
+                max_age=expiration,
+            )
+        except Exception as e:
+            print(f"\nShopyo-LOG, Error at confirm_token: {e}")
+            return False
+
+        if email != self.email:
+            return False
+
+        self.is_email_confirmed = True
+        self.email_confirm_date = datetime.datetime.now()
+        self.update()
+        return True
+
+
+@login_manager.user_loader
+def load_user(user_id):
+    return User.query.get(user_id)
+
+
+login_manager.login_view = "shopyo_auth.login"
+
+
+class Role(PkModel):
+    """A role for a user."""
+
+    __tablename__ = "roles"
+    name = db.Column(db.String(100), nullable=False)
+
+    def __repr__(self):
+        return f"<Role-id: {self.id}, Role-name: {self.name}>"

shopyo_auth-1.0.0/shopyo_auth/static/style.css

@@ -0,0 +1,7 @@
+/* for styling WTform errors*/
+.form-errors {
+    list-style-type: none;
+    padding: 0px;
+    margin: 0px;
+    color: red;
+}

shopyo_auth-1.0.0/shopyo_auth/templates/shopyo_auth/blocks/login_form.html

@@ -0,0 +1,36 @@
+
+<p class="h2">Login</p>
+<div class="input-group mb-3">
+    <div class="input-group-prepend">
+        <span class="input-group-text"><i class="fa fa-id-card"></i></span>
+    </div>
+    {{ form.email() }}
+    {% if form.email.errors %}
+        <ul class="errors">
+            {% for error in form.user_id.errors %}
+	            <li>{{ error }}</li>
+            {% endfor %}
+        </ul>
+    {% endif %}
+</div>
+<div class="input-group mb-3">
+    <div class="input-group-prepend">
+        <span class="input-group-text"><i class="fa fa-key"></i></span>
+    </div>
+    {{ form.password() }}
+    {% if form.password.errors %}
+        <ul class="errors">
+            {% for error in form.password.errors %}
+	            <li>{{ error }}</li>
+            {% endfor %}
+        </ul>
+    {% endif %}
+</div>
+<input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
+
+<input
+    type="hidden"
+    name="next"
+    value="{{ request.args.get('next', '') }}"
+/>
+<input type="submit" name="" value="submit" class="btn btn-info">

shopyo_auth-1.0.0/shopyo_auth/templates/shopyo_auth/blocks/register_form.html

@@ -0,0 +1,44 @@
+<p class="h2">Register</p>
+
+<div class="form-group">
+    <div class="input-group mb-3">
+        <div class="input-group-prepend">
+            <span class="input-group-text"><i class="fa fa-id-card"></i></span>
+        </div>
+        {{ form.email(class_="form-control", placeholder="Email", autocomplete="off", autofocus=true) }}
+    </div>
+    <ul class="form-errors">
+        {% for error in form.email.errors %}
+            <li>{{ error }}</li>
+        {% endfor %}
+    </ul>
+</div>
+<div class="form-group">
+    <div class="input-group mb-3">
+        <div class="input-group-prepend">
+            <span class="input-group-text"><i class="fa fa-key"></i></span>
+        </div>
+        {{ form.password(class_="form-control", placeholder="Password") }}
+    </div>
+    <ul class="form-errors">
+        {% for error in form.password.errors %}
+            <li>{{ error }}</li>
+        {% endfor %}
+    </ul>
+</div>
+<div class="form-group">
+    <div class="input-group mb-3">
+        <div class="input-group-prepend">
+            <span class="input-group-text"><i class="fa fa-key"></i></span>
+        </div>
+        {{ form.confirm(class_="form-control", placeholder="Confirm Password") }}
+    </div>
+    <ul class="form-errors">
+        {% for error in form.confirm.errors %}
+            <li>{{ error }}</li>
+        {% endfor %}
+    </ul>
+</div>
+
+<input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
+<input type="submit" name="" value="register" class="btn btn-info">

shopyo_auth-1.0.0/shopyo_auth/templates/shopyo_auth/emails/activate_user.html

@@ -0,0 +1,16 @@
+<p>Dear {{ user.email }},</p>
+
+<p>Welcome to <b>Shopyo</b>!</p>
+
+<p>
+    To confirm your account please <a href="{{ url_for('auth.confirm', token=token, _external=True) }}">click here</a>.
+</p>
+
+<p>Alternatively, you can paste the following link in your browser's address bar:</p>
+<p>{{ url_for('auth.confirm', token=token, _external=True) }}</p>
+
+<p>Sincerely,</p>
+
+<p>The Shopyo Team</p>
+
+<p><small>Note: replies to this email address are not monitored.</small></p>

shopyo_auth-1.0.0/shopyo_auth/templates/shopyo_auth/emails/activate_user.txt

@@ -0,0 +1,13 @@
+Dear {{ user.email }},
+
+Welcome to Shopyo!
+
+To confirm your account please click on the following link:
+
+{{ url_for('auth.confirm', token=token, _external=True) }}
+
+Sincerely,
+
+The Shopyo Team
+
+Note: replies to this email address are not monitored.

shopyo_auth-1.0.0/shopyo_auth/templates/shopyo_auth/login.html

@@ -0,0 +1,46 @@
+{% extends "shopyo_base/main_base.html" %}
+
+{% set active_page = "login" %}
+{% block pagehead %}
+	<title>{{active_page.capitalize()}}</title>
+	<style>
+        .hidden {
+            display: none;
+        }
+
+        .show {
+            display: inline-block;
+        }
+
+        .active {
+            width: 6rem;
+            color: white;
+            background-color: #34ce57;
+        }
+
+        .inactive {
+            width: 6rem;
+            color: white;
+            background-color: #ff253a;
+        }
+
+        .all_inactive {
+            display: none;
+        }
+    </style>
+
+{% endblock %}
+{% block content %}
+
+	<div class="container col-md-6 off-set-2 text-center test">
+        <div class="card">
+            <div class="card-body">
+                <img src="/static/shopyo.svg" width="175" height="150">
+                <form action="{{url_for('shopyo_auth.login')}}" method="POST">
+                    {%include 'shopyo_auth/blocks/login_form.html'%}
+                </form>
+            </div>
+        </div>
+    </div>
+
+{% endblock %}

shopyo_auth-1.0.0/shopyo_auth/templates/shopyo_auth/register.html

@@ -0,0 +1,26 @@
+{% extends "shopyo_base/main_base.html" %}
+
+{% set active_page = "register" %}
+
+{% block pagehead %}
+    <link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='modules/box__default/auth/style.css') }}">
+    <title>{{ active_page.capitalize() }}</title>
+{% endblock %}
+
+{% block content %}
+	<div class="container col-md-6 mb-4 off-set-2 text-center">
+        <div class="card">
+            <div class="card-body">
+                <img src="/static/shopyo.svg" width="175" height="150">
+                <form action="{{url_for('shopyo_auth.register')}}" method="post">
+                    {%include 'auth/blocks/register_form.html'%}
+                </form>
+                <hr>
+                <span class="text-muted">
+                    Have already registered?
+                    <a href="{{ url_for('shopyo_auth.login') }}">Sign in here</a>
+                </span>
+            </div>
+        </div>
+    </div>
+{% endblock %}

shopyo_auth-1.0.0/shopyo_auth/templates/shopyo_auth/shop_login.html

@@ -0,0 +1,19 @@
+{%set active_page = 'shop.html'%}
+{% extends "shop/base.html" %}
+{% block pagehead %}
+
+{% endblock %}
+{% block content %}
+<div class="shop-spacer-1">
+</div>
+<div class="container">
+    <div class="card">
+        <div class="card-body">
+            <form action="{{ url_for('auth.shop_login') }}" method="post">
+                 {%include 'auth/blocks/login_form.html'%}
+            </form>
+        </div>
+    </div>
+
+</div>
+    {% endblock %}

shopyo_auth-1.0.0/shopyo_auth/templates/shopyo_auth/unconfirmed.html

@@ -0,0 +1,19 @@
+{% extends "shopyo_base/main_base.html" %}
+
+{% set active_page = "Email Confirmation" %}
+
+{% block pagehead %}
+    <title>{{ active_page.capitalize() }}</title>
+{% endblock %}
+
+{% block content %}
+	<div class="container col-md-6 mb-4 off-set-2 text-center">
+        <div class="card">
+            <div class="card-body">
+                <img src="/static/shopyo.svg" width="175" height="150">
+                <p>You have not confirmed your account. Email confirmation link was sent to <span class="mark">{{ current_user.email }}</span>. Please check your inbox and your spam folder.</p>
+                <p>Didn't get the email?<a href="{{ url_for('auth.resend',_external=True) }}"> Resend</a></p>
+            </div>
+        </div>
+    </div>
+{% endblock %}

shopyo_auth-1.0.0/shopyo_auth/upload.py

@@ -0,0 +1,23 @@
+import datetime
+import json
+
+from .models import User
+
+
+def add_admin(email, password):
+    user = User()
+    user.email = email
+    user.password = password
+    user.is_admin = True
+    user.is_email_confirmed = True
+    user.email_confirm_date = datetime.datetime.now()
+    user.save()
+
+
+def upload(verbose=False):
+    with open("config.json") as config:
+        config = json.load(config)
+        add_admin(config["admin_user"]["email"], config["admin_user"]["password"])
+
+        if verbose:
+            print("[x] Added Admin User")