Merge pull request #9 from nahum365/v020

Version 0.02.0 -- get camera stream

Author: nahum365

docs/index.md

@@ -12,6 +12,7 @@ Coming soon:
 
 ## Demo
 
+### Access Devices
 ```
 nda = NestDeviceAccess(
     project_id="PROJECT_ID",
@@ -23,3 +24,20 @@ nda.login()
 for device in nda.devices():
     print(device.name)
 ```
+
+### Access Camera Stream
+
+```
+nda = NestDeviceAccess(
+    project_id="PROJECT_ID",
+    client_id="CLIENT_ID",
+    client_secret="CLIENT_SECRET",
+    code="OAUTH_CODE",
+)
+nda.login()
+for device in nda.get_devices():
+    camera_stream = nda.get_camera_stream(device)
+    print(camera_stream.rtsp_stream_url)
+    print(camera_stream.stream_token)
+    print(camera_stream.expires_at)
+```

nestdeviceaccess/nestdeviceaccess.py

@@ -1,13 +1,20 @@
+from datetime import datetime
+
 import requests
 import pickle
 import os
 
 AUTH_URI = "https://www.googleapis.com/oauth2/v4/token"
+REFRESH_URI = "https://www.googleapis.com/oauth2/v4/token?client_id={client_id}" \
+              "&client_secret={client_secret}&refresh_token={refresh_token}" \
+              "&grant_type=refresh_token"
 DEFAULT_BASE_URI = "https://smartdevicemanagement.googleapis.com/v1"
 DEFAULT_REDIRECT_URI = "https://www.google.com"
 DEVICES_URI = (
     "https://smartdevicemanagement.googleapis.com/v1/enterprises/{project_id}/devices"
 )
+EXECUTE_COMMAND_URI = "https://smartdevicemanagement.googleapis.com/v1/enterprises/" \
+                      "{project_id}/devices/{device_id}:executeCommand"
 
 
 class ArgumentsMissingError(Exception):
@@ -18,6 +25,10 @@ class AuthorizationError(Exception):
     pass
 
 
