ruby_home 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf4e167745548086679350014c0375cf64eeb8733b9e6948ef0846ea36fd4f11
-  data.tar.gz: d8583372ac979eceafcd3c6a1cf36f8f40c32d5ab543ff28b7cf03e11e294d9b
+  metadata.gz: b7f5f53b947e2cfbce79204572dd8d29b284c5434304aee7214b6a7a33d3e0a6
+  data.tar.gz: '086845819574df45f838c8ff67979f55f01763b6fe44114af76fd3479f8f1b83'
 SHA512:
-  metadata.gz: 84a6186ceb1d259b60bfe877ee3e12c78c4d9a25cb3fc9433605c45264a3bc174796650bb87e95795f8c39ea6dd365bc22425c6360636e07923f731cacaf185d
-  data.tar.gz: 19899a408055f4dd74993b03679cee97ea4d440b09beccbf6aaf4d034db727a96d09a73fc85ddb85f3fc4326704782ec861f9e006149a05c9e6c00c57123513d
+  metadata.gz: 419df1283d71010c0a4e8e89f60f01fa752ea9366f6fe59a1ca3a2e202a9ab72361ed4dff5389ecdfb8b084feb40cd0d5c62fcbf16b90b65bfcd5096c7a3a4ab
+  data.tar.gz: 3644d107b711edadd639f881614ebd85cb8e164cbeebf5db30e1748303983b52bf056371e952a6c9c0e39aa2a7744351549ddaf2eef4c655428dabdf0c9fe2eb

data/README.md

@@ -21,18 +21,18 @@ Or install it yourself as:
 
     $ gem install ruby_home
 
-## Usage
+## Basic Usage
 
 Create a fan with an on/off switch.
 
 ```ruby
 require 'ruby_home'
 
-accessory_information = RubyHome::AccessoryFactory.create(:accessory_information)
-fan = RubyHome::AccessoryFactory.create(:fan)
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+fan = RubyHome::ServiceFactory.create(:fan)
 
-fan.characteristic(:on).on(:updated) do |new_value|
-  if new_value == 1
+fan.characteristic(:on).after_update do |characteristic|
+  if characteristic.value == 1
     puts "Fan switched on"
   else
     puts "Fan switched off"
@@ -42,6 +42,65 @@ 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 ties to provide sane defaults for all services. Customization of any of the options is possible.
+
+```ruby
+require 'ruby_home'
+
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information,
+  firmware_revision: '4.3.18421',
+  manufacturer: 'Fake Company',
+  model: 'BSB001',
+  name: 'Kickass fan bridge',
+  serial_number: 'AB1-UK-A123456'
+)
+
+fan = RubyHome::ServiceFactory.create(:fan,
+  on: false,
+  rotation_speed: 50,
+  rotation_direction: 1,
+  firmware_revision: '105.0.21169',
+  manufacturer: 'Fake Company',
+  model: 'LWB006',
+  name: 'Kickass fan',
+  serial_number: '123-UK-A12345'
+)
+
+fan.characteristic(:on).after_update do |characteristic|
+  if characteristic.value == 1
+    puts "Fan switched on"
+  else
+    puts "Fan switched off"
+  end
+end
+
+RubyHome.run
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/rubyhome

@@ -2,11 +2,11 @@
 
 require_relative '../lib/ruby_home'
 
-accessory_information = RubyHome::AccessoryFactory.create(:accessory_information)
-fan = RubyHome::AccessoryFactory.create(:fan)
+accessory_information = RubyHome::ServiceFactory.create(:accessory_information)
+fan = RubyHome::ServiceFactory.create(:fan)
 
-fan.characteristic(:on).on(:updated) do |new_value|
-  if new_value == 1
+fan.characteristic(:on).after_update do |characteristic|
+  if characteristic.value == 1
     puts "Fan switched on"
   else
     puts "Fan switched off"

data/lib/ruby_home/accessory_info.rb

@@ -1,24 +1,46 @@
-require_relative 'device_id'
-require_relative 'yaml_record'
+require_relative 'persistable'
 
 module RubyHome
-  class AccessoryInfo < YamlRecord::Base
+  class AccessoryInfo
+    include Persistable
+
+    self.source = 'accessory_info.yml'
+
+    def self.instance
+      @@_instance ||= persisted || create
+    end
+
+    def self.reload
+      @@_instance = nil
+    end
+
     USERNAME = -'Pair-Setup'
 
