ruby_home 0.1.0

data/lib/ruby_home/rack/handler/hap_server.rb

@@ -0,0 +1,26 @@
+require 'webrick'
+require_relative '../../http/hap_server'
+
+module RubyHome
+  module Rack
+    module Handler
+      class HAPServer < ::Rack::Handler::WEBrick
+        def self.run(app, options={})
+          environment  = ENV['RACK_ENV'] || 'development'
+          default_host = environment == 'development' ? 'localhost' : nil
+
+          options[:BindAddress] = options.delete(:Host) || default_host
+          options[:Port] ||= 8080
+          unless ENV['DEBUG']
+            options[:Logger] = WEBrick::Log.new("/dev/null")
+            options[:AccessLog] = []
+          end
+          @server = HTTP::HAPServer.new(options)
+          @server.mount '/', Handler::HAPServer, app
+          yield @server  if block_given?
+          @server.start
+        end
+      end
+    end
+  end
+end

data/lib/ruby_home/tlv.rb

@@ -0,0 +1,83 @@
+Dir[File.dirname(__FILE__) + '/tlv/*.rb'].each {|file| require file }
+
+module RubyHome
+  module TLV
+    extend self
+
+    TLV = Struct.new(:type, :name, :handler)
+    TLVs = [
+      TLV.new('00', 'kTLVType_Method', Int),
+      TLV.new('01', 'kTLVType_Identifier', Utf8),
+      TLV.new('02', 'kTLVType_Salt', Bytes),
+      TLV.new('03', 'kTLVType_PublicKey', Bytes),
+      TLV.new('04', 'kTLVType_Proof', Bytes),
+      TLV.new('05', 'kTLVType_EncryptedData', Bytes),
+      TLV.new('06', 'kTLVType_State', Int),
+      TLV.new('07', 'kTLVType_Error', Int),
+      TLV.new('08', 'kTLVType_RetryDelay', Int),
+      TLV.new('09', 'kTLVType_Certificate', Bytes),
+      TLV.new('0a', 'kTLVType_Signature', Bytes),
+      TLV.new('0b', 'kTLVType_Permissions', Int),
+      TLV.new('0c', 'kTLVType_FragmentData', Bytes),
+      TLV.new('0d', 'kTLVType_FragmentLast', Bytes),
+    ].freeze
+
+    def pack(hash)
+      data = ''
+
+      pack_objects(hash).each do |type, value|
+        value.chars.each_slice(510).map(&:join).each do |value_slice|
+          length = Int.pack([value_slice].pack('H*').length)
+
+          data << type
+          data << length
+          data << value_slice
+        end
+      end
+
+      [data].pack('H*')
+    end
+
+    def pack_objects(objects)
+      objects.each_with_object({}) do |(unpacked_key, unpacked_value), memo|
+        tlv_value = TLVs.find { |tlv| tlv.name == unpacked_key }
+        packed_key = tlv_value.type
+        packed_value = tlv_value.handler.pack(unpacked_value)
+        memo[packed_key] = packed_value
+      end
+    end
+
+    def unpack(input)
+      data = input.unpack('H*')[0]
+      objects = {}
+      scanner_index = 0
+
+      while scanner_index < data.length do
+        type = data[scanner_index, 2]
+        scanner_index += 2
+
+        byte_length = Int.unpack(data[scanner_index, 2]) * 2
+        scanner_index += 2
+
+        newData = data[scanner_index, byte_length]
+        if objects[type]
+          objects[type] << newData
+        else
+          objects[type] = newData
+        end
+        scanner_index += byte_length
+      end
+
+      unpack_objects(objects)
+    end
+
+    def unpack_objects(objects)
+      objects.each_with_object({}) do |(packed_key, packed_value), memo|
+        tlv_value = TLVs.find { |tlv| tlv.type == packed_key }
+        unpacked_key = tlv_value.name
+        unpacked_value = tlv_value.handler.unpack(packed_value)
+        memo[unpacked_key] = unpacked_value
+      end
+    end
+  end
+end

data/lib/ruby_home/tlv/bytes.rb

@@ -0,0 +1,19 @@
+module RubyHome
+  module TLV
+    module Bytes
+      extend self
+
+      def pack(input)
+        if input.length.odd?
+          input.insert(0, '0')
+        else
+          input
+        end
+      end
+
+      def unpack(input)
+        input
+      end
+    end
+  end
+end

data/lib/ruby_home/tlv/int.rb

