mcm-cli 0.45__py3-none-any.whl

mcm_cli-0.45.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

mcm_cli-0.45.dist-info/METADATA

@@ -0,0 +1,77 @@
+Metadata-Version: 2.1
+Name: mcm-cli
+Version: 0.45
+Summary: A command-line interface for Moloco Commerde Media
+Home-page: https://github.com/moloco-mcm/mcm-cli
+Author: Moloco MCM Team
+Author-email: mcm-help@moloco.com
+License: Apache-2.0 license
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: colorama
+Requires-Dist: gitpython
+Requires-Dist: pydantic
+Requires-Dist: pygithub
+Requires-Dist: python-terraform
+Requires-Dist: requests
+Requires-Dist: rich
+Requires-Dist: shortuuid
+Requires-Dist: toml
+Requires-Dist: typer
+
+# Moloco Commerce Media (MCM) CLI utility
+
+This tool is a command-line interface for the Moloco Commerce Media Platform, formerly known as the Retail Media Platform.
+
+Please contact the Moloco representative for more details.
+
+## How to install
+
+Run the command from a terminal.
+```
+git clone https://github.com/moloco-mcm/mcm-cli.git && pip install mcm-cli
+```
+
+## How to upgrade
+
+Run the command from a terminal.
+```
+git -C mcm-cli pull && pip install mcm-cli
+```
+
+## How to uninstall
+
+Run the command from a terminal.
+```
+pip uninstall mcm-cli
+```
+
+## How to use
+Run `$ mcm config init` to initialize the configuration. It saves the configuration to `~/.mcm/config.toml`.
+
+Use `--help` option to learn more of each command.
+
+```
+$ mcm --help
+
+ Usage: mcm [OPTIONS] COMMAND [ARGS]...
+
+╭─ Options ────────────────────────────────────────────────────────╮
+│ --help          Show this message and exit.                      │
+╰──────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────╮
+│ auth       Authentication management                             │
+│ config     Configurations                                        │
+│ version                                                          │
+│ wallet     Wallet management                                     │
+╰──────────────────────────────────────────────────────────────────╯
+
+$
+```
+
+© Moloco, Inc. 2023 All rights reserved. Released under Apache 2.0 License

mcm_cli-0.45.dist-info/NOTICE

@@ -0,0 +1 @@
+© Moloco, Inc. 2023 All rights reserved. Released under Apache 2.0 License

mcm_cli-0.45.dist-info/RECORD

@@ -0,0 +1,17 @@
+mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
+mcmcli/__main__.py,sha256=Mil8isMhqc3nzQyTDIfC8q3bgmM8jDHaIKtDupyj_xw,1267
+mcmcli/logging.py,sha256=xjRS5ey1ONx_d34qB1Fetb_SwPysoh2hzNDuNAaYYWQ,1739
+mcmcli/requests.py,sha256=50N_LiWIWr8-3EPs_yR9f4uEQf8rQ68s_FoMYRhgjzI,2343
+mcmcli/command/auth.py,sha256=QLdr_XFW5BVw9r4a7Kjj5BTBXpSux3AWI9eI03S8aiA,2480
+mcmcli/command/config.py,sha256=sdzge-l_Yi2P_TlTgSLqShcGyPCzpW3QJzctpIvc-g4,4195
+mcmcli/command/wallet.py,sha256=TB3WrmniREsDk0ui20p3ha6OZMwA2wAJaxQ9QDGtKnA,8968
+mcmcli/data/error.py,sha256=d6xa_jTXumlA0EzXy2PJQ86ajBb0Pm90fss9R3LuHUc,1094
+mcmcli/data/token.py,sha256=11wtyLHCAZHu0LVbNDPa-yipcL6lenxoYIKEI58VzFs,1744
+mcmcli/data/wallet.py,sha256=HvFJsRsPNRw-n_lwm6kAKlUxQbtnft97QFkHiS3StjY,1915
+mcm_cli-0.45.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+mcm_cli-0.45.dist-info/METADATA,sha256=4G0mNs2xqIgMeE3GkIoDDNiFxFIrl2hSrrWDFE9zkKA,2755
+mcm_cli-0.45.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
+mcm_cli-0.45.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
+mcm_cli-0.45.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
+mcm_cli-0.45.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
+mcm_cli-0.45.dist-info/RECORD,,

