ruby_home 0.2.0 → 0.2.5

data/lib/ruby_home/config/services.yml

@@ -152,6 +152,14 @@
   - 00000023-0000-1000-8000-0026BB765291
   :required_characteristics_uuids:
   - 000000AC-0000-1000-8000-0026BB765291
+- :name: :faucet
+  :description: Faucet
+  :uuid: 000000D7-0000-1000-8000-0026BB765291
+  :optional_characteristics_uuids:
+  - 00000023-0000-1000-8000-0026BB765291
+  - 00000077-0000-1000-8000-0026BB765291
+  :required_characteristics_uuids:
+  - 000000B0-0000-1000-8000-0026BB765291
 - :name: :garage_door_opener
   :description: Garage Door Opener
   :uuid: 00000041-0000-1000-8000-0026BB765291
@@ -206,6 +214,30 @@
   - 00000023-0000-1000-8000-0026BB765291
   :required_characteristics_uuids:
   - 00000010-0000-1000-8000-0026BB765291
+- :name: :input_source
+  :description: Input Source
+  :uuid: 000000D9-0000-1000-8000-0026BB765291
+  :optional_characteristics_uuids:
+  - 000000E6-0000-1000-8000-0026BB765291
+  - 000000DC-0000-1000-8000-0026BB765291
+  - 00000134-0000-1000-8000-0026BB765291
+  :required_characteristics_uuids:
+  - 000000E3-0000-1000-8000-0026BB765291
+  - 000000DB-0000-1000-8000-0026BB765291
+  - 000000D6-0000-1000-8000-0026BB765291
+  - 00000023-0000-1000-8000-0026BB765291
+  - 00000135-0000-1000-8000-0026BB765291
+- :name: :irrigation_system
+  :description: Irrigation System
+  :uuid: 000000CF-0000-1000-8000-0026BB765291
+  :optional_characteristics_uuids:
+  - 00000023-0000-1000-8000-0026BB765291
+  - 000000D4-0000-1000-8000-0026BB765291
+  - 00000077-0000-1000-8000-0026BB765291
+  :required_characteristics_uuids:
+  - 000000B0-0000-1000-8000-0026BB765291
+  - 000000D1-0000-1000-8000-0026BB765291
+  - 000000D2-0000-1000-8000-0026BB765291
 - :name: :leak_sensor
   :description: Leak Sensor
   :uuid: '00000083-0000-1000-8000-0026BB765291'
@@ -221,11 +253,11 @@
   :description: Light Sensor
   :uuid: '00000084-0000-1000-8000-0026BB765291'
   :optional_characteristics_uuids:
+  - 00000023-0000-1000-8000-0026BB765291
   - 00000075-0000-1000-8000-0026BB765291
   - 00000077-0000-1000-8000-0026BB765291
   - 0000007A-0000-1000-8000-0026BB765291
   - '00000079-0000-1000-8000-0026BB765291'
-  - 00000023-0000-1000-8000-0026BB765291
   :required_characteristics_uuids:
   - 0000006B-0000-1000-8000-0026BB765291
 - :name: :lightbulb
@@ -236,6 +268,7 @@
   - 00000013-0000-1000-8000-0026BB765291
   - 0000002F-0000-1000-8000-0026BB765291
   - 00000023-0000-1000-8000-0026BB765291
+  - 000000CE-0000-1000-8000-0026BB765291
   :required_characteristics_uuids:
   - 00000025-0000-1000-8000-0026BB765291
 - :name: :lock_management
@@ -265,9 +298,9 @@
   :description: Microphone
   :uuid: 00000112-0000-1000-8000-0026BB765291
   :optional_characteristics_uuids:
-  - '00000119-0000-1000-8000-0026BB765291'
   - 00000023-0000-1000-8000-0026BB765291
   :required_characteristics_uuids:
