ruby_home 0.2.1 → 0.2.6

data/lib/ruby_home/persistable.rb

@@ -1,16 +1,17 @@
-require 'facets/cattr'
+require "facets/cattr"
 
 module RubyHome
   module Persistable
     def self.included(base)
       base.send(:cattr_accessor, :source)
+      base.send(:cattr_accessor, :cache)
       base.extend(ClassMethods)
     end
 
     module ClassMethods
       def persisted
-        if yaml = read
-          new(yaml)
+        if (yaml = read)
+          new(**yaml)
         end
       end
 
@@ -19,23 +20,29 @@ module RubyHome
       end
 
       def write(collection)
-        File.open(source, 'w') {|f| f.write(collection.to_yaml) }
+        self.cache = collection
+        persist
+
+        true
       end
 
-      def read
-        return false unless file_exists?
+      def persist
+        File.write(source, cache.to_yaml)
+      end
 
+      def read_persisted
         YAML.load_file(source)
+      rescue Errno::ENOENT
+        false
       end
 
-      def truncate
-        return false unless file_exists?
-
-        File.truncate(source, 0)
+      def read
+        self.cache ||= read_persisted
       end
 
-      def file_exists?
-        File.exists?(source)
+      def reset
+        self.cache = nil
+        persist
       end
     end
 

data/lib/ruby_home/service.rb

@@ -1,10 +1,10 @@
-require_relative 'service_collection'
+require_relative "service_collection"
 
 module RubyHome
   class DuplicateServiceError < StandardError; end
 
   class Service
-    def initialize(accessory: , primary: false, hidden: false, name:, description:, uuid:)
+    def initialize(accessory:, name:, description:, uuid:, primary: false, hidden: false)
       @accessory = accessory
       @primary = primary
       @hidden = hidden
@@ -12,6 +12,7 @@ module RubyHome
       @description = description
       @uuid = uuid
       @characteristics = CharacteristicCollection.new
+      @linked = []
     end
 
     attr_reader(
@@ -25,6 +26,8 @@ module RubyHome
       :instance_id
     )
 
+    attr_accessor :linked
+
     def instance_id=(new_id)
       raise DuplicateServiceError if accessory.contains_instance_id?(new_id)
 

data/lib/ruby_home/service_collection.rb

@@ -20,6 +20,6 @@ module RubyHome
 
     private
 
-      attr_reader :services
+    attr_reader :services
   end
 end

data/lib/ruby_home/version.rb

@@ -1,3 +1,3 @@
 module RubyHome
-  VERSION = '0.2.1'
+  VERSION = "0.2.6"
 end

data/rubyhome.gemspec

@@ -1,45 +1,45 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ruby_home/version'
+require "ruby_home/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ruby_home'
-  spec.version       = RubyHome::VERSION
-  spec.authors       = ['Karl Entwistle']
-  spec.email         = ['karl@entwistle.com']
-  spec.summary       = 'Ruby HomeKit support'
-  spec.description   = <<~DESCRIPTION
+  spec.name = "ruby_home"
+  spec.version = RubyHome::VERSION
+  spec.authors = ["Karl Entwistle"]
+  spec.email = ["karl@entwistle.com"]
+  spec.summary = "Ruby HomeKit support"
+  spec.description = <<~DESCRIPTION
     RubyHome is a lightweight service you can run on your home network that
     emulates the iOS HomeKit API. It supports community contributed plugins, which
     are modules that provide a bridge from HomeKit to various 3rd-party APIs
     provided by manufacturers of smart home devices.
   DESCRIPTION
-  spec.homepage      = 'https://github.com/karlentwistle/ruby_home'
-  spec.license       = 'MIT'
+  spec.homepage = "https://github.com/karlentwistle/ruby_home"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'bin'
-  spec.executables   = ['ruby_home']
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.4.1'
+  spec.bindir = "bin"
+  spec.executables = ["ruby_home"]
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.add_dependency 'bindata', '~> 2.4', '>= 2.4.3'
-  spec.add_dependency 'dnssd', '~> 3.0'
-  spec.add_dependency 'facets', '~> 3.1'
-  spec.add_dependency 'hkdf', '~> 0.3.0'
-  spec.add_dependency 'oj', '3.7.12'
-  spec.add_dependency 'rbnacl', '~> 6.0'
-  spec.add_dependency 'ruby_home-srp', '~> 1.3'
-  spec.add_dependency 'ruby_home-tlv', '~> 0.1.0'
-  spec.add_dependency 'sinatra', '2.0.5'
-  spec.add_dependency 'wisper', '~> 2.0'
+  spec.add_dependency "dnssd", "~> 3.0"
+  spec.add_dependency "facets", "~> 3.1"
+  spec.add_dependency "hkdf", "~> 1.0.0"
+  spec.add_dependency "oj", "~> 3.10"
+  spec.add_dependency "rbnacl", "~> 7.0"
+  spec.add_dependency "ruby_home-srp", "~> 1.3"
+  spec.add_dependency "ruby_home-tlv", "~> 0.1"
+  spec.add_dependency "sinatra", "~> 2.0"
+  spec.add_dependency "webrick", "~> 1.7"
+  spec.add_dependency "wisper", "~> 2.0"
 
