feat: refactor api

Author: everysoftware

.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: '37 9 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: python
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/codeql.yml

@@ -0,0 +1,32 @@
+name: Run all tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+
+      - name: Install dependencies
+        run: |
+          pip install poetry
+          poetry config virtualenvs.create false
+          poetry install --only dev
+
+      - name: Run checks
+        run: |
+          poetry run make lint

.github/workflows/test.yml

@@ -1,20 +1,20 @@
 # FastLink
 
-**Effortless asynchronous OAuth 2.0 client for popular platforms**
+_OAuth 2.0 client for various platforms, asynchronous, easy-to-use, extensible_
 
 ---
 
-[![Test](https://github.com/everysoftware/fastid/actions/workflows/test.yml/badge.svg)](https://github.com/everysoftware/fastid/actions/workflows/test.yml)
-[![CodeQL Advanced](https://github.com/everysoftware/fastid/actions/workflows/codeql.yml/badge.svg)](https://github.com/everysoftware/fastid/actions/workflows/codeql.yml)
+[![Test](https://github.com/everysoftware/fastlink/actions/workflows/test.yml/badge.svg)](https://github.com/everysoftware/fastlink/actions/workflows/test.yml)
+[![CodeQL Advanced](https://github.com/everysoftware/fastlink/actions/workflows/codeql.yml/badge.svg)](https://github.com/everysoftware/fastlink/actions/workflows/codeql.yml)
 
 ---
 
 ## Features
 
+- **All-in-one**: Supports popular platforms like **Google**, **Yandex**, **Telegram**, etc.
 - **Asynchronous**: Built on top of `httpx` is fully asynchronous.
-- **Built-in support**: For popular OAuth 2.0 providers like **Google**, **Yandex**, **Telegram**, etc.
-- **Extensible**: Easily add support for new OAuth 2.0 providers.
-- **Easy to use**: Simple and intuitive API.
+- **Easy-to-use**: Simple and intuitive API for quick integration.
+- **Extensible**: Easily add support for new platforms or customize existing ones.
 
 ## Installation
 
@@ -27,16 +27,16 @@ pip install fastlink
 ```python
 from typing import Annotated
 
-from fastapi import FastAPI, Depends
-from starlette.responses import RedirectResponse
+from fastapi import Depends, FastAPI
+from fastapi.responses import RedirectResponse
 
-from fastlink.google.client import GoogleOAuth
-from fastlink.schemas import OAuth2Callback, OpenID
 from examples.config import settings
+from fastlink import GoogleSSO
+from fastlink.schemas import OAuth2Callback, OpenID
 
 app = FastAPI()
 
-oauth = GoogleOAuth(
+oauth = GoogleSSO(
     settings.google_client_id,
     settings.google_client_secret,
     "http://localhost:8000/callback",
@@ -46,15 +46,14 @@ oauth = GoogleOAuth(
 @app.get("/login")
 async def login() -> RedirectResponse:
     async with oauth:
-        url = await oauth.get_authorization_url()
+        url = await oauth.login_url()
         return RedirectResponse(url=url)
 
 
 @app.get("/callback")
-async def oauth_callback(callback: Annotated[OAuth2Callback, Depends()]) -> OpenID:
+async def callback(call: Annotated[OAuth2Callback, Depends()]) -> OpenID:
     async with oauth:
-        await oauth.authorize(callback)
-        return await oauth.userinfo()
+        return await oauth.callback(call)
 
 ```
 

README.md

@@ -8,8 +8,8 @@ class Settings(BaseSettings):
     yandex_client_id: str
     yandex_client_secret: str
 
-    telegram_bot_username: str
     telegram_bot_token: str
+    telegram_bot_public_key: str
 
     model_config = SettingsConfigDict(env_file=".env", extra="ignore")
 

examples/config.py

@@ -1,15 +1,15 @@
 from typing import Annotated
 
 from fastapi import Depends, FastAPI
-from starlette.responses import RedirectResponse
+from fastapi.responses import RedirectResponse
 
 from examples.config import settings
-from fastlink import GoogleOAuth
+from fastlink import GoogleSSO
 from fastlink.schemas import OAuth2Callback, OpenID
 
 app = FastAPI()
 
-oauth = GoogleOAuth(
+oauth = GoogleSSO(
     settings.google_client_id,
     settings.google_client_secret,
     "http://localhost:8000/callback",
@@ -19,12 +19,11 @@
 @app.get("/login")
 async def login() -> RedirectResponse:
     async with oauth:
-        url = await oauth.get_authorization_url()
+        url = await oauth.login_url()
         return RedirectResponse(url=url)
 
 
 @app.get("/callback")
-async def oauth_callback(callback: Annotated[OAuth2Callback, Depends()]) -> OpenID:
+async def callback(call: Annotated[OAuth2Callback, Depends()]) -> OpenID:
     async with oauth:
-        await oauth.authorize(callback)
-        return await oauth.userinfo()
+        return await oauth.callback(call)

examples/google.py

@@ -1,47 +1,33 @@
-from typing import Annotated, Any
+from typing import Annotated
 
 from fastapi import Depends, FastAPI
 from fastapi.responses import HTMLResponse, RedirectResponse
 
 from examples.config import settings
-from fastlink import TelegramAuth
+from fastlink import TelegramSSO
 from fastlink.schemas import OpenID
 from fastlink.telegram.schemas import TelegramCallback
 
 app = FastAPI()
 
-oauth = TelegramAuth(
-    settings.telegram_bot_token,
-    "http://localhost:8000/widget",
-)
-CALLBACK_URL = "http://localhost:8000/callback"
+oauth = TelegramSSO(settings.telegram_bot_token, "http://localhost:8000/widget", "http://localhost:8000/callback")
 
 
 @app.get("/login")
 async def login() -> RedirectResponse:
     async with oauth:
-        url = await oauth.get_authorization_url()
+        url = await oauth.login_url()
         return RedirectResponse(url=url)
 
 
 @app.get("/widget")
-def oauth_redirect() -> Any:
-    text = f"""
-    <html>
-        <head>
-            <title>Telegram OAuth</title>
-        </head>
-        <body>
-            <script async src="https://telegram.org/js/telegram-widget.js?22" data-telegram-login="{settings.telegram_bot_username}"
-            data-size="medium" data-auth-url="{CALLBACK_URL}" data-request-access="write"></script>
-        </body>
-    </html>
-    """
-    return HTMLResponse(content=text)
+async def widget() -> HTMLResponse:
+    async with oauth:
+        content = await oauth.widget()
+        return HTMLResponse(content=content)
 
 
 @app.get("/callback")
-async def oauth_callback(callback: Annotated[TelegramCallback, Depends()]) -> OpenID:
+async def callback(call: Annotated[TelegramCallback, Depends()]) -> OpenID:
     async with oauth:
-        await oauth.authorize(callback)
-        return await oauth.userinfo()
+        return await oauth.callback(call)

examples/telegram.py

@@ -4,12 +4,12 @@
 from starlette.responses import RedirectResponse
 
 from examples.config import settings
-from fastlink import YandexOAuth
+from fastlink import YandexSSO
 from fastlink.schemas import OAuth2Callback, OpenID
 
 app = FastAPI()
 
-oauth = YandexOAuth(
+oauth = YandexSSO(
     settings.yandex_client_id,
     settings.yandex_client_secret,
     "http://localhost:8000/callback",
@@ -19,12 +19,11 @@
 @app.get("/login")
 async def login() -> RedirectResponse:
     async with oauth:
-        url = await oauth.get_authorization_url()
+        url = await oauth.login_url()
         return RedirectResponse(url=url)
 
 
 @app.get("/callback")
-async def oauth_callback(callback: Annotated[OAuth2Callback, Depends()]) -> OpenID:
+async def callback(call: Annotated[OAuth2Callback, Depends()]) -> OpenID:
     async with oauth:
-        await oauth.authorize(callback)
-        return await oauth.userinfo()
+        return await oauth.callback(call)

examples/yandex.py

@@ -1,11 +1,11 @@
-from fastlink.client.httpx import HttpxClient
-from fastlink.google.client import GoogleOAuth
-from fastlink.telegram.auth import TelegramAuth
-from fastlink.yandex.client import YandexOAuth
+from fastlink.base.client import FastLink
+from fastlink.google.provider import GoogleSSO
+from fastlink.telegram.provider import TelegramSSO
+from fastlink.yandex.provider import YandexSSO
 
 __all__ = [
-    "GoogleOAuth",
-    "HttpxClient",
-    "TelegramAuth",
-    "YandexOAuth",
+    "FastLink",
+    "GoogleSSO",
+    "TelegramSSO",
+    "YandexSSO",
 ]