+  - '00000119-0000-1000-8000-0026BB765291'
   - 0000011A-0000-1000-8000-0026BB765291
 - :name: :motion_sensor
   :description: Motion Sensor
@@ -284,11 +317,11 @@
   :description: Occupancy Sensor
   :uuid: '00000086-0000-1000-8000-0026BB765291'
   :optional_characteristics_uuids:
+  - 00000023-0000-1000-8000-0026BB765291
   - 00000075-0000-1000-8000-0026BB765291
   - 00000077-0000-1000-8000-0026BB765291
   - 0000007A-0000-1000-8000-0026BB765291
   - '00000079-0000-1000-8000-0026BB765291'
-  - 00000023-0000-1000-8000-0026BB765291
   :required_characteristics_uuids:
   - 00000071-0000-1000-8000-0026BB765291
 - :name: :outlet
@@ -343,8 +376,8 @@
   :description: Speaker
   :uuid: 00000113-0000-1000-8000-0026BB765291
   :optional_characteristics_uuids:
-  - '00000119-0000-1000-8000-0026BB765291'
   - 00000023-0000-1000-8000-0026BB765291
+  - '00000119-0000-1000-8000-0026BB765291'
   :required_characteristics_uuids:
   - 0000011A-0000-1000-8000-0026BB765291
 - :name: :stateless_programmable_switch
@@ -362,6 +395,34 @@
   - 00000023-0000-1000-8000-0026BB765291
   :required_characteristics_uuids:
   - 00000025-0000-1000-8000-0026BB765291
+- :name: :television
+  :description: Television
+  :uuid: '000000D8-0000-1000-8000-0026BB765291'
+  :optional_characteristics_uuids:
+  - 00000008-0000-1000-8000-0026BB765291
+  - 000000DD-0000-1000-8000-0026BB765291
+  - 00000136-0000-1000-8000-0026BB765291
+  - 000000E0-0000-1000-8000-0026BB765291
+  - 00000137-0000-1000-8000-0026BB765291
+  - 000000E2-0000-1000-8000-0026BB765291
+  - 000000DF-0000-1000-8000-0026BB765291
+  - 00000023-0000-1000-8000-0026BB765291
+  :required_characteristics_uuids:
+  - 000000B0-0000-1000-8000-0026BB765291
+  - 000000E7-0000-1000-8000-0026BB765291
+  - 000000E3-0000-1000-8000-0026BB765291
+  - 000000E1-0000-1000-8000-0026BB765291
+  - 000000E8-0000-1000-8000-0026BB765291
+- :name: :television_speaker
+  :description: Television Speaker
+  :uuid: 00000113-0000-1000-8000-0026BB765291
+  :optional_characteristics_uuids:
+  - 000000B0-0000-1000-8000-0026BB765291
+  - 00000119-0000-1000-8000-0026BB765291
+  - 000000E9-0000-1000-8000-0026BB765291
+  - 000000EA-0000-1000-8000-0026BB765291
+  :required_characteristics_uuids:
+  - 0000011A-0000-1000-8000-0026BB765291
 - :name: :temperature_sensor
   :description: Temperature Sensor
   :uuid: '0000008A-0000-1000-8000-0026BB765291'
@@ -388,6 +449,20 @@
   - 00000011-0000-1000-8000-0026BB765291
   - 00000035-0000-1000-8000-0026BB765291
   - 00000036-0000-1000-8000-0026BB765291
+- :name: :valve
+  :description: Valve
+  :uuid: 000000D0-0000-1000-8000-0026BB765291
+  :optional_characteristics_uuids:
+  - 000000D3-0000-1000-8000-0026BB765291
+  - 000000D4-0000-1000-8000-0026BB765291
+  - 000000D6-0000-1000-8000-0026BB765291
+  - 000000CB-0000-1000-8000-0026BB765291
+  - 00000077-0000-1000-8000-0026BB765291
+  - 00000023-0000-1000-8000-0026BB765291
+  :required_characteristics_uuids:
+  - 000000B0-0000-1000-8000-0026BB765291
+  - 000000D2-0000-1000-8000-0026BB765291
+  - 000000D5-0000-1000-8000-0026BB765291
 - :name: :window
   :description: Window
   :uuid: '0000008B-0000-1000-8000-0026BB765291'

