ruby_home 0.1.0

data/lib/ruby_home/dns/text_record.rb

@@ -0,0 +1,100 @@
+require 'dnssd/text_record'
+
+module RubyHome
+  class TextRecord < DNSSD::TextRecord
+    def initialize(accessory_info:)
+      @accessory_info = accessory_info
+      super(to_hash)
+    end
+
+    private
+
+    attr_reader :accessory_info
+
+    def to_hash
+      {
+        'c#' => current_configuration_number,
+        'ci' => accessory_category_identifier,
+        'ff' => feature_flags,
+        'id' => device_id,
+        'md' => model_name,
+        'pv' => protocol_version,
+        's#' => current_state_number,
+        'sf' => status_flags
+      }
+    end
+
+    # Current configuration number. Required. Must update when an accessory,
+    # service, or characteristic is added or removed on the accessory server.
+    # Accessories must increment the config number after a firmware update. This
+    # must have a range of 1-4294967295 and wrap to 1 when it overflows. This
+    # value must persist across reboots, power cycles, etc.
+
+    def current_configuration_number
+      1
+    end
+
+    # Accessory Category Identifier. Required. Indicates the category that best
+    # describes the primary function of the accessory. This must have a range of
+    # 1-65535.
+
+    def accessory_category_identifier
+      2
+    end
+
+    # Feature flags (e.g. "0x3" for bits 0 and 1). Required if non-zero.
+
+    def feature_flags
+      0
+    end
+
+    # Status flags (e.g. "0x04" for bit 3). Value should be an unsigned integer.
+    # Required if non-zero.
+
+    STATUS_FLAGS = {
+      PAIRED: 0,
+      NOT_PAIRED: 1,
+    }.freeze
+
+    def status_flags
+      if accessory_info.paired?
+        STATUS_FLAGS[:PAIRED]
+      else
+        STATUS_FLAGS[:NOT_PAIRED]
+      end
+    end
+
+    # Device ID (Device ID (page 36)) of the accessory. The Device ID must be
+    # formatted as "XX:XX:XX:XX:XX:XX", where "XX" is a hexadecimal string
+    # representing a byte. Required. This value is also used as the accessory's
+    # Pairing Identifier.
+
+    def device_id
+      accessory_info.device_id
+    end
+
+    # Model name of the accessory (e.g. "Device1,1"). Required.
+
+    def model_name
+      'RubyHome'
+    end
+
+    # Protocol version string <major>.<minor> (e.g. "1.0"). Required if value is
+    # not "1.0". The client should check this before displaying an accessory to
+    # the user. If the major version is greater than the major version the client
+    # software was built to support, it should hide the accessory from the user. A
+    # change in the minor version indicates the protocol is still compatible. This
+    # mechanism allows future versions of the protocol to hide itself from older
+    # clients that may not know how to handle it.
+
+    def protocol_version
+      1.0
+    end
+
+    # Current state number. Required. This must have a value of "1".
+
+    def current_state_number
+      1
+    end
+  end
+end

data/lib/ruby_home/factories/accessory_factory.rb

@@ -0,0 +1,78 @@
+require_relative '../hap/service'
+require_relative '../hap/accessory'
+require_relative 'templates/service_template'
+require_relative 'templates/characteristic_template'
+
+module RubyHome
+  class AccessoryFactory
+    def self.create(service_name, characteristics: {}, **options)
+      new(service_name, options, characteristics).create
+    end
+
+    def initialize(service_name, accessory_options, characteristic_options)
+      @service_name = service_name
+      @accessory_options = accessory_options
+      @characteristic_options = characteristic_options
+    end
+
+    def create
+      yield service if block_given?
+
+      create_accessory_information
+      service.save
+      create_required_characteristics
+      create_optional_characteristics
+
+      service
+    end
+
+    private
+
+      attr_reader :service_name, :accessory_options, :characteristic_options
+
+      def template
+        @template ||= ServiceTemplate.find_by(name: service_name.to_sym)
+      end
+
+      def create_accessory_information
+        unless service_name == :accessory_information
+          AccessoryFactory.create(:accessory_information, accessory_information_params)
+        end
+      end
+
+      def accessory_information_params
+        accessory_options.merge(accessory: service.accessory)
+      end
+
+      def create_required_characteristics
+        template.required_characteristics.map do |characteristic_template|
+          CharacteristicFactory.create(characteristic_template.name, service: service) do |characteristic|
+            value = characteristic_options[characteristic.name]
+            next unless value
+
+            characteristic.value = value
+          end
+        end
+      end
+
+      def create_optional_characteristics
+        template.optional_characteristics.map do |characteristic_template|
+          value = characteristic_options[characteristic_template.name]
+          next unless value
+
+          CharacteristicFactory.create(characteristic_template.name, service: service) do |characteristic|
+            characteristic.value = value
+          end
+        end
+      end
+
+      def service
+        @service ||= Service.new(service_params)
+      end
+
+      def service_params
+        accessory_options[:accessory] ||= Accessory.new
+        accessory_options.merge(template.to_hash)
+      end
+  end
+end

