Merge pull request #152 from fronzbot/dev

0.12.0

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+omit = 
+    helpers/*
+    tests/*
+    setup.py

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. 
+2. 
+3. 
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Home Assistant version (if applicable):** <HA Version Number>
+
+**`blinkpy` version (not needed if filling out Home Assistant version):**
+
+**Log Output/Additional Information**
+If using home-assistant, please paste the output of the log showing your error below.  If not, please include any additional useful information.
+
+```
+PASTE LOG OUTPUT HERE
+```

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context about the feature request (such as API endpoint responses, etc).

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+## Description:
+
+
+**Related issue (if applicable):** fixes #<blinkpy issue number goes here>
+
+## Checklist:
+- [ ] Local tests with `tox` run successfully **PR cannot be meged unless tests pass**
+- [ ] Changes tested locally to ensure platform still works as intended
+- [ ] Tests added to verify new code works

.gitignore

@@ -1,3 +1,4 @@
+.pytest_cache/*
 .cache/*
 .tox/*
 __pycache__/*
@@ -6,6 +7,7 @@ htmlcov/*
 *.pyc
 *.egg*/*
 dist/*
-MANIFEST
-README
 .sh
+build/*
+docs/_build
+*.log

.gitlab-ci.yml

@@ -0,0 +1,25 @@
+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
+

.hound.yml

@@ -0,0 +1,7 @@
+python:
+  enabled: true
+  ignore_file: setup.py
+  ignored_directories:
+  - docs
+
+fail_on_violations: true

.travis.yml

@@ -0,0 +1,23 @@
+sudo: required
+matrix:
+  fast_finish: true
+  include:
+    - python: "3.6"
+      env: TOXENV=lint
+    - python: "3.5.3"
+      env: TOXENV=py35
+    - python: "3.6"
+      env: TOXENV=py36
+    - python: "3.6"
+      env: TOXENV=build
+    - python: "3.7"
+      env: TOXENV=py37
+      dist: xenial
+    - python: "3.8-dev"
+      env: TOXENV=py38
+      dist: xenial
+
+install: pip install -U tox coveralls
+language: python
+script: tox
+after_success: coveralls

API.md

@@ -0,0 +1,289 @@
+# BlinkMonitorProtocol
+Unofficial documentation for the Client API of the Blink Wire-Free HD Home Monitoring & Alert System.
+
+Copied from https://github.com/MattTW/BlinkMonitorProtocol
+
+I am not affiliated with the company in any way - this documentation is strictly **"AS-IS"**.  My goal was to uncover enough to arm and disarm the system programatically so that I can issue those commands in sync with my home alarm system arm/disarm.  Just some raw notes at this point but should be enough for creating programmatic APIs.    Lots more to be discovered and documented - feel free to contribute!
+
+The Client API is a straightforward REST API using JSON and HTTPS.
+
+## Login
+
+Client login to the Blink Servers.
+
+**Request:**
+>curl -H "Host: prod.immedia-semi.com" -H "Content-Type: application/json" --data-binary '{
+>  "password" : "*your blink password*",
+>  "client_specifier" : "iPhone 9.2 | 2.2 | 222",
+>  "email" : "*your blink login/email*"
+>}' --compressed https://rest.prod.immedia-semi.com/login
+
+**Response:**
+>{"authtoken":{"authtoken":"*an auth token*","message":"auth"},"networks":{"*network id*":{"name":"*name*","onboarded":true}},"region":{"*regioncode for endpoint*":"*region name"}}
+
+**Notes:**
+The authtoken value is passed in a header in future calls.
+The region code for endpoint is required to form the URL of the REST endpoint for future calls.
+Depending on the region you are registered you will need to change the REST endpoints below:
+- from `https://rest.prod.immedia-semi.com`
+- to `https://rest.prde.immedia-semi.com` if e.g. your device is registered in Germany
+Please note that at this moment it seems that all regions are not implemented equally: not all endpoints are available in all regions
+
+## Networks
+
+Obtain information about the Blink networks defined for the logged in user.
+
+**Request:**
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/networks
+
+**Response:**
+JSON response containing information including Network ID and Account ID.
+
+**Notes:**
+Network ID is needed to issue arm/disarm calls
+
+
+## Sync Modules
+
+Obtain information about the Blink Sync Modules on the given network.
+
+**Request:**
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/network/*network_id_from_networks_call*/syncmodules
+
+**Response:**
+JSON response containing information about the known state of the Sync module, most notably if it is online
+
+**Notes:**
+Probably not strictly needed but checking result can verify that the sync module is online and will respond to requests to arm/disarm, etc.
+
+
+## Arm
+ 
+Arm the given network (start recording/reporting motion events)
+
+**Request:**
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --data-binary --compressed https://rest.prod.immedia-semi.com/network/*network_id_from_networks_call*/arm
+
+**Response:**
+JSON response containing information about the arm command request, including the command/request ID
+
+**Notes:**
+When this call returns, it does not mean the arm request is complete,  the client must gather the request ID from the response and poll for the status of the command.
+
+## Disarm
+
+Disarm the given network (stop recording/reporting motion events)
+
+**Request:**
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --data-binary --compressed https://rest.prod.immedia-semi.com/network/*network_id_from_networks_call*/disarm
+
+**Response:**
+JSON response containing information about the disarm command request, including the command/request ID
+
+**Notes:**
+When this call returns, it does not mean the disarm request is complete,  the client must gather the request ID from the response and poll for the status of the command.
+
+
+## Command Status
+
+Get status info on the given command
+
+**Request:**
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/network/*network_id*/command/*command_id*
+
+**Response:**
+JSON response containing state information of the given command, most notably whether it has completed and was successful.
+
+**Notes:**
+After an arm/disarm command, the client appears to poll this URL every second or so until the response indicates the command is complete.
+
+**Known Commands:**
+lv_relay, arm, disarm, thumbnail, clip
+
+## Home Screen
+
+Return information displayed on the home screen of the mobile client
+
+**Request:**
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/homescreen
+
+**Response:**
+JSON response containing information that the mobile client displays on the home page, including:  status, armed state, links to thumbnails for each camera, etc.
+
+**Notes:**
+Not necessary to as part of issuing arm/disarm commands, but contains good summary info.
+
+## Events, thumbnails & video captures
+
+**Request**
+Get events for a given network (sync module) -- Need network ID from home 
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/events/network/*network__id*
+
+**Response**
+A json list of evets incluing URL's.   Replace the "mp4" with "jpg" extension to get the thumbnail of each clip
+
+
+**Request**
+Get a video clip from the events list
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed **video url from events list.mp4** > video.mp4
+
+**Response**
+The mp4 video
+
+**Request**
+Get a thumbnail from the events list
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed **video url from events list.jpg** > video_thumb.jpg
+
+**Response**
+The jpg bytes. 
+
+**Notes**
+Note that you replace the 'mp4' with a 'jpg' to get the thumbnail
+
+**Request**
+Captures a new thumbnail for a camera
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --data-binary --compressed https://rest.prod.immedia-semi.com/network/*network_id*/camera/*camera_id*/thumbnail
+
+**Response**
+Command information. 
+
+**Request**
+Captures a new video for a camera
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --data-binary --compressed https://rest.prod.immedia-semi.com/network/*network_id*/camera/*camera_id*/clip
+
+**Response**
+Command information.
+
+## Video Information
+
+**Request**
+Get the total number of videos in the system
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/api/v2/videos/count
+
+**Response**
+JSON response containing the total video count.
+
+**Request**
+Gets a paginated set of video information
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/api/v2/videos/page/0
+
+**Response**
+JSON response containing a set of video information, including: camera name, creation time, thumbnail URI, size, length
+
+**Request**
+Gets information for a specific video by ID
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/api/v2/video/*video_id*
+
+**Response**
+JSON response containing video information
+
+**Request**
+Gets a list of unwatched videos
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/api/v2/videos/unwatched
+
+**Response**
+JSON response containing unwatched video information
+
+**Request**
+Deletes a video
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --data-binary --compressed https://rest.prod.immedia-semi.com/api/v2/video/*video_id*/delete
+
+**Response**
+Unknown - not tested
+
+**Request**
+Deletes all videos
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --data-binary --compressed https://rest.prod.immedia-semi.com/api/v2/videos/deleteall
+
+**Response**
+Unknown - not tested
+
+## Cameras
+
+**Request**
+Gets a list of cameras
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/network/*network_id*/cameras
+
+**Response**
+JSON response containing camera information
+
+**Request**
+Gets information for one camera
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/network/*network_id*/camera/*camera_id*
+
+**Response**
+JSON response containing camera information
+
+**Request**
+Gets camera sensor information
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/network/*network_id*/camera/*camera_id*/signals
+
+**Response**
+JSON response containing camera sensor information, such as wifi strength, temperature, and battery level
+
+**Request**
+Enables motion detection for one camera
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: $auth_token" --data-binary --compressed https://rest.prod.immedia-semi.com/network/*network_id*/camera/*camera_id*/enable
+
+**Response**
+JSON response containing camera information
+
+**Request**
+Disables motion detection for one camera
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: $auth_token" --data-binary --compressed https://rest.prod.immedia-semi.com/network/*network_id*/camera/*camera_id*/disable
+
+**Response**
+JSON response containing camera information
+
+*Note*: enabling or disabling motion detection is independent of arming or disarming the system.  No motion detection or video recording will take place unless the system is armed.
+
+
+## Miscellaneous
+
+**Request**
+Gets information about devices that have connected to the blink service
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/account/clients
+
+**Response**
+JSON response containing client information, including: type, name, connection time, user ID
+
+**Request**
+Gets information about supported regions
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/regions
+
+**Response**
+JSON response containing region information
+
+**Request**
+Gets information about system health
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/health
+
+**Response**
+"all ports tested are open"
+
+**Request**
+Gets information about programs
+
+>curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/api/v1/networks/*network_id*/programs
+
+**Response**
+Unknown.

CHANGES.rst

@@ -0,0 +1,153 @@
+Changelog
+-----------
+
+A list of changes between each release
+
+0.11.2 (2019-01-23)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Hotfix to prevent platform from stalling due to API change
+- Motion detection and video recovery broken until new API endpoint discovered
+
+0.11.1 (2019-01-02)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Fixed incorrect backup login url
+- Added calibrated temperature property for cameras
+
+
+0.11.0 (2018-11-23)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Added support for multiple sync modules
+
+0.10.3 (2018-11-18)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Use networks endpoint rather than homecreen to retrieve arm/disarm status (`@md-reddevil <https://github.com/fronzbot/blinkpy/pull/119>`__)
+- Fix incorrect command status endpoint (`@md-reddevil <https://github.com/fronzbot/blinkpy/pull/118>`__)
+- Add extra debug logging
+- Remove error prior to re-authorization (only log error when re-auth failed)
+
+
+0.10.2 (2018-10-30)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Set minimum required version of the requests library to 2.20.0 due to vulnerability in earlier releases.
+- When multiple networks detected, changed log level to 'warning' from 'error' 
+
+
+0.10.1 (2018-10-18)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Fix re-authorization bug (fixes `#101 <https://github.com/fronzbot/blinkpy/issues/#101>`__)
+- Log an error if saving video that doesn't exist
+
+0.10.0 (2018-10-16)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Moved all API calls to own module for easier maintainability
+- Added network ids to sync module and cameras to allow for multi-network use
+- Removed dependency on video existance prior to camera setup (fixes `#93 <https://github.com/fronzbot/blinkpy/issues/#93>`__)
+- Camera wifi_strength now reported in wifi "bars" rather than dBm due to API endpoint change
+- Use homescreen thumbnail as fallback in case it's not in the camera endpoint
+- Removed "armed" and "status" attributes from camera (status of camera only reported by "motion_enabled" now)
+- Added serial number attributes to sync module and cameras
+- Check network_id from login response and verify that network is onboarded (fixes `#90 <https://github.com/fronzbot/#90>`__)
+- Check if retrieved clip is "None" prior to storing in cache
+
+0.9.0 (2018-09-27)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Complete code refactoring to enable future multi-sync module support
+- Add image and video caching to the cameras
+- Add internal throttling of system refresh
+- Use session for http requests
+
+**Breaking change:**
+- Cameras now accessed through sync module Blink.sync.cameras
+
+
+0.8.1 (2018-09-24)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Update requirements_test.txt
+- Update linter versions
+- Fix pylint warnings
+  - Remove object from class declarations
+  - Remove useless returns from functions
+- Fix pylint errors
+  - change if comparison to fix (consider-using-in)
+  - Disabled no else-if-return check
+- Fix useless-import-alias
+- Disable no-else-return
+- Fix motion detection
+  - Use an array of recent video clips to determine if motion has been detected.
+  - Reset the value every system refresh
+
+0.8.0 (2018-05-21)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Added support for battery voltage level (fixes `#64 <https://github.com/fronzbot/blinkpy/issues/64>`__)
+- Added motion detection per camera
+- Added fully accessible camera configuration dict
+- Added celcius property to camera (fixes `#60 <https://github.com/fronzbot/blinkpy/issues/60>`__)
+
+0.7.1 (2018-05-09)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Fixed pip 10 import issue during setup (`@fronzbot <https://github.com/fronzbot/blinkpy/pull/61>`__)
+
+0.7.0 (2018-02-08)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- Fixed style errors for bumped pydocstring and pylint versions
+- Changed Blink.cameras dictionary to be case-insensitive (fixes `#35 <https://github.com/fronzbot/blinkpy/issues/35>`__)
+- Changed api endpoint for video extraction (fixes `#35 <https://github.com/fronzbot/blinkpy/issues/35>`__ and `#41 <https://github.com/fronzbot/blinkpy/issues/41>`__)
+- Removed last_motion() function from Blink class
+- Refactored code for better organization
+- Moved some request calls out of @property methods (enables future CLI support)
+- Renamed get_summary() method to summary and changed to @property
+- Added ability to download most recent video clip
+- Improved camera arm/disarm handling (`@b10m <https://github.com/fronzbot/blinkpy/pull/50>`__)
+- Added authentication to ``login()`` function and deprecated ``setup_system()`` in favor of ``start()``
+- Added ``attributes`` dictionary to camera object
+
+0.6.0 (2017-05-12)
+^^^^^^^^^^^^^^^^^^
+- Removed redundent properties that only called hidden variables
+- Revised request wrapper function to be more intelligent
+- Added tests to ensure exceptions are caught and handled (100% coverage!)
+- Added auto-reauthorization (token refresh) when a request fails due to an expired token (`@tySwift93 <https://github.com/fronzbot/blinkpy/pull/24>`__)
+- Added battery level string to reduce confusion with the way Blink reports battery level as integer from 0 to 3
+
+0.5.2 (2017-03-12)
+^^^^^^^^^^^^^^^^^^
+- Fixed packaging mishap, same as 0.5.0 otherwise
+
+0.5.0 (2017-03-12)
+^^^^^^^^^^^^^^^^^^
+- Fixed region handling problem
+- Added rest.piri subdomain as a backup if region can't be found
+- Improved the file writing function
+- Large test coverage increase
+
+0.4.4 (2017-03-06)
+^^^^^^^^^^^^^^^^^^
+- Fixed bug where region id was not being set in the header
+
+0.4.3 (2017-03-05)
+^^^^^^^^^^^^^^^^^^
+- Changed to bdist_wheel release
+
+0.4.2 (2017-01-28)
+^^^^^^^^^^^^^^^^^^
+- Fixed inability to retrieve motion data due to Key Error
+
+0.4.1 (2017-01-27)
+^^^^^^^^^^^^^^^^^^
+- Fixed refresh bug (0.3.1 did not actually fix the problem)
+- Image refresh routine added (per camera)
+- Dictionary of thumbnails per camera added
+- Improved test coverage
+
+0.3.1 (2017-01-25)
+^^^^^^^^^^^^^^^^^^
+- Fixed refresh bug (Key Error)
+
+0.3.0 (2017-01-25)
+^^^^^^^^^^^^^^^^^^
+- Added device id to camera lookup table
+- Added image to file method
+
+0.2.0 (2017-01-21)
+^^^^^^^^^^^^^^^^^^
+- Initial release of blinkpy

CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to blinkpy
+
+Everyone is welcome to contribute to blinkpy! The process to get started is described below.
+
+## Fork the Repository
+
+You can do this right in github: just click the 'fork' button at the top right.
+
+## Start Developing
+
+1. Setup Local Repository
+   ```shell
+   $ git clone https://github.com/<YOUR_GIT_USERNAME>/blinkpy.git
+   $ cd blinkpy
+   $ git remote add upstream https://github.com/fronzbot/blinkpy.git
+   ```
+
+2. Create a Local Branch
+   
+   First, you will want to create a new branch to hold your changes:
+   ``git checkout -b <your-branch-name>``
+
+
+3. Make changes
+   
+   Now you can make changes to your code.  It is worthwhile to test your code as you progress (see the **Testing** section)
+
+4. Commit Your Changes
+   
+   To commit changes to your branch, simply add the files you want and the commit them to the branch.  After that, you can push to your fork on GitHub:
+   ```shell
+   $ git add .
+   $ git commit -m "Put your commit text here.  Please be concise, but descriptive."
+   $ git push origin HEAD
+   ```
+   
+5. Submit your pull request on GitHub
+   
+   - On GitHub, navigate to the [blinkpy](https://github.com/fronzbot/blinkpy) repository.
+   - In the "Branch" menu, choose the branch that contains your commits (from your fork).
+   - To the right of the Branch menu, click New pull request.
+   - The base branch dropdown menu should read `dev`. Use the compare branch drop-down menu to choose the branch you made your changes        in.
+   - Type a title and complete the provided description for your pull request.
+   - Click Create pull request.
+   - More detailed instructions can be found here: [Creating a Pull Request](https://help.github.com/articles/creating-a-pull-request/)
+   
+6. Prior to merge approval
+   
+   Finally, the `blinkpy` repository uses continuous integration tools to run tests prior to merging. If there are any problems, you      will see a red 'X' next to your pull request. To see what's wrong, you can find your pull request [here](https://travis-       ci.org/fronzbot/blinkpy/pull_requests) and click on the failing test to see the logs.  Those logs will indicate, as best as they can, what is causing that test to fail.
+
+
+## Testing
+
+It is important to test the code to make sure your changes don't break anything major and that they pass PEP8 style conventions.
+First, you need to locally install ``tox``
+
+```shell
+$ pip3 install tox
+```
+
+You can then run all of the tests with the following command:
+
+```shell
+$ tox
+```
+
+### Tips
+
+If you only want to see if you can pass the local tests, you can run `tox -e py35` (or whatever python version you have installed.  Only `py35`, `py36`, and `py37` will be accepted).  If you just want to check for style violations, you can run `tox -e lint`.  Regardless, when you submit a pull request, your code MUST pass both the unit tests, and the linters.
+
+If you need to change anything in `requirements.txt` for any reason, you'll want to regenerate the virtual envrionments used by `tox` by running with the `-r` flag: `tox -r`
+
+If you want to run a single test (perhaps you only changed a small thing in one file) you can run `tox -e py35 -- tests/<testname>.py -x`.  This will run the test `<testname>.py` and stop testing upon the first failure, making it easier to figure out why a particular test might be failing.  The test structure mimics the library structure, so if you changed something in `sync_module.py`, the associated test file would be in `test_sync_module.py` (ie. the filename is prepended with `test_`.
+
+# Catching Up With Reality
+
+If your code is taking a while to develop, you may be behind the ``dev`` branch, in which case you need to catch up before creating your pull-request.  To do this you can run ``git rebase`` as follows (running this on your local branch):
+
+```shell
+$ git fetch upstream dev
+$ git rebase upstream/dev
+```
+
+If rebase detects conflicts, repeat the following process until all changes have been resolved:
+
+1. ``git status`` shows you the filw with a conflict.  You will need to edit that file and resolve the lines between ``<<<< | >>>>`.
+2. Add the modified file: ``git add <file>`` or ``git add .``.
+3. Continue rebase: ``git rebase --continue``.
+4. Repeat until all conflicts resolved.

MANIFEST.in

@@ -0,0 +1,4 @@
+include README.rst
+include LICENSE.md
+include API.md
+include tests/*.py

README.rst

@@ -1,9 +1,9 @@
-**blinkpy**
-============
+blinkpy |Build Status| |Coverage Status| |Docs| |PyPi Version| |Python Version|
+================================================================================
 A Python library for the Blink Camera system
 
-**Disclaimers**
-===============
+Disclaimer:
+~~~~~~~~~~~~~~~
 Published under the MIT license - See LICENSE file for more details.
 
 "Blink Wire-Free HS Home Monitoring & Alert Systems" is a trademark owned by Immedia Inc., see www.blinkforhome.com for more information.
@@ -11,118 +11,115 @@ I am in no way affiliated with Blink, nor Immedia Inc.
 
 Original protocol hacking by MattTW : https://github.com/MattTW/BlinkMonitorProtocol
 
-**Installation**
+API calls faster than 60 seconds is not recommended as it can overwhelm Blink's servers.  Please use this module responsibly.
+
+Installation
 ================
 ``pip3 install blinkpy``
 
-**Purpose**
+Installing Development Version
+==================================
+To install the current development version, perform the following steps.  Note that the following will create a blinkpy directory in your home area:
+
+.. code:: bash
+
+    $ cd ~
+    $ git clone https://github.com/fronzbot/blinkpy.git
+    $ cd blinkpy
+    $ rm -rf build dist
+    $ python3 setup.py bdist_wheel
+    $ pip3 install --upgrade dist/*.whl
+
+
+If you'd like to contribute to this library, please read the `contributing instructions <https://github.com/fronzbot/blinkpy/blob/dev/CONTRIBUTING.md>`__.
+
+For more information on how to use this library, please `read the docs <https://blinkpy.readthedocs.io/en/latest/>`__.
+
+Purpose
 ===========
-This library was built with the intention of allowing easy communication with Blink camera systems, specifically so I can add a module into homeassistant https://home-assistant.io
-
-**Usage**
-=========
-In terms of usage, you just need to instantiate the module with a username and password
-::
-  import blinkpy
-  blink = blinkpy.Blink(username='YOUR USER NAME', password='YOUR PASSWORD')
-
-
-If you leave out either of those parameters, you need to call the login function which will prompt for your username and password
-::
-  blink.login()
-
-
-Once the login information is entered, you can run the `setup_system()` function which will attempt to authenticate with Blink servers using your username and password, obtain network ids, and create a list of cameras.
-The cameras are of a BlinkCamera class, of which the following parameters can be used (the code below creates a Blink object and iterates through each camera found)
-::
-  blink = blinkpy.Blink(username='YOUR USER NAME', password='YOUR PASSWORD')
-  blink.setup_system()
-
-  for camera in blink.cameras:
-      print(camera.name)          # Name of the camera
-      print(camera.id)            # Integer id of the camera (assigned by Blink)
-      print(camera.armed)        # Whether the device is armed/disarmed (ie. detecting motion)
-      print(camera.clip)          # Link to last motion clip captured
-      print(camera.thumbnail)     # Link to current camera thumbnail
-      print(camera.temperature)   # Current camera temperature (not super accurate, but might be useful for someone)
-      print(camera.battery)       # Current battery level... I think the value ranges from 0-3, but not quite sure yet.
-      print(camera.notifications) # Number of unread notifications (ie. motion alerts that haven't been viewed)
-      print(camera.motion)        # Dictionary containing values for keys ['video', 'image', 'time']
-                                # which correspond to last motion recorded, thumbnail of last motion, and timestamp of last motion
-
-
-**class Blink**
----------------
-The following properties/methods are availiable to the Blink class
-
-**Blink.cameras**
-Returns a list of BlinkCamera objects found by the system
-
-**Blink.network_id**
-Returns the current network id
-
-**Blink.account_id**
-Returns the account id
-
-**Blink.events**
-Returns a list of events recorded by blink.  This information will contain links to any motion caught by an armed camera.
-
-**Blink.online**
-Returns online status of sync module (True = online, False = offline)
-
-**Blink.last_motion()**
-Finds last motion information for each camera and stores it in the BlinkCamera.motion field
-
-**Blink.arm**
-Set to True to arm, False to disarm.  Can be used to see the status of the system as well
-
-**Blink.refresh()**
-Forces a refresh of all camera information
-
-**Blink.get_summary()**
-Returns json formatted summary of the system
-
-**Blink.get_cameras()**
-Finds all cameras in the system and creates them
-
-**Blink.set_links()**
-Gives each BlinkCamera object the links needed to find recent images and videos
-
-**Blink.login()**
-Prompts user for login information
-
-**Blink.get_auth_token()**
-Uses login information to retrieve authorization token from Blink for further communication
-
-**Blink.get_ids()**
-Retrieves the network_id and account_id from Blink in order to access video and image pages on their server
-
-**Blink.setup_system()**
-A wrapper script that calls:
-::
-  self.get_auth_token()
-  self.get_ids()
-  self.get_camers()
-  self.set_links()
-
-
-**class BlinkCamera**
----------------------
-This class is just a wrapper for each individual camera in order to make communication with individual cameras less clunky.  The following properties/methods are availiable (in addition to the ones mentioned earlier)
-
-**BlinkCamera.snap_picture()**
-Takes an image with the camera and saves it as the new thumbnail.  The Blink.refresh() method should be called after this if you want to store the new thumbnail link
-
-**BlinkCamera.set_motion_detect(enable=True/False)**
-Sending True to this function will enable motion detection for the camera.  Setting to False will disable motion detection
-
-**BlinkCamera.image_to_file(path)**
-This will write the current thumbnail to the location indicated in 'path'
-
-
-
-
-
+This library was built with the intention of allowing easy communication with Blink camera systems, specifically to support the `Blink component <https://home-assistant.io/components/blink>`__ in `homeassistant <https://home-assistant.io/>`__.
 
+Quick Start
+=============
+The simplest way to use this package from a terminal is to call ``Blink.start()`` which will prompt for your Blink username and password and then log you in.  Alternatively, you can instantiate the Blink class with a username and password, and call ``Blink.start()`` to login and setup without prompt, as shown below.  In addition, http requests are throttled internally via use of the ``Blink.refresh_rate`` variable, which can be set at initialization and defaults to 30 seconds.
+
+.. code:: python
+
+    from blinkpy import blinkpy
+    blink = blinkpy.Blink(username='YOUR USER NAME', password='YOUR PASSWORD', refresh_rate=30)
+    blink.start()
+
+If you would like to log in without setting up the cameras or system, you can simply call the ``Blink.login()`` function which will prompt for a username and password and then authenticate with the server.  This is useful if you want to avoid use of the ``start()`` function which simply acts as a wrapper for more targeted API methods.
+
+At initialization, you may also set the logging level of the ``blinkpy`` library like so (default is ``INFO``:
+
+.. code:: python
+
+    import logging
+    from blinkpy import blinkpy
+    blink = blinkpy.Blink(..., loglevel=logging.<LEVEL>)
+    blink.start()
+    
+You can also disable logging of duplicate entries via the ``allow_duplicate_logs`` flag (default is ``True``):
+
+.. code:: python
+
+    from blinkpy import blinkpy
+    blink = blinkpy.Blink(..., allow_duplicate_logs=False)
+    blink.start()
+    
+Cameras are instantiated as individual ``BlinkCamera`` classes within a ``BlinkSyncModule`` instance.  All of your sync modules are stored within the ``Blink.sync`` dictionary and can be accessed using the name of the sync module as the key (this is the name of your sync module in the Blink App).
+
+The below code will display cameras and their available attributes:
+
+.. code:: python
+
+    from blinkpy import blinkpy
+
+    blink = blinkpy.Blink(username='YOUR USER NAME', password='YOUR PASSWORD')
+    blink.start()
+
+    for name, camera in blink.cameras.items():
+      print(name)                   # Name of the camera
+      print(camera.attributes)      # Print available attributes of camera
+
+The most recent images and videos can be accessed as a bytes-object via internal variables.  These can be updated with calls to ``Blink.refresh()`` but will only make a request if motion has been detected or other changes have been found.  This can be overridden with the ``force_cache`` flag, but this should be used for debugging only since it overrides the internal request throttling.
+
+.. code:: python
+    
+    camera = blink.cameras['SOME CAMERA NAME']
+    blink.refresh(force_cache=True)  # force a cache update USE WITH CAUTION
+    camera.image_from_cache.raw  # bytes-like image object (jpg)
+    camera.video_from_cache.raw  # bytes-like video object (mp4)
+
+The ``blinkpy`` api also allows for saving images and videos to a file and snapping a new picture from the camera remotely:
+
+.. code:: python
+
+    camera = blink.cameras['SOME CAMERA NAME']
+    camera.snap_picture()       # Take a new picture with the camera
+    blink.refresh()             # Get new information from server
+    camera.image_to_file('/local/path/for/image.jpg')
+    camera.video_to_file('/local/path/for/video.mp4')
+    
+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.
+
+Example usage, which downloads all videos recorded since July 4th, 2018 at 9:34am to the ``/home/blink`` directory:
+
+.. code:: python
+
+    blink = blinkpy.Blink(username="YOUR USER NAME", password="YOUR PASSWORD")
+    blink.start()
+    blink.download_videos('/home/blink', since='2018/07/04 09:34')
 
 
+.. |Build Status| image:: https://travis-ci.org/fronzbot/blinkpy.svg?branch=dev
+   :target: https://travis-ci.org/fronzbot/blinkpy
+.. |Coverage Status| image:: https://coveralls.io/repos/github/fronzbot/blinkpy/badge.svg?branch=dev
+    :target: https://coveralls.io/github/fronzbot/blinkpy?branch=dev
+.. |PyPi Version| image:: https://img.shields.io/pypi/v/blinkpy.svg
+    :target: https://pypi.python.org/pypi/blinkpy
+.. |Docs| image:: https://readthedocs.org/projects/blinkpy/badge/?version=latest
+   :target: http://blinkpy.readthedocs.io/en/latest/?badge=latest
+.. |Python Version| image:: https://img.shields.io/pypi/pyversions/blinkpy.svg
+   :target: https://img.shields.io/pypi/pyversions/blinkpy.svg

__init__.py

@@ -1 +0,0 @@
-from blinkpy import Blink

blinkpy.py

@@ -1,394 +0,0 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-'''
-blinkpy by Kevin Fronczak - A Blink camera Python library
-https://github.com/fronzbot/blinkpy
-Original protocol hacking by MattTW : https://github.com/MattTW/BlinkMonitorProtocol
-
-Published under the MIT license - See LICENSE file for more details.
-
-"Blink Wire-Free HS Home Monitoring & Alert Systems" is a trademark owned by Immedia Inc., see www.blinkforhome.com for more information.
-I am in no way affiliated with Blink, nor Immedia Inc.
-'''
-
-import logging
-import requests
-import getpass
-import json
-
-BLINK_URL = 'immedia-semi.com'
-LOGIN_URL = 'https://prod.' + BLINK_URL + '/login'
-BASE_URL = 'https://prod.' + BLINK_URL
-DEFAULT_URL = 'prod.' + BLINK_URL
-
-logger = logging.getLogger('blinkpy')
-
-
-def _request(url, data=None, headers=None, type='get', stream=False, json=True):
-    """Wrapper function for request"""
-    if type is 'post':
-        response = requests.post(url, headers=headers, data=data).json()
-    elif type is 'get' and json:
-        response = requests.get(url, headers=headers, stream=stream).json()
-    elif type is 'get' and not json:
-        response = requests.get(url, headers=headers, stream=stream)
-    else:
-        raise ValueError("Cannot perform requests of type " + type)
-
-    if json and 'message' in response.keys():
-        raise BlinkAuthenticationException(response['code'], response['message'])
-
-    return response
-
-
-class BlinkException(Exception):
-    def __init__(self, id, message):
-        self.id = id
-        self.message = message
-
-
-class BlinkAuthenticationException(BlinkException):
-    pass
-
-
-class BlinkCamera(object):
-    """Class to initialize individual camera"""
-    def __init__(self, config):
-        self._ID = str(config['device_id'])
-        self._NAME = config['name']
-        self._STATUS = config['armed']
-        self._THUMB = BASE_URL + config['thumbnail'] + '.jpg'
-        self._CLIP = BASE_URL + config['thumbnail'] + '.mp4'
-        self._TEMPERATURE = config['temp']
-        self._BATTERY = config['battery']
-        self._NOTIFICATIONS = config['notifications']
-        self._MOTION = {}
-        self._HEADER = None
-        self._IMAGE_LINK = None
-        self._ARM_LINK = None
-        self._REGION_ID = config['region_id']
-
-    @property
-    def id(self):
-        return self._ID
-
-    @property
-    def name(self):
-        return self._NAME
-
-    @name.setter
-    def name(self, value):
-        self._NAME = value
-
-    @property
-    def region_id(self):
-        return self._REGION_ID
-
-    @property
-    def armed(self):
-        return self._STATUS
-
-    @property
-    def clip(self):
-        return self._CLIP
-
-    @clip.setter
-    def clip(self, value):
-        self._CLIP = value
-
-    @property
-    def thumbnail(self):
-        # RUN THUMB ACQ HERE
-        return self._THUMB
-
-    @thumbnail.setter
-    def thumbnail(self, value):
-        self._THUMB = value
-
-    @property
-    def temperature(self):
-        return self._TEMPERATURE
-
-    @temperature.setter
-    def temperature(self, value):
-        self._TEMPERATURE = value
-
-    @property
-    def battery(self):
-        return self._BATTERY
-
-    @battery.setter
-    def battery(self, value):
-        self._BATTERY = value
-
-    @property
-    def notifications(self):
-        return self._NOTIFICATIONS
-
-    @notifications.setter
-    def notifications(self, value):
-        self._NOTIFICATIONS = value
-
-    @property
-    def image_link(self):
-        return self._IMAGE_LINK
-
-    @image_link.setter
-    def image_link(self, value):
-        self._IMAGE_LINK = value
-
-    @property
-    def arm_link(self):
-        return self._ARM_LINK
-
-    @arm_link.setter
-    def arm_link(self, value):
-        self._ARM_LINK = value
-
-    @property
-    def header(self):
-        return self._HEADER
-
-    @header.setter
-    def header(self, value):
-        self._HEADER = value
-
-    @property
-    def motion(self):
-        return self._MOTION
-
-    @motion.setter
-    def motion(self, value):
-        """Sets link to last motion and timestamp"""
-        self._MOTION = value
-
-    def snap_picture(self):
-        """Takes a picture with camera to create a new thumbnail"""
-        _request(self._IMAGE_LINK, headers=self._HEADER, type='post')
-
-    def set_motion_detect(self, enable):
-        """Sets motion detection"""
-        url = self._ARM_LINK
-        if enable:
-            _request(url + 'enable', headers=self._HEADER, type='post')
-        else:
-            _request(url + 'disable', headers=self._HEADER, type='post')
-
-    def update(self, values):
-        self._NAME = values['name']
-        self._STATUS = values['armed']
-        self._THUMB = BASE_URL + values['thumbnail'] + '.jpg'
-        self._CLIP = BASE_URL + values['thumbnail'] + '.mp4'
-        self._TEMPERATURE = values['temp']
-        self._BATTERY = values['battery']
-        self._NOTIFICATIONS = values['notifications']
-
-    def image_refresh(self):
-        url = BASE_URL + '/homescreen'
-        response = _request(url, headers=self._HEADER, type='get')['devices']
-        for element in response:
-            try:
-                if str(element['device_id']) == self._ID:
-                    self._THUMB = BASE_URL + element['thumbnail'] + '.jpg'
-                    return self._THUMB
-            except KeyError:
-                pass
-        return None
-
-    def image_to_file(self, path):
-        thumb = self.image_refresh()
-        response = _request(thumb, headers=self._HEADER, stream=True, json=False)
-        if response.status_code == 200:
-            with open(path, 'wb') as f:
-                for chunk in response:
-                    f.write(chunk)
-
-
-class Blink(object):
-    """Class to initialize communication and sync module"""
-    def __init__(self, username=None, password=None):
-        """Constructor for class"""
-        self._username = username
-        self._password = password
-        self._TOKEN = None
-        self._AUTH_HEADER = None
-        self._NETWORKID = None
-        self._ACCOUNTID = None
-        self._REGION = None
-        self._REGION_ID = None
-        self._HOST = None
-        self._EVENTS = []
-        self._CAMERAS = {}
-        self._IDLOOKUP = {}
-
-    @property
-    def cameras(self):
-        return self._CAMERAS
-
-    @property
-    def camera_thumbs(self):
-        self.refresh()
-        data = {}
-        for name, camera in self._CAMERAS.items():
-            data[name] = camera.thumbnail
-
-        return data
-
-    @property
-    def id_table(self):
-        return self._IDLOOKUP
-
-    @property
-    def network_id(self):
-        return self._NETWORKID
-
-    @property
-    def account_id(self):
-        return self._ACCOUNTID
-
-    @property
-    def region(self):
-        return self._REGION
-
-    @property
-    def region_id(self):
-        return self._REGION_ID
-
-    @property
-    def events(self):
-        """Gets all events on server"""
-        url = BASE_URL + '/events/network/' + self._NETWORKID
-        headers = self._AUTH_HEADER
-        self._EVENTS = _request(url, headers=headers, type='get')['event']
-        return self._EVENTS
-
-    @property
-    def online(self):
-        """Returns True or False depending on if sync module is online/offline"""
-        url = BASE_URL + 'network/' + self._NETWORKID + '/syncmodules'
-        headers = self._AUTH_HEADER
-        online_dict = {'online': True, 'offline': False}
-        return online_dict[_request(url, headers=headers, type='get')['syncmodule']['status']]
-
-    def last_motion(self):
-        """Finds last motion of each camera"""
-        recent = self.events
-        for element in recent:
-            try:
-                camera_id = str(element['camera_id'])
-                camera_name = self._IDLOOKUP[camera_id]
-                camera = self._CAMERAS[camera_name]
-                if element['type'] == 'motion':
-                    url = BASE_URL + element['video_url']
-                    camera.motion = {'video': url, 'image': url[:-3] + 'jpg', 'time': element['created_at']}
-            except KeyError:
-                pass
-
-    @property
-    def arm(self):
-        """Returns status of sync module: armed/disarmed"""
-        return self.get_summary()['network']['armed']
-
-    @arm.setter
-    def arm(self, value):
-        """Arms or disarms system.  Arms/disarms all if camera not named"""
-        if value:
-            value_to_append = 'arm'
-        else:
-            value_to_append = 'disarm'
-        url = BASE_URL + '/network/' + self._NETWORKID + '/' + value_to_append
-        _request(url, headers=self._AUTH_HEADER, type='post')
-
-    def refresh(self):
-        """Gets all blink cameras and pulls their most recent status"""
-        response = self.get_summary()['devices']
-
-        for name, camera in self._CAMERAS.items():
-            for element in response:
-                try:
-                    if str(element['device_id']) == camera.id:
-                        camera.update(element)
-                except KeyError:
-                    pass
-
-    def get_summary(self):
-        """Gets a full summary of device information"""
-        url = BASE_URL + '/homescreen'
-        headers = self._AUTH_HEADER
-
-        if self._AUTH_HEADER is None:
-            raise BlinkException(0, "Authentication header incorrect.  Are you sure you logged in and received your token?")
-
-        return _request(url, headers=headers, type='get')
-
-    def get_cameras(self):
-        """Finds and creates cameras"""
-        response = self.get_summary()['devices']
-        for element in response:
-            if 'device_type' in element.keys():
-                if element['device_type'] == 'camera':
-                    # Add region to config
-                    element['region_id'] = self._REGION_ID
-                    device = BlinkCamera(element)
-                    self._CAMERAS[device.name] = device
-                    self._IDLOOKUP[device.id] = device.name
-
-    def set_links(self):
-        """Sets access links and required headers for each camera in system"""
-        for name, camera in self._CAMERAS.items():
-            image_url = BASE_URL + '/network/' + self._NETWORKID + '/camera/' + camera.id + '/thumbnail'
-            arm_url = BASE_URL + '/network/' + self._NETWORKID + '/camera/' + camera.id + '/'
-            camera.image_link = image_url
-            camera.arm_link = arm_url
-            camera.header = self._AUTH_HEADER
-
-    def setup_system(self):
-        """Method logs in and sets auth token and network ids for future requests"""
-        if self._username is None or self._password is None:
-            raise BlinkAuthenticationException(3, "Cannot authenticate since either password or username has not been set")
-
-        self.get_auth_token()
-        self.get_ids()
-        self.get_cameras()
-        self.set_links()
-
-    def login(self):
-        """Prompts user for username and password"""
-        self._username = input("Username:")
-        self._password = getpass.getpass("Password:")
-
-    def get_auth_token(self):
-        """Retrieves the authentication token from Blink"""
-        if not isinstance(self._username, str):
-            raise BlinkAuthenticationException(0, "Username must be a string")
-        if not isinstance(self._password, str):
-            raise BlinkAuthenticationException(0, "Password must be a string")
-
-        headers = {'Host': DEFAULT_URL,
-                   'Content-Type': 'application/json'
-                   }
-        data = json.dumps({
-            "email": self._username,
-            "password": self._password,
-            "client_specifier": "iPhone 9.2 | 2.2 | 222"
-        })
-        response = _request(LOGIN_URL, headers=headers, data=data, type='post')
-        self._TOKEN = response['authtoken']['authtoken']
-        (self._REGION_ID, self._REGION), = response['region'].items()
-        self._HOST = self._REGION + '.' + BLINK_URL
-        self._AUTH_HEADER = {'Host': self._HOST,
-                             'TOKEN_AUTH': self._TOKEN
-                             }
-
-    def get_ids(self):
-        """Sets the network ID and Account ID"""
-        url = BASE_URL + '/networks'
-        headers = self._AUTH_HEADER
-
-        if self._AUTH_HEADER is None:
-            raise BlinkException(0, "Authentication header incorrect.  Are you sure you logged in and received your token?")
-
-        response = _request(url, headers=headers, type='get')
-        self._NETWORKID = str(response['networks'][0]['id'])
-        self._ACCOUNTID = str(response['networks'][0]['account_id'])

blinkpy/__init__.py

@@ -0,0 +1 @@
+"""Init file for blinkpy."""

blinkpy/api.py

@@ -0,0 +1,258 @@
+"""Implements known blink API calls."""
+
+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.constants import DEFAULT_URL
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def request_login(blink, url, username, password, is_retry=False):
+    """
+    Login request.
+
+    :param blink: Blink instance.
+    :param url: Login url.
+    :param username: Blink username.
+    :param password: Blink password.
+    :param is_retry: Is this part of a re-authorization attempt?
+    """
+    headers = {
+        'Host': DEFAULT_URL,
+        'Content-Type': 'application/json'
+    }
+    data = dumps({
+        'email': username,
+        'password': password,
+        'client_specifier': 'iPhone 9.2 | 2.2 | 222'
+    })
+    return http_req(blink, url=url, headers=headers, data=data,
+                    json_resp=False, reqtype='post', is_retry=is_retry)
+
+
+def request_networks(blink):
+    """Request all networks information."""
+    url = "{}/networks".format(blink.urls.base_url)
+    return http_get(blink, url)
+
+
+def request_network_status(blink, network):
+    """
+    Request network information.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    """
+    url = "{}/network/{}".format(blink.urls.base_url, network)
+    return http_get(blink, url)
+
+
+def request_syncmodule(blink, network):
+    """
+    Request sync module info.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    """
+    url = "{}/network/{}/syncmodules".format(blink.urls.base_url, network)
+    return http_get(blink, url)
+
+
+def request_system_arm(blink, network):
+    """
+    Arm system.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    """
+    url = "{}/network/{}/arm".format(blink.urls.base_url, network)
+    return http_post(blink, url)
+
+
+def request_system_disarm(blink, network):
+    """
+    Disarm system.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    """
+    url = "{}/network/{}/disarm".format(blink.urls.base_url, network)
+    return http_post(blink, url)
+
+
+def request_command_status(blink, network, command_id):
+    """
+    Request command status.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    :param command_id: Command id to check.
+    """
+    url = "{}/network/{}/command/{}".format(blink.urls.base_url,
+                                            network,
+                                            command_id)
+    return http_get(blink, url)
+
+
+def request_homescreen(blink):
+    """Request homescreen info."""
+    url = "{}/homescreen".format(blink.urls.base_url)
+    return http_get(blink, url)
+
+
+def request_sync_events(blink, network):
+    """
+    Request events from sync module.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    """
+    url = "{}/events/network/{}".format(blink.urls.base_url, network)
+    return http_get(blink, url)
+
+
+def request_new_image(blink, network, camera_id):
+    """
+    Request to capture new thumbnail for camera.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    :param camera_id: Camera ID of camera to request new image from.
+    """
+    url = "{}/network/{}/camera/{}/thumbnail".format(blink.urls.base_url,
+                                                     network,
+                                                     camera_id)
+    return http_post(blink, url)
+
+
+def request_new_video(blink, network, camera_id):
+    """
+    Request to capture new video clip.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    :param camera_id: Camera ID of camera to request new video from.
+    """
+    url = "{}/network/{}/camera/{}/clip".format(blink.urls.base_url,
+                                                network,
+                                                camera_id)
+    return http_post(blink, url)
+
+
+def request_video_count(blink):
+    """Request total video count."""
+    url = "{}/api/v2/videos/count".format(blink.urls.base_url)
+    return http_get(blink, url)
+
+
+def request_videos(blink, time=None, page=0):
+    """
+    Perform a request for videos.
+
+    :param blink: Blink instance.
+    :param time: Get videos since this time.  In epoch seconds.
+    :param page: Page number to get videos from.
+    """
+    timestamp = get_time(time)
+    url = "{}/api/v2/videos/changed?since={}&page={}".format(
+        blink.urls.base_url, timestamp, page)
+    return http_get(blink, url)
+
+
+def request_cameras(blink, network):
+    """
+    Request all camera information.
+
+    :param Blink: Blink instance.
+    :param network: Sync module network id.
+    """
+    url = "{}/network/{}/cameras".format(blink.urls.base_url, network)
+    return http_get(blink, url)
+
+
+def request_camera_info(blink, network, camera_id):
+    """
+    Request camera info for one camera.
+
+    :param blink: Blink instance.
+    :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)
+    return http_get(blink, url)
+
+
+def request_camera_sensors(blink, network, camera_id):
+    """
+    Request camera sensor info for one camera.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    :param camera_id: Camera ID of camera to request sesnor info from.
+    """
+    url = "{}/network/{}/camera/{}/signals".format(blink.urls.base_url,
+                                                   network,
+                                                   camera_id)
+    return http_get(blink, url)
+
+
+def request_motion_detection_enable(blink, network, camera_id):
+    """
+    Enable motion detection for a camera.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    :param camera_id: Camera ID of camera to enable.
+    """
+    url = "{}/network/{}/camera/{}/enable".format(blink.urls.base_url,
+                                                  network,
+                                                  camera_id)
+    return http_post(blink, url)
+
+
+def request_motion_detection_disable(blink, network, camera_id):
+    """Disable motion detection for a camera.
+
+    :param blink: Blink instance.
+    :param network: Sync module network id.
+    :param camera_id: Camera ID of camera to disable.
+    """
+    url = "{}/network/{}/camera/{}/disable".format(blink.urls.base_url,
+                                                   network,
+                                                   camera_id)
+    return http_post(blink, url)
+
+
+def http_get(blink, url, stream=False, json=True, is_retry=False):
+    """
+    Perform an http get request.
+
+    :param url: URL to perform get request.
+    :param stream: Stream response? True/FALSE
+    :param json: Return json response? TRUE/False
+    :param is_retry: Is this part of a re-auth attempt?
+    """
+    if blink.auth_header is None:
+        raise BlinkException(ERROR.AUTH_TOKEN)
+    _LOGGER.debug("Making GET request to %s", url)
+    return http_req(blink, url=url, headers=blink.auth_header,
+                    reqtype='get', stream=stream, json_resp=json,
+                    is_retry=is_retry)
+
+
+def http_post(blink, url, is_retry=False):
+    """
+    Perform an http post request.
+
+    :param url: URL to perfom post request.
+    :param is_retry: Is this part of a re-auth attempt?
+    """
+    if blink.auth_header is None:
+        raise BlinkException(ERROR.AUTH_TOKEN)
+    _LOGGER.debug("Making POST request to %s", url)
+    return http_req(blink, url=url, headers=blink.auth_header,
+                    reqtype='post', is_retry=is_retry)

blinkpy/blinkpy.py

@@ -0,0 +1,303 @@
+# -*- coding: utf-8 -*-
+"""
+blinkpy is an unofficial api for the Blink security camera system.
+
+repo url: https://github.com/fronzbot/blinkpy
+
+Original protocol hacking by MattTW :
+https://github.com/MattTW/BlinkMonitorProtocol
+
+Published under the MIT license - See LICENSE file for more details.
+"Blink Wire-Free HS Home Monitoring & Alert Systems" is a trademark
+owned by Immedia Inc., see www.blinkforhome.com for more information.
+blinkpy is in no way affiliated with Blink, nor Immedia Inc.
+"""
+
+import os.path
+import time
+import getpass
+import logging
+from shutil import copyfileobj
+
+from requests.structures import CaseInsensitiveDict
+from dateutil.parser import parse
+
+from blinkpy import api
+from blinkpy.sync_module import BlinkSyncModule
+from blinkpy.helpers import errors as ERROR
+from blinkpy.helpers import log
+from blinkpy.helpers.util import (
+    create_session, merge_dicts, get_time, BlinkURLHandler,
+    BlinkAuthenticationException)
+from blinkpy.helpers.constants import (
+    BLINK_URL, LOGIN_URL, LOGIN_BACKUP_URL)
+from blinkpy.helpers.constants import __version__
+
+REFRESH_RATE = 30
+
+_LOGGER = log.create_logger('blinkpy')
+
+
+class Blink():
+    """Class to initialize communication."""
+
+    def __init__(self, username=None, password=None,
+                 refresh_rate=REFRESH_RATE, loglevel=logging.INFO,
+                 allow_duplicate_logs=True):
+        """
+        Initialize Blink system.
+
+        :param username: Blink username (usually email address)
+        :param password: Blink password
+        :param refresh_rate: Refresh rate of blink information.
+                             Defaults to 15 (seconds)
+        :param loglevel: Sets the log level for the logger.
+        :param allow_duplicate_logs: Set to 'False' to only allow a log
+                                     message to be logged once.
+        """
+        self._username = username
+        self._password = password
+        self._token = None
+        self._auth_header = None
+        self._host = None
+        self.account_id = None
+        self.network_ids = []
+        self.urls = None
+        self.sync = CaseInsensitiveDict({})
+        self.region = None
+        self.region_id = None
+        self.last_refresh = None
+        self.refresh_rate = refresh_rate
+        self.session = create_session()
+        self.networks = []
+        self.cameras = CaseInsensitiveDict({})
+        self.video_list = CaseInsensitiveDict({})
+        self._login_url = LOGIN_URL
+        self.version = __version__
+        self.allow_duplicate_logs = allow_duplicate_logs
+
+        self.loglevel = loglevel
+        self._reset_logger()
+
+    @property
+    def auth_header(self):
+        """Return the authentication header."""
+        return self._auth_header
+
+    def start(self):
+        """
+        Perform full system setup.
+
+        Method logs in and sets auth token, urls, and ids for future requests.
+        Essentially this is just a wrapper function for ease of use.
+        """
+        self._reset_logger()
+
+        if self._username is None or self._password is None:
+            if not self.login():
+                return
+        elif not self.get_auth_token():
+            return
+
+        networks = self.get_ids()
+        for network_name, network_id in networks.items():
+            sync_module = BlinkSyncModule(self, network_name, network_id)
+            sync_module.start()
+            self.sync[network_name] = sync_module
+        self.cameras = self.merge_cameras()
+
+    def login(self):
+        """Prompt user for username and password."""
+        self._username = input("Username:")
+        self._password = getpass.getpass("Password:")
+        if self.get_auth_token():
+            _LOGGER.info("Login successful!")
+            return True
+        _LOGGER.warning("Unable to login with %s.", self._username)
+        return False
+
+    def get_auth_token(self, is_retry=False):
+        """Retrieve the authentication token from Blink."""
+        if not isinstance(self._username, str):
+            raise BlinkAuthenticationException(ERROR.USERNAME)
+        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)
+            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']
+        self.networks = response['networks']
+
+        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 get_ids(self):
+        """Set the network ID and Account ID."""
+        response = api.request_networks(self)
+        all_networks = []
+        network_dict = {}
+        for network, status in self.networks.items():
+            if status['onboarded']:
+                all_networks.append('{}'.format(network))
+                network_dict[status['name']] = network
+
+        # For the first onboarded network we find, grab the account id
+        for resp in response['networks']:
+            if str(resp['id']) in all_networks:
+                self.account_id = resp['account_id']
+                break
+
+        self.network_ids = all_networks
+        return network_dict
+
+    def refresh(self, force_cache=False):
+        """
+        Perform a system refresh.
+
+        :param force_cache: Force an update of the camera cache
+        """
+        if self.check_if_ok_to_update() or force_cache:
+            for sync_name, sync_module in self.sync.items():
+                _LOGGER.debug("Attempting refresh of sync %s", sync_name)
+                sync_module.refresh(force_cache=force_cache)
+            if not force_cache:
+                # Prevents rapid clearing of motion detect property
+                self.last_refresh = int(time.time())
+
+    def check_if_ok_to_update(self):
+        """Check if it is ok to perform an http request."""
+        current_time = int(time.time())
+        last_refresh = self.last_refresh
+        if last_refresh is None:
+            last_refresh = 0
+        if current_time >= (last_refresh + self.refresh_rate):
+            return True
+        return False
+
+    def merge_cameras(self):
+        """Merge all sync camera dicts into one."""
+        combined = CaseInsensitiveDict({})
+        for sync in self.sync:
+            combined = merge_dicts(combined, self.sync[sync].cameras)
+        return combined
+
+    def download_videos(self, path, since=None, camera='all', stop=10):
+        """
+        Download all videos from server since specified time.
+
+        :param path: Path to write files.  /path/<cameraname>_<recorddate>.mp4
+        :param since: Date and time to get videos from.
+                      Ex: "2018/07/28 12:33:00" to retrieve videos since
+                           July 28th 2018 at 12:33:00
+        :param camera: Camera name to retrieve.  Defaults to "all".
+                       Use a list for multiple cameras.
+        :param stop: Page to stop on (~25 items per page. Default page 10).
+        """
+        if since is None:
+            since_epochs = self.last_refresh
+        else:
+            parsed_datetime = parse(since, fuzzy=True)
+            since_epochs = parsed_datetime.timestamp()
+
+        formatted_date = get_time(time_to_convert=since_epochs)
+        _LOGGER.info("Retrieving videos since %s", formatted_date)
+
+        if not isinstance(camera, list):
+            camera = [camera]
+
+        for page in range(1, stop):
+            response = api.request_videos(self, time=since_epochs, page=page)
+            _LOGGER.debug("Processing page %s", page)
+            try:
+                result = response['videos']
+                if not result:
+                    raise IndexError
+            except (KeyError, IndexError):
+                _LOGGER.info("No videos found on page %s. Exiting.", page)
+                break
+
+            self._parse_downloaded_items(result, camera, path)
+
+    def _parse_downloaded_items(self, result, camera, path):
+        """Parse downloaded videos."""
+        for item in result:
+            try:
+                created_at = item['created_at']
+                camera_name = item['camera_name']
+                is_deleted = item['deleted']
+                address = item['address']
+            except KeyError:
+                _LOGGER.info("Missing clip information, skipping...")
+                continue
+
+            if camera_name not in camera and 'all' not in camera:
+                _LOGGER.debug("Skipping videos for %s.", camera_name)
+                continue
+
+            if is_deleted:
+                _LOGGER.debug("%s: %s is marked as deleted.",
+                              camera_name,
+                              address)
+                continue
+
+            clip_address = "{}{}".format(self.urls.base_url, address)
+            filename = "{}_{}.mp4".format(camera_name, created_at)
+            filename = os.path.join(path, filename)
+
+            if os.path.isfile(filename):
+                _LOGGER.info("%s already exists, skipping...", filename)
+                continue
+
+            response = api.http_get(self, url=clip_address,
+                                    stream=True, json=False)
+            with open(filename, 'wb') as vidfile:
+                copyfileobj(response.raw, vidfile)
+
+            _LOGGER.info("Downloaded video to %s", filename)
+
+    # pylint: disable=no-self-use
+    def _reset_logger(self):
+        """Reset the log handler."""
+        for handler in _LOGGER.handlers:
+            _LOGGER.removeHandler(handler)
+            handler.close()
+        _LOGGER.setLevel(self.loglevel)
+        if self.allow_duplicate_logs:
+            handler = logging.StreamHandler()
+            handler.setFormatter(log.log_formatter())
+        else:
+            handler = log.RepeatLogHandler()
+            handler.setFormatter(log.log_formatter())
+
+        _LOGGER.addHandler(handler)

blinkpy/camera.py

@@ -0,0 +1,208 @@
+"""Defines Blink cameras."""
+
+from shutil import copyfileobj
+import logging
+from blinkpy import api
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class BlinkCamera():
+    """Class to initialize individual camera."""
+
+    def __init__(self, sync):
+        """Initiailize BlinkCamera."""
+        self.sync = sync
+        self.name = None
+        self.camera_id = None
+        self.network_id = None
+        self.thumbnail = None
+        self.serial = None
+        self.motion_enabled = None
+        self.battery_voltage = None
+        self.clip = None
+        self.temperature = None
+        self.temperature_calibrated = None
+        self.battery_state = None
+        self.motion_detected = None
+        self.wifi_strength = None
+        self.last_record = None
+        self._cached_image = None
+        self._cached_video = None
+
+    @property
+    def attributes(self):
+        """Return dictionary of all camera attributes."""
+        attributes = {
+            'name': self.name,
+            'camera_id': self.camera_id,
+            'serial': self.serial,
+            'temperature': self.temperature,
+            'temperature_c': self.temperature_c,
+            'temperature_calibrated': self.temperature_calibrated,
+            'battery': self.battery,
+            'thumbnail': self.thumbnail,
+            'video': self.clip,
+            'motion_enabled': self.motion_enabled,
+            'motion_detected': self.motion_detected,
+            'wifi_strength': self.wifi_strength,
+            'network_id': self.sync.network_id,
+            'sync_module': self.sync.name,
+            'last_record': self.last_record
+        }
+        return attributes
+
+    @property
+    def battery(self):
+        """Return battery level as percentage."""
+        return round(self.battery_voltage / 180 * 100)
+
+    @property
+    def temperature_c(self):
+        """Return temperature in celcius."""
+        return round((self.temperature - 32) / 9.0 * 5.0, 1)
+
+    @property
+    def image_from_cache(self):
+        """Return the most recently cached image."""
+        if self._cached_image:
+            return self._cached_image
+        return None
+
+    @property
+    def video_from_cache(self):
+        """Return the most recently cached video."""
+        if self._cached_video:
+            return self._cached_video
+        return None
+
+    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)
+
+    def set_motion_detect(self, enable):
+        """Set motion detection."""
+        if enable:
+            return api.request_motion_detection_enable(self.sync.blink,
+                                                       self.network_id,
+                                                       self.camera_id)
+        return api.request_motion_detection_disable(self.sync.blink,
+                                                    self.network_id,
+                                                    self.camera_id)
+
+    def update(self, config, force_cache=False):
+        """Update camera info."""
+        self.name = config['name']
+        self.camera_id = str(config['camera_id'])
+        self.network_id = str(config['network_id'])
+        self.serial = config['serial']
+        self.motion_enabled = config['enabled']
+        self.battery_voltage = config['battery_voltage']
+        self.battery_state = config['battery_state']
+        self.temperature = config['temperature']
+        self.wifi_strength = config['wifi_strength']
+
+        # Retrieve calibrated temperature from special endpoint
+        resp = api.request_camera_sensors(self.sync.blink,
+                                          self.network_id,
+                                          self.camera_id)
+        try:
+            self.temperature_calibrated = resp['temp']
+        except KeyError:
+            self.temperature_calibrated = self.temperature
+            _LOGGER.warning("Could not retrieve calibrated temperature.")
+
+        # Check if thumbnail exists in config, if not try to
+        # get it from the homescreen info in teh sync module
+        # otherwise set it to None and log an error
+        new_thumbnail = None
+        if config['thumbnail']:
+            thumb_addr = config['thumbnail']
+        else:
+            thumb_addr = self.get_thumb_from_homescreen()
+
+        if thumb_addr is not None:
+            new_thumbnail = "{}{}.jpg".format(self.sync.urls.base_url,
+                                              thumb_addr)
+
+        try:
+            self.motion_detected = self.sync.motion[self.name]
+        except KeyError:
+            self.motion_detected = False
+
+        clip_addr = None
+        if self.name in self.sync.last_record:
+            clip_addr = self.sync.last_record[self.name]['clip']
+            self.last_record = self.sync.last_record[self.name]['time']
+            self.clip = "{}{}".format(self.sync.urls.base_url,
+                                      clip_addr)
+
+        # If the thumbnail or clip have changed, update the cache
+        update_cached_image = False
+        if new_thumbnail != self.thumbnail or self._cached_image is None:
+            update_cached_image = True
+        self.thumbnail = new_thumbnail
+
+        update_cached_video = False
+        if self._cached_video is None or self.motion_detected:
+            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)
+        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)
+
+    def image_to_file(self, path):
+        """
+        Write image to file.
+
+        :param path: Path to write file
+        """
+        _LOGGER.debug("Writing image from %s to %s", self.name, path)
+        response = self._cached_image
+        if response.status_code == 200:
+            with open(path, 'wb') as imgfile:
+                copyfileobj(response.raw, imgfile)
+        else:
+            _LOGGER.error("Cannot write image to file, response %s",
+                          response.status_code,
+                          exc_info=True)
+
+    def video_to_file(self, path):
+        """Write video to file.
+
+        :param path: Path to write file
+        """
+        _LOGGER.debug("Writing video from %s to %s", self.name, path)
+        response = self._cached_video
+        if response is None:
+            _LOGGER.error("No saved video exist for %s.",
+                          self.name,
+                          exc_info=True)
+            return
+        with open(path, 'wb') as vidfile:
+            copyfileobj(response.raw, vidfile)
+
+    def get_thumb_from_homescreen(self):
+        """Retrieve thumbnail from homescreen."""
+        for device in self.sync.homescreen['devices']:
+            try:
+                device_type = device['device_type']
+                device_name = device['name']
+                device_thumb = device['thumbnail']
+                if device_type == 'camera' and device_name == self.name:
+                    return device_thumb
+            except KeyError:
+                pass
+        _LOGGER.error("Could not find thumbnail for camera %s",
+                      self.name,
+                      exc_info=True)
+        return None

blinkpy/helpers/__init__.py

@@ -0,0 +1 @@
+"""Init file for blinkpy helper functions."""

blinkpy/helpers/constants.py

@@ -0,0 +1,61 @@
+"""Generates constants for use in blinkpy."""
+
+import os
+
+MAJOR_VERSION = 0
+MINOR_VERSION = 12
+PATCH_VERSION = 0
+
+__version__ = '{}.{}.{}'.format(MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION)
+
+REQUIRED_PYTHON_VER = (3, 5, 3)
+
+PROJECT_NAME = 'blinkpy'
+PROJECT_PACKAGE_NAME = 'blinkpy'
+PROJECT_LICENSE = 'MIT'
+PROJECT_AUTHOR = 'Kevin Fronczak'
+PROJECT_COPYRIGHT = ' 2017, {}'.format(PROJECT_AUTHOR)
+PROJECT_URL = 'https://github.com/fronzbot/blinkpy'
+PROJECT_EMAIL = 'kfronczak@gmail.com'
+PROJECT_DESCRIPTION = ('A Blink camera Python library '
+                       'running on Python 3.')
+PROJECT_LONG_DESCRIPTION = ('blinkpy is an open-source '
+                            'unofficial API for the Blink Camera '
+                            'system with the intention for easy '
+                            'integration into various home '
+                            'automation platforms.')
+if os.path.exists('README.rst'):
+    PROJECT_LONG_DESCRIPTION = open('README.rst').read()
+PROJECT_CLASSIFIERS = [
+    'Intended Audience :: Developers',
+    'License :: OSI Approved :: MIT License',
+    'Operating System :: OS Independent',
+    'Programming Language :: Python :: 3.5',
+    'Programming Language :: Python :: 3.6',
+    'Programming Language :: Python :: 3.7',
+    'Topic :: Home Automation'
+]
+
+PROJECT_GITHUB_USERNAME = 'fronzbot'
+PROJECT_GITHUB_REPOSITORY = 'blinkpy'
+
+PYPI_URL = 'https://pypi.python.org/pypi/{}'.format(PROJECT_PACKAGE_NAME)
+
+'''
+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_BACKUP_URL = "https://{}.{}/login".format('rest.piri', BLINK_URL)
+
+'''
+Dictionaries
+'''
+ONLINE = {'online': True, 'offline': False}
+
+'''
+OTHER
+'''
+TIMESTAMP_FORMAT = '%Y-%m-%dT%H:%M:%S%Z'

blinkpy/helpers/errors.py

@@ -0,0 +1,13 @@
+"""Module to define error types."""
+
+USERNAME = (0, "Username must be a string")
+PASSWORD = (1, "Password must be a string")
+AUTHENTICATE = (
+    2,
+    "Cannot authenticate since either password or username has not been set"
+)
+AUTH_TOKEN = (
+    3,
+    "Authentication header incorrect.  Are you sure you received your token?"
+)
+REQUEST = (4, "Cannot perform request (get/post type incorrect)")

blinkpy/helpers/log.py

@@ -0,0 +1,33 @@
+"""Module for blinkpy logging."""
+import logging
+
+
+def create_logger(name):
+    """Create a logger instance."""
+    handler = RepeatLogHandler()
+    handler.setFormatter(log_formatter())
+    logger = logging.getLogger(name)
+    logger.setLevel(logging.DEBUG)
+    logger.addHandler(handler)
+    return logger
+
+
+def log_formatter():
+    """Create log formatter."""
+    fmt = "%(asctime)s %(levelname)s [%(name)s] %(message)s"
+    return logging.Formatter(fmt)
+
+
+class RepeatLogHandler(logging.StreamHandler):
+    """Log handler for repeat entries."""
+
+    def __init__(self):
+        """Initialize repeat log handler."""
+        super().__init__()
+        self.log_record = set()
+
+    def emit(self, record):
+        """Ensure we only log a message once."""
+        if record.msg not in self.log_record:
+            self.log_record.add(record.msg)
+            super().emit(record)

blinkpy/helpers/util.py

@@ -0,0 +1,123 @@
+"""Useful functions for blinkpy."""
+
+import logging
+import time
+from requests import Request, Session, exceptions
+from blinkpy.helpers.constants import BLINK_URL, TIMESTAMP_FORMAT
+import blinkpy.helpers.errors as ERROR
+
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def get_time(time_to_convert=None):
+    """Create blink-compatible timestamp."""
+    if time_to_convert is None:
+        time_to_convert = time.time()
+    return time.strftime(TIMESTAMP_FORMAT, time.localtime(time_to_convert))
+
+
+def merge_dicts(dict_a, dict_b):
+    """Merge two dictionaries into one."""
+    duplicates = [val for val in dict_a if val in dict_b]
+    if duplicates:
+        _LOGGER.warning(("Duplicates found during merge: %s. "
+                         "Renaming is recommended."), duplicates)
+    return {**dict_a, **dict_b}
+
+
+def create_session():
+    """Create a session for blink communication."""
+    sess = Session()
+    return sess
+
+
+def attempt_reauthorization(blink):
+    """Attempt to refresh auth token and links."""
+    _LOGGER.info("Auth token expired, attempting reauthorization.")
+    headers = blink.get_auth_token(is_retry=True)
+    return headers
+
+
+def http_req(blink, url='http://example.com', data=None, headers=None,
+             reqtype='get', stream=False, json_resp=True, is_retry=False):
+    """
+    Perform server requests and check if reauthorization neccessary.
+
+    :param blink: Blink instance
+    :param url: URL to perform request
+    :param data: Data to send (default: None)
+    :param headers: Headers to send (default: None)
+    :param reqtype: Can be 'get' or 'post' (default: 'get')
+    :param stream: Stream response? True/FALSE
+    :param json_resp: Return JSON response? TRUE/False
+    :param is_retry: Is this a retry attempt? True/FALSE
+    """
+    if reqtype == 'post':
+        req = Request('POST', url, headers=headers, data=data)
+    elif reqtype == 'get':
+        req = Request('GET', url, headers=headers)
+    else:
+        _LOGGER.error("Invalid request type: %s", reqtype)
+        raise BlinkException(ERROR.REQUEST)
+
+    prepped = req.prepare()
+
+    try:
+        response = blink.session.send(prepped, stream=stream, timeout=10)
+        if json_resp and 'code' in response.json():
+            if is_retry:
+                _LOGGER.error("Cannot obtain new token for server auth.")
+                return None
+            else:
+                headers = attempt_reauthorization(blink)
+                if not headers:
+                    raise exceptions.ConnectionError
+                return http_req(blink, url=url, data=data, headers=headers,
+                                reqtype=reqtype, stream=stream,
+                                json_resp=json_resp, is_retry=True)
+    except (exceptions.ConnectionError, exceptions.Timeout):
+        _LOGGER.info("Cannot connect to server with url %s.", url)
+        if not is_retry:
+            headers = attempt_reauthorization(blink)
+            return http_req(blink, url=url, data=data, headers=headers,
+                            reqtype=reqtype, stream=stream,
+                            json_resp=json_resp, is_retry=True)
+        _LOGGER.error("Endpoint %s failed. Possible issue with Blink servers.",
+                      url)
+        return None
+
+    if json_resp:
+        return response.json()
+
+    return response
+
+
+class BlinkException(Exception):
+    """Class to throw general blink exception."""
+
+    def __init__(self, errcode):
+        """Initialize BlinkException."""
+        super().__init__()
+        self.errid = errcode[0]
+        self.message = errcode[1]
+
+
+class BlinkAuthenticationException(BlinkException):
+    """Class to throw authentication exception."""
+
+    pass
+
+
+class BlinkURLHandler():
+    """Class that handles Blink URLS."""
+
+    def __init__(self, region_id):
+        """Initialize the urls."""
+        self.base_url = "https://rest.{}.{}".format(region_id, BLINK_URL)
+        self.home_url = "{}/homescreen".format(self.base_url)
+        self.event_url = "{}/events/network".format(self.base_url)
+        self.network_url = "{}/network".format(self.base_url)
+        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)

blinkpy/sync_module.py

@@ -0,0 +1,171 @@
+"""Defines a sync module for Blink."""
+
+import logging
+
+from requests.structures import CaseInsensitiveDict
+from blinkpy import api
+from blinkpy.camera import BlinkCamera
+from blinkpy.helpers.constants import ONLINE
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class BlinkSyncModule():
+    """Class to initialize sync module."""
+
+    def __init__(self, blink, network_name, network_id):
+        """
+        Initialize Blink sync module.
+
+        :param blink: Blink class instantiation
+        """
+        self.blink = blink
+        self._auth_header = blink.auth_header
+        self.network_id = network_id
+        self.region = blink.region
+        self.region_id = blink.region_id
+        self.name = network_name
+        self.serial = None
+        self.status = None
+        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 = {}
+
+    @property
+    def attributes(self):
+        """Return sync attributes."""
+        attr = {
+            'name': self.name,
+            'id': self.sync_id,
+            'network_id': self.network_id,
+            'serial': self.serial,
+            'status': self.status,
+            'region': self.region,
+            'region_id': self.region_id,
+        }
+        return attr
+
+    @property
+    def urls(self):
+        """Return device urls."""
+        return self.blink.urls
+
+    @property
+    def online(self):
+        """Return boolean system online status."""
+        return ONLINE[self.status]
+
+    @property
+    def arm(self):
+        """Return status of sync module: armed/disarmed."""
+        return self.network_info['network']['armed']
+
+    @arm.setter
+    def arm(self, value):
+        """Arm or disarm system."""
+        if value:
+            return api.request_system_arm(self.blink, self.network_id)
+
+        return api.request_system_disarm(self.blink, self.network_id)
+
+    def start(self):
+        """Initialize the system."""
+        response = api.request_syncmodule(self.blink, self.network_id)
+        try:
+            self.summary = response['syncmodule']
+            self.network_id = self.summary['network_id']
+        except (TypeError, KeyError):
+            _LOGGER.error(("Could not retrieve sync module information "
+                           "with response: %s"), response, exc_info=True)
+            return False
+
+        try:
+            self.sync_id = self.summary['id']
+            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)
+
+        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)
+
+        return True
+
+    def get_events(self):
+        """Retrieve events from server."""
+        response = api.request_sync_events(self.blink, self.network_id)
+        try:
+            return response['event']
+        except (TypeError, KeyError):
+            _LOGGER.error("Could not extract events: %s",
+                          response,
+                          exc_info=True)
+            return False
+
+    def get_camera_info(self):
+        """Retrieve camera information."""
+        response = api.request_cameras(self.blink, self.network_id)
+        try:
+            return response['devicestatus']
+        except (TypeError, KeyError):
+            _LOGGER.error("Could not extract camera info: %s",
+                          response,
+                          exc_info=True)
+            return []
+
+    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)
+
+    def check_new_videos(self):
+        """Check if new videos since last refresh."""
+        resp = api.request_videos(self.blink,
+                                  time=self.blink.last_refresh,
+                                  page=0)
+
+        for camera in self.cameras.keys():
+            self.motion[camera] = False
+
+        try:
+            info = resp['videos']
+        except (KeyError, TypeError):
+            _LOGGER.warning("Could not check for motion. Response: %s", resp)
+            return False
+
+        for entry in info:
+            try:
+                name = entry['camera_name']
+                clip = entry['address']
+                timestamp = entry['created_at']
+                self.motion[name] = True
+                self.last_record[name] = {'clip': clip, 'time': timestamp}
+            except KeyError:
+                _LOGGER.debug("No new videos since last refresh.")
+
+        return True

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = blinkpy
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.rst

@@ -0,0 +1 @@
+../README.rst

docs/api/blinkpy.rst

@@ -0,0 +1,17 @@
+.. _core_module:
+
+Blinkpy
+----------------------
+
+.. automodule:: blinkpy.blinkpy
+    :members:
+
+.. automodule:: blinkpy.sync_module
+    :members:
+
+.. automodule:: blinkpy.camera
+    :members:
+
+.. automodule:: blinkpy.helpers.util
+    :members:
+

docs/api/implemented.rst

@@ -0,0 +1,6 @@
+API Reference
+----------------------
+
+.. automodule:: blinkpy.api
+    :members:
+

docs/conf.py

@@ -0,0 +1,177 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# blinkpy documentation build configuration file, created by
+# sphinx-quickstart on Sat Jan 20 22:20:16 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+import sphinx_rtd_theme
+from blinkpy.helpers.constants import __version__
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'blinkpy'
+copyright = '2018, Kevin Fronczak'
+author = 'Kevin Fronczak'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = __version__
+# The full version, including alpha/beta/rc tags.
+release = __version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+#html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'blinkpydoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'blinkpy.tex', 'blinkpy Documentation',
+     'Kevin Fronczak', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'blinkpy', 'blinkpy Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'blinkpy', 'blinkpy Documentation',
+     author, 'blinkpy', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/index.rst

@@ -0,0 +1,22 @@
+.. blinkpy documentation master file, created by
+   sphinx-quickstart on Sat Jan 20 22:20:16 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to blinkpy's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :glob:
+   
+   README
+   api/*
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=blinkpy
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

examples/arm_system_camera.py

@@ -1,22 +0,0 @@
-#!/usr/bin/python
-import blinkpy
-import time
-
-blink = blinkpy.Blink()
-blink.login()
-blink.setup_system()
-
-for camera in blink.cameras:
-    print('Arming ' + camera.name)
-    camera.set_motion_detect(True)
-    time.sleep(5)
-    blink.refresh()
-
-print('Arming Blink')
-blink.arm = True
-time.sleep(5)
-print('Blink armed? ' + str(blink.arm))
-print('Disarming Blink')
-time.sleep(5)
-blink.arm = False
-print('Blink armed? ' + str(blink.arm))

examples/list_all_cameras.py

@@ -1,18 +0,0 @@
-#!/usr/bin/python
-import blinkpy
-
-blink = blinkpy.Blink()
-blink.login()
-blink.setup_system()
-
-for camera in blink.cameras:
-    print(camera.name)          # Name of the camera
-    print(camera.id)            # Integer id of the camera (assigned by Blink)
-    print(camera.armed)        # Whether the device is armed/disarmed (ie. detecting motion)
-    print(camera.clip)          # Link to last motion clip captured
-    print(camera.thumbnail)     # Link to current camera thumbnail
-    print(camera.temperature)   # Current camera temperature (not super accurate, but might be useful for someone)
-    print(camera.battery)       # Current battery level... I think the value ranges from 0-3, but not quite sure yet.
-    print(camera.notifications) # Number of unread notifications (ie. motion alerts that haven't been viewed)
-    print(camera.motion)        # Dictionary containing values for keys ['video', 'image', 'time']
-                                # which correspond to last motion recorded, thumbnail of last motion, and timestamp of last motion

pylintrc

@@ -0,0 +1,25 @@
+[MASTER]
+reports=no
+
+# Reasons disabled:
+# locally-disabled - it spams too much
+# duplicate-code - it's annoying
+# unused-argument - generic callbacks and setup methods create a lot of warnings
+# 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
+
+disable=
+  locally-disabled,
+  unused-argument,
+  duplicate-code,
+  too-many-arguments,
+  too-many-branches,
+  too-many-instance-attributes,
+  too-many-locals,
+  too-many-public-methods,
+  too-many-return-statements,
+  too-many-statements,
+  too-many-lines,
+  too-few-public-methods,
+  no-else-return,

requirements.txt

@@ -1,5 +1,3 @@
-pytest>=2.9.2
-pytest-cov>=2.3.1
-pytest-timeout>=1.0.0
-requests>=2.12.4
-testtools
+python-dateutil==2.7.5
+requests>=2.20.0
+testtools==2.3.0

requirements_test.txt

@@ -0,0 +1,10 @@
+flake8==3.5.0
+flake8-docstrings==1.3.0
+pylint==2.1.1
+pydocstyle==2.1.1
+pytest==3.7.1
+pytest-cov>=2.3.1
+pytest-sugar>=0.9.0
+pytest-timeout>=1.0.0
+restructuredtext-lint>=1.0.1
+pygments>=2.2.0

setup.py

@@ -1,26 +1,48 @@
 # -*- coding: utf-8 -*-
+from os.path import abspath, dirname, join
+from setuptools import setup, find_packages
+#  Fixes import error due to breaking change in pip 10
+#  https://stackoverflow.com/a/49867265
+#  pip > 10
+try:
+    from pip._internal.req import parse_requirements
+#  pip < 10
+except ImportError:
+    from pip.req import parse_requirements
+from blinkpy.helpers.constants import (
+    __version__, PROJECT_PACKAGE_NAME, PROJECT_LICENSE, PROJECT_URL,
+    PROJECT_EMAIL, PROJECT_DESCRIPTION, PROJECT_CLASSIFIERS, PROJECT_AUTHOR,
+)
 
-from setuptools import setup
+this_dir = abspath(dirname(__file__))
+
+install_reqs = parse_requirements('{}/requirements.txt'.format(this_dir), session=False)
+test_reqs = parse_requirements('{}/requirements_test.txt'.format(this_dir), session=False)
+REQUIRES = [str(ir.req) for ir in install_reqs]
+TEST_REQUIRES = [str(ir.req) for ir in test_reqs]
+
+PACKAGES = find_packages(exclude=['tests*', 'docs'])
+
+with open('{}/README.rst'.format(this_dir), encoding='utf-8') as readme_file:
+    long_description = readme_file.read()
+
+name = PROJECT_PACKAGE_NAME
+version = __version__
 
 setup(
-    name = 'blinkpy',
-    version = '0.4.',
-    description = 'A Blink camera Python library',
-    long_description='A library that communicates with Blink cameras',
-    author = 'Kevin Fronczak',
-    author_email = "kfronczak@gmail.com",
-    license='MIT',
-    url = 'https://github.com/fronzbot/blinkpy',
-    py_modules=['blinkpy'],
-    install_requires=['requests>=2,<3'],
-    classifiers=[
-      'Development Status :: 4 - Beta',
-      'Intended Audience :: Developers',
-      'License :: OSI Approved :: MIT License',
-      'Programming Language :: Python :: 3.4',
-      'Programming Language :: Python :: 3.5',
-      'Programming Language :: Python :: 3.6',
-      'Environment :: Plugins',
-      'Environment :: Web Environment'
-      ]
-)
+    name = PROJECT_PACKAGE_NAME,
+    version = __version__,
+    description = PROJECT_DESCRIPTION,
+    long_description = long_description,
+    author = PROJECT_AUTHOR,
+    author_email = PROJECT_EMAIL,
+    license = PROJECT_LICENSE,
+    url = PROJECT_URL,
+    platforms = 'any',
+    py_modules = ['blinkpy'],
+    packages=PACKAGES,
+    include_package_data = True,
+    install_requires = REQUIRES,
+    test_suite = 'tests',
+    classifiers = PROJECT_CLASSIFIERS
+)

tests/__init__.py

@@ -0,0 +1 @@
+"""Init file for tests directory."""

tests/mock_responses.py

@@ -0,0 +1,71 @@
+"""Simple mock responses definitions."""
+
+from blinkpy.helpers.util import BlinkURLHandler
+import blinkpy.helpers.constants as const
+
+LOGIN_RESPONSE = {
+    'region': {'mock': 'Test'},
+    'networks': {
+        '1234': {'name': 'test', 'onboarded': True}
+    },
+    'authtoken': {'authtoken': 'foobar123', 'message': 'auth'}
+}
+
+
+class MockResponse:
+    """Class for mock request response."""
+
+    def __init__(self, json_data, status_code, raw_data=None):
+        """Initialize mock get response."""
+        self.json_data = json_data
+        self.status_code = status_code
+        self.raw_data = raw_data
+
+    def json(self):
+        """Return json data from get_request."""
+        return self.json_data
+
+    @property
+    def raw(self):
+        """Return raw data from get request."""
+        return self.raw_data
+
+
+def mocked_session_send(*args, **kwargs):
+    """Mock session."""
+    prepped = args[0]
+    url = prepped.url
+    header = prepped.headers
+    method = prepped.method
+    if method == 'GET':
+        expected_token = LOGIN_RESPONSE['authtoken']['authtoken']
+        if header['TOKEN_AUTH'] != expected_token:
+            response = {'message': 'Not Authorized', 'code': 400}
+            status = 400
+        elif url == 'use_bad_response':
+            response = {'foo': 'bar'}
+            status = 200
+        elif url == 'reauth':
+            response = {'message': 'REAUTH', 'code': 777}
+            status = 777
+        else:
+            response = {'test': 'foo'}
+            status = 200
+    elif method == 'POST':
+        if url in (const.LOGIN_URL, const.LOGIN_BACKUP_URL):
+            response = LOGIN_RESPONSE
+            status = 200
+        elif url == 'http://wrong.url/' or url is None:
+            response = {'message': 'Error', 'code': 404}
+            status = 404
+        else:
+            response = {'message': 'foo', 'code': 200}
+            status = 200
+
+    return MockResponse(response, status)
+
+
+class MockURLHandler(BlinkURLHandler):
+    """Mocks URL Handler in blinkpy module."""
+
+    pass

tests/test_api.py

@@ -0,0 +1,42 @@
+"""Test various api functions."""
+
+import unittest
+from unittest import mock
+from blinkpy import api
+from blinkpy.blinkpy import Blink
+from blinkpy.helpers.util import create_session
+
+
+class TestBlinkAPI(unittest.TestCase):
+    """Test the blink api module."""
+
+    def setUp(self):
+        """Initialize the blink module."""
+        self.blink = Blink()
+        self.blink.session = create_session()
+        # pylint: disable=protected-access
+        self.blink._auth_header = {}
+
+    def tearDown(self):
+        """Tear down blink module."""
+        self.blink = None
+
+    @mock.patch('blinkpy.blinkpy.Blink.get_auth_token')
+    def test_http_req_connect_error(self, mock_auth):
+        """Test http_get error condition."""
+        mock_auth.return_value = {'foo': 'bar'}
+        firstlog = ("INFO:blinkpy.helpers.util:"
+                    "Cannot connect to server with url {}.").format(
+                        'http://notreal.fake')
+        nextlog = ("INFO:blinkpy.helpers.util:"
+                   "Auth token expired, attempting reauthorization.")
+        lastlog = ("ERROR:blinkpy.helpers.util:"
+                   "Endpoint {} failed. Possible issue with "
+                   "Blink servers.").format('http://notreal.fake')
+        expected = [firstlog, nextlog, firstlog, lastlog]
+        with self.assertLogs() as getlog:
+            api.http_get(self.blink, 'http://notreal.fake')
+        with self.assertLogs() as postlog:
+            api.http_post(self.blink, 'http://notreal.fake')
+        self.assertEqual(getlog.output, expected)
+        self.assertEqual(postlog.output, expected)

tests/test_blink_functions.py

@@ -0,0 +1,150 @@
+"""Tests camera and system functions."""
+import unittest
+from unittest import mock
+import logging
+from requests import Request
+
+from blinkpy import blinkpy
+from blinkpy.sync_module import BlinkSyncModule
+from blinkpy.helpers.util import create_session, get_time
+import tests.mock_responses as mresp
+
+USERNAME = 'foobar'
+PASSWORD = 'deadbeef'
+
+
+class MockSyncModule(BlinkSyncModule):
+    """Mock http requests from sync module."""
+
+    def __init__(self, blink, header):
+        """Create mock sync module instance."""
+        super().__init__(blink, header)
+        self.blink = blink
+        self.header = header
+        self.return_value = None
+        self.return_value2 = None
+
+    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
+
+
+@mock.patch('blinkpy.helpers.util.Session.send',
+            side_effect=mresp.mocked_session_send)
+class TestBlinkFunctions(unittest.TestCase):
+    """Test Blink and BlinkCamera functions in blinkpy."""
+
+    def setUp(self):
+        """Set up Blink module."""
+        self.blink = blinkpy.Blink(username=USERNAME,
+                                   password=PASSWORD)
+        # pylint: disable=protected-access
+        self.blink._auth_header = {
+            'Host': 'test.url.tld',
+            'TOKEN_AUTH': 'foobar123'
+        }
+        self.blink.urls = blinkpy.BlinkURLHandler('test')
+        self.blink.session = create_session()
+
+    def tearDown(self):
+        """Clean up after test."""
+        self.blink = None
+
+    @mock.patch('blinkpy.blinkpy.api.http_req')
+    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}}
+        }
+        new_req = mresp.MockResponse(json_resp, 200)
+        req.side_effect = [
+            mresp.mocked_session_send(fake_req),
+            new_req
+        ]
+        self.blink.get_auth_token()
+        self.assertEqual(self.blink.region_id, 'piri')
+        self.assertEqual(self.blink.region, 'UNKNOWN')
+        # pylint: disable=protected-access
+        self.assertEqual(self.blink._token, 'foobar123')
+
+    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'].cameras = first_dict
+        self.blink.sync['bar'].cameras = next_dict
+        result = self.blink.merge_cameras()
+        expected = {'foo': 'bar', 'test': 123, 'foobar': 456, 'bar': 'foo'}
+        self.assertEqual(expected, result)
+
+    @mock.patch('blinkpy.blinkpy.api.request_videos')
+    def test_download_video_exit(self, mock_req, mock_sess):
+        """Test we exit method when provided bad response."""
+        blink = blinkpy.Blink(loglevel=logging.DEBUG)
+        blink.last_refresh = 0
+        mock_req.return_value = {}
+        formatted_date = get_time(blink.last_refresh)
+        expected_log = [
+            "INFO:blinkpy:Retrieving videos since {}".format(formatted_date),
+            "DEBUG:blinkpy:Processing page 1",
+            "INFO:blinkpy:No videos found on page 1. Exiting."
+        ]
+        with self.assertLogs() as dl_log:
+            blink.download_videos('/tmp')
+        self.assertEqual(dl_log.output, expected_log)
+
+    @mock.patch('blinkpy.blinkpy.api.request_videos')
+    def test_parse_downloaded_items(self, mock_req, mock_sess):
+        """Test ability to parse downloaded items list."""
+        blink = blinkpy.Blink(loglevel=logging.DEBUG)
+        generic_entry = {
+            'created_at': '1970',
+            'camera_name': 'foo',
+            'deleted': True,
+            'address': '/bar.mp4'
+        }
+        result = [generic_entry]
+        mock_req.return_value = {'videos': result}
+        blink.last_refresh = 0
+        formatted_date = get_time(blink.last_refresh)
+        expected_log = [
+            "INFO:blinkpy:Retrieving videos since {}".format(formatted_date),
+            "DEBUG:blinkpy:Processing page 1",
+            "DEBUG:blinkpy:foo: /bar.mp4 is marked as deleted."
+        ]
+        with self.assertLogs() as dl_log:
+            blink.download_videos('/tmp', stop=2)
+        self.assertEqual(dl_log.output, expected_log)
+
+    @mock.patch('blinkpy.blinkpy.api.request_videos')
+    def test_parse_camera_not_in_list(self, mock_req, mock_sess):
+        """Test ability to parse downloaded items list."""
+        blink = blinkpy.Blink(loglevel=logging.DEBUG)
+        generic_entry = {
+            'created_at': '1970',
+            'camera_name': 'foo',
+            'deleted': True,
+            'address': '/bar.mp4'
+        }
+        result = [generic_entry]
+        mock_req.return_value = {'videos': result}
+        blink.last_refresh = 0
+        formatted_date = get_time(blink.last_refresh)
+        expected_log = [
+            "INFO:blinkpy:Retrieving videos since {}".format(formatted_date),
+            "DEBUG:blinkpy:Processing page 1",
+            "DEBUG:blinkpy:Skipping videos for foo."
+        ]
+        with self.assertLogs() as dl_log:
+            blink.download_videos('/tmp', camera='bar', stop=2)
+        self.assertEqual(dl_log.output, expected_log)

tests/test_blink_requests.py

@@ -1,100 +0,0 @@
-import blinkpy
-import requests
-import unittest
-from unittest import mock
-from blinkpy import LOGIN_URL
-from blinkpy import BASE_URL
-import test_const as const
-
-def mocked_requests_post(*args, **kwargs):
-    class MockPostResponse:
-        def __init__(self,json_data,status_code):
-            self.json_data = json_data
-            self.status_code = status_code
-        def json(self):
-            return self.json_data
-            
-    if args[0] == LOGIN_URL:
-        return MockPostResponse({"region":{const.REGION_ID: const.REGION}, "authtoken":{"authtoken":const.TOKEN}}, 200)
-    elif args[0].split("/")[-1] == 'arm':
-        return MockPostResponse({"armed":True}, 200)
-    elif args[0].split("/")[-1] == 'disarm':
-        return MockPostResponse({"armed":False}, 200)
-    else:
-        return MockPostResponse({}, 200)
-    
-    return MockPostResponse({'message':'ERROR','code':404}, 404)
-    
-def mocked_requests_get(*args, **kwargs):
-    class MockGetResponse:
-        def __init__(self,json_data,status_code):
-            self.json_data = json_data
-            self.status_code = status_code
-        def json(self):
-            return self.json_data
-            
-    if args[0] == BASE_URL + '/networks':
-        return MockGetResponse({'networks':[{"id":const.NETWORK_ID,"account_id":const.ACCOUNT_ID},{"nothing":"nothing"}]}, 200)
-    else:
-        return MockGetResponse(const.response, 200)
-                               
-    
-    return MockGetResponse({'message':'ERROR','code':404}, 404)
-    
-class TestBlinkRequests(unittest.TestCase):
-    @mock.patch('blinkpy.requests.post', side_effect=mocked_requests_post)
-    @mock.patch('blinkpy.requests.get', side_effect=mocked_requests_get)
-    def test_blink_setup(self, mock_get, mock_post):
-        blink = blinkpy.Blink(username='user',password='password')
-        blink.setup_system()
-        
-        self.assertEqual(blink.network_id, str(const.NETWORK_ID))
-        self.assertEqual(blink.account_id, str(const.ACCOUNT_ID))
-        self.assertEqual(blink.region, const.REGION)
-        self.assertEqual(blink.region_id, const.REGION_ID)
-        self.assertEqual(blink.online, const.ISONLINE)
-        self.assertEqual(blink.arm, const.ARMED)
-    
-    @mock.patch('blinkpy.requests.post', side_effect=mocked_requests_post)
-    @mock.patch('blinkpy.requests.get', side_effect=mocked_requests_get)
-    def test_blink_camera_setup_and_motion(self, mock_get, mock_post):
-        blink = blinkpy.Blink(username='user',password='password')
-        blink.setup_system()
-        blink.last_motion()
-        for name, camera in blink.cameras.items():
-            if camera.id == str(const.DEVICE_ID):
-                 self.assertEqual(name, const.CAMERA_NAME)
-                 self.assertEqual(camera.armed, const.ARMED)
-                 self.assertEqual(camera.motion['video'], BASE_URL + const.THUMB + '.mp4')
-            elif camera.id == str(const.DEVICE_ID2):
-                 self.assertEqual(name, const.CAMERA_NAME2)
-                 self.assertEqual(camera.armed, const.ARMED2)
-                 self.assertEqual(len(camera.motion.keys()), 0)
-            else:
-                assert False is True
-                
-    @mock.patch('blinkpy.requests.post', side_effect=mocked_requests_post)
-    @mock.patch('blinkpy.requests.get', side_effect=mocked_requests_get)
-    def test_blink_refresh(self, mock_get, mock_post):
-        blink = blinkpy.Blink(username='user',password='password')
-        blink.setup_system()
-        const.response['devices'][0]['thumbnail'] = const.THUMB + const.THUMB2
-        blink.refresh()
-        for name, camera in blink.cameras.items():
-            if camera.id == str(const.DEVICE_ID):
-                self.assertEqual(camera.thumbnail, BASE_URL + const.THUMB + const.THUMB2 + '.jpg')
-            elif camera.id == str(const.DEVICE_ID2):
-                pass
-            else:
-                assert False is True
-        
-        const.response['devices'][0]['thumbnail'] = 'new'
-        blink.cameras[const.CAMERA_NAME].image_refresh()
-        for name, camera in blink.cameras.items():
-            if camera.id == str(const.DEVICE_ID):
-                self.assertEqual(camera.thumbnail, BASE_URL + 'new' + '.jpg')
-            elif camera.id == str(const.DEVICE_ID2):
-                pass
-            else:
-                assert False is True
-        

tests/test_blinkpy.py

@@ -0,0 +1,162 @@
+"""
+Test full system.
+
+Tests the system initialization and attributes of
+the main Blink system.  Tests if we properly catch
+any communication related errors at startup.
+"""
+
+import unittest
+from unittest import mock
+from blinkpy import api
+from blinkpy.blinkpy import Blink
+from blinkpy.sync_module import BlinkSyncModule
+from blinkpy.helpers.util import (
+    http_req, create_session, BlinkAuthenticationException,
+    BlinkException, BlinkURLHandler)
+from blinkpy.helpers.constants import __version__
+import tests.mock_responses as mresp
+
+USERNAME = 'foobar'
+PASSWORD = 'deadbeef'
+
+
+@mock.patch('blinkpy.helpers.util.Session.send',
+            side_effect=mresp.mocked_session_send)
+class TestBlinkSetup(unittest.TestCase):
+    """Test the Blink class in blinkpy."""
+
+    def setUp(self):
+        """Set up Blink module."""
+        self.blink_no_cred = Blink()
+        self.blink = Blink(username=USERNAME,
+                           password=PASSWORD)
+        self.blink.sync['test'] = BlinkSyncModule(self.blink, 'test', '1234')
+        self.blink.urls = BlinkURLHandler('test')
+        self.blink.session = create_session()
+
+    def tearDown(self):
+        """Clean up after test."""
+        self.blink = None
+        self.blink_no_cred = None
+
+    def test_initialization(self, mock_sess):
+        """Verify we can initialize blink."""
+        self.assertEqual(self.blink.version, __version__)
+        # pylint: disable=protected-access
+        self.assertEqual(self.blink._username, USERNAME)
+        # pylint: disable=protected-access
+        self.assertEqual(self.blink._password, PASSWORD)
+
+    def test_no_credentials(self, mock_sess):
+        """Check that we throw an exception when no username/password."""
+        with self.assertRaises(BlinkAuthenticationException):
+            self.blink_no_cred.get_auth_token()
+        # pylint: disable=protected-access
+        self.blink_no_cred._username = USERNAME
+        with self.assertRaises(BlinkAuthenticationException):
+            self.blink_no_cred.get_auth_token()
+
+    def test_no_auth_header(self, mock_sess):
+        """Check that we throw an exception when no auth header given."""
+        # pylint: disable=unused-variable
+        (region_id, region), = mresp.LOGIN_RESPONSE['region'].items()
+        self.blink.urls = BlinkURLHandler(region_id)
+        with self.assertRaises(BlinkException):
+            self.blink.get_ids()
+
+    @mock.patch('blinkpy.blinkpy.getpass.getpass')
+    def test_manual_login(self, getpwd, mock_sess):
+        """Check that we can manually use the login() function."""
+        getpwd.return_value = PASSWORD
+        with mock.patch('builtins.input', return_value=USERNAME):
+            self.assertTrue(self.blink_no_cred.login())
+        # pylint: disable=protected-access
+        self.assertEqual(self.blink_no_cred._username, USERNAME)
+        # pylint: disable=protected-access
+        self.assertEqual(self.blink_no_cred._password, PASSWORD)
+
+    def test_bad_request(self, mock_sess):
+        """Check that we raise an Exception with a bad request."""
+        self.blink.session = create_session()
+        explog = ("ERROR:blinkpy.helpers.util:"
+                  "Cannot obtain new token for server auth.")
+        with self.assertRaises(BlinkException):
+            http_req(self.blink, reqtype='bad')
+
+        with self.assertLogs() as logrecord:
+            http_req(self.blink, reqtype='post', is_retry=True)
+        self.assertEqual(logrecord.output, [explog])
+
+    def test_authentication(self, mock_sess):
+        """Check that we can authenticate Blink up properly."""
+        authtoken = self.blink.get_auth_token()['TOKEN_AUTH']
+        expected = mresp.LOGIN_RESPONSE['authtoken']['authtoken']
+        self.assertEqual(authtoken, expected)
+
+    def test_reauthorization_attempt(self, mock_sess):
+        """Check that we can reauthorize after first unsuccessful attempt."""
+        original_header = self.blink.get_auth_token()
+        # pylint: disable=protected-access
+        bad_header = {'Host': self.blink._host, 'TOKEN_AUTH': 'BADTOKEN'}
+        # pylint: disable=protected-access
+        self.blink._auth_header = bad_header
+        self.assertEqual(self.blink.auth_header, bad_header)
+        api.request_homescreen(self.blink)
+        self.assertEqual(self.blink.auth_header, original_header)
+
+    @mock.patch('blinkpy.api.request_networks')
+    def test_multiple_networks(self, mock_net, mock_sess):
+        """Check that we handle multiple networks appropriately."""
+        mock_net.return_value = {
+            'networks': [{'id': 1234, 'account_id': 1111},
+                         {'id': 5678, 'account_id': 2222}]
+        }
+        self.blink.networks = {'0000': {'onboarded': False, 'name': 'foo'},
+                               '5678': {'onboarded': True, 'name': 'bar'},
+                               '1234': {'onboarded': False, 'name': 'test'}}
+        self.blink.get_ids()
+        self.assertTrue('5678' in self.blink.network_ids)
+        self.assertEqual(self.blink.account_id, 2222)
+
+    @mock.patch('blinkpy.api.request_networks')
+    def test_multiple_onboarded_networks(self, mock_net, mock_sess):
+        """Check that we handle multiple networks appropriately."""
+        mock_net.return_value = {
+            'networks': [{'id': 0000, 'account_id': 2222},
+                         {'id': 5678, 'account_id': 1111}]
+        }
+        self.blink.networks = {'0000': {'onboarded': False, 'name': 'foo'},
+                               '5678': {'onboarded': True, 'name': 'bar'},
+                               '1234': {'onboarded': True, 'name': 'test'}}
+        self.blink.get_ids()
+        self.assertTrue('5678' in self.blink.network_ids)
+        self.assertTrue('1234' in self.blink.network_ids)
+        self.assertEqual(self.blink.account_id, 1111)
+
+    @mock.patch('blinkpy.blinkpy.time.time')
+    def test_throttle(self, mock_time, mock_sess):
+        """Check throttling functionality."""
+        now = self.blink.refresh_rate + 1
+        mock_time.return_value = now
+        self.assertEqual(self.blink.last_refresh, None)
+        self.assertEqual(self.blink.check_if_ok_to_update(), True)
+        self.assertEqual(self.blink.last_refresh, None)
+        with mock.patch('blinkpy.sync_module.BlinkSyncModule.refresh',
+                        return_value=True):
+            self.blink.refresh()
+
+        self.assertEqual(self.blink.last_refresh, now)
+        self.assertEqual(self.blink.check_if_ok_to_update(), False)
+        self.assertEqual(self.blink.last_refresh, now)
+
+    def test_sync_case_insensitive_dict(self, mock_sess):
+        """Check that we can access sync modules ignoring case."""
+        self.assertEqual(self.blink.sync['test'].name, 'test')
+        self.assertEqual(self.blink.sync['TEST'].name, 'test')
+
+    @mock.patch('blinkpy.api.request_login')
+    def test_unexpected_login(self, mock_login, mock_sess):
+        """Check that we appropriately handle unexpected login info."""
+        mock_login.return_value = None
+        self.assertFalse(self.blink.get_auth_token())

tests/test_cameras.py

@@ -0,0 +1,194 @@
+"""
+Test all camera attributes.
+
+Tests the camera initialization and attributes of
+individual BlinkCamera instantiations once the
+Blink system is set up.
+"""
+
+import unittest
+from unittest import mock
+from blinkpy import blinkpy
+from blinkpy.helpers.util import create_session, BlinkURLHandler
+from blinkpy.sync_module import BlinkSyncModule
+from blinkpy.camera import BlinkCamera
+import tests.mock_responses as mresp
+
+USERNAME = 'foobar'
+PASSWORD = 'deadbeef'
+
+CAMERA_CFG = {
+    'camera': [
+        {
+            'battery_voltage': 90,
+            'motion_alert': True,
+            'wifi_strength': -30,
+            'temperature': 68
+        }
+    ]
+}
+
+
+@mock.patch('blinkpy.helpers.util.Session.send',
+            side_effect=mresp.mocked_session_send)
+class TestBlinkCameraSetup(unittest.TestCase):
+    """Test the Blink class in blinkpy."""
+
+    def setUp(self):
+        """Set up Blink module."""
+        self.blink = blinkpy.Blink(username=USERNAME,
+                                   password=PASSWORD)
+        header = {
+            'Host': 'abc.zxc',
+            'TOKEN_AUTH': mresp.LOGIN_RESPONSE['authtoken']['authtoken']
+        }
+        # pylint: disable=protected-access
+        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.camera = BlinkCamera(self.blink.sync['test'])
+        self.camera.name = 'foobar'
+        self.blink.sync['test'].cameras['foobar'] = self.camera
+
+    def tearDown(self):
+        """Clean up after test."""
+        self.blink = None
+
+    def test_camera_update(self, mock_sess):
+        """Test that we can properly update camera properties."""
+        config = {
+            'name': 'new',
+            'camera_id': 1234,
+            'network_id': 5678,
+            'serial': '12345678',
+            'enabled': False,
+            'battery_voltage': 90,
+            'battery_state': 'ok',
+            'temperature': 68,
+            'wifi_strength': 4,
+            'thumbnail': '/thumb',
+        }
+        self.camera.last_record = ['1']
+        self.camera.sync.last_record = {
+            'new': {
+                'clip': '/test.mp4',
+                'time': '1970-01-01T00:00:00'
+            }
+        }
+        mock_sess.side_effect = [
+            mresp.MockResponse({'temp': 71}, 200),
+            'test',
+            'foobar'
+        ]
+        self.camera.update(config)
+        self.assertEqual(self.camera.name, 'new')
+        self.assertEqual(self.camera.camera_id, '1234')
+        self.assertEqual(self.camera.network_id, '5678')
+        self.assertEqual(self.camera.serial, '12345678')
+        self.assertEqual(self.camera.motion_enabled, False)
+        self.assertEqual(self.camera.battery, 50)
+        self.assertEqual(self.camera.temperature, 68)
+        self.assertEqual(self.camera.temperature_c, 20)
+        self.assertEqual(self.camera.temperature_calibrated, 71)
+        self.assertEqual(self.camera.wifi_strength, 4)
+        self.assertEqual(self.camera.thumbnail,
+                         'https://rest.test.immedia-semi.com/thumb.jpg')
+        self.assertEqual(self.camera.clip,
+                         'https://rest.test.immedia-semi.com/test.mp4')
+        self.assertEqual(self.camera.image_from_cache, 'test')
+        self.assertEqual(self.camera.video_from_cache, 'foobar')
+
+    def test_thumbnail_not_in_info(self, mock_sess):
+        """Test that we grab thumbanil if not in camera_info."""
+        mock_sess.side_effect = [
+            mresp.MockResponse({'temp': 71}, 200),
+            'foobar',
+            'barfoo'
+        ]
+        self.camera.last_record = ['1']
+        self.camera.sync.last_record = {
+            'new': {
+                'clip': '/test.mp4',
+                'time': '1970-01-01T00:00:00'
+            }
+        }
+        config = {
+            'name': 'new',
+            'camera_id': 1234,
+            'network_id': 5678,
+            'serial': '12345678',
+            'enabled': False,
+            'battery_voltage': 90,
+            'battery_state': 'ok',
+            'temperature': 68,
+            'wifi_strength': 4,
+            'thumbnail': '',
+        }
+        self.camera.sync.homescreen = {
+            'devices': [
+                {'foo': 'bar'},
+                {'device_type': 'foobar'},
+                {'device_type': 'camera',
+                 'name': 'new',
+                 'thumbnail': '/new/thumb'}
+            ]
+        }
+        self.camera.update(config)
+        self.assertEqual(self.camera.thumbnail,
+                         'https://rest.test.immedia-semi.com/new/thumb.jpg')
+
+    def test_no_thumbnails(self, mock_sess):
+        """Tests that thumbnail is 'None' if none found."""
+        mock_sess.return_value = 'foobar'
+        self.camera.last_record = ['1']
+        config = {
+            'name': 'new',
+            'camera_id': 1234,
+            'network_id': 5678,
+            'serial': '12345678',
+            'enabled': False,
+            'battery_voltage': 90,
+            'battery_state': 'ok',
+            'temperature': 68,
+            'wifi_strength': 4,
+            'thumbnail': '',
+        }
+        self.camera.sync.homescreen = {
+            'devices': []
+        }
+        self.assertEqual(self.camera.temperature_calibrated, None)
+        with self.assertLogs() as logrecord:
+            self.camera.update(config)
+        self.assertEqual(self.camera.thumbnail, None)
+        self.assertEqual(self.camera.last_record, ['1'])
+        self.assertEqual(self.camera.temperature_calibrated, 68)
+        self.assertEqual(
+            logrecord.output,
+            [("WARNING:blinkpy.camera:Could not retrieve calibrated "
+              "temperature."),
+             ("ERROR:blinkpy.camera:Could not find thumbnail for camera new"
+              "\nNoneType: None")]
+        )
+
+    def test_no_video_clips(self, mock_sess):
+        """Tests that we still proceed with camera setup with no videos."""
+        mock_sess.return_value = 'foobar'
+        config = {
+            'name': 'new',
+            'camera_id': 1234,
+            'network_id': 5678,
+            'serial': '12345678',
+            'enabled': False,
+            'battery_voltage': 90,
+            'battery_state': 'ok',
+            'temperature': 68,
+            'wifi_strength': 4,
+            'thumbnail': '/foobar',
+        }
+        self.camera.sync.homescreen = {
+            'devices': []
+        }
+        self.camera.update(config, force_cache=True)
+        self.assertEqual(self.camera.clip, None)
+        self.assertEqual(self.camera.video_from_cache, None)

tests/test_classes.py

@@ -1,75 +0,0 @@
-import testtools
-import unittest
-import blinkpy
-from blinkpy import BASE_URL
-
-class TestBlink(unittest.TestCase):
-    def test_blink_instance(self):
-        blink = blinkpy.Blink()
-        
-    def test_blink_camera_attributes(self):
-        config = {'name':'name', 'device_id': 1248, 'armed':True, 'thumbnail':'/test/url/image', 'temp':70, 'battery':3, 'notifications':0, 'region_id':'rid'}
-
-        camera = blinkpy.BlinkCamera(config)
-        
-        # Check that values are properly stored and can be recalled
-        self.assertEqual(camera.name, config['name'])
-        self.assertEqual(camera.id, str(config['device_id']))
-        self.assertEqual(camera.armed, config['armed'])
-        self.assertEqual(camera.clip, BASE_URL + config['thumbnail'] + '.mp4')
-        self.assertEqual(camera.thumbnail, BASE_URL + config['thumbnail'] + '.jpg')
-        self.assertEqual(camera.temperature, config['temp'])
-        self.assertEqual(camera.battery, config['battery'])
-        self.assertEqual(camera.notifications, config['notifications'])
-        self.assertEqual(camera.region_id, config['region_id'])
-        
-        # Check that values can be changed with individual methods
-        test_header  = {'Header':'test','Test':'1234'}
-        test_img     = 'http://image-link.com'
-        test_arm     = 'http://arm-link.com'
-        test_motion  = {'video':'url','image':'url','time':'timestamp'}
-        
-        camera.name  = config['name']+'_new'
-        camera.clip  = BASE_URL + config['thumbnail'] + '.mp4_new'
-        camera.thumbnail = BASE_URL + config['thumbnail'] + '.jpg_new'
-        camera.temperature = config['temp'] + 10
-        camera.battery = config['battery'] + 1
-        camera.notifications = config['notifications'] + 1
-        camera.image_link = test_img
-        camera.arm_link = test_arm
-        camera.header = test_header
-        camera.motion = test_motion
-        
-        # Check that values are properly stored and can be recalled
-        self.assertEqual(camera.name , config['name']+'_new')
-        self.assertEqual(camera.clip , BASE_URL + config['thumbnail'] + '.mp4_new')
-        self.assertEqual(camera.thumbnail, BASE_URL + config['thumbnail'] + '.jpg_new')
-        self.assertEqual(camera.temperature, config['temp'] + 10)
-        self.assertEqual(camera.battery, config['battery'] + 1)
-        self.assertEqual(camera.notifications, config['notifications'] + 1)
-        self.assertEqual(camera.image_link, test_img)
-        self.assertEqual(camera.arm_link, test_arm)
-        self.assertEqual(camera.header, test_header)
-        self.assertEqual(camera.motion, test_motion)
-        
-        # Verify bulk update function
-        test_name    = camera.name +' last'
-        test_status  = True
-        test_url     = '-this-is-a-test/for_realz'
-        test_temp    = camera.temperature + 7
-        test_battery = camera.battery - 1
-        test_notif   = camera.notifications - 1
-        values = {'name':test_name, 'armed':test_status, 'thumbnail':test_url, 'temp':test_temp, 'battery':test_battery, 'notifications':test_notif}
-        
-        camera.update(values)
-        # Check that values are properly stored and can be recalled
-        jpg_url = BASE_URL + test_url +'.jpg'
-        mp4_url = BASE_URL + test_url +'.mp4'
-        self.assertEqual(camera.name, test_name)
-        self.assertEqual(camera.armed, test_status)
-        self.assertEqual(camera.clip, mp4_url)
-        self.assertEqual(camera.thumbnail, jpg_url)
-        self.assertEqual(camera.temperature, test_temp)
-        self.assertEqual(camera.battery, test_battery)
-        self.assertEqual(camera.notifications, test_notif)
-        

tests/test_const.py

@@ -1,157 +0,0 @@
-ISONLINE = True
-ARMED = True
-ARMED2 = False
-REGION_ID = 'test'
-REGION = 'Oceaniaeurasia'
-TOKEN = 'abcd1234$$@@'
-NETWORK_ID = 1337
-DEVICE_ID = 9876
-DEVICE_ID2 = 6789
-ACCOUNT_ID = 1234
-CAMERA_NAME = 'My Camera'
-CAMERA_NAME2 = 'Number 2'
-BATTERY = 3
-BATTERY2 = 1
-TEMP = 70
-TEMP2 = 66
-THUMB = '/url/camera/7777/clip'
-THUMB2 = '/url/camera/8888/clip'
-NOTIFS = 1
-NOTIFS2 = 1
-SYNC_ID = 1000
-
-if ISONLINE:
-    ONLINE = 'online'
-else:
-    ONLINE = 'offline'
-    
-
-response = {'account': {'notifications': 1}, 
-            'devices': [{'device_type': 'camera', 
-                         'notifications': NOTIFS, 
-                         'battery': BATTERY, 
-                         'active': 'disabled', 
-                         'errors': 0, 
-                         'error_msg': '', 
-                         'enabled': False, 
-                         'temp': TEMP, 
-                         'updated_at': '2017-01-27T03:14:24+00:00', 
-                         'lfr_strength': 3, 
-                         'armed': ARMED, 
-                         'device_id': DEVICE_ID, 
-                         'wifi_strength': 5, 
-                         'warning': 0, 
-                         'thumbnail': THUMB, 
-                         'name': CAMERA_NAME, 
-                         'status': 'done'},
-                        {'device_type': 'camera', 
-                         'notifications': NOTIFS2, 
-                         'battery': BATTERY2, 
-                         'active': 'disabled', 
-                         'errors': 0, 
-                         'error_msg': '', 
-                         'enabled': False, 
-                         'temp': TEMP2, 
-                         'updated_at': '2017-01-27T03:14:24+00:00', 
-                         'lfr_strength': 3, 
-                         'armed': ARMED2, 
-                         'device_id': DEVICE_ID2, 
-                         'wifi_strength': 5, 
-                         'warning': 0, 
-                         'thumbnail': THUMB2, 
-                         'name': CAMERA_NAME2, 
-                         'status': 'done'}, 
-                         {'updated_at': '2017-01-26T19:32:10+00:00', 
-                         'device_type': 'sync_module', 
-                         'notifications': 0, 
-                         'device_id': SYNC_ID, 
-                         'status': 
-                         'online', 
-                         'last_hb': 
-                         '2017-01-27T03:14:49+00:00', 
-                         'errors': 0, 
-                         'error_msg': '', 
-                         'warning': 0}], 
-            'network': {'armed': ARMED, 
-                        'wifi_strength': 5, 
-                        'warning': 0, 
-                        'error_msg': '', 
-                        'name': 'Blink', 
-                        'notifications': NOTIFS, 
-                        'status': 'ok'},        
-            'event': [{'camera_name': CAMERA_NAME, 
-                       'updated_at': '2017-01-28T19:51:52+00:00', 
-                       'sync_module_id': None, 
-                       'camera': DEVICE_ID, 
-                       'type': 'motion', 
-                       'duration': None, 
-                       'status': None, 
-                       'created_at': '2017-01-28T19:51:52+00:00', 
-                       'camera_id': DEVICE_ID, 
-                       'id': 123456789, 
-                       'siren_id': None, 
-                       'account_id': ACCOUNT_ID, 
-                       'notified': True, 
-                       'siren': None, 
-                       'syncmodule': None, 
-                       'video_url': THUMB+'.mp4', 
-                       'command_id': None, 
-                       'network_id': None, 
-                       'account': ACCOUNT_ID, 
-                       'video_id': 100000001}, 
-                      {'updated_at': '2017-01-28T19:51:29+00:00', 
-                       'sync_module_id': SYNC_ID, 
-                       'camera': None, 
-                       'type': 'armed', 
-                       'duration': None, 
-                       'status': None, 
-                       'created_at': 
-                       '2017-01-28T19:51:29+00:00', 
-                       'camera_id': None, 
-                       'id': 123456789, 
-                       'siren_id': None, 
-                       'account_id': ACCOUNT_ID, 
-                       'notified': False, 
-                       'siren': None, 
-                       'syncmodule': SYNC_ID, 
-                       'command_id': None, 
-                       'network_id': None, 
-                       'account': ACCOUNT_ID}, 
-                      {'updated_at': '2017-01-28T19:00:12+00:00', 
-                       'sync_module_id': SYNC_ID, 
-                       'camera': None, 
-                       'type': 'disarmed', 
-                       'duration': None, 
-                       'status': None, 
-                       'created_at': '2017-01-28T19:00:12+00:00', 
-                       'camera_id': None, 
-                       'id': 123456789, 
-                       'siren_id': None, 
-                       'account_id': 2463, 
-                       'notified': False, 
-                       'siren': None, 
-                       'syncmodule': SYNC_ID, 
-                       'command_id': None, 
-                       'network_id': None, 
-                       'account': ACCOUNT_ID}, 
-                      {'camera_name': CAMERA_NAME, 
-                       'updated_at': '2017-01-28T18:59:55+00:00', 
-                       'sync_module_id': None, 
-                       'camera': DEVICE_ID, 
-                       'type': 'motion', 
-                       'duration': None, 
-                       'status': None, 
-                       'created_at': '2017-01-28T18:59:55+00:00', 
-                       'camera_id': DEVICE_ID, 
-                       'id': 123456789, 
-                       'siren_id': None, 
-                       'account_id': ACCOUNT_ID, 
-                       'notified': True, 
-                       'siren': None, 
-                       'syncmodule': None, 
-                       'command_id': None, 
-                       'network_id': None, 
-                       'account': ACCOUNT_ID}],
-            'syncmodule':{'name':'SyncName', 
-                          'status':ONLINE}}
-                        

tests/test_import.py

@@ -1,6 +0,0 @@
-import testtools
-import blinkpy
-
-class TestImport(testtools.TestCase):
-    def test_import(self):
-        pass

tests/test_sync_module.py

@@ -0,0 +1,156 @@
+"""Tests camera and system functions."""
+import unittest
+from unittest import mock
+
+from blinkpy import blinkpy
+from blinkpy.sync_module import BlinkSyncModule
+from blinkpy.camera import BlinkCamera
+
+USERNAME = 'foobar'
+PASSWORD = 'deadbeef'
+
+
+@mock.patch('blinkpy.api.http_req')
+class TestBlinkSyncModule(unittest.TestCase):
+    """Test BlinkSyncModule functions in blinkpy."""
+
+    def setUp(self):
+        """Set up Blink module."""
+        self.blink = blinkpy.Blink(username=USERNAME,
+                                   password=PASSWORD)
+        # pylint: disable=protected-access
+        self.blink._auth_header = {
+            'Host': 'test.url.tld',
+            'TOKEN_AUTH': 'foobar123'
+        }
+        self.blink.urls = blinkpy.BlinkURLHandler('test')
+        self.blink.sync['test'] = BlinkSyncModule(self.blink, 'test', '1234')
+        self.camera = BlinkCamera(self.blink.sync)
+        self.mock_start = [
+            {'syncmodule': {
+                'id': 1234,
+                'network_id': 5678,
+                'serial': '12345678',
+                'status': 'foobar'}},
+            {'event': True},
+            {},
+            {},
+            None,
+            {'devicestatus': {}},
+        ]
+
+    def tearDown(self):
+        """Clean up after test."""
+        self.blink = None
+        self.camera = None
+        self.mock_start = None
+
+    def test_get_events(self, mock_resp):
+        """Test get events function."""
+        mock_resp.return_value = {'event': True}
+        self.assertEqual(self.blink.sync['test'].get_events(), True)
+
+    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)
+
+    def test_check_new_videos(self, mock_resp):
+        """Test recent video response."""
+        mock_resp.return_value = {
+            'videos': [{
+                'camera_name': 'foo',
+                'address': '/foo/bar.mp4',
+                'created_at': '1970-01-01T00:00:00+0:00'
+            }]
+        }
+        sync_module = self.blink.sync['test']
+        sync_module.cameras = {'foo': None}
+        self.assertEqual(sync_module.motion, {})
+        self.assertTrue(sync_module.check_new_videos())
+        self.assertEqual(sync_module.last_record['foo'],
+                         {'clip': '/foo/bar.mp4',
+                          'time': '1970-01-01T00:00:00+0:00'})
+        self.assertEqual(sync_module.motion, {'foo': True})
+        mock_resp.return_value = {'videos': []}
+        self.assertTrue(sync_module.check_new_videos())
+        self.assertEqual(sync_module.motion, {'foo': False})
+        self.assertEqual(sync_module.last_record['foo'],
+                         {'clip': '/foo/bar.mp4',
+                          'time': '1970-01-01T00:00:00+0:00'})
+
+    def test_check_new_videos_failed(self, mock_resp):
+        """Test method when response is unexpected."""
+        mock_resp.side_effect = [None, 'just a string', {}]
+        sync_module = self.blink.sync['test']
+        sync_module.cameras = {'foo': None}
+
+        sync_module.motion['foo'] = True
+        self.assertFalse(sync_module.check_new_videos())
+        self.assertFalse(sync_module.motion['foo'])
+
+        sync_module.motion['foo'] = True
+        self.assertFalse(sync_module.check_new_videos())
+        self.assertFalse(sync_module.motion['foo'])
+
+        sync_module.motion['foo'] = True
+        self.assertFalse(sync_module.check_new_videos())
+        self.assertFalse(sync_module.motion['foo'])
+
+    def test_sync_start(self, mock_resp):
+        """Test sync start function."""
+        mock_resp.side_effect = self.mock_start
+        self.blink.sync['test'].start()
+        self.assertEqual(self.blink.sync['test'].name, 'test')
+        self.assertEqual(self.blink.sync['test'].sync_id, 1234)
+        self.assertEqual(self.blink.sync['test'].network_id, 5678)
+        self.assertEqual(self.blink.sync['test'].serial, '12345678')
+        self.assertEqual(self.blink.sync['test'].status, 'foobar')
+
+    def test_unexpected_summary(self, mock_resp):
+        """Test unexpected summary response."""
+        self.mock_start[0] = None
+        mock_resp.side_effect = self.mock_start
+        self.assertFalse(self.blink.sync['test'].start())
+
+    def test_summary_with_no_network_id(self, mock_resp):
+        """Test handling of bad summary."""
+        self.mock_start[0]['syncmodule'] = None
+        mock_resp.side_effect = self.mock_start
+        self.assertFalse(self.blink.sync['test'].start())
+
+    def test_summary_with_only_network_id(self, mock_resp):
+        """Test handling of sparse summary."""
+        self.mock_start[0]['syncmodule'] = {'network_id': 8675309}
+        mock_resp.side_effect = self.mock_start
+        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
+        self.mock_start[5] = None
+        mock_resp.side_effect = self.mock_start
+        self.blink.sync['test'].start()
+        self.assertEqual(self.blink.sync['test'].cameras, {'foo': None})
+
+    def test_missing_camera_info(self, mock_resp):
+        """Test missing key from camera info response."""
+        self.blink.sync['test'].cameras['foo'] = None
+        self.mock_start[5] = {}
+        self.blink.sync['test'].start()
+        self.assertEqual(self.blink.sync['test'].cameras, {'foo': None})

tox.ini

@@ -1,23 +1,41 @@
 [tox]
-envlist = py34, pep8
+envlist = build, py35, py36, py37, py38, lint
+skip_missing_interpreters = True
+skipsdist = True
 
 [testenv]
 setenv =
-    LAND=en_US.UTF-8
+    LANG=en_US.UTF-8
     PYTHONPATH = {toxinidir}
 commands = 
-    py.test -v --timeout=30 --duration=10 --cov=blinkpy --cov-report html {posargs}
+    py.test --timeout=30 --duration=10 --cov=blinkpy --cov-report term-missing {posargs}
 deps = 
     -r{toxinidir}/requirements.txt
+    -r{toxinidir}/requirements_test.txt
     
-[testenv:pep8]
+[testenv:lint]
 deps = 
     -r{toxinidir}/requirements.txt
-    flake8
+    -r{toxinidir}/requirements_test.txt
 basepython = python3
+ignore_errors = True
 commands = 
-    flake8 blinkpy.py
-    
-[flake8]
-ignore = E501
-exclude = .venv,.git,.tox,dist,doc,*lib/python,*egg,build
+    pylint --rcfile={toxinidir}/pylintrc blinkpy tests
+    flake8 blinkpy tests
+    pydocstyle blinkpy tests
+    rst-lint README.rst
+    rst-lint CHANGES.rst
+
+[testenv:build]
+recreate = True
+skip_install = True
+whitelist_externals =
+    /bin/sh
+    /bin/rm
+deps =
+    -r{toxinidir}/requirements_test.txt
+commands = 
+    /bin/rm -rf build dist
+    python setup.py bdist_wheel
+    /bin/sh -c "pip install --upgrade dist/*.whl"
+    py.test tests