ruby_home 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faee051d71617c37bbbaf0274d1469db94770d0623bc415a7f8448ff7ce4408b
-  data.tar.gz: c207e5bb1bec2c07d86183e912c21a3f8f4e8c3c4c27b639cd955a9a3d21b887
+  metadata.gz: 01126dd521e4351b6b7b801bfbb2e4bfd9ab6e19d47ce1715dc9c964ea5dfeca
+  data.tar.gz: be5d09f37ec55495c374778c4e2c0baea87edd16ea791ff2f9ca65a90a0666ad
 SHA512:
-  metadata.gz: 601d7ef1d41989e34ae7ba3a336dcf3b36c93a693a0bfb8d998afc2aae7e9bcf243c65406eab992269f03e627ef71f0b01be904969b37e063c2472f4b438a022
-  data.tar.gz: 7f5ee6ca44cabbdbf316e1a21c388ba09173e4a69853a8505d80249bd4602ee9f0cf609c8a6755fc6b6337c540d4a712573f1d4984b1435dd008ed04a77d8b49
+  metadata.gz: 96fb624e38e24b0b6fc709f6df2f7dd048b2514210f1cd4b43e91a36c2de1bc0f8de22848bb106b44ab7e17f3efbfcab7a3ad839275a819391c745e890e299ea
+  data.tar.gz: bbbc772b8da1669307f63753f23ad07f1ada6e9f675e0a02e174f9653a94f67245cd13564c9d7e57f163fa2ebc1cb4526071df2ef5dc7763466146f446bfb852

data/.github/workflows/tests.yml

@@ -2,16 +2,16 @@ name: Tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   ubuntu:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [3.0, 2.7, 2.6, 2.5]
+        ruby-version: [3.0, 2.7, 2.6]
     steps:
     - name: Install libdnssd
       run: sudo apt-get install libavahi-compat-libdnssd-dev
@@ -28,7 +28,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        ruby-version: [3.0, 2.7, 2.6, 2.5]
+        ruby-version: [3.0, 2.7, 2.6]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby-version }}

data/.gitignore

@@ -1,14 +1,14 @@
 .byebug_history
 .rspec_status
+.ruby-version
 /.bundle/
+/.rubocop-*
 /.yardoc
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
 Gemfile.lock
 accessory_info.yml
 identifier_cache.yml
-.ruby-version

data/.rubocop.yml

@@ -1,9 +1,2 @@
-Style:
-  TrailingCommaInLiteral:
-    Enabled: false
-  Documentation:
-    Enabled: false
-  FrozenStringLiteralComment:
-    Enabled: false
-  IndentationConsistency:
-    AllowProtectedAndPrivateMethodsBeIndented: true
+inherit_from:
+  - https://raw.githubusercontent.com/testdouble/standard/master/config/base.yml

data/.standard.yml

@@ -0,0 +1,3 @@
+ignore:
+  - 'examples/*':
+    - Lint/UselessAssignment

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ruby_home Changelog
 
+## [v0.2.6](https://github.com/karlentwistle/ruby_home/releases/tag/v0.2.6) (2021-05-25)
+
+### Features
+
+* Introduce in memory cache for identifier_cache and accessory_info to improve read performance
+
 ## [v0.2.5](https://github.com/karlentwistle/ruby_home/releases/tag/v0.2.5) (2021-01-22)
 
 ### Features
