Google Calendar round 2 #4161

mnestor · 2016-10-31T22:58:14Z

Description:
Creating a new pull since #2052 was closed so long ago.

Adds Google Calendar Event Devices and a generic Calendar Device for future calendar integration.
I've set this up after discussions with @Bart274 about doing an iCloud calendar similar to this so it should be easier to add in that support after this.

Related issue (if applicable): fixes #

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#1403

Example entry for configuration.yaml:

google:
  client_id: al8e43hyoahjweog8h # required, this comes from Google Api Console
  client_secret: laih34go8ahewo48h # required, comes from Google
  track_new_calendar: yes  # optional, defaults to yes

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable ([example][ex-requir]).
New dependencies are only imported inside functions that use them ([example][ex-import]).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

mention-bot · 2016-10-31T22:58:15Z

@mnestor, thanks for your PR! By analyzing the history of the files in this pull request, we identified @balloob, @fabaff and @kfgoode to be potential reviewers.

balloobbot · 2016-10-31T22:58:19Z

homeassistant/components/calendar/__init__.py

+from homeassistant.helpers.entity import Entity
+from homeassistant.const import (STATE_ON, STATE_OFF)
+from homeassistant.util import Throttle
+from homeassistant.components import (


farcy v1.1

1: F401 'homeassistant.components.google' imported but unused

balloobbot · 2016-10-31T22:58:20Z

homeassistant/components/google.py

+"""
+import os
+import logging
+import socket


farcy v1.1

1: F401 'socket' imported but unused

balloobbot · 2016-10-31T22:58:20Z

homeassistant/components/google.py

+import os
+import logging
+import socket
+from datetime import timedelta


farcy v1.1

1: F401 'datetime.timedelta' imported but unused

balloobbot · 2016-10-31T22:58:21Z

homeassistant/components/google.py

+import homeassistant.helpers.config_validation as cv
+import homeassistant.loader as loader
+from homeassistant import bootstrap
+from homeassistant.const import HTTP_OK


farcy v1.1

1: F401 'homeassistant.const.HTTP_OK' imported but unused

balloobbot · 2016-10-31T22:58:21Z

homeassistant/components/google.py

+        hass, 'In order to authorize Home-Assistant to view your calendars'
+              'You must visit: <a href="{}" target="_blank">{}</a> and enter'
+              'code: {}'.format(devFlow.verification_url,
+                devFlow.verification_url, devFlow.user_code),


farcy v1.1

17: E128 continuation line under-indented for visual indent

balloobbot · 2016-10-31T22:58:21Z

homeassistant/components/google.py

+            title=NOTIFICATION_TITLE, notification_id=NOTIFICATION_ID)
+
+    listener = track_time_change(hass, step2_exchange,
+        second=range(0, 60, devFlow.interval))


farcy v1.1

9: E128 continuation line under-indented for visual indent

balloobbot · 2016-10-31T22:58:22Z

homeassistant/components/google.py

+    for calendar_hash, calendar in calendars.items():
+        _CALENDARS.update({calendar_hash: calendar})
+        discovery.load_platform(hass, 'calendar', DOMAIN,
+        _CALENDARS[calendar_hash])


farcy v1.1

9: E128 continuation line under-indented for visual indent

balloobbot · 2016-10-31T22:58:22Z

homeassistant/components/google.py

+        _CALENDARS[calendar_hash]
+    )
+
+    discovery.load_platform(hass, 'calendar', DOMAIN, _CALENDARS[calendar_hash])


farcy v1.1

80: E501 line too long (80 > 79 characters)

lwis · 2016-11-01T07:10:21Z

Could we have the ability to specify a list of calendars we want to track? Also, thanks for continuing this!

mnestor · 2016-11-01T09:34:24Z

@lwis It's there, it creates a google_calendars.yaml file similar to known_devices.yaml and also allows you to specify search based.

But I just realized I messed that up when I tried to make it so you could specify the device name. Crap.

a7709b23defc0ebf26e56c9b05b046c2866d6b6fb76223d0522986f8:
  cal_id: 072pj7okgusgb14uqqj0rgf15n9jhmeg@import.calendar.google.com
  entities:
  - name: Mike Nestor (TripIt)
    search: null
    track: true
  name: Mike Nestor (TripIt)
c379a36a72dc93de3bce26b627af0966ec88089abde13045b739613b:
  cal_id: asdfasdf@group.calendar.google.com
  entities:
  - name: Maggie
    search: null
    track: false
  - name: Maggie
    search: Vet
    track: true
  name: Maggie

lwis · 2016-11-01T10:52:41Z

@mnestor one comment, if search is null we shouldn't write/display it, just make sure that it's documented on the website.

mnestor · 2016-11-01T12:40:10Z

@lwis

Changed the google_calendars.yaml around

- cal_id: blahasldfhaiehg@group.calendar.google.com
  entities:
  - device_id: things_to_do
    name: Things to do
    track: false

- cal_id: '#contacts@group.v.calendar.google.com'
  entities:
  - device_id: contacts
    name: Contacts
    track: false

- cal_id: en.usa#holiday@group.v.calendar.google.com
  entities:
  - device_id: holidays_in_united_states
    name: Holidays in United States
    track: false
  - device_id: holidays_chistmas
    name: Christmas
    search: Christmas Day
    track: true

The above would only create one calendar, a search based one in you holiday calendar to turn on only on Christmas Day.

Bart274 · 2016-11-03T09:27:13Z

@mnestor I'll take a look at how I can use your component to add an icloud calendar as well :-)

mnestor · 2016-11-04T18:40:39Z

@Bart274 Nothing has changed since we last talked. I've just found a new way to do the oauth for the google part that makes it a LOT easier for people to get setup.

Bart274 · 2016-11-04T18:42:12Z

@mnestor I see, I will look how I can add the icloud calendar :)

balloob · 2016-11-06T19:05:30Z

homeassistant/components/google.py

+REQUIREMENTS = [
+    'google-api-python-client==1.5.4',
+]
+DEPENDENCIES = ['calendar']


The Google component shouldn't depend on calendar.

balloob · 2016-11-06T19:06:26Z

homeassistant/components/calendar/__init__.py

+    @property
+    def track(self):
+        """Are we tracking events on this search sensor."""
+        return self._track


What does this mean? If it shouldn't track anything it shouldn't have been loaded to begin with.

Yeah, that's dumb. Copy/paste I never thought about.

balloob · 2016-11-06T19:06:56Z

homeassistant/components/calendar/__init__.py

+        self._end_listener = track_point_in_time(self.hass, _end,
+                                                 self._cal_data['end'])
+
+    def value_changed(self, state):


Doesn't seem to be used?

It appeared, months ago, that this was called by another process and I didn't have to deal with changing the state. I take it either I'm wrong about that and this was never needed?

Do I need to call update_ha_state when state data changes?

Home Assistant will automatically call update every 60 seconds (as that's what you entered into the EntityComponent constructor).

balloob · 2016-11-06T19:07:35Z

homeassistant/components/calendar/__init__.py

+        """Return the device name."""
+        return self._name
+
+    @property


This is not being used outside of this entity. You can just have other pieces of code directly refer to the internal attribute self._state. I also think that self._state could be renamed to better describe what the value means that it holds (I'm assuming it represents if an event is currently happening?).

I'm confused. I thought this was needed so I could check it in an automation?

- condition: state entity_id: calendar.name state: 'on'

I left it as on/off since it made sense to me as these are basically binary switches for being in an event state.

None of the properties that are defined on an entity will be set as state attributes. That's what state_attributes is for.

balloob · 2016-11-06T19:15:10Z

homeassistant/components/google.py

+    def _found_calendar(call):
+        """Check if we know about a calendar and generate PLATFORM_DISCOVER."""
+        calendar = get_calendar_info(hass, call.data)
+        if _CALENDARS.get(calendar[CONF_CAL_ID], None) is not None:


We have added hass.data as a dictionary for components to store data. You will no longer need to use globals. Make sure you make the key unique to your component, ie hass.data['google_calendars']

balloob · 2016-11-06T19:16:26Z

homeassistant/components/demo.py

@@ -17,6 +17,7 @@
 COMPONENTS_WITH_DEMO_PLATFORM = [
    'alarm_control_panel',
    'binary_sensor',
+    'calendar',


A demo platform has not been included?

It got lost when I built a new system to work on this on. I'll get it added back.

balloob · 2016-11-06T19:16:43Z

homeassistant/components/google.py

+DEPENDENCIES = ['calendar']
+
+_LOGGER = logging.getLogger(__name__)
+_CONFIGURING = {}


This doesn't seem to be used.

balloob · 2016-11-11T04:28:06Z

homeassistant/components/calendar/__init__.py

+        """
+        raise NotImplementedError(message)
+
+    @Throttle(MIN_TIME_BETWEEN_UPDATES)


We should never throttle at the entity level. It is up to the platforms to decide how much they require throttling. For example the demo platform will never need a throttle.

I think I've changed it to how you want it.

balloob · 2016-11-15T06:37:59Z

homeassistant/components/google.py

+
+TOKEN_FILE = '.{}.token'.format(DOMAIN)
+
+PLATFORM_SCHEMA = vol.Schema({


This is a component, so you should use CONFIG_SCHEMA. See group example

balloob · 2016-11-15T06:39:17Z

homeassistant/components/google.py

+def setup(hass, config):
+    """Setup the platform."""
+    config = config.get(DOMAIN, {})
+    if isinstance(config, list) and len(config) > 0:


This will no longer ben ecessary when you define CONFIG_SCHEMA instead of PLATFORM_SCHEMA

balloob · 2016-11-15T06:40:17Z

homeassistant/components/google.py

+    bootstrap.setup_component(hass, 'calendar', config)
+
+    for calendar in hass.data[DATA_INDEX].values():
+        discovery.load_platform(hass, 'calendar', DOMAIN, calendar)


Is calendar JSON serializable?

balloob · 2016-11-15T07:11:14Z

homeassistant/components/google.py

+
+def update_config(path, calendar):
+    """Write the google_calendar_devices.yaml."""
+    with threading.Lock():


This will create a new lock every time you call this, so that means that the lock is never shared -> the locking won't work

balloob · 2016-11-15T07:12:52Z

.coveragerc

@@ -28,6 +28,9 @@ omit =
    homeassistant/components/envisalink.py
    homeassistant/components/*/envisalink.py

+    homeassistant/components/google.py


No need to exclude from coverage if you wrote tests ?

@balloob how would I go about disabling coverage for the google api stuff? Since I'm not failing for those.

balloobbot reviewed Oct 31, 2016

View reviewed changes

homeassistant/components/google.py

"""

import os

import logging

import socket

Copy link

balloobbot Oct 31, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

farcy v1.1

1: F401 'socket' imported but unused

balloobbot reviewed Oct 31, 2016

View reviewed changes

mnestor force-pushed the google_calendar branch 3 times, most recently from 0a40c39 to 7c20cd5 Compare November 1, 2016 01:03

mnestor force-pushed the google_calendar branch from 7c20cd5 to 5a466a4 Compare November 1, 2016 12:37

mnestor force-pushed the google_calendar branch 2 times, most recently from 7225626 to 2c4038d Compare November 2, 2016 00:22

mnestor force-pushed the google_calendar branch 4 times, most recently from ec6c57f to 4eaf1b8 Compare November 5, 2016 18:54

mnestor changed the title ~~WIP: Google Calendar round 2~~ Google Calendar round 2 Nov 5, 2016

mnestor mentioned this pull request Nov 5, 2016

Documentation for Google Calendar component home-assistant/home-assistant.io#1403

Merged

balloob reviewed Nov 6, 2016

View reviewed changes

balloob reviewed Nov 11, 2016

View reviewed changes

mnestor force-pushed the google_calendar branch 3 times, most recently from a8dc664 to 22ddc68 Compare November 13, 2016 21:10

balloob reviewed Nov 15, 2016

View reviewed changes

mnestor force-pushed the google_calendar branch from 22ddc68 to 1f3bc08 Compare November 15, 2016 14:25

Google Calendar round 2

044642a

mnestor force-pushed the google_calendar branch from 1f3bc08 to 044642a Compare November 16, 2016 11:41

balloob added 2 commits November 18, 2016 22:07

Add google back to .coveragerc

634f583

Update __init__.py

704d2bd

balloob merged commit 6136154 into home-assistant:dev Nov 19, 2016

home-assistant locked and limited conversation to collaborators Mar 17, 2017


		TOKEN_FILE = '.{}.token'.format(DOMAIN)

		PLATFORM_SCHEMA = vol.Schema({

Google Calendar round 2 #4161

Google Calendar round 2 #4161

Conversation

mnestor commented Oct 31, 2016 • edited by fabaff

mention-bot commented Oct 31, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lwis commented Nov 1, 2016 • edited

mnestor commented Nov 1, 2016

lwis commented Nov 1, 2016

mnestor commented Nov 1, 2016 • edited

Bart274 commented Nov 3, 2016

mnestor commented Nov 4, 2016

Bart274 commented Nov 4, 2016 via email

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mnestor commented Oct 31, 2016 •

edited by fabaff

lwis commented Nov 1, 2016 •

edited

mnestor commented Nov 1, 2016 •

edited