+class InvalidActionError(Exception):
+    pass
+
+
 class NestDeviceAccessAuth(requests.auth.AuthBase):
     def __init__(
         self,
@@ -34,16 +45,16 @@ def __init__(
         self.project_id = project_id
         self.client_id = client_id
         self.client_secret = client_secret
+        self._res = {}
+        self.access_token = None
+        self.refresh_token = None
 
         if not code or code == "":
             self.invalid_token()
             raise ArgumentsMissingError()
 
         self.code = code
 
-        self._res = {}
-        self.access_token = None
-        self.refresh_token = None
         self.redirect_uri = redirect_uri
         self._session = session
 
@@ -53,6 +64,7 @@ def login(self):
                 creds = pickle.load(token)
                 self.access_token = creds["access"]
                 self.refresh_token = creds["refresh"]
+                self.refresh()
                 return
 
         data = {
@@ -86,20 +98,44 @@ def __call__(self, r):
             return r
 
     def invalid_token(self):
+        if self.refresh_token:
+            self.refresh()
+            return
         print(
             f"Go to this link to get OAuth token: https://nestservices.google.com/partnerconnections/{self.project_id}"
             f"/auth?redirect_uri=https://www.google.com&access_type=offline&prompt=consent&client_id={self.client_id}"
             f"&response_type=code&scope=https://www.googleapis.com/auth/sdm.service"
         )
 
+    def refresh(self):
+        if not self.refresh_token:
+            self.invalid_token()
+            return
+        response = requests.post(REFRESH_URI.format(client_id=self.client_id,
+                                                    client_secret=self.client_secret,
+                                                    refresh_token=self.refresh_token))
+        if response.status_code != 200:
+            if response.status_code == 400:
+                self.invalid_token()
+            raise AuthorizationError(response)
+        self.access_token = response.json()["access_token"]
+
 
 class Device(object):
     def __init__(self, dict):
         self.name = dict["name"]
+        self.device_id = self.name.split('/')[3]
         self.type = dict["type"]
         self.traits = dict["traits"]
 
 
+class CameraStream(object):
+    def __init__(self, dict):
+        self.rtsp_stream_url = dict["results"]["streamUrls"]["rtspUrl"]
+        self.stream_token = dict["results"]["streamToken"]
+        self.expires_at = datetime.strptime(dict["results"]["expiresAt"], "%Y-%m-%dT%H:%M:%S.%fZ")
+
+
 class NestDeviceAccess(object):
     def __init__(
         self,
@@ -126,7 +162,7 @@ def login(self):
             print("Authorization Error")
             pass
 
-    def devices(self):
+    def get_devices(self):
         if not self.auth.access_token:
             raise AuthorizationError()
 
@@ -139,18 +175,23 @@ def devices(self):
         devices_dict = response.json()
 
         devices = []
-        for device in devices_dict["devices"]:
-            devices.append(Device(device))
+        for device_dict in devices_dict["devices"]:
+            device = Device(device_dict)
+            devices.append(device)
         return devices
 
+    def get_camera_stream(self, device):
+        if device.type not in ["sdm.devices.types.DOORBELL", "sdm.devices.types.CAMERA"]:
+            raise InvalidActionError()
+        if not self.auth.access_token:
+            raise AuthorizationError()
 
-if __name__ == "__main__":
-    nda = NestDeviceAccess(
-        project_id="2a7ad63f-af0f-414a-b218-23dd6b39d0c5",
-        client_id="484808906646-a9tche4b03q56u47fiojh04tbf7r56m8.apps.googleusercontent.com",
-        client_secret="uS-rH6Fqcr_d_vsTHpZOZd6l",
-        code="4/0AY0e-g6INJsCbfeHVxZV_Eg1jSEdWaxI22DgTfxUFTbPSBMXAEexjT_4VY9Rf1H5jht-hQ",
-    )
-    nda.login()
-    for device in nda.devices():
-        print(device.name)
+        data = {
+            "command": "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
+            "params": {}
+        }
+        response = requests.post(EXECUTE_COMMAND_URI.format(project_id=self.project_id,
+                                                            device_id=device.device_id),
+                                 json=data,
+                                 auth=self.auth)
+        return CameraStream(response.json())

nestdeviceaccess/test_nestdeviceaccess.py

@@ -1,17 +1,14 @@
 import pytest
 import nestdeviceaccess
-
-
-def callback():
-    pass
+from datetime import datetime
 
 
 def test_require_all_arguments():
     with pytest.raises(nestdeviceaccess.ArgumentsMissingError):
         _ = nestdeviceaccess.NestDeviceAccess(project_id="", client_secret="", client_id="", code="")
 
 
-def test_url_printed_when_auth_code_not_present(capsys):
+def test_auth_code_not_present_prints_url(capsys):
     try:
         _ = nestdeviceaccess.NestDeviceAccess(project_id="123", client_secret="123", client_id="123", code="")
     except nestdeviceaccess.ArgumentsMissingError:
@@ -26,11 +23,66 @@ def test_url_printed_when_auth_code_not_present(capsys):
 def test_devices_call_without_login_fails():
     with pytest.raises(nestdeviceaccess.AuthorizationError):
         nda = nestdeviceaccess.NestDeviceAccess(project_id="123", client_secret="123", client_id="123", code="123")
-        nda.devices()
+        nda.get_devices()
 
 
 def test_failed_login_prints_error(capsys):
     nda = nestdeviceaccess.NestDeviceAccess(project_id="123", client_secret="123", client_id="123", code="123")
     nda.login()
     captured = capsys.readouterr()
     assert captured.out == "Authorization Error\n"
+
+
+def test_failed_refresh_prints_url(capsys):
+    nda = nestdeviceaccess.NestDeviceAccess(project_id="123", client_secret="123", client_id="123", code="123")
+    nda.auth.refresh()
+    captured = capsys.readouterr()
+    assert captured.out == "Go to this link to get OAuth token: " \
+                           "https://nestservices.google.com/partnerconnections/123/auth?redirect_uri=https://www" \
+                           ".google.com&access_type=offline&prompt=consent&client_id=123&response_type=code&scope" \
+                           "=https://www.googleapis.com/auth/sdm.service\n"
+
+
+def test_create_camera_stream():
+    response = {
+        "results": {
+            "streamUrls": {
+                "rtspUrl": "rtsp://123.com"
+            },
+            "streamToken": "token",
+            "expiresAt": "2020-01-01T00:00:01.000Z",
+        }
+    }
+
+    camera_stream = nestdeviceaccess.CameraStream(response)
+    assert camera_stream.rtsp_stream_url == "rtsp://123.com"
+    assert camera_stream.stream_token == "token"
+    assert camera_stream.expires_at == datetime.strptime("2020-01-01T00:00:01.000Z", "%Y-%m-%dT%H:%M:%S.%fZ")
+
+
+def test_create_device():
+    response = {
+        "name": "0/1/2/device_id",
+        "type": "type",
+        "traits": {"trait": "trait"}
+    }
+
+    device = nestdeviceaccess.Device(response)
+    assert device.name == "0/1/2/device_id"
+    assert device.device_id == "device_id"
+    assert device.type == "type"
+    assert device.traits == {"trait": "trait"}
+
+
+def test_create_camera_stream_with_non_camera():
+    response = {
+        "name": "0/1/2/device_id",
+        "type": "type",
+        "traits": {"trait": "trait"}
+    }
+    device = nestdeviceaccess.Device(response)
+
+    nda = nestdeviceaccess.NestDeviceAccess(project_id="123", client_secret="123", client_id="123", code="123")
+
+    with pytest.raises(nestdeviceaccess.InvalidActionError):
+        nda.get_camera_stream(device)