meerschaum 2.9.5__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

meerschaum/api/models/_pipes.py

@@ -8,14 +8,92 @@ Pydantic model for a pipe's keys.
 
 from __future__ import annotations
 
+from typing import Optional, List, Tuple, Dict, Union, Any
+
 import meerschaum as mrsm
-from meerschaum.utils.typing import Optional
 
-pydantic = mrsm.attempt_import('pydantic', warn=False, lazy=False)
+from meerschaum.models.pipes import (
+    PipeModel as BasePipeModel,
+    ConnectorKeysModel,
+    MetricKeyModel,
+    LocationKeyModel,
+)
+
+pydantic = mrsm.attempt_import('pydantic', lazy=False)
+from pydantic import (
+    BaseModel,
+    RootModel,
+    field_validator,
+    ValidationInfo,
+    ConfigDict,
+)
+
+
+class PipeModel(BasePipeModel):
+    """
+    A `Pipe`'s model to be used in API responses.
+    """
+    parameters: Optional[dict] = None
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': {
+                'connector_keys': 'sql:main',
+                'metric_key': 'weather',
+                'location_key': 'us.co.denver',
+                'instance_keys': 'sql:main',
+                'parameters': {
+                    'columns': {
+                        'datetime': 'dt',
+                        'id': 'id',
+                        'value': 'val',
+                    },
+                },
+            },
+        },
+    )
+
+
+class FetchPipesKeysResponseModel(
+    RootModel[List[Tuple[ConnectorKeysModel, MetricKeyModel, LocationKeyModel]]]
+):
+    """
+    A list of tuples containing connector, metric, and location keys.
+    """
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': [
+                ['sql:main', 'weather', 'greenville'],
+                ['plugin:noaa', 'weather', 'greenville'],
+            ],
+        },
+    )
 
 
-class MetaPipe(pydantic.BaseModel):
-    connector_keys: str
-    metric_key: str
-    location_key: Optional[str] = None
-    instance_keys: Optional[str] = None
+class SyncPipeRequestModel(
+    RootModel[
+        Union[
+            List[Dict[str, Any]],
+            Dict[str, List[Any]],
+            str
+        ]
+    ]
+):
+    """
+    The accepted formats of dataframes to be synced.
+    """
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': [
+                {
+                    'timestamp': '2026-01-01',
+                    'id': 1,
+                    'value': 100.1,
+                },
+                {
+                    'timestamp': '2026-01-02',
+                    'id': 1,
+                    'value': 200.2,
+                }
+            ],
+        }
+    )

meerschaum/api/models/_tokens.py