@@ -7,7 +13,6 @@
 * Added support for television service and characteristics (#100, @johndbritton, @getowic)
 * category_identifier can now be configured (#100, @getowic)
 
-
 ### Fixes
 
 * Fix Ruby 3.0 LoadError (#102, @karlentwistle)

data/Gemfile

@@ -1,6 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-git_source(:github) {|repo_name| 'https://github.com/#{repo_name}' }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in ruby_home.gemspec
 gemspec

data/Rakefile

@@ -1,7 +1,7 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require_relative 'lib/ruby_home'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require_relative "lib/ruby_home"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/examples/air_purifier.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 air_purifier = RubyHome::ServiceFactory.create(:air_purifier,
@@ -8,12 +8,11 @@ air_purifier = RubyHome::ServiceFactory.create(:air_purifier,
   name: "air purifier", # optional
   rotation_speed: 0, # optional
   swing_mode: 1, # optional
-  lock_physical_controls: 0, # optional
-)
+  lock_physical_controls: 0) # optional
 
 target_air_purifier_state_values = {
-  0 => 'Manual',
-  1 => 'Auto',
+  0 => "Manual",
+  1 => "Auto"
 }
 air_purifier.target_air_purifier_state.after_update do |target_air_purifier_state|
   state = target_air_purifier_state_values[target_air_purifier_state]
@@ -21,9 +20,9 @@ air_purifier.target_air_purifier_state.after_update do |target_air_purifier_stat
 end
 
 current_air_purifier_state_values = {
-  0 => 'Inactive',
-  1 => 'Idle',
-  2 => 'Purifying Air',
+  0 => "Inactive",
+  1 => "Idle",
+  2 => "Purifying Air"
 }
 air_purifier.current_air_purifier_state.after_update do |current_air_purifier_state|
   state = current_air_purifier_state_values[current_air_purifier_state]

data/examples/air_quality_sensor.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 air_quality_sensor = RubyHome::ServiceFactory.create(:air_quality_sensor,
@@ -15,16 +15,15 @@ air_quality_sensor = RubyHome::ServiceFactory.create(:air_quality_sensor,
   status_low_battery: 0, # optional
   status_tampered: 0, # optional
   status_fault: 0, # optional
-  status_active: true # optional
-)
+  status_active: true) # optional
 
 air_quality_values = {
-  0 => 'Unknown',
-  1 => 'Excellent',
-  2 => 'Good',
-  3 => 'Fair',
-  4 => 'Inferior',
-  5 => 'Poor'
+  0 => "Unknown",
+  1 => "Excellent",
+  2 => "Good",
+  3 => "Fair",
+  4 => "Inferior",
+  5 => "Poor"
 }
 air_quality_sensor.air_quality.after_update do |air_quality|
   state = air_quality_values[air_quality]

data/examples/battery_service.rb

@@ -1,12 +1,11 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 battery_service = RubyHome::ServiceFactory.create(:battery_service,
   status_low_battery: 0, # required
   charging_state: 0, # required
   battery_level: 20, # required
-  name: "battery service", # optional
-)
+  name: "battery service") # optional
 
 battery_service.status_low_battery.after_update do |status_low_battery|
   if status_low_battery == 0

data/examples/carbon_dioxide_sensor.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 carbon_dioxide_sensor = RubyHome::ServiceFactory.create(:carbon_dioxide_sensor,
@@ -9,8 +9,7 @@ carbon_dioxide_sensor = RubyHome::ServiceFactory.create(:carbon_dioxide_sensor,
   status_tampered: 0, # optional
   status_low_battery: 0, # optional
   status_fault: 0, # optional
-  status_active: true # optional
-)
+  status_active: true) # optional
 
 carbon_dioxide_sensor.carbon_dioxide_detected.after_update do |carbon_dioxide_detected|
   if carbon_dioxide_detected == 0

data/examples/carbon_monoxide_sensor.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 carbon_monoxide_sensor = RubyHome::ServiceFactory.create(:carbon_monoxide_sensor,
@@ -9,8 +9,7 @@ carbon_monoxide_sensor = RubyHome::ServiceFactory.create(:carbon_monoxide_sensor
   status_tampered: 0, # optional
   status_low_battery: 0, # optional
   status_fault: 0, # optional
-  status_active: true # optional
-)
+  status_active: true) # optional
 
 carbon_monoxide_sensor.carbon_monoxide_detected.after_update do |carbon_monoxide_detected|
   if carbon_monoxide_detected == 0
@@ -62,7 +61,7 @@ end
 
 Thread.new do
   sleep 30
-  
+
   loop do
     carbon_monoxide_sensor.carbon_monoxide_detected = (0..1).to_a.sample
     carbon_monoxide_sensor.carbon_monoxide_peak_level = (0..100).to_a.sample

data/examples/contact_sensor.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 contact_sensor = RubyHome::ServiceFactory.create(:contact_sensor,
@@ -7,8 +7,7 @@ contact_sensor = RubyHome::ServiceFactory.create(:contact_sensor,
   status_low_battery: 0, # optional
   status_tampered: 0, # optional
   status_fault: 0, # optional
-  status_active: true # optional
-)
+  status_active: true) # optional
 
 contact_sensor.contact_sensor_state.after_update do |contact_sensor_state|
   if contact_sensor_state == 0

data/examples/door.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 door = RubyHome::ServiceFactory.create(:door,
@@ -6,8 +6,7 @@ door = RubyHome::ServiceFactory.create(:door,
   position_state: 1, # required
   current_position: 0, # required
   name: "door", # optional
-  obstruction_detected: false, # optional
-)
+  obstruction_detected: false) # optional
 
 door.target_position.after_update do |target_position|
   puts "door target position #{target_position}"
@@ -25,9 +24,9 @@ door.target_position.after_update do |target_position|
 end
 
 position_state_values = {
-  0 => 'Decreasing',
-  1 => 'Increasing',
-  2 => 'Stopped'
+  0 => "Decreasing",
+  1 => "Increasing",
+  2 => "Stopped"
 }
 door.position_state.after_update do |position_state|
   state = position_state_values[position_state]

data/examples/fan.rb

@@ -1,12 +1,11 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 fan = RubyHome::ServiceFactory.create(:fan,
   on: false, # required
   name: "fan", # optional
   rotation_speed: 50, # optional
-  rotation_direction: 0 # optional
-)
+  rotation_direction: 0) # optional
 
 fan.on.after_update do |on|
   if on

data/examples/fan_v2.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 fan = RubyHome::ServiceFactory.create(:fan_v2,
@@ -9,8 +9,7 @@ fan = RubyHome::ServiceFactory.create(:fan_v2,
   rotation_direction: 0, # optional
   lock_physical_controls: 0, # optional
   target_fan_state: 0, # optional
-  current_fan_state: 0 # optional
-)
+  current_fan_state: 0) # optional
 
 fan.active.after_update do |active|
   if active == 0

data/examples/garage_door_opener.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 garage_door_opener = RubyHome::ServiceFactory.create(:garage_door_opener,
@@ -7,8 +7,7 @@ garage_door_opener = RubyHome::ServiceFactory.create(:garage_door_opener,
   current_door_state: 1, # required
   name: "garage door opener", # optional
   lock_target_state: 1, # optional
-  lock_current_state: 1, # optional
-)
+  lock_current_state: 1) # optional
 
 garage_door_opener.obstruction_detected.after_update do |obstruction_detected|
   if obstruction_detected
@@ -19,8 +18,8 @@ garage_door_opener.obstruction_detected.after_update do |obstruction_detected|
 end
 
 target_door_state_values = {
-  0 => 'Open',
-  1 => 'Closed',
+  0 => "Open",
+  1 => "Closed"
 }
 garage_door_opener.target_door_state.after_update do |target_door_state|
   state = target_door_state_values[target_door_state]
@@ -38,11 +37,11 @@ garage_door_opener.target_door_state.after_update do |target_door_state|
 end
 
 current_door_state_values = {
-  0 => 'Open',
-  1 => 'Closed',
-  2 => 'Opening',
-  3 => 'Closing',
-  4 => 'Stopped'
+  0 => "Open",
+  1 => "Closed",
+  2 => "Opening",
+  3 => "Closing",
+  4 => "Stopped"
 }
 garage_door_opener.current_door_state.after_update do |current_door_state|
   state = current_door_state_values[current_door_state]

data/examples/heater_cooler.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 heater_cooler = RubyHome::ServiceFactory.create(:heater_cooler,
@@ -12,17 +12,16 @@ heater_cooler = RubyHome::ServiceFactory.create(:heater_cooler,
   heating_threshold_temperature: 20, # optional
   cooling_threshold_temperature: 10, # optional
   swing_mode: 1, # optional
-  lock_physical_controls: 0, # optional
-)
+  lock_physical_controls: 0) # optional
 
 heater_cooler.current_temperature.after_update do |current_temperature|
   puts "heater cooler current temperature in celsius #{current_temperature}"
 end
 
 target_heater_cooler_state_values = {
-  0 => 'Auto',
-  1 => 'Heat',
-  2 => 'Cool'
+  0 => "Auto",
+  1 => "Heat",
+  2 => "Cool"
 }
 heater_cooler.target_heater_cooler_state.after_update do |target_heater_cooler_state|
   state = target_heater_cooler_state_values[target_heater_cooler_state]
@@ -30,10 +29,10 @@ heater_cooler.target_heater_cooler_state.after_update do |target_heater_cooler_s
 end
 
 current_heater_cooler_state_values = {
-  0 => 'Inactive',
-  1 => 'Idle',
-  2 => 'Heating',
-  3 => 'Cooling'
+  0 => "Inactive",
+  1 => "Idle",
+  2 => "Heating",
+  3 => "Cooling"
 }
 heater_cooler.current_heater_cooler_state.after_update do |current_heater_cooler_state|
   state = current_heater_cooler_state_values[current_heater_cooler_state]

data/examples/humidifier_dehumidifier.rb

@@ -1,4 +1,4 @@
-require 'ruby_home'
+require "ruby_home"
 
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 humidifier_dehumidifier = RubyHome::ServiceFactory.create(:humidifier_dehumidifier,
@@ -12,8 +12,7 @@ humidifier_dehumidifier = RubyHome::ServiceFactory.create(:humidifier_dehumidifi
   relative_humidity_dehumidifier_threshold: 0, # optional
   water_level: 50, # optional
   swing_mode: 1, # optional
-  lock_physical_controls: 0, # optional
-)
+  lock_physical_controls: 0) # optional
 
 humidifier_dehumidifier.active.after_update do |active|
   if active == 0
@@ -24,9 +23,9 @@ humidifier_dehumidifier.active.after_update do |active|
 end
 
 target_humidifier_dehumidifier_state_values = {
-  0 => 'Humidifier or Dehumidifier',
-  1 => 'Humidifier',
-  2 => 'Dehumidifier'
+  0 => "Humidifier or Dehumidifier",
+  1 => "Humidifier",
+  2 => "Dehumidifier"
 }
 humidifier_dehumidifier.target_humidifier_dehumidifier_state.after_update do |target_humidifier_dehumidifier_state|
   state = target_humidifier_dehumidifier_state_values[target_humidifier_dehumidifier_state]
@@ -34,10 +33,10 @@ humidifier_dehumidifier.target_humidifier_dehumidifier_state.after_update do |ta
 end
 
 current_humidifier_dehumidifier_state_values = {
-  0 => 'Inactive',
-  1 => 'Idle',
-  2 => 'Humidifying',
-  3 => 'Dehumidifying'
+  0 => "Inactive",
+  1 => "Idle",
+  2 => "Humidifying",
+  3 => "Dehumidifying"
 }
 humidifier_dehumidifier.current_humidifier_dehumidifier_state.after_update do |current_humidifier_dehumidifier_state|
   state = current_humidifier_dehumidifier_state_values[current_humidifier_dehumidifier_state]