ruby_home 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca7f2c1b6c63b9083605bb967d75f4c56219825c03068f972f5d57dfbf227bd
-  data.tar.gz: f5a79a5a8c4e6b77302f736d22898be8bef2972c6fd7da06d3f4d7a51e66a186
+  metadata.gz: cf4e167745548086679350014c0375cf64eeb8733b9e6948ef0846ea36fd4f11
+  data.tar.gz: d8583372ac979eceafcd3c6a1cf36f8f40c32d5ab543ff28b7cf03e11e294d9b
 SHA512:
-  metadata.gz: 0bbff1f14b617fbbf00c8c1f3ed529e1d1fb7545f316f582a0b6ba196213f6e0560679fa7cb7a8de4499c74af74af00ec1c1b8ea4b4158c4816b2265a8c44988
-  data.tar.gz: 8a8ce2a35a678aaf7b4ecea34f8aedcfc40741d1afc4de8e06bd6eb0bf982685ae99c7ce6f85b778249c28f0c0da94a5aba5c37a3c8a5fb7820b22e3e6e02d13
+  metadata.gz: 84a6186ceb1d259b60bfe877ee3e12c78c4d9a25cb3fc9433605c45264a3bc174796650bb87e95795f8c39ea6dd365bc22425c6360636e07923f731cacaf185d
+  data.tar.gz: 19899a408055f4dd74993b03679cee97ea4d440b09beccbf6aaf4d034db727a96d09a73fc85ddb85f3fc4326704782ec861f9e006149a05c9e6c00c57123513d

data/.travis.yml

@@ -7,6 +7,7 @@ install:
   - 'bundle --version'
   - bundle
 rvm:
+  - 2.5.1
   - 2.5.0
   - ruby-head
 os:

data/lib/ruby_home/accessory_info.rb

@@ -50,7 +50,7 @@ module RubyHome
     end
 
     def set_password
-      self.password ||= '031-45-154'
+      self.password ||= Password.generate
     end
 
     def set_signature_key

data/lib/ruby_home/device_id.rb

@@ -1,5 +1,5 @@
 module RubyHome
-  class DeviceID
+  module DeviceID
     class << self
       DELIMITER = ':'
 

data/lib/ruby_home/factories/characteristic_factory.rb

@@ -1,12 +1,7 @@
 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)
@@ -44,9 +39,13 @@ module RubyHome
 
       def default_value
         DEFAULT_VALUES.fetch(characteristic_name.to_sym) do
-          case template.format
-          when 'bool'
-            false
+          klass = "RubyHome::#{template.format.classify}DefaultValue".safe_constantize || NullDefaultValue
+          default_value = klass.new(template).default
+
+          if default_value.nil?
+            raise "No default value available for characteristic: #{characteristic_name} of type: #{template.format}"
+          else
+            default_value
           end
         end
       end

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

@@ -0,0 +1,15 @@
+module RubyHome
+  class BaseValue
+    def initialize(template)
+      @template = template
+    end
+
+    def default
+      raise NotImplementedError
+    end
+
+    private
+
+      attr_reader :template
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative 'base_value'
+
+module RubyHome
+  class BoolDefaultValue < BaseValue
+    def default
+      false
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require_relative 'base_value'
+
+module RubyHome
+  class FloatDefaultValue < BaseValue
+    def default
+      minimum_value.to_f
+    end
+
+    private
+
+      def minimum_value
+        template.constraints.fetch('MinimumValue')
+      end
+  end
+end

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