@@ -0,0 +1,81 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Response models for tokens.
+"""
+
+import uuid
+from datetime import datetime
+from typing import Optional, List, Union
+
+import meerschaum as mrsm
+from meerschaum._internal.static import STATIC_CONFIG
+
+from pydantic import BaseModel, RootModel, Field, ConfigDict
+
+
+class RegisterTokenRequestModel(BaseModel):
+    label: Optional[str] = None
+    expiration: Optional[datetime] = None
+    scopes: List[str] = Field(default_factory=lambda: list(STATIC_CONFIG['tokens']['scopes']))
+    model_config = ConfigDict(
+        json_schema_extra = {
+            'examples': [
+                {
+                    'label': 'my-iot-device',
+                    'expiration': '2026-01-01T00:00:00Z',
+                    'scopes': list(STATIC_CONFIG['tokens']['scopes']),
+                }
+            ]
+        }
+    )
+
+
+class RegisterTokenResponseModel(BaseModel):
+    label: str
+    secret: str
+    id: uuid.UUID
+    api_key: str
+    expiration: Optional[datetime]
+    model_config = ConfigDict(
+        json_schema_extra = {
+            'examples': [
+                {
+                    'label': 'my-iot-device',
+                    'secret': 'a_very_long_secret_string_that_is_only_shown_once',
+                    'id': '1540c2f6-a99d-463c-bfab-47d361200123',
+                    'expiration': '2026-01-01T00:00:00Z',
+                    'api_key': 'mrsm-key:MTU0MGMyZjYtYTk5ZC00NjNjLWJmYWItNDdkMzYxMjAwMTIzOmFfdmVyeV9sb25nX3NlY3JldF9zdHJpbmdfdGhhdF9pc19vbmx5X3Nob3duX29uY2U=',
+                }
+            ]
+        }
+    )
+
+
+class GetTokenResponseModel(BaseModel):
+    id: Optional[uuid.UUID] = Field(default=None)
+    creation: datetime = Field()
+    expiration: Optional[datetime] = Field()
+    label: str = Field()
+    user_id: Optional[Union[int, str, uuid.UUID]] = Field(default=None)
+    scopes: List[str] = Field(default=list(STATIC_CONFIG['tokens']['scopes']))
+    is_valid: bool = Field(default=True)
+
+
+class GetTokensResponseModel(RootModel[List[GetTokenResponseModel]]):
+    model_config = ConfigDict(
+        json_schema_extra={
+            'example': [
+                {
+                    'label': 'my-iot-device',
+                    'id': '1540c2f6-a99d-463c-bfab-47d361200123',
+                    'user_id': 1,
+                    'scopes': ['pipes:write'],
+                    'creation': '2025-07-01T00:00:00Z',
+                    'expiration': '2026-01-01T00:00:00Z',
+                    'is_valid': True,
+                },
+            ],
+        }
+    )

meerschaum/api/resources/templates/termpage.html

@@ -30,6 +30,7 @@ window.addEventListener(
     let connector_keys = event.data['connector_keys'] ? event.data['connector_keys'] : [];
     let metric_keys = event.data['metric_keys'] ? event.data['metric_keys'] : [];
     let location_keys = event.data['location_keys'] ? event.data['location_keys'] : [];
+    let tags = event.data['tags'] ? event.data['tags'] : [];
     let connector_keys_str = " -c";
     for (let ck of connector_keys){
         if (typeof ck === "string"){
@@ -62,6 +63,16 @@ window.addEventListener(
     if (location_keys_str === " -l"){
         location_keys_str = "";
     }
+    let tags_str = " -t";
+    for (tag of tags){
+        if (typeof tag === "string"){
+            quote_str = tag.includes(" ") ? "'" : "";
+            tags_str += " " + quote_str + tag + quote_str;
+        }
+    }
+    if (tags_str === " -t"){
+        tags_str = "";
+    }
 
     let instance = event.data['instance'] ? event.data['instance'] : '';
     let flags_str = "";
@@ -105,6 +116,7 @@ window.addEventListener(
       + connector_keys_str
       + metric_keys_str
       + location_keys_str
+      + tags_str
       + flags_str
       + '\r'
     );

meerschaum/api/routes/__init__.py

@@ -15,6 +15,7 @@ import meerschaum.api.routes._misc
 import meerschaum.api.routes._pipes
 import meerschaum.api.routes._plugins
 import meerschaum.api.routes._users
+import meerschaum.api.routes._tokens
 import meerschaum.api.routes._version
 
 from meerschaum.api import _include_dash

meerschaum/api/routes/_actions.py

@@ -18,6 +18,7 @@ from meerschaum.api import (
     manager,
     private,
     no_auth,
+    ScopedAuth,
 )
 from meerschaum.actions import actions
 from meerschaum.core.User import is_user_allowed_to_execute
@@ -28,7 +29,7 @@ actions_endpoint = endpoints['actions']
 @app.get(actions_endpoint, tags=['Actions'])
 def get_actions(
     curr_user = (
-        fastapi.Depends(manager) if private else None
+        fastapi.Depends(ScopedAuth(['actions:execute'])) if private else None
     ),
 ) -> List[str]:
     """
