ruby_home 0.1.2 → 0.1.3

data/lib/ruby_home/yaml_record.rb

@@ -0,0 +1,440 @@
+# Original code https://github.com/nicotaing/yaml_record
+
+require 'active_support'
+require 'active_support/callbacks'
+require 'active_support/core_ext/hash'
+require 'securerandom'
+require 'yaml'
+
+module YamlRecord
+  module Adapters
+    class LocalStore
+
+      # Returns YAML File as ruby collection
+      #
+      # === Example:
+      #
+      #   @adapter.read("foo") => [{...}, {...}]
+      #
+      def read(source)
+        return false unless File.exists?(source)
+
+        YAML.load_file(source)
+      end
+
+      # Writes ruby collection as YAML File
+      #
+      # === Example:
+      #
+      #   @adapter.write("foo", [{...}, {...}]) => "<yaml data>"
+      #
+      def write(source, collection)
+        File.open(source, 'w') {|f| f.write(collection.to_yaml) }
+      end
+    end
+  end
+
+  class Base
+    attr_accessor :attributes, :is_created, :is_destroyed
+
+    include ActiveSupport::Callbacks
+    define_callbacks :before_save, :after_save, :before_destroy, :after_destroy, :before_validation, :before_create, :after_create
+
+    set_callback :before_create, :before, :set_id!
+
+    # Constructs a new YamlRecord instance based on specified attribute hash
+    #
+    # === Example:
+    #
+    #   class Post < YamlRecord::Base; properties :foo; end
+    #
+    #   Post.new(:foo  => "bar")
+    #
+    def initialize(attr_hash={})
+      attr_hash.symbolize_keys!
+      attr_hash.reverse_merge!(self.class.properties.inject({}) { |result, key| result[key] = nil; result })
+
+      self.attributes ||= {}
+      self.is_created = attr_hash.delete(:persisted) || false
+      attr_hash.each do |k,v|
+        self.send("#{k}=", v) # self.attributes[:media] = "foo"
+      end
+    end
+
+    # Accesses given attribute from YamlRecord instance
+    #
+    # === Example:
+    #
+    #   @post[:foo] => "bar"
+    #
+    def [](attribute)
+      self.attributes[attribute]
+    end
+
+    # Assign given attribute from YamlRecord instance with specified value
+    #
+    # === Example:
+    #
+    #   @post[:foo] = "baz"
+    #
+    def []=(attribute, value)
+      self.attributes[attribute] = value
+    end
+
+    # Saved YamlRecord instance to file
+    # Executes save and create callbacks
+    # Returns true if record saved; false otherwise
+    #
+    # === Example:
+    #
+    #   @post.save => true
+    #
+    def save
+      run_callbacks(:before_save)
+      run_callbacks(:before_create) unless self.is_created
+
+      existing_items = self.class.all
+      if self.new_record?
+        existing_items << self
+      else # update existing record
+        updated_item = existing_items.find { |item| item.id == self.id }
+        return false unless updated_item
+        updated_item.attributes = self.attributes
+      end
+
+      raw_data = existing_items ? existing_items.map { |item| item.persisted_attributes } : []
+      self.class.write_contents(raw_data) if self.valid?
+
+      run_callbacks(:after_create) unless self.is_created
+      run_callbacks(:after_save)
+      true
+    rescue IOError
+      false
+    end
+
+    # Update YamlRecord instance with specified attributes
+    # Returns true if record updated; false otherwise
+    #
+    # === Example:
+    #
+    #   @post.update_attributes(:foo  => "baz", :miso => "awesome") => true
+    #
+    def update_attributes(updated_attrs={})
+      updated_attrs.each { |k,v| self.send("#{k}=", v) }
+      self.save
+    end
+
+    # Returns array of instance attributes names; An attribute is a value stored for this record (persisted or not)
+    #
+    # === Example:
+    #
+    #   @post.column_names => ["foo", "miso"]
+    #
+    def column_names
+      self.attributes.keys.map(&:to_s)
+    end
+
+    # Returns hash of attributes to be persisted to file.
+    # A persisted attribute is a value stored in the file (specified with the properties declaration)
+    #
+    # === Example:
+    #
+    #   class Post < YamlRecord::Base; properties :foo, :miso; end
+    #   @post = Post.create(:foo => "bar", :miso => "great")
+    #   @post.persisted_attributes => { :id => "a1b2c3", :foo => "bar", :miso => "great" }
+    #
+    def persisted_attributes
+      self.attributes.slice(*self.class.properties).reject { |k, v| v.nil? }
+    end
+
+    # Returns true if YamlRecord instance hasn't persisted; false otherwise
+    #
+    # === Example:
+    #
+    #   @post = Post.new(:foo => "bar", :miso => "great")
+    #   @post.new_record?  =>  true
+    #   @post.save  => true
+    #   @post.new_record?  =>  false
+    #
+    def new_record?
+      !self.is_created
+    end
+
+    # Returns true if YamlRecord instance has been destroyed; false otherwise
+    #
+    # === Example:
+    #
+    #   @post = Post.new(:foo => "bar", :miso => "great")
+    #   @post.destroyed?  =>  false
+    #   @post.save
+    #   @post.destroy  => true
+    #   @post.destroyed?  =>  true
+    #
+    def destroyed?
+      self.is_destroyed
+    end
+
+    # Remove a persisted YamlRecord object
+    # Returns true if destroyed; false otherwise
+    #
+    # === Example:
+    #
+    #   @post = Post.create(:foo => "bar", :miso => "great")
+    #   Post.all.size => 1
+    #   @post.destroy  => true
+    #   Post.all.size => 0
+    #
+    def destroy
+      run_callbacks(:before_destroy)
+      new_data = self.class.all.reject { |item| item.persisted_attributes == self.persisted_attributes }.map { |item| item.persisted_attributes }
+      self.class.write_contents(new_data)
+      self.is_destroyed = true
+      run_callbacks(:after_destroy)
+      true
+    rescue IOError
+      false
+    end
+
+    # Execute validations for instance
+    # Returns true if record is valid; false otherwise
+    # TODO Implement validation
+    #
+    # === Example:
+    #
+    #   @post.valid? => true
+    #
+    def valid?
+      true
+    end
+
+    # Returns errors messages if record isn't valid; empty array otherwise
+    # TODO Implement validation
+    #
+    # === Example:
+    #
+    #   @post.errors => ["Foo can't be blank"]
+    #
+    def errors
+      []
+    end
+
+    # Returns YamlRecord Instance
+    # Complies with ActiveModel api
+    #
+    # === Example:
+    #
+    #   @post.to_model => @post
+    #
+    def to_model
+      self
+    end
+
+    # Returns the instance of a record as a parameter
+    # By default return an id
+    #
+    # === Example:
+    #
+    #   @post.to_param => <id>
+    #
+    def to_param
+      self.id
+    end
+
+    # Reload YamlRecord instance attributes from file
+    #
+    # === Example:
+    #
+    #   @post = Post.create(:foo => "bar", :miso => "great")
+    #   @post.foo = "bazz"
+    #   @post.reload
+    #   @post.foo => "bar"
+    #
+    def reload
+      record = self.class.find(self.id)
+      self.attributes = record.attributes
+      record
+    end
+
+    # Find YamlRecord instance given attribute name and expected value
+    # Supports checking inclusion for array based values
+    # Returns instance if found; false otherwise
+    #
+    # === Example:
+    #
+    #   Post.find_by_attribute(:foo, "bar")         => @post
+    #   Post.find_by_attribute(:some_list, "item")  => @post
+    #
+    def self.find_by_attribute(attribute, expected_value)
+      self.all.find do |record|
+        value = record.send(attribute) if record.respond_to?(attribute)
+        value.is_a?(Array) ?
+          value.include?(expected_value) :
+          value == expected_value
+      end
+    end
+
+    class << self;
+
+      # Find YamlRecord instance given id
+      # Returns instance if found; false otherwise
+      #
+      # === Example:
+      #
+      #   Post.find_by_id("a1b2c3")  => @post
+      #
+      def find_by_id(value)
+        self.find_by_attribute(:id, value)
+      end
+      alias :find :find_by_id
+    end
+
+    # Returns collection of all YamlRecord instances
+    # Caches results during request
+    #
+    # === Example:
+    #
+    #   Post.all  => [@post1, @post2, ...]
+    #   Post.all(true) => (...force reload...)
+    #
+    def self.all
+      raw_items = self.adapter.read(self.source) || []
+      raw_items.map { |item| self.new(item.merge(:persisted => true)) }
+    end
+
+    # Find last YamlRecord instance given a limit
+    # Returns an array of instances if found; empty otherwise
+    #
+    # === Example:
+    #
+    #   Post.last  => @post6
+    #   Post.last(3) => [@p4, @p5, @p6]
+    #
+    def self.last(limit=1)
+      limit == 1 ? self.all.last : self.all.last(limit)
+    end
+
+    # Find first YamlRecord instance given a limit
+    # Returns an array of instances if found; empty otherwise
+    #
+    # === Example:
+    #
+    #   Post.first  => @post
+    #   Post.first(3) => [@p1, @p2, @p3]
+    #
+    def self.first(limit=1)
+      limit == 1 ? self.all.first : self.all.first(limit)
+    end
+
+    # Initializes YamlRecord instance given an attribute hash and saves afterwards
+    # Returns instance if successfully saved; false otherwise
+    #
+    # === Example:
+    #
+    #   Post.create(:foo => "bar", :miso => "great")  => @post
+    #
+    def self.create(attributes={})
+      @fs = self.new(attributes)
+      if @fs.save == true
+        @fs.is_created = true
+        @fs
+      else
+        false
+      end
+    end
+
+    # Declares persisted attributes for YamlRecord class
+    #
+    # === Example:
+    #
+    #   class Post < YamlRecord::Base; properties :foo, :miso; end
+    #   Post.create(:foo => "bar", :miso => "great")  => @post
+    #
+    def self.properties(*names)
+      @_properties ||= []
+      if names.size == 0 # getter
+        @_properties
+      elsif names.size > 0 # setter
+        names = names | [:id]
+        setup_properties!(*names)
+        @_properties += names
+      end
+    end
+
+    # Declares or retrieves adapter for Yaml storage
+    # Returns an instance of an adapter
+    #
+    # === Example:
+    #
+    #   class Post < YamlRecord::Base
+    #     adapter :redis, @redis #  => YamlRecord::Adapters::RedisAdapter
+    #   end
+    #
+    def self.adapter(kind=nil, *options)
+      kind.nil? ? @_adapter_kind ||= :local : @_adapter_kind = kind
+      @_adapter ||= eval("YamlRecord::Adapters::#{@_adapter_kind.to_s.capitalize}Store").new(*options)
+    end
+
+    # Declares source file for YamlRecord class
+    #
+    # === Example:
+    #
+    #   class Post < YamlRecord::Base
+    #     source "path/to/yaml/file"
+    #   end
+    #
+    def self.source(file=nil)
+      file ? @file = (file.to_s) : @file
+    end
+
+    # Overrides equality to match if matching ids
+    #
+    def ==(comparison_record)
+      self.id == comparison_record.id
+    end
+
+    protected
+
+    # Validates each persisted attributes
+    # TODO Implement validation
+    #
+    def self.validates_each(*args, &block)
+      true
+    end
+
+    # Write raw yaml data to file
+    # Protected method, not called during usage
+    #
+    # === Example:
+    #
+    #   Post.write_content([{ :foo => "bar"}, { :foo => "baz"}, ...]) # writes to source file
+    #
+    def self.write_contents(raw_data)
+      self.adapter.write(self.source, raw_data)
+      @records = nil
+    end
+
+    # Creates reader and writer methods for each persisted attribute
+    # Protected method, not called during usage
+    #
+    # === Example:
+    #
+    #   Post.setup_properties!(:foo)
+    #   @post.foo = "baz"
+    #   @post.foo => "baz"
+    #
+    def self.setup_properties!(*names)
+      names.each do |name|
+        define_method(name) { self[name.to_sym] }
+        define_method("#{name}=") { |val| self[name.to_sym] = val  }
+      end
+    end
+
+    # Assign YamlRecord a unique id if not set
+    # Invoke before create of an instance
+    # Protected method, not called during usage
+    #
+    def set_id!
+      self.id = SecureRandom.hex(15)
+    end
+  end
+end

data/lib/ruby_home.rb

@@ -1,7 +1,46 @@
-require_relative 'ruby_home/version'
-require_relative 'ruby_home/broadcast'
-require_relative 'ruby_home/identifier_cache'
-Dir[File.dirname(__FILE__) + '/ruby_home/factories/*.rb'].each { |file| require file }
-Dir[File.dirname(__FILE__) + '/ruby_home/hap/crypto/*.rb'].each { |file| require file }
+require 'bindata'
+require 'dnssd'
+require 'hkdf'
+require 'oj'
+require 'rack'
+require 'rbnacl/libsodium'
+require 'request_store'
+require 'ruby_home-srp'
+require 'sinatra/base'
+require 'webrick'
+require 'wisper'
 
-module RubyHome; end
+module RubyHome
+  Dir[File.dirname(__FILE__) + '/ruby_home/**/*.rb'].each { |file| require file }
+
+  class << self
+    def run
+      trap 'INT'  do shutdown end
+      trap 'TERM' do shutdown end
+
+      start
+    end
+
+    def start
+      threads << Thread.start { dns_service.register }
+      threads << Thread.start { http_server.run }
+      threads.each(&:join)
+    end
+
+    def threads
+      @@threads ||= []
+    end
+
+    def shutdown
+      threads.each(&:exit)
+    end
+
+    def dns_service
+      @_dns_service ||= RubyHome::DNS::Service.new(http_server.port)
+    end
+
+    def http_server
+      @_http_server ||= RubyHome::HTTP::Application.new
+    end
+  end
+end