@@ -0,0 +1,15 @@
+require_relative 'base_value'
+
+module RubyHome
+  class Int32DefaultValue < BaseValue
+    def default
+      minimum_value.to_i
+    end
+
+    private
+
+      def minimum_value
+        template.constraints.fetch('MinimumValue')
+      end
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative 'base_value'
+
+module RubyHome
+  class NullDefaultValue < BaseValue
+    def default
+      nil
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative 'base_value'
+
+module RubyHome
+  class StringDefaultValue < BaseValue
+    DEFAULT_VALUES = {
+      firmware_revision: '1.0',
+      hardware_revision: '1.0',
+      manufacturer: 'Default-Manufacturer',
+      model: 'Default-Model',
+      name: 'RubyHome',
+      serial_number: 'Default-SerialNumber',
+      version: '1.0',
+    }.freeze
+
+    def default
+      DEFAULT_VALUES[name]
+    end
+
+    private
+
+      def name
+        template.name
+      end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative 'base_value'
+
+module RubyHome
+  class Uint32DefaultValue < BaseValue
+    DEFAULT_VALUES = {
+      color_temperature: 50,
+      lock_management_auto_security_timeout: 0,
+    }.freeze
+
+    def default
+      DEFAULT_VALUES[name]
+    end
+
+    private
+
+      def name
+        template.name
+      end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative 'base_value'
+
+module RubyHome
+  class Uint8DefaultValue < BaseValue
+    def default
+      first_default_value.to_i
+    end
+
+    private
+
+      def first_default_value
+        valid_values.keys.first
+      end
+
+      def valid_values
+        template.constraints.fetch('ValidValues')
+      end
+  end
+end

data/lib/ruby_home/greeter.rb

@@ -0,0 +1,28 @@
+module RubyHome
+  module Greeter
+    class << self
+      def run
+        unless paired?
+          puts "Please enter this code with your HomeKit app on your iOS device to pair with RubyHome"
+          puts "                       "
+          puts "    ┌────────────┐     "
+          puts "    │ " + pin + " │    "
+          puts "    └────────────┘     "
+          puts "                       "
+        end
+      end
+
+      def pin
+        accessory_info.password
+      end
+
+      def paired?
+        accessory_info.paired?
+      end
+
+      def accessory_info
+        AccessoryInfo.instance
+      end
+    end
+  end
+end

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

@@ -3,46 +3,48 @@ require_relative 'application_controller'
 module RubyHome
   module HTTP
     class CharacteristicsController < ApplicationController
-      get '/' do
+      before do
         content_type 'application/hap+json'
+        require_session
+      end
 
-        if cache[:controller_to_accessory_key] && cache[:accessory_to_controller_key]
-          accessory_id, instance_id = params[:id].split('.')
-          characteristics = IdentifierCache.find_characteristics(
-            accessory_id: accessory_id.to_i,
-            instance_id: instance_id.to_i
-          )
-
-          CharacteristicValueSerializer.new(characteristics).serialized_json
-        else
-          status 401
-          JSON.generate({"status" => -70401})
-        end
+      get '/' do
+        CharacteristicValueSerializer.new(find_characteristics).serialized_json
       end
 
       put '/' do
-        content_type 'application/hap+json'
+        json_body.fetch('characteristics', []).each do |characteristic_params|
+          update_characteristics(characteristic_params)
+        end
+
+        status 204
+      end
+
+      private
 
-        if cache[:controller_to_accessory_key] && cache[:accessory_to_controller_key]
-          json_body.fetch('characteristics', []).each do |characteristic_params|
-            accessory_id = characteristic_params['aid']
-            instance_id = characteristic_params['iid']
-            characteristic = IdentifierCache.find_characteristics(
-              accessory_id: accessory_id.to_i,
-              instance_id: instance_id.to_i
-            ).first
-
-            if characteristic_params['value']
-              characteristic.value = characteristic_params['value']
-            end
+        def find_characteristics
+          params.fetch(:id, "").split(',').flat_map do |characteristic_params|
+            aid, iid = characteristic_params.split('.')
+            find_characteristic(aid: aid, iid: iid)
           end
+        end
 
-          status 204
-        else
-          status 401
-          JSON.generate({"status" => -70401})
+        def update_characteristics(characteristic_params)
+          characteristic = find_characteristic(**characteristic_params.symbolize_keys.slice(:aid, :iid))
+          if characteristic && characteristic_params['value']
+            characteristic.value = characteristic_params['value']
+          end
+        end
+
+        def find_characteristic(aid:, iid:)
+          IdentifierCache.find_characteristic(accessory_id: aid.to_i, instance_id: iid.to_i)
+        end
+
+        def require_session
+          unless cache[:controller_to_accessory_key] && cache[:accessory_to_controller_key]
+            halt 401, JSON.generate({"status" => -70401})
+          end
         end
-      end
     end
   end
 end

data/lib/ruby_home/identifier_cache.rb

@@ -19,8 +19,8 @@ module RubyHome
         services.flat_map(&:characteristics)
       end
 
-      def find_characteristics(attributes)
-        characteristics.select do |characteristic|
+      def find_characteristic(attributes)
+        characteristics.find do |characteristic|
           attributes.all? do |key, value|
             characteristic.send(key) == value
           end

data/lib/ruby_home/password.rb

@@ -0,0 +1,46 @@
+module RubyHome
+  module Password
+    class << self
+      DELIMITER = '-'
+      LENGTH = 8
+      INVALIDS = [
+        '00000000',
+        '11111111',
+        '22222222',
+        '33333333',
+        '44444444',
+        '55555555',
+        '66666666',
+        '77777777',
+        '88888888',
+        '99999999',
+        '12345678',
+        '87654321',
+      ]
+
+      # The Setup Code must conform to the format XXX-XX-XXX where each X is a
+      # 0-9 digit and dashes are required. For example, "101-48-005" (without
+      # quotes). The accessory must generate its SRP verifier with the full
+      # Setup Code, including dashes.
+
+      def generate
+        loop do
+          digits = random_digits(LENGTH)
+          break format(digits.to_s) unless INVALIDS.include?(digits)
+        end
+      end
+
+      def format(digits)
+        [
+          digits[0...3],
+          digits[3...5],
+          digits[5...8],
+        ].join(DELIMITER)
+      end
+
+      def random_digits(length)
+        Array.new(length) { rand(0..9) }.join
+      end
+    end
+  end
+end

data/lib/ruby_home/version.rb

@@ -1,3 +1,3 @@
 module RubyHome
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/ruby_home.rb

@@ -18,6 +18,7 @@ module RubyHome
       trap 'INT'  do shutdown end
       trap 'TERM' do shutdown end
 
+      greet
       start
     end
 
@@ -42,5 +43,9 @@ module RubyHome
     def http_server
       @@_http_server ||= RubyHome::HTTP::Application.new
     end
+
+    def greet
+      Greeter.run
+    end
   end
 end

data/rubyhome.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
     provided by manufacturers of smart home devices.
   DESCRIPTION
   spec.homepage      = 'https://github.com/karlentwistle/ruby_home'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_home
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Karl Entwistle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-02 00:00:00.000000000 Z
+date: 2018-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -304,8 +304,17 @@ files:
 - lib/ruby_home/dns/text_record.rb
 - lib/ruby_home/factories/accessory_factory.rb
 - lib/ruby_home/factories/characteristic_factory.rb
+- lib/ruby_home/factories/default_values/base_value.rb
+- lib/ruby_home/factories/default_values/bool_value.rb
+- lib/ruby_home/factories/default_values/float_value.rb
+- lib/ruby_home/factories/default_values/int32_value.rb
+- lib/ruby_home/factories/default_values/null_value.rb
+- lib/ruby_home/factories/default_values/string_value.rb
+- lib/ruby_home/factories/default_values/uint32_value.rb
+- lib/ruby_home/factories/default_values/uint8_value.rb
 - 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/characteristic.rb
 - lib/ruby_home/hap/crypto/chacha20poly1305.rb
@@ -333,6 +342,7 @@ files:
 - lib/ruby_home/http/services/start_srp_service.rb
 - lib/ruby_home/http/services/verify_srp_service.rb
 - lib/ruby_home/identifier_cache.rb
+- lib/ruby_home/password.rb
 - lib/ruby_home/rack/handler/hap_server.rb
 - lib/ruby_home/version.rb
 - lib/ruby_home/yaml_record.rb
@@ -340,7 +350,8 @@ files:
 - sbin/characteristic_generator.rb
 - sbin/service_generator.rb
 homepage: https://github.com/karlentwistle/ruby_home
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []