Merge branch 'master' into vageli/flake8

Author: vagelim

setup.py

@@ -0,0 +1,11 @@
+from setuptools import setup
+
+setup(name='ubiquiti',
+      version='0.2',
+      description='Library for interacting with Ubiquity Cloudkey',
+      url='http://github.com/vageli/Unifi-Python-API',
+      author='vagelim',
+      author_email='code@evangelosm.com',
+      license='MIT',
+      packages=['ubiquiti'],
+      zip_safe=False)

ubiquiti/unifi.py

@@ -37,24 +37,24 @@ def __init__(self, username: str="ubnt", password: str="ubnt", site: str="defaul
 
     def __enter__(self):
         """
-        Contextmanager entry handle
+        Contextmanager entry handle.
 
-        :return: isntance object of class
+        :return: instance object of class
         """
         self.login()
         return self
 
     def __exit__(self, *args):
         """
-        Contextmanager exit handle
+        Contextmanager exit handle.
 
         :return: None
         """
         self.logout()
 
     def login(self):
         """
-        Log the user in
+        Log the user in.
 
         :return: None
         """
@@ -64,7 +64,7 @@ def login(self):
 
     def logout(self):
         """
-        Log the user out
+        Log the user out.
 
         :return: None
         """
@@ -73,16 +73,146 @@ def logout(self):
 
     def list_clients(self, filters: Dict[str, Union[str, Pattern]]=None, order_by: str=None) -> list:
         """
-        List all available clients from the api
+        List all available clients from the api.
 
-        :param filters: dict with valid key, value pairs, string supplied is compiled to a regular expression
-        :param order_by: order by a valid client key, defaults to '_id' if key is not found
+        :param filters: dict of k/v pairs; string is compiled to regex
+        :param order_by: order by a key; defaults to '_id'
         :return: A list of clients on the format of a dict
         """
 
         r = self._session.get("{}/api/s/{}/stat/sta".format(self._baseurl, self._site, verify=self._verify_ssl), data="json={}")
         self._current_status_code = r.status_code
-        
+
+        if self._current_status_code == 401:
+            raise LoggedInException("Invalid login, or login has expired")
+
+        data = r.json()['data']
+
+        if filters:
+            for term, value in filters.items():
+                value_re = value if isinstance(value, Pattern) else re.compile(value)
+
+                data = [x for x in data if term in x.keys() and re.fullmatch(value_re, x[term])]
+
+        if order_by:
+            data = sorted(data, key=lambda x: x[order_by] if order_by in x.keys() else x['_id'])
+
+        return data
+
+    def health(self) -> dict:
+        """
+        List site health information.
+        :return: A dict of network health information (see below)
+        num_adopted
+        num_ap        
+        num_disabled
+        num_disconnected
+        num_guest
+        num_iot
+        num_pending
+        num_user
+        rx_bytes-r
+        status
+        subsystem
+        tx_bytes-r
+        """
+        r = self._session.get("{}/api/s/{}/stat/health".format(self._baseurl, self._site, verify=False), data="json={}")
+        self._current_status_code = r.status_code
+        if self._current_status_code == 401:
+            raise LoggedInException("Invalid login, or login has expired")
+
+        data = r.json()['data']
+
+        return data[0]
+
+    def info(self) -> dict:
+        """
+        List site information.
+        :return: A dict of site information (see below for a sample)
+        autobackup
+        build
+        cloudkey_update_version
+        cloudkey_version
+        data_retention_days
+        debug_system
+        eol_pending_device_count
+        hostname
+        https_port
+        inform_port
+        ip_addrs
+        name
+        timezone
+        unifi_go_enabled
+        update_available
+        version
+        """
+        r = self._session.get("{}/api/s/{}/stat/sysinfo".format(self._baseurl, self._site, verify=False), data="json={}")
+        self._current_status_code = r.status_code
+        if self._current_status_code == 401:
+            raise LoggedInException("Invalid login, or login has expired")
+
+        data = r.json()['data']
+
+        return data[0]
+
+    def events(self, filters: Dict[str, Union[str, Pattern]]=None, order_by: str=None) -> list:
+        """
+        List site events.
+
+        :param filters: dict of k/v pairs; string is compiled to regex
+        :param order_by: order by a key; defaults to '_id'
+        :return: A list of events as dicts (see below for sample keys)
+        app_proto
+        datetime
+        dest_ip
+        dest_port
+        event_type
+        host
+        key
+        msg
+        proto
+        site_id
+        src_ip
+        src_mac
+        src_port
+        srcipCountry
+        subsystem
+        time
+        """
+        r = self._session.get("{}/api/s/{}/stat/event".format(self._baseurl, self._site, verify=self._verify_ssl), data="json={}")
+        self._current_status_code = r.status_code
+
+        if self._current_status_code == 401:
+            raise LoggedInException("Invalid login, or login has expired")
+
+        data = r.json()['data']
+
+        if filters:
+            for term, value in filters.items():
+                value_re = value if isinstance(value, Pattern) else re.compile(value)
+
+                data = [x for x in data if term in x.keys() and re.fullmatch(value_re, x[term])]
+
+        if order_by:
+            data = sorted(data, key=lambda x: x[order_by] if order_by in x.keys() else x['_id'])
+
+        return data
+
+    def routes(self, filters: Dict[str, Union[str, Pattern]]=None, order_by: str=None) -> list:
+        """
+        List site routes.
+
+        :param filters: dict of k/v pairs; string is compiled to regex
+        :param order_by: order by a key; defaults to '_id'
+        :return: A list of routes as dicts (see below for example data)
+        nh: [{'intf': 'eth0',
+              't': 'C>*'
+            }]
+        pfx: 192.168.1.0/24
+        """
+        r = self._session.get("{}/api/s/{}/stat/routing".format(self._baseurl, self._site, verify=self._verify_ssl), data="json={}")
+        self._current_status_code = r.status_code
+
         if self._current_status_code == 401:
             raise LoggedInException("Invalid login, or login has expired")