@@ -0,0 +1,15 @@
+module RubyHome
+  module TLV
+    module Int
+      extend self
+
+      def pack(input)
+        [input].pack('C*').unpack1('H*')
+      end
+
+      def unpack(input)
+        [input].pack('H*').unpack1('C*')
+      end
+    end
+  end
+end

data/lib/ruby_home/tlv/utf8.rb

@@ -0,0 +1,18 @@
+module RubyHome
+  module TLV
+    module Utf8
+      extend self
+
+      def pack(input)
+        input.bytes.map { |b| b.to_s(16) }.join
+      end
+
+      def unpack(input)
+        [input]
+          .pack('H*')
+          .force_encoding('utf-8')
+          .encode('utf-8')
+      end
+    end
+  end
+end

data/lib/ruby_home/version.rb

@@ -0,0 +1,3 @@
+module RubyHome
+  VERSION = '0.1.0'
+end

data/rubyhome.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_home/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_home'
+  spec.version       = RubyHome::VERSION
+  spec.authors       = ['Karl Entwistle']
+  spec.email         = ['karl@entwistle.com']
+  spec.summary       = 'Ruby HomeKit support'
+  spec.description   = <<~DESCRIPTION
+    RubyHome is a lightweight service you can run on your home network that
+    emulates the iOS HomeKit API. It supports community contributed plugins, which
+    are modules that provide a bridge from HomeKit to various 3rd-party APIs
+    provided by manufacturers of smart home devices.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/karlentwistle/ruby_home'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dnssd', '~> 3.0'
+  spec.add_dependency 'ed25519', '~> 1.2', '>= 1.2.3'
+  spec.add_dependency 'hkdf', '~> 0.3.0'
+  spec.add_dependency 'oj', '~> 3.4'
+  spec.add_dependency 'rbnacl', '~> 5.0'
+  spec.add_dependency 'rbnacl-libsodium', '~> 1.0', '>= 1.0.16'
+  spec.add_dependency 'ruby_home-srp', '~> 1.1.1'
+  spec.add_dependency 'sinatra', '~> 2.0'
+  spec.add_dependency 'wisper', '~> 1.6', '>= 1.6.1'
+  spec.add_dependency 'x25519', '~> 1.0', '>= 1.0.5'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', '~> 10.0'
+  spec.add_development_dependency 'plist', '~> 3.4'
+  spec.add_development_dependency 'rack-test', '~> 1.0.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/sbin/characteristic_generator.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+require 'byebug'
+require 'plist'
+require 'yaml'
+
+module RubyHome
+  class CharacteristicGenerator
+    class << self
+      def run
+        convert_binary_plist
+        File.open(file_path, 'w') do |file|
+          file.write generate_characteristics.to_yaml
+        end
+      end
+
+      def generate_characteristics
+        parsed_xml['Characteristics'].map do |characteristics_xml|
+          new(characteristics_xml).generate_characteristic_hash
+        end
+      end
+
+      def convert_binary_plist
+        system([
+          'plutil -convert xml1 -o',
+          '/tmp/Accessory.xml',
+          "\'/Applications/Utilities/HomeKit\ Accessory\ Simulator.app/Contents/Frameworks/HAPAccessoryKit.framework/Versions/A/Resources/default.metadata.plist\'"
+        ].join(' '))
+      end
+
+      def parsed_xml
+        Plist.parse_xml('/tmp/Accessory.xml')
+      end
+
+      def file_path
+        File.dirname(__FILE__) + '/../lib/ruby_home/config/characteristics.yml'
+      end
+    end
+
+    def initialize(xml)
+      @constraints = xml["Constraints"]
+      @format = xml["Format"]
+      @name = xml["Name"]
+      @permissions = xml["Permissions"]
+      @properties = xml["Properties"]
+      @uuid = xml["UUID"]
+      @unit = xml["Unit"]
+    end
+
+    def generate_characteristic_hash
+      {
+        name: sanitized_name.to_sym,
+        description: name,
+        uuid: uuid,
+        format: format,
+        unit: sanitized_unit,
+        permissions: permissions,
+        properties: properties,
+        constraints: constraints,
+      }
+    end
+
+    private
+
+      def sanitized_name
+        name.downcase.gsub(' ', '_').gsub('.', '_')
+      end
+
+      def sanitized_unit
+        if unit
+          "\"#{unit}\""
+        else
+          "nil"
+        end
+      end
+
+      private
+
+      attr_reader :constraints, :format, :name, :permissions, :properties, :uuid, :unit
+  end
+end
+
+RubyHome::CharacteristicGenerator.run

