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

meerschaum/actions/edit.py

@@ -27,6 +27,7 @@ def edit(
         'users'     : _edit_users,
         'plugins'   : _edit_plugins,
         'jobs'      : _edit_jobs,
+        'tokens'    : _edit_tokens,
     }
     return choose_subaction(action, options, **kw)
 
@@ -66,7 +67,7 @@ def _complete_edit(
     return default_action_completer(action=(['edit'] + action), **kw)
 
 
-def _edit_config(action: Optional[List[str]] = None, **kw : Any) -> SuccessTuple:
+def _edit_config(action: Optional[List[str]] = None, **kw: Any) -> SuccessTuple:
     """
     Edit Meerschaum configuration files.
 
@@ -104,14 +105,14 @@ def _complete_edit_config(action: Optional[List[str]] = None, **kw: Any) -> List
     return possibilities
 
 def _edit_pipes(
-        action: Optional[List[str]] = None,
-        params: Optional[Dict[str, Any]] = None,
-        yes: bool = False,
-        force: bool = False,
-        noask: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    params: Optional[Dict[str, Any]] = None,
+    yes: bool = False,
+    force: bool = False,
+    noask: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Open and edit pipes' configuration files.
     
@@ -218,7 +219,7 @@ def _edit_users(
     from meerschaum.utils.prompt import prompt, yes_no, get_password, get_email
     from meerschaum.utils.misc import edit_file
     from meerschaum.config._paths import USERS_CACHE_RESOURCES_PATH
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     from meerschaum.utils.yaml import yaml
     import os, pathlib
     instance_connector = parse_instance_keys(mrsm_instance)
@@ -235,7 +236,7 @@ def _edit_users(
                 minimum_length = STATIC_CONFIG['users']['min_password_length'],
             )
 
-        ## Make an admin
+        ### Make an admin
         _type = ''
         if yes_no(f"Change the user type for user '{username}'?", default='n', yes=yes, noask=noask):
             is_admin = yes_no(
@@ -248,15 +249,34 @@ def _edit_users(
         if yes_no(f"Change the email for user '{username}'?", default='n', yes=yes, noask=noask):
             email = get_email(username)
 
+        attributes = {}
+        ### Change the scopes.
+        attributes['scopes'] = prompt(
+            f"Scopes for user '{username}' (`*` to grant all scopes):",
+            default_editable=' '.join(User(
+                username,
+                instance=instance_connector,
+            ).get_scopes(refresh=True, debug=debug)),
+        ).split()
+        if attributes['scopes'] == ['*']:
+            attributes['scopes'] = list(STATIC_CONFIG['tokens']['scopes'])
+
         ### Change the attributes
-        attributes = None
         if yes_no(
-                f"Edit the attributes YAML file for user '{username}'?",
-                default='n', yes=yes, noask=noask
+            f"Edit the attributes YAML file for user '{username}'?",
+            default='n',
+            yes=yes,
+            noask=noask,
         ):
             attr_path = pathlib.Path(os.path.join(USERS_CACHE_RESOURCES_PATH, f'{username}.yaml'))
             try:
-                existing_attrs = instance_connector.get_user_attributes(User(username), debug=debug)
+                existing_attrs = instance_connector.get_user_attributes(
+                    User(
+                        username,
+                        instance=instance_connector,
+                    ),
+                    debug=debug,
+                )
                 with open(attr_path, 'w+') as f:
                     yaml.dump(existing_attrs, stream=f, sort_keys=False)
                 edit_file(attr_path)
@@ -271,7 +291,14 @@ def _edit_users(
                 attributes = None
 
         ### Submit changes
-        return User(username, password, email=email, type=_type, attributes=attributes)
+        return User(
+            username,
+            password,
+            email=email,
+            type=_type,
+            attributes=attributes,
+            instance=instance_connector,
+        )
 
     if not action:
         return False, "No users to edit."
@@ -301,14 +328,14 @@ def _edit_users(
         f"    ({succeeded} succeeded, {failed} failed)."
     )
     info(msg)
-    return True, msg
+    return succeeded > 0, msg
 
 
 def _edit_plugins(
     action: Optional[List[str]] = None,
     debug: bool = False,
     **kwargs: Any
-):
+) -> mrsm.SuccessTuple:
     """
     Edit a plugin's source code.
     """
@@ -507,6 +534,103 @@ def _edit_jobs(
     return True, msg
 
 
+def _edit_tokens(
+    action: Optional[List[str]] = None,
+    mrsm_instance: Optional[str] = None,
+    debug: bool = False,
+) -> mrsm.SuccessTuple:
+    """
+    Edit tokens registered to an instance.
+    """
+    import uuid
+    from meerschaum.utils.warnings import warn
+    from meerschaum.utils.misc import is_uuid
+    from meerschaum.core import Token
+    from meerschaum.connectors.parse import parse_instance_keys
+    from meerschaum.utils.prompt import prompt, yes_no
+    from meerschaum._internal.static import STATIC_CONFIG
+    dateutil_parser = mrsm.attempt_import('dateutil.parser')
+
+    if not action:
+        return False, "Provide token labels or IDs for the tokens to edit."
+
+    conn = parse_instance_keys(mrsm_instance)
+
+    labels = [
+        label
+        for label in (action or [])
+        if not is_uuid(label)
+    ]
+    potential_token_ids = [
+        uuid.UUID(potential_id)
+        for potential_id in (action or [])
+        if is_uuid(potential_id)
+    ]
+
+    tokens = conn.get_tokens(
+        labels=(labels or None),
+        ids=(potential_token_ids or None),
+        debug=debug,
+    )
+
+    num_edited = 0
+    for token in tokens:
+        token_model = token.to_model(refresh=True)
+        if token_model is None:
+            warn(f"Token '{token.id}' does not exist.", stack=False)
+            continue
+
+        new_attrs = {}
+
+        new_attrs['label'] = prompt("Label:", default_editable=token_model.label)
+        new_expiration_str = prompt(
+            "Expiration (empty for no expiration):",
+            default_editable=('' if token.expiration is None else str(token_model.expiration)),
+        )
+        new_attrs['expiration'] = (
+            dateutil_parser.parse(new_expiration_str)
+            if new_expiration_str
+            else None
+        )
+        new_scopes_str = prompt(
+            "Scope (`*` to grant all permissions):",
+            default_editable=' '.join(token_model.scopes),
+        )
+        new_attrs['scopes'] = (
+            new_scopes_str.split(' ')
+            if new_scopes_str != '*'
+            else list(STATIC_CONFIG['tokens']['scopes'])
+        )
+        invalidate = (
+            yes_no("Do you want to invalidate this token?", default='n')
+            if token_model.is_valid
+            else True
+        )
+        new_attrs['is_valid'] = token_model.is_valid and not invalidate
+
+        new_token = Token(**{**dict(token_model), **new_attrs})
+        edit_success, edit_msg = new_token.edit(debug=debug)
+        if not edit_success:
+            return False, edit_msg
+
+        if invalidate:
+            invalidate_success, invalidate_msg = new_token.invalidate(debug=debug)
+            if not invalidate_success:
+                return False, invalidate_msg
+
+        num_edited += 1
+
+    msg = (
+        f"Successfully edited {num_edited} token"
+        + ('s' if num_edited != 1 else '')
+        + '.'
+    )
+
+    return True, msg
+
+        
+
+
 ### NOTE: This must be the final statement of the module.
 ###       Any subactions added below these lines will not
 ###       be added to the `help` docstring.

meerschaum/actions/register.py

@@ -7,6 +7,9 @@ Register new Pipes. Requires the API to be running.
 """
 
 from __future__ import annotations
+
+from datetime import datetime, timedelta, timezone
+
 import meerschaum as mrsm
 from meerschaum.utils.typing import SuccessTuple, Any, List, Optional, Dict
 
@@ -26,6 +29,7 @@ def register(
         'plugins'   : _register_plugins,
         'users'     : _register_users,
         'connectors': _register_connectors,
+        'tokens'    : _register_tokens,
     }
     return choose_subaction(action, options, **kw)
 
@@ -175,11 +179,11 @@ def _register_plugins(
     reload_plugins(debug=debug)
 
     repo_connector = parse_repo_keys(repository)
-    if repo_connector.__dict__.get('type', None) != 'api':
+    if repo_connector.type != 'api':
         return False, (
             "Can only upload plugins to the Meerschaum API." +
-            f"Connector '{repo_connector}' is of type " +
-            f"'{repo_connector.get('type', type(repo_connector))}'."
+            f"Connector '{repo_connector}' is " +
+            f"'{type(repo_connector)}'."
         )
 
     if len(action) == 0 or action == ['']:
@@ -272,6 +276,7 @@ def _complete_register_plugins(*args, **kw):
 def _register_users(
     action: Optional[List[str]] = None,
     mrsm_instance: Optional[str] = None,
+    scopes: Optional[List[str]] = None,
     shell: bool = False,
     debug: bool = False,
     **kw: Any
@@ -280,7 +285,7 @@ def _register_users(
     Register a new user to a Meerschaum instance.
     """
     from meerschaum.config import get_config
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     from meerschaum.connectors.parse import parse_instance_keys
     from meerschaum.utils.warnings import warn, info
     from meerschaum.core import User
@@ -333,9 +338,17 @@ def _register_users(
             )
         if len(email) == 0:
             email = None
-        user = User(username, password, email=email)
+        user = User(
+            username,
+            password,
+            email=email,
+            attributes={
+                'scopes': scopes or list(STATIC_CONFIG['tokens']['scopes']),
+            },
+            instance=instance_connector,
+        )
         info(f"Registering user '{user}' to Meerschaum instance '{instance_connector}'...")
-        result_tuple = instance_connector.register_user(user, debug=debug)
+        result_tuple = user.register(debug=debug)
         print_tuple(result_tuple)
         success[username] = result_tuple[0]
         if success[username]:
@@ -443,6 +456,124 @@ def _complete_register_connectors(
     return _complete_show_connectors(action)
 
 
+def _register_tokens(
+    mrsm_instance: Optional[str] = None,
+    name: Optional[str] = None,
+    ttl_days: Optional[int] = None,
+    scopes: Optional[List[str]] = None,
+    end: Optional[datetime] = None,
+    force: bool = False,
+    yes: bool = False,
+    noask: bool = False,
+    nopretty: bool = False,
+    debug: bool = False,
+    **kwargs: Any
+) -> mrsm.SuccessTuple:
+    """
+    Register a new long-lived access token for API access.
+    Note that omitting and end time or TTL will generate token which does not expire.
+
+    Examples:
+
+    mrsm register token --end 2032-01-01
+
+    mrsm register token --ttl-days 1000
+
+    mrsm register token --name weather-sensor
+
+    """
+    import json
+    from meerschaum.utils.schedule import parse_start_time
+    from meerschaum.core import User
+    from meerschaum.core.Token._Token import Token, _PLACEHOLDER_EXPIRATION
+    from meerschaum.connectors.parse import parse_instance_keys
+    from meerschaum.utils.prompt import yes_no, choose
+    from meerschaum.utils.formatting import make_header, print_tuple
+    from meerschaum.utils.dtypes import value_is_null
+
+    expiration = (
+        end
+        if end is not None
+        else (
+            parse_start_time(f"starting in {ttl_days} days")
+            if ttl_days
+            else _PLACEHOLDER_EXPIRATION
+        )
+    )
+
+    instance_connector = parse_instance_keys(mrsm_instance)
+    user = None
+    if instance_connector.type != 'api':
+        usernames = instance_connector.get_users(debug=debug)
+        if not usernames:
+            return False, f"No users are registered to '{instance_connector}'."
+
+        username = choose(
+            "To which user should this token be registered? Enter the number.",
+            usernames,
+        )
+        user_id = instance_connector.get_user_id(
+            User(username, instance=mrsm_instance),
+            debug=debug,
+        )
+        if user_id is None:
+            return False, f"Cannot load ID for user '{username}'."
+
+        user = User(username, user_id=user_id, instance=mrsm_instance)
+
+    token = Token(
+        label=name,
+        expiration=expiration,
+        scopes=scopes,
+        user=user,
+        instance=mrsm_instance,
+    )
+
+    register_success, register_msg = token.register(debug=debug)
+    token_id = token.id
+    token_secret = token.secret
+    if not register_success:
+        return False, f"Failed to register token '{token.label}':\n{register_msg}"
+
+    token_model = token.to_model(refresh=True)
+    token_kwargs = dict(token_model)
+    token_kwargs['id'] = token_id
+    token_kwargs['secret'] = token_secret
+    token = Token(**token_kwargs)
+
+    if not nopretty:
+        print_tuple(
+            (
+                True,
+                (
+                    f"Registered token '{token}'.\n    "
+                    "Write down the client secret, because it won't be shown again."
+                )
+            ),
+            calm=True
+        )
+
+    msg_to_print = (
+        (
+            make_header(f"Attributes for token '{token}':") + "\n"
+            + f"    - Client ID: {token_model.id}\n"
+            + f"    - Client Secret: {token_secret}\n"
+            + "    - Expiration: "
+            + (
+                token.expiration.isoformat()
+                if not value_is_null(token.expiration)
+                else 'Does not expire.'
+            )
+            + "\n"
+            + f"    - API Key: {token.get_api_key()}\n"
+        )
+        if not nopretty
+        else json.dumps({'secret': token_secret, **dict(token_model)})
+    ) 
+    print(msg_to_print)
+    return True, f"Successfully registered token '{token.label}'."
+
+
 ### NOTE: This must be the final statement of the module.
 ###       Any subactions added below these lines will not
 ###       be added to the `help` docstring.

meerschaum/actions/show.py

@@ -45,6 +45,7 @@ def show(
         'tags'       : _show_tags,
         'schedules'  : _show_schedules,
         'venvs'      : _show_venvs,
+        'tokens'     : _show_tokens,
     }
     return choose_subaction(action, show_options, **kw)
 
@@ -113,11 +114,11 @@ def _show_help(**kw: Any) -> SuccessTuple:
 
 
 def _show_config(
-        action: Optional[List[str]] = None,
-        debug: bool = False,
-        nopretty: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    debug: bool = False,
+    nopretty: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """
     Show the configuration dictionary.
     Sub-actions defined in the action list are recursive indices in the config dictionary.
@@ -789,34 +790,22 @@ def _show_tags(
     from meerschaum.utils.formatting import pipe_repr, UNICODE, ANSI
     from meerschaum.utils.pool import get_pool
     from meerschaum.config import get_config
+    from meerschaum.connectors.parse import parse_instance_keys
     rich_tree, rich_panel, rich_text, rich_console, rich_columns = (
         mrsm.attempt_import('rich.tree', 'rich.panel', 'rich.text', 'rich.console', 'rich.columns')
     )
-    panel = rich_panel.Panel.fit('Tags')
-    tree = rich_tree.Tree(panel)
     action = action or []
     tags = action + (tags or [])
-    pipes = mrsm.get_pipes(as_list=True, tags=tags, **kwargs)
-    if not pipes:
-        return False, f"No pipes were found with the given tags."
 
-    pool = get_pool(workers=workers)
     tag_prefix = get_config('formatting', 'pipes', 'unicode', 'icons', 'tag') if UNICODE else ''
     tag_style = get_config('formatting', 'pipes', 'ansi', 'styles', 'tags') if ANSI else None
 
-    tags_pipes = defaultdict(lambda: [])
-    gather_pipe_tags = lambda pipe: (pipe, (pipe.tags or []))
-
-    pipes_tags = dict(pool.map(gather_pipe_tags, pipes))
-
-    for pipe, tags in pipes_tags.items():
-        for tag in tags:
-            if action and tag not in action:
-                continue
-            tags_pipes[tag].append(pipe)
+    tags_pipes = mrsm.get_pipes(as_tags_dict=True, tags=tags, **kwargs)
+    if action:
+        tags_pipes = {tag: pipes for tag, pipes in tags_pipes.items() if tag in action}
 
     columns = []
-    sorted_tags = sorted([tag for tag in tags_pipes])
+    sorted_tags = sorted(list(tags_pipes))
     for tag in sorted_tags:
         _pipes = tags_pipes[tag]
         tag_text = (
@@ -904,9 +893,7 @@ def _show_schedules(
     return True, "Success"
         
 
-def _show_venvs(
-    **kwargs: Any    
-):
+def _show_venvs(**kwargs: Any) -> SuccessTuple:
     """
     Print the available virtual environments in the current MRSM_ROOT_DIR.
     """
@@ -921,12 +908,113 @@ def _show_venvs(
         for _venv in os.listdir(VIRTENV_RESOURCES_PATH)
         if venv_exists(_venv)
     ]
-    print_options(
-        venvs,
-        name = 'Venvs:',
-        **kwargs
+    print_options(venvs, name='Virtual Environments:', **kwargs)
+    return True, "Success"
+
+
+def _show_tokens(
+    action: Optional[List[str]] = None,
+    mrsm_instance: Optional[str] = None,
+    nopretty: bool = False,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
+    """
+    Print a table of the registered tokens on the instance.
+    """
+    import json
+    import uuid
+    from meerschaum.connectors.parse import parse_instance_keys
+    from meerschaum.utils.dtypes import value_is_null, json_serialize_value
+    from meerschaum.utils.misc import is_uuid
+    from meerschaum.utils.packages import import_rich
+    from meerschaum.utils.formatting import UNICODE, get_console
+    rich = import_rich()
+    rich_table, rich_json = mrsm.attempt_import('rich.table', 'rich.json')
+
+    conn = parse_instance_keys(mrsm_instance)
+
+    labels = [
+        label
+        for label in (action or [])
+        if not is_uuid(label)
+    ]
+    potential_token_ids = [
+        uuid.UUID(potential_id)
+        for potential_id in (action or [])
+        if is_uuid(potential_id)
+    ]
+
+    tokens = conn.get_tokens(
+        labels=(labels or None),
+        ids=(potential_token_ids or None),
+        debug=debug,
+    )
+
+    if nopretty:
+        for token in tokens:
+            print(json.dumps({
+                'id': str(token.id),
+                'label': token.label,
+                'scopes': token.scopes,
+                'expiration': (
+                    token.expiration.isoformat()
+                    if not value_is_null(token.expiration)
+                    else None
+                ),
+                'creation': (token.creation.isoformat() if not value_is_null(token.creation) else None),
+                'user': (token.user.username if token.user is not None else None),
+                'is_valid': token.is_valid,
+            }))
+        return True, "Success"
+
+    if len(tokens) == 1:
+        token = tokens[0]
+        tokens_json = json.dumps({
+            'id': str(token.id),
+            'label': token.label,
+            'scopes': token.scopes,
+            'creation': (token.creation.isoformat() if not value_is_null(token.creation) else None),
+            'expiration': (token.expiration.isoformat() if not value_is_null(token.expiration) else None),
+            'user': (token.user.username if token.user is not None else None),
+            'is_valid': token.is_valid,
+        }, default=json_serialize_value, indent=4)
+        get_console().print(rich_json.JSON(tokens_json))
+        
+        return True, "Success"
+
+    is_valid_true = (
+        "🟢"
+        if UNICODE
+        else "[+]"
     )
+    is_valid_false = (
+        "🔴"
+        if UNICODE
+        else "[-]"
+    )
+
+    table = rich_table.Table(title=f"Registered Tokens on instance '{conn}'")
+    table.add_column("ID")
+    table.add_column("Label")
+    table.add_column("User")
+    table.add_column("Expiration")
+    table.add_column("Valid")
+
+    for token in tokens:
+        table.add_row(
+            str(token.id),
+            token.label,
+            (token.user.username if token.user is not None else ""),
+            (
+                token.expiration.isoformat()
+                if not value_is_null(token.expiration)
+                else 'Does not expire'
+            ),
+            (is_valid_true if token.is_valid else is_valid_false),
+        )
 
+    mrsm.pprint(table)
     return True, "Success"
 
 

meerschaum/actions/stop.py

@@ -7,7 +7,8 @@ Stop running jobs that were started with `-d` or `start job`.
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import Optional, List, Dict, SuccessTuple, Any
+from meerschaum.utils.typing import Optional, List, SuccessTuple, Any
+
 
 def stop(action: Optional[List[str]] = None, **kw) -> SuccessTuple:
     """
@@ -111,6 +112,8 @@ def _stop_jobs(
         )
 
     if not jobs_to_stop:
+        if jobs:
+            return True, "The selected jobs are currently running."
         return False, "No running, paused or restarting jobs to stop."
 
     if not action:

meerschaum/actions/sync.py

@@ -287,7 +287,7 @@ def _sync_pipes(
     from meerschaum.utils.formatting._shell import progress
     from meerschaum.utils.formatting._shell import clear_screen
     from meerschaum.utils.formatting import print_pipes_results
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     from meerschaum.utils.misc import interval_str
 
     noninteractive_val = os.environ.get(STATIC_CONFIG['environment']['noninteractive'], None)

meerschaum/actions/tag.py

@@ -8,12 +8,12 @@ Functions for editing elements belong here.
 
 from __future__ import annotations
 import meerschaum as mrsm
-from meerschaum.utils.typing import List, Any, SuccessTuple, Optional, Dict
+from meerschaum.utils.typing import List, Any, SuccessTuple, Optional
 
 def tag(
-        action: Optional[List[str]] = None,
-        **kwargs: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Edit an existing element.
     """
@@ -25,10 +25,10 @@ def tag(
 
 
 def _tag_pipes(
-        action: Optional[List[str]] = None,
-        debug: bool = False,
-        **kwargs: Any
-    ) -> SuccessTuple:
+    action: Optional[List[str]] = None,
+    debug: bool = False,
+    **kwargs: Any
+) -> SuccessTuple:
     """
     Add or remove tags to registered pipes.
     Prefix a tag with a leading underscore to remove it.
@@ -68,6 +68,7 @@ def _tag_pipes(
                 pipe_was_edited = True
 
         if pipe_was_edited:
+            pipe.tags = pipe_tags
             edited_pipes.append(pipe)
 
     if not edited_pipes: