Merge pull request #8 from nahum365/linter

Merge version 0.0.1 and documentation

Author: nahum365

.gitignore

@@ -0,0 +1,6 @@
+*/__pycache__
+env
+.idea
+docs/_build
+docs/_static
+docs/_templates

.travis.yml

@@ -5,7 +5,7 @@ python:
 install:
   - pip install -r requirements.txt
 script:
-  - flake8 nestdeviceaccess/
+  - flake8 --max-line-length 120 nestdeviceaccess/
   - pytest nestdeviceaccess/test_nestdeviceaccess.py
   - coverage run -m pytest nestdeviceaccess/test_nestdeviceaccess.py
 after_success:

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+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/conf.py

@@ -0,0 +1,67 @@
+import sphinx_rtd_theme
+from recommonmark.transform import AutoStructify
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'python-nestdeviceaccess'
+copyright = '2020, Nahum Getachew'
+author = 'Nahum Getachew'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['recommonmark']
+source_suffix = ['.rst', '.md']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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 = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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']
+
+
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        'auto_toc_tree_section': 'Contents',
+    }, True)
+    app.add_transform(AutoStructify)

docs/index.md

@@ -0,0 +1,11 @@
+# Welcome to python-nestdeviceaccess's documentation!
+
+## Overview 
+This Python library seeks to allow easy access to Google Nest devices using the Nest Device Access Smart Management API.
+It allows interfacing with:
+
+- Nest Hello doorbell
+
+Coming soon:
+
+- Nest thermostat

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+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% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

nestdeviceaccess/nestdeviceaccess.py

@@ -1,9 +1,13 @@
 import requests
-from requests import auth
+import pickle
+import os
 
 AUTH_URI = "https://www.googleapis.com/oauth2/v4/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"
+)
 
 
 class ArgumentsMissingError(Exception):
@@ -14,45 +18,139 @@ class AuthorizationError(Exception):
     pass
 
 
-class NestDeviceAccessAuth(auth.AuthBase):
-    def __init__(self, auth_callback, client_id, client_secret, code, session=None, redirect_uri=DEFAULT_REDIRECT_URI):
-        if not client_id or client_secret or not code or client_id == "" or client_secret == "" or code == "":
+class NestDeviceAccessAuth(requests.auth.AuthBase):
+    def __init__(
+        self,
+        project_id,
+        client_id,
+        client_secret,
+        code,
+        session=None,
+        redirect_uri=DEFAULT_REDIRECT_URI,
+    ):
+        if client_id == "" or client_secret == "" or project_id == "":
             raise ArgumentsMissingError()
-        self._res = {}
+
+        self.project_id = project_id
         self.client_id = client_id
         self.client_secret = client_secret
+
+        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
-        self.auth_callback = auth_callback
-
-    def login(self, headers=None):
-        data = {'client_id': self.client_id,
-                'client_secret': self.client_secret,
-                'code': self.code,
-                'grant_type': 'authorization_code',
-                'redirect_uri': self.redirect_uri}
-        post = requests.post
-        response = post(AUTH_URI, params=data, headers=headers)
+
+    def login(self):
+        if os.path.exists("auth.bak"):
+            with open("auth.bak", "rb") as token:
+                creds = pickle.load(token)
+                self.access_token = creds["access"]
+                self.refresh_token = creds["refresh"]
+                return
+
+        data = {
+            "client_id": self.client_id,
+            "client_secret": self.client_secret,
+            "code": self.code,
+            "grant_type": "authorization_code",
+            "redirect_uri": self.redirect_uri,
+        }
+        response = requests.post(AUTH_URI, params=data)
         if response.status_code != 200:
-            print(response.content)
+            if response.status_code == 400:
+                self.invalid_token()
             raise AuthorizationError(response)
         self._res = response.json()
-        self.auth_callback(self._res)
+        self.access_token = self._res["access_token"]
+        self.refresh_token = self._res["refresh_token"]
+
+        with open("auth.bak", "wb") as token:
+            pickle.dump(
+                {"access": self.access_token, "refresh": self.refresh_token}, token
+            )
+
+    def __call__(self, r):
+        if self.access_token is not None:
+            r.headers["authorization"] = "Bearer " + self.access_token
+            return r
+        else:
+            self.login()
+            r.headers["authorization"] = "Bearer " + self.access_token
+            return r
+
+    def invalid_token(self):
+        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"
+        )
+
+
+class Device(object):
+    def __init__(self, dict):
+        self.name = dict["name"]
+        self.type = dict["type"]
+        self.traits = dict["traits"]
 
 
 class NestDeviceAccess(object):
-    def __init__(self, client_id, client_secret, code, redirect_uri=DEFAULT_REDIRECT_URI):
-        auth = NestDeviceAccessAuth(client_id, client_secret, code, self.login_callback, redirect_uri)
-        self._session = requests.Session()
-        self._session.auth = auth
+    def __init__(
+        self,
+        project_id,
+        client_id,
+        client_secret,
+        code,
+        redirect_uri=DEFAULT_REDIRECT_URI,
+    ):
+        self.auth = NestDeviceAccessAuth(
+            project_id, client_id, client_secret, code, redirect_uri
+        )
+        self.access_token = None
+        self.refresh_token = None
 
-    def login_callback(self, res):
-        print(res)
+        self.project_id = project_id
+        self.client_id = client_id
+        self.client_secret = client_secret
 
     def login(self):
-        self._session.auth.login()
+        try:
+            self.auth.login()
+        except AuthorizationError:
+            print("Authorization Error")
+            pass
+
+    def devices(self):
+        if not self.auth.access_token:
+            raise AuthorizationError()
+
+        response = requests.get(
+            DEVICES_URI.format(project_id=self.project_id), auth=self.auth
+        )
+        if response.status_code != 200:
+            if response.status_code == 400:
+                raise AuthorizationError(response)
+        devices_dict = response.json()
+
+        devices = []
+        for device in devices_dict["devices"]:
+            devices.append(Device(device))
+        return devices
 
 
-#nda = NestDeviceAccess(client_id="484808906646-a9tche4b03q56u47fiojh04tbf7r56m8.apps.googleusercontent.com", client_secret="uS-rH6Fqcr_d_vsTHpZOZd6l", code="4/5AE-0v8n60-tkng0pcvVhgviF1i77yUfpseFxiURRzPi_vdlHDRCe2KL8nOnUa0AcDF4a2aKHarqChm6SQC4FoQ")
-#nda.login()
+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)

nestdeviceaccess/test_nestdeviceaccess.py

@@ -8,5 +8,29 @@ def callback():
 
 def test_require_all_arguments():
     with pytest.raises(nestdeviceaccess.ArgumentsMissingError):
-        _ = nestdeviceaccess.NestDeviceAccess(client_secret="", client_id="", code="")
+        _ = nestdeviceaccess.NestDeviceAccess(project_id="", client_secret="", client_id="", code="")
 
+
+def test_url_printed_when_auth_code_not_present(capsys):
+    try:
+        _ = nestdeviceaccess.NestDeviceAccess(project_id="123", client_secret="123", client_id="123", code="")
+    except nestdeviceaccess.ArgumentsMissingError:
+        pass
+    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_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()
+
+
+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"