Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0262f14a53 | ||
|
|
c4b255d3bf | ||
|
|
13b7debb33 | ||
|
|
a203c4a29f | ||
|
|
d8bac39c52 | ||
|
|
f1c06198b2 | ||
|
|
95b45f507a | ||
|
|
54bfb99d60 | ||
|
|
9dda477e3d | ||
|
|
2ca6b9edda | ||
|
|
b22764614d | ||
|
|
09c168f6e8 | ||
|
|
414eabd3ae | ||
|
|
b536bd7eb5 | ||
|
|
532a8d5071 | ||
|
|
793797e3a7 | ||
|
|
602b6160ab | ||
|
|
aff95ba9e9 | ||
|
|
74aad2af1c | ||
|
|
b96ad8b4e4 | ||
|
|
a8b731fe21 | ||
|
|
147b6143b0 |
+1
-1
@@ -2,7 +2,7 @@ sudo: required
|
||||
matrix:
|
||||
fast_finish: true
|
||||
include:
|
||||
- python: "3.6"
|
||||
- python: "3.5.3"
|
||||
env: TOXENV=lint
|
||||
- python: "3.5.3"
|
||||
env: TOXENV=py35
|
||||
|
||||
+25
@@ -3,6 +3,31 @@ Changelog
|
||||
|
||||
A list of changes between each release
|
||||
|
||||
0.13.0 (2019-03-01)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
**Breaking change:**
|
||||
Wifi status reported in dBm again, instead of bars (which is great). Also, the old `get_camera_info` method has changed and requires a `camera_id` parameter.
|
||||
|
||||
- Adds throttle decorator
|
||||
- Decorate following functions with 4s throttle (call method with `force=True` to override):
|
||||
- request_network_status
|
||||
- request_syncmodule
|
||||
- request_system_arm
|
||||
- request_system_disarm
|
||||
- request_sync_events
|
||||
- request_new_image
|
||||
- request_new_video
|
||||
- request_video_count
|
||||
- request_cameras
|
||||
- request_camera_info
|
||||
- request_camera_sensors
|
||||
- request_motion_detection_enable
|
||||
- request_motion_detection_disable
|
||||
- Use the updated homescreen api endpoint to retrieve camera information. The old method to retrieve all cameras at once seems to not exist, and this was the only solution I could figure out and confirm to work.
|
||||
- Adds throttle decorator to refresh function to prevent too many frequent calls with `force_cache` flag set to `True`. This additional throttle can be overridden with the `force=True` argument passed to the refresh function.
|
||||
- Add ability to cycle through login api endpoints to anticipate future endpoint deprecation
|
||||
|
||||
|
||||
0.12.1 (2019-01-31)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
- Remove logging improvements since they were incompatible with home-assistant logging
|
||||
|
||||
+20
-5
@@ -3,11 +3,13 @@
|
||||
import logging
|
||||
from json import dumps
|
||||
import blinkpy.helpers.errors as ERROR
|
||||
from blinkpy.helpers.util import http_req, get_time, BlinkException
|
||||
from blinkpy.helpers.util import http_req, get_time, BlinkException, Throttle
|
||||
from blinkpy.helpers.constants import DEFAULT_URL
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
MIN_THROTTLE_TIME = 2
|
||||
|
||||
|
||||
def request_login(blink, url, username, password, is_retry=False):
|
||||
"""
|
||||
@@ -38,6 +40,7 @@ def request_networks(blink):
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_network_status(blink, network):
|
||||
"""
|
||||
Request network information.
|
||||
@@ -49,6 +52,7 @@ def request_network_status(blink, network):
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_syncmodule(blink, network):
|
||||
"""
|
||||
Request sync module info.
|
||||
@@ -60,6 +64,7 @@ def request_syncmodule(blink, network):
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_system_arm(blink, network):
|
||||
"""
|
||||
Arm system.
|
||||
@@ -71,6 +76,7 @@ def request_system_arm(blink, network):
|
||||
return http_post(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_system_disarm(blink, network):
|
||||
"""
|
||||
Disarm system.
|
||||
@@ -96,12 +102,15 @@ def request_command_status(blink, network, command_id):
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_homescreen(blink):
|
||||
"""Request homescreen info."""
|
||||
url = "{}/homescreen".format(blink.urls.base_url)
|
||||
url = "{}/api/v3/accounts/{}/homescreen".format(blink.urls.base_url,
|
||||
blink.account_id)
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_sync_events(blink, network):
|
||||
"""
|
||||
Request events from sync module.
|
||||
@@ -113,6 +122,7 @@ def request_sync_events(blink, network):
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_new_image(blink, network, camera_id):
|
||||
"""
|
||||
Request to capture new thumbnail for camera.
|
||||
@@ -127,6 +137,7 @@ def request_new_image(blink, network, camera_id):
|
||||
return http_post(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_new_video(blink, network, camera_id):
|
||||
"""
|
||||
Request to capture new video clip.
|
||||
@@ -141,6 +152,7 @@ def request_new_video(blink, network, camera_id):
|
||||
return http_post(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_video_count(blink):
|
||||
"""Request total video count."""
|
||||
url = "{}/api/v2/videos/count".format(blink.urls.base_url)
|
||||
@@ -161,6 +173,7 @@ def request_videos(blink, time=None, page=0):
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_cameras(blink, network):
|
||||
"""
|
||||
Request all camera information.
|
||||
@@ -180,9 +193,9 @@ def request_camera_info(blink, network, camera_id):
|
||||
:param network: Sync module network id.
|
||||
:param camera_id: Camera ID of camera to request info from.
|
||||
"""
|
||||
url = "{}/network/{}/camera/{}".format(blink.urls.base_url,
|
||||
network,
|
||||
camera_id)
|
||||
url = "{}/network/{}/camera/{}/config".format(blink.urls.base_url,
|
||||
network,
|
||||
camera_id)
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@@ -200,6 +213,7 @@ def request_camera_sensors(blink, network, camera_id):
|
||||
return http_get(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_motion_detection_enable(blink, network, camera_id):
|
||||
"""
|
||||
Enable motion detection for a camera.
|
||||
@@ -214,6 +228,7 @@ def request_motion_detection_enable(blink, network, camera_id):
|
||||
return http_post(blink, url)
|
||||
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def request_motion_detection_disable(blink, network, camera_id):
|
||||
"""Disable motion detection for a camera.
|
||||
|
||||
|
||||
+76
-30
@@ -27,13 +27,17 @@ from blinkpy.sync_module import BlinkSyncModule
|
||||
from blinkpy.helpers import errors as ERROR
|
||||
from blinkpy.helpers.util import (
|
||||
create_session, merge_dicts, get_time, BlinkURLHandler,
|
||||
BlinkAuthenticationException)
|
||||
BlinkAuthenticationException, Throttle)
|
||||
from blinkpy.helpers.constants import (
|
||||
BLINK_URL, LOGIN_URL, LOGIN_BACKUP_URL)
|
||||
BLINK_URL, LOGIN_URL, OLD_LOGIN_URL, LOGIN_BACKUP_URL)
|
||||
from blinkpy.helpers.constants import __version__
|
||||
|
||||
REFRESH_RATE = 30
|
||||
|
||||
# Prevents rapid calls to blink.refresh()
|
||||
# with the force_cache flag set to True
|
||||
MIN_THROTTLE_TIME = 2
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@@ -88,9 +92,16 @@ class Blink():
|
||||
elif not self.get_auth_token():
|
||||
return
|
||||
|
||||
camera_list = self.get_cameras()
|
||||
networks = self.get_ids()
|
||||
for network_name, network_id in networks.items():
|
||||
sync_module = BlinkSyncModule(self, network_name, network_id)
|
||||
if network_id not in camera_list.keys():
|
||||
camera_list[network_id] = {}
|
||||
_LOGGER.warning("No cameras found for %s", network_name)
|
||||
sync_module = BlinkSyncModule(self,
|
||||
network_name,
|
||||
network_id,
|
||||
camera_list[network_id])
|
||||
sync_module.start()
|
||||
self.sync[network_name] = sync_module
|
||||
self.cameras = self.merge_cameras()
|
||||
@@ -112,33 +123,12 @@ class Blink():
|
||||
if not isinstance(self._password, str):
|
||||
raise BlinkAuthenticationException(ERROR.PASSWORD)
|
||||
|
||||
login_url = LOGIN_URL
|
||||
response = api.request_login(self,
|
||||
login_url,
|
||||
self._username,
|
||||
self._password,
|
||||
is_retry=is_retry)
|
||||
try:
|
||||
if response.status_code != 200:
|
||||
_LOGGER.debug("Received response code %s during login.",
|
||||
response.status_code)
|
||||
login_url = LOGIN_BACKUP_URL
|
||||
response = api.request_login(self,
|
||||
login_url,
|
||||
self._username,
|
||||
self._password,
|
||||
is_retry=is_retry)
|
||||
response = response.json()
|
||||
(self.region_id, self.region), = response['region'].items()
|
||||
except AttributeError:
|
||||
_LOGGER.error("Login API endpoint failed with response %s",
|
||||
response,
|
||||
exc_info=True)
|
||||
login_urls = [LOGIN_URL, OLD_LOGIN_URL, LOGIN_BACKUP_URL]
|
||||
|
||||
response = self.login_request(login_urls, is_retry=is_retry)
|
||||
|
||||
if not response:
|
||||
return False
|
||||
except KeyError:
|
||||
_LOGGER.warning("Could not extract region info.")
|
||||
self.region_id = 'piri'
|
||||
self.region = 'UNKNOWN'
|
||||
|
||||
self._host = "{}.{}".format(self.region_id, BLINK_URL)
|
||||
self._token = response['authtoken']['authtoken']
|
||||
@@ -147,10 +137,44 @@ class Blink():
|
||||
self._auth_header = {'Host': self._host,
|
||||
'TOKEN_AUTH': self._token}
|
||||
self.urls = BlinkURLHandler(self.region_id)
|
||||
self._login_url = login_url
|
||||
|
||||
return self._auth_header
|
||||
|
||||
def login_request(self, login_urls, is_retry=False):
|
||||
"""Make a login request."""
|
||||
try:
|
||||
login_url = login_urls.pop(0)
|
||||
except IndexError:
|
||||
_LOGGER.error("Could not login to blink servers.")
|
||||
return False
|
||||
|
||||
_LOGGER.info("Attempting login with %s", login_url)
|
||||
|
||||
response = api.request_login(self,
|
||||
login_url,
|
||||
self._username,
|
||||
self._password,
|
||||
is_retry=is_retry)
|
||||
try:
|
||||
if response.status_code != 200:
|
||||
response = self.login_request(login_urls)
|
||||
response = response.json()
|
||||
(self.region_id, self.region), = response['region'].items()
|
||||
|
||||
except AttributeError:
|
||||
_LOGGER.error("Login API endpoint failed with response %s",
|
||||
response,
|
||||
exc_info=True)
|
||||
return False
|
||||
|
||||
except KeyError:
|
||||
_LOGGER.warning("Could not extract region info.")
|
||||
self.region_id = 'piri'
|
||||
self.region = 'UNKNOWN'
|
||||
|
||||
self._login_url = login_url
|
||||
return response
|
||||
|
||||
def get_ids(self):
|
||||
"""Set the network ID and Account ID."""
|
||||
response = api.request_networks(self)
|
||||
@@ -170,6 +194,26 @@ class Blink():
|
||||
self.network_ids = all_networks
|
||||
return network_dict
|
||||
|
||||
def get_cameras(self):
|
||||
"""Retrieve a camera list for each onboarded network."""
|
||||
response = api.request_homescreen(self)
|
||||
try:
|
||||
all_cameras = {}
|
||||
for camera in response['cameras']:
|
||||
camera_network = str(camera['network_id'])
|
||||
camera_name = camera['name']
|
||||
camera_id = camera['id']
|
||||
camera_info = {'name': camera_name, 'id': camera_id}
|
||||
if camera_network not in all_cameras:
|
||||
all_cameras[camera_network] = []
|
||||
|
||||
all_cameras[camera_network].append(camera_info)
|
||||
return all_cameras
|
||||
except KeyError:
|
||||
_LOGGER.error("Initialization failue. Could not retrieve cameras.")
|
||||
return {}
|
||||
|
||||
@Throttle(seconds=MIN_THROTTLE_TIME)
|
||||
def refresh(self, force_cache=False):
|
||||
"""
|
||||
Perform a system refresh.
|
||||
@@ -183,6 +227,8 @@ class Blink():
|
||||
if not force_cache:
|
||||
# Prevents rapid clearing of motion detect property
|
||||
self.last_refresh = int(time.time())
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_if_ok_to_update(self):
|
||||
"""Check if it is ok to perform an http request."""
|
||||
|
||||
+3
-2
@@ -92,10 +92,11 @@ class BlinkCamera():
|
||||
self.network_id,
|
||||
self.camera_id)
|
||||
|
||||
def update(self, config, force_cache=False):
|
||||
def update(self, config, force_cache=False, **kwargs):
|
||||
"""Update camera info."""
|
||||
# force = kwargs.pop('force', False)
|
||||
self.name = config['name']
|
||||
self.camera_id = str(config['camera_id'])
|
||||
self.camera_id = str(config['id'])
|
||||
self.network_id = str(config['network_id'])
|
||||
self.serial = config['serial']
|
||||
self.motion_enabled = config['enabled']
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
import os
|
||||
|
||||
MAJOR_VERSION = 0
|
||||
MINOR_VERSION = 12
|
||||
PATCH_VERSION = 1
|
||||
MINOR_VERSION = 13
|
||||
PATCH_VERSION = 0
|
||||
|
||||
__version__ = '{}.{}.{}'.format(MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION)
|
||||
|
||||
@@ -47,7 +47,8 @@ URLS
|
||||
BLINK_URL = 'immedia-semi.com'
|
||||
DEFAULT_URL = "{}.{}".format('prod', BLINK_URL)
|
||||
BASE_URL = "https://{}".format(DEFAULT_URL)
|
||||
LOGIN_URL = "{}/login".format(BASE_URL)
|
||||
LOGIN_URL = "{}/api/v2/login".format(BASE_URL)
|
||||
OLD_LOGIN_URL = "{}/login".format(BASE_URL)
|
||||
LOGIN_BACKUP_URL = "https://{}.{}/login".format('rest.piri', BLINK_URL)
|
||||
|
||||
'''
|
||||
|
||||
+31
-2
@@ -2,6 +2,7 @@
|
||||
|
||||
import logging
|
||||
import time
|
||||
from functools import wraps
|
||||
from requests import Request, Session, exceptions
|
||||
from blinkpy.helpers.constants import BLINK_URL, TIMESTAMP_FORMAT
|
||||
import blinkpy.helpers.errors as ERROR
|
||||
@@ -106,8 +107,6 @@ class BlinkException(Exception):
|
||||
class BlinkAuthenticationException(BlinkException):
|
||||
"""Class to throw authentication exception."""
|
||||
|
||||
pass
|
||||
|
||||
|
||||
class BlinkURLHandler():
|
||||
"""Class that handles Blink URLS."""
|
||||
@@ -121,3 +120,33 @@ class BlinkURLHandler():
|
||||
self.networks_url = "{}/networks".format(self.base_url)
|
||||
self.video_url = "{}/api/v2/videos".format(self.base_url)
|
||||
_LOGGER.debug("Setting base url to %s.", self.base_url)
|
||||
|
||||
|
||||
class Throttle():
|
||||
"""Class for throttling api calls."""
|
||||
|
||||
def __init__(self, seconds=10):
|
||||
"""Initialize throttle class."""
|
||||
self.throttle_time = seconds
|
||||
self.last_call = 0
|
||||
|
||||
def __call__(self, method):
|
||||
"""Throttle caller method."""
|
||||
def throttle_method():
|
||||
"""Call when method is throttled."""
|
||||
return None
|
||||
|
||||
@wraps(method)
|
||||
def wrapper(*args, **kwargs):
|
||||
"""Wrap that checks for throttling."""
|
||||
force = kwargs.pop('force', False)
|
||||
now = int(time.time())
|
||||
last_call_delta = now - self.last_call
|
||||
if force or last_call_delta > self.throttle_time:
|
||||
result = method(*args, *kwargs)
|
||||
self.last_call = now
|
||||
return result
|
||||
|
||||
return throttle_method()
|
||||
|
||||
return wrapper
|
||||
|
||||
+36
-22
@@ -13,7 +13,7 @@ _LOGGER = logging.getLogger(__name__)
|
||||
class BlinkSyncModule():
|
||||
"""Class to initialize sync module."""
|
||||
|
||||
def __init__(self, blink, network_name, network_id):
|
||||
def __init__(self, blink, network_name, network_id, camera_list):
|
||||
"""
|
||||
Initialize Blink sync module.
|
||||
|
||||
@@ -30,12 +30,12 @@ class BlinkSyncModule():
|
||||
self.sync_id = None
|
||||
self.host = None
|
||||
self.summary = None
|
||||
self.homescreen = None
|
||||
self.network_info = None
|
||||
self.events = []
|
||||
self.cameras = CaseInsensitiveDict({})
|
||||
self.motion = {}
|
||||
self.last_record = {}
|
||||
self.camera_list = camera_list
|
||||
|
||||
@property
|
||||
def attributes(self):
|
||||
@@ -76,7 +76,9 @@ class BlinkSyncModule():
|
||||
|
||||
def start(self):
|
||||
"""Initialize the system."""
|
||||
response = api.request_syncmodule(self.blink, self.network_id)
|
||||
response = api.request_syncmodule(self.blink,
|
||||
self.network_id,
|
||||
force=True)
|
||||
try:
|
||||
self.summary = response['syncmodule']
|
||||
self.network_id = self.summary['network_id']
|
||||
@@ -94,24 +96,35 @@ class BlinkSyncModule():
|
||||
response,
|
||||
exc_info=True)
|
||||
|
||||
self.events = self.get_events()
|
||||
self.homescreen = api.request_homescreen(self.blink)
|
||||
self.network_info = api.request_network_status(self.blink,
|
||||
self.network_id)
|
||||
|
||||
self.check_new_videos()
|
||||
camera_info = self.get_camera_info()
|
||||
for camera_config in camera_info:
|
||||
name = camera_config['name']
|
||||
self.cameras[name] = BlinkCamera(self)
|
||||
self.motion[name] = False
|
||||
self.cameras[name].update(camera_config, force_cache=True)
|
||||
try:
|
||||
for camera_config in self.camera_list:
|
||||
if 'name' not in camera_config:
|
||||
break
|
||||
name = camera_config['name']
|
||||
self.cameras[name] = BlinkCamera(self)
|
||||
self.motion[name] = False
|
||||
camera_info = self.get_camera_info(camera_config['id'])
|
||||
self.cameras[name].update(camera_info,
|
||||
force_cache=True,
|
||||
force=True)
|
||||
except KeyError:
|
||||
_LOGGER.error("Could not create cameras instances for %s",
|
||||
self.name,
|
||||
exc_info=True)
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
def get_events(self):
|
||||
def get_events(self, **kwargs):
|
||||
"""Retrieve events from server."""
|
||||
response = api.request_sync_events(self.blink, self.network_id)
|
||||
force = kwargs.pop('force', False)
|
||||
response = api.request_sync_events(self.blink,
|
||||
self.network_id,
|
||||
force=force)
|
||||
try:
|
||||
return response['event']
|
||||
except (TypeError, KeyError):
|
||||
@@ -120,11 +133,13 @@ class BlinkSyncModule():
|
||||
exc_info=True)
|
||||
return False
|
||||
|
||||
def get_camera_info(self):
|
||||
def get_camera_info(self, camera_id):
|
||||
"""Retrieve camera information."""
|
||||
response = api.request_cameras(self.blink, self.network_id)
|
||||
response = api.request_camera_info(self.blink,
|
||||
self.network_id,
|
||||
camera_id)
|
||||
try:
|
||||
return response['devicestatus']
|
||||
return response['camera'][0]
|
||||
except (TypeError, KeyError):
|
||||
_LOGGER.error("Could not extract camera info: %s",
|
||||
response,
|
||||
@@ -133,15 +148,14 @@ class BlinkSyncModule():
|
||||
|
||||
def refresh(self, force_cache=False):
|
||||
"""Get all blink cameras and pulls their most recent status."""
|
||||
self.events = self.get_events()
|
||||
self.homescreen = api.request_homescreen(self.blink)
|
||||
self.network_info = api.request_network_status(self.blink,
|
||||
self.network_id)
|
||||
camera_info = self.get_camera_info()
|
||||
self.check_new_videos()
|
||||
for camera_config in camera_info:
|
||||
name = camera_config['name']
|
||||
self.cameras[name].update(camera_config, force_cache=force_cache)
|
||||
for camera_name in self.cameras.keys():
|
||||
camera_id = self.cameras[camera_name].camera_id
|
||||
camera_info = self.get_camera_info(camera_id)
|
||||
self.cameras[camera_name].update(camera_info,
|
||||
force_cache=force_cache)
|
||||
|
||||
def check_new_videos(self):
|
||||
"""Check if new videos since last refresh."""
|
||||
|
||||
@@ -8,6 +8,8 @@ reports=no
|
||||
# too-many-* - are not enforced for the sake of readability
|
||||
# too-few-* - same as too-many-*
|
||||
# no-else-return - I don't see any reason to enforce this. both forms are readable
|
||||
# no-self-use - stupid and only annoying
|
||||
# unexpected-keyword-arg - doesn't allow for use of **kwargs, which is dumb
|
||||
|
||||
disable=
|
||||
locally-disabled,
|
||||
@@ -23,3 +25,5 @@ disable=
|
||||
too-many-lines,
|
||||
too-few-public-methods,
|
||||
no-else-return,
|
||||
no-self-use,
|
||||
unexpected-keyword-arg,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
flake8==3.5.0
|
||||
flake8-docstrings==1.3.0
|
||||
pylint==2.1.1
|
||||
pylint==2.3.0
|
||||
pydocstyle==2.1.1
|
||||
pytest==3.7.1
|
||||
pytest-cov>=2.3.1
|
||||
|
||||
@@ -67,5 +67,3 @@ def mocked_session_send(*args, **kwargs):
|
||||
|
||||
class MockURLHandler(BlinkURLHandler):
|
||||
"""Mocks URL Handler in blinkpy module."""
|
||||
|
||||
pass
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
import unittest
|
||||
from unittest import mock
|
||||
import logging
|
||||
from requests import Request
|
||||
|
||||
from blinkpy import blinkpy
|
||||
from blinkpy.sync_module import BlinkSyncModule
|
||||
@@ -56,31 +55,39 @@ class TestBlinkFunctions(unittest.TestCase):
|
||||
"""Clean up after test."""
|
||||
self.blink = None
|
||||
|
||||
@mock.patch('blinkpy.blinkpy.api.http_req')
|
||||
@mock.patch('blinkpy.blinkpy.api.request_login')
|
||||
def test_backup_url(self, req, mock_sess):
|
||||
"""Test backup login method."""
|
||||
fake_req = Request('POST', 'http://wrong.url').prepare()
|
||||
json_resp = {
|
||||
'authtoken': {'authtoken': 'foobar123'},
|
||||
'networks': {'1234': {'name': 'foobar', 'onboarded': True}}
|
||||
}
|
||||
bad_req = mresp.MockResponse({}, 404)
|
||||
new_req = mresp.MockResponse(json_resp, 200)
|
||||
req.side_effect = [
|
||||
mresp.mocked_session_send(fake_req),
|
||||
bad_req,
|
||||
bad_req,
|
||||
new_req
|
||||
]
|
||||
self.blink.get_auth_token()
|
||||
self.assertEqual(self.blink.region_id, 'piri')
|
||||
self.assertEqual(self.blink.region, 'UNKNOWN')
|
||||
self.blink.login_request(['test1', 'test2', 'test3'])
|
||||
# pylint: disable=protected-access
|
||||
self.assertEqual(self.blink._token, 'foobar123')
|
||||
self.assertEqual(self.blink._login_url, 'test3')
|
||||
|
||||
req.side_effect = [
|
||||
bad_req,
|
||||
new_req,
|
||||
bad_req
|
||||
]
|
||||
self.blink.login_request(['test1', 'test2', 'test3'])
|
||||
# pylint: disable=protected-access
|
||||
self.assertEqual(self.blink._login_url, 'test2')
|
||||
|
||||
def test_merge_cameras(self, mock_sess):
|
||||
"""Test merge camera functionality."""
|
||||
first_dict = {'foo': 'bar', 'test': 123}
|
||||
next_dict = {'foobar': 456, 'bar': 'foo'}
|
||||
self.blink.sync['foo'] = BlinkSyncModule(self.blink, 'foo', 1)
|
||||
self.blink.sync['bar'] = BlinkSyncModule(self.blink, 'bar', 2)
|
||||
self.blink.sync['foo'] = BlinkSyncModule(self.blink, 'foo', 1, [])
|
||||
self.blink.sync['bar'] = BlinkSyncModule(self.blink, 'bar', 2, [])
|
||||
self.blink.sync['foo'].cameras = first_dict
|
||||
self.blink.sync['bar'].cameras = next_dict
|
||||
result = self.blink.merge_cameras()
|
||||
|
||||
+24
-1
@@ -31,7 +31,10 @@ class TestBlinkSetup(unittest.TestCase):
|
||||
self.blink_no_cred = Blink()
|
||||
self.blink = Blink(username=USERNAME,
|
||||
password=PASSWORD)
|
||||
self.blink.sync['test'] = BlinkSyncModule(self.blink, 'test', '1234')
|
||||
self.blink.sync['test'] = BlinkSyncModule(self.blink,
|
||||
'test',
|
||||
'1234',
|
||||
[])
|
||||
self.blink.urls = BlinkURLHandler('test')
|
||||
self.blink.session = create_session()
|
||||
|
||||
@@ -160,3 +163,23 @@ class TestBlinkSetup(unittest.TestCase):
|
||||
"""Check that we appropriately handle unexpected login info."""
|
||||
mock_login.return_value = None
|
||||
self.assertFalse(self.blink.get_auth_token())
|
||||
|
||||
@mock.patch('blinkpy.api.request_homescreen')
|
||||
def test_get_cameras(self, mock_home, mock_sess):
|
||||
"""Check retrieval of camera information."""
|
||||
mock_home.return_value = {
|
||||
'cameras': [{'name': 'foo', 'network_id': 1234, 'id': 5678},
|
||||
{'name': 'bar', 'network_id': 1234, 'id': 5679},
|
||||
{'name': 'test', 'network_id': 4321, 'id': 0000}]
|
||||
}
|
||||
result = self.blink.get_cameras()
|
||||
self.assertEqual(result, {'1234': [{'name': 'foo', 'id': 5678},
|
||||
{'name': 'bar', 'id': 5679}],
|
||||
'4321': [{'name': 'test', 'id': 0000}]})
|
||||
|
||||
@mock.patch('blinkpy.api.request_homescreen')
|
||||
def test_get_cameras_failure(self, mock_home, mock_sess):
|
||||
"""Check that on failure we initialize empty info and move on."""
|
||||
mock_home.return_value = {}
|
||||
result = self.blink.get_cameras()
|
||||
self.assertEqual(result, {})
|
||||
|
||||
@@ -46,7 +46,7 @@ class TestBlinkCameraSetup(unittest.TestCase):
|
||||
self.blink._auth_header = header
|
||||
self.blink.session = create_session()
|
||||
self.blink.urls = BlinkURLHandler('test')
|
||||
self.blink.sync['test'] = BlinkSyncModule(self.blink, 'test', 1234)
|
||||
self.blink.sync['test'] = BlinkSyncModule(self.blink, 'test', 1234, [])
|
||||
self.camera = BlinkCamera(self.blink.sync['test'])
|
||||
self.camera.name = 'foobar'
|
||||
self.blink.sync['test'].cameras['foobar'] = self.camera
|
||||
@@ -59,7 +59,7 @@ class TestBlinkCameraSetup(unittest.TestCase):
|
||||
"""Test that we can properly update camera properties."""
|
||||
config = {
|
||||
'name': 'new',
|
||||
'camera_id': 1234,
|
||||
'id': 1234,
|
||||
'network_id': 5678,
|
||||
'serial': '12345678',
|
||||
'enabled': False,
|
||||
@@ -115,7 +115,7 @@ class TestBlinkCameraSetup(unittest.TestCase):
|
||||
}
|
||||
config = {
|
||||
'name': 'new',
|
||||
'camera_id': 1234,
|
||||
'id': 1234,
|
||||
'network_id': 5678,
|
||||
'serial': '12345678',
|
||||
'enabled': False,
|
||||
@@ -144,7 +144,7 @@ class TestBlinkCameraSetup(unittest.TestCase):
|
||||
self.camera.last_record = ['1']
|
||||
config = {
|
||||
'name': 'new',
|
||||
'camera_id': 1234,
|
||||
'id': 1234,
|
||||
'network_id': 5678,
|
||||
'serial': '12345678',
|
||||
'enabled': False,
|
||||
@@ -159,7 +159,7 @@ class TestBlinkCameraSetup(unittest.TestCase):
|
||||
}
|
||||
self.assertEqual(self.camera.temperature_calibrated, None)
|
||||
with self.assertLogs() as logrecord:
|
||||
self.camera.update(config)
|
||||
self.camera.update(config, force=True)
|
||||
self.assertEqual(self.camera.thumbnail, None)
|
||||
self.assertEqual(self.camera.last_record, ['1'])
|
||||
self.assertEqual(self.camera.temperature_calibrated, 68)
|
||||
@@ -176,7 +176,7 @@ class TestBlinkCameraSetup(unittest.TestCase):
|
||||
mock_sess.return_value = 'foobar'
|
||||
config = {
|
||||
'name': 'new',
|
||||
'camera_id': 1234,
|
||||
'id': 1234,
|
||||
'network_id': 5678,
|
||||
'serial': '12345678',
|
||||
'enabled': False,
|
||||
|
||||
@@ -24,7 +24,10 @@ class TestBlinkSyncModule(unittest.TestCase):
|
||||
'TOKEN_AUTH': 'foobar123'
|
||||
}
|
||||
self.blink.urls = blinkpy.BlinkURLHandler('test')
|
||||
self.blink.sync['test'] = BlinkSyncModule(self.blink, 'test', '1234')
|
||||
self.blink.sync['test'] = BlinkSyncModule(self.blink,
|
||||
'test',
|
||||
'1234',
|
||||
[])
|
||||
self.camera = BlinkCamera(self.blink.sync)
|
||||
self.mock_start = [
|
||||
{'syncmodule': {
|
||||
@@ -52,8 +55,9 @@ class TestBlinkSyncModule(unittest.TestCase):
|
||||
|
||||
def test_get_camera_info(self, mock_resp):
|
||||
"""Test get camera info function."""
|
||||
mock_resp.return_value = {'devicestatus': True}
|
||||
self.assertEqual(self.blink.sync['test'].get_camera_info(), True)
|
||||
mock_resp.return_value = {'camera': ['foobar']}
|
||||
self.assertEqual(self.blink.sync['test'].get_camera_info('1234'),
|
||||
'foobar')
|
||||
|
||||
def test_check_new_videos(self, mock_resp):
|
||||
"""Test recent video response."""
|
||||
@@ -126,20 +130,6 @@ class TestBlinkSyncModule(unittest.TestCase):
|
||||
self.blink.sync['test'].start()
|
||||
self.assertEqual(self.blink.sync['test'].network_id, 8675309)
|
||||
|
||||
def test_unexpected_events(self, mock_resp):
|
||||
"""Test unexpected events response."""
|
||||
self.mock_start[1] = None
|
||||
mock_resp.side_effect = self.mock_start
|
||||
self.blink.sync['test'].start()
|
||||
self.assertEqual(self.blink.sync['test'].events, False)
|
||||
|
||||
def test_missing_events(self, mock_resp):
|
||||
"""Test missing events key from response."""
|
||||
self.mock_start[1] = {}
|
||||
mock_resp.side_effect = self.mock_start
|
||||
self.blink.sync['test'].start()
|
||||
self.assertEqual(self.blink.sync['test'].events, False)
|
||||
|
||||
def test_unexpected_camera_info(self, mock_resp):
|
||||
"""Test unexpected camera info response."""
|
||||
self.blink.sync['test'].cameras['foo'] = None
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
"""Test various api functions."""
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
import time
|
||||
from blinkpy.helpers.util import Throttle
|
||||
|
||||
|
||||
class TestUtil(unittest.TestCase):
|
||||
"""Test the helpers/util module."""
|
||||
|
||||
def setUp(self):
|
||||
"""Initialize the blink module."""
|
||||
|
||||
def tearDown(self):
|
||||
"""Tear down blink module."""
|
||||
|
||||
def test_throttle(self):
|
||||
"""Test the throttle decorator."""
|
||||
calls = []
|
||||
|
||||
@Throttle(seconds=5)
|
||||
def test_throttle():
|
||||
calls.append(1)
|
||||
|
||||
now = int(time.time())
|
||||
now_plus_four = now + 4
|
||||
now_plus_six = now + 6
|
||||
|
||||
test_throttle()
|
||||
self.assertEqual(1, len(calls))
|
||||
|
||||
# Call again, still shouldn't fire
|
||||
test_throttle()
|
||||
self.assertEqual(1, len(calls))
|
||||
|
||||
# Call with force
|
||||
test_throttle(force=True)
|
||||
self.assertEqual(2, len(calls))
|
||||
|
||||
# Call without throttle, shouldn't fire
|
||||
test_throttle()
|
||||
self.assertEqual(2, len(calls))
|
||||
|
||||
# Fake time as 4 seconds from now
|
||||
with mock.patch('time.time', return_value=now_plus_four):
|
||||
test_throttle()
|
||||
self.assertEqual(2, len(calls))
|
||||
|
||||
# Fake time as 6 seconds from now
|
||||
with mock.patch('time.time', return_value=now_plus_six):
|
||||
test_throttle()
|
||||
self.assertEqual(3, len(calls))
|
||||
|
||||
def test_throttle_per_instance(self):
|
||||
"""Test that throttle is done once per instance of class."""
|
||||
class Tester:
|
||||
"""A tester class for throttling."""
|
||||
|
||||
def test(self):
|
||||
"""Test the throttle."""
|
||||
return True
|
||||
|
||||
tester = Tester()
|
||||
throttled = Throttle(seconds=1)(tester.test)
|
||||
self.assertEqual(throttled(), True)
|
||||
self.assertEqual(throttled(), None)
|
||||
|
||||
def test_throttle_on_two_methods(self):
|
||||
"""Test that throttle works for multiple methods."""
|
||||
class Tester:
|
||||
"""A tester class for throttling."""
|
||||
|
||||
@Throttle(seconds=3)
|
||||
def test1(self):
|
||||
"""Test function for throttle."""
|
||||
return True
|
||||
|
||||
@Throttle(seconds=5)
|
||||
def test2(self):
|
||||
"""Test function for throttle."""
|
||||
return True
|
||||
|
||||
tester = Tester()
|
||||
now = time.time()
|
||||
now_plus_4 = now + 4
|
||||
now_plus_6 = now + 6
|
||||
|
||||
self.assertEqual(tester.test1(), True)
|
||||
self.assertEqual(tester.test2(), True)
|
||||
self.assertEqual(tester.test1(), None)
|
||||
self.assertEqual(tester.test2(), None)
|
||||
|
||||
with mock.patch('time.time', return_value=now_plus_4):
|
||||
self.assertEqual(tester.test1(), True)
|
||||
self.assertEqual(tester.test2(), None)
|
||||
|
||||
with mock.patch('time.time', return_value=now_plus_6):
|
||||
self.assertEqual(tester.test1(), None)
|
||||
self.assertEqual(tester.test2(), True)
|
||||
Reference in New Issue
Block a user