-    properties :device_id, :paired_clients, :password, :signature_key
-    source 'accessory_info.yml'
+    def initialize(device_id: nil, paired_clients: [], password: nil, signature_key: nil)
+      @device_id = device_id
+      @paired_clients = paired_clients
+      @password = password
+      @signature_key = signature_key
+    end
 
-    set_callback :before_create, :set_device_id
-    set_callback :before_create, :set_paired_clients
-    set_callback :before_create, :set_password
-    set_callback :before_create, :set_signature_key
+    def username
+      USERNAME
+    end
 
-    def self.instance
-      first || create
+    def password
+      @password ||= Password.generate
+    end
+
+    def device_id
+      @device_id ||= DeviceID.generate
+    end
+
+    def paired_clients
+      @paired_clients ||= []
     end
 
     def add_paired_client(admin: false, identifier: , public_key: )
-      paired_clients << { admin: admin, identifier: identifier, public_key: public_key }
+      @paired_clients << { admin: admin, identifier: identifier, public_key: public_key }
       save
     end
 
@@ -35,26 +57,19 @@ module RubyHome
       @signing_key ||= RbNaCl::Signatures::Ed25519::SigningKey.new([signature_key].pack('H*'))
     end
 
-    def username
-      USERNAME
-    end
-
     private
 
-    def set_device_id
-      self.device_id ||= DeviceID.generate
-    end
-
-    def set_paired_clients
-      self.paired_clients = []
-    end
+      def signature_key
+        @signature_key ||= RbNaCl::Signatures::Ed25519::SigningKey.generate.to_bytes.unpack1('H*')
+      end
 
-    def set_password
-      self.password ||= Password.generate
-    end
-
-    def set_signature_key
-      self.signature_key ||= RbNaCl::Signatures::Ed25519::SigningKey.generate.to_bytes.unpack1('H*')
-    end
+      def persisted_attributes
+        {
+          device_id: device_id,
+          paired_clients: paired_clients,
+          password: password,
+          signature_key: signature_key
+        }
+      end
   end
 end

data/lib/ruby_home/factories/characteristic_factory.rb

@@ -4,37 +4,45 @@ module RubyHome
       identify: nil,
     }.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
+    def self.create(characteristic_name, service: , value: nil)
+      new(
+        characteristic_name: characteristic_name,
+        service: service,
+        value: value
+      ).create
     end
 
     def create
-      yield characteristic if block_given?
+      service.characteristics << new_characteristic
 
-      characteristic.save
-      characteristic
+      new_characteristic
     end
 
     private
 
-      attr_reader :characteristic_name, :options
-
-      def template
-        @template ||= CharacteristicTemplate.find_by(name: characteristic_name.to_sym)
+      def initialize(characteristic_name:, service:, value:)
+        @characteristic_name = characteristic_name.to_sym
+        @service = service
+        @value = value || default_value
       end
 
-      def characteristic
-        @characteristic ||= Characteristic.new(characteristic_params)
+      attr_reader :service, :characteristic_name, :value
+
+      def new_characteristic
+        @new_characteristic ||= Characteristic.new(
+          description: template.description,
+          format: template.format,
+          name: characteristic_name,
+          properties: template.properties,
+          service: service,
+          unit: template.unit,
+          uuid: template.uuid,
+          value: value
+        )
       end
 
-      def characteristic_params
-        options[:value] ||= default_value
-        options.merge(template.to_hash)
+      def template
+        @template ||= CharacteristicTemplate.find_by(name: characteristic_name)
       end
 
       def default_value

data/lib/ruby_home/factories/default_values/float_value.rb

@@ -9,7 +9,7 @@ module RubyHome
     private
 
       def minimum_value
-        template.constraints.fetch('MinimumValue')
+        template.constraints.fetch('MinimumValue', 0)
       end
   end
 end

data/lib/ruby_home/factories/service_factory.rb

