Merge pull request #432 from fronzbot/add-reauth-back

Add reauth param back into login

.github/stale.yml

@@ -1,5 +1,5 @@
 # Number of days of inactivity before an issue becomes stale
-daysUntilStale: 60
+daysUntilStale: 30
 
 # Number of days of inactivity before a stale issue is closed
 daysUntilClose: 7
@@ -8,7 +8,8 @@ daysUntilClose: 7
 exemptLabels:
   - Priority
   - bug
-  - Help Wanted
+  - help wanted
+  - feature request
 
 # Set to true to ignore issues in a project (defaults to false)
 exemptProjects: true

.github/workflows/coverage.yml

@@ -33,8 +33,9 @@ jobs:
       run: |
         tox -r -e cov
     - name: Codecov
-      uses: codecov/codecov-action@v1.0.6
+      uses: codecov/codecov-action@v1
       with:
+        token: ${{ secrets.CODECOV_TOKEN }}
         flags: unittests
         file: ./coverage.xml
         name: blinkpy

.github/workflows/lint.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.8]
+        python-version: [3.9]
 
     steps:
     - uses: actions/checkout@v2

.github/workflows/publish.yml

@@ -17,7 +17,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v1
       with:
-        python-version: '3.7'
+        python-version: '3.8'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.github/workflows/tests.yml

@@ -10,11 +10,11 @@ jobs:
   build:
     runs-on: ${{ matrix.platform }}
     strategy:
-      max-parallel: 3
+      max-parallel: 4
       matrix:
         platform:
           - ubuntu-latest
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
 
     steps:
     - uses: actions/checkout@v2

.gitignore

