apigeecli 0.53.3__tar.gz → 0.53.5__tar.gz

{apigeecli-0.53.3/apigeecli.egg-info → apigeecli-0.53.5}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
 Name: apigeecli
-Version: 0.53.3
-Summary: apigee-cli is an unofficial command-line interface tool designed to simplify the use of the Apigee Edge Management API
+Version: 0.53.5
+Summary: The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
 Home-page: https://github.com/darumatic/apigee-cli
 Author: Matthew Delotavo
 Author-email: matthew.t.delotavo@gmail.com
 License: Apache license 2.0
 Project-URL: Documentation, https://darumatic.github.io/apigee-cli/index.html
+Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -22,23 +23,25 @@ License-File: NOTICE
 apigee-cli
 ==========
 
-⚠️ **Warning:** This project is no longer actively maintained and was created specifically for previous Darumatic clients.
+|Python version| |Downloads| |License|
 
-|License| |Python version| |Downloads|
+.. warning::
 
-apigee-cli is a command-line interface tool designed to simplify the use of the Apigee Edge Management API. 
-It provides a user-friendly experience with features such as SSO support.
+   This tool is no longer actively maintained.
 
-It can be used for general administrative tasks, as a developer package, 
-and to support automation for common development tasks such as CI/CD. 
+The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
 
-With the apigee-cli, you can manage your Apigee Edge credentials using environment variables, config files, 
-or command-line arguments. 
+Initially developed for Darumatic clients, this project remains available as a working proof of concept, proven reliable in production CI/CD pipelines. The custom plugins feature will remain functional even if Apigee Edge APIs stop working.
 
-The tool is highly experimental and is not affiliated with Apigee or Google. 
+I have created private forks for clients, where I continued to add features, fixes, and unit tests. However, I do not intend to maintain this public version. Feel free to explore and learn from the code.
 
-For more information on getting started with the apigee-cli or for troubleshooting help, 
-refer to the documentation and links provided.
+If you’re up for a challenge, try updating the code to work with Apigee X (ง•_•)ง
+
+-----------------------------------------
+Why use this instead of the official tool
+-----------------------------------------
+
+The `official Apigee CLI`_ is powerful and may suit your needs. However, I built this version to better support our CI/CD processes, self-service operations, and DevOps workflows that are difficult to manage with the official tool.
 
 ------------
 Installation
@@ -125,24 +128,23 @@ Run the following command to get a list of API proxies in your ``default`` Apige
     $ apigee apis list
     ["helloworld", "oauth"]
 
---------------------
-Why does this exist?
---------------------
+-------------
+Running Tests
+-------------
+
+This project uses `unittest` for testing its codebase. In order to run the tests, you will need to install the `coverage.py` tool. You can install it using pip:
+
+.. code-block:: bash
 
-It is intended for general administrative use from your shell, as a package for developers,
-and to support automation for common development tasks, such as test automation
-or Continuous Integration/Continuous Deployment (CI/CD).
+   pip3 install coverage
 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-When to use this over the official tool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Once `coverage.py` is installed, you can run the tests using the `runtests` script:
 
-Apigee Corporation maintains their own `fully-featured CLI`_ for the Apigee Management API
-that can be used as an SDK to orchestrate tasks and may be more than suitable for your needs.
+.. code-block:: bash
 
-We built and use the Apigee CLI to implement and distribute features that allow our clients
-to manage CI/CD, perform self-service operations and promote our DevOps workflows
-which are difficult to perform using official tools.
+   ./runtests
+
+This script will run all the tests in the `tests` directory and generate a coverage report.
 
 ------------
 Getting Help
@@ -163,10 +165,11 @@ For further questions, feel free to contact us at hello@darumatic.com.
 ----------
 Disclaimer
 ----------
-This is not an officially supported Google product.
+
+This tool is not affiliated with Apigee or Google and is highly experimental.
 
 
-.. _`fully-featured CLI`: https://github.com/apigee/apigeetool-node
+.. _`official Apigee CLI`: https://github.com/apigee/apigeetool-node
 
 .. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg
     :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22
@@ -224,3 +227,5 @@ This is not an officially supported Google product.
 
 .. _`Apigee CI/CD Docker releases`: https://hub.docker.com/r/darumatic/apigee-cicd
 
+
+

{apigeecli-0.53.3 → apigeecli-0.53.5}/README.rst

@@ -2,23 +2,25 @@
 apigee-cli
 ==========
 
-⚠️ **Warning:** This project is no longer actively maintained and was created specifically for previous Darumatic clients.
+|Python version| |Downloads| |License|
 
-|License| |Python version| |Downloads|
+.. warning::
 