@@ -0,0 +1,89 @@
+module RubyHome
+  class ServiceFactory
+    def self.create(service_name, accessory: Accessory.new, **options)
+      new(
+        service_name: service_name,
+        accessory: accessory,
+        **options
+      ).create
+    end
+
+    def create
+      accessory.services << new_service
+
+      create_accessory_information
+      create_required_characteristics
+      create_optional_characteristics
+
+      new_service
+    end
+
+    private
+      ACCESSORY_INFORMATION_OPTIONS = [
+        :firmware_revision,
+        :manufacturer,
+        :model,
+        :name,
+        :serial_number
+      ].freeze
+
+      def initialize(service_name:, accessory:, **options)
+        @service_name = service_name.to_sym
+        @accessory = accessory
+        @options = options
+      end
+
+      attr_reader :service_name, :accessory, :options
+
+      def new_service
+        @new_service ||= Service.new(
+          accessory: accessory,
+          description: template.description,
+          name: service_name,
+          uuid: template.uuid
+        )
+      end
+
+      def create_required_characteristics
+        template.required_characteristics.each do |characteristic_template|
+          characteristic_name = characteristic_template.name
+          CharacteristicFactory.create(
+            characteristic_template.name,
+            service: new_service,
+            value: options[characteristic_name]
+          )
+        end
+      end
+
+      def create_optional_characteristics
+        optional_characteristic_templates.each do |characteristic_template|
+          characteristic_name = characteristic_template.name
+          CharacteristicFactory.create(
+            characteristic_name,
+            service: new_service,
+            value: options[characteristic_name]
+          )
+        end
+      end
+
+      def optional_characteristic_templates
+        template.optional_characteristics.select do |characteristic_template|
+          options.keys.include?(characteristic_template.name)
+        end
+      end
+
+      def create_accessory_information
+        unless service_name == :accessory_information
+          ServiceFactory.create(
+            :accessory_information,
+            accessory: accessory,
+            **options.slice(*ACCESSORY_INFORMATION_OPTIONS)
+          )
+        end
+      end
+
+      def template
+        @template ||= ServiceTemplate.find_by(name: service_name)
+      end
+  end
+end

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

@@ -15,7 +15,7 @@ module RubyHome
       end
     end
 
-    def initialize(name:, description:, uuid:, format:, unit:, permissions:, properties:, constraints:)
+    def initialize(name:, description:, uuid:, format:, unit:, permissions:, properties:, constraints: )
       @name = name
       @description = description
       @uuid = uuid
@@ -26,7 +26,11 @@ module RubyHome
       @constraints = constraints
     end
 