data/lib/ruby_home/configuration.rb

@@ -1,7 +1,12 @@
 module RubyHome
+  class UnknownCategoriyIdentifierError < StandardError; end
+
   class Configuration
     extend Forwardable
 
+    CATEGORIES_FILEPATH = (File.dirname(__FILE__) + '/config/categories.yml').freeze
+    CATEGORIES = YAML.load_file(CATEGORIES_FILEPATH).freeze
+
     def initialize(accessory_info = AccessoryInfo.instance)
       @accessory_info = accessory_info
     end
@@ -11,6 +16,7 @@ module RubyHome
     DEFAULT_PORT = 4567
     DEFAULT_MODEL_NAME = DEFAULT_NAME
     DEFAULT_DISCOVERY_NAME = DEFAULT_NAME
+    DEFAULT_CATEGORY_IDENTIFIER = 2
 
     def discovery_name
       @discovery_name || DEFAULT_DISCOVERY_NAME
@@ -28,6 +34,19 @@ module RubyHome
       @host || DEFAULT_HOST
     end
 
+    def category_identifier
+      @category_identifier || DEFAULT_CATEGORY_IDENTIFIER
+    end
+
+    def category_identifier=(value)
+      if value.is_a?(Symbol)
+        raise UnknownCategoriyIdentifierError if !CATEGORIES.include?(value)
+        @category_identifier = CATEGORIES[value]
+      else
+        @category_identifier = value.to_i
+      end
+    end
+
     attr_writer :discovery_name, :model_name, :host, :port
 
     def_delegators :@accessory_info, :password, :password=

data/lib/ruby_home/dns/service.rb

@@ -6,6 +6,8 @@ module RubyHome
       end
 
       def update
+        return if RbConfig::CONFIG['target_os'] =~ /linux/
+
         dnssd_service.add_record(DNSSD::Record::TXT, text_record.encode)
       end
 

data/lib/ruby_home/dns/text_record.rb

@@ -38,7 +38,7 @@ module RubyHome
     # 1-65535.
 
     def accessory_category_identifier
-      2
+      @configuration.category_identifier
     end
 
     # Feature flags (e.g. "0x3" for bits 0 and 1). Required if non-zero.

data/lib/ruby_home/errors.rb

@@ -0,0 +1,4 @@
+module RubyHome
+  class RubyHomeError < StandardError; end
+  class UnknownValueError < RubyHomeError; end
+end

data/lib/ruby_home/factories/characteristic_factory.rb

@@ -15,6 +15,7 @@ module RubyHome
         format: template.format,
         name: characteristic_name,
         properties: template.properties,
+        constraints: template.constraints,
         service: service,
         unit: template.unit,
         uuid: template.uuid,

data/lib/ruby_home/factories/templates/characteristic_template.rb

@@ -4,7 +4,7 @@ module RubyHome
     DATA = YAML.load_file(FILEPATH).freeze
 
     def self.all
-      @@all ||= DATA.map { |data| new(data) }
+      @@all ||= DATA.map { |data| new(**data) }
     end
 
     def self.find_by(options)

data/lib/ruby_home/factories/templates/service_template.rb

@@ -4,7 +4,7 @@ module RubyHome
     DATA = YAML.load_file(FILEPATH).freeze
 
     def self.all
-      @all ||= DATA.map { |data| new(data) }
+      @all ||= DATA.map { |data| new(**data) }
     end
 
     def self.find_by(options)

data/lib/ruby_home/hap/server_handler.rb

@@ -35,29 +35,20 @@ module RubyHome
           Host: bind_address,
           ServerSoftware: 'RubyHome',
           Logger: server_logger,
