mcm-cli 1.7.5__py3-none-any.whl → 1.8.0__py3-none-any.whl

{mcm_cli-1.7.5.dist-info → mcm_cli-1.8.0.dist-info}/METADATA

@@ -1,11 +1,12 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.7.5
+Version: 1.8.0
 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
+Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -93,3 +94,5 @@ $
 ```
 
 © Moloco, Inc. 2023 All rights reserved. Released under Apache 2.0 License
+
+

{mcm_cli-1.7.5.dist-info → mcm_cli-1.8.0.dist-info}/RECORD

@@ -1,14 +1,15 @@
 mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
-mcmcli/__main__.py,sha256=CmK7cg9IKPBqwf9I9XoufkwUslfZDbotL9ReHEiceaA,1844
-mcmcli/logging.py,sha256=xjRS5ey1ONx_d34qB1Fetb_SwPysoh2hzNDuNAaYYWQ,1739
+mcmcli/__main__.py,sha256=xiXZDfSfen-divvv_HXqITkQ9oOboOs_vv0nomKddpQ,1844
+mcmcli/logging.py,sha256=RmSM4xK7-e-me4Nl1rRXYysXwCVzNr5EIHxRlgCvwns,1749
 mcmcli/requests.py,sha256=IuySBQ8P_GoGF3f_TRysfgQNOhi2n9M84WK_eRXnoEU,2945
 mcmcli/command/account.py,sha256=FWXmzOLj4rVLVLEv-w0eDVlQVrkONvR1UewZbcTDgE4,24994
-mcmcli/command/admin.py,sha256=ynIWITIuLLUFDy2mqcKToLTsIwdNH4-k-6o-lWp1Rh0,19191
+mcmcli/command/admin.py,sha256=VRph21dBWhVgaPoLnjAlBbWpIiFqcAmJ866K3fNBR6E,19663
 mcmcli/command/auth.py,sha256=Ak7ZNEskWPpMoeTJcbYlEpDBgzxn8N33Q2dNf67SsCs,2926
 mcmcli/command/campaign.py,sha256=eHE_i1lRlUuU1GeVMwXkJgBU_zOgU-b9Wo0SYC9TK7M,15444
 mcmcli/command/config.py,sha256=08C5ftAvdvpQ26Z329LqhP8AxTI629LS7Ou6glzrRgw,4396
-mcmcli/command/decision.py,sha256=L54-Uw-CyXELOIGMv464fxjaSFKCgqJGEKXFjqBDFIg,9285
+mcmcli/command/decision.py,sha256=hBOISPFSSDRSAPcRAiLkjz-PMZHsDWgRLUjXZQInB14,9283
 mcmcli/command/report.py,sha256=N8IMyDZ5QpY11-KkZG-n5_ZzEeh-ME5s2s3wrAKEGjY,5387
+mcmcli/command/userevent.py,sha256=bSXQUfcZlBdacrZat1W_hLF5nz9A2meUhZAuCnLDvhY,2906
 mcmcli/command/wallet.py,sha256=b7X4lLOoDMg2ItyyRPawtiA_p-r7dSsRcHNhCAmBjyc,11616
 mcmcli/data/account.py,sha256=pe7tPapP6vlUD5D5L5Nh5k2bkWdYOK01Mpt5fBYFnJs,1782
 mcmcli/data/account_user.py,sha256=27nQp52nMma5a3QszSJGqgq5Z0ivIb-nMZcZuhEgbEg,1328
@@ -23,10 +24,10 @@ 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.7.5.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
-mcm_cli-1.7.5.dist-info/METADATA,sha256=MWVvOXH-jPSep0wJluOvCXErAGS9ZrBE51aoES7dAik,3153
-mcm_cli-1.7.5.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
-mcm_cli-1.7.5.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-mcm_cli-1.7.5.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
-mcm_cli-1.7.5.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
-mcm_cli-1.7.5.dist-info/RECORD,,
+mcm_cli-1.8.0.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+mcm_cli-1.8.0.dist-info/METADATA,sha256=v3hvmmVyRvFunqyijHggZe2TW17eNnvGwhC7_wwv1dY,3173
+mcm_cli-1.8.0.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
+mcm_cli-1.8.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+mcm_cli-1.8.0.dist-info/entry_points.txt,sha256=AQPedI0vnP2FfE6pCSg7Zp8QKDLnkakl50bU0DNZu5w,61
+mcm_cli-1.8.0.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
+mcm_cli-1.8.0.dist-info/RECORD,,

{mcm_cli-1.7.5.dist-info → mcm_cli-1.8.0.dist-info}/WHEEL

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

{mcm_cli-1.7.5.dist-info → mcm_cli-1.8.0.dist-info}/entry_points.txt

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

mcmcli/__main__.py

@@ -37,7 +37,7 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.7.5")
+	typer.echo(f"Version: mcm-cli v1.8.0")
 
 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")

mcmcli/command/admin.py

@@ -28,6 +28,7 @@ import mcmcli.command.auth
 import mcmcli.command.campaign
 import mcmcli.command.config
 import mcmcli.command.decision
+import mcmcli.command.userevent
 import mcmcli.command.wallet
 import mcmcli.requests
 import random
@@ -83,8 +84,8 @@ def generate_sample_data(
     profile: str = typer.Option("default", help="Profile Name – The MCM CLI configuration profile to use."), 
 ):
     """
-    Generate sample impressions and clicks. This command invokes the Decision APIs, and posts the impression
-    and click trackers to generate sample data in the platform.
+    Generate sample impressions, clicks, and purchase events. This command invokes the Decision APIs, and posts the impression
+    and click trackers to generate sample data in the platform. It also posts the purchase events to the User Event API.
     """
     if warn:
         typer.confirm("""⚠️ WARNING: This script is strictly for use on the TEST platform.⚠️
@@ -105,13 +106,15 @@ Please proceed only if you are certain.""", abort=True)
 
     # Initialize DecisionCommand
     d = mcmcli.command.decision.DecisionCommand(profile)      
+    ue = mcmcli.command.userevent.UserEventCommand(profile)
     
     print(f"Invoking the Decision API {num_iterations} times to generate sample impressions and clicks...", end='', flush=True)
     thread, stopper = start_dot_printing()
     
     for i in range(num_iterations):
+        user_id = f"user-{random.randint(100_000, 999_999)}"
         # Call Decision API to get trackers
-        _, error, decided_items = d.decide_items(ad_inventory_id, search_query)
+        _, error, decided_items = d.decide_items(ad_inventory_id, user_id, search_query)
         if error:
             print_error(f"Error calling Decision API: {error.message}")
             continue
@@ -136,6 +139,11 @@ Please proceed only if you are certain.""", abort=True)
                     requests.post(click_url)
                 except requests.RequestException as e:
                     print(f"[{i}] Failed to post imp tracker: {click_url} - Error: {e}")
+
+            # Send Purchase user event with 10% probability
+            if random.random() >= 0.9:
+                continue
+            ue.insert_purchase_event(user_id, item.auction_result.ad_account_id, item.item_id, to_curl=False)
                     
         print('.', end='', flush=True)
         

mcmcli/command/decision.py

@@ -44,7 +44,9 @@ def decide_items(
     """
     d = DecisionCommand(profile)
 
-    curl, error, ret = d.decide_items(inventory_id, search_query, num_items, items, location_filter, to_curl)
+    user_id = f"user-{random.randint(100_000, 999_999)}"
+
+    curl, error, ret = d.decide_items(inventory_id, user_id, search_query, num_items, items, location_filter, to_curl)
     if to_curl:
         print(curl)
         return
@@ -141,6 +143,7 @@ class DecisionCommand:
     def decide_items(
         self, 
         inventory_id, 
+        user_id,
         search_query = None,
         num_items = 5, 
         items = False,
@@ -159,10 +162,10 @@ class DecisionCommand:
                 "num_items": num_items
             },
             "user": {
-                "user_id": f"mcmcli-user-{random.randint(100_000, 999_999)}"
+                "user_id": user_id
             },
             "device": {
-                "persistent_id": f"mcmcli-device-{random.randint(100_000, 999_999)}"
+                "persistent_id": user_id
             },
         }
         if items:

mcmcli/command/userevent.py

@@ -0,0 +1,96 @@
+# 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 datetime import datetime, timezone
+from mcmcli.data.error import Error
+from mcmcli.requests import CurlString, api_request
+from typing import Optional
+
+UTC = timezone.utc
+
+import mcmcli.command.config
+import sys
+import typer
+
+app = typer.Typer(add_completion=False)
+
+class UserEventCommand:
+    def __init__(
+        self,
+        profile,
+    ):
+        self.config = mcmcli.command.config.get_config(profile)
+        if (self.config is None):
+            print(f"ERROR: Failed to load the CLI profile", file=sys.stderr, flush=True)
+            sys.exit()
+
+        self.profile = profile
+
+        self.api_base_url = f"{self.config['event_api_hostname']}/rmp/event/v1/platforms/{self.config['platform_id']}/userevents"
+        self.headers = {
+            "accept": "application/json",
+            "content-type": "application/json",
+            "x-api-key": self.config['event_api_key']
+        }
+
+    def insert_purchase_event(
+        self,
+        user_id: str,
+        account_id: str,
+        item_id: str,
+        to_curl: bool,
+    ) -> tuple[
+        Optional[CurlString],
+        Optional[Error],
+    ]:
+        # Get current timestamp in milliseconds
+        timestamp_ms = int(datetime.now(timezone.utc).timestamp() * 1000)
+        _api_url = self.api_base_url
+        _payload = {
+            "id": f"event-{user_id}",
+            "timestamp":timestamp_ms,
+            "user_id": user_id,
+            "device": {
+                "persistent_id": user_id
+            },
+            "event_type": "PURCHASE",
+            "channel_type": "SITE",
+            "items": [
+                {
+                    "id": item_id,
+                    "quantity": 1,
+                    "seller_id": account_id,
+                    "price": {
+                        "currency": "USD",
+                        "amount": 100
+                    }
+                }
+            ],
+            "revenue": {
+                "currency": "USD",
+                "amount": 100
+            },
+            "shipping_charge": {
+                "currency": "USD",
+                "amount": 0
+            },
+        }
+
+        curl, error, json_obj = api_request('POST', to_curl, _api_url, self.headers, _payload)
+        if curl:
+            return curl, None
+        if error:
+            return None, error
+
+        return None, None
+

mcmcli/logging.py

@@ -17,7 +17,7 @@ import threading
 import time
 import typer
 
-def print_error(api_url, message):
+def print_error(message, api_url="Unknown"):
     # Something's wrong. Print error and exit.
 
     _msg = typer.style(f"\nERROR: {message}", fg=typer.colors.RED, bold=True)