ruby_home 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c60d5366dfa8a7f6b485c54212fb6559f2542b7a
-  data.tar.gz: f5a297ad7566a3a516be681bba3a16bbc94d204b
+SHA256:
+  metadata.gz: f5c2472175346b490fafbd175e114227a9796e4304c472d5c3e5f4eb8734c76a
+  data.tar.gz: 6930dac62338255403695f5369397daa26fd0c7853d9ab2784a7de084f092655
 SHA512:
-  metadata.gz: 66b2f8f148791dcacf5d2207ee69cafcf17a3b5fff85f69c1e682f403c6a7f14a6a4f729a57831595e01efb65865b74b91ad7f837c67417edd8fe42200b04606
-  data.tar.gz: 5c5b99686275cea3696558be5034bc0f2f692323a500c63644ede9c990e7a56784006a3fe2d07155c4946d412a1c796e7f0bf2a059b16de9b14622dfda6952ea
+  metadata.gz: 18ebd83f029b7a1545d2f28331ca38be78ffe5a392026e598b93732b936dc5712b43e7b7b1c24088864709cc4fa45d6189bf3c9793220303d02b1fb86c336079
+  data.tar.gz: cd1227d1e26ef5dd91c6fc91c1ce526cc8b8e257916161a8cc72814e68f5be522b33bdd8f4db3d46a5511ce98534261917c640dfe75e6cc9e23df2cc19efe391

data/.gitignore

@@ -11,3 +11,4 @@
 Gemfile.lock
 accessory_info.yml
 identifier_cache.yml
+.ruby-version

data/.travis.yml

@@ -12,7 +12,7 @@ install:
   - 'bundle --version'
   - bundle
 rvm:
-  - 2.4
+  - 2.4.1
   - 2.5
   - 2.6
   - ruby-head

data/README.md