-          AccessLog: access_logger
+          AccessLog: []
         }
       end
 
       def server_logger
-        if ENV['DEBUG']
+        if ENV['DEBUG'] == 'debug'
           WEBrick::Log::new(STDOUT, WEBrick::BasicLog::DEBUG)
+        elsif ENV['DEBUG'] == 'info'
+          WEBrick::Log::new(STDOUT, WEBrick::BasicLog::INFO)
         else
           WEBrick::Log::new("/dev/null", WEBrick::BasicLog::WARN)
         end
       end
 
-      def access_logger
-        if ENV['DEBUG']
-          [
-            [ STDOUT, WEBrick::AccessLog::COMMON_LOG_FORMAT ],
-            [ STDOUT, WEBrick::AccessLog::REFERER_LOG_FORMAT ]
-          ]
-        else
-          []
-        end
-      end
-
       def bind_address
         configuration.host
       end

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

@@ -13,7 +13,17 @@ module RubyHome
       end
 
       def valid_values
-        template.constraints.fetch('ValidValues')
+        defined_values || range_values || raise(UnknownValueError, "Constraint contains an unrecognized list of values: #{template.constraints.inspect }")
+      end
+
+      def defined_values
+        template.constraints.dig('ValidValues')
+      end
+
+      def range_values
+        if min = template.constraints.dig('MinimumValue')
+          { min.to_s => min }
+        end
       end
   end
 end

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

@@ -5,10 +5,17 @@ module RubyHome
     class ApplicationController < Sinatra::Base
       disable :protection
 
-      if ENV['DEBUG']
-        enable :logging
-        set :logger, Logger.new(STDOUT)
+      logger = Logger.new(STDOUT)
+      logger.level = case ENV['DEBUG']
+      when 'debug'
+        Logger::DEBUG
+      when 'info'
+        Logger::INFO
+      else
+        Logger::WARN
       end
+      set :logger, logger
+      enable :logging if ENV['DEBUG']
 
       before do
         logger.debug "Session"

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

@@ -38,9 +38,9 @@ module RubyHome
           device_proof: unpack_request[:proof],
           srp_session: session.srp_session,
           public_key: unpack_request[:public_key],
-        )
+        ).run
 
-        if verify_srp.valid?
+        if verify_srp.success?
           session.session_key = verify_srp.session_key
           session.srp_session = nil
 
@@ -96,7 +96,7 @@ module RubyHome
           encrypted_data = chacha20poly1305ietf.encrypt(nonce, subtlv)
 
           pairing_params = { admin: true, identifier: iosdevicepairingid, public_key: iosdeviceltpk.unpack1('H*') }
-          accessory_info.add_paired_client pairing_params
+          accessory_info.add_paired_client(**pairing_params)
 
           tlv state: 6, encrypted_data: encrypted_data
         end

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

@@ -48,18 +48,16 @@ module RubyHome
       end
 
       def verify_finish_response
-        encrypted_data = unpack_request[:encrypted_data]
-
-        chacha20poly1305ietf = HAP::Crypto::ChaCha20Poly1305.new(session.session_key)
-        nonce = HexHelper.pad('PV-Msg03')
-        decrypted_data = chacha20poly1305ietf.decrypt(nonce, encrypted_data)
-        unpacked_decrypted_data = TLV.decode(decrypted_data)
-
-        if accessory_info.paired_clients.any? {|h| h[:identifier] == unpacked_decrypted_data[:identifier]}
-          shared_secret = HAP::Crypto::SessionKey.new(session.shared_secret)
-
-          session.controller_to_accessory_key = shared_secret.controller_to_accessory_key
-          session.accessory_to_controller_key = shared_secret.accessory_to_controller_key
+        verify_finish = VerifyFinishService.new(
+          encrypted_data: unpack_request[:encrypted_data],
+          session_key: session.session_key,
+          shared_secret: session.shared_secret,
+          accessory_info: accessory_info
+        ).run
+
+        if verify_finish.success?
+          session.controller_to_accessory_key = verify_finish.controller_to_accessory_key
+          session.accessory_to_controller_key = verify_finish.accessory_to_controller_key
 
           session.session_key = nil
           session.shared_secret = nil

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