@@ -41,9 +42,7 @@ def get_actions(
 def do_action_legacy(
     action: str,
     keywords: Dict[str, Any] = fastapi.Body(...),
-    curr_user = (
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user = fastapi.Depends(ScopedAuth(['actions:execute'])),
 ) -> SuccessTuple:
     """
     Perform a Meerschaum action (if permissions allow).

meerschaum/api/routes/_connectors.py

@@ -10,7 +10,7 @@ import fastapi
 from fastapi import HTTPException
 
 import meerschaum as mrsm
-from meerschaum.api import app, endpoints, no_auth, manager
+from meerschaum.api import app, endpoints, ScopedAuth
 from meerschaum.utils.typing import Optional, Dict, List, Union
 
 endpoint = endpoints['connectors']
@@ -19,9 +19,7 @@ endpoint = endpoints['connectors']
 @app.get(endpoint, tags=['Connectors'])
 def get_connectors(
     type: Optional[str] = None,
-    curr_user = (
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['connectors:read'])),
 ) -> Union[Dict[str, List[str]], List[str]]:
     """
     Return the keys of the registered connectors.
@@ -54,9 +52,7 @@ def get_connectors(
 @app.get(endpoint + "/{type}", tags=['Connectors'])
 def get_connectors_by_type(
     type: str,
-    curr_user = (
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['connectors:read']))
 ):
     """
     Convenience method for `get_connectors()`.

meerschaum/api/routes/_jobs.py

@@ -28,11 +28,12 @@ from meerschaum.api import (
     fastapi,
     app,
     endpoints,
-    manager,
+    ScopedAuth,
     no_auth,
+    manager,
     debug,
 )
-from meerschaum.config.static import STATIC_CONFIG
+from meerschaum._internal.static import STATIC_CONFIG
 from meerschaum.core.User import is_user_allowed_to_execute
 
 
@@ -53,9 +54,7 @@ def _get_job(name: str, sysargs: Union[str, List[str], None] = None):
 
 @app.get(endpoints['jobs'], tags=['Jobs'])
 def get_jobs(
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:read'])),
 ) -> Dict[str, Dict[str, Any]]:
     """
     Return metadata about the current jobs.
@@ -84,9 +83,7 @@ def get_jobs(
 @app.get(endpoints['jobs'] + '/{name}', tags=['Jobs'])
 def get_job(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:read'])),
 ) -> Dict[str, Any]:
     """
     Return metadata for a single job.
@@ -137,9 +134,7 @@ def clean_sysargs(sysargs: List[str]) -> List[str]:
 def create_job(
     name: str,
     metadata: Union[List[str], Dict[str, Any]],
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:execute', 'jobs:write'])),
 ) -> SuccessTuple:
     """
     Create and start a new job.
@@ -172,9 +167,7 @@ def create_job(
 @app.delete(endpoints['jobs'] + '/{name}', tags=['Jobs'])
 def delete_job(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:delete'])),
 ) -> SuccessTuple:
     """
     Delete a job.
@@ -189,9 +182,7 @@ def delete_job(
 @app.get(endpoints['jobs'] + '/{name}/exists', tags=['Jobs'])
 def get_job_exists(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:read'])),
 ) -> bool:
     """
     Return whether a job exists.
@@ -203,9 +194,7 @@ def get_job_exists(
 @app.get(endpoints['logs'] + '/{name}', tags=['Jobs'])
 def get_logs(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:read', 'logs:read'])),
 ) -> Union[str, None]:
     """
     Return a job's log text.
@@ -224,9 +213,7 @@ def get_logs(
 @app.post(endpoints['jobs'] + '/{name}/start', tags=['Jobs'])
 def start_job(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:execute'])),
 ) -> SuccessTuple:
     """
     Start a job if stopped.
@@ -247,9 +234,7 @@ def start_job(
 @app.post(endpoints['jobs'] + '/{name}/stop', tags=['Jobs'])
 def stop_job(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:execute', 'josb:stop'])),
 ) -> SuccessTuple:
     """
     Stop a job if running.
@@ -270,9 +255,7 @@ def stop_job(
 @app.post(endpoints['jobs'] + '/{name}/pause', tags=['Jobs'])
 def pause_job(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:execute', 'jobs:pause'])),
 ) -> SuccessTuple:
     """
     Pause a job if running.
@@ -293,9 +276,7 @@ def pause_job(
 @app.get(endpoints['jobs'] + '/{name}/stop_time', tags=['Jobs'])
 def get_stop_time(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:read'])),
 ) -> Union[datetime, None]:
     """
     Get the timestamp when the job was manually stopped.
@@ -307,9 +288,7 @@ def get_stop_time(
 @app.get(endpoints['jobs'] + '/{name}/is_blocking_on_stdin', tags=['Jobs'])
 def get_is_blocking_on_stdin(
     name: str,
-    curr_user=(
-        fastapi.Depends(manager) if not no_auth else None
-    ),
+    curr_user=fastapi.Depends(ScopedAuth(['jobs:read'])),
 ) -> bool:
     """
     Return whether a job is blocking on stdin.

meerschaum/api/routes/_login.py

@@ -6,19 +6,22 @@
 Manage access and refresh tokens.
 """
 
+import uuid
 from datetime import datetime, timedelta, timezone
+from typing import Union
 
 import fastapi
-from fastapi import Request, status
+from fastapi import Request, status, Response
 from fastapi_login.exceptions import InvalidCredentialsException
 from fastapi.exceptions import RequestValidationError
 from starlette.responses import JSONResponse
 
 from meerschaum.api import endpoints, get_api_connector, app, debug, manager, no_auth
 from meerschaum.core import User
-from meerschaum.config.static import STATIC_CONFIG
+from meerschaum._internal.static import STATIC_CONFIG
 from meerschaum.utils.typing import Dict, Any
-from meerschaum.core.User._User import verify_password
+from meerschaum.utils.misc import is_uuid
+from meerschaum.core.User import verify_password
 from meerschaum.utils.warnings import warn
 from meerschaum.api._oauth2 import CustomOAuth2PasswordRequestForm
 
@@ -39,26 +42,60 @@ def login(
     Login and set the session token.
     """
     username, password = (
-        (data['username'], data['password'])
+        (data.get('username', None), data.get('password', None))
         if isinstance(data, dict)
         else (data.username, data.password)
-    ) if not no_auth else ('no-auth', 'no-auth')
-
-    user = User(username, password)
-    correct_password = no_auth or verify_password(
-        password,
-        get_api_connector().get_user_password_hash(user, debug=debug)
     )
-    if not correct_password:
+    client_id, client_secret = (
+        (data.get('client_id', None), data.get('client_secret', None))
+        if isinstance(data, dict)
+        else (data.client_id, data.client_secret)
+    )
+    grant_type = (
+        data.get('grant_type', None)
+        if isinstance(data, dict)
+        else data.grant_type
+    )
+    if not grant_type:
+        grant_type = (
+            'password'
+            if username and password
+            else 'client_credentials'
+        )
+
+    expires_dt: Union[datetime, None] = None
+    if grant_type == 'password':
+        user = User(str(username), str(password), instance=get_api_connector())
+        correct_password = no_auth or verify_password(
+            str(password),
+            get_api_connector().get_user_password_hash(user, debug=debug)
+        )
+        if not correct_password:
+            raise InvalidCredentialsException
+
+    elif grant_type == 'client_credentials':
+        if not is_uuid(str(client_id)):
+            raise InvalidCredentialsException
+        token_id = uuid.UUID(client_id)
+        correct_password = no_auth or verify_password(
+            str(client_secret),
+            str(get_api_connector().get_token_secret_hash(token_id, debug=debug))
+        )
+        if not correct_password:
+            raise InvalidCredentialsException
+    else:
         raise InvalidCredentialsException
 
     expires_minutes = STATIC_CONFIG['api']['oauth']['token_expires_minutes']
     expires_delta = timedelta(minutes=expires_minutes)
     expires_dt = datetime.now(timezone.utc).replace(tzinfo=None) + expires_delta
     access_token = manager.create_access_token(
-        data={'sub': username},
+        data={
+            'sub': (username if grant_type == 'password' else client_id),
+        },
         expires=expires_delta
     )
+
     return {
         'access_token': access_token,
         'token_type': 'bearer',

meerschaum/api/routes/_misc.py

@@ -19,7 +19,8 @@ from meerschaum.api import (
     debug,
     get_api_connector,
     private,
-    manager
+    manager,
+    ScopedAuth,
 )
 from meerschaum.config.paths import API_STATIC_PATH
 from meerschaum import __version__ as version
@@ -38,9 +39,7 @@ def get_favicon() -> Any:
 
 @app.get(endpoints['chaining'], tags=['Misc'])
 def get_chaining_status(
-    curr_user = (
-        fastapi.Depends(manager) if private else None
-    ),
+    curr_user = fastapi.Depends(ScopedAuth(['instance:read'])) if private else None,
 ) -> bool:
     """
     Return whether this API instance may be chained.
@@ -50,9 +49,7 @@ def get_chaining_status(
 
 @app.get(endpoints['info'], tags=['Misc'])
 def get_instance_info(
-    curr_user = (
-        fastapi.Depends(manager) if private else None
-    ),
+    curr_user = fastapi.Depends(ScopedAuth(['instance:read'])) if private else None,
     instance_keys: Optional[str] = None,
 ) -> Dict[str, Union[str, int]]:
     """
@@ -87,9 +84,7 @@ def get_healtheck(instance_keys: Optional[str] = None) -> Dict[str, Any]:
 if debug:
     @app.get('/id', tags=['Misc'])
     def get_ids(
-        curr_user = (
-            fastapi.Depends(manager) if private else None
-        ),
+        curr_user = fastapi.Depends(ScopedAuth(['instance:read'])) if private else None,
     ) -> Dict[str, Union[int, str]]:
         return {
             'server': SERVER_ID,