migrating and adding calls

Author: callumeveratt

custom_components/gkeep/__init__.py

@@ -1,59 +1,27 @@
-"""
-Custom component for Home Assistant to enable adding to and updating lists on
-Google Keep. This component relies on gkeepapi, an unofficial client for the
-Google Keep API (https://github.com/kiwiz/gkeepapi).
-
-Example configuration.yaml entry:
-
-gkeep:
-  username: 'this_is_my_username@gmail.com'
-  password: 'this_is_my_Google_App_password'
-
-With this custom component loaded, a new service named google_keep.add_to_list
-is available. This service data call has two inputs: 'title' and 'things', where
-'title' is the title of the Google Keep list, and 'things' is a either a list of
-things, or a string. A string input for 'things' is parsed for multiple things
-separated by 'and'.
-"""
+"""Custom component for the Google Keep API"""
+
+from .const import (
+    DOMAIN,
+    CONF_USERNAME,
+    CONF_PASSWORD,
+    CONF_LIST_NAME,
+    SERVICE_LIST_NAME,
+    SERVICE_LIST_ITEM,
+    SHOPPING_LIST_DOMAIN,
+    SERVICE_LIST_EMAIL
+)
+
+from .schema import (
+    SERVICE_LIST_SCHEMA,
+    SERVICE_LIST_NAME_SCHEMA,
+    SERVICE_LIST_EMAIL_SCHEMA
+)
 
 import logging
-
-import voluptuous as vol
-import homeassistant.helpers.config_validation as cv
-
 from homeassistant.core import callback
 
 _LOGGER = logging.getLogger(__name__)
 
-# Domain and component constants and validation
-DOMAIN = "gkeep"
-SHOPPING_LIST_DOMAIN = "shopping_list"
-CONF_USERNAME = 'username'    # Google account username
-CONF_PASSWORD = 'password'    # Google App password, https://myaccount.google.com/apppasswords
-CONF_LIST_NAME = 'list_name'  # Default Google Keep list title
-DEFAULT_LIST_NAME = 'Grocery'
-
-CONFIG_SCHEMA = vol.Schema({
-    DOMAIN: vol.Schema({
-        vol.Required(CONF_USERNAME): cv.string,
-        vol.Required(CONF_PASSWORD): cv.string,
-        vol.Optional(CONF_LIST_NAME, default=DEFAULT_LIST_NAME): cv.string,
-    }),
-}, extra=vol.ALLOW_EXTRA)
-
-# Service constants and validation
-SERVICE_LIST_NAME = 'title'   # Title of the Google Keep list to create or update, string
-SERVICE_LIST_ITEM = 'things'  # Things(s) to add to the list
-
-SERVICE_LIST_SCHEMA = vol.Schema({
-    vol.Optional(SERVICE_LIST_NAME): cv.string,
-    vol.Required(SERVICE_LIST_ITEM): cv.ensure_list_csv,
-})
-
-SERVICE_LIST_NAME_SCHEMA = vol.Schema({
-    vol.Optional(SERVICE_LIST_NAME): cv.string,
-})
-
 def setup(hass, config):
     """Setup the google_keep component."""
 
@@ -151,11 +119,20 @@ def clear_shopping_list(call):
         """Clear a google keep shopping list."""        
         list_name = call.data.get(SERVICE_LIST_NAME, default_list_name)
 
-        # Sync with Google servers
-        keep.sync()
         google_keep_list = _get_or_create_list_name_(list_name)
         google_keep_list.delete()
-        
+        keep.sync()
+
+    def share_shopping_list(call):
+        """Share a google keep list"""
+        list_name = call.data.get(SERVICE_LIST_NAME, default_list_name)
+        email = call.data.get(SERVICE_LIST_EMAIL)
+
+        google_keep_list = _get_or_create_list_name_(list_name)
+
+        if not email in google_keep_list.collaborators.all():
+            google_keep_list.collaborators.add(email)
+            keep.sync()
 
     def _get_or_create_list_name_(list_name):
         """ Find the target list amongst all the Keep notes/lists """
@@ -174,6 +151,7 @@ def _get_or_create_list_name_(list_name):
     # Register the service google_keep.add_to_list with Home Assistant.
     hass.services.register(DOMAIN, 'add_to_list', add_to_list, schema=SERVICE_LIST_SCHEMA)
     hass.services.register(DOMAIN, 'clear_shopping_list', clear_shopping_list, schema=SERVICE_LIST_SCHEMA)
+    hass.services.register(DOMAIN, 'share_shopping_list', share_shopping_list, schema=SERVICE_LIST_EMAIL_SCHEMA)
 
     # Register the service google_keep.sync_shopping_list with Home Assistant.
     SHOPPING_LIST = hass.data.get(SHOPPING_LIST_DOMAIN)

custom_components/gkeep/const.py

@@ -0,0 +1,11 @@
+"""Constants for Google Keep"""
+
+DOMAIN = "gkeep"
+SHOPPING_LIST_DOMAIN = "shopping_list"
+CONF_USERNAME = 'username'    # Google account username
+CONF_PASSWORD = 'password'    # Google App password, https://myaccount.google.com/apppasswords
+CONF_LIST_NAME = 'list_name'  # Default Google Keep list title
+DEFAULT_LIST_NAME = 'Grocery'
+SERVICE_LIST_NAME = 'title'   # Title of the Google Keep list to create or update, string
+SERVICE_LIST_ITEM = 'things'  # Things(s) to add to the list
+SERVICE_LIST_EMAIL = 'email'

custom_components/gkeep/manifest.json

@@ -1,9 +1,9 @@
 {
   "domain": "gkeep",
   "name": "Google Keep",
-  "documentation": "https://github.com/aFrankLion/hass-google_keep",
+  "documentation": "https://github.com/callumeveratt/hass-google_keep",
   "dependencies": [],
-  "version": "0.2.1",
-  "codeowners": ["@aFrankLion"],
-  "requirements": ["gkeepapi==0.13.4"]
+  "version": "0.2.2",
+  "codeowners": ["@callumeveratt"],
+  "requirements": ["gkeepapi==0.14.2"]
 }

custom_components/gkeep/schema.py

@@ -0,0 +1,36 @@
+"""Schemas for Google Keep"""
+
+from .const import (
+    CONF_USERNAME,
+    CONF_PASSWORD,
+    CONF_LIST_NAME,
+    SERVICE_LIST_NAME,
+    SERVICE_LIST_ITEM,
+    DEFAULT_LIST_NAME,
+    SERVICE_LIST_EMAIL
+)
+
+import voluptuous as vol
+import homeassistant.helpers.config_validation as cv
+
+CONFIG_SCHEMA = vol.Schema({
+    DOMAIN: vol.Schema({
+        vol.Required(CONF_USERNAME): cv.string,
+        vol.Required(CONF_PASSWORD): cv.string,
+        vol.Optional(CONF_LIST_NAME, default=DEFAULT_LIST_NAME): cv.string,
+    }),
+}, extra=vol.ALLOW_EXTRA)
+
+SERVICE_LIST_SCHEMA = vol.Schema({
+    vol.Optional(SERVICE_LIST_NAME): cv.string,
+    vol.Required(SERVICE_LIST_ITEM): cv.ensure_list_csv,
+})
+
+SERVICE_LIST_NAME_SCHEMA = vol.Schema({
+    vol.Optional(SERVICE_LIST_NAME): cv.string,
+})
+
+SERVICE_LIST_EMAIL_SCHEMA = vol.Schema({
+    vol.Optional(SERVICE_LIST_NAME): cv.string,
+    vol.Required(SERVICE_LIST_EMAIL): cv.string
+})

custom_components/gkeep/services.yaml

@@ -16,3 +16,20 @@ sync_shopping_list:
     title:
       description: Title of the Google Keep list for syncing the shopping list
       example: 'Grocery'
+
+clear_shopping_list:
+  description: Clear a Google Keep shopping list.
+  fields:
+    title:
+      description: Title of the Google Keep list for syncing the shopping list
+      example: 'Grocery'
+
+share_shopping_list:
+  description: Share a Google Keep Shopping list
+  fields:
+    title:
+      description: Title of the Google Keep list for sharing
+      example: 'Grocery'
+    email:
+      description: Email of the sharer
+      example: 'example@me.com'