splent-feature-github 0.1.0__py3-none-any.whl

splent_feature_github-0.1.0.dist-info/licenses/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

splent_feature_github-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+splent_io

splent_io/splent_feature_github/__init__.py

@@ -0,0 +1,30 @@
+from splent_framework.assets.asset_registry import register_asset
+from splent_framework.blueprints.base_blueprint import create_blueprint
+from splent_framework.refinement import refine_model
+from splent_framework.services.service_locator import register_service
+
+from splent_io.splent_feature_github.models import UserProfileGithubMixin
+from splent_io.splent_feature_github.services import (
+    GithubService,
+    register_github_client,
+)
+
+github_bp = create_blueprint(__name__)
+
+
+def init_feature(app):
+    from splent_io.splent_feature_github.config import inject_config
+
+    inject_config(app)
+    register_service(app, "GithubService", GithubService)
+    register_github_client(app)
+    refine_model("UserProfile", UserProfileGithubMixin)
+    # GitHub's colours on its button and its profile row, for the public
+    # shell. The app shell gets the same file through layout.head.css.
+    register_asset(
+        "css", "github.assets", order=100, subfolder="css", filename="github.css"
+    )
+
+
+def inject_context_vars(app):
+    return {}

splent_io/splent_feature_github/assets/css/github.css

@@ -0,0 +1,70 @@
+/* GitHub's colours, wherever the product draws GitHub: its sign-in button
+   on the login and sign-up pages, and the linked account on the profile
+   page.
+
+   The public shell loads this file from the asset registry and the app
+   shell through its layout.head.css slot, after their own stylesheets. A
+   product that wants another look overrides these selectors in a
+   stylesheet of its own. */
+
+/* The sign-in button. Every state is set, so the button stays GitHub's
+   whatever a shell does to a bare .btn on hover or focus. The variables are
+   the ones Bootstrap 5.3 reads, and the properties serve the shells that do
+   not read them. */
+.btn.btn-github,
+.btn.btn-github:hover,
+.btn.btn-github:focus,
+.btn.btn-github:focus-visible,
+.btn.btn-github:active {
+  --bs-btn-color: #fff;
+  --bs-btn-bg: #24292f;
+  --bs-btn-border-color: #24292f;
+  --bs-btn-hover-color: #fff;
+  --bs-btn-hover-bg: #1a1e23;
+  --bs-btn-hover-border-color: #1a1e23;
+  --bs-btn-active-color: #fff;
+  --bs-btn-active-bg: #1a1e23;
+  --bs-btn-active-border-color: #1a1e23;
+  color: #fff;
+  background-color: #24292f;
+  border-color: #24292f;
+}
+
+.btn.btn-github:hover,
+.btn.btn-github:focus-visible,
+.btn.btn-github:active {
+  background-color: #1a1e23;
+  border-color: #1a1e23;
+}
+
+/* The GitHub mark, drawn in currentColor. */
+.github-mark {
+  color: #212529;
+  flex-shrink: 0;
+}
+
+/* The profile row: the linked account in a field that reads as fixed, or a
+   link to connect one that looks like the same field. */
+.form-control.github-identity__field {
+  background-color: #f8f9fa;
+}
+
+.form-control.github-identity__connect {
+  color: #495057;
+  cursor: pointer;
+}
+
+.github-identity__value {
+  flex-grow: 1;
+}
+
+.btn.github-identity__disconnect,
+.btn.github-identity__disconnect:hover,
+.btn.github-identity__disconnect:focus,
+.btn.github-identity__disconnect:focus-visible,
+.btn.github-identity__disconnect:active {
+  background: none;
+  border: none;
+  color: #212529;
+  cursor: pointer;
+}

splent_io/splent_feature_github/config.py

@@ -0,0 +1,18 @@
+"""
+github feature configuration.
+
+The OAuth app registered at https://github.com/settings/developers.
+Without both values GitHub sign-in is disabled (the redirect fails and the
+user is sent back to the login page with a message).
+"""
+
+import os
+
+
+def inject_config(app):
+    app.config.update(
+        {
+            "GITHUB_CLIENT_ID": os.getenv("GITHUB_CLIENT_ID", ""),
+            "GITHUB_CLIENT_SECRET": os.getenv("GITHUB_CLIENT_SECRET", ""),
+        }
+    )

splent_io/splent_feature_github/hooks.py

