class Server(object):
def __init__(self, token, connect=True):
self.token = token
self.username = None
self.domain = None
self.login_data = None
self.websocket = None
self.users = SearchList()
self.channels = SearchList()
self.connected = False
self.pingcounter = 0
self.api_requester = SlackRequest()
if connect:
self.rtm_connect()
def __eq__(self, compare_str):
if compare_str == self.domain or compare_str == self.token:
return True
else:
return False
def __str__(self):
data = ""
for key in list(self.__dict__.keys()):
data += "{} : {}\n".format(key, str(self.__dict__[key])[:40])
return data
def __repr__(self):
return self.__str__()
def rtm_connect(self, reconnect=False):
reply = self.api_requester.do(self.token, "rtm.start")
if reply.code != 200:
raise SlackConnectionError
else:
login_data = json.loads(reply.read().decode('utf-8'))
if login_data["ok"]:
self.ws_url = login_data['url']
if not reconnect:
self.parse_slack_login_data(login_data)
self.connect_slack_websocket(self.ws_url)
else:
raise SlackLoginError
def parse_slack_login_data(self, login_data):
self.login_data = login_data
self.domain = self.login_data["team"]["domain"]
self.username = self.login_data["self"]["name"]
self.parse_channel_data(login_data["channels"])
self.parse_channel_data(login_data["groups"])
self.parse_channel_data(login_data["ims"])
self.parse_user_data(login_data["users"])
def connect_slack_websocket(self, ws_url):
try:
self.websocket = create_connection(ws_url)
self.websocket.sock.setblocking(0)
except:
raise SlackConnectionError
def parse_channel_data(self, channel_data):
for channel in channel_data:
if "name" not in channel:
channel["name"] = channel["id"]
if "members" not in channel:
channel["members"] = []
self.attach_channel(channel["name"], channel["id"],
channel["members"])
def parse_user_data(self, user_data):
for user in user_data:
if "tz" not in user:
user["tz"] = "unknown"
if "real_name" not in user:
user["real_name"] = user["name"]
self.attach_user(user["name"], user["id"], user["real_name"],
user["tz"])
def send_to_websocket(self, data):
"""Send (data) directly to the websocket."""
try:
data = json.dumps(data)
self.websocket.send(data)
except:
self.rtm_connect(reconnect=True)
def ping(self):
return self.send_to_websocket({"type": "ping"})
def websocket_safe_read(self):
""" Returns data if available, otherwise ''. Newlines indicate multiple
messages
"""
data = ""
while True:
try:
data += "{}\n".format(self.websocket.recv())
except SSLError as e:
if e.errno == 2:
# errno 2 occurs when trying to read or write data, but more
# data needs to be received on the underlying TCP transport
# before the request can be fulfilled.
#
# Python 2.7.9+ and Python 3.3+ give this its own exception,
# SSLWantReadError
return ''
raise
return data.rstrip()
def attach_user(self, name, id, real_name, tz):
if self.users.find(id) is None:
self.users.append(User(self, name, id, real_name, tz))
def attach_channel(self, name, id, members=[]):
if self.channels.find(id) is None:
self.channels.append(Channel(self, name, id, members))
def join_channel(self, name):
print(
self.api_requester.do(self.token,
"channels.join?name={}".format(name)).read())
def api_call(self, method, **kwargs):
reply = self.api_requester.do(self.token, method, kwargs)
return reply.read()
class Server(object):
'''
The Server object owns the websocket connection and all attached channel information.
'''
def __init__(self, token, connect=True):
self.token = token
self.username = None
self.domain = None
self.login_data = None
self.websocket = None
self.users = SearchList()
self.channels = SearchList()
self.connected = False
self.ws_url = None
self.api_requester = SlackRequest()
if connect:
self.rtm_connect()
def __eq__(self, compare_str):
if compare_str == self.domain or compare_str == self.token:
return True
else:
return False
def __hash__(self):
return hash(self.token)
def __str__(self):
'''
Example Output::
username : None
domain : None
websocket : None
users : []
login_data : None
api_requester : <slackclient._slackrequest.SlackRequest
channels : []
token : xoxb-asdlfkyadsofii7asdf734lkasdjfllakjba7zbu
connected : False
ws_url : None
'''
data = ""
for key in list(self.__dict__.keys()):
data += "{} : {}\n".format(key, str(self.__dict__[key])[:40])
return data
def __repr__(self):
return self.__str__()
def rtm_connect(self, reconnect=False):
reply = self.api_requester.do(self.token, "rtm.start")
if reply.status_code != 200:
raise SlackConnectionError
else:
login_data = reply.json()
if login_data["ok"]:
self.ws_url = login_data['url']
if not reconnect:
self.parse_slack_login_data(login_data)
self.connect_slack_websocket(self.ws_url)
else:
raise SlackLoginError
def parse_slack_login_data(self, login_data):
self.login_data = login_data
self.domain = self.login_data["team"]["domain"]
self.username = self.login_data["self"]["name"]
self.parse_channel_data(login_data["channels"])
self.parse_channel_data(login_data["groups"])
self.parse_channel_data(login_data["ims"])
self.parse_user_data(login_data["users"])
def connect_slack_websocket(self, ws_url):
try:
self.websocket = create_connection(ws_url)
self.websocket.sock.setblocking(0)
except:
raise SlackConnectionError
def parse_channel_data(self, channel_data):
for channel in channel_data:
if "name" not in channel:
channel["name"] = channel["id"]
if "members" not in channel:
channel["members"] = []
self.attach_channel(channel["name"],
channel["id"],
channel["members"])
def parse_user_data(self, user_data):
for user in user_data:
if "tz" not in user:
user["tz"] = "unknown"
if "real_name" not in user:
user["real_name"] = user["name"]
self.attach_user(user["name"], user["id"], user["real_name"], user["tz"])
def send_to_websocket(self, data):
"""
Send a JSON message directly to the websocket. See
`RTM documentation <https://api.slack.com/rtm` for allowed types.
:Args:
data (dict) the key/values to send the websocket.
"""
try:
data = json.dumps(data)
self.websocket.send(data)
except:
self.rtm_connect(reconnect=True)
def ping(self):
return self.send_to_websocket({"type": "ping"})
def websocket_safe_read(self):
""" Returns data if available, otherwise ''. Newlines indicate multiple
messages
"""
data = ""
while True:
try:
data += "{0}\n".format(self.websocket.recv())
except SSLError as e:
if e.errno == 2:
# errno 2 occurs when trying to read or write data, but more
# data needs to be received on the underlying TCP transport
# before the request can be fulfilled.
#
# Python 2.7.9+ and Python 3.3+ give this its own exception,
# SSLWantReadError
return ''
raise
return data.rstrip()
def attach_user(self, name, channel_id, real_name, tz):
if self.users.find(channel_id) is None:
self.users.append(User(self, name, channel_id, real_name, tz))
def attach_channel(self, name, channel_id, members=None):
if members is None:
members = []
if self.channels.find(channel_id) is None:
self.channels.append(Channel(self, name, channel_id, members))
def join_channel(self, name):
'''
Join a channel by name.
Note: this action is not allowed by bots, they must be invited to channels.
'''
return self.api_requester.do(
self.token,
"channels.join?name={}".format(name)
).text
def api_call(self, method, **kwargs):
'''
Call the Slack Web API as documented here: https://api.slack.com/web
:Args:
method (str): The API Method to call. See here for a list: https://api.slack.com/methods
:Kwargs:
(optional) kwargs: any arguments passed here will be bundled and sent to the api
requester as post_data
and will be passed along to the API.
Example::
sc.server.api_call(
"channels.setPurpose",
channel="CABC12345",
purpose="Writing some code!"
)
Returns:
str -- returns the text of the HTTP response.
Examples::
u'{"ok":true,"purpose":"Testing bots"}'
or
u'{"ok":false,"error":"channel_not_found"}'
See here for more information on responses: https://api.slack.com/web
'''
return self.api_requester.do(self.token, method, kwargs).text
class Server(object):
'''
The Server object owns the websocket connection and all attached channel information.
'''
def __init__(self, token, connect=True):
self.token = token
self.username = None
self.domain = None
self.login_data = None
self.websocket = None
self.users = SearchDict()
self.channels = SearchList()
self.connected = False
self.ws_url = None
self.api_requester = SlackRequest()
if connect:
self.rtm_connect()
def __eq__(self, compare_str):
if compare_str == self.domain or compare_str == self.token:
return True
else:
return False
def __hash__(self):
return hash(self.token)
def __str__(self):
'''
Example Output::
username : None
domain : None
websocket : None
users : []
login_data : None
api_requester : <slackclient._slackrequest.SlackRequest
channels : []
token : xoxb-asdlfkyadsofii7asdf734lkasdjfllakjba7zbu
connected : False
ws_url : None
'''
data = ""
for key in list(self.__dict__.keys()):
data += "{} : {}\n".format(key, str(self.__dict__[key])[:40])
return data
def __repr__(self):
return self.__str__()
def append_user_agent(self, name, version):
self.api_requester.append_user_agent(name, version)
def rtm_connect(self, reconnect=False, timeout=None):
reply = self.api_requester.do(self.token, "rtm.start", timeout=timeout)
if reply.status_code != 200:
raise SlackConnectionError
else:
login_data = reply.json()
if login_data["ok"]:
self.ws_url = login_data['url']
if not reconnect:
self.parse_slack_login_data(login_data)
self.connect_slack_websocket(self.ws_url)
else:
raise SlackLoginError
def parse_slack_login_data(self, login_data):
self.login_data = login_data
self.domain = self.login_data["team"]["domain"]
self.username = self.login_data["self"]["name"]
self.parse_channel_data(login_data["channels"])
self.parse_channel_data(login_data["groups"])
self.parse_channel_data(login_data["ims"])
self.parse_user_data(login_data["users"])
def connect_slack_websocket(self, ws_url):
try:
host = os.environ.get('HTTP_PROXY_HOST')
port = os.environ.get('HTTP_PROXY_PORT')
if None not in (host, port):
self.websocket = create_connection(ws_url,
http_proxy_host=host,
http_proxy_port=port)
else:
self.websocket = create_connection(ws_url)
self.websocket.sock.setblocking(0)
except:
raise SlackConnectionError
def parse_channel_data(self, channel_data):
for channel in channel_data:
if "name" not in channel:
channel["name"] = channel["id"]
if "members" not in channel:
channel["members"] = []
self.attach_channel(channel["name"], channel["id"],
channel["members"])
def parse_user_data(self, user_data):
for user in user_data:
if "tz" not in user:
user["tz"] = "unknown"
if "real_name" not in user:
user["real_name"] = user["name"]
self.attach_user(user["name"], user["id"], user["real_name"],
user["tz"])
def send_to_websocket(self, data):
"""
Send a JSON message directly to the websocket. See
`RTM documentation <https://api.slack.com/rtm` for allowed types.
:Args:
data (dict) the key/values to send the websocket.
"""
try:
data = json.dumps(data)
self.websocket.send(data)
except:
self.rtm_connect(reconnect=True)
def ping(self):
return self.send_to_websocket({"type": "ping"})
def websocket_safe_read(self):
""" Returns data if available, otherwise ''. Newlines indicate multiple
messages
"""
data = ""
while True:
try:
data += "{0}\n".format(self.websocket.recv())
except SSLError as e:
if e.errno == 2:
# errno 2 occurs when trying to read or write data, but more
# data needs to be received on the underlying TCP transport
# before the request can be fulfilled.
#
# Python 2.7.9+ and Python 3.3+ give this its own exception,
# SSLWantReadError
return ''
raise
return data.rstrip()
def attach_user(self, name, user_id, real_name, tz):
self.users.update({user_id: User(self, name, user_id, real_name, tz)})
def attach_channel(self, name, channel_id, members=None):
if members is None:
members = []
if self.channels.find(channel_id) is None:
self.channels.append(Channel(self, name, channel_id, members))
def join_channel(self, name, timeout=None):
'''
Join a channel by name.
Note: this action is not allowed by bots, they must be invited to channels.
'''
return self.api_requester.do(self.token,
"channels.join?name={}".format(name),
timeout=timeout).text
def api_call(self, method, timeout=None, **kwargs):
'''
Call the Slack Web API as documented here: https://api.slack.com/web
:Args:
method (str): The API Method to call. See here for a list: https://api.slack.com/methods
:Kwargs:
(optional) timeout: stop waiting for a response after a given number of seconds
(optional) kwargs: any arguments passed here will be bundled and sent to the api
requester as post_data
and will be passed along to the API.
Example::
sc.server.api_call(
"channels.setPurpose",
channel="CABC12345",
purpose="Writing some code!"
)
Returns:
str -- returns the text of the HTTP response.
Examples::
u'{"ok":true,"purpose":"Testing bots"}'
or
u'{"ok":false,"error":"channel_not_found"}'
See here for more information on responses: https://api.slack.com/web
'''
return self.api_requester.do(self.token,
method,
kwargs,
timeout=timeout).text
class Server(object):
def __init__(self, token, connect=True):
self.token = token
self.username = None
self.domain = None
self.login_data = None
self.websocket = None
self.users = SearchList()
self.channels = SearchList()
self.connected = False
self.pingcounter = 0
self.ws_url = None
self.api_requester = SlackRequest()
if connect:
self.rtm_connect()
def __eq__(self, compare_str):
if compare_str == self.domain or compare_str == self.token:
return True
else:
return False
def __str__(self):
data = ""
for key in list(self.__dict__.keys()):
data += "{} : {}\n".format(key, str(self.__dict__[key])[:40])
return data
def __repr__(self):
return self.__str__()
def rtm_connect(self, reconnect=False):
reply = self.api_requester.do(self.token, "rtm.start")
if reply.status_code != 200:
raise SlackConnectionError
else:
login_data = reply.json()
if login_data["ok"]:
self.ws_url = login_data['url']
if not reconnect:
self.parse_slack_login_data(login_data)
self.connect_slack_websocket(self.ws_url)
else:
raise SlackLoginError
def parse_slack_login_data(self, login_data):
self.login_data = login_data
self.domain = self.login_data["team"]["domain"]
self.username = self.login_data["self"]["name"]
self.parse_channel_data(login_data["channels"])
self.parse_channel_data(login_data["groups"])
self.parse_channel_data(login_data["ims"])
self.parse_user_data(login_data["users"])
def connect_slack_websocket(self, ws_url):
try:
self.websocket = create_connection(ws_url)
self.websocket.sock.setblocking(0)
except:
raise SlackConnectionError
def parse_channel_data(self, channel_data):
for channel in channel_data:
if "name" not in channel:
channel["name"] = channel["id"]
if "members" not in channel:
channel["members"] = []
self.attach_channel(channel["name"],
channel["id"],
channel["members"])
def parse_user_data(self, user_data):
for user in user_data:
if "tz" not in user:
user["tz"] = "unknown"
if "real_name" not in user:
user["real_name"] = user["name"]
self.attach_user(user["name"], user["id"], user["real_name"], user["tz"])
def send_to_websocket(self, data):
"""Send (data) directly to the websocket."""
try:
data = json.dumps(data)
self.websocket.send(data)
except:
self.rtm_connect(reconnect=True)
def ping(self):
return self.send_to_websocket({"type": "ping"})
def websocket_safe_read(self):
""" Returns data if available, otherwise ''. Newlines indicate multiple
messages
"""
while True:
try:
yield self.websocket.recv()
except SSLWantReadError:
time.sleep(.1)
except SSLError as e:
if e.errno == 2:
# errno 2 occurs when trying to read or write data, but more
# data needs to be received on the underlying TCP transport
# before the request can be fulfilled.
#
# Python 2.7.9+ and Python 3.3+ give this its own exception,
# SSLWantReadError
time.sleep(.1)
raise
def attach_user(self, name, channel_id, real_name, tz):
if self.users.find(channel_id) is None:
self.users.append(User(self, name, channel_id, real_name, tz))
def attach_channel(self, name, channel_id, members=None):
if members is None:
members = []
if self.channels.find(channel_id) is None:
self.channels.append(Channel(self, name, channel_id, members))
def join_channel(self, name):
print(self.api_requester.do(self.token,
"channels.join?name={}".format(name)).text)
def api_call(self, method, **kwargs):
return self.api_requester.do(self.token, method, kwargs).text