123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451 |
- #
- # Copyright (c) 2017-2019 Joe Clarke <jclarke@cisco.com>
- # All rights reserved.
- #
- # Redistribution and use in source and binary forms, with or without
- # modification, are permitted provided that the following conditions
- # are met:
- # 1. Redistributions of source code must retain the above copyright
- # notice, this list of conditions and the following disclaimer.
- # 2. Redistributions in binary form must reproduce the above copyright
- # notice, this list of conditions and the following disclaimer in the
- # documentation and/or other materials provided with the distribution.
- #
- # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
- # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
- # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- # SUCH DAMAGE.
- from builtins import object
- import requests
- from requests_toolbelt import MultipartEncoder
- from io import BytesIO
- import logging
- import time
- from enum import Enum, unique
- @unique
- class ResourceType(Enum):
- ROOM = 1
- TEAM = 2
- @unique
- class MessageType(Enum):
- GOOD = "✅ "
- BAD = "🚨🚨 "
- WARNING = "✴️ "
- NEUTRAL = ""
- class Sparker(object):
- SPARK_API = "https://api.ciscospark.com/v1/"
- RETRIES = 5
- MAX_MSG_LEN = 7430
- _headers = {"authorization": None, "content-type": "application/json"}
- _logit = False
- def __init__(self, **kwargs):
- if "logit" in kwargs:
- self._logit = kwargs["logit"]
- if "token" in kwargs:
- self._headers["authorization"] = "Bearer " + kwargs["token"]
- self._team_cache = {}
- self._room_cache = {}
- @staticmethod
- def _request_with_retry(*args, **kwargs):
- backoff = 1
- i = 0
- while True:
- try:
- response = requests.request(*args, **kwargs)
- response.raise_for_status()
- return response
- except Exception as e:
- if (response.status_code != 429 and response.status_code != 503 and response.status_code != 400) or i == Sparker.RETRIES:
- return response
- if response.status_code == 400:
- print("XXX: Body is {}".format(response.text))
- time.sleep(backoff)
- backoff *= 2
- i += 1
- @staticmethod
- def _get_items_pages(*args, **kwargs):
- more_pages = True
- result = []
- while more_pages:
- try:
- response = Sparker._request_with_retry(*args, **kwargs)
- response.raise_for_status()
- result += response.json()["items"]
- if "Link" in response.headers:
- links = requests.utils.parse_header_links(response.headers["Link"])
- found_next = False
- for link in links:
- if link["rel"] == "next":
- args = (args[0], link["url"])
- kwargs.pop("params", None)
- found_next = True
- break
- if found_next:
- continue
- more_pages = False
- else:
- more_pages = False
- except Exception as e:
- raise e
- return result
- def set_token(self, token):
- self._headers["authorization"] = "Bearer " + token
- def check_token(self):
- if self._headers["authorization"] is None:
- if self._logit:
- logging.error("Spark token is not set!")
- else:
- print("Spark token is not set!")
- return False
- return True
- def get_message(self, mid):
- if not self.check_token():
- return None
- url = self.SPARK_API + "messages" + "/" + mid
- try:
- response = Sparker._request_with_retry("GET", url, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error getting message with ID {}: {}".format(mid, getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- return response.json()
- def get_person(self, pid):
- if not self.check_token():
- return None
- url = self.SPARK_API + "people" + "/" + pid
- try:
- response = Sparker._request_with_retry("GET", url, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error getting person with ID {}: {}".format(pid, getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- return response.json()
- def get_team_id(self, team):
- if not self.check_token():
- return None
- if team in self._team_cache:
- return self._team_cache[team]
- url = self.SPARK_API + "teams"
- try:
- items = Sparker._get_items_pages("GET", url, headers=self._headers)
- except Exception as e:
- msg = "Error retrieving teams: {}".format(getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- team_id = None
- for t in items:
- if "name" in t and t["name"] == team:
- self._team_cache[team] = t["id"]
- return t["id"]
- if team_id is None:
- msg = "Error finding team ID for {}".format(team)
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- def get_room_id(self, team_id, room):
- if not self.check_token():
- return None
- if team_id is None:
- team_id = ""
- if "{}:{}".format(team_id, room) in self._room_cache:
- return self._room_cache["{}:{}".format(team_id, room)]
- url = self.SPARK_API + "rooms"
- params = {}
- if team_id != "":
- params["teamId"] = team_id
- try:
- items = Sparker._get_items_pages("GET", url, headers=self._headers, params=params)
- except Exception as e:
- msg = "Error retrieving room {}: {}".format(room, getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- room_id = None
- for r in items:
- if "title" in r and r["title"] == room:
- self._room_cache["{}:{}".format(team_id, room)] = r["id"]
- return r["id"]
- if room_id is None:
- msg = "Failed to find room ID for {}".format(room)
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- def get_members(self, resource, type=ResourceType.TEAM):
- if not self.check_token():
- return None
- payload = {}
- url = self.SPARK_API
- if type == ResourceType.TEAM:
- rid = self.get_team_id(resource)
- if rid is None:
- return None
- url += "team/memberships"
- payload["teamId"] = rid
- elif type == ResourceType.ROOM:
- rid = self.get_room_id(None, resource)
- if rid is None:
- return None
- url += "memberships"
- payload["roomId"] = rid
- else:
- msg = "Resource type must be TEAM or ROOM"
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- try:
- items = Sparker._get_items_pages("GET", url, params=payload, headers=self._headers)
- except Exception as e:
- msg = "Error getting resource membership: {}".format(getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return None
- return items
- def add_members(self, members, resource, type=ResourceType.TEAM):
- if not self.check_token():
- return None
- payload = {"isModerator": False}
- url = self.SPARK_API
- err_occurred = False
- if type == ResourceType.TEAM:
- rid = self.get_team_id(resource)
- if rid is None:
- return False
- url += "team/memberships"
- payload["teamId"] = rid
- elif type == ResourceType.ROOM:
- rid = self.get_room_id(None, resource)
- if rid is None:
- return False
- url += "memberships"
- payload["roomId"] = rid
- else:
- msg = "Resource type must be TEAM or ROOM"
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- mem_list = members
- if not isinstance(members, list):
- mem_list = [members]
- for member in mem_list:
- try:
- if isinstance(member, dict):
- if "personId" in member:
- payload["personId"] = member["personId"]
- payload.pop("personEmail", None)
- else:
- payload["personEmail"] = member["personEmail"]
- payload.pop("personId", None)
- else:
- if member != "":
- payload["personEmail"] = member
- payload.pop("personId", None)
- else:
- continue
- response = Sparker._request_with_retry("POST", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error adding member %s to %s: %s" % (member, resource, getattr(e, "message", repr(e)),)
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- err_occurred = True
- return not err_occurred
- def post_to_spark(self, team, room, msg, mtype=MessageType.NEUTRAL):
- if not self.check_token():
- return None
- mt = None
- try:
- mt = MessageType(mtype)
- except Exception as e:
- msg = "Invalid message type: {}".format(getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- team_id = None
- if team is not None:
- team_id = self.get_team_id(team)
- if team_id is None:
- return False
- room_id = self.get_room_id(team_id, room)
- if room_id is None:
- return False
- url = self.SPARK_API + "messages"
- payload = {
- "roomId": room_id,
- "markdown": mt.value + ((msg[: Sparker.MAX_MSG_LEN] + "...") if len(msg) > Sparker.MAX_MSG_LEN else msg),
- }
- try:
- response = Sparker._request_with_retry("POST", url, json=payload, headers=self._headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error posting message: {}".format(getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- return True
- def post_to_spark_with_attach(self, team, room, msg, attach, fname, ftype, mtype=MessageType.NEUTRAL):
- if not self.check_token():
- return None
- mt = None
- try:
- mt = MessageType(mtype)
- except Exception as e:
- msg = "Invalid message type: {}".format(getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- team_id = None
- if team is not None:
- team_id = self.get_team_id(team)
- if team_id is None:
- return False
- room_id = self.get_room_id(team_id, room)
- if room_id is None:
- return False
- url = self.SPARK_API + "messages"
- bio = BytesIO(attach)
- payload = {
- "roomId": room_id,
- "markdown": mt.value + ((msg[: Sparker.MAX_MSG_LEN] + "...") if len(msg) > Sparker.MAX_MSG_LEN else msg),
- "files": (fname, bio, ftype),
- }
- m = MultipartEncoder(fields=payload)
- headers = self._headers
- headers["content-type"] = m.content_type
- try:
- response = Sparker._request_with_retry("POST", url, data=m, headers=headers)
- response.raise_for_status()
- except Exception as e:
- msg = "Error posting message: {}".format(getattr(e, "message", repr(e)))
- if self._logit:
- logging.error(msg)
- else:
- print(msg)
- return False
- return True
|