data/lib/ruby_home/factories/characteristic_factory.rb

@@ -0,0 +1,57 @@
+require_relative '../hap/service'
+require_relative '../hap/accessory'
+
+module RubyHome
+  class CharacteristicFactory
+    DEFAULT_VALUES = {
+      firmware_revision: '1.0',
+      identify: nil,
+      manufacturer: 'Default-Manufacturer',
+      model: 'Default-Model',
+      name: 'RubyHome',
+      serial_number: 'Default-SerialNumber',
+    }.freeze
+
+    def self.create(characteristic_name, options={}, &block)
+      new(characteristic_name, options).create(&block)
+    end
+
+    def initialize(characteristic_name, options)
+      @characteristic_name = characteristic_name
+      @options = options
+    end
+
+    def create
+      yield characteristic if block_given?
+
+      characteristic.save
+      characteristic
+    end
+
+    private
+
+      attr_reader :characteristic_name, :options
+
+      def template
+        @template ||= CharacteristicTemplate.find_by(name: characteristic_name.to_sym)
+      end
+
+      def characteristic
+        @characteristic ||= Characteristic.new(characteristic_params)
+      end
+
+      def characteristic_params
+        options[:value] ||= default_value
+        options.merge(template.to_hash)
+      end
+
+      def default_value
+        DEFAULT_VALUES.fetch(characteristic_name.to_sym) do
+          case template.format
+          when 'bool'
+            false
+          end
+        end
+      end
+  end
+end

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

@@ -0,0 +1,43 @@
+module RubyHome
+  class CharacteristicTemplate
+    FILEPATH = (File.dirname(__FILE__) + '/../../config/characteristics.yml').freeze
+    DATA = YAML.load_file(FILEPATH).freeze
+
+    def self.all
+      @@all ||= DATA.map { |data| new(data) }
+    end
+
+    def self.find_by(options)
+      all.find do |characteristic|
+        options.all? do |key, value|
+          characteristic.send(key) == value
+        end
+      end
+    end
+
+    def initialize(name:, description:, uuid:, format:, unit:, permissions:, properties:, constraints:)
+      @name = name
+      @description = description
+      @uuid = uuid
+      @format = format
+      @unit = unit
+      @permissions = permissions
+      @properties = properties
+      @constraints = constraints
+    end
+
+    attr_reader :name, :description, :uuid, :format, :unit, :permissions, :properties, :constraints
+
+    def to_hash
+      {
+        name: name,
+        description: description,
+        uuid: uuid,
+        format: format,
+        unit: unit,
+        properties: properties,
+      }
+    end
+  end
+end
+

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