-    attr_reader :name, :description, :uuid, :format, :unit, :permissions, :properties, :constraints
+    attr_reader :name, :description, :uuid, :format, :unit, :permissions, :properties
+
+    def constraints
+      @constraints || {}
+    end
 
     def to_hash
       {

data/lib/ruby_home/hap/accessory.rb

@@ -1,11 +1,22 @@
 module RubyHome
   class Accessory
+    @@all = AccessoryCollection.new
+
+    def self.all
+      @@all
+    end
+
+    def self.reset
+      @@all = AccessoryCollection.new
+    end
+
     def initialize
       @services = []
+      @id = next_available_accessory_id
+      @@all << self
     end
 
-    attr_accessor :id
-    attr_reader :services
+    attr_reader :services, :id
 
     def characteristics
       services.flat_map(&:characteristics)
@@ -15,12 +26,22 @@ module RubyHome
       (largest_instance_id || 0) + 1
     end
 
+    private
+
     def instance_ids
-      services.map(&:instance_id) + characteristics.map(&:instance_id)
+      instances.map(&:instance_id)
+    end
+
+    def instances
+      services + characteristics
     end
 
     def largest_instance_id
       instance_ids.max
     end
+
+    def next_available_accessory_id
+      self.class.all.count + 1
+    end
   end
 end

data/lib/ruby_home/hap/accessory_collection.rb

@@ -0,0 +1,38 @@
+module RubyHome
+  class AccessoryCollection
+    include Enumerable
+    attr_accessor :accessories
+
+    def initialize(*accessories)
+      @accessories = accessories
+    end
+
+    def each
+      @accessories.map do |accessory|
+        yield accessory
+      end
+    end
+
+    def <<(accessory)
+      @accessories << accessory
+    end
+
+    def find_characteristic(attributes)
+      characteristics.find do |characteristic|
+        attributes.all? do |key, value|
+          characteristic.send(key) == value
+        end
+      end
+    end
+
+    private
+
+    def services
+      accessories.flat_map(&:services)
+    end
+
+    def characteristics
+      services.flat_map(&:characteristics)
+    end
+  end
+end

data/lib/ruby_home/hap/characteristic.rb

@@ -2,6 +2,18 @@ module RubyHome
   class Characteristic
     include Wisper::Publisher
 
+    public :local_registrations
+
+    def unsubscribe(*listeners)
+      local_registrations.delete_if do |registration|
+        listeners.include?(registration.listener)
+      end
+    end
+
+    def after_update(&block)
+      on(:after_update, &block)
+    end
+
     PROPERTIES = {
       'cnotify' => 'ev',
       'read' => 'pr',
@@ -18,10 +30,20 @@ module RubyHome
       @properties = properties
       @service = service
       @value = value
+      @instance_id = accessory.next_available_instance_id
     end
 
-    attr_reader :service, :value, :uuid, :name, :description, :format, :unit, :properties
-    attr_accessor :instance_id
+    attr_reader(
+      :service,
+      :value,
+      :uuid,
+      :name,
+      :description,
+      :format,
+      :unit,
+      :properties,
+      :instance_id
+    )
 
     def accessory
       service.accessory
@@ -37,24 +59,8 @@ module RubyHome
 
     def value=(new_value)
       return if name == :identify
-
       @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)
+      broadcast(:after_update, self)
     end
   end
 end

data/lib/ruby_home/hap/crypto/session_key.rb

@@ -0,0 +1,31 @@
+module RubyHome
+  module HAP
+    module Crypto
+      class SessionKey
+        def initialize(shared_secret)
+          @shared_secret = shared_secret
+        end
+
+        def controller_to_accessory_key
+          @controller_to_accessory_key ||= generate_shared_secret_key(WRITE)
+        end
+
+        def accessory_to_controller_key
+          @accessory_to_controller_key ||= generate_shared_secret_key(READ)
+        end
+
+        private
+
+          SALT = -'Control-Salt'
+          READ = -'Control-Read-Encryption-Key'
+          WRITE = -'Control-Write-Encryption-Key'
+
+          attr_reader :shared_secret
+
+          def generate_shared_secret_key(info)
+            Crypto::HKDF.new(info: info, salt: SALT).encrypt(shared_secret)
+          end
+      end
+    end
+  end
+end

data/lib/ruby_home/hap/ev_response.rb

@@ -0,0 +1,64 @@
+module RubyHome
+  module HAP
+    class EVResponse
+      def initialize(socket, body)
+        @socket = socket
+        @body = body
+        cache[:accessory_to_controller_count] ||= 0
+      end
+
+      def send_response
+        response = ''
+
+        send_header(response)
+        send_body(response)
+
+        encrypted_response = encrypter.encrypt(response).join
+        cache[:accessory_to_controller_count] = encrypter.count
+
+        socket << encrypted_response
+      end
+
+      private
+
+        CRLF = -"\x0d\x0a"
+        STATUS_LINE = -'EVENT/1.0 200 OK'
+        CONTENT_TYPE_LINE = -'Content-Type: application/hap+json'
+
+        def send_header(socket)
+          socket << STATUS_LINE + CRLF
+          socket << CONTENT_TYPE_LINE + CRLF
+          socket << content_length_line + CRLF
+          socket << CRLF
+        end
+
+        def send_body(socket)
+          socket << body
+        end
+
+        def content_length_line
+          "Content-Length: #{body.length}"
+        end
+
+        attr_reader :body, :socket
+
+        def encrypter
+          @_encrypter ||= RubyHome::HAP::HTTPEncryption.new(encryption_key, encrypter_params)
+        end
+
+        def encrypter_params
+          {
+            count: cache[:accessory_to_controller_count]
+          }
+        end
+
+        def encryption_key
+          cache[:accessory_to_controller_key]
+        end
+
+        def cache
+          RubyHome.socket_store[socket]
+        end
+    end
+  end
+end

data/lib/ruby_home/{http → hap}/hap_request.rb

@@ -1,13 +1,14 @@
 module RubyHome
-  module HTTP
+  module HAP
     class HAPRequest < WEBrick::HTTPRequest
-      def initialize(*args)
+      def initialize(config, sock)
+        @sock = sock
         cache[:controller_to_accessory_count] ||= 0
 
-        super(*args)
+        super(config)
       end
 
-      def parse(socket=nil)
+      def parse(socket)
         if decryption_time?
           request_line = socket.read_nonblock(@buffer_size)
 
@@ -24,8 +25,14 @@ module RubyHome
         cache[:controller_to_accessory_count] >= 1
       end
 
+      def meta_vars
+        super.merge({"REQUEST_SOCKET" => sock})
+      end
+
       private
 
+      attr_reader :sock
+
       def decrypter
         @_decrypter ||= RubyHome::HAP::HTTPDecryption.new(decryption_key, decrypter_params)
       end
@@ -45,7 +52,7 @@ module RubyHome
       end
 
       def cache
-        RequestStore.store
+        RubyHome.socket_store[sock]
       end
     end
   end