@@ -0,0 +1,58 @@
+"""Template hooks for splent_feature_github.
+
+GitHub offers itself first on the login page (auth's auth.login.providers)
+and on the sign-up page when the product has one (signup's
+signup.providers). On the edit-profile page it shows the linked account, or
+a "Connect GitHub" link, first among the sections below the form
+(profile's profile.edit.sections).
+
+Every slot is filled by name, so a product without signup simply has no
+sign-up page to show the button on.
+
+GitHub's colours are in assets/css/github.css. The public shell loads it
+from the asset registry (see __init__.py), and the app shell, which does not
+render the registry, through its layout.head.css slot.
+"""
+
+from flask import render_template, request, url_for
+from flask_login import current_user
+from markupsafe import Markup
+
+from splent_framework.hooks.template_hooks import register_template_hook
+
+# Before ORCID, which takes 20, in every slot both of them fill.
+ORDER = 10
+
+
+def github_login_button():
+    from splent_io.splent_feature_auth.routes import safe_next_url
+
+    # The login and the sign-up both carry where the reader was heading, in
+    # the query string and, after a failed post, in their form.
+    next_url = safe_next_url(request.form.get("next") or request.args.get("next"))
+    return render_template("hooks/github_login_button.html", next_url=next_url)
+
+
+def github_profile_row():
+    from splent_io.splent_feature_identities.services import IdentitiesService
+
+    identity = next(
+        (
+            i
+            for i in IdentitiesService().identities_of(current_user.id)
+            if i.provider == "github"
+        ),
+        None,
+    )
+    return render_template("hooks/github_profile_row.html", identity=identity)
+
+
+def github_stylesheet():
+    href = url_for("github.assets", subfolder="css", filename="github.css")
+    return Markup(f'<link rel="stylesheet" href="{href}">')
+
+
+register_template_hook("auth.login.providers", github_login_button, order=ORDER)
+register_template_hook("signup.providers", github_login_button, order=ORDER)
+register_template_hook("profile.edit.sections", github_profile_row, order=ORDER)
+register_template_hook("layout.head.css", github_stylesheet)

splent_io/splent_feature_github/migrations/alembic.ini

@@ -0,0 +1,36 @@
+[alembic]
+script_location = migrations
+
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

splent_io/splent_feature_github/migrations/env.py

@@ -0,0 +1,9 @@
+"""Alembic migration environment for splent_feature_github."""
+
+from splent_io.splent_feature_github import models  # noqa
+from splent_framework.migrations.feature_env import run_feature_migrations
+
+FEATURE_NAME = "splent_feature_github"
+FEATURE_TABLES = set()
+
+run_feature_migrations(FEATURE_NAME, FEATURE_TABLES)

splent_io/splent_feature_github/migrations/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

splent_io/splent_feature_github/migrations/versions/7ace6050fb3f_splent_feature_github.py

@@ -0,0 +1,43 @@
+"""splent_feature_github
+
+Revision ID: 7ace6050fb3f
+Revises:
+Create Date: 2026-10-14 23:44:44.935160
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = "7ace6050fb3f"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "github",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("github_id", sa.Integer(), nullable=False),
+        sa.Column("github_login", sa.String(length=255), nullable=False),
+        sa.Column("registration_date", sa.DateTime(), nullable=False),
+        sa.Column("profile_id", sa.Integer(), nullable=True),
+        sa.ForeignKeyConstraint(
+            ["profile_id"],
+            ["user_profile.id"],
+        ),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("github_id"),
+        sa.UniqueConstraint("profile_id"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("github")
+    # ### end Alembic commands ###

splent_io/splent_feature_github/models.py

@@ -0,0 +1,31 @@
+from datetime import datetime
+
+import pytz
+from splent_framework.db import db
+
+
+class Github(db.Model):
+    """The GitHub account on a user's profile.
+
+    The table keeps the name and columns of the application this feature was
+    ported from, so an existing database carries over as is.
+    """
+
+    id = db.Column(db.Integer, primary_key=True)
+    github_id = db.Column(db.Integer, unique=True, nullable=False)
+    github_login = db.Column(db.String(255), nullable=False)
+    registration_date = db.Column(
+        db.DateTime, nullable=False, default=lambda: datetime.now(pytz.utc)
+    )
+    profile_id = db.Column(db.Integer, db.ForeignKey("user_profile.id"), unique=True)
+
+    def __repr__(self):
+        return f"Github<{self.github_login}>"
+
+
+class UserProfileGithubMixin:
+    """profile.get_github(), applied to profile's UserProfile."""
+
+    def get_github(self):
+        record = Github.query.filter_by(profile_id=self.id).first()
+        return record.github_login if record else None

