mcm-cli 1.4.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

{mcm_cli-1.4.0.dist-info → mcm_cli-1.4.1.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.4.0
+Version: 1.4.1
 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: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
@@ -20,6 +20,7 @@ Requires-Dist: pygithub
 Requires-Dist: python-terraform
 Requires-Dist: requests
 Requires-Dist: rich
+Requires-Dist: setuptools
 Requires-Dist: shortuuid
 Requires-Dist: toml
 Requires-Dist: typer

mcm_cli-1.4.1.dist-info/RECORD

@@ -0,0 +1,32 @@
+mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
+mcmcli/__main__.py,sha256=wbiwdsy9Sq1Ebv93G6LlnH7wTb2SUT5gRxxFF9w5Hgc,1844
+mcmcli/logging.py,sha256=xjRS5ey1ONx_d34qB1Fetb_SwPysoh2hzNDuNAaYYWQ,1739
+mcmcli/requests.py,sha256=IuySBQ8P_GoGF3f_TRysfgQNOhi2n9M84WK_eRXnoEU,2945
+mcmcli/command/account.py,sha256=FWXmzOLj4rVLVLEv-w0eDVlQVrkONvR1UewZbcTDgE4,24994
+mcmcli/command/admin.py,sha256=05Ti5nMnuL_Ppo8hy2_bMGwfNZGdN6s528Gpi-EnpDg,16036
+mcmcli/command/auth.py,sha256=Ak7ZNEskWPpMoeTJcbYlEpDBgzxn8N33Q2dNf67SsCs,2926
+mcmcli/command/campaign.py,sha256=SU6TrDy6YhqM0JWPzbYWLpXZrz7Ymw31pd168dK2LZk,10638
+mcmcli/command/config.py,sha256=08C5ftAvdvpQ26Z329LqhP8AxTI629LS7Ou6glzrRgw,4396
+mcmcli/command/decision.py,sha256=iLvEDEa2k0LAgoXrOvcdn-HcFRo90E8Dxht_Ls9EGCY,8690
+mcmcli/command/report.py,sha256=N8IMyDZ5QpY11-KkZG-n5_ZzEeh-ME5s2s3wrAKEGjY,5387
+mcmcli/command/wallet.py,sha256=vG2rg7tPwGsV9YB7cpvkiocbqtB1reqXn7dmolFmzD4,11536
+mcmcli/data/account.py,sha256=pe7tPapP6vlUD5D5L5Nh5k2bkWdYOK01Mpt5fBYFnJs,1782
+mcmcli/data/account_user.py,sha256=27nQp52nMma5a3QszSJGqgq5Z0ivIb-nMZcZuhEgbEg,1328
+mcmcli/data/campaign.py,sha256=vUukEsZ9Lzvcqm4Pa8z7vzyt_qOpT_t6_YEXuLubVSQ,1731
+mcmcli/data/decision.py,sha256=bQ5j_PbPRSFa0sY5g9UVqdNzl_2epchcz1lHoDVuV90,2880
+mcmcli/data/error.py,sha256=d6xa_jTXumlA0EzXy2PJQ86ajBb0Pm90fss9R3LuHUc,1094
+mcmcli/data/item.py,sha256=Z2xTRhU8T4vyJADO0l6-XPyQXvb9DX_OAjExhSXpW2A,1091
+mcmcli/data/item_blocking_result.py,sha256=daK4c8--aCe2vRsnTzLBjgKQo0C-zcDH09dC0GgrN7E,1429
+mcmcli/data/platform_user.py,sha256=AC4ps5DdC8XdDpfBMKtVCne2UtnOKtQbVY8D-bLbcIY,1638
+mcmcli/data/report.py,sha256=lJAKQUsaU6g_Kqbx3KpYtBPZ5RSWAJfAmVXxw3KHaUE,2933
+mcmcli/data/seller.py,sha256=40SA7QekM3a3svDrDYLo_QYJ68VUxDO0KeGejJMp4k4,1004
+mcmcli/data/token.py,sha256=11wtyLHCAZHu0LVbNDPa-yipcL6lenxoYIKEI58VzFs,1744
+mcmcli/data/user_join_request.py,sha256=lXMO2hE_VpRg0JofVrYAVM82S-RLFkPrZk8-drvhoDI,1251
+mcmcli/data/wallet.py,sha256=eMUi8N0vJdg_E10TPhSPoZkZtmIG7gHyqgabQ8C5Lg8,3217
+mcm_cli-1.4.1.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+mcm_cli-1.4.1.dist-info/METADATA,sha256=lwdpWx33PEgWxiCl4FBfbqM_CIflw5eLDOLtzCpjK1Y,3056
+mcm_cli-1.4.1.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
+mcm_cli-1.4.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+mcm_cli-1.4.1.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
+mcm_cli-1.4.1.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
+mcm_cli-1.4.1.dist-info/RECORD,,

mcmcli/__main__.py

@@ -22,8 +22,10 @@ from typing import Optional
 import mcmcli.command.account
 import mcmcli.command.admin
 import mcmcli.command.auth
+import mcmcli.command.campaign
 import mcmcli.command.config
 import mcmcli.command.decision
+import mcmcli.command.report
 import mcmcli.command.wallet
 import mcmcli.logging
 import typer
@@ -35,13 +37,15 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.4.0")
+	typer.echo(f"Version: mcm-cli v1.4.1")
 
 app.add_typer(mcmcli.command.account.app, name="account", help="Ad account management")
 app.add_typer(mcmcli.command.admin.app, name="admin", help="Platform administration")
 app.add_typer(mcmcli.command.auth.app, name="auth", help="Authentication management")
+app.add_typer(mcmcli.command.campaign.app, name="campaign", help="Campaign management")
 app.add_typer(mcmcli.command.config.app, name="config", help="Configurations")
 app.add_typer(mcmcli.command.decision.app, name="decision", help="Decision command")
+app.add_typer(mcmcli.command.report.app, name="report", help="Report commands")
 app.add_typer(mcmcli.command.wallet.app, name="wallet", help="Wallet management")
 
 if __name__ == "__main__":

mcmcli/command/account.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 from enum import Enum
+from mcmcli.command.auth import AuthCommand, AuthHeaderName, AuthHeaderValue
 from mcmcli.data.account import Account, AccountListWrapper
 from mcmcli.data.account_user import User, UserWrapper, UserListWrapper
 from mcmcli.data.error import Error
@@ -348,8 +349,7 @@ class AccountCommand:
     def __init__(
         self,
         profile,
-        auth_command: mcmcli.command.auth.AuthCommand,
-        token
+        auth_command: AuthCommand,
     ):
         self.config = mcmcli.command.config.get_config(profile)
         if (self.config is None):
@@ -362,18 +362,20 @@ class AccountCommand:
         self.headers = {
             "accept": "application/json",
             "content-type": "application/json",
-            "Authorization": f"Bearer {token}"
         }
 
+        self.refresh_token()
+
 
     def refresh_token(
         self,
     ) -> None:
-        _, error, token = self.auth_command.get_token()
+        error, auth_header_name, auth_header_value = self.auth_command.get_auth_credential()
         if error:
             print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
-            return
-        self.headers["Authorization"] = f"Bearer {token.token}"
+            sys.exit()
+
+        self.headers[auth_header_name] = auth_header_value
 
 
     def retry_with_token_refresh(
@@ -760,12 +762,8 @@ class AccountCommand:
 def _create_account_command(
         profile: str
 ) -> Optional[AccountCommand]:
-    auth = mcmcli.command.auth.AuthCommand(profile)
-    _, error, token = auth.get_token()
-    if error:
-        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
-        return None
-    return AccountCommand(profile, auth, token.token)
+    auth = AuthCommand(profile)
+    return AccountCommand(profile, auth)
 
 
 def _read_csv_file(

mcmcli/command/admin.py

@@ -12,28 +12,33 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from datetime import datetime, timedelta, timezone
-from mcmcli.data.error import Error
+from mcmcli.command.auth import AuthCommand, AuthHeaderName, AuthHeaderValue
+from mcmcli.data.account import Account
 from mcmcli.data.item_blocking_result import ItemBlockingResult
+from mcmcli.data.campaign import Campaign
+from mcmcli.data.error import Error
+from mcmcli.data.item import Item
+from mcmcli.data.platform_user import PlatformUser, PlatformUserListWrapper, PlatformUserWrapper
 from mcmcli.requests import CurlString, api_request
 from typing import Optional
 
+import csv
 import mcmcli.command.account
 import mcmcli.command.auth
+import mcmcli.command.campaign
 import mcmcli.command.config
 import mcmcli.command.wallet
 import mcmcli.requests
 import sys
 import typer
 
+from mcmcli.logging import echo, echo_newline, start_dot_printing, stop_dot_printing, print_error
+
 app = typer.Typer(add_completion=False)
 
 def _create_admin_command(profile):
-    auth = mcmcli.command.auth.AuthCommand(profile)
-    _, error, token = auth.get_token()
-    if error:
-        print(f"ERROR: {error.message}")
-        return None
-    return AdminCommand(profile, auth, token.token)
+    auth = AuthCommand(profile)
+    return AdminCommand(profile, auth)
 
 @app.command()
 def list_wallet_balances(
@@ -48,6 +53,181 @@ def list_wallet_balances(
     admin.list_wallet_balances()
 
 
+@app.command()
+def list_all_campaigns(
+    profile: str = "default",
+):
+    """
+    List the campaigigns of all of the active ad accounts
+    """
+    admin = _create_admin_command(profile)
+    if admin is None:
+        return
+    error, account_campaigns = admin.list_all_campaigns()
+    if error:
+        print(error, file=sys.stderr, flush=True)
+        return
+
+    print("Account IDAccount Title,Campaign ID,Campaign Title,Ad Type,Start,End,Budget Period,Budget Amount,Enabling State,State,Created At,Updated At,Item IDs")
+    for account_campaign in account_campaigns:
+        a, c = account_campaign
+
+        print(f'"{a.id}","{a.title}",', end="", flush=True)
+        print(f'"{c.id}","{c.title}","{c.ad_type}",', end="", flush=True)
+        print(f'"{c.schedule.start}","{c.schedule.end}",', end="", flush=True)
+        print(f'"{c.budget.period}","{int(c.budget.amount.amount_micro) / 1000000}",', end="", flush=True)
+        print(f'"{c.enabling_state}","{c.state}",', end="", flush=True)
+        print(f'"{c.created_at}","{c.updated_at}",', end="", flush=True)
+        print(f'"{";".join(c.catalog_item_ids)}"')
+
+@app.command()
+def list_platform_users(
+    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",
+):
+    """
+    List the users of the platform
+    """
+    admin = _create_admin_command(profile)
+    if admin is None:
+        return
+
+    curl, error, users = admin.list_platform_users(to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(error, file=sys.stderr, flush=True)
+        return
+    if to_json:
+        json_dumps = [x.model_dump_json() for x in users]
+        print(f"[{','.join(json_dumps)}]")
+        return
+
+    print('User ID,Created At,Updated At,Status,Email,Name,Roles')
+    for u in users:
+        roles = [f'{x.name} of {x.resource_type} {x.resource_id}' for x in u.roles]
+        print(f'{u.id},{u.created_at},{u.updated_at},{u.status},{u.email},{u.name},{';'.join(roles)}')
+
+
+@app.command()
+def get_platform_user(
+    user_email: str = typer.Option(help="User's email address"),
+    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 = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    Get the email user's profile.
+    """
+    a = _create_admin_command(profile)
+    if a is None:
+        return
+
+    curl, error, user = a.get_platform_user(user_email, to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    if user is not None:
+        print(f"{user.model_dump_json()}")
+    return
+
+
+@app.command()
+def list_items(
+    account_id: str = typer.Option(help="Ad account ID"),
+    profile: str = "default",
+    ):
+    """
+    List the itmes, item status, and attached campaigns of a given ad account
+    """
+    admin = _create_admin_command(profile)
+    if admin is None:
+        return
+
+    error, campaigns = admin.list_campaigns(account_id)
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    campaign_item_obj = {} # build item list into item object with the item_id as an index
+    # print("Campaign ID, Campaign Title, Item ID, Item Title, Item Status")
+
+    for c in campaigns:
+        error, campaign_items = admin.list_campaign_items(account_id, c.id)
+        if error:
+            print(f"ERROR: {error.message}")
+            return
+        for ci in campaign_items:
+            if ci.id in campaign_item_obj:
+                campaign_item_obj[ci.id].append({
+                    'campaign_id': c.id,
+                    'campaign_title': c.title
+                })
+            else:
+                campaign_item_obj[ci.id] = [{
+                    'campaign_id': c.id,
+                    'campaign_title': c.title
+                }]
+            # print(f"{c['id']}, {c['title']}, {ci['id']}, {ci['title']}, {ci['is_active']}")
+
+    error, items = admin.list_items(account_id)
+    if error:
+        print(f"ERROR: {error.message}")
+
+    print("Ad Account ID,Item ID,Is Item Active,Item Title,Campaign ID,Campaign Title")
+    for i in items:
+        if i.id in campaign_item_obj:
+            ci = campaign_item_obj[i.id]
+            campaign_id_list = ""
+            campaign_title_list = ""
+            for c in ci:
+                campaign_id_list += f"{c['campaign_id']};"
+                campaign_title_list += f"{c['campaign_title']};"
+            campaign_id_list = campaign_id_list[:-1]
+            campaign_title_list = campaign_title_list[:-1]
+
+            print(f"{account_id},{i.id},{i.is_active},\"{i.title}\",{campaign_id_list},\"{campaign_title_list}\"")
+        else:
+            print(f"{account_id},{i.id},{i.is_active},\"{i.title}\",,")
+
+@app.command()
+def list_off_campaign_items(
+    account_id: str = typer.Option(help="Ad account ID"),
+    profile: str = "default",
+    ):
+    """
+    Lists the items that are not in any of campaigns
+    """
+    admin = _create_admin_command(profile)
+    if admin is None:
+        return
+
+    error, items = admin.list_items(account_id)
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    error, campaigns = admin.list_campaigns(account_id)
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+
+    campaign_item_obj = {} # build item list into item object with the item_id as an index
+    for c in campaigns:
+        error, campaign_items = admin.list_campaign_items(account_id, c.id)
+        for ci in campaign_items:
+            campaign_item_obj[ci.id] = ci.title
+
+    print("Item ID, Item Title")
+    for i in items:
+        if i.id not in campaign_item_obj and i.is_active:
+            print(f"{i.id}, {i.title}")
+
 @app.command()
 def block_item(
     item_id: str = typer.Option(help="Item ID"),
@@ -77,26 +257,40 @@ def block_item(
     print(result.model_dump_json())
     return
 
+
 class AdminCommand:
     def __init__(
         self,
         profile,
-        auth_command: mcmcli.command.auth.AuthCommand,
-        token
+        auth_command: AuthCommand,
     ):
-        self.profile = profile
-        self.auth_command = auth_command
         self.config = mcmcli.command.config.get_config(profile)
-        mcmcli.command.config.assert_config_exists(self.config)
+        if (self.config is None):
+            print(f"ERROR: Failed to load the CLI profile", file=sys.stderr, flush=True)
+            sys.exit()
 
-        self.token = token
+        self.profile = profile
+        self.auth_command = auth_command
         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}"
         }
 
+        self.refresh_token()
+
+
+    def refresh_token(
+        self,
+    ) -> None:
+        error, auth_header_name, auth_header_value = self.auth_command.get_auth_credential()
+        if error:
+            print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+            sys.exit()
+
+        self.headers[auth_header_name] = auth_header_value
+
+
     def block_item(
         self,
         item_id,
@@ -112,13 +306,12 @@ class AdminCommand:
         _payload = { 
             "items": [{
                 "item_id": item_id,
-                "seller_id": account_id,
                 "updated_time": _requested_at,
                 "blocked": f'Requested at {_requested_at}',
             }]
         }
-        if account_id is None:
-            del _payload["items"][0]["seller_id"]
+        if account_id is not None:
+            _payload["items"][0]["seller_id"] = account_id
         
         curl, error, json_obj = api_request('POST', to_curl, _api_url, self.headers, _payload)
         if curl:
@@ -127,11 +320,52 @@ class AdminCommand:
             return None, error, None
         return None, None, ItemBlockingResult(**json_obj)
     
+    
+    def get_platform_user(
+        self,
+        user_email,
+        to_curl = False,
+    ) -> tuple[
+        Optional[CurlString],
+        Optional[Error],
+        Optional[PlatformUser],
+    ]:
+        _api_url = f"{self.api_base_url}/users/{user_email}"
+        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
+
+        ret = PlatformUserWrapper(**json_obj).user
+        return None, None, ret
+
+    
+    def list_platform_users(
+        self,
+        to_curl=False,
+    ) -> tuple [
+        Optional[CurlString],
+        Optional[Error],
+        list[PlatformUser],
+    ]:
+        _api_url = f"{self.api_base_url}/users"
+
+        curl, error, json_obj = api_request('GET', to_curl, _api_url, self.headers)
+        if curl:
+            return curl, None, []
+        if error:
+            return None, error, []
+
+        user_list_wrapper = PlatformUserListWrapper(**json_obj)
+        users = user_list_wrapper.users
+        return None, None, users
+
     def list_wallet_balances(
         self
     ):
-        ac = mcmcli.command.account.AccountCommand(self.profile, self.auth_command, self.token)
-        wc = mcmcli.command.wallet.WalletCommand(self.profile, self.auth_command, self.token)
+        ac = mcmcli.command.account.AccountCommand(self.profile, self.auth_command)
+        wc = mcmcli.command.wallet.WalletCommand(self.profile, self.auth_command)
         _, error, accounts = ac.list_accounts()
         if error:
             print(error, file=sys.stderr, flush=True)
@@ -148,5 +382,105 @@ class AdminCommand:
             prepaid = w1 if w1.type == 'PRE_PAID' else w0
             credits = int(credits.balance.amount_micro) / 1000000
             prepaid = int(prepaid.balance.amount_micro) / 1000000
+
             print(f'"{accounts[id].title}", {id}, {credits}, {prepaid}')
 
+
+
+    def list_all_campaigns(
+        self
+    ) -> tuple [
+        Optional[Error],
+        list[tuple[Account, Campaign]]
+    ]:
+        ac = mcmcli.command.account.AccountCommand(self.profile, self.auth_command)
+        cc = mcmcli.command.campaign.CampaignCommand(self.profile, self.auth_command)
+        _, error, accounts = ac.list_accounts()
+        if error:
+            return error, []
+
+        echo('Collecting campaigns...')
+        return_value = []
+        for id in accounts:
+            account = accounts[id]
+            echo('.')
+            if account.state_info.state == "INACTIVE":
+                continue
+            # print(f'{account.id}, \"{account.title}\"')
+            _, error, campaigns = cc.list_campaigns(account.id)
+            if error:
+                echo_newline(error)
+                continue
+            for c in campaigns:
+                return_value.append((account, c))
+
+        echo_newline(' done')
+        return None, return_value
+
+
+    def list_items(
+        self,
+        account_id
+    ) -> tuple [
+        Optional[Error],
+        list[Item],
+    ]:
+        ac = mcmcli.command.account.AccountCommand(self.profile, self.auth_command)
+        echo("Gathering the account's items ")
+        thread, stopper = start_dot_printing()
+        _, error, items = ac.list_account_items(account_id)
+        stop_dot_printing(thread, stopper)
+        echo_newline(" done")
+
+        if error:
+            return error, []
+        if items == []:
+            return Error(code=0, message=str("Cannot find items")), []
+
+        return None, items
+    
+    def list_campaigns(
+        self,
+        ad_account_id
+    ) -> tuple [
+        Optional[Error],
+        list[Campaign],
+    ]:
+        cam = mcmcli.command.campaign.CampaignCommand(self.profile, self.auth_command)
+
+        echo("Gathering the account's campaigns ")
+        thread, stopper = start_dot_printing()
+        _, error, campaigns = cam.list_campaigns(ad_account_id)
+        stop_dot_printing(thread, stopper)
+        echo_newline(" done")
+
+        if error:
+            return error, []
+        if campaigns == []:
+            return Error(code=0, message=str("Cannot find campaigns")), []
+
+        return None, campaigns
+
+
+    def list_campaign_items(
+        self,
+        ad_account_id,
+        campaign_id
+    ) -> tuple [
+        Optional[Error],
+        list[Item]
+    ]:
+        cam = mcmcli.command.campaign.CampaignCommand(self.profile, self.auth_command)
+
+        echo(f"Gathering the items of the campaign {campaign_id} ")
+        thread, stopper = start_dot_printing()
+        _, error, campaign_items = cam.list_campaign_items(ad_account_id, campaign_id)
+        stop_dot_printing(thread, stopper)
+        echo_newline(" done")
+
+        if error:
+            return error, []
+        if campaign_items == []:
+            return Error(code=0, message=str("Cannot find campaign items")), []
+
+        return None, campaign_items

mcmcli/command/auth.py

@@ -21,6 +21,9 @@ import mcmcli.logging
 import sys
 import typer
 
+AuthHeaderName = str
+AuthHeaderValue = str
+
 app = typer.Typer(add_completion=False)
 
 #
@@ -79,4 +82,15 @@ class AuthCommand:
             return None, error, None
 
         return None, None, Token(**json_obj)
+    
+    def get_auth_credential(self) -> tuple[Error, AuthHeaderName, AuthHeaderValue]:
+        if 'management_api_key' in self.config:
+            return None, "x-api-key", self.config['management_api_key']
+
+        _, error, token = self.get_token(to_curl=False)
+        if error:
+            return error, None, None
+
+        else:
+            return None, "Authorization", f"Bearer {token.token}"