def dispatcher(mocker, plugin_actions, request):
mocker.patch('machine.dispatch.LowLevelSlackClient', autospec=True)
dispatch_instance = EventDispatcher(plugin_actions, request.param)
mocker.patch.object(dispatch_instance, '_get_bot_id')
dispatch_instance._get_bot_id.return_value = '123'
mocker.patch.object(dispatch_instance, '_get_bot_name')
dispatch_instance._get_bot_name.return_value = 'superbot'
dispatch_instance._aliases = request.param
return dispatch_instance
def dispatcher(mocker, plugin_actions, request):
mocker.patch('machine.dispatch.ThreadPool', autospec=True)
mocker.patch('machine.singletons.SlackClient', autospec=True)
mocker.patch('machine.singletons.BackgroundScheduler', autospec=True)
dispatch_instance = EventDispatcher(plugin_actions, request.param)
mocker.patch.object(dispatch_instance, '_get_bot_id')
dispatch_instance._get_bot_id.return_value = '123'
mocker.patch.object(dispatch_instance, '_get_bot_name')
dispatch_instance._get_bot_name.return_value = 'superbot'
dispatch_instance._aliases = request.param
return dispatch_instance
def __init__(self, settings=None):
announce("Initializing Slack Machine:")
with indent(4):
puts("Loading settings...")
if settings:
self._settings = settings
found_local_settings = True
else:
self._settings, found_local_settings = import_settings()
fmt = '[%(asctime)s][%(levelname)s] %(name)s %(filename)s:%(funcName)s:%(lineno)d |' \
' %(message)s'
date_fmt = '%Y-%m-%d %H:%M:%S'
log_level = self._settings.get('LOGLEVEL', logging.ERROR)
logging.basicConfig(
level=log_level,
format=fmt,
datefmt=date_fmt,
)
if not found_local_settings:
warn(
"No local_settings found! Are you sure this is what you want?"
)
if 'SLACK_API_TOKEN' not in self._settings:
error(
"No SLACK_API_TOKEN found in settings! I need that to work..."
)
sys.exit(1)
self._client = Slack()
puts("Initializing storage using backend: {}".format(
self._settings['STORAGE_BACKEND']))
self._storage = Storage.get_instance()
logger.debug("Storage initialized!")
self._plugin_actions = {
'process': {},
'listen_to': {},
'respond_to': {},
'catch_all': {}
}
self._help = {'human': {}, 'robot': {}}
puts("Loading plugins...")
self.load_plugins()
logger.debug("The following plugin actions were registered: %s",
self._plugin_actions)
self._dispatcher = EventDispatcher(self._plugin_actions,
self._settings)
class Machine:
def __init__(self, settings=None):
announce("Initializing Slack Machine:")
with indent(4):
puts("Loading settings...")
if settings:
self._settings = settings
found_local_settings = True
else:
self._settings, found_local_settings = import_settings()
fmt = '[%(asctime)s][%(levelname)s] %(name)s %(filename)s:%(funcName)s:%(lineno)d |' \
' %(message)s'
date_fmt = '%Y-%m-%d %H:%M:%S'
log_level = self._settings.get('LOGLEVEL', logging.ERROR)
logging.basicConfig(
level=log_level,
format=fmt,
datefmt=date_fmt,
)
if not found_local_settings:
warn("No local_settings found! Are you sure this is what you want?")
if 'SLACK_API_TOKEN' not in self._settings:
error("No SLACK_API_TOKEN found in settings! I need that to work...")
sys.exit(1)
self._client = Slack()
puts("Initializing storage using backend: {}".format(self._settings['STORAGE_BACKEND']))
self._storage = Storage.get_instance()
logger.debug("Storage initialized!")
self._plugin_actions = {
'process': {},
'listen_to': {},
'respond_to': {},
'catch_all': {}
}
puts("Loading plugins...")
self.load_plugins()
logger.debug("The following plugin actions were registered: %s", self._plugin_actions)
self._dispatcher = EventDispatcher(self._plugin_actions)
def load_plugins(self):
with indent(4):
logger.debug("PLUGINS: %s", self._settings['PLUGINS'])
for plugin in self._settings['PLUGINS']:
for class_name, cls in import_string(plugin):
if MachineBasePlugin in cls.__bases__ and cls is not MachineBasePlugin:
logger.debug("Found a Machine plugin: {}".format(plugin))
storage = PluginStorage(class_name)
instance = cls(self._settings, MessagingClient(),
storage)
self._register_plugin(class_name, instance)
show_valid(class_name)
def _register_plugin(self, plugin_class, cls_instance):
if hasattr(cls_instance, 'catch_all'):
self._plugin_actions['catch_all'][plugin_class] = {
'class': cls_instance,
'class_name': plugin_class,
'function': getattr(cls_instance, 'catch_all')
}
for name, fn in inspect.getmembers(cls_instance, predicate=inspect.ismethod):
if hasattr(fn, 'metadata'):
self._register_plugin_actions(plugin_class, fn.metadata, cls_instance, name, fn)
def _register_plugin_actions(self, plugin_class, metadata, cls_instance, fn_name, fn):
fq_fn_name = "{}.{}".format(plugin_class, fn_name)
for action, config in metadata['plugin_actions'].items():
if action == 'process':
event_type = config['event_type']
event_handlers = self._plugin_actions['process'].get(event_type, {})
event_handlers[fq_fn_name] = {
'class': cls_instance,
'class_name': plugin_class,
'function': fn
}
self._plugin_actions['process'][event_type] = event_handlers
if action == 'respond_to' or action == 'listen_to':
for regex in config['regex']:
event_handler = {
'class': cls_instance,
'class_name': plugin_class,
'function': fn,
'regex': regex
}
key = "{}-{}".format(fq_fn_name, regex.pattern)
self._plugin_actions[action][key] = event_handler
if action == 'schedule':
Scheduler.get_instance().add_job(fq_fn_name, trigger='cron', args=[cls_instance],
id=fq_fn_name, replace_existing=True, **config)
def run(self):
announce("\nStarting Slack Machine:")
with indent(4):
self._client.rtm_connect()
show_valid("Connected to Slack")
Scheduler.get_instance().start()
show_valid("Scheduler started")
show_valid("Dispatcher started")
self._dispatcher.start()
class Machine:
def __init__(self, settings=None):
announce("Initializing Slack Machine:")
with indent(4):
puts("Loading settings...")
if settings:
self._settings = settings
found_local_settings = True
else:
self._settings, found_local_settings = import_settings()
fmt = '[%(asctime)s][%(levelname)s] %(name)s %(filename)s:%(funcName)s:%(lineno)d |' \
' %(message)s'
date_fmt = '%Y-%m-%d %H:%M:%S'
log_level = self._settings.get('LOGLEVEL', logging.ERROR)
logging.basicConfig(
level=log_level,
format=fmt,
datefmt=date_fmt,
)
if not found_local_settings:
warn("No local_settings found! Are you sure this is what you want?")
if 'SLACK_API_TOKEN' not in self._settings:
error("No SLACK_API_TOKEN found in settings! I need that to work...")
sys.exit(1)
self._client = Slack()
puts("Initializing storage using backend: {}".format(self._settings['STORAGE_BACKEND']))
self._storage = Storage.get_instance()
logger.debug("Storage initialized!")
self._plugin_actions = {
'process': {},
'listen_to': {},
'respond_to': {},
'catch_all': {}
}
self._help = {
'human': {},
'robot': {}
}
puts("Loading plugins...")
self.load_plugins()
logger.debug("The following plugin actions were registered: %s", self._plugin_actions)
self._dispatcher = EventDispatcher(self._plugin_actions, self._settings)
def load_plugins(self):
with indent(4):
logger.debug("PLUGINS: %s", self._settings['PLUGINS'])
for plugin in self._settings['PLUGINS']:
for class_name, cls in import_string(plugin):
if issubclass(cls, MachineBasePlugin) and cls is not MachineBasePlugin:
logger.debug("Found a Machine plugin: {}".format(plugin))
storage = PluginStorage(class_name)
instance = cls(self._settings, MessagingClient(),
storage)
missing_settings = self._register_plugin(class_name, instance)
if missing_settings:
show_invalid(class_name)
with indent(4):
error_msg = "The following settings are missing: {}".format(
", ".join(missing_settings)
)
puts(colored.red(error_msg))
puts(colored.red("This plugin will not be loaded!"))
del instance
else:
instance.init()
show_valid(class_name)
self._storage.set('manual', dill.dumps(self._help))
def _register_plugin(self, plugin_class, cls_instance):
missing_settings = []
missing_settings.extend(self._check_missing_settings(cls_instance.__class__))
methods = inspect.getmembers(cls_instance, predicate=inspect.ismethod)
for _, fn in methods:
missing_settings.extend(self._check_missing_settings(fn))
if missing_settings:
return missing_settings
if hasattr(cls_instance, 'catch_all'):
self._plugin_actions['catch_all'][plugin_class] = {
'class': cls_instance,
'class_name': plugin_class,
'function': getattr(cls_instance, 'catch_all')
}
if cls_instance.__doc__:
class_help = cls_instance.__doc__.splitlines()[0]
else:
class_help = plugin_class
self._help['human'][class_help] = self._help['human'].get(class_help, {})
self._help['robot'][class_help] = self._help['robot'].get(class_help, [])
for name, fn in methods:
if hasattr(fn, 'metadata'):
self._register_plugin_actions(plugin_class, fn.metadata, cls_instance, name, fn,
class_help)
def _check_missing_settings(self, fn_or_class):
missing_settings = []
if hasattr(fn_or_class, 'metadata') and 'required_settings' in fn_or_class.metadata:
for setting in fn_or_class.metadata['required_settings']:
if setting not in self._settings:
missing_settings.append(setting.upper())
return missing_settings
def _register_plugin_actions(self, plugin_class, metadata, cls_instance, fn_name, fn,
class_help):
fq_fn_name = "{}.{}".format(plugin_class, fn_name)
if fn.__doc__:
self._help['human'][class_help][fq_fn_name] = self._parse_human_help(fn.__doc__)
for action, config in metadata['plugin_actions'].items():
if action == 'process':
event_type = config['event_type']
event_handlers = self._plugin_actions['process'].get(event_type, {})
event_handlers[fq_fn_name] = {
'class': cls_instance,
'class_name': plugin_class,
'function': fn
}
self._plugin_actions['process'][event_type] = event_handlers
if action == 'respond_to' or action == 'listen_to':
for regex in config['regex']:
event_handler = {
'class': cls_instance,
'class_name': plugin_class,
'function': fn,
'regex': regex
}
key = "{}-{}".format(fq_fn_name, regex.pattern)
self._plugin_actions[action][key] = event_handler
self._help['robot'][class_help].append(self._parse_robot_help(regex, action))
if action == 'schedule':
Scheduler.get_instance().add_job(fq_fn_name, trigger='cron', args=[cls_instance],
id=fq_fn_name, replace_existing=True, **config)
if action == 'route':
for route_config in config:
bottle.route(**route_config)(fn)
@staticmethod
def _parse_human_help(doc):
summary = doc.splitlines()[0].split(':')
if len(summary) > 1:
command = summary[0].strip()
cmd_help = summary[1].strip()
else:
command = "??"
cmd_help = summary[0].strip()
return {
'command': command,
'help': cmd_help
}
@staticmethod
def _parse_robot_help(regex, action):
if action == 'respond_to':
return "@botname {}".format(regex.pattern)
else:
return regex.pattern
def _keepalive(self):
while True:
time.sleep(self._settings['KEEP_ALIVE'])
self._client.server.send_to_websocket({'type': 'ping'})
logger.debug("Client Ping!")
def run(self):
announce("\nStarting Slack Machine:")
with indent(4):
connected = self._client.rtm_connect()
if not connected:
logger.error("Could not connect to Slack! Aborting...")
sys.exit(1)
show_valid("Connected to Slack")
Scheduler.get_instance().start()
show_valid("Scheduler started")
if not self._settings['DISABLE_HTTP']:
self._bottle_thread = Thread(
target=bottle.run,
kwargs=dict(
host=self._settings['HTTP_SERVER_HOST'],
port=self._settings['HTTP_SERVER_PORT'],
server=self._settings['HTTP_SERVER_BACKEND'],
)
)
self._bottle_thread.daemon = True
self._bottle_thread.start()
show_valid("Web server started")
if self._settings['KEEP_ALIVE']:
self._keep_alive_thread = Thread(target=self._keepalive)
self._keep_alive_thread.daemon = True
self._keep_alive_thread.start()
show_valid(
"Keepalive thread started [Interval: %ss]" % self._settings['KEEP_ALIVE']
)
show_valid("Dispatcher started")
self._dispatcher.start()