Merge pull request #9 from gofynd/update-library-version-FPCO-17516

ID:FPCO-17516; DONE:50; HOURS:2 update client library version to latest

Author: vivek8690

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run Example Extension",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/examples/example_app.py",
+            "console": "integratedTerminal",
+            "justMyCode": false
+        }
+    ]
+}

examples/example_app.py

@@ -2,28 +2,28 @@
 import sys
 
 import aioredis
-from sanic import Sanic, Blueprint
-from sanic import response
+from sanic import Sanic, Blueprint, request, response
 
 import logging
 
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
+from fdk_client.platform import PlatformClient
 from fdk_extension import setup_fdk
-from examples.extension_handlers import extension_handler
 from fdk_extension.utilities.logger import get_logger
 from fdk_extension.storage.redis_storage import RedisStorage
 
+from examples.extension_handlers import extension_handler
+
 logger = get_logger()
 
 
 app = Sanic("test")
 
 redis_connection = aioredis.from_url("redis://localhost")
 
-base_url = "http://0.0.0.0:8000"
-
 
+# webhook handlers
 async def handle_coupon_edit(event_name, payload, company_id, application_id):
     logging.debug(f"Event received for {company_id} and {application_id}")
     logging.debug(payload)
@@ -45,21 +45,14 @@ async def handle_location_event(event_name, payload, company_id):
     logging.debug(payload)
 
 
