beta update

Author: robswc

src/components/actions/base/action.py

@@ -47,6 +47,7 @@ class Action:
     def __init__(self):
         self.name = self.get_name()
         self.logs = []
+        self._raw_data = None
 
     def get_name(self):
         return type(self).__name__
@@ -68,6 +69,16 @@ def register(self):
         self.objects._actions.append(self)
         logger.info(f'ACTION REGISTERED --->\t{str(self)}')
 
+    def set_data(self, data):
+        """Sets data for action"""
+        self._raw_data = data
+
+    def validate_data(self):
+        """Ensures data is valid"""
+        if not self._raw_data:
+            raise ValueError('No data provided to action')
+        return self._raw_data
+
     def run(self, *args, **kwargs):
         """
         Runs, logs action

src/components/actions/base/template/action_template.py

@@ -6,11 +6,8 @@ def __init__(self):
         super().__init__()
 
     def run(self, *args, **kwargs):
-        super().run(*args, **kwargs)
+        super().run(*args, **kwargs)  # this is required
         """
         Custom run method. Add your custom logic here.
         """
         print(self.name, '---> action has run!')
-
-
-template_action = TemplateActionClass()

src/components/actions/community_created_actions/crypto/log_account_balance.py

@@ -0,0 +1,30 @@
+import datetime
+import random
+
+from components.actions.base.action import Action
+from components.logs.log_event import LogEvent
+
+
+class LogAccountBalance(Action):
+    def __init__(self):
+        super().__init__()
+
+    def run(self, *args, **kwargs):
+        super().run(*args, **kwargs)  # this is required
+        """
+        Custom run method. Add your custom logic here.
+        """
+        data = self.validate_data()
+        print('Data from webhook:', data)
+        message = f'Account Balance is: ${random.randint(0, 100)} USD'
+        timestamp = datetime.datetime.now()
+        log = LogEvent(self.name, 'account_balance', timestamp, message)
+        log.write()  # remember to write the log!
+
+        # kraken = ccxt.kraken({
+        #     'apiKey': 'YOUR_PUBLIC_API_KEY',
+        #     'secret': 'YOUR_SECRET_PRIVATE_KEY',
+        # })
+
+        # kraken.load_markets()
+        # print(kraken.fetch_balance())

src/components/actions/community_created_actions/crypto/trade_crypto.py

@@ -0,0 +1,24 @@
+from components.actions.base.action import Action
+
+
+class TradeCrypto(Action):
+    def __init__(self):
+        super().__init__()
+
+    def run(self, *args, **kwargs):
+        super().run(*args, **kwargs)
+        """
+        Custom run method. Add your custom logic here.
+        """
+        data = self.validate_data()
+        print('Data from webhook:', data)
+        print('Data is of type:', type(data))
+        print('Looking for order symbol...')
+        symbol = data.get('symbol', 'Not found :(')
+        print('Symbol:', symbol)
+        print('Looking for order type...')
+        order_type = data.get('order_type', 'Not found :(')
+        print('Order type is:', order_type)
+        print('\n\nUse the data above to make your trade!')
+        print('\nhttps://github.com/ccxt/ccxt#python-1')
+        print('CCXT is an example of a library you can use to make trades.\n\n')

src/components/actions/handle_order_example.py renamed to src/components/actions/print_data.py

@@ -1,17 +1,15 @@
 from components.actions.base.action import Action
 
 
-class HandleOrderExample(Action):
+class PrintData(Action):
     def __init__(self):
         super().__init__()
-        self.name = 'handle_order_example'
 
     def run(self, *args, **kwargs):
-        super(Action).run(*args, **kwargs)
+        super().run(*args, **kwargs)  # this is required
         """
         Custom run method. Add your custom logic here.
         """
         print(self.name, '---> action has run!')
-
-
-handle_order_example = HandleOrderExample()
+        data = self.validate_data()  # always get data from webhook by calling this method!
+        print('Data from webhook:', data)

src/components/events/base/event.py

@@ -42,8 +42,7 @@ class Event:
 
     def __init__(self):
         self.name = self.get_name()
-        self.webhook = True
-        # generate consistent hash using hashlib, based off of name
+        self.webhook = True  # all events are webhooks by default
         self.key = f'{self.name}:{md5(f"{self.name + UNIQUE_KEY}".encode()).hexdigest()[:6]}'
         self._actions = []
         self.logs = [LogEvent().from_line(line) for line in open(LOG_LOCATION, 'r') if line.split(',')[0] == self.name]
@@ -81,4 +80,5 @@ def trigger(self, *args, **kwargs):
 
         self.logs.append(log_event)
         for action in self._actions:
-            action.run(data=data)
+            action.set_data(data)
+            action.run()

src/components/logs/log_event.py

@@ -8,7 +8,7 @@ def __init__(self, parent=None, event_type=None, event_time=None, event_data=Non
         self.parent = parent
         self.event_type = event_type
         self.event_time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-        self.event_data = event_data
+        self.event_data = event_data.replace(',', ' ') if event_data else None
 
     def __str__(self):
         return "Event Type: " + self.event_type + " Event Time: " + self.event_time + " Event Data: " + self.event_data

src/settings.py

@@ -1,9 +1,9 @@
 # actions
-REGISTERED_ACTIONS = ['NewAction']
+REGISTERED_ACTIONS = ['PrintData']
 
 # events
-REGISTERED_EVENTS = ['NewEvent']
+REGISTERED_EVENTS = ['WebhookReceived']
 
 # links
-REGISTERED_LINKS = [('NewAction', 'NewEvent')]
+REGISTERED_LINKS = [('PrintData', 'WebhookReceived')]
 

src/tvwb.py

@@ -130,6 +130,9 @@ def create_event(name: str):
 
 @app.command('event:register')
 def register_event(name: str):
+    """
+    Registers an event to the events registry. (Adds to settings.py)
+    """
     logger.info(f'Registering event --->\t{name}')
     try:
         add_event(name)
@@ -146,5 +149,12 @@ def trigger_event(name: str):
     return True
 
 
+@app.command('shell')
+def shell():
+    cmd = '--help'
+    while cmd not in ['exit', 'quit', 'q']:
+        run(f'python3 tvwb.py {cmd}'.split(' '))
+        cmd = typer.prompt("Enter TVWB command (q) to exit")
+
 if __name__ == "__main__":
     app()

src/utils/modify_settings.py

@@ -50,16 +50,17 @@ def validate_settings():
     # make sure all registered actions exist
     for action in REGISTERED_ACTIONS:
         try:
-            cls = getattr(importlib.import_module(f'components.actions.{snake_case(action)}', action), action)()
+            getattr(importlib.import_module(f'components.actions.{snake_case(action)}', action), action)()
         except ImportError:
             logger.critical(f'Action ({action}) not found')
             return False
 
     # make sure all registered events exist
     for event in REGISTERED_EVENTS:
-        cls = getattr(importlib.import_module(f'components.events.{snake_case(event)}', event), event)()
-        if not cls:
-            logger.critical(f'Event ({event}) does not exist')
+        try:
+            getattr(importlib.import_module(f'components.events.{snake_case(event)}', event), event)()
+        except ImportError:
+            logger.critical(f'Event ({event}) not found')
             return False
 
     return True
@@ -163,7 +164,18 @@ def delete_action(action_name):
 
 def add_event(event_name):
     """Add event to settings.py"""
-    build_settings(events=[event_name])
+
+    events = []
+    try:
+        from settings import REGISTERED_EVENTS
+        events = REGISTERED_EVENTS + [event_name]
+    except ImportError:
+        logger.error('Could not import REGISTERED_EVENTS from settings.py')
+
+    # use set to remove duplicates
+    events = list(set(events))
+
+    build_settings(events=events)
 
 
 def link_action_to_event(action_name, event_name):