-apigee-cli is a command-line interface tool designed to simplify the use of the Apigee Edge Management API. 
-It provides a user-friendly experience with features such as SSO support.
+   This tool is no longer actively maintained.
 
-It can be used for general administrative tasks, as a developer package, 
-and to support automation for common development tasks such as CI/CD. 
+The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
 
-With the apigee-cli, you can manage your Apigee Edge credentials using environment variables, config files, 
-or command-line arguments. 
+Initially developed for Darumatic clients, this project remains available as a working proof of concept, proven reliable in production CI/CD pipelines. The custom plugins feature will remain functional even if Apigee Edge APIs stop working.
 
-The tool is highly experimental and is not affiliated with Apigee or Google. 
+I have created private forks for clients, where I continued to add features, fixes, and unit tests. However, I do not intend to maintain this public version. Feel free to explore and learn from the code.
 
-For more information on getting started with the apigee-cli or for troubleshooting help, 
-refer to the documentation and links provided.
+If you’re up for a challenge, try updating the code to work with Apigee X (ง•_•)ง
+
+-----------------------------------------
+Why use this instead of the official tool
+-----------------------------------------
+
+The `official Apigee CLI`_ is powerful and may suit your needs. However, I built this version to better support our CI/CD processes, self-service operations, and DevOps workflows that are difficult to manage with the official tool.
 
 ------------
 Installation
@@ -105,24 +107,23 @@ Run the following command to get a list of API proxies in your ``default`` Apige
     $ apigee apis list
     ["helloworld", "oauth"]
 
---------------------
-Why does this exist?
---------------------
+-------------
+Running Tests
+-------------
+
+This project uses `unittest` for testing its codebase. In order to run the tests, you will need to install the `coverage.py` tool. You can install it using pip:
 
-It is intended for general administrative use from your shell, as a package for developers,
-and to support automation for common development tasks, such as test automation
-or Continuous Integration/Continuous Deployment (CI/CD).
+.. code-block:: bash
 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-When to use this over the official tool
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+   pip3 install coverage
 
-Apigee Corporation maintains their own `fully-featured CLI`_ for the Apigee Management API
-that can be used as an SDK to orchestrate tasks and may be more than suitable for your needs.
+Once `coverage.py` is installed, you can run the tests using the `runtests` script:
 
-We built and use the Apigee CLI to implement and distribute features that allow our clients
-to manage CI/CD, perform self-service operations and promote our DevOps workflows
-which are difficult to perform using official tools.
+.. code-block:: bash
+
+   ./runtests
+
+This script will run all the tests in the `tests` directory and generate a coverage report.
 
 ------------
 Getting Help
@@ -143,10 +144,11 @@ For further questions, feel free to contact us at hello@darumatic.com.
 ----------
 Disclaimer
 ----------
-This is not an officially supported Google product.
+
+This tool is not affiliated with Apigee or Google and is highly experimental.
 
 
-.. _`fully-featured CLI`: https://github.com/apigee/apigeetool-node
+.. _`official Apigee CLI`: https://github.com/apigee/apigeetool-node
 
 .. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg
     :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22

{apigeecli-0.53.3 → apigeecli-0.53.5}/apigee/__init__.py

@@ -6,9 +6,9 @@ from apigee import utils_init
 
 APP = "apigeecli"
 CMD = "apigee"
-__version__ = "0.53.3"
-description = "apigee-cli is an unofficial command-line interface tool designed to simplify the use of the Apigee Edge Management API"
-long_description = """apigee-cli is an unofficial command-line interface tool designed to simplify the use of the Apigee Edge Management API. It provides a user-friendly experience with features such as SSO support. It can be used for general administrative tasks, as a developer package, and to support automation for common development tasks such as CI/CD. With the apigee-cli, you can manage your Apigee Edge credentials using environment variables, config files, or command-line arguments. The tool is highly experimental and is not affiliated with Apigee or Google. For more information on getting started with the apigee-cli or for troubleshooting help, refer to the documentation and links provided."""
+__version__ = "0.53.5"
+description = "The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication."
+long_description = """This tool is no longer actively maintained. Initially developed for Darumatic clients, this project remains available as a working proof of concept, proven reliable in production CI/CD pipelines. The custom plugins feature will remain functional even if Apigee Edge APIs stop working."""
 
 APIGEE_CLI_DIRECTORY = utils_init.join_path_components(Path.home(), ".apigee")
 APIGEE_CLI_PLUGINS_DIRECTORY = utils_init.join_path_components(APIGEE_CLI_DIRECTORY, "plugins")

{apigeecli-0.53.3 → apigeecli-0.53.5}/apigee/auth.py