-  spec.add_development_dependency 'byebug', '~> 11.0'
-  spec.add_development_dependency 'plist', '~> 3.4'
-  spec.add_development_dependency 'rack-test', '~> 1.1.0'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency "byebug", "~> 11.0"
+  spec.add_development_dependency "plist", "~> 3.4"
+  spec.add_development_dependency "rack-test", "~> 1.1.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "standard", "~> 1.0"
 end

data/sbin/characteristic_generator.rb

@@ -1,39 +1,39 @@
 #!/usr/bin/env ruby
 
-require 'byebug'
-require 'plist'
-require 'yaml'
+require "byebug"
+require "plist"
+require "yaml"
 
 module RubyHome
   class CharacteristicGenerator
     class << self
       def run
         convert_binary_plist
-        File.open(file_path, 'w') do |file|
+        File.open(file_path, "w") do |file|
           file.write generate_characteristics.to_yaml
         end
       end
 
       def generate_characteristics
-        parsed_xml['Characteristics'].map do |characteristics_xml|
+        parsed_xml["Characteristics"].map do |characteristics_xml|
           new(characteristics_xml).generate_characteristic_hash
         end
       end
 
       def convert_binary_plist
         system([
-          'plutil -convert xml1 -o',
-          '/tmp/Accessory.xml',
+          "plutil -convert xml1 -o",
+          "/tmp/Accessory.xml",
           "\'/Applications/Utilities/HomeKit\ Accessory\ Simulator.app/Contents/Frameworks/HAPAccessoryKit.framework/Versions/A/Resources/default.metadata.plist\'"
-        ].join(' '))
+        ].join(" "))
       end
 
       def parsed_xml
-        Plist.parse_xml('/tmp/Accessory.xml')
+        Plist.parse_xml("/tmp/Accessory.xml")
       end
 
       def file_path
-        File.dirname(__FILE__) + '/../lib/ruby_home/config/characteristics.yml'
+        File.dirname(__FILE__) + "/../lib/ruby_home/config/characteristics.yml"
       end
     end
 
@@ -41,7 +41,6 @@ module RubyHome
       @constraints = xml["Constraints"]
       @format = xml["Format"]
       @name = xml["Name"]
-      @permissions = xml["Permissions"]
       @properties = xml["Properties"]
       @uuid = xml["UUID"]
       @unit = xml["Unit"]
@@ -54,29 +53,28 @@ module RubyHome
         uuid: uuid,
         format: format,
         unit: sanitized_unit,
-        permissions: permissions,
         properties: properties,
-        constraints: constraints,
+        constraints: constraints
       }
     end
 
     private
 
-      def sanitized_name
-        name.downcase.gsub(' ', '_').gsub('.', '_')
-      end
+    def sanitized_name
+      name.downcase.tr(" ", "_").tr(".", "_")
+    end
 
-      def sanitized_unit
-        if unit
-          "\"#{unit}\""
-        else
-          "nil"
-        end
+    def sanitized_unit
+      if unit
+        "\"#{unit}\""
+      else
+        "nil"
       end
+    end
 
-      private
+    private
 
-      attr_reader :constraints, :format, :name, :permissions, :properties, :uuid, :unit
+    attr_reader :constraints, :format, :name, :properties, :uuid, :unit
   end
 end
 

data/sbin/service_generator.rb

@@ -1,46 +1,47 @@
 #!/usr/bin/env ruby
 
-require 'byebug'
-require 'plist'
-require 'yaml'
+require "byebug"
+require "plist"
+require "yaml"
+require_relative "../lib/ruby_home"
 
 module RubyHome
   class ServiceGenerator
     class << self
       def run
         convert_binary_plist
-        File.open(file_path, 'w') do |file|
+        File.open(file_path, "w") do |file|
           file.write generate_services.to_yaml
         end
       end
 
       def generate_services
-        parsed_xml['Services'].map do |services_xml|
+        parsed_xml["Services"].map do |services_xml|
           new(services_xml).generate_service_hash
         end
       end
 
       def convert_binary_plist
         system([
-          'plutil -convert xml1 -o',
-          '/tmp/Accessory.xml',
+          "plutil -convert xml1 -o",
+          "/tmp/Accessory.xml",
           "\'/Applications/Utilities/HomeKit\ Accessory\ Simulator.app/Contents/Frameworks/HAPAccessoryKit.framework/Versions/A/Resources/default.metadata.plist\'"
-        ].join(' '))
+        ].join(" "))
       end
 
       def parsed_xml