@@ -0,0 +1,50 @@
+require_relative 'characteristic_template'
+
+module RubyHome
+  class ServiceTemplate
+    FILEPATH = (File.dirname(__FILE__) + '/../../config/services.yml').freeze
+    DATA = YAML.load_file(FILEPATH).freeze
+
+    def self.all
+      @all ||= DATA.map { |data| new(data) }
+    end
+
+    def self.find_by(options)
+      all.find do |characteristic|
+        options.all? do |key, value|
+          characteristic.send(key) == value
+        end
+      end
+    end
+
+    def initialize(name:, description:, uuid:, optional_characteristics_uuids:, required_characteristics_uuids:)
+      @name = name
+      @description = description
+      @uuid = uuid
+      @optional_characteristics_uuids = optional_characteristics_uuids
+      @required_characteristics_uuids = required_characteristics_uuids
+    end
+
+    attr_reader :name, :description, :uuid, :optional_characteristics_uuids, :required_characteristics_uuids
+
+    def optional_characteristics
+      @optional_characteristics ||= optional_characteristics_uuids.map do |uuid|
+        CharacteristicTemplate.find_by(uuid: uuid)
+      end
+    end
+
+    def required_characteristics
+      @required_characteristics ||= required_characteristics_uuids.map do |uuid|
+        CharacteristicTemplate.find_by(uuid: uuid)
+      end
+    end
+
+    def to_hash
+      {
+        name: name,
+        description: description,
+        uuid: uuid
+      }
+    end
+  end
+end

data/lib/ruby_home/hap/accessory.rb

@@ -0,0 +1,26 @@
+module RubyHome
+  class Accessory
+    def initialize
+      @services = []
+    end
+
+    attr_reader :id, :services
+    attr_writer :id
+
+    def characteristics
+      services.flat_map(&:characteristics)
+    end
+
+    def next_available_instance_id
+      (largest_instance_id || 0) + 1
+    end
+
+    def instance_ids
+      services.map(&:instance_id) + characteristics.map(&:instance_id)
+    end
+
+    def largest_instance_id
+      instance_ids.max
+    end
+  end
+end

data/lib/ruby_home/hap/characteristic.rb

@@ -0,0 +1,60 @@
+require 'wisper'
+
+module RubyHome
+  class Characteristic
+    include Wisper::Publisher
+
+    PROPERTIES = {
+      'cnotify' => 'ev',
+      'read' => 'pr',
+      'uncnotify' => nil,
+      'write' => 'pw',
+    }.freeze
+
+    def initialize(uuid:, name:, description:, format:, unit:, properties:, service: , value: nil)
+      @uuid = uuid
+      @name = name
+      @description = description
+      @format = format
+      @unit = unit
+      @properties = properties
+      @service = service
+      @value = value
+    end
+
+    attr_reader :service, :value, :uuid, :name, :description, :format, :unit, :properties
+    attr_accessor :instance_id
+
+    def accessory
+      service.accessory
+    end
+
+    def accessory_id
+      accessory.id
+    end
+
+    def service_iid
+      service.instance_id
+    end
+
+    def value=(new_value)
+      @value = new_value
+      broadcast(:updated, new_value)
+    end
+
+    def inspect
+      {
+        name: name,
+        value: value,
+        accessory_id: accessory_id,
+        service_iid: service_iid,
+        instance_id: instance_id
+      }
+    end
+
+    def save
+      IdentifierCache.add_accessory(accessory)
+      IdentifierCache.add_characteristic(self)
+    end
+  end
+end

data/lib/ruby_home/hap/hex_pad.rb

@@ -0,0 +1,13 @@
+module RubyHome
+  module HAP
+    module HexPad
+      def self.pad(input, pad_length: 24)
+        [
+          input
+            .unpack1('H*')
+            .rjust(pad_length, '0')
+        ].pack('H*')
+      end
+    end
+  end
+end

data/lib/ruby_home/hap/hkdf_encryption.rb

@@ -0,0 +1,34 @@
+require 'rbnacl/libsodium'
+
+module RubyHome
+  module HAP
+    class HKDFEncryption
+      def initialize(salt:, info: )
+        @salt = salt
+        @info = info
+      end
+
+      def encrypt(source)
+        HKDF.new(source, hkdf_opts).next_bytes(BYTE_LENGTH)
+      end
+
+      private
+
+      BYTE_LENGTH = 32
+
+      attr_reader :info, :salt, :source
+
+      def hkdf_opts
+        {
+          algorithm: algorithm,
+          info: info,
+          salt: salt
+        }
+      end
+
+      def algorithm
+        'SHA512'
+      end
+    end
+  end
+end