@@ -37,21 +37,21 @@ def attach_is_token_option(func, profile):
             "--token/--no-token",
             default=is_token,
             show_default=True,
-            help="specify to use oauth without MFA",
+            help="specify to use OAuth without MFA",
         )(func)
     elif is_token_envvar in (True, "True", "true", "1"):
         func = click.option(
             "--token/--no-token",
             default=is_token_envvar,
             show_default=True,
-            help="specify to use oauth without MFA",
+            help="specify to use OAuth without MFA",
         )(func)
     else:
         func = click.option(
             "--token/--no-token",
             default=False,
             show_default=True,
-            help="specify to use oauth without MFA",
+            help="specify to use OAuth without MFA",
         )(func)
     return func
 
@@ -222,75 +222,68 @@ def get_access_token_for_mfa(
         )
 
 
-def get_access_token(auth, username, password, oauth_url, post_headers, session):
+def get_access_token(auth, username, password, oauth_url, post_headers, session, passcode):
     if auth.token or APIGEE_CLI_IS_MACHINE_USER:
         return get_access_token_for_token(auth, username, password, oauth_url, post_headers, session)
     elif auth.mfa_secret:
         return get_access_token_for_mfa(auth, username, password, oauth_url, post_headers, session)
     elif auth.zonename:
-        return get_access_token_for_sso(auth, username, password, oauth_url, post_headers, session)
+        return get_access_token_for_sso(auth, username, password, oauth_url, post_headers, session, passcode)
 
 
 def get_access_token_for_sso(
-    auth, username, password, oauth_url, post_headers, session
+    auth, username, password, oauth_url, post_headers, session, passcode
 ):
     refresh_token = validate_refresh_token(auth)
     oauth_url = APIGEE_ZONENAME_OAUTH_URL.format(zonename=auth.zonename)
     passcode_url = APIGEE_SAML_LOGIN_URL.format(zonename=auth.zonename)
+
     if not refresh_token:
-        post_body = get_sso_access_token_parameters(passcode_url)
+        if not passcode:
+            passcode = get_sso_temporary_authentication_code(passcode_url)
+        post_body = f"passcode={passcode}&grant_type=password&response_type=token"
     else:
         # Should we notify users that the refresh token is being used to verify the access token?
         #console.echo("Refresh Token found, renewing access token with Refresh Token...")
         post_body = f"grant_type=refresh_token&refresh_token={refresh_token}"
 
     try:
-        try:
-            response_post = session.post(
-                f"{oauth_url}", headers=post_headers, data=post_body
-            )
-            response_data = response_post.json()
-            response_data["access_token"]
-            # If we didn't have a refresh token previously, save the refresh token we just got.
-            if not refresh_token:
-                with open(APIGEE_CLI_REFRESH_TOKEN_FILE, "w") as f:
-                    f.write(response_data["refresh_token"])
-            return response_data
-        except KeyError:
-            sys.exit("Temporary Authentication Code or Refresh Token is invalid. Please try again.")
+        response_post = session.post(
+            f"{oauth_url}", headers=post_headers, data=post_body
+        )
+        response_data = response_post.json()
+        response_data["access_token"]
+
+        # If we didn't have a refresh token previously, save the refresh token we just got.
+        if not refresh_token:
+            with open(APIGEE_CLI_REFRESH_TOKEN_FILE, "w") as f:
+                f.write(response_data["refresh_token"])
+        return response_data
+    except KeyError:
+        sys.exit("Temporary Authentication Code or Refresh Token is invalid. Please try again.")
     except ConnectionError as ce:
         console.echo(ce)
-    except KeyError:
-        pass
 
 
 def get_config_value(config_section, config_key):
-    try:
-        config = configparser.ConfigParser()
-        config.read(APIGEE_CLI_CREDENTIALS_FILE)
-        if config_section in config:
+    config = configparser.ConfigParser()
+    config.read(APIGEE_CLI_CREDENTIALS_FILE)
+    if config_section in config:
+        if config_key in config[config_section]:
             return config[config_section][config_key]
-    except Exception:
-        return
 
 
-def get_sso_access_token_parameters(passcode_url):
+def get_sso_temporary_authentication_code(passcode_url):
     webbrowser.open(passcode_url)
-    console.echo(
-        "SSO authorization page has automatically been opened in your default browser."
-    )
-    console.echo(
-        "Follow the instructions in the browser to complete this authorization request."
-    )
-    console.echo(
-        f"""\nIf your browser did not automatically open, go to the following URL and sign in:\n\n{passcode_url}\n\nthen copy the Temporary Authentication Code.\n"""
-    )
+    console.echo("SSO authorization page has automatically been opened in your default browser.")
+    console.echo("Follow the instructions in the browser to complete this authorization request.")
+    console.echo(f"""\nIf your browser did not automatically open, go to the following URL and sign in:\n\n{passcode_url}\n\nthen copy the Temporary Authentication Code.\n""")
 
     passcode = click.prompt("Please enter the Temporary Authentication Code")
