feat: rename npm modules to match functionality

dgreif · dgreif · commit 8e7c387d5130 · 2019-07-12T15:50:07.000-07:00
BREAKING CHANGE: `homebridge-ring-alarm` renamed to `homebridge-ring`.  The config for homebridge should now be `"platform": "Ring"` instead of `"platform": "RingAlarm"`.  This config change will happen automatically the first time you start homebridge with the new version, but it will cause homebridge to error out after the config is changed.  You will see a log that the config has changed and you can restart homebridge.
BREAKING CHANGE: `@dgreif/ring-alarm` renamed to `ring-client-api`.  The exported class is now `RingApi` instead of `RingAlarmApi`.  Proper usage now looks like `import { RingApi } from "ring-client-api"`.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# ring-alarm
+# ring-client-api
  
 [![CircleCI](https://circleci.com/gh/dgreif/ring.svg?style=svg)](https://circleci.com/gh/dgreif/ring)
 [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=HD9ZPB34FY428&currency_code=USD&source=url)
@@ -8,16 +8,16 @@ This is an unofficial TypeScript api for [Ring Doorbells](https://shop.ring.com/
 the [Ring Alarm System](https://shop.ring.com/pages/security-system),
 [Ring Smart Lighting](https://shop.ring.com/pages/smart-lighting),
 and third party devices that connect to the Ring Alarm System.
-Built to support the [homebridge-ring-alarm Plugin](./homebridge)
+Built to support the [homebridge-ring Plugin](./homebridge)
  
 ## Installation
 
-`npm i @dgreif/ring-alarm`
+`npm i ring-client-api`
 
 
 ## Setup and Config
 ```js
-import { RingApi } from '@dgreif/ring-alarm'
+import { RingApi } from 'ring-client-api'
 
 const ringApi = new RingApi({
   email: 'some.one@website.com',
@@ -32,7 +32,7 @@ const ringApi = new RingApi({
 
 ### Optional Parameters
 `locationIds`: Allows you to limit the results to a specific set of locations.
-This is mainly useful for the [homebridge-ring-alarm Plugin](./homebridge), but can also be used if you only care about
+This is mainly useful for the [homebridge-ring Plugin](./homebridge), but can also be used if you only care about
 listening for events at a subset of your locations and don't want to create websocket connections to _all_ of your locations.
 This will also limit the results for `ringApi.getCameras()` to the configured locations.
 If this option is not included, all locations will be returned.
@@ -65,7 +65,7 @@ Once you have acquired the desired location, you can start
 to interact with associated devices. These devices include ring alarm, ring lighting,
 and third party devices connected to ring alarm
 ```js
-import { RingDeviceType } from '@dgreif/ring-alarm'
+import { RingDeviceType } from 'ring-client-api'
 
 const devices = await location.getDevices()
 const baseStation = devices.find(device => device.data.deviceType === RingDeviceType.BaseStation)
@@ -116,11 +116,11 @@ v3 exports a full `RingApi` object instead of a single `getLocations` method.
 
 ```typescript
 // v2
-import { getLocations } from '@dgreif/ring-alarm'
+import { getLocations } from 'ring-client-api'
 const locations = await getLocations(options)
 
 // v3
-import { RingApi } from '@dgreif/ring-alarm'
+import { RingApi } from 'ring-client-api'
 const ringApi = new RingApi(options),
   locations = await ringApi.getLocations(), // same locations object form v2
   cameras = await ringApi.getCameras() // new! all cameras from all locations
@@ -129,9 +129,9 @@ const ringApi = new RingApi(options),
 v3 also exposes some other top level methods like `ringApi.getHistory()` and `ringApi.fetchRingDevices()`.
 Since these are global across all locations, it no longer made sense to export a single `getLocations` method.
 
-## homebridge-ring-alarm
+## homebridge-ring
 
-The `homebridge-ring-alarm` is also maintained in this repo.  It's readme can be found in [the `homebridge` directory](./homebridge)
+The `homebridge-ring` is also maintained in this repo.  It's readme can be found in [the `homebridge` directory](./homebridge)
 
 ## Credits
 
diff --git a/api/api.ts b/api/api.ts
@@ -12,7 +12,7 @@ import { RingCamera } from './ring-camera'
 import { EMPTY, merge, Subject } from 'rxjs'
 import { debounceTime, switchMap, throttleTime } from 'rxjs/operators'
 
-export interface RingAlarmOptions {
+export interface RingApiOptions {
   locationIds?: string[]
   cameraStatusPollingSeconds?: number
   cameraDingsPollingSeconds?: number
@@ -23,7 +23,7 @@ export class RingApi {
 
   private locations = this.fetchAndBuildLocations()
 
-  constructor(public readonly options: RingAlarmOptions & RingAuth) {}
+  constructor(public readonly options: RingApiOptions & RingAuth) {}
 
   async fetchRingDevices() {
     const {
diff --git a/api/util.ts b/api/util.ts
@@ -3,7 +3,7 @@ import { red } from 'colors'
 import { randomBytes } from 'crypto'
 import { createInterface } from 'readline'
 
-const logger = debug('ring-alarm')
+const logger = debug('ring')
 
 export function delay(milliseconds: number) {
   return new Promise(resolve => {
diff --git a/homebridge/README.md b/homebridge/README.md
@@ -1,4 +1,4 @@
-# homebridge-ring-alarm
+# homebridge-ring
  
 [![CircleCI](https://circleci.com/gh/dgreif/ring.svg?style=svg)](https://circleci.com/gh/dgreif/ring)
 [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=HD9ZPB34FY428&currency_code=USD&source=url)
@@ -14,17 +14,17 @@ and third party devices that connect to the Ring Alarm System.
  
  Assuming a global installation of `homebridge`:
  
- `npm i -g homebridge-ring-alarm`
+ `npm i -g homebridge-ring`
  
  ## Homebridge Configuration
  
- Add the `RingAlarm` platform in your homebridge `config.json` file.
+ Add the `Ring` platform in your homebridge `config.json` file.
  
  ```js
 {
   "platforms": [
     {
-      "platform": "RingAlarm",
+      "platform": "Ring",
       "email": "some.one@website.com",
       "password": "abc123!#",
       
diff --git a/homebridge/base-accessory.ts b/homebridge/base-accessory.ts
@@ -3,13 +3,13 @@ import { HAP } from './hap'
 import Service = HAP.Service
 import { debounceTime, distinctUntilChanged, map, take } from 'rxjs/operators'
 import { Observable, Subject } from 'rxjs'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 
 export abstract class BaseAccessory<T extends RingDevice | RingCamera> {
   abstract readonly device: T
   abstract readonly accessory: HAP.Accessory
   abstract readonly logger: HAP.Log
-  abstract readonly config: RingAlarmPlatformConfig
+  abstract readonly config: RingPlatformConfig
 
   getService(serviceType: HAP.Service, name = this.device.name) {
     if (process.env.RING_DEBUG) {
diff --git a/homebridge/base-device-accessory.ts b/homebridge/base-device-accessory.ts
@@ -3,7 +3,7 @@ import { HAP, hap } from './hap'
 import Service = HAP.Service
 import { debounceTime, distinctUntilChanged, map } from 'rxjs/operators'
 import { Subject } from 'rxjs'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 import { BaseAccessory } from './base-accessory'
 
 function getBatteryLevel({ batteryLevel, batteryStatus }: RingDeviceData) {
@@ -51,7 +51,7 @@ export abstract class BaseDeviceAccessory extends BaseAccessory<RingDevice> {
   abstract readonly device: RingDevice
   abstract readonly accessory: HAP.Accessory
   abstract readonly logger: HAP.Log
-  abstract readonly config: RingAlarmPlatformConfig
+  abstract readonly config: RingPlatformConfig
 
   protected constructor() {
     super()
diff --git a/homebridge/base-station.ts b/homebridge/base-station.ts
@@ -1,14 +1,14 @@
 import { BaseDeviceAccessory } from './base-device-accessory'
 import { RingDevice } from '../api'
 import { HAP } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 
 export class BaseStation extends BaseDeviceAccessory {
   constructor(
     public readonly device: RingDevice,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
   }
diff --git a/homebridge/beam.ts b/homebridge/beam.ts
@@ -1,6 +1,6 @@
 import { RingDevice, RingDeviceType } from '../api'
 import { HAP, hap } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 import { BaseDeviceAccessory } from './base-device-accessory'
 
 export class Beam extends BaseDeviceAccessory {
@@ -12,7 +12,7 @@ export class Beam extends BaseDeviceAccessory {
     public readonly device: RingDevice,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
 
diff --git a/homebridge/camera.ts b/homebridge/camera.ts
@@ -1,5 +1,5 @@
 import { HAP, hap } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 import { RingCamera } from '../api'
 import { BaseAccessory } from './base-accessory'
 import { map, mapTo } from 'rxjs/operators'
@@ -10,7 +10,7 @@ export class Camera extends BaseAccessory<RingCamera> {
     public readonly device: RingCamera,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
     const { Characteristic, Service } = hap,
diff --git a/homebridge/co-alarm.ts b/homebridge/co-alarm.ts
@@ -1,14 +1,14 @@
 import { BaseDeviceAccessory } from './base-device-accessory'
 import { RingDevice } from '../api'
 import { HAP, hap } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 
 export class CoAlarm extends BaseDeviceAccessory {
   constructor(
     public readonly device: RingDevice,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
 
diff --git a/homebridge/config.ts b/homebridge/config.ts
@@ -1,6 +1,6 @@
-import { RingAlarmOptions } from '../api'
+import { RingApiOptions } from '../api'
 
-export interface RingAlarmPlatformConfig extends RingAlarmOptions {
+export interface RingPlatformConfig extends RingApiOptions {
   alarmOnEntryDelay?: boolean
   beamDurationSeconds?: number
   hideLightGroups?: boolean
diff --git a/homebridge/contact-sensor.ts b/homebridge/contact-sensor.ts
@@ -1,14 +1,14 @@
 import { BaseDeviceAccessory } from './base-device-accessory'
 import { RingDevice } from '../api'
 import { HAP, hap } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 
 export class ContactSensor extends BaseDeviceAccessory {
   constructor(
     public readonly device: RingDevice,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
 
diff --git a/homebridge/index.ts b/homebridge/index.ts
@@ -1,5 +1,13 @@
-import { RingAlarmPlatform } from './ring-alarm-platform'
+import { RingPlatform } from './ring-platform'
 import { hap } from './hap'
+import { readFileSync, writeFileSync } from 'fs'
+import { join as joinPath } from 'path'
+import {
+  platformName,
+  pluginName,
+  oldPlatformName,
+  oldPluginName
+} from './plugin-info'
 
 export default function(homebridge: any) {
   hap.PlatformAccessory = homebridge.platformAccessory
@@ -9,10 +17,43 @@ export default function(homebridge: any) {
   hap.AccessoryCategories = homebridge.hap.Accessory.Categories
   hap.StreamController = homebridge.hap.StreamController
 
-  homebridge.registerPlatform(
-    'homebridge-ring-alarm',
-    'RingAlarm',
-    RingAlarmPlatform,
-    true
-  )
+  try {
+    // This plugin was changed from homebridge-ring-alarm to homebridge-ring
+    // This code cleans up the config/cache files to point to the new plugin
+
+    const cachedAccessoriesPath = joinPath(
+        homebridge.user.cachedAccessoryPath(),
+        'cachedAccessories'
+      ),
+      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
+
+    if (cachedAccessories !== updatedAccessories) {
+      writeFileSync(cachedAccessoriesPath, updatedAccessories)
+      filesChanged = true
+    }
+
+    if (config !== updatedConfig) {
+      writeFileSync(configPath, updatedConfig)
+      filesChanged = true
+    }
+
+    if (filesChanged) {
+      console.error(
+        '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.'
+      )
+      process.exit(1)
+    }
+  } catch (_) {}
+
+  homebridge.registerPlatform(pluginName, platformName, RingPlatform, true)
 }
diff --git a/homebridge/keypad.ts b/homebridge/keypad.ts
@@ -1,14 +1,14 @@
 import { BaseDeviceAccessory } from './base-device-accessory'
 import { RingDevice } from '../api'
 import { HAP } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 
 export class Keypad extends BaseDeviceAccessory {
   constructor(
     public readonly device: RingDevice,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
   }
diff --git a/homebridge/lock.ts b/homebridge/lock.ts
@@ -2,7 +2,7 @@ import { BaseDeviceAccessory } from './base-device-accessory'
 import { RingDevice, RingDeviceData } from '../api'
 import { distinctUntilChanged } from 'rxjs/operators'
 import { HAP, hap } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 
 function getCurrentState({ locked }: RingDeviceData) {
   const {
@@ -28,7 +28,7 @@ export class Lock extends BaseDeviceAccessory {
     public readonly device: RingDevice,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
 
diff --git a/homebridge/motion-sensor.ts b/homebridge/motion-sensor.ts
@@ -1,14 +1,14 @@
 import { BaseDeviceAccessory } from './base-device-accessory'
 import { RingDevice } from '../api'
 import { HAP, hap } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 
 export class MotionSensor extends BaseDeviceAccessory {
   constructor(
     public readonly device: RingDevice,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
 
diff --git a/homebridge/multi-level-switch.ts b/homebridge/multi-level-switch.ts
@@ -1,14 +1,14 @@
 import { BaseDeviceAccessory } from './base-device-accessory'
 import { RingDevice } from '../api'
 import { HAP, hap } from './hap'
-import { RingAlarmPlatformConfig } from './config'
+import { RingPlatformConfig } from './config'
 
 export class MultiLevelSwitch extends BaseDeviceAccessory {
   constructor(
     public readonly device: RingDevice,
     public readonly accessory: HAP.Accessory,
     public readonly logger: HAP.Log,
-    public readonly config: RingAlarmPlatformConfig
+    public readonly config: RingPlatformConfig
   ) {
     super()
 
diff --git a/homebridge/package.json b/homebridge/package.json
diff --git a/homebridge/plugin-info.ts b/homebridge/plugin-info.ts
diff --git a/homebridge/ring-platform.ts b/homebridge/ring-platform.ts
diff --git a/homebridge/security-panel.ts b/homebridge/security-panel.ts
diff --git a/homebridge/smoke-alarm.ts b/homebridge/smoke-alarm.ts
diff --git a/homebridge/smoke-co-listener.ts b/homebridge/smoke-co-listener.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