-        Plist.parse_xml('/tmp/Accessory.xml')
+        Plist.parse_xml("/tmp/Accessory.xml")
       end
 
       def file_path
-        File.dirname(__FILE__) + '/../lib/ruby_home/config/services.yml'
+        File.dirname(__FILE__) + "/../lib/ruby_home/config/services.yml"
       end
     end
 
     def initialize(xml)
       @name = xml["Name"]
-      @optional_characteristics = xml["OptionalCharacteristics"]
-      @required_characteristics = xml["RequiredCharacteristics"]
+      @optional_characteristic_uuids = xml["OptionalCharacteristics"]
+      @required_characteristic_uuids = xml["RequiredCharacteristics"]
       @uuid = xml["UUID"]
     end
 
@@ -49,20 +50,38 @@ module RubyHome
         name: sanitized_name.to_sym,
         description: name,
         uuid: uuid,
-        optional_characteristics_uuids: optional_characteristics,
-        required_characteristics_uuids: required_characteristics,
+        optional_characteristic_names: optional_characteristic_names.sort,
+        required_characteristic_names: required_characteristic_names.sort
       }
     end
 
     private
 
-      def sanitized_name
-        name.downcase.gsub(' ', '_')
-      end
+    def sanitized_name
+      name.downcase.tr(" ", "_")
+    end
+
+    def optional_characteristic_names
+      optional_characteristic_uuids.map do |uuid|
+        RubyHome::CharacteristicTemplate.find_by(uuid: uuid).name
+      end + additional_optional_characteristic_names
+    end
+
+    ADDITIONAL_OPTIONAL_CHARACTERISTIC_NAMES = {
+      "lightbulb" => [:color_temperature]
+    }.freeze
 
-      private
+    def additional_optional_characteristic_names
+      ADDITIONAL_OPTIONAL_CHARACTERISTIC_NAMES.fetch(sanitized_name, [])
+    end
+
+    def required_characteristic_names
+      required_characteristic_uuids.map do |uuid|
+        RubyHome::CharacteristicTemplate.find_by(uuid: uuid).name
+      end
+    end
 
-      attr_reader :name, :optional_characteristics, :required_characteristics, :uuid
+    attr_reader :name, :required_characteristic_uuids, :optional_characteristic_uuids, :uuid
   end
 end
 

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby_home
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - Karl Entwistle
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bindata
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.4.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.4.3
 - !ruby/object:Gem::Dependency
   name: dnssd
   requirement: !ruby/object:Gem::Requirement
@@ -64,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.12
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.12
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: ruby_home-srp
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: wisper
   requirement: !ruby/object:Gem::Requirement
@@ -204,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |
   RubyHome is a lightweight service you can run on your home network that
   emulates the iOS HomeKit API. It supports community contributed plugins, which
@@ -238,11 +246,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".standard.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -250,13 +260,44 @@ files:
 - bin/console
 - bin/ruby_home
 - bin/setup
+- examples/air_purifier.rb
+- examples/air_quality_sensor.rb
+- examples/battery_service.rb
+- examples/carbon_dioxide_sensor.rb
+- examples/carbon_monoxide_sensor.rb
+- examples/contact_sensor.rb
+- examples/door.rb
+- examples/fan.rb
+- examples/fan_v2.rb
+- examples/garage_door_opener.rb
+- examples/heater_cooler.rb
+- examples/humidifier_dehumidifier.rb
+- examples/humidity_sensor.rb
+- examples/leak_sensor.rb
+- examples/light_sensor.rb
+- examples/lightbulb.rb
+- examples/lock_mechanism.rb
+- examples/motion_sensor.rb
+- examples/occupancy_sensor.rb
+- examples/outlet.rb
+- examples/security_system.rb
+- examples/smoke_sensor.rb
+- examples/switch.rb
+- examples/television.rb
+- examples/temperature_sensor.rb
+- examples/thermostat.rb
+- examples/window.rb
+- examples/window_covering.rb
 - lib/ruby_home.rb
 - lib/ruby_home/accessory.rb
 - lib/ruby_home/accessory_collection.rb
 - lib/ruby_home/accessory_info.rb
 - lib/ruby_home/characteristic.rb
 - lib/ruby_home/characteristic_collection.rb
+- lib/ruby_home/config/categories.yml
 - lib/ruby_home/config/characteristics.yml
+- lib/ruby_home/config/manual_characteristics.yml
+- lib/ruby_home/config/manual_services.yml
 - lib/ruby_home/config/services.yml
 - lib/ruby_home/configuration.rb
 - lib/ruby_home/device_id.rb
@@ -320,7 +361,7 @@ homepage: https://github.com/karlentwistle/ruby_home
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -328,15 +369,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.1
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Ruby HomeKit support
 test_files: []