-    return f"passcode={passcode}&grant_type=password&response_type=token"
+    return passcode
 
 
-def retrieve_access_token(authentication, session=None):
+def retrieve_access_token(authentication, passcode=None):
     oauth_url = APIGEE_OAUTH_URL
     username = authentication.username
     password = authentication.password
@@ -302,7 +295,7 @@ def retrieve_access_token(authentication, session=None):
         "Accept": "application/json;charset=utf-8",
         "Authorization": "Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0",
     }
-    response_data = get_access_token(authentication, username, password, oauth_url, post_headers, session)
+    response_data = get_access_token(authentication, username, password, oauth_url, post_headers, session, passcode)
     try:
         return response_data["access_token"]
     except KeyError as error:
@@ -366,19 +359,18 @@ def auth():
     pass
 
 
-@auth.command(name="get-access-token", help="request a fresh access token")
+@auth.command(name="get-access-token", help="Request a fresh access token")
 @common_auth_options
 @common_verbose_options
 @common_silent_options
+@click.option('--passcode', help='Apigee SAML temporary authentication code to use when getting an Apigee access token (optional)')
 def get_access_token_command(
-    username, password, mfa_secret, token, zonename, org, profile, **kwargs
+    username, password, mfa_secret, token, zonename, org, profile, passcode, **kwargs
 ):
-    console.echo(
-        retrieve_access_token(generate_authentication(username, password, mfa_secret, token, zonename))
-    )
+    console.echo(retrieve_access_token(generate_authentication(username, password, mfa_secret, token, zonename), passcode))
 
 
-@auth.command(help="view the current access token")
+@auth.command(help="View the current access token")
 @common_auth_options
 @common_verbose_options
 @common_silent_options
@@ -392,11 +384,7 @@ def view_access_token(
         console.echo(validate_access_token(authentication_object))
     else:
         # Show the user/password base64 basic auth value
-        console.echo(
-            base64.b64encode(
-                f"{authentication_object.username}:{authentication_object.password}".encode()
-            ).decode()
-        )
+        console.echo(base64.b64encode(f"{authentication_object.username}:{authentication_object.password}".encode()).decode())
 
 
 @auth.command(help="Clear cached access token and refresh token")

{apigeecli-0.53.3 → apigeecli-0.53.5}/apigee/encryption_utils.py

@@ -1,5 +1,4 @@
 import base64
-
 import gnupg
 
 ENCRYPTED_HEADER_BEGIN = "-----BEGIN ENCRYPTED APIGEE CLI MESSAGE-----"
@@ -8,22 +7,20 @@ ENCRYPTED_HEADER_END = "-----END ENCRYPTED APIGEE CLI MESSAGE-----"
 
 def encrypt_message_with_gpg(secret, message, encoded=True):
     gpg = gnupg.GPG()
-    if encoded:
-        return base64.b64encode(
-            str(
-                gpg.encrypt(
-                    message, symmetric="AES256", passphrase=secret, recipients=None
-                )
-            ).encode()
-        ).decode()
-    return str(
-        gpg.encrypt(message, symmetric="AES256", passphrase=secret, recipients=None)
+    encrypted_message = gpg.encrypt(
+        message, symmetric="AES256", passphrase=secret, recipients=None
     )
+    if encoded:
+        return base64.b64encode(str(encrypted_message).encode()).decode()
+    return str(encrypted_message)
 
 
 def has_encrypted_header(message):
-    return message.startswith(ENCRYPTED_HEADER_BEGIN) and message.endswith(
-        ENCRYPTED_HEADER_END
+    if not isinstance(message, str):
+        return False
+    return (
+        message.startswith(ENCRYPTED_HEADER_BEGIN)
+        and message.endswith(ENCRYPTED_HEADER_END)
     )
 
 
@@ -33,5 +30,6 @@ def decrypt_message_with_gpg(secret, message, encoded=True):
         return ""
     message = message[len(ENCRYPTED_HEADER_BEGIN) : -len(ENCRYPTED_HEADER_END)]
     if encoded:
-        return str(gpg.decrypt(base64.b64decode(message).decode(), passphrase=secret))
+        decoded_message = base64.b64decode(message).decode()
+        return str(gpg.decrypt(decoded_message, passphrase=secret))
     return str(gpg.decrypt(message, passphrase=secret))