@@ -22,7 +22,7 @@ module RubyHome
           identifier: unpack_request[:identifier],
           public_key: unpack_request[:public_key].unpack1('H*')
         }
-        accessory_info.add_paired_client pairing_params
+        accessory_info.add_paired_client(**pairing_params)
 
         tlv state: 2
       end

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

@@ -14,13 +14,13 @@ module RubyHome
           'perms' => perms(characteristic),
           'format' => characteristic.format,
           'description' => characteristic.description,
-        }.merge(value_hash(characteristic))
+        }
+          .merge(value_hash(characteristic))
+          .merge(valid_values_hash(characteristic))
       end
 
       private
 
-        HIDDEN_VALUE_OBJECTS = [ IdentifyValue ].freeze
-
         def perms(characteristic)
           characteristic.properties.map do |property|
             RubyHome::Characteristic::PROPERTIES[property]
@@ -28,10 +28,18 @@ module RubyHome
         end
 
         def value_hash(characteristic)
-          if HIDDEN_VALUE_OBJECTS.include?(characteristic.value_object.class)
+          if characteristic.properties.include?('read')
+            { 'value' => characteristic.value }
+          else
+            {}
+          end
+        end
+
+        def valid_values_hash(characteristic)
+          if characteristic.valid_values.empty?
             {}
           else
-            { 'value' => characteristic.value }.compact
+            { 'valid-values' => characteristic.valid_values }
           end
         end
     end

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

@@ -15,7 +15,17 @@ module RubyHome
           'characteristics' => CharacteristicSerializer.new(service.characteristics).serializable_hash,
           'primary' => service.primary,
           'hidden' => service.hidden,
-        }
+        }.merge(linked_services(service))
+      end
+
+      private
+
+      def linked_services(service)
+        if service.linked.empty?
+          {}
+        else
+          { 'linked' => service.linked.map(&:instance_id) }
+        end
       end
     end
   end

data/lib/ruby_home/http/services/verify_finish_service.rb

@@ -0,0 +1,56 @@
+module RubyHome
+  class VerifyFinishService
+    def initialize(accessory_info: , encrypted_data: , session_key:, shared_secret:)
+      @accessory_info = accessory_info
+      @encrypted_data = encrypted_data
+      @session_key = session_key
+      @shared_secret = HAP::Crypto::SessionKey.new(shared_secret)
+    end
+
+    def run
+      if paired_client_exists?
+        RubyHome.dns_service.update
+
+        OpenStruct.new(
+          success?: true,
+          controller_to_accessory_key: shared_secret.controller_to_accessory_key,
+          accessory_to_controller_key: shared_secret.accessory_to_controller_key
+        )
+      else
+        OpenStruct.new(success?: false)
+      end
+    end
+
+    private
+
+      NONCE = -'PV-Msg03'
+
+      attr_reader :accessory_info, :encrypted_data, :session_key, :shared_secret
+
+      def paired_client_exists?
+        accessory_info.paired_clients.any? do |paired_client|
+          paired_client[:identifier] == identifier
+        end
+      end
+
+      def chacha20poly1305
+        HAP::Crypto::ChaCha20Poly1305.new(session_key)
+      end
+
+      def nonce
+        HexHelper.pad(NONCE)
+      end
+
+      def decrypted_data
+        chacha20poly1305.decrypt(nonce, encrypted_data)
+      end
+
+      def unpacked_decrypted_data
+        TLV.decode(decrypted_data)
+      end
+
+      def identifier
+        unpacked_decrypted_data[:identifier]
+      end
+  end
+end