ruby_home 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f1ec9a0cf851dfdd6394018bf525c56543316231714b79003bbecf58b0996e1
-  data.tar.gz: 935e5d614d0c4738511e83ba1dcead41a22ac49aed6da5e66bf2fbef96cb2f01
+  metadata.gz: ad5b7e8f3b0b442d25929da1a8af15bdf127cd722102f7ff9399ee1ed085872a
+  data.tar.gz: bb1a2e1b6cce59ec430f7a12125f61d5786eb80ffa816c6e92bd3082a9481fee
 SHA512:
-  metadata.gz: d18cdd0a7a98ac1109257851c1fcc30e96574e532835bd76945a36905f460385cfbe1b566534d15a9d11a79cac3d4200fb2ff9b2c430eee5ecffebd0e2ca0a9a
-  data.tar.gz: 99aae206a6330cb6cbdf04158c79219670454d88eaf65ff2cc9cb311d596c9f9004ff13ee2334f10a43d709a33e443d3a561bfa995941379b45c74c270b10636
+  metadata.gz: 7671cc93259b8934c88928dc8c956ed40062a668d5c593a6f69f69b6607d74796d9e8522a3b3f13373fc35b59d2e971656b6dce8396e9bcf3abc6ddc7d601a20
+  data.tar.gz: bfd2b41ede9bd1ac5f0af0048e39cd1ea98dc3cd302bd19b836a7ea78c92fda2bad7be16791e82bb88bfcad5e25fafbdf1d04a54ada620d92599712c9f1049fd

data/.travis.yml

@@ -14,6 +14,7 @@ install:
 rvm:
   - 2.4
   - 2.5
+  - 2.6
   - ruby-head
 os:
   - linux

data/README.md

@@ -47,8 +47,8 @@ require 'ruby_home'
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 fan = RubyHome::ServiceFactory.create(:fan)
 
-fan.characteristic(:on).after_update do |characteristic|
-  if characteristic.value == true
+fan.on.after_update do |updated_value|
+  if updated_value
     puts "Fan switched on"
   else
     puts "Fan switched off"