mcm_cli-0.45.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (71.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mcm_cli-0.45.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mcm = mcmcli.__main__:console_entry_point

mcm_cli-0.45.dist-info/top_level.txt

@@ -0,0 +1 @@
+mcmcli

mcmcli/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

mcmcli/__main__.py

@@ -0,0 +1,45 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#!/usr/bin/env python3
+
+"""mcm cli entry point script."""
+# mcmcli/__main__.py
+
+from typing import Optional
+
+import mcmcli.command.auth
+import mcmcli.command.config
+import mcmcli.command.wallet
+import mcmcli.logging
+import typer
+
+app = typer.Typer(add_completion=False)
+
+@app.command()
+def version():
+	"""
+	Show the tool version
+	"""
+	typer.echo(f"Version: mcm-cli v0.45")
+
+app.add_typer(mcmcli.command.auth.app, name="auth", help="Authentication management")
+app.add_typer(mcmcli.command.config.app, name="config", help="Configurations")
+app.add_typer(mcmcli.command.wallet.app, name="wallet", help="Wallet management")
+
+if __name__ == "__main__":
+	app()
+
+def console_entry_point():
+	app()

mcmcli/command/auth.py

@@ -0,0 +1,82 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from mcmcli.data.error import Error
+from mcmcli.data.token import Token
+from mcmcli.requests import CurlString, api_request
+
+import mcmcli.command.config
+import mcmcli.logging
+import sys
+import typer
+
+app = typer.Typer(add_completion=False)
+
+#
+# Typer commands
+#
+@app.command()
+def get_token(
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    to_json: bool = typer.Option(False, help="Print raw output in json"),
+    profile: str = "default",
+    ):
+    """
+    Get a new authentication token.
+    """
+    auth = AuthCommand(profile)
+    curl, error, token = auth.get_token(to_curl)
+
+    if to_curl:
+        print(curl)
+    elif error:
+        print(f"ERROR: {error.message}")
+    elif to_json:
+        print(token.model_dump_json())
+    else:
+        print(token.token)
+
+
+#
+# Command executors
+#
+class AuthCommand:
+    def __init__(self, profile):
+        self.config = mcmcli.command.config.get_config(profile)
+        mcmcli.command.config.assert_config_exists(self.config)
+
+        self.api_base_url = f"{self.config['management_api_hostname']}/rmp/mgmt/v1/platforms/{self.config['platform_id']}"
+        self.headers = {
+            "accept": "application/json",
+            "content-type": "application/json",
+        }
+        self.payload = {
+            "auth_type": "CREDENTIAL",
+            "credential_type_payload": {
+                "email": self.config['admin_email'],
+                "password": self.config['admin_password']
+            }
+        }
+    
+    def get_token(self, to_curl=False) -> tuple[CurlString, Error, Token]:
+        _api_url = f"{self.api_base_url}/tokens"
+
+        curl, error, json_obj = api_request('POST', to_curl, _api_url, self.headers, self.payload)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        return None, None, Token(**json_obj)
+

mcmcli/command/config.py

@@ -0,0 +1,120 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from enum import Enum
+from typing import Optional
+
+import os
+import sys
+import toml
+import typer
+
+DEFAULT_CONFIG_DIR = os.path.expanduser('~') + "/.mcm/"
+DEFAULT_CONFIG_FILE = os.path.expanduser('~') + "/.mcm/config.toml"
+
+#
+# Enum classes
+#
+
+class Profile(Enum):
+    default = "default"
+    shared = "shared"
+
+app = typer.Typer(add_completion=False)
+
+
+def get_config(profile = "default") -> Optional[dict]:
+    
+    if not os.path.exists(DEFAULT_CONFIG_FILE):
+        return None
+
+    with open(DEFAULT_CONFIG_FILE, "r") as f:
+        d = toml.load(f)
+
+    if profile in d:
+        return d[profile]
+
+    return None
+
+def assert_config_exists(config) -> None:
+    if config is None:
+        print(f"ERROR: the configuration file or the profile doesn't exist.")
+        sys.exit()
+
+@app.command()
+def init(profile: str = "default"):
+    """
+    The tool sets up the configuration file ~/.mcm/config.toml if it does not already exist.
+    By default, it creates the "default" profile.
+    To specify a different profile name, use the --profile option.
+    To save your GitHub token, run the following command:
+    `mcm config init --profile shared`
+    """
+    if not os.path.exists(DEFAULT_CONFIG_DIR):
+        # ~/.mcm directory doesn't exist. Create one.
+        os.mkdir(DEFAULT_CONFIG_DIR)
+
+    if not os.path.isdir(DEFAULT_CONFIG_DIR):
+        print("Error: A file ~/.mcm already exists. Please delete it so we tool can create ~/.mcm directory.")
+        sys.exit()
+
+    config = {}
+    if os.path.exists(DEFAULT_CONFIG_FILE):
+        with open(DEFAULT_CONFIG_FILE, "r") as f:
+            config = toml.load(f)
+
+    print(f"Creating a profile [{profile}] ...")
+    config[profile] = {
+        "platform_id":             typer.prompt("Platform ID"),
+        "admin_email":             typer.prompt("Your email address of the Campaign Manager"),
+        "admin_password":          typer.prompt("Password of the Campaign Manager"),
+        "currency":                typer.prompt("Currency in a three digit code like 'USD'", default="USD"),
+        "timezone":                typer.prompt("Timezone", default="unknown"),
+        "decision_api_hostname":   typer.prompt("Decision API hostname", default="unknown"),
+        "management_api_hostname": typer.prompt("Management API hostname", default="unknown"),
+        "event_api_hostname":      typer.prompt("Event API hostname", default="unknown"),
+        "decision_api_key":        typer.prompt("Decision API key", default="unknown"),
+        "decision_api_key_name":   typer.prompt("Friendly name of the decision API key", default="unknown"),
+        "event_api_key":           typer.prompt("Event API key", default="unknown"),
+        "event_api_key_name":      typer.prompt("Friendly name of the event API key", default="unknown"),
+    }
+    print(f"The profile [{profile}] has been created.")
+
+    with open(DEFAULT_CONFIG_FILE, "w") as f:
+        toml.dump(config, f)
+    print("Configuration saved to ~/.mcm/config.toml")
+
+@app.command()
+def list(profile: str = "default"):
+    """
+    This command lists the profile name, decision api, managmement api, event api,
+    decision api key, event api key, admin email and password.
+    It will be retrieved from the ~/.mcm/config.toml
+    """
+    c = get_config(profile)
+    if c is None:
+        return
+
+    for k, v in c.items():
+        print(f"{k}: {v}")
+
+@app.command()
+def list_profiles():
+    """
+    To list all your profile names, use the `mcm config list-profiles` command.
+    """
+    with open(DEFAULT_CONFIG_FILE) as f:
+        d = toml.load(f)
+        for profiles in d:
+            print(profiles)

mcmcli/command/wallet.py

@@ -0,0 +1,259 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from enum import Enum
+from mcmcli.data.error import Error
+from mcmcli.data.wallet import Wallet, WalletsWrapper
+from mcmcli.requests import CurlString, api_request
+
+import json
+import mcmcli.command.auth
+import mcmcli.command.config
+import mcmcli.logging
+import mcmcli.requests
+import shortuuid
+import sys
+import typer
+
+app = typer.Typer(add_completion=False)
+
+class FundType(Enum):
+    CREDITS = "CREDITS"
+    PRE_PAID = "PRE_PAID"
+
+class OperationType(Enum):
+    DEPOSIT = "deposit"
+    WITHDRAW = "withdraw"
+
+@app.command()
+def balance(
+    account_id: str = typer.Option(help="Ad account ID"), 
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    to_json: bool = typer.Option(False, help="Print raw output in json"),
+    profile: str = "default",
+    ):
+    """
+    Retrive the current balance of the given ad account's wallet.
+    """
+    auth = mcmcli.command.auth.AuthCommand(profile)
+    curl, error, token = auth.get_token()
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    wc = WalletCommand(profile, token.token)
+    curl, error, wallet = wc.get_balance(account_id, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if to_json:
+        print(wallet.model_dump_json())
+        return
+    
+    wa0 = wallet.accounts[0]
+    wa1 = wallet.accounts[1]
+
+    credits_amount_micro  = wa0.balance.amount_micro if wa0.type == 'CREDITS' else wa1.balance.amount_micro
+    pre_paid_amount_micro = wa0.balance.amount_micro if wa0.type == 'PRE_PAID' else wa1.balance.amount_micro
+    credit_amount = float(credits_amount_micro) / float(1000000)
+    money_amount = float(pre_paid_amount_micro) / float(1000000)
+
+    print(f"Ad account ID = {account_id}")
+    print(f"Wallet ID = {wallet.id}")
+    print(f"PRE_PAID balance = {money_amount}")
+    print(f"CREDITS balance = {credit_amount}")
+    return
+
+
+@app.command()
+def deposit(
+    account_id: str = typer.Option(help="Ad account ID"), 
+    fund_type: FundType = typer.Option(help="CREDITS or PREPAID"),
+    fund_amount: float = typer.Option(help="The fund amount to deposit"), 
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    to_json: bool = typer.Option(False, help="Print raw output in json"),
+    profile: str = "default",
+    ):
+    """
+    Add or top up the money amount to the current balance of the given ad account's wallet.
+    """
+    auth = mcmcli.command.auth.AuthCommand(profile)
+    curl, error, token = auth.get_token()
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    wc = WalletCommand(profile, token.token)
+
+    # Check the wallet first
+    curl, error, wallet = wc.get_balance(account_id, to_curl=False)
+    if curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    # Deposit funds
+    curl, error, wallet = wc.update_balance(OperationType.DEPOSIT, account_id, wallet.id, fund_type, fund_amount, to_curl)
+    if curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if to_json:
+        print(wallet.model_dump_json())
+        return
+
+    wa0 = wallet.accounts[0]
+    wa1 = wallet.accounts[1]
+    credits_amount_micro  = wa0.balance.amount_micro if wa0.type == 'CREDITS' else wa1.balance.amount_micro
+    pre_paid_amount_micro = wa0.balance.amount_micro if wa0.type == 'PRE_PAID' else wa1.balance.amount_micro
+    credits_amount  = float(credits_amount_micro)  / float(1000000)
+    pre_paid_amount = float(pre_paid_amount_micro) / float(1000000)
+
+    print(f"Deposited to the wallet. Currence balance of the ad account id {account_id} is {pre_paid_amount} for PRE_PAID and {credits_amount} for CREDITS.")
+    return
+
+@app.command()
+def withdraw(
+    account_id: str = typer.Option(help="Ad account ID"), 
+    fund_type: FundType = typer.Option(help="CREDITS or PREPAID"),
+    fund_amount: float = typer.Option(help="The amount of credit to add"), 
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    to_json: bool = typer.Option(False, help="Print raw output in json"),
+    profile: str = "default",
+    ):    
+    """
+    Withdraws the money amount from the current balance of the given ad account's wallet.
+    """
+    auth = mcmcli.command.auth.AuthCommand(profile)
+    curl, error, token = auth.get_token()
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    wc = WalletCommand(profile, token.token)
+
+    # Check the wallet first
+    curl, error, wallet = wc.get_balance(account_id, to_curl=False)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    # Withdraw funds
+    curl, error, wallet = wc.update_balance(OperationType.WITHDRAW, account_id, wallet.id, fund_type, fund_amount, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if to_json:
+        print(wallet.model_dump_json())
+        return
+
+    wa0 = wallet.accounts[0]
+    wa1 = wallet.accounts[1]
+    credits_amount_micro  = wa0.balance.amount_micro if wa0.type == 'CREDITS' else wa1.balance.amount_micro
+    pre_paid_amount_micro = wa0.balance.amount_micro if wa0.type == 'PRE_PAID' else wa1.balance.amount_micro
+    credits_amount  = float(credits_amount_micro)  / float(1000000)
+    pre_paid_amount = float(pre_paid_amount_micro) / float(1000000)
+
+    print(f"Withdrew the funds from to the wallet. Currence balance of the ad account id {account_id} is {pre_paid_amount} for PRE_PAID and {credits_amount} for CREDITS.")
+    return
+
+class WalletCommand:
+    def __init__(self, profile, token):
+        self.config = mcmcli.command.config.get_config(profile)
+        mcmcli.command.config.assert_config_exists(self.config)
+
+        self.api_base_url = f"{self.config['management_api_hostname']}/rmp/mgmt/v1/platforms/{self.config['platform_id']}"
+        self.headers = {
+            "accept": "application/json",
+            "content-type": "application/json",
+            "Authorization": f"Bearer {token}"
+        }
+
+    def get_balance(
+        self,
+        account_id: str,
+        to_curl: bool,
+    ) -> tuple[
+        None | CurlString,
+        None | Error,
+        None | Wallet,
+    ]:
+        _api_url = f"{self.api_base_url}/ad-accounts/{account_id}/wallets"
+
+        curl, error, json_obj = api_request('GET', to_curl, _api_url, self.headers)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+        
+        wallets_wrapper = WalletsWrapper(**json_obj)
+        if not wallets_wrapper.wallets:
+            return None, Error(code=0, message="Wallet doesn't exist"), None
+
+        wallet = wallets_wrapper.wallets[0] # The MCM supports one wallet per account as of March 2024.
+        return None, None, wallet
+
+    def update_balance(
+        self,
+        operation_type: OperationType,
+        account_id: str,
+        wallet_id: str,
+        fund_type: FundType,
+        fund_amount: float,
+        to_curl: bool,
+    ) -> tuple[
+        None | CurlString,
+        None | Error,
+        None | Wallet,
+    ]:      
+        if fund_amount <= 0:
+            return None, Error(code=0, message="The fund amount should be greater than zero."), None
+
+        _api_url = f"{self.api_base_url}/ad-accounts/{account_id}/wallets/{wallet_id}"
+        _request_id = str(shortuuid.ShortUUID().random(length=16))
+        if operation_type == OperationType.DEPOSIT:
+            _api_url += f"/top-up/{_request_id}"
+        else:
+            _api_url += f"/withdraw/{_request_id}"
+
+        _message = {
+            "type": fund_type.value,
+            "amount": {
+                "currency": self.config['currency'],
+                "amount_micro": int(fund_amount * 1000000)
+            }
+        }
+        _payload = { "top_up": _message } if operation_type == operation_type.DEPOSIT else { "withdraw": _message }
+
+        curl, error, json_obj = api_request('PUT', to_curl, _api_url, self.headers, _payload)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        wallet = Wallet(**json_obj['wallet'])
+        return None, None, wallet

mcmcli/data/error.py

@@ -0,0 +1,34 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pydantic import BaseModel
+
+#
+# API error response dataclasses
+#
+# get-token command's example error response is as below:
+#
+# {
+#     "code": 16,
+#     "message": "{\"reason\":\"the given credential doesn't match with database record\",\"status\":401}\n [id:Fd35MbLKRZyTQxo3]",
+#     "details": [
+#         {
+#             "@type": "type.googleapis.com/api.adcloud.common.ErrorInfo",
+#             "category": "DEFAULT_ERROR_CATEGORY"
+#         }
+#     ]
+# }
+class Error(BaseModel):
+    code: int
+    message: str

mcmcli/data/token.py

@@ -0,0 +1,64 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pydantic import BaseModel
+
+#
+# API response dataclasses
+#
+# get-token command's example response is as below:
+#
+# {
+#     'token': 'eyJhbGciOiJpD4', 
+#     'expires_at': '2024-03-09T19:57:46Z', 
+#     'user': {
+#         'id': 'QFrrnyjtf2bGtHDLgbno', 
+#         'email': 'user@example.com', 
+#         'name': 'Ada Lovelace', 
+#         'roles': [
+#             {
+#                 'name': 'PLATFORM_STAFF', 
+#                 'resource_type': 'PLATFORM', 
+#                 'resource_id': 'MYPLATFORM_TEST'
+#             }, 
+#             {
+#                 'name': 'PLATFORM_USER', 
+#                 'resource_type': 'PLATFORM', 
+#                 'resource_id': 'MYPLATFORM_TEST'
+#             }
+#         ], 
+#         'status': 'NOT_REGISTERED', 
+#         'created_at': '2023-10-28T16:38:47Z', 
+#         'updated_at': '2023-12-12T21:27:41Z'
+#     }
+# }
+#
+class Role(BaseModel):
+    name: str
+    resource_type: str
+    resource_id: str
+
+class User(BaseModel):
+    id: str
+    email: str
+    name: str
+    roles: list[Role]
+    status: str
+    created_at: str
+    updated_at: str
+
+class Token(BaseModel):
+    token: str
+    expires_at: str
+    user: User

mcmcli/data/wallet.py

@@ -0,0 +1,69 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pydantic import BaseModel
+
+#
+# API response dataclasses
+#
+# The balance command's example response is as below:
+#
+# {
+#     "wallets": [
+#         {
+#             "id": "TjNwMMlONkaMqNyn",
+#             "title": "",
+#             "ad_account_id": "side_bar_1-ME",
+#             "type": "PRE_PAYMENT",
+#             "accounts": [
+#                 {
+#                     "type": "CREDITS",
+#                     "balance": {
+#                         "currency": "USD",
+#                         "amount_micro": "1000000"
+#                     }
+#                 },
+#                 {
+#                     "type": "PRE_PAID",
+#                     "balance": {
+#                         "currency": "USD",
+#                         "amount_micro": "1002011000000"
+#                     }
+#                 }
+#             ],
+#             "created_at": "2024-02-29T21:24:21.743177Z",
+#             "updated_at": "2024-03-04T16:41:25.717512Z"
+#         }
+#     ]
+# }
+
+class MicroPrice(BaseModel):
+    currency: str
+    amount_micro: str
+
+class WalletAccount(BaseModel):
+    type: str
+    balance: MicroPrice
+
+class Wallet(BaseModel):
+    id: str
+    title: str
+    ad_account_id: str
+    type: str
+    accounts: list[WalletAccount]
+    created_at: str
+    updated_at: str
+
+class WalletsWrapper(BaseModel):
+    wallets: list[Wallet]

mcmcli/logging.py

@@ -0,0 +1,53 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import sys
+import threading
+import time
+import typer
+
+def print_error(api_url, message):
+    # Something's wrong. Print error and exit.
+
+    _msg = typer.style(f"\nERROR: {message}", fg=typer.colors.RED, bold=True)
+    typer.echo(_msg, file=sys.stderr)
+
+    _msg = typer.style(f"URL = {api_url}", fg=typer.colors.YELLOW, bold=True)
+    typer.echo(_msg, file=sys.stderr)
+
+    friendly_message = "Check if you used the accurate values of the API hostname, Platform ID, and Ad Account ID."
+    _msg = typer.style(friendly_message, fg=typer.colors.WHITE, bold=True)
+    typer.echo(_msg, file=sys.stderr)
+
+def _print_dot(stopper):
+    while not stopper.is_set():
+        print(".", file=sys.stderr, end="", flush=True)
+        time.sleep(1)
+
+def start_dot_printing():
+    stopper = threading.Event()
+    thread = threading.Thread(target=_print_dot, args=[stopper])
+    thread.setDaemon(True)
+    thread.start()
+    return (thread, stopper)
+
+def stop_dot_printing(thread, stopper):
+    stopper.set()
+    thread.join()
+
+def echo(message):
+    print(message, file=sys.stderr, end="", flush=True)
+
+def echo_newline(message):
+    print(message, file=sys.stderr, flush=True)

mcmcli/requests.py

@@ -0,0 +1,78 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from mcmcli.data.error import Error
+
+import json
+import requests
+import sys
+
+CurlString = str
+
+def to_curl_str(method, api_base_url, headers, payload = None):
+    c = f"""curl --request {method} \\
+     --url {api_base_url} \\     
+"""
+    for k in headers:
+        c = c + f"     --header '{k}: {headers[k]}' \\\n"
+    if payload is None:
+        c = c + "\n"
+    else:
+        c = c + f"     --data '\n"
+        c = c + json.dumps(payload, indent=4)
+        c = c + f"\n'"
+    return c
+
+def get(url, headers):
+    try:
+        res = requests.get(url, headers=headers)
+        return None, json.loads(res.text)
+    except Exception as e:
+        return e, None
+
+def post(url, headers, payload):
+    try:
+        res = requests.post(url, headers=headers, json=payload)
+        return None, json.loads(res.text)
+    except Exception as e:
+        return  e, None
+
+def put(url, headers, payload):
+    try:
+        res = requests.put(url, headers=headers, json=payload)
+        return None, json.loads(res.text)
+    except Exception as e:
+        return e, None
+
+def api_request(method, to_curl, url, headers, payload=None) -> tuple[CurlString, Error, dict]:
+    if to_curl:
+        curl = to_curl_str(method, url, headers, payload)
+        return curl, None, None
+
+    if method == 'GET':
+        error, json_obj = get(url, headers)
+    elif method == 'POST':
+        error, json_obj = post(url, headers, payload)
+    elif method == 'PUT':
+        error, json_obj = put(url, headers, payload)
+    else:
+        return None, Error(code=0, message="Unsupported HTTP method"), None
+    
+    if error:
+        return None, Error(code=0, message=str(error)), None
+    if 'code' in json_obj:
+        return None, Error(**json_obj), None
+
+    return None, None, json_obj
+