cc-py-commons 0.5.34__tar.gz → 0.5.36__tar.gz

{cc_py_commons-0.5.34 → cc_py_commons-0.5.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cc_py_commons
-Version: 0.5.34
+Version: 0.5.36
 Summary: Common code for microservices
 Home-page: https://github.com/Cargo-Chief/py-commons
 Author: CargoChief

{cc_py_commons-0.5.34 → cc_py_commons-0.5.36}/cc_py_commons/config/c4_account_settings.py

@@ -4,3 +4,4 @@ class C4AccountSettings:
 	SEARCH_TRUCK_ORIGIN_DEADHEAD_LIMIT = 'SEARCH_TRUCK_ORIGIN_DEADHEAD_LIMIT'
 	SEARCH_TRUCK_DESTINATION_DEADHEAD_LIMIT = 'SEARCH_TRUCK_DESTINATION_DEADHEAD_LIMIT'
 	SEARCH_TRUCK_RESULTS_COUNT = 'SEARCH_TRUCK_RESULTS_COUNT'
+	INCLUDE_DISPATCHER_IN_BOOK_NOW_OFFER = 'INCLUDE_DISPATCHER_IN_BOOK_NOW_OFFER'

{cc_py_commons-0.5.34 → cc_py_commons-0.5.36}/cc_py_commons/config/env.py

@@ -60,6 +60,8 @@ class Config(object):
   HERMES_SNS_ARN = 'arn:aws:sns:us-west-1:791608169866:hermes-sns-test'
   C4_ACCOUNTS_BUCKET = 'c4-accounts-test'
   ANALYTICS_SNS_ARN = 'arn:aws:sns:us-west-1:791608169866:analytics-test'
+  WEB_SOCKET_SNS_TOPIC_ARN = 'arn:aws:sns:us-west-1:791608169866:websocket-dev'
+  WEB_SOCKET_AUTH_TOKEN = os.getenv('WEB_SOCKET_AUTH_TOKEN')
 
   # Database
   DB_USERNAME = os.getenv('DB_USERNAME')
@@ -119,6 +121,7 @@ class ProductionConfig(Config):
   HERMES_SNS_ARN = 'arn:aws:sns:us-west-1:791608169866:hermes-sns-prod'
   C4_ACCOUNTS_BUCKET = 'c4-accounts-prod'
   ANALYTICS_SNS_ARN ='arn:aws:sns:us-west-1:791608169866:analytics-prod'
+  WEB_SOCKET_SNS_TOPIC_ARN = 'arn:aws:sns:us-west-1:791608169866:websocket-prod'
 
 config_options = {
     'local': LocalConfig,

cc_py_commons-0.5.36/cc_py_commons/config/web_socket_action.py

@@ -0,0 +1,3 @@
+class WebSocketAction:
+	BROADCAST_TO_USER = 'broadcastActionToUser'
+	BROADCAST_TO_ACCOUNT = 'broadcastActionToAccount'

cc_py_commons-0.5.36/cc_py_commons/services/web_socket/send_notification.py

@@ -0,0 +1,38 @@
+import json
+import traceback
+
+from cc_py_commons.config.env import app_config
+from cc_py_commons.config.web_socket_action import WebSocketAction
+from cc_py_commons.sns.sns_service import SnsService
+from cc_py_commons.utils import json_logger
+
+
+def execute(action, user_id, account_id, payload):
+	if not action or not account_id or not payload:
+		json_logger.warning(account_id, 'Missing required parameters')
+		return None
+	valid_actions = [WebSocketAction.BROADCAST_TO_USER, WebSocketAction.BROADCAST_TO_ACCOUNT]
+	if action not in valid_actions:
+		json_logger.warning(account_id, f'Invalid action. Should be one of {valid_actions}')
+		return None
+	web_socket_auth_token = app_config.WEB_SOCKET_AUTH_TOKEN
+	if not web_socket_auth_token:
+		json_logger.warning(account_id, 'Missing WEB_SOCKET_AUTH_TOKEN')
+		return None
+	try:
+		message = {
+			'authKey': web_socket_auth_token,
+			'action': action,
+			'userId': user_id,
+			'accountId': account_id,
+			'payload': payload
+		}
+		sns_service = SnsService()
+		sns_service.send(app_config.WEB_SOCKET_SNS_TOPIC_ARN, 'web-socket-message', json.dumps(message))
+		successful_message = 'Successfully sent the notification'
+		json_logger.info(account_id, successful_message)
+		return successful_message
+	except Exception as e:
+		json_logger.error(account_id, 'Failed to send web socket notification', error=str(e),
+						  stacktrace=traceback.format_exc())
+	return None

cc_py_commons-0.5.36/cc_py_commons/tests/test_web_socket_send_notification.py

@@ -0,0 +1,39 @@
+from unittest import TestCase
+from unittest.mock import patch
+
+from cc_py_commons.config.web_socket_action import WebSocketAction
+from cc_py_commons.services.web_socket import send_notification
+from cc_py_commons.sns.sns_service import SnsService
+
+
+@patch.object(SnsService, 'send')
+class TestSendNotification(TestCase):
+
+	def test_when_required_parameters_are_missing(self, sns_service_send):
+		result = send_notification.execute(WebSocketAction.BROADCAST_TO_ACCOUNT,
+										   None, None, {'message': 'test'})
+
+		self.assertIsNone(result)
+		sns_service_send.assert_not_called()
+
+	def test_invalid_action(self, sns_service_send):
+		result = send_notification.execute('INVALID_ACTION',
+										   None, 1234, {'message': 'test'})
+
+		self.assertIsNone(result)
+		sns_service_send.assert_not_called()
+
+	def test_when_web_socket_token_is_missing(self, sns_service_send):
+		result = send_notification.execute(WebSocketAction.BROADCAST_TO_ACCOUNT,
+										   None, 1234, {'message': 'test'})
+
+		self.assertIsNone(result)
+		sns_service_send.assert_not_called()
+
+	@patch('cc_py_commons.config.env.app_config.WEB_SOCKET_AUTH_TOKEN', 'TOKEN')
+	def test_valid_request(self, sns_service_send):
+		result = send_notification.execute(WebSocketAction.BROADCAST_TO_ACCOUNT,
+										   None, 1234, {'message': 'test'})
+
+		self.assertIsNotNone(result)
+		sns_service_send.assert_called_once()

{cc_py_commons-0.5.34 → cc_py_commons-0.5.36}/cc_py_commons.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cc-py-commons
-Version: 0.5.34
+Version: 0.5.36
 Summary: Common code for microservices
 Home-page: https://github.com/Cargo-Chief/py-commons
 Author: CargoChief

{cc_py_commons-0.5.34 → cc_py_commons-0.5.36}/cc_py_commons.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ cc_py_commons/config/c4_account_settings.py
 cc_py_commons/config/env.py
 cc_py_commons/config/mcleod_load_fields.py
 cc_py_commons/config/pc_miler_config.py
+cc_py_commons/config/web_socket_action.py
 cc_py_commons/db/__init__.py
 cc_py_commons/db/connection.py
 cc_py_commons/lanes/__init__.py
@@ -96,6 +97,8 @@ cc_py_commons/services/mercury/db/__init__.py
 cc_py_commons/services/mercury/db/delete_table.py
 cc_py_commons/services/slack/__init__.py
 cc_py_commons/services/slack/send_slack_message.py
+cc_py_commons/services/web_socket/__init__.py
+cc_py_commons/services/web_socket/send_notification.py
 cc_py_commons/sns/__init__.py
 cc_py_commons/sns/book_load_notification.py
 cc_py_commons/sns/booking_assistant_flow_notification.py
@@ -115,6 +118,7 @@ cc_py_commons/tests/test_case_conversion.py
 cc_py_commons/tests/test_lambda_utils.py
 cc_py_commons/tests/test_map_transaction.py
 cc_py_commons/tests/test_temperature_utils.py
+cc_py_commons/tests/test_web_socket_send_notification.py
 cc_py_commons/transactions/__init__.py
 cc_py_commons/transactions/equipment_clas_schema.py
 cc_py_commons/transactions/equipment_class.py

{cc_py_commons-0.5.34 → cc_py_commons-0.5.36}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 setup(
     name='cc_py_commons',
     description='Common code for microservices',
-    version='0.5.34',
+    version='0.5.36',
     url='https://github.com/Cargo-Chief/py-commons',
     author='CargoChief',
     author_email='engineering@cargochief.com',