@@ -58,27 +58,6 @@ end
 RubyHome.run
 ```
 
-Create a garage door opener.
-
-```ruby
-require 'ruby_home'
-
-accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
-door = RubyHome::ServiceFactory.create(:garage_door_opener)
-
-door.characteristic(:target_door_state).after_update do |characteristic|
-  if characteristic.value == 0 # open
-    sleep 1
-    door.characteristic(:current_door_state).value = 0
-  elsif characteristic.value == 1 #closed
-    sleep 1
-    door.characteristic(:current_door_state).value = 1
-  end
-end
-
-RubyHome.run
-```
-
 ## Customization
 
 RubyHome tries to provide sane defaults for all services. Customization of any of the options is possible.
@@ -105,8 +84,8 @@ fan = RubyHome::ServiceFactory.create(:fan,
   serial_number: '123-UK-A12345'
 )
 
-fan.characteristic(:on).after_update do |characteristic|
-  if characteristic.value == true
+fan.on.after_update do |updated_value|
+  if updated_value
     puts "Fan switched on"
   else
     puts "Fan switched off"
@@ -128,7 +107,6 @@ require 'open-uri'
 require 'ruby_home'
 
 fan = RubyHome::ServiceFactory.create(:fan)
-on_characteristic = fan.characteristic(:on)
 
 Thread.new do
   def fetch_fan_status
@@ -141,8 +119,83 @@ Thread.new do
 
     current_fan_status = fetch_fan_status
 
-    unless on_characteristic.value == current_fan_status
-      on_characteristic.value = current_fan_status
+    unless fan.on == current_fan_status
+      fan.on = current_fan_status
+    end
+  end
+end
+
+RubyHome.run
+```
+
+## More examples
+
+### Create a garage door opener.
+
+```ruby
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+door = RubyHome::ServiceFactory.create(:garage_door_opener)
+
+door.target_door_state.after_update do |updated_value|
+  if updated_value == 0 # open
+    sleep 1
+    door.current_door_state = 0
+  elsif updated_value == 1 #closed
+    sleep 1
+    door.current_door_state = 1
+  end
+end
+
+RubyHome.run
+```
+
+### Create a thermostat.
+
+```ruby
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+thermostat = RubyHome::ServiceFactory.create(:thermostat,
+  current_heating_cooling_state: 0, # off
+  target_heating_cooling_state: 0, # off
+  current_temperature: 18,
+  target_temperature: 18,
+  temperature_display_units: 0
+)
+
+thermostat.target_temperature.after_update do |updated_value|
+  if thermostat.current_temperature < updated_value
+    thermostat.target_heating_cooling_state = 1 # heat
+  elsif thermostat.current_temperature > updated_value
+    thermostat.target_heating_cooling_state = 2 # cool
+  end
+end
+
+thermostat.target_heating_cooling_state.after_update do |updated_value|
+  if updated_value == 1
+    thermostat.current_heating_cooling_state = 1  # heat
+  elsif updated_value == 2
+    thermostat.current_heating_cooling_state = 2 # cool
+  else
+    thermostat.current_heating_cooling_state = 0 # off
+  end
+end
+
+Thread.new do
+  loop do
+    sleep 5 # seconds
+
+    puts "current_temperature: #{thermostat.current_temperature.value.to_i}"
+    puts "target_temperature: #{thermostat.target_temperature.value.to_i}"
+
+    if thermostat.target_temperature.to_i > thermostat.current_temperature.to_i
+      thermostat.current_temperature += 1
+    elsif thermostat.target_temperature.to_i < thermostat.current_temperature.to_i
+      thermostat.current_temperature -= 1
+    else
+      thermostat.target_heating_cooling_state = 3 # auto
     end
   end
 end

data/bin/ruby_home

@@ -5,8 +5,8 @@ require_relative '../lib/ruby_home'
 accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
 fan = RubyHome::ServiceFactory.create(:fan)
 
-fan.characteristic(:on).after_update do |characteristic|
-  if characteristic.value == true
+fan.on.after_update do |updated_value|
+  if updated_value
     puts "Fan switched on"
   else
     puts "Fan switched off"

data/lib/ruby_home/{hap/accessory.rb → accessory.rb}

@@ -13,7 +13,7 @@ module RubyHome
     end
 
     def initialize
-      @services = []
+      @services = ServiceCollection.new
       @id = next_available_accessory_id
       @@all << self
     end
@@ -21,7 +21,7 @@ module RubyHome
     attr_reader :services, :id
 
     def characteristics
-      services.flat_map(&:characteristics)
+      services.characteristics
     end
 
     def next_available_instance_id
@@ -35,19 +35,13 @@ module RubyHome
     end
 
     def contains_instance_id?(instance_id)
-      instance_ids.include?(instance_id)
+      services.any? do |service|
+        service.contains_instance_id?(instance_id)
+      end
     end
 
     private
 
-    def instance_ids
-      instances.map(&:instance_id)
-    end
-
-    def instances
-      services + characteristics
-    end
-
     def largest_instance_id
       IdentifierCache.where(accessory_id: id).map(&:instance_id).max
     end

data/lib/ruby_home/{hap/accessory_collection.rb → accessory_collection.rb}

@@ -7,10 +7,8 @@ module RubyHome
       @accessories = accessories
     end
 
-    def each
-      @accessories.map do |accessory|
-        yield accessory
-      end
+    def each(&block)
+      accessories.each(&block)
     end
 
     def <<(accessory)
@@ -27,12 +25,12 @@ module RubyHome
 
     private
 
-    def services
-      accessories.flat_map(&:services)
-    end
+      def services
+        accessories.flat_map(&:services)
+      end
 
-    def characteristics
-      services.flat_map(&:characteristics)
-    end
+      def characteristics
+        services.flat_map(&:characteristics)
+      end
   end
 end

data/lib/ruby_home/{hap/characteristic.rb → characteristic.rb}

@@ -1,3 +1,5 @@
+require_relative 'characteristic_collection'
+
 module RubyHome
   class DuplicateCharacteristicError < StandardError; end
 
@@ -52,20 +54,33 @@ module RubyHome
       @instance_id = new_id
     end
 
-    delegate :accessory, to: :service
-    delegate :id, to: :accessory, prefix: true
+    def accessory
+      service.accessory
+    end
+
+    def accessory_id
+      accessory.id
+    end
 
     def service_iid
       service.instance_id
     end
 
+    def method_missing(method_name, *args, &block)
+      value.send(method_name, *args, &block)
+    end
+
+    def respond_to_missing?(method_name, *args)
+      value.respond_to?(method_name, *args) || super
+    end
+
     def value
       value_object.value
     end
 
     def value=(new_value)
       value_object.value = new_value
-      broadcast(:after_update, self)
+      broadcast(:after_update, new_value)
     end
   end
 end

data/lib/ruby_home/characteristic_collection.rb

@@ -0,0 +1,48 @@
+module RubyHome
+  class CharacteristicCollection
+    include Enumerable
+
+    def initialize(*characteristics)
+      @characteristics = characteristics
+    end
+
+    def each(&block)
+      characteristics.each(&block)
+    end
+
+    def <<(characteristic)
+      define_service_getter(characteristic)
+      define_service_setter(characteristic)
+
+      @characteristics << characteristic
+    end
+
+    alias all to_a
+
+    def contains_instance_id?(instance_id)
+      map(&:instance_id).include?(instance_id)
+    end
+
+    private
+
+      attr_reader :characteristics
+
+      def define_service_getter(characteristic)
+        service = characteristic.service
+
+        unless service.respond_to?(characteristic.name)
+          service.define_singleton_method(characteristic.name) { characteristic }
+        end
+      end
+
+      def define_service_setter(characteristic)
+        service = characteristic.service
+
+        unless service.respond_to?("#{characteristic.name}=")
+          service.define_singleton_method("#{characteristic.name}=") do |args|
+            characteristic.value = args
+          end
+        end
+      end
+  end
+end

data/lib/ruby_home/factories/characteristic_factory.rb

@@ -44,7 +44,9 @@ module RubyHome
 
       attr_reader :service, :characteristic_name, :subtype
 
-      delegate :accessory, to: :service
+      def accessory
+        service.accessory
+      end
 
       def template
         @template ||= CharacteristicTemplate.find_by(name: characteristic_name)

data/lib/ruby_home/hap/server.rb

@@ -5,6 +5,7 @@ module RubyHome
         @port = port
         @host = host
         @selector = NIO::Selector.new
+        @status = :running
       end
 
       attr_reader :port, :host
@@ -17,10 +18,18 @@ module RubyHome
         monitor.value = proc { accept }
 
         loop do
-          @selector.select { |monitor| monitor.value.call(monitor) }
+          if @status == :running
+            @selector.select { |monitor| monitor.value.call(monitor) }
+          else
+            @selector.close
+          end
         end
       end
 
+      def shutdown
+        @status = :shutdown
+      end
+
       private
 
       SESSIONS = {}

data/lib/ruby_home/hap/session.rb

@@ -73,15 +73,15 @@ module RubyHome
         end
 
         def decryption_time?
-          controller_to_accessory_key.present?
+          !!controller_to_accessory_key
         end
 
         def accessory_to_controller_key?
-          accessory_to_controller_key.present?
+          !!accessory_to_controller_key
         end
 
         def controller_to_accessory_key?
-          controller_to_accessory_key.present?
+          !!controller_to_accessory_key
         end
     end
   end

data/lib/ruby_home/hap/values/base_value.rb

@@ -1,9 +1,11 @@
+require 'facets/string/modulize'
+
 module RubyHome
   class BaseValue
     def self.value_for_template(template)
       return IdentifyValue if template.name == :identify
 
-      "::RubyHome::#{template.format.classify}Value".safe_constantize || NullValue
+      Object.const_get("::RubyHome::#{template.format.modulize}Value") || NullValue
     end
 
     def initialize(characteristic_template=nil, initial_value=nil)

data/lib/ruby_home/http/application.rb

@@ -13,8 +13,6 @@ module RubyHome
 
         def rack_builder
           ::Rack::Builder.new do
-            use ::Rack::CommonLogger
-
             map('/accessories') { run AccessoriesController }
             map('/characteristics') { run CharacteristicsController }
             map('/identify') { run IdentifyController }

data/lib/ruby_home/http/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module RubyHome
   module HTTP
     class ApplicationController < Sinatra::Base

data/lib/ruby_home/http/serializers/object_serializer.rb

@@ -1,3 +1,5 @@
+require 'facets/hash/symbolize_keys'
+
 module RubyHome
   module HTTP
     module ObjectSerializer

data/lib/ruby_home/http/serializers/uuid_helper.rb

@@ -14,7 +14,7 @@ module RubyHome
       end
 
       def trim_leading_zeros(input)
-        input.remove(/^0*/)
+        input.gsub(/^0*/, '')
       end
     end
   end

data/lib/ruby_home/persistable.rb

@@ -1,3 +1,5 @@
+require 'facets/cattr'
+
 module RubyHome
   module Persistable
     def self.included(base)

data/lib/ruby_home/{hap/service.rb → service.rb}

@@ -1,3 +1,5 @@
+require_relative 'service_collection'
+
 module RubyHome
   class DuplicateServiceError < StandardError; end
 
@@ -9,7 +11,7 @@ module RubyHome
       @name = name
       @description = description
       @uuid = uuid
-      @characteristics = []
+      @characteristics = CharacteristicCollection.new
     end
 
     attr_reader(
@@ -29,7 +31,13 @@ module RubyHome
       @instance_id = new_id
     end
 
-    delegate :id, to: :accessory, prefix: true
+    def contains_instance_id?(instance_id)
+      self.instance_id == instance_id || characteristics.contains_instance_id?(instance_id)
+    end
+
+    def accessory_id
+      accessory.id
+    end
 
     def characteristic(characteristic_name)
       characteristics.find do |characteristic|

data/lib/ruby_home/service_collection.rb

@@ -0,0 +1,25 @@
+module RubyHome
+  class ServiceCollection
+    include Enumerable
+
+    def initialize(*services)
+      @services = services
+    end
+
+    def each(&block)
+      services.each(&block)
+    end
+
+    def <<(service)
+      @services << service
+    end
+
+    def characteristics
+      flat_map(&:characteristics).flat_map(&:all)
+    end
+
+    private
+
+      attr_reader :services
+  end
+end

data/lib/ruby_home/version.rb

@@ -1,3 +1,3 @@
 module RubyHome
-  VERSION = '0.1.17'
+  VERSION = '0.1.18'
 end

data/lib/ruby_home.rb

@@ -1,7 +1,6 @@
-require 'active_support'
-require 'active_support/core_ext/hash'
 require 'bindata'
 require 'dnssd'
+require 'facets/hash/slice'
 require 'hkdf'
 require 'nio'
 require 'oj'
@@ -38,6 +37,8 @@ module RubyHome
     end
 
     def shutdown
+      hap_server.shutdown
+
       threads.each(&:exit)
     end
 

data/rubyhome.gemspec

@@ -25,16 +25,17 @@ Gem::Specification.new do |spec|
   spec.executables   = ['ruby_home']
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '~> 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 'nio4r', '~> 2.3', '>= 2.3.1'
-  spec.add_dependency 'oj', '3.7.4'
+  spec.add_dependency 'oj', '3.7.6'
   spec.add_dependency 'rbnacl', '~> 6.0'
   spec.add_dependency 'ruby_home-srp', '~> 1.2'
-  spec.add_dependency 'sinatra', '2.0.4'
+  spec.add_dependency 'sinatra', '2.0.5'
   spec.add_dependency 'wisper', '~> 2.0'
+
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'byebug', '~> 10.0'
   spec.add_development_dependency 'plist', '~> 3.4'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby_home
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Karl Entwistle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bindata
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: hkdf
   requirement: !ruby/object:Gem::Requirement
@@ -98,14 +98,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.4
+        version: 3.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.4
+        version: 3.7.6
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +140,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: wisper
   requirement: !ruby/object:Gem::Requirement
@@ -271,7 +271,11 @@ files:
 - bin/ruby_home
 - bin/setup
 - 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/characteristics.yml
 - lib/ruby_home/config/services.yml
 - lib/ruby_home/device_id.rb
@@ -282,20 +286,16 @@ files:
 - lib/ruby_home/factories/templates/characteristic_template.rb
 - lib/ruby_home/factories/templates/service_template.rb
 - lib/ruby_home/greeter.rb
-- lib/ruby_home/hap/accessory.rb
-- lib/ruby_home/hap/accessory_collection.rb
-- lib/ruby_home/hap/characteristic.rb
 - lib/ruby_home/hap/crypto/chacha20poly1305.rb
 - lib/ruby_home/hap/crypto/hkdf.rb
 - lib/ruby_home/hap/crypto/session_key.rb
+- lib/ruby_home/hap/decrypter.rb
+- lib/ruby_home/hap/encrypter.rb
 - lib/ruby_home/hap/ev_response.rb
 - lib/ruby_home/hap/hap_request.rb
 - lib/ruby_home/hap/hap_response.rb
 - lib/ruby_home/hap/server.rb
-- lib/ruby_home/hap/service.rb
 - lib/ruby_home/hap/session.rb
-- lib/ruby_home/hap/session/decrypter.rb
-- lib/ruby_home/hap/session/encrypter.rb
 - lib/ruby_home/hap/tlv.rb
 - lib/ruby_home/hap/values/base_value.rb
 - lib/ruby_home/hap/values/bool_value.rb
@@ -327,6 +327,8 @@ files:
 - lib/ruby_home/identifier_cache.rb
 - lib/ruby_home/password.rb
 - lib/ruby_home/persistable.rb
+- lib/ruby_home/service.rb
+- lib/ruby_home/service_collection.rb
 - lib/ruby_home/version.rb
 - rubyhome.gemspec
 - sbin/characteristic_generator.rb
@@ -350,8 +352,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Ruby HomeKit support