data/rubyhome.gemspec

@@ -24,21 +24,21 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport', '~> 5.0'
   spec.add_dependency 'bindata', '~> 2.4', '>= 2.4.3'
   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 'request_store', '~> 1.4', '>= 1.4.1'
   spec.add_dependency 'ruby_home-srp', '~> 1.2'
-  spec.add_dependency 'sinatra', '2.0.1'
+  spec.add_dependency 'sinatra', '2.0.3'
   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 'rack-test', '~> 1.1.0'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby_home
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Karl Entwistle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-09-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bindata
   requirement: !ruby/object:Gem::Requirement
@@ -44,26 +58,6 @@ dependencies:
     - - "~>"
       - !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
@@ -126,6 +120,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.16
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: ruby_home-srp
   requirement: !ruby/object:Gem::Requirement
@@ -146,14 +160,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: wisper
   requirement: !ruby/object:Gem::Requirement
@@ -174,26 +188,6 @@ dependencies:
     - - ">="
       - !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
@@ -242,14 +236,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -303,7 +297,6 @@ files:
 - 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
@@ -317,13 +310,12 @@ files:
 - lib/ruby_home/hap/characteristic.rb
 - lib/ruby_home/hap/crypto/chacha20poly1305.rb
 - lib/ruby_home/hap/crypto/hkdf.rb
-- lib/ruby_home/hap/hex_pad.rb
 - lib/ruby_home/hap/http_decryption.rb
 - lib/ruby_home/hap/http_encryption.rb
 - lib/ruby_home/hap/service.rb
 - lib/ruby_home/hap/tlv.rb
+- lib/ruby_home/hex_helper.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
@@ -338,9 +330,12 @@ files:
 - 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/http/services/start_srp_service.rb
+- lib/ruby_home/http/services/verify_srp_service.rb
 - lib/ruby_home/identifier_cache.rb
 - lib/ruby_home/rack/handler/hap_server.rb
 - lib/ruby_home/version.rb
+- lib/ruby_home/yaml_record.rb
 - rubyhome.gemspec
 - sbin/characteristic_generator.rb
 - sbin/service_generator.rb