splent_io/splent_feature_github/repositories.py

@@ -0,0 +1,11 @@
+from splent_framework.repositories.BaseRepository import BaseRepository
+
+from splent_io.splent_feature_github.models import Github
+
+
+class GithubRepository(BaseRepository):
+    def __init__(self):
+        super().__init__(Github)
+
+    def get_by_github_id(self, github_id: int) -> Github | None:
+        return self.model.query.filter_by(github_id=github_id).first()

splent_io/splent_feature_github/routes.py

@@ -0,0 +1,110 @@
+from flask import current_app, flash, redirect, request, session, url_for
+from flask_login import current_user, login_user
+from splent_framework.services.service_locator import service_proxy
+
+from splent_io.splent_feature_auth.decorators import login_required
+from splent_io.splent_feature_auth.routes import landing_url, safe_next_url
+from splent_io.splent_feature_github import github_bp
+
+github_service = service_proxy("GithubService")
+
+
+def _back_to_login(next_url):
+    return redirect(
+        url_for("auth.login", next=next_url) if next_url else url_for("auth.login")
+    )
+
+
+@github_bp.route("/github/login")
+def login():
+    next_url = safe_next_url(request.form.get("next") or request.args.get("next"))
+    if next_url:
+        session["github_next_url"] = next_url
+    else:
+        session.pop("github_next_url", None)
+
+    redirect_uri = url_for("github.authorize", _external=True)
+
+    try:
+        return github_service.github_client.authorize_redirect(redirect_uri)
+    except Exception as exc:
+        current_app.logger.exception("GitHub authorize_redirect failed: %s", exc)
+        flash("GitHub login failed. Please try again.", "danger")
+        return _back_to_login(next_url)
+
+
+@github_bp.route("/github/authorize")
+def authorize():
+    next_url = safe_next_url(session.pop("github_next_url", None))
+    connect_mode = session.pop("github_connect_mode", False)
+
+    # One instance for the whole callback: the proxy builds a new one on
+    # every attribute access.
+    service = github_service._get_current_object()
+
+    try:
+        token = service.github_client.authorize_access_token()
+    except Exception as exc:
+        current_app.logger.exception("GitHub authorize_access_token failed: %s", exc)
+        flash(
+            "GitHub authorization failed (invalid session or provider error). Please try again.",
+            "danger",
+        )
+        return _back_to_login(next_url)
+
+    user_info, err = service.get_github_user_info(token)
+    if err:
+        flash(err, "danger")
+        return _back_to_login(next_url)
+
+    if connect_mode:
+        if not current_user.is_authenticated:
+            flash("You must be logged in to connect GitHub.", "danger")
+            return redirect(url_for("auth.login"))
+
+        _, err = service.link_identity(current_user, user_info)
+        if err:
+            flash(err, "danger")
+            return redirect(url_for("profile.edit_profile"))
+
+        flash("GitHub account connected successfully", "success")
+        return redirect(url_for("profile.edit_profile"))
+
+    github_id = user_info.get("id")
+    if not service.identities.get_identity("github", github_id):
+        # Linked to nobody, so this sign-in would open an account. A product
+        # without signup refuses it here, whatever GitHub shared.
+        refusal = service.new_account_refusal()
+        if refusal:
+            flash(refusal, "danger")
+            return _back_to_login(next_url)
+
+        # get_github_user_info already falls back to the verified primary
+        # email; if GitHub still gave us nothing, bounce to login rather than
+        # create an account without an email.
+        if not user_info.get("email"):
+            flash(
+                "GitHub did not share a verified email, so we could not create your account. "
+                "Make a primary email verified on GitHub, or sign in with email or ORCID.",
+                "danger",
+            )
+            return _back_to_login(next_url)
+
+    user, err = service.get_or_create_user(user_info)
+    if err:
+        flash(err, "danger")
+        return _back_to_login(next_url)
+
+    login_user(user)
+    flash("Signed in with GitHub.", "success")
+    return redirect(next_url or landing_url())
+
+
+# ── Connecting GitHub to the signed-in account ───────────────────────────────
+
+
+@github_bp.route("/account/connect/github")
+@login_required
+def connect_github():
+    session["github_connect_mode"] = True
+    return redirect(url_for("github.login"))