fix(homebridge): keep refreshToken up to date in config.json

#109

Author: dgreif

api/api.ts

@@ -22,6 +22,7 @@ export interface RingApiOptions {
 
 export class RingApi {
   public readonly restClient = new RingRestClient(this.options)
+  public readonly onRefreshTokenUpdated = this.restClient.onRefreshTokenUpdated.asObservable()
 
   private locations = this.fetchAndBuildLocations()
 

api/rest-client.ts

@@ -2,6 +2,7 @@ import axios, { AxiosRequestConfig, ResponseType } from 'axios'
 import { delay, generateRandomId, logError, logInfo, stringify } from './util'
 import * as querystring from 'querystring'
 import { AuthTokenResponse, SessionResponse } from './ring-types'
+import { ReplaySubject } from 'rxjs'
 
 const ringErrorCodes: { [code: number]: string } = {
     7050: 'NO_ASSET',
@@ -68,6 +69,10 @@ export class RingRestClient {
   private authPromise = this.getAuth()
   private sessionPromise = this.getSession()
   public using2fa = false
+  public onRefreshTokenUpdated = new ReplaySubject<{
+    oldRefreshToken?: string
+    newRefreshToken: string
+  }>(1)
 
   constructor(private authOptions: RingAuth) {}
 
@@ -113,6 +118,10 @@ export class RingRestClient {
         }
       })
 
+      this.onRefreshTokenUpdated.next({
+        oldRefreshToken: this.refreshToken,
+        newRefreshToken: response.refresh_token
+      })
       this.refreshToken = response.refresh_token
 
       return response

homebridge/config.ts

@@ -1,4 +1,5 @@
 import { RingApiOptions } from '../api'
+import { readFileSync, writeFileSync } from 'fs'
 
 export interface RingPlatformConfig extends RingApiOptions {
   alarmOnEntryDelay?: boolean
@@ -10,3 +11,19 @@ export interface RingPlatformConfig extends RingApiOptions {
   hideAlarmSirenSwitch?: boolean
   showPanicButtons?: boolean
 }
+
+export function updateHomebridgeConfig(
+  homebridge: any,
+  update: (config: string) => string
+) {
+  const configPath = homebridge.user.configPath(),
+    config = readFileSync(configPath).toString(),
+    updatedConfig = update(config)
+
+  if (config !== updatedConfig) {
+    writeFileSync(configPath, updatedConfig)
+    return true
+  }
+
+  return false
+}

homebridge/index.ts

@@ -3,12 +3,13 @@ import { hap } from './hap'
 import { readFileSync, writeFileSync } from 'fs'
 import { join as joinPath } from 'path'
 import {
-  platformName,
-  pluginName,
   oldPlatformName,
-  oldPluginName
+  oldPluginName,
+  platformName,
+  pluginName
 } from './plugin-info'
 import { logError } from '../api/util'
+import { updateHomebridgeConfig } from './config'
 
 export default function(homebridge: any) {
   hap.PlatformAccessory = homebridge.platformAccessory
@@ -29,25 +30,17 @@ export default function(homebridge: any) {
       cachedAccessories = readFileSync(cachedAccessoriesPath).toString(),
       updatedAccessories = cachedAccessories
         .replace(new RegExp(oldPluginName, 'g'), pluginName)
-        .replace(new RegExp(oldPlatformName, 'g'), platformName),
-      configPath = homebridge.user.configPath(),
-      config = readFileSync(configPath).toString(),
-      updatedConfig = config.replace(
-        `"${oldPlatformName}"`,
-        `"${platformName}"`
-      )
-    let filesChanged = false
+        .replace(new RegExp(oldPlatformName, 'g'), platformName)
+
+    let filesChanged = updateHomebridgeConfig(homebridge, config => {
+      return config.replace(`"${oldPlatformName}"`, `"${platformName}"`)
+    })
 
     if (cachedAccessories !== updatedAccessories) {
       writeFileSync(cachedAccessoriesPath, updatedAccessories)
       filesChanged = true
     }
 
-    if (config !== updatedConfig) {
-      writeFileSync(configPath, updatedConfig)
-      filesChanged = true
-    }
-
     if (filesChanged) {
       logError(
         'Your Ring Alarm config has been updated to new Ring config.  This is a one time thing, and you do not need to do anything.  Just restart homebridge and everything should start normally.'

homebridge/ring-platform.ts

@@ -15,7 +15,7 @@ import { Lock } from './lock'
 import { SmokeAlarm } from './smoke-alarm'
 import { CoAlarm } from './co-alarm'
 import { SmokeCoListener } from './smoke-co-listener'
-import { RingPlatformConfig } from './config'
+import { RingPlatformConfig, updateHomebridgeConfig } from './config'
 import { Beam } from './beam'
 import { MultiLevelSwitch } from './multi-level-switch'
 import { Fan } from './fan'
@@ -241,5 +241,17 @@ export class RingPlatform {
         staleAccessories
       )
     }
+
+    ringApi.onRefreshTokenUpdated.subscribe(
+      ({ oldRefreshToken, newRefreshToken }) => {
+        if (!oldRefreshToken) {
+          return
+        }
+
+        updateHomebridgeConfig(this.api, config => {
+          return config.replace(oldRefreshToken, newRefreshToken)
+        })
+      }
+    )
   }
 }