@@ -14,3 +14,4 @@ build/*
 docs/_build
 *.log
 venv
+.session*

.gitlab-ci.yml

@@ -1,25 +0,0 @@
-image: python
-
-stages:
-    - test
-
-before_script:
-    - curl -O https://bootstrap.pypa.io/get-pip.py
-    - python get-pip.py
-    - pip install tox
-
-python35:
-    image: python:3.5
-    stage: test
-    script: tox -e py35
-           
-python36:
-    image: python:3.6
-    stage: test
-    script: tox -e py36
-
-lint:
-    image: python:3.6
-    stage: test
-    script: tox -e lint
-

.pre-commit-config.yaml

@@ -8,12 +8,12 @@ repos:
           - --quiet
         files: ^((blinkpy|tests)/.+)?[^/]+\.py$
   - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.2
+    rev: 3.8.3
     hooks:
       - id: flake8
         additional_dependencies:
           - flake8-docstrings==1.5.0
-          - pydocstyle==5.0.2
+          - pydocstyle==5.1.1
         files: ^(blinkpy|tests)/.+\.py$
   - repo: https://github.com/Lucas-C/pre-commit-hooks-markup
     rev: v1.0.0

CHANGES.rst

@@ -4,6 +4,81 @@ Changelog
 
 A list of changes between each release
 
+0.16.4 (2020-11-22)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Bugfixes:**
+
+- Updated liveview endpoint (`#389 <https://github.com/fronzbot/blinkpy/pull/389>`__)
+- Fixed mini thumbnail not updating (`#388 <https://github.com/fronzbot/blinkpy/pull/388>`__)
+- Add exception catch to prevent NoneType error on refresh, added test to check behavior as well (`#401 <https://github.com/fronzbot/blinkpy/pull/401>`__)
+  - Unrelated: had to add two force methods to refresh for testing purposes. Should not change normal usage.
+- Fix malformed stream url (`#395 <https://github.com/fronzbot/blinkpy/pull/395>`__)
+
+**All:**
+
+- Moved testtools to requirements_test.txt (`#387 <https://github.com/fronzbot/blinkpy/pull/387>`__)
+- Bumped pytest to 6.1.1
+- Bumped flake8 to 3.8.4
+- Fixed README spelling ((`#381 <https://github.com/fronzbot/blinkpy/pull/381>`__) via @rohitsud)
+- Bumped pygments to 2.7.1
+- Bumped coverage to 5.3
+- Bumped pydocstyle to 5.1.1
+- Bumped pre-commit to 2.7.1
+- Bumped pylint to 2.6.0
+- Bumped pytest-cov to 2.10.1
+
+
+0.16.3 (2020-08-02)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Add user-agent to all headers
+
+0.16.2 (2020-08-01)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Add user-agent to header at login
+- Remove extra data parameters at login (not-needed)
+- Bump pytest to 6.0.1
+
+
+0.16.1 (2020-07-29)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Unpin requirements, set minimum version instead
+- Bump coverage to 5.2.1
+- Bump pytest to 6.0.0
+
+
+0.16.0 (2020-07-20)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Breaking Changes:**
+
+- Add arm property to camera, deprecate motion enable method (`#273 <https://github.com/fronzbot/blinkpy/pull/273>`__)
+- Complete refactoring of auth logic (breaks all pre-0.16.0 setups!) (`#261 <https://github.com/fronzbot/blinkpy/pull/261>`__)
+
+**New Features:**
+
+- Add is_errored property to Auth class (`#275 <https://github.com/fronzbot/blinkpy/pull/275>`__)
+- Add new endpoint to get user infor (`#280 <https://github.com/fronzbot/blinkpy/pull/280>`__)
+- Add get_liveview command to camera module (`#289 <https://github.com/fronzbot/blinkpy/pull/289>`__)
+- Add blink Mini Camera support (`#290 <https://github.com/fronzbot/blinkpy/pull/290>`__)
+- Add option to skip homescreen check (`#305 <https://github.com/fronzbot/blinkpy/pull/305>`__)
+- Add different timeout for video and image retrieval (`#323 <https://github.com/fronzbot/blinkpy/pull/323>`__)
+- Modifiy session to use HTTPAdapter and handle retries (`#324 <https://github.com/fronzbot/blinkpy/pull/324>`__)
+- Add retry option overrides (`#339 <https://github.com/fronzbot/blinkpy/pull/339>`__)
+
+**All changes:**
+
+Please see the change list in the (`Release Notes <https://github.com/fronzbot/releases/tag/v0.16.0>`__)
+
+
+0.15.1 (2020-07-11)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- Bugfix: remove "Host" from auth header (`#330 <https://github.com/fronzbot/blinkpy/pull/330>`__)
+
+
 0.15.0 (2020-05-08)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 **Breaking Changes:**

README.rst

@@ -174,7 +174,7 @@ Similar methods exist for individual cameras:
 
 Download videos
 ----------------
-You can also use this library to download all videos from the server.  In order to do this, you must specify a ``path``.  You may also specifiy a how far back in time to go to retrieve videos via the ``since=`` variable (a simple string such as ``"2017/09/21"`` is sufficient), as well as how many pages to traverse via the ``page=`` variable.  Note that by default, the library will search the first ten pages which is sufficient in most use cases.  Additionally, you can specidy one or more cameras via the ``camera=`` property.  This can be a single string indicating the name of the camera, or a list of camera names.  By default, it is set to the string ``'all'`` to grab videos from all cameras.
+You can also use this library to download all videos from the server.  In order to do this, you must specify a ``path``.  You may also specifiy a how far back in time to go to retrieve videos via the ``since=`` variable (a simple string such as ``"2017/09/21"`` is sufficient), as well as how many pages to traverse via the ``stop=`` variable.  Note that by default, the library will search the first ten pages which is sufficient in most use cases.  Additionally, you can specify one or more cameras via the ``camera=`` property.  This can be a single string indicating the name of the camera, or a list of camera names.  By default, it is set to the string ``'all'`` to grab videos from all cameras.
 
 Example usage, which downloads all videos recorded since July 4th, 2018 at 9:34am to the ``/home/blink`` directory:
 

blinkpy/api.py

@@ -3,7 +3,7 @@
 import logging
 from json import dumps
 from blinkpy.helpers.util import get_time, Throttle
-from blinkpy.helpers.constants import DEFAULT_URL
+from blinkpy.helpers.constants import DEFAULT_URL, TIMEOUT, DEFAULT_USER_AGENT
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -20,21 +20,22 @@ def request_login(
     :param url: Login url.
     :login_data: Dictionary containing blink login data.
     """
-    headers = {"Host": DEFAULT_URL, "Content-Type": "application/json"}
+    headers = {
+        "Host": DEFAULT_URL,
+        "Content-Type": "application/json",
+        "user-agent": DEFAULT_USER_AGENT,
+    }
     data = dumps(
         {
             "email": login_data["username"],
             "password": login_data["password"],
-            "notification_key": login_data["notification_key"],
             "unique_id": login_data["uid"],
-            "app_version": "6.0.7 (520300) #afb0be72a",
             "device_identifier": login_data["device_id"],
             "client_name": "Computer",
-            "client_type": "android",
-            "os_version": "5.1.1",
-            "reauth": "false",
+            "reauth": True,
         }
     )
+
     return auth.query(
         url=url,
         headers=headers,
@@ -54,6 +55,12 @@ def request_verify(auth, blink, verify_key):
     )
 
 
+def request_logout(blink):
+    """Logout of blink servers."""
+    url = f"{blink.urls.base_url}/api/v4/account/{blink.account_id}/client/{blink.client_id}/logout"
+    return http_post(blink, url=url)
+
+
 def request_networks(blink):
     """Request all networks information."""
     url = f"{blink.urls.base_url}/networks"
@@ -241,9 +248,7 @@ def request_camera_liveview(blink, network, camera_id):
     :param network: Sync module network id.
     :param camera_id: Camera ID of camera to request liveview from.
     """
-    url = (
-        f"{blink.urls.base_url}/api/v3/networks/{network}/cameras/{camera_id}/liveview"
-    )
+    url = f"{blink.urls.base_url}/api/v5/accounts/{blink.account_id}/networks/{network}/cameras/{camera_id}/liveview"
     return http_post(blink, url)
 
 
@@ -284,7 +289,7 @@ def request_motion_detection_disable(blink, network, camera_id):
     return http_post(blink, url)
 
 
-def http_get(blink, url, stream=False, json=True, is_retry=False):
+def http_get(blink, url, stream=False, json=True, is_retry=False, timeout=TIMEOUT):
     """
     Perform an http get request.
 
@@ -304,7 +309,7 @@ def http_get(blink, url, stream=False, json=True, is_retry=False):
     )
 
 
-def http_post(blink, url, is_retry=False):
+def http_post(blink, url, is_retry=False, timeout=TIMEOUT):
     """
     Perform an http post request.
 

blinkpy/auth.py

@@ -2,9 +2,16 @@
 import logging
 from functools import partial
 from requests import Request, Session, exceptions
+from requests.adapters import HTTPAdapter
+from urllib3.util.retry import Retry
 from blinkpy import api
 from blinkpy.helpers import util
-from blinkpy.helpers.constants import BLINK_URL, LOGIN_ENDPOINT
+from blinkpy.helpers.constants import (
+    BLINK_URL,
+    DEFAULT_USER_AGENT,
+    LOGIN_ENDPOINT,
+    TIMEOUT,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -12,7 +19,7 @@ _LOGGER = logging.getLogger(__name__)
 class Auth:
     """Class to handle login communication."""
 
-    def __init__(self, login_data=None, no_prompt=False, login_method="v4"):
+    def __init__(self, login_data=None, no_prompt=False):
         """
         Initialize auth handler.
 
@@ -22,7 +29,6 @@ class Auth:
                              - password
         :param no_prompt: Should any user input prompts
                           be supressed? True/FALSE
-        :param login_method: Choose the login endpoint to use. Default: v4.  v3 uses email verification rather than a 2FA code.
         """
         if login_data is None:
             login_data = {}
@@ -32,7 +38,6 @@ class Auth:
         self.region_id = login_data.get("region_id", None)
         self.client_id = login_data.get("client_id", None)
         self.account_id = login_data.get("account_id", None)
-        self.login_method = login_method
         self.login_response = None
         self.is_errored = False
         self.no_prompt = no_prompt
@@ -53,19 +58,31 @@ class Auth:
         """Return authorization header."""
         if self.token is None:
             return None
-        return {"Host": self.host, "TOKEN_AUTH": self.token}
+        return {
+            "TOKEN_AUTH": self.token,
+            "user-agent": DEFAULT_USER_AGENT,
+            "content-type": "application/json",
+        }
 
-    @property
-    def login_url(self):
-        """Return login url."""
-        if self.login_method not in LOGIN_ENDPOINT:
-            return LOGIN_ENDPOINT["v4"]
-        return LOGIN_ENDPOINT[self.login_method]
-
-    def create_session(self):
+    def create_session(self, opts=None):
         """Create a session for blink communication."""
+        if opts is None:
+            opts = {}
+        backoff = opts.get("backoff", 1)
+        retries = opts.get("retries", 3)
+        retry_list = opts.get("retry_list", [429, 500, 502, 503, 504])
         sess = Session()
-        sess.get = partial(sess.get, timeout=10)
+        assert_status_hook = [
+            lambda response, *args, **kwargs: response.raise_for_status()
+        ]
+        sess.hooks["response"] = assert_status_hook
+        retry = Retry(
+            total=retries, backoff_factor=backoff, status_forcelist=retry_list
+        )
+        adapter = HTTPAdapter(max_retries=retry)
+        sess.mount("https://", adapter)
+        sess.mount("http://", adapter)
+        sess.get = partial(sess.get, timeout=TIMEOUT)
         return sess
 
     def prepare_request(self, url, headers, data, reqtype):
@@ -82,17 +99,21 @@ class Auth:
 
         self.data = util.validate_login_data(self.data)
 
-    def login(self):
+    def login(self, login_url=LOGIN_ENDPOINT):
         """Attempt login to blink servers."""
         self.validate_login()
-        _LOGGER.info("Attempting login with %s", self.login_url)
-        response = api.request_login(self, self.login_url, self.data, is_retry=False,)
+        _LOGGER.info("Attempting login with %s", login_url)
+        response = api.request_login(self, login_url, self.data, is_retry=False,)
         try:
             if response.status_code == 200:
                 return response.json()
             raise LoginError
-        except AttributeError:
-            raise LoginError
+        except AttributeError as error:
+            raise LoginError from error
+
+    def logout(self, blink):
+        """Log out."""
+        return api.request_logout(blink)
 
     def refresh_token(self):
         """Refresh auth token."""
@@ -100,20 +121,24 @@ class Auth:
         try:
             _LOGGER.info("Token expired, attempting automatic refresh.")
             self.login_response = self.login()
-            self.region_id = self.login_response["region"]["tier"]
-            self.host = f"{self.region_id}.{BLINK_URL}"
-            self.token = self.login_response["authtoken"]["authtoken"]
-            self.client_id = self.login_response["client"]["id"]
-            self.account_id = self.login_response["account"]["id"]
+            self.extract_login_info()
             self.is_errored = False
-        except LoginError:
+        except LoginError as error:
             _LOGGER.error("Login endpoint failed. Try again later.")
-            raise TokenRefreshFailed
-        except (TypeError, KeyError):
+            raise TokenRefreshFailed from error
+        except (TypeError, KeyError) as error:
             _LOGGER.error("Malformed login response: %s", self.login_response)
-            raise TokenRefreshFailed
+            raise TokenRefreshFailed from error
         return True
 
+    def extract_login_info(self):
+        """Extract login info from login response."""
+        self.region_id = self.login_response["account"]["tier"]
+        self.host = f"{self.region_id}.{BLINK_URL}"
+        self.token = self.login_response["auth"]["token"]
+        self.client_id = self.login_response["account"]["client_id"]
+        self.account_id = self.login_response["account"]["account_id"]
+
     def startup(self):
         """Initialize tokens for communication."""
         self.validate_login()
@@ -134,8 +159,8 @@ class Auth:
             json_data = response.json()
         except KeyError:
             pass
-        except (AttributeError, ValueError):
-            raise BlinkBadResponse
+        except (AttributeError, ValueError) as error:
+            raise BlinkBadResponse from error
 
         self.is_errored = False
         return json_data
@@ -149,6 +174,7 @@ class Auth:
         stream=False,
         json_resp=True,
         is_retry=False,
+        timeout=TIMEOUT,
     ):
         """
         Perform server requests.
@@ -163,21 +189,25 @@ class Auth:
         """
         req = self.prepare_request(url, headers, data, reqtype)
         try:
-            response = self.session.send(req, stream=stream)
+            response = self.session.send(req, stream=stream, timeout=timeout)
             return self.validate_response(response, json_resp)
         except (exceptions.ConnectionError, exceptions.Timeout):
             _LOGGER.error(
-                "Connection error. Endpoint %s possibly down or throttled. %s: %s",
-                url,
-                response.status_code,
-                response.reason,
+                "Connection error. Endpoint %s possibly down or throttled.", url,
             )
         except BlinkBadResponse:
+            code = None
+            reason = None
+            try:
+                code = response.status_code
+                reason = response.reason
+            except AttributeError:
+                pass
             _LOGGER.error(
                 "Expected json response from %s, but received: %s: %s",
                 url,
-                response.status_code,
-                response.reason,
+                code,
+                reason,
             )
         except UnauthorizedError:
             try:
@@ -191,6 +221,7 @@ class Auth:
                         stream=stream,
                         json_resp=json_resp,
                         is_retry=True,
+                        timeout=timeout,
                     )
                 _LOGGER.error("Unable to access %s after token refresh.", url)
             except TokenRefreshFailed:
@@ -204,6 +235,9 @@ class Auth:
             try:
                 json_resp = response.json()
                 blink.available = json_resp["valid"]
+                if not json_resp["valid"]:
+                    _LOGGER.error("%s", json_resp["message"])
+                    return False
             except (KeyError, TypeError):
                 _LOGGER.error("Did not receive valid response from server.")
                 return False
@@ -212,7 +246,7 @@ class Auth:
     def check_key_required(self):
         """Check if 2FA key is required."""
         try:
-            if self.login_response["client"]["verification_required"]:
+            if self.login_response["account"]["client_verification_required"]:
                 return True
         except (KeyError, TypeError):
             pass

blinkpy/blinkpy.py

@@ -29,6 +29,7 @@ from blinkpy.helpers.constants import (
     DEFAULT_MOTION_INTERVAL,
     DEFAULT_REFRESH,
     MIN_THROTTLE_TIME,
+    TIMEOUT_MEDIA,
 )
 from blinkpy.helpers.constants import __version__
 from blinkpy.auth import Auth, TokenRefreshFailed, LoginError
@@ -75,20 +76,22 @@ class Blink:
         self.no_owls = no_owls
 
     @util.Throttle(seconds=MIN_THROTTLE_TIME)
-    def refresh(self, force=False):
+    def refresh(self, force=False, force_cache=False):
         """
         Perform a system refresh.
 
-        :param force: Force an update of the camera data
+        :param force: Used to override throttle, resets refresh
+        :param force_cache: Used to force update without overriding throttle
         """
-        if self.check_if_ok_to_update() or force:
+        if self.check_if_ok_to_update() or force or force_cache:
             if not self.available:
                 self.setup_post_verify()
 
+            self.get_homescreen()
             for sync_name, sync_module in self.sync.items():
                 _LOGGER.debug("Attempting refresh of sync %s", sync_name)
-                sync_module.refresh(force_cache=force)
-            if not force:
+                sync_module.refresh(force_cache=(force or force_cache))
+            if not force_cache:
                 # Prevents rapid clearing of motion detect property
                 self.last_refresh = int(time.time())
             return True
@@ -330,7 +333,13 @@ class Blink:
                     _LOGGER.info("%s already exists, skipping...", filename)
                     continue
 
-                response = api.http_get(self, url=clip_address, stream=True, json=False)
+                response = api.http_get(
+                    self,
+                    url=clip_address,
+                    stream=True,
+                    json=False,
+                    timeout=TIMEOUT_MEDIA,
+                )
                 with open(filename, "wb") as vidfile:
                     copyfileobj(response.raw, vidfile)
 

blinkpy/camera.py

@@ -3,6 +3,7 @@
 from shutil import copyfileobj
 import logging
 from blinkpy import api
+from blinkpy.helpers.constants import TIMEOUT_MEDIA
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -97,6 +98,19 @@ class BlinkCamera:
             self.sync.blink, self.network_id, self.camera_id
         )
 
+    def record(self):
+        """Initiate clip recording."""
+        return api.request_new_video(self.sync.blink, self.network_id, self.camera_id)
+
+    def get_media(self, media_type="image"):
+        """Download media (image or video)."""
+        url = self.thumbnail
+        if media_type.lower() == "video":
+            url = self.clip
+        return api.http_get(
+            self.sync.blink, url=url, stream=True, json=False, timeout=TIMEOUT_MEDIA,
+        )
+
     def snap_picture(self):
         """Take a picture with camera to create a new thumbnail."""
         return api.request_new_image(self.sync.blink, self.network_id, self.camera_id)
@@ -150,9 +164,7 @@ class BlinkCamera:
         if config.get("thumbnail", False):
             thumb_addr = config["thumbnail"]
         else:
-            _LOGGER.warning(
-                "Could not find thumbnail for camera %s", self.name, exc_info=True
-            )
+            _LOGGER.warning("Could not find thumbnail for camera %s", self.name)
 
         if thumb_addr is not None:
             new_thumbnail = f"{self.sync.urls.base_url}{thumb_addr}.jpg"
@@ -181,13 +193,10 @@ class BlinkCamera:
             update_cached_video = True
 
         if new_thumbnail is not None and (update_cached_image or force_cache):
-            self._cached_image = api.http_get(
-                self.sync.blink, url=self.thumbnail, stream=True, json=False
-            )
+            self._cached_image = self.get_media()
+
         if clip_addr is not None and (update_cached_video or force_cache):
-            self._cached_video = api.http_get(
-                self.sync.blink, url=self.clip, stream=True, json=False
-            )
+            self._cached_video = self.get_media(media_type="video")
 
     def get_liveview(self):
         """Get livewview rtsps link."""
@@ -203,7 +212,7 @@ class BlinkCamera:
         :param path: Path to write file
         """
         _LOGGER.debug("Writing image from %s to %s", self.name, path)
-        response = self._cached_image
+        response = self.get_media()
         if response.status_code == 200:
             with open(path, "wb") as imgfile:
                 copyfileobj(response.raw, imgfile)
@@ -219,7 +228,7 @@ class BlinkCamera:
         :param path: Path to write file
         """
         _LOGGER.debug("Writing video from %s to %s", self.name, path)
-        response = self._cached_video
+        response = self.get_media(media_type="video")
         if response is None:
             _LOGGER.error("No saved video exist for %s.", self.name)
             return
@@ -261,6 +270,6 @@ class BlinkCameraMini(BlinkCamera):
         response = api.http_post(self.sync.blink, url)
         server = response["server"]
         server_split = server.split(":")
-        server_split[0] = "rtsps"
+        server_split[0] = "rtsps:"
         link = "".join(server_split)
         return link

blinkpy/helpers/constants.py

@@ -3,8 +3,8 @@
 import os
 
 MAJOR_VERSION = 0
-MINOR_VERSION = 16
-PATCH_VERSION = "0-rc10"
+MINOR_VERSION = 17
+PATCH_VERSION = "0.rc1"
 
 __version__ = f"{MAJOR_VERSION}.{MINOR_VERSION}.{PATCH_VERSION}"
 
@@ -34,6 +34,7 @@ PROJECT_CLASSIFIERS = [
     "Programming Language :: Python :: 3.6",
     "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
     "Topic :: Home Automation",
 ]
 
@@ -48,10 +49,7 @@ URLS
 BLINK_URL = "immedia-semi.com"
 DEFAULT_URL = f"rest-prod.{BLINK_URL}"
 BASE_URL = f"https://{DEFAULT_URL}"
-LOGIN_ENDPOINT = {
-    "v4": f"{BASE_URL}/api/v4/account/login",
-    "v3": f"{BASE_URL}/api/v3/login",
-}
+LOGIN_ENDPOINT = f"{BASE_URL}/api/v5/account/login"
 
 """
 Dictionaries
@@ -61,6 +59,7 @@ ONLINE = {"online": True, "offline": False}
 """
 OTHER
 """
+DEFAULT_USER_AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
 DEVICE_ID = "Blinkpy"
 TIMESTAMP_FORMAT = "%Y-%m-%dT%H:%M:%S%z"
 DEFAULT_MOTION_INTERVAL = 1
@@ -68,3 +67,5 @@ DEFAULT_REFRESH = 30
 MIN_THROTTLE_TIME = 2
 SIZE_NOTIFICATION_KEY = 152
 SIZE_UID = 16
+TIMEOUT = 10
+TIMEOUT_MEDIA = 90

blinkpy/helpers/util.py

@@ -33,10 +33,13 @@ def json_save(data, file_name):
         json.dump(data, json_file, indent=4)
 
 
-def gen_uid(size):
+def gen_uid(size, uid_format=False):
     """Create a random sring."""
-    full_token = secrets.token_hex(size)
-    return full_token[0:size]
+    if uid_format:
+        token = f"BlinkCamera_{secrets.token_hex(4)}-{secrets.token_hex(2)}-{secrets.token_hex(2)}-{secrets.token_hex(2)}-{secrets.token_hex(6)}"
+    else:
+        token = secrets.token_hex(size)
+    return token
 
 
 def time_to_seconds(timestamp):
@@ -79,10 +82,7 @@ def prompt_login_data(data):
 
 def validate_login_data(data):
     """Check for missing keys."""
-    data["uid"] = data.get("uid", gen_uid(const.SIZE_UID))
-    data["notification_key"] = data.get(
-        "notification_key", gen_uid(const.SIZE_NOTIFICATION_KEY)
-    )
+    data["uid"] = data.get("uid", gen_uid(const.SIZE_UID, uid_format=True))
     data["device_id"] = data.get("device_id", const.DEVICE_ID)
 
     return data

blinkpy/sync_module.py

@@ -93,9 +93,7 @@ class BlinkSyncModule:
             self.serial = self.summary["serial"]
             self.status = self.summary["status"]
         except KeyError:
-            _LOGGER.error(
-                "Could not extract some sync module info: %s", response, exc_info=True
-            )
+            _LOGGER.error("Could not extract some sync module info: %s", response)
 
         is_ok = self.get_network_info()
         self.check_new_videos()
@@ -147,7 +145,7 @@ class BlinkSyncModule:
             for owl in self.blink.homescreen["owls"]:
                 if owl["name"] == name:
                     return owl
-        except KeyError:
+        except (TypeError, KeyError):
             pass
         return None
 
@@ -158,7 +156,7 @@ class BlinkSyncModule:
         try:
             return response["event"]
         except (TypeError, KeyError):
-            _LOGGER.error("Could not extract events: %s", response, exc_info=True)
+            _LOGGER.error("Could not extract events: %s", response)
             return False
 
     def get_camera_info(self, camera_id, **kwargs):
@@ -170,7 +168,7 @@ class BlinkSyncModule:
         try:
             return response["camera"][0]
         except (TypeError, KeyError):
-            _LOGGER.error("Could not extract camera info: %s", response, exc_info=True)
+            _LOGGER.error("Could not extract camera info: %s", response)
             return {}
 
     def get_network_info(self):
@@ -272,7 +270,7 @@ class BlinkOwl(BlinkSyncModule):
                 if owl["name"] == self.name:
                     self.status = owl["enabled"]
                     return owl
-        except KeyError:
+        except (TypeError, KeyError):
             pass
         return None
 

debug_login.py

@@ -0,0 +1,77 @@
+"""Login testing script."""
+import sys
+import os
+from blinkpy.blinkpy import Blink
+from blinkpy.auth import Auth
+from blinkpy.helpers.util import json_load, json_save
+
+save_session = False
+print("")
+print("Blink Login Debug Script ...")
+print(" ... Loading previous session information.")
+cwd = os.getcwd()
+print(f" ... Looking in {cwd}.")
+session_path = os.path.join(cwd, ".session_debug")
+session = json_load(session_path)
+
+try:
+    auth_file = session["file"]
+except (TypeError, KeyError):
+    print(" ... Please input location of auth file")
+    auth_file = input("     Must contain username and password: ")
+    save_session = True
+
+data = json_load(auth_file)
+if data is None:
+    print(f" ... Please fix file contents of {auth_file}.")
+    print(" ... Exiting.")
+    sys.exit(1)
+
+try:
+    username = data["username"]
+    password = data["password"]
+except KeyError:
+    print(f" ... File contents of {auth_file} incorrect.")
+    print(" ... Require username and password at minimum.")
+    print(" ... Exiting.")
+    sys.exit(1)
+
+if save_session:
+    print(f" ... Saving session file to {session_path}.")
+    json_save({"file": auth_file}, session_path)
+
+blink = Blink()
+auth = Auth(data)
+blink.auth = auth
+
+print(" ... Starting Blink.")
+print("")
+blink.start()
+print("")
+print(" ... Printing login response.")
+print("")
+print(blink.auth.login_response)
+print("")
+print(" ... Printing login attributes.")
+print("")
+print(blink.auth.login_attributes)
+print("")
+input(" ... Press any key to continue: ")
+print(" ... Deactivating auth token.")
+blink.auth.token = "foobar"
+print(f"\t - blink.auth.token = {blink.auth.token}")
+
+print(" ... Attempting login.")
+print("")
+blink.start()
+print("")
+print(" ... Printing login response.")
+print("")
+print(blink.auth.login_response)
+print("")
+print(" ... Printing login attributes.")
+print("")
+print(blink.auth.login_attributes)
+print("")
+rint(" ... Done.")
+print("")

docs/advanced.rst

@@ -30,6 +30,29 @@ By default, the ``blink.auth.Auth`` class creates its own websession via its ``c
     blink.auth = Auth()
     blink.auth.session = YourCustomSession
 
+
+Custom Retry Logic
+--------------------
+The built-in auth session via the ``create_session`` method allows for customizable retry intervals and conditions. These parameters are:
+
+- retries
+- backoff
+- retry_list
+
+``retries`` is the total number of retry attempts that each http request can do before timing out.  ``backoff`` is a parameter that allows for non-linear retry times such that the time between retries is backoff*(2^(retries) - 1).  ``retry_list`` is simply a list of status codes to force a retry.  By default ``retries=3``, ``backoff=1``, and ``retry_list=[429, 500, 502, 503, 504]``. To override them, you need to add you overrides to a dictionary and use that to create a new session with the ``opts`` variable in the ``create_session`` method. The following example can serve as a guide where only the number of retries and backoff factor are overridden:
+
+.. code:: python
+
+    from blinkpy.blinkpy import Blink
+    from blinkpy.auth import Auth
+
+    blink = Blink()
+    blink.auth = Auth()
+
+    opts = {"retries": 10, "backoff": 2}
+    blink.auth.session = blink.auth.create_session(opts=opts)
+
+
 Custom HTTP requests
 ---------------------
 In addition to custom sessions, custom blink server requests can be performed.  This give you the ability to bypass the built-in ``Auth.query`` method.  It also allows flexibility by giving you the option to pass your own url, rather than be limited to what is currently implemented in the ``blinkpy.api`` module.

requirements.txt

@@ -1,4 +1,3 @@
-python-dateutil~=2.8.1
-requests~=2.24.0
-python-slugify~=4.0.0
-testtools==2.4.0
+python-dateutil>=2.8.1
+requests>=2.24.0
+python-slugify>=4.0.1

requirements_test.txt

@@ -1,13 +1,14 @@
 black==19.10b0
-coverage==5.1
-flake8==3.8.3
+coverage==5.4
+flake8==3.8.4
 flake8-docstrings==1.5.0
-pre-commit==2.5.1
-pylint==2.5.3
-pydocstyle==5.0.2
-pytest==5.4.3
-pytest-cov==2.10.0
-pytest-sugar==0.9.3
-pytest-timeout==1.4.1
-restructuredtext-lint==1.3.1
-pygments==2.6.1
+pre-commit==2.10.1
+pylint==2.6.0
+pydocstyle==5.1.1
+pytest==6.2.2
+pytest-cov==2.11.1
+pytest-sugar==0.9.4
+pytest-timeout==1.4.2
+restructuredtext-lint==1.3.2
+pygments==2.7.4
+testtools>=2.4.0

setup.py

@@ -3,23 +3,26 @@
 from os.path import abspath, dirname
 from setuptools import setup, find_packages
 from blinkpy.helpers.constants import (
-    __version__, PROJECT_PACKAGE_NAME, PROJECT_LICENSE, PROJECT_URL,
-    PROJECT_EMAIL, PROJECT_DESCRIPTION, PROJECT_CLASSIFIERS, PROJECT_AUTHOR,
+    __version__,
+    PROJECT_PACKAGE_NAME,
+    PROJECT_LICENSE,
+    PROJECT_URL,
+    PROJECT_EMAIL,
+    PROJECT_DESCRIPTION,
+    PROJECT_CLASSIFIERS,
+    PROJECT_AUTHOR,
 )
 
 PROJECT_VERSION = __version__
 
 THIS_DIR = abspath(dirname(__file__))
 
-REQUIRES = [
-    "python-dateutil~=2.8.1",
-    "requests~=2.23.0",
-    "python-slugify~=4.0.0",
-]
+with open(f"{THIS_DIR}/requirements.txt") as req_file:
+    REQUIRES = [line.rstrip() for line in req_file]
 
-PACKAGES = find_packages(exclude=['tests*', 'docs'])
+PACKAGES = find_packages(exclude=["tests*", "docs"])
 
-with open('{}/README.rst'.format(THIS_DIR), encoding='utf-8') as readme_file:
+with open("{}/README.rst".format(THIS_DIR), encoding="utf-8") as readme_file:
     LONG_DESCRIPTION = readme_file.read()
 
 setup(
@@ -31,11 +34,11 @@ setup(
     author_email=PROJECT_EMAIL,
     license=PROJECT_LICENSE,
     url=PROJECT_URL,
-    platforms='any',
-    py_modules=['blinkpy'],
+    platforms="any",
+    py_modules=["blinkpy"],
     packages=PACKAGES,
     include_package_data=True,
     install_requires=REQUIRES,
-    test_suite='tests',
-    classifiers=PROJECT_CLASSIFIERS
+    test_suite="tests",
+    classifiers=PROJECT_CLASSIFIERS,
 )

tests/test_auth.py

@@ -42,7 +42,6 @@ class TestAuth(unittest.TestCase):
             "username": "foo",
             "password": "bar",
             "uid": 1234,
-            "notification_key": 1234,
             "device_id": const.DEVICE_ID,
         }
         self.assertDictEqual(auth.data, expected_data)
@@ -62,7 +61,6 @@ class TestAuth(unittest.TestCase):
             "username": "foo",
             "password": "bar",
             "uid": 1234,
-            "notification_key": 1234,
             "device_id": const.DEVICE_ID,
         }
         self.assertDictEqual(auth.data, expected_data)
@@ -128,8 +126,11 @@ class TestAuth(unittest.TestCase):
     def test_header(self):
         """Test header data."""
         self.auth.token = "bar"
-        self.auth.host = "foo"
-        expected_header = {"Host": "foo", "TOKEN_AUTH": "bar"}
+        expected_header = {
+            "TOKEN_AUTH": "bar",
+            "user-agent": const.DEFAULT_USER_AGENT,
+            "content-type": "application/json",
+        }
         self.assertDictEqual(self.auth.header, expected_header)
 
     def test_header_no_token(self):
@@ -144,21 +145,6 @@ class TestAuth(unittest.TestCase):
         fake_resp = mresp.MockResponse({"foo": "bar"}, 200)
         mock_req.return_value = fake_resp
         self.assertEqual(self.auth.login(), {"foo": "bar"})
-        mock_req.assert_called_with(
-            self.auth, const.LOGIN_ENDPOINT["v4"], {}, is_retry=False
-        )
-
-    @mock.patch("blinkpy.auth.Auth.validate_login", return_value=None)
-    @mock.patch("blinkpy.auth.api.request_login")
-    def test_login_v3(self, mock_req, mock_validate):
-        """Test login handling."""
-        auth_v3 = Auth(login_method="v3")
-        fake_resp = mresp.MockResponse({"foo": "bar"}, 200)
-        mock_req.return_value = fake_resp
-        self.assertEqual(auth_v3.login(), {"foo": "bar"})
-        mock_req.assert_called_with(
-            auth_v3, const.LOGIN_ENDPOINT["v3"], {}, is_retry=False
-        )
 
     @mock.patch("blinkpy.auth.Auth.validate_login", return_value=None)
     @mock.patch("blinkpy.auth.api.request_login")
@@ -177,10 +163,8 @@ class TestAuth(unittest.TestCase):
     def test_refresh_token(self, mock_login):
         """Test refresh token method."""
         mock_login.return_value = {
-            "region": {"tier": "test"},
-            "authtoken": {"authtoken": "foobar"},
-            "client": {"id": 1234},
-            "account": {"id": 5678},
+            "account": {"account_id": 5678, "client_id": 1234, "tier": "test"},
+            "auth": {"token": "foobar"},
         }
         self.assertTrue(self.auth.refresh_token())
         self.assertEqual(self.auth.region_id, "test")
@@ -202,12 +186,19 @@ class TestAuth(unittest.TestCase):
         self.auth.login_response = {}
         self.assertFalse(self.auth.check_key_required())
 
-        self.auth.login_response = {"client": {"verification_required": False}}
+        self.auth.login_response = {"account": {"client_verification_required": False}}
         self.assertFalse(self.auth.check_key_required())
 
-        self.auth.login_response = {"client": {"verification_required": True}}
+        self.auth.login_response = {"account": {"client_verification_required": True}}
         self.assertTrue(self.auth.check_key_required())
 
+    @mock.patch("blinkpy.auth.api.request_logout")
+    def test_logout(self, mock_req):
+        """Test logout method."""
+        mock_blink = MockBlink(None)
+        mock_req.return_value = True
+        self.assertTrue(self.auth.logout(mock_blink))
+
     @mock.patch("blinkpy.auth.api.request_verify")
     def test_send_auth_key(self, mock_req):
         """Check sending of auth key."""
@@ -246,7 +237,7 @@ class TestAuth(unittest.TestCase):
     @mock.patch("blinkpy.auth.Auth.refresh_token")
     def test_query_retry_failed(self, mock_refresh, mock_validate):
         """Check handling of failed retry request."""
-        self.auth.seession = MockSession()
+        self.auth.session = MockSession()
         mock_validate.side_effect = [UnauthorizedError, BlinkBadResponse]
         mock_refresh.return_value = True
         self.assertEqual(self.auth.query(url="http://example.com"), None)
@@ -254,14 +245,48 @@ class TestAuth(unittest.TestCase):
         mock_validate.side_effect = [UnauthorizedError, TokenRefreshFailed]
         self.assertEqual(self.auth.query(url="http://example.com"), None)
 
-    def test_login_methods(self):
-        """Test correct login url returned."""
-        auth = Auth()
-        self.assertEqual(auth.login_url, const.LOGIN_ENDPOINT["v4"])
-        auth.login_method = "v3"
-        self.assertEqual(auth.login_url, const.LOGIN_ENDPOINT["v3"])
-        auth.login_method = "foobar"
-        self.assertEqual(auth.login_url, const.LOGIN_ENDPOINT["v4"])
+    def test_default_session(self):
+        """Test default session creation."""
+        sess = self.auth.create_session()
+        adapter = sess.adapters["https://"]
+        self.assertEqual(adapter.max_retries.total, 3)
+        self.assertEqual(adapter.max_retries.backoff_factor, 1)
+        self.assertEqual(
+            adapter.max_retries.status_forcelist, [429, 500, 502, 503, 504]
+        )
+
+    def test_custom_session_full(self):
+        """Test full custom session creation."""
+        opts = {"backoff": 2, "retries": 10, "retry_list": [404]}
+        sess = self.auth.create_session(opts=opts)
+        adapter = sess.adapters["https://"]
+        self.assertEqual(adapter.max_retries.total, 10)
+        self.assertEqual(adapter.max_retries.backoff_factor, 2)
+        self.assertEqual(adapter.max_retries.status_forcelist, [404])
+
+    def test_custom_session_partial(self):
+        """Test partial custom session creation."""
+        opts1 = {"backoff": 2}
+        opts2 = {"retries": 5}
+        opts3 = {"retry_list": [101, 202]}
+        sess1 = self.auth.create_session(opts=opts1)
+        sess2 = self.auth.create_session(opts=opts2)
+        sess3 = self.auth.create_session(opts=opts3)
+        adapt1 = sess1.adapters["https://"]
+        adapt2 = sess2.adapters["https://"]
+        adapt3 = sess3.adapters["https://"]
+
+        self.assertEqual(adapt1.max_retries.total, 3)
+        self.assertEqual(adapt1.max_retries.backoff_factor, 2)
+        self.assertEqual(adapt1.max_retries.status_forcelist, [429, 500, 502, 503, 504])
+
+        self.assertEqual(adapt2.max_retries.total, 5)
+        self.assertEqual(adapt2.max_retries.backoff_factor, 1)
+        self.assertEqual(adapt2.max_retries.status_forcelist, [429, 500, 502, 503, 504])
+
+        self.assertEqual(adapt3.max_retries.total, 3)
+        self.assertEqual(adapt3.max_retries.backoff_factor, 1)
+        self.assertEqual(adapt3.max_retries.status_forcelist, [101, 202])
 
 
 class MockSession:

tests/test_blink_functions.py

@@ -5,29 +5,23 @@ import logging
 
 from blinkpy import blinkpy
 from blinkpy.sync_module import BlinkSyncModule
+from blinkpy.camera import BlinkCamera
 from blinkpy.helpers.util import get_time, BlinkURLHandler
 
 
 class MockSyncModule(BlinkSyncModule):
-    """Mock http requests from sync module."""
+    """Mock blink sync module object."""
 
-    def __init__(self, blink, header):
-        """Create mock sync module instance."""
-        super().__init__(blink, header, network_id=None, camera_list=None)
-        self.blink = blink
-        self.header = header
-        self.return_value = None
-        self.return_value2 = None
+    def get_network_info(self):
+        """Mock network info method."""
+        return True
 
-    def http_get(self, url, stream=False, json=True):
-        """Mock get request."""
-        if stream and self.return_value2 is not None:
-            return self.return_value2
-        return self.return_value
 
-    def http_post(self, url):
-        """Mock post request."""
-        return self.return_value
+class MockCamera(BlinkCamera):
+    """Mock blink camera object."""
+
+    def update(self, config, force_cache=False, **kwargs):
+        """Mock camera update method."""
 
 
 class TestBlinkFunctions(unittest.TestCase):
@@ -121,3 +115,16 @@ class TestBlinkFunctions(unittest.TestCase):
         with self.assertLogs() as dl_log:
             blink.download_videos("/tmp", camera="bar", stop=2)
         self.assertEqual(dl_log.output, expected_log)
+
+    @mock.patch("blinkpy.blinkpy.api.request_network_update")
+    @mock.patch("blinkpy.auth.Auth.query")
+    def test_refresh(self, mock_req, mock_update):
+        """Test ability to refresh system."""
+        mock_update.return_value = {"network": {"sync_module_error": False}}
+        mock_req.return_value = None
+        self.blink.last_refresh = 0
+        self.blink.available = True
+        self.blink.sync["foo"] = MockSyncModule(self.blink, "foo", 1, [])
+        self.blink.cameras = {"bar": MockCamera(self.blink.sync)}
+        self.blink.sync["foo"].cameras = self.blink.cameras
+        self.assertTrue(self.blink.refresh())

tests/test_blinkpy.py

@@ -68,8 +68,8 @@ class TestBlinkSetup(unittest.TestCase):
         self.assertEqual(self.blink.last_refresh, None)
         with mock.patch(
             "blinkpy.sync_module.BlinkSyncModule.refresh", return_value=True
-        ):
-            self.blink.refresh()
+        ), mock.patch("blinkpy.blinkpy.Blink.get_homescreen", return_value=True):
+            self.blink.refresh(force=True)
 
         self.assertEqual(self.blink.last_refresh, now)
         self.assertEqual(self.blink.check_if_ok_to_update(), False)

tests/test_cameras.py

@@ -117,10 +117,7 @@ class TestBlinkCameraSetup(unittest.TestCase):
                     "WARNING:blinkpy.camera:Could not retrieve calibrated "
                     "temperature."
                 ),
-                (
-                    "WARNING:blinkpy.camera:Could not find thumbnail for camera new"
-                    "\nNoneType: None"
-                ),
+                ("WARNING:blinkpy.camera:Could not find thumbnail for camera new"),
             ],
         )
 
@@ -179,3 +176,10 @@ class TestBlinkCameraSetup(unittest.TestCase):
         attr = camera.attributes
         for key in attr:
             self.assertEqual(attr[key], None)
+
+    def test_camera_stream(self, mock_resp):
+        """Test that camera stream returns correct url."""
+        mock_resp.return_value = {"server": "rtsps://foo.bar"}
+        mini_camera = BlinkCameraMini(self.blink.sync["test"])
+        self.assertEqual(self.camera.get_liveview(), "rtsps://foo.bar")
+        self.assertEqual(mini_camera.get_liveview(), "rtsps://foo.bar")

tests/test_util.py

@@ -3,7 +3,7 @@
 import unittest
 from unittest import mock
 import time
-from blinkpy.helpers.util import json_load, Throttle, time_to_seconds
+from blinkpy.helpers.util import json_load, Throttle, time_to_seconds, gen_uid
 
 
 class TestUtil(unittest.TestCase):
@@ -132,3 +132,19 @@ class TestUtil(unittest.TestCase):
         self.assertEqual(json_load("fake.file"), None)
         with mock.patch("builtins.open", mock.mock_open(read_data="")):
             self.assertEqual(json_load("fake.file"), None)
+
+    def test_gen_uid(self):
+        """Test gen_uid formatting."""
+        val1 = gen_uid(8)
+        val2 = gen_uid(8, uid_format=True)
+
+        self.assertEqual(len(val1), 16)
+
+        self.assertTrue(val2.startswith("BlinkCamera_"))
+        val2_cut = val2.split("_")
+        val2_split = val2_cut[1].split("-")
+        self.assertEqual(len(val2_split[0]), 8)
+        self.assertEqual(len(val2_split[1]), 4)
+        self.assertEqual(len(val2_split[2]), 4)
+        self.assertEqual(len(val2_split[3]), 4)
+        self.assertEqual(len(val2_split[4]), 12)

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = build, py36, py37, py38, lint
+envlist = build, py36, py37, py38, py39, lint
 skip_missing_interpreters = True
 skipsdist = True