data/sbin/service_generator.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'byebug'
+require 'plist'
+require 'yaml'
+
+module RubyHome
+  class ServiceGenerator
+    class << self
+      def run
+        convert_binary_plist
+        File.open(file_path, 'w') do |file|
+          file.write generate_services.to_yaml
+        end
+      end
+
+      def generate_services
+        parsed_xml['Services'].map do |services_xml|
+          new(services_xml).generate_service_hash
+        end
+      end
+
+      def convert_binary_plist
+        system([
+          'plutil -convert xml1 -o',
+          '/tmp/Accessory.xml',
+          "\'/Applications/Utilities/HomeKit\ Accessory\ Simulator.app/Contents/Frameworks/HAPAccessoryKit.framework/Versions/A/Resources/default.metadata.plist\'"
+        ].join(' '))
+      end
+
+      def parsed_xml
+        Plist.parse_xml('/tmp/Accessory.xml')
+      end
+
+      def file_path
+        File.dirname(__FILE__) + '/../lib/ruby_home/config/services.yml'
+      end
+    end
+
+    def initialize(xml)
+      @name = xml["Name"]
+      @optional_characteristics = xml["OptionalCharacteristics"]
+      @required_characteristics = xml["RequiredCharacteristics"]
+      @uuid = xml["UUID"]
+    end
+
+    def generate_service_hash
+      {
+        name: sanitized_name.to_sym,
+        description: name,
+        uuid: uuid,
+        optional_characteristics_uuids: optional_characteristics,
+        required_characteristics_uuids: required_characteristics,
+      }
+    end
+
+    private
+
+      def sanitized_name
+        name.downcase.gsub(' ', '_')
+      end
+
+      private
+
+      attr_reader :name, :optional_characteristics, :required_characteristics, :uuid
+  end
+end
+
+RubyHome::ServiceGenerator.run

metadata

@@ -0,0 +1,352 @@
+--- !ruby/object:Gem::Specification
+name: ruby_home
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karl Entwistle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dnssd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: hkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl-libsodium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.16
+- !ruby/object:Gem::Dependency
+  name: ruby_home-srp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: x25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  RubyHome is a lightweight service you can run on your home network that
+  emulates the iOS HomeKit API. It supports community contributed plugins, which
+  are modules that provide a bridge from HomeKit to various 3rd-party APIs
+  provided by manufacturers of smart home devices.
+email:
+- karl@entwistle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/rubyhome
+- bin/setup
+- lib/ruby_home.rb
+- lib/ruby_home/accessory_info.rb
+- lib/ruby_home/broadcast.rb
+- lib/ruby_home/config/characteristics.yml
+- lib/ruby_home/config/services.yml
+- lib/ruby_home/device_id.rb
+- lib/ruby_home/dns/service.rb
+- 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/templates/characteristic_template.rb
+- lib/ruby_home/factories/templates/service_template.rb
+- lib/ruby_home/hap/accessory.rb
+- lib/ruby_home/hap/characteristic.rb
+- lib/ruby_home/hap/hex_pad.rb
+- lib/ruby_home/hap/hkdf_encryption.rb
+- lib/ruby_home/hap/http_decryption.rb
+- lib/ruby_home/hap/http_encryption.rb
+- lib/ruby_home/hap/service.rb
+- lib/ruby_home/http/application.rb
+- lib/ruby_home/http/cache.rb
+- 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/pair_setups_controller.rb
+- lib/ruby_home/http/controllers/pair_verifies_controller.rb
+- lib/ruby_home/http/controllers/pairings_controller.rb
+- lib/ruby_home/http/hap_request.rb
+- lib/ruby_home/http/hap_response.rb
+- lib/ruby_home/http/hap_server.rb
+- lib/ruby_home/http/serializers/accessory_serializer.rb
+- lib/ruby_home/http/serializers/characteristic_serializer.rb
+- lib/ruby_home/http/serializers/characteristic_value_serializer.rb
+- lib/ruby_home/http/serializers/object_serializer.rb
+- lib/ruby_home/http/serializers/service_serializer.rb
+- lib/ruby_home/identifier_cache.rb
+- lib/ruby_home/rack/handler/hap_server.rb
+- lib/ruby_home/tlv.rb
+- lib/ruby_home/tlv/bytes.rb
+- lib/ruby_home/tlv/int.rb
+- lib/ruby_home/tlv/utf8.rb
+- lib/ruby_home/version.rb
+- rubyhome.gemspec
+- sbin/characteristic_generator.rb
+- sbin/service_generator.rb
+homepage: https://github.com/karlentwistle/ruby_home
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Ruby HomeKit support
+test_files: []