-async def handle_ext_install(payload, company_id):
-    logging.debug(f"Event received for {company_id}")
-    logging.debug(payload)
-
-
 fdk_extension_client = setup_fdk({
-    "api_key": "6220daa4a5414621b975a41f",
-    "api_secret": "EbeGBRC~Fthv5om",
-    "base_url": base_url, # this is optional
-    "scopes": ["company/product"], # this is optional
+    "api_key": "<API_KEY>",
+    "api_secret": "<API_SECRET>",
     "callbacks": extension_handler,
-    "storage": RedisStorage(redis_connection),
+    "storage": RedisStorage(redis_connection, "example_app"),
     "access_mode": "offline",
     "debug": True,
-    "cluster": "https://api.fyndx0.de",  # this is optional by default it points to prod.
+    "cluster": "https://api.fynd.com",
     "webhook_config": {
         "api_path": "/webhook",
         "notification_email": "test2@abc.com",  # required
@@ -129,14 +122,23 @@ async def disable_sales_channel_webhook_handler(request, application_id):
         return response.json({"error_message": str(e), "success": False}, 500)
 
 
+# Adding `fdk_route` to handle extension install/auth
 app.blueprint(fdk_extension_client.fdk_route)
 
-platform_bp = Blueprint("platform blueprint")
+
+# platform blueprints
+platform_bp = Blueprint("platform_blueprint")
 platform_bp.add_route(test_route_handler, "/test/routes")
+platform_bp_group = Blueprint.group(platform_bp)
 
-application_bp = Blueprint("application blueprint")
+
+# application blueprints
+application_bp = Blueprint("application_blueprint")
 application_bp.add_route(test_route_handler, "/1234")
+application_bp_group = Blueprint.group(application_bp)
+
 
+# webhook handler
 app.add_route(webhook_handler, "/webhook", methods=["POST"])
 
 platform_bp.add_route(enable_sales_channel_webhook_handler,
@@ -146,12 +148,33 @@ async def disable_sales_channel_webhook_handler(request, application_id):
                                                       "/webhook/application/<application_id>/unsubscribe",
                                                       methods=["POST"])
 
-fdk_extension_client.platform_api_routes.append(platform_bp)
-fdk_extension_client.application_proxy_routes.append(application_bp)
+# registering blueprints
+fdk_extension_client.platform_api_routes.append(platform_bp_group)
+fdk_extension_client.application_proxy_routes.append(application_bp_group)
+
 
 app.blueprint(fdk_extension_client.platform_api_routes)
 app.blueprint(fdk_extension_client.application_proxy_routes)
 
+
+# Example of How to use platform client in `offline` access mode
+@app.post("/client")
+async def client_handler(request: request.Request):
+    try:
+        client: PlatformClient = await fdk_extension_client.get_platform_client("<COMPANY_ID>")
+        res = await client.application("<APPLICATION_ID>").theme.getAppliedTheme()
+        return response.json(body={"message": "OK"}, status=200)
+    except Exception as e:
+        print(e)
+        return response.json(body={"message": "Error"}, status=400)
+    
+
+# home page
+@app.get("company/<company_id>")
+async def home_page_handler(request: request.Request, company_id):
+    return response.html(f"<h1>Extension launched on Company ID: {company_id}</h1>")
+
+
 # debug logs enabled with debug = True
 if __name__ == '__main__':
-    app.run(host="0.0.0.0", port=8000, debug=True)
+    app.run(host="127.0.0.1", port=8000, debug=True)

examples/extension_handlers.py

@@ -1,7 +1,9 @@
-async def auth(request):
+from sanic import request
+
+async def auth(request: request.Request):
     # Write you code here to return initial launch url
     company_id = int(request.args.get("company_id"))
-    return f"{request.conn_info.ctx.extension.base_url}?company_id={company_id}"
+    return f"{request.conn_info.ctx.extension.base_url}/company/{company_id}"
 
 
 async def uninstall(request):

fdk_extension/extension.py

@@ -141,7 +141,7 @@ async def get_platform_client(self, company_id, session: Session) -> PlatformCli
                 logger.debug(f"Access token renewed for comapny {company_id} with response {renew_token_res}")
 
         platform_client = PlatformClient(platform_config)
-        await platform_client.setExtraHeaders({
+        platform_client.setExtraHeaders({
             'x-ext-lib-version': f"py/{__version__}"
         })
         return platform_client

fdk_extension/middleware/api_middleware.py

@@ -19,6 +19,7 @@ async def application_proxy_on_request(request: Request) -> None:
         request.conn_info.ctx.application_config = ApplicationConfig({
             "applicationID": request.conn_info.ctx.application._id,
             "applicationToken": request.conn_info.ctx.application.token,
+            "domain": extension.cluster
         })
         request.conn_info.ctx.application_client = ApplicationClient(request.conn_info.ctx.application_config)
 

fdk_extension/webhook.py

@@ -88,7 +88,7 @@ def __get_event_id_map(self, events: list) -> dict:
 
 
     def __association_criteria(self, application_id_list: list) -> str:
-        if self._config["subscribed_saleschannel"] == "specific":
+        if self._config.get("subscribed_saleschannel") == "specific":
             return ASSOCIATION_CRITERIA["SPECIFIC"] if application_id_list else ASSOCIATION_CRITERIA["EMPTY"]
         return ASSOCIATION_CRITERIA["ALL"]
 
@@ -137,7 +137,7 @@ async def sync_events(self, platform_client: PlatformClient, config: dict=None,
                 "name": self._fdk_config["api_key"],
                 "webhook_url": self.__webhook_url,
                 "association": {
-                    "company_id": platform_client._conf.companyId,
+                    "company_id": platform_client.config.companyId,
                     "application_id": [],
                     "criteria": self.__association_criteria([])
                 },
@@ -153,7 +153,7 @@ async def sync_events(self, platform_client: PlatformClient, config: dict=None,
             if enable_webhooks is not None:
                 subscriber_config["status"] = "active" if enable_webhooks else "inactive"
         else:
-            logger.debug(f"Webhook config on platform side for company id {platform_client._conf.companyId}: {ujson.dumps(subscriber_config)}")
+            logger.debug(f"Webhook config on platform side for company id {platform_client.config.companyId}: {ujson.dumps(subscriber_config)}")
 
             auth_meta = subscriber_config["auth_meta"]
             event_configs = subscriber_config["event_configs"]
@@ -191,7 +191,7 @@ async def sync_events(self, platform_client: PlatformClient, config: dict=None,
                     for event_name in event_config["events_map"]:
                         event_map[event_config["events_map"][event_name]] = event_name
                     subscriber_config["event_id"] = [event_map[event_id] for event_id in subscriber_config["event_id"]]
-                    logger.debug(f"Webhook config registered for company: {platform_client._conf.companyId}, config: {ujson.dumps(subscriber_config)}")
+                    logger.debug(f"Webhook config registered for company: {platform_client.config.companyId}, config: {ujson.dumps(subscriber_config)}")
 
             else:
                 event_diff = [each_event_id for each_event_id in subscriber_config["event_id"]
@@ -207,7 +207,7 @@ async def sync_events(self, platform_client: PlatformClient, config: dict=None,
                         for event_name in event_config["events_map"]:
                             event_map[event_config["events_map"][event_name]] = event_name
                         subscriber_config["event_id"] = [event_map[event_id] for event_id in subscriber_config["event_id"]]
-                        logger.debug(f"Webhook config updated for company: {platform_client._conf.companyId}, config: {ujson.dumps(subscriber_config)}")
+                        logger.debug(f"Webhook config updated for company: {platform_client.config.companyId}, config: {ujson.dumps(subscriber_config)}")
 
         except Exception as e:
             raise FdkWebhookRegistrationError(f"Failed to sync webhook events. Reason: {str(e)}")
@@ -217,7 +217,7 @@ async def enable_sales_channel_webhook(self, platform_client: PlatformClient, ap
         if not self.is_initialized:
             raise FdkInvalidWebhookConfig("Webhook registry not initialized")
 
-        if self._config["subscribed_saleschannel"] != "specific":
+        if self._config.get("subscribed_saleschannel") != "specific":
             raise FdkWebhookRegistrationError("'subscribed_saleschannel' is not set to 'specific' in webhook config")
 
         try:
@@ -250,7 +250,7 @@ async def disable_sales_channel_webhook(self, platform_client: PlatformClient, a
         if not self.is_initialized:
             raise FdkInvalidWebhookConfig("Webhook registry not initialized")
 
-        if self._config["subscribed_saleschannel"] != "specific":
+        if self._config.get("subscribed_saleschannel") != "specific":
             raise FdkWebhookRegistrationError("`subscribed_saleschannel` is not set to `specific` in webhook config")
         try:
             subscriber_config = await self.get_subscribe_config(platform_client=platform_client)

requirements/requirements.txt

@@ -1,4 +1,4 @@
-fdk_client@git+https://github.com/gofynd/fdk-client-python.git@0.1.28#egg=fdk_client
+fdk_client@git+https://github.com/gofynd/fdk-client-python.git@1.0.2#egg=fdk_client
 sanic>=22.9.0
 aioredis>=2.0.0
 structlog>=20.1.0