@@ -58,6 +58,26 @@ end
 RubyHome.run
 ```
 
+## Configuration
+
+The configuration options can be set by using the `configure` helper
+
+```ruby
+RubyHome.configure do |c|
+  c.discovery_name = 'My Home'
+end
+```
+
+The following is the full list of available configuration options:
+
+| Method | Description | Default | Example | Type |
+|---|---|---|---|---|
+| `discovery_name` |  The user-visible name of the accessory | `"RubyHome"` | `"My Home"` | String |
+| `model_name` |  The model name of the accessory | `"RubyHome"` | `"Device1,1"` | String |
+| `password` | Used for pairing must conform to the format XXX-XX-XXX where each X is a 0-9 digit and dashes are required | Randomly generated | `"101-48-005"` | String |
+| `host` | The hostname or IP address of the interface to listen on | `"0.0.0.0"` | `"192.168.0.2"` | String  |
+| `port` | The port that should be used when starting the built-in web server | `4567` | `8080` | Integer |
+
 ## Customization
 
 RubyHome tries to provide sane defaults for all services. Customization of any of the options is possible.

data/lib/ruby_home.rb

@@ -18,6 +18,16 @@ module RubyHome
   Dir[File.dirname(__FILE__) + '/ruby_home/**/*.rb'].each { |file| require file }
 
   class << self
+    def configuration
+      @_configuration ||= Configuration.new
+    end
+
+    alias_method :config, :configuration
+
+    def configure
+      yield configuration
+    end
+
     def run
       trap 'INT'  do shutdown end
       trap 'TERM' do shutdown end
@@ -43,11 +53,11 @@ module RubyHome
     end
 
     def dns_service
-      @_dns_service ||= DNS::Service.new(hap_server.port)
+      @_dns_service ||= DNS::Service.new(configuration: configuration)
     end
 
     def hap_server
-      @_hap_server ||= HAP::Server.new('0.0.0.0', 4567)
+      @_hap_server ||= HAP::Server.new(configuration.host, configuration.port)
     end
 
     def greet

data/lib/ruby_home/accessory_info.rb

@@ -31,6 +31,11 @@ module RubyHome
       @password ||= Password.generate
     end
 
+    def password=(new_password)
+      @password = new_password
+      save
+    end
+
     def device_id
       @device_id ||= DeviceID.generate
     end

data/lib/ruby_home/configuration.rb

@@ -0,0 +1,35 @@
+module RubyHome
+  class Configuration
+    extend Forwardable
+
+    def initialize(accessory_info = AccessoryInfo.instance)
+      @accessory_info = accessory_info
+    end
+
+    DEFAULT_NAME = -'RubyHome'
+    DEFAULT_HOST = -'0.0.0.0'
+    DEFAULT_PORT = 4567
+    DEFAULT_MODEL_NAME = DEFAULT_NAME
+    DEFAULT_DISCOVERY_NAME = DEFAULT_NAME
+
+    def discovery_name
+      @discovery_name || DEFAULT_DISCOVERY_NAME
+    end
+
+    def model_name
+      @model_name || DEFAULT_MODEL_NAME
+    end
+
+    def port
+      @port || DEFAULT_PORT
+    end
+
+    def host
+      @host || DEFAULT_HOST
+    end
+
+    attr_writer :discovery_name, :model_name, :host, :port
+
+    def_delegators :@accessory_info, :password, :password=
+  end
+end

data/lib/ruby_home/dns/service.rb

@@ -1,8 +1,8 @@
 module RubyHome
   module DNS
     class Service
-      def initialize(port)
-        @port = port
+      def initialize(configuration: )
+        @configuration = configuration
       end
 
       def update
@@ -15,24 +15,38 @@ module RubyHome
 
       private
 
+      attr_reader :configuration
+
       def dnssd_service
         @_dnssd_service ||= begin
-          DNSSD::Service.register(name, type, nil, port, nil, text_record)
+          DNSSD::Service.register(name, type, nil, port, host, text_record)
         end
       end
 
       def name
-        'RubyHome'
+        configuration.discovery_name
       end
 
       def type
-        '_hap._tcp'
+        -'_hap._tcp'
+      end
+
+      def port
+        configuration.port
       end
 
-      attr_reader :port
+      def host
+        return nil if configuration.host == Configuration::DEFAULT_HOST
+
+        configuration.host
+      end
 
       def text_record
-        TextRecord.new(accessory_info: AccessoryInfo.instance)
+        TextRecord.new(accessory_info: accessory_info, configuration: configuration)
+      end
+
+      def accessory_info
+        AccessoryInfo.instance
       end
     end
   end

data/lib/ruby_home/dns/text_record.rb

@@ -1,13 +1,14 @@
 module RubyHome
   class TextRecord < DNSSD::TextRecord
-    def initialize(accessory_info:)
+    def initialize(accessory_info:, configuration:)
+      @configuration = configuration
       @accessory_info = accessory_info
       super(to_hash)
     end
 
     private
 
-    attr_reader :accessory_info
+    attr_reader :accessory_info, :configuration
 
     def to_hash
       {
@@ -74,7 +75,7 @@ module RubyHome
     # Model name of the accessory (e.g. "Device1,1"). Required.
 
     def model_name
-      'RubyHome'
+      configuration.model_name
     end
 
     # Protocol version string <major>.<minor> (e.g. "1.0"). Required if value is

data/lib/ruby_home/version.rb

@@ -1,3 +1,3 @@
 module RubyHome
-  VERSION = '0.1.21'
+  VERSION = '0.1.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_home
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Karl Entwistle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -248,7 +248,6 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -265,6 +264,7 @@ files:
 - lib/ruby_home/characteristic_collection.rb
 - lib/ruby_home/config/characteristics.yml
 - lib/ruby_home/config/services.yml
+- lib/ruby_home/configuration.rb
 - lib/ruby_home/device_id.rb
 - lib/ruby_home/dns/service.rb
 - lib/ruby_home/dns/text_record.rb
@@ -339,8 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Ruby HomeKit support

data/.ruby-version

@@ -1 +0,0 @@
-2.4.0