ruby_home 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f5f53b947e2cfbce79204572dd8d29b284c5434304aee7214b6a7a33d3e0a6
-  data.tar.gz: '086845819574df45f838c8ff67979f55f01763b6fe44114af76fd3479f8f1b83'
+  metadata.gz: dff58e7d6769b9869dd1c7368ced5443698c27197ca89c4f85eafe9320fb1f62
+  data.tar.gz: 9ee496a8ebb0a2c7d1693501e5bef6cb14d99cc92d6d70aa34c04ca81947ff33
 SHA512:
-  metadata.gz: 419df1283d71010c0a4e8e89f60f01fa752ea9366f6fe59a1ca3a2e202a9ab72361ed4dff5389ecdfb8b084feb40cd0d5c62fcbf16b90b65bfcd5096c7a3a4ab
-  data.tar.gz: 3644d107b711edadd639f881614ebd85cb8e164cbeebf5db30e1748303983b52bf056371e952a6c9c0e39aa2a7744351549ddaf2eef4c655428dabdf0c9fe2eb
+  metadata.gz: a633129cf9f076ec82ed3f24295a1d70b1f2efd405466c3dee2f11ce6c56d85cdfd3fc2b7264cac70987abadf6b87f564f82431b903baae6041bbf734fcbd9f7
+  data.tar.gz: fdc5d4de8f61b619acfc20d647f5eb2f3fd68dc062921f2c0dc1305575c5eab5985af69ea2481e14be755721017510578c31135be1bcf7f166ad26348a5a0e35

data/README.md

@@ -65,7 +65,7 @@ RubyHome.run
 
 ## Customization
 
-RubyHome ties to provide sane defaults for all services. Customization of any of the options is possible.
+RubyHome tries to provide sane defaults for all services. Customization of any of the options is possible.
 
 ```ruby
 require 'ruby_home'

data/lib/ruby_home/factories/characteristic_factory.rb

@@ -4,42 +4,51 @@ module RubyHome
       identify: nil,
     }.freeze
 
-    def self.create(characteristic_name, service: , value: nil)
+    def self.create(characteristic_name, service: , subtype: 'default' , value: nil)
       new(
         characteristic_name: characteristic_name,
         service: service,
+        subtype: subtype,
         value: value
       ).create
     end
 
     def create
-      service.characteristics << new_characteristic
+      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
+      )
+
+      if persisted_characteristic
+        characteristic.instance_id = persisted_characteristic.instance_id
+      else
+        characteristic.instance_id = accessory.next_available_instance_id
+        persist_characteristic(characteristic)
+      end
 
-      new_characteristic
+      service.characteristics << characteristic
+
+      characteristic
     end
 
     private
 
-      def initialize(characteristic_name:, service:, value:)
+      def initialize(characteristic_name:, service:, subtype:, value:)
         @characteristic_name = characteristic_name.to_sym
         @service = service
+        @subtype = subtype
         @value = value || default_value
       end
 
-      attr_reader :service, :characteristic_name, :value
+      attr_reader :service, :characteristic_name, :value, :subtype
 
-      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
+      delegate :accessory, to: :service
 
       def template
         @template ||= CharacteristicTemplate.find_by(name: characteristic_name)
@@ -57,5 +66,24 @@ module RubyHome
           end
         end
       end
+
+      def persisted_characteristic
+        IdentifierCache.find_by(
+          accessory_id: service.accessory_id,
+          service_uuid: service.uuid,
+          uuid: template.uuid,
+          subtype: subtype
+        )
+      end
+
+      def persist_characteristic(characteristic)
+        IdentifierCache.create(
+          accessory_id: characteristic.accessory_id,
+          instance_id: characteristic.instance_id,
+          service_uuid: service.uuid,
+          uuid: characteristic.uuid,
+          subtype: subtype
+        )
+      end
   end
 end

data/lib/ruby_home/factories/service_factory.rb

@@ -1,24 +1,43 @@
 module RubyHome
   class ServiceFactory
-    def self.create(service_name, accessory: Accessory.new, **options)
+    def self.create(service_name, accessory: Accessory.new, subtype: 'default', **options)
       new(
         service_name: service_name,
         accessory: accessory,
+        subtype: subtype,
         **options
       ).create
     end
 
     def create
-      accessory.services << new_service
+      service = Service.new(
+        accessory: accessory,
+        description: template.description,
+        name: service_name,
+        uuid: template.uuid,
+      )
+
+      if persisted_service
+        service.instance_id = persisted_service.instance_id
+      else
+        service.instance_id = accessory.next_available_instance_id
+        persist_service(service)
+      end
 
-      create_accessory_information
-      create_required_characteristics
-      create_optional_characteristics
+      accessory.services << service
+
+      create_required_characteristics(service)
+      create_optional_characteristics(service)
+
+      unless accessory_information_factory?
+        create_accessory_information
+      end
 
-      new_service
+      service
     end
 
     private
+
       ACCESSORY_INFORMATION_OPTIONS = [
         :firmware_revision,
         :manufacturer,
@@ -27,40 +46,34 @@ module RubyHome
         :serial_number
       ].freeze
 
-      def initialize(service_name:, accessory:, **options)
+      def initialize(service_name:, accessory:, subtype:, **options)
         @service_name = service_name.to_sym
         @accessory = accessory
+        @subtype = subtype
         @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
+      attr_reader :service_name, :accessory, :subtype, :options
 
-      def create_required_characteristics
+      def create_required_characteristics(service)
         template.required_characteristics.each do |characteristic_template|
           characteristic_name = characteristic_template.name
           CharacteristicFactory.create(
             characteristic_template.name,
-            service: new_service,
+            service: service,
+            subtype: subtype,
             value: options[characteristic_name]
           )
         end
       end
 
-      def create_optional_characteristics
+      def create_optional_characteristics(service)
         optional_characteristic_templates.each do |characteristic_template|
           characteristic_name = characteristic_template.name
           CharacteristicFactory.create(
             characteristic_name,
-            service: new_service,
+            service: service,
+            subtype: subtype,
             value: options[characteristic_name]
           )
         end
@@ -72,18 +85,40 @@ module RubyHome
         end
       end
 
+      def accessory_information_factory?
+        service_name == :accessory_information
+      end
+
       def create_accessory_information
-        unless service_name == :accessory_information
-          ServiceFactory.create(
-            :accessory_information,
-            accessory: accessory,
-            **options.slice(*ACCESSORY_INFORMATION_OPTIONS)
-          )
-        end
+        return if accessory.has_accessory_information?
+
+        ServiceFactory.create(
+          :accessory_information,
+          accessory: accessory,
+          subtype: 'accessory_information',
+          **options.slice(*ACCESSORY_INFORMATION_OPTIONS)
+        )
       end
 
       def template
         @template ||= ServiceTemplate.find_by(name: service_name)
       end
+
+      def persisted_service
+        IdentifierCache.find_by(
+          accessory_id: accessory.id,
+          uuid: template.uuid,
+          subtype: subtype
+        )
+      end
+
+      def persist_service(service)
+        IdentifierCache.create(
+          accessory_id: accessory.id,
+          instance_id: service.instance_id,
+          uuid: template.uuid,
+          subtype: subtype
+        )
+      end
   end
 end

data/lib/ruby_home/hap/accessory.rb

@@ -1,3 +1,5 @@
+require_relative 'accessory_collection'
+
 module RubyHome
   class Accessory
     @@all = AccessoryCollection.new
@@ -26,6 +28,16 @@ module RubyHome
       (largest_instance_id || 0) + 1
     end
 
+    def has_accessory_information?
+      services.any? do |service|
+        service.name == :accessory_information
+      end
+    end
+
+    def contains_instance_id?(instance_id)
+      instance_ids.include?(instance_id)
+    end
+
     private
 
     def instance_ids
@@ -37,7 +49,7 @@ module RubyHome
     end
 
     def largest_instance_id
-      instance_ids.max
+      IdentifierCache.where(accessory_id: id).map(&:instance_id).max
     end
 
     def next_available_accessory_id

data/lib/ruby_home/hap/characteristic.rb

@@ -1,4 +1,6 @@
 module RubyHome
+  class DuplicateCharacteristicError < StandardError; end
+
   class Characteristic
     include Wisper::Publisher
 
@@ -30,7 +32,6 @@ module RubyHome
       @properties = properties
       @service = service
       @value = value
-      @instance_id = accessory.next_available_instance_id
     end
 
     attr_reader(
@@ -45,14 +46,15 @@ module RubyHome
       :instance_id
     )
 
-    def accessory
-      service.accessory
-    end
+    def instance_id=(new_id)
+      raise DuplicateCharacteristicError if accessory.contains_instance_id?(new_id)
 
-    def accessory_id
-      accessory.id
+      @instance_id = new_id
     end
 
+    delegate :accessory, to: :service
+    delegate :id, to: :accessory, prefix: true
+
     def service_iid
       service.instance_id
     end

data/lib/ruby_home/hap/hap_response.rb

@@ -10,10 +10,10 @@ module RubyHome
 
       def send_response(socket)
         if encryption_time?
-          response = String.new
+          response = StringIO.new
           super(response)
 
-          encrypted_response = encrypter.encrypt(response).join
+          encrypted_response = encrypter.encrypt(response.string).join
           cache[:accessory_to_controller_count] = encrypter.count
 
           _write_data(socket, encrypted_response)

data/lib/ruby_home/hap/service.rb

@@ -1,4 +1,6 @@
 module RubyHome
+  class DuplicateServiceError < StandardError; end
+
   class Service
     def initialize(accessory: , primary: false, hidden: false, name:, description:, uuid:)
       @accessory = accessory
@@ -8,7 +10,6 @@ module RubyHome
       @description = description
       @uuid = uuid
       @characteristics = []
-      @instance_id = accessory.next_available_instance_id
     end
 
     attr_reader(
@@ -22,6 +23,14 @@ module RubyHome
       :instance_id
     )
 
+    def instance_id=(new_id)
+      raise DuplicateServiceError if accessory.contains_instance_id?(new_id)
+
+      @instance_id = new_id
+    end
+
+    delegate :id, to: :accessory, prefix: true
+
     def characteristic(characteristic_name)
       characteristics.find do |characteristic|
         characteristic.name == characteristic_name

data/lib/ruby_home/http/application.rb

@@ -17,6 +17,7 @@ module RubyHome
 
             map('/accessories') { run AccessoriesController }
             map('/characteristics') { run CharacteristicsController }
+            map('/identify') { run IdentifyController }
             map('/pair-setup') { run PairSetupsController }
             map('/pair-verify') { run PairVerifiesController }
             map('/pairings') { run PairingsController }

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

@@ -0,0 +1,27 @@
+require_relative 'application_controller'
+
+module RubyHome
+  module HTTP
+    class IdentifyController < ApplicationController
+      post '/' do
+        if accessory_info.paired?
+          paired_accessory
+        else
+          unpaired_accessory
+        end
+      end
+
+      private
+
+        def paired_accessory
+          status 400
+          content_type 'application/hap+json'
+          JSON.generate({"status" => -70401})
+        end
+
+        def unpaired_accessory
+          halt 204
+        end
+    end
+  end
+end

data/lib/ruby_home/identifier_cache.rb

@@ -6,26 +6,59 @@ module RubyHome
 
     self.source = 'identifier_cache.yml'
 
-    def self.instance
-      @@_instance ||= persisted || create
+    def self.all
+      raw_items = read || []
+      raw_items.map do |raw_item|
+        new(**raw_item)
+      end
     end
 
     def self.reload
       @@_instance = nil
     end
 
-    def initialize(accessory_id: , instance_id: , uuid: )
+    def self.create(**attributes)
+      new(**attributes).save
+    end
+
+    def self.find_by(**attributes)
+      all.find do |identifier_cache|
+        attributes.all? do |key, value|
+          identifier_cache.send(key) == value
+        end
+      end
+    end
+
+    def self.where(**attributes)
+      all.select do |identifier_cache|
+        attributes.all? do |key, value|
+          identifier_cache.send(key) == value
+        end
+      end
+    end
+
+    def initialize(accessory_id:, instance_id:, service_uuid: nil, subtype: , uuid: )
       @accessory_id = accessory_id
       @instance_id = instance_id
+      @subtype = subtype
+      @service_uuid = service_uuid
       @uuid = uuid
     end
 
+    attr_reader :accessory_id, :instance_id, :service_uuid, :subtype, :uuid
+
     def persisted_attributes
-      {
-        accessory_id: accessory.id,
-        instance_id: instance.instance_id,
-        uuid: instance.uuid
-      }
+      existing_items = self.class.all
+      existing_items << self
+      existing_items.map do |identifier|
+        {
+          accessory_id: identifier.accessory_id,
+          instance_id: identifier.instance_id,
+          subtype: identifier.subtype,
+          service_uuid: identifier.service_uuid,
+          uuid: identifier.uuid,
+        }
+      end
     end
   end
 end

data/lib/ruby_home/version.rb

@@ -1,3 +1,3 @@
 module RubyHome
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/rubyhome.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dnssd', '~> 3.0'
   spec.add_dependency 'hkdf', '~> 0.3.0'
   spec.add_dependency 'nio4r', '~> 2.3', '>= 2.3.1'
-  spec.add_dependency 'oj', '~> 3.4'
+  spec.add_dependency 'oj', '3.7.0'
   spec.add_dependency 'rbnacl', '~> 5.0'
   spec.add_dependency 'rbnacl-libsodium', '~> 1.0', '>= 1.0.16'
   spec.add_dependency 'ruby_home-srp', '~> 1.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_home
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Karl Entwistle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-28 00:00:00.000000000 Z
+date: 2018-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -96,16 +96,16 @@ dependencies:
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: rbnacl
   requirement: !ruby/object:Gem::Requirement
@@ -328,6 +328,7 @@ files:
 - lib/ruby_home/http/controllers/accessories_controller.rb
 - lib/ruby_home/http/controllers/application_controller.rb
 - lib/ruby_home/http/controllers/characteristics_controller.rb
+- lib/ruby_home/http/controllers/identify_controller.rb
 - lib/ruby_home/http/controllers/pair_setups_controller.rb
 - lib/ruby_home/http/controllers/pair_verifies_controller.rb
 - lib/ruby_home/http/controllers/pairings_controller.rb
@@ -366,7 +367,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby HomeKit support