fritzbox-smarthome 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8e0195a6e63ff7455d046a2795abecb92cc7f90534f2e66780b7b55a36e867c
-  data.tar.gz: b3813af3a7b38b0fac17bb83bd24bea5d312cd7ab0db5c5adba39cb983599547
+  metadata.gz: 87ca99bd2b9c7f0ab8cc157255593d9211b16e168f838e3a7b643dd273b541e2
+  data.tar.gz: c9d862aa7dfae2b02cb16694e2caf8595397fbdc990e84fb0539159b1a5dfee6
 SHA512:
-  metadata.gz: 0ba494fb0ba09894f97696a94c471f486cec8bc820fe1c02467f2071fc384bb94df6864e0f4d85e399e7851e6123061c036093048b7cde96369aa02352d38e92
-  data.tar.gz: f58785489fab952caa6a37c10a32385f7eb14d55f1712ea034f2fced9e98b480840c6277642e264a76e902aae4166fd87c84e11deacff4165b342cd27b50ec4b
+  metadata.gz: de120146d37f15a50a43c0ba89c19cee46f91131a4765a01d518cedf897ecaa053269c6cae7bb5a6ccbdd35bd48904571722c6bafcd475d28e92ce4ff636d63c
+  data.tar.gz: 62629678cefbef554aa83ff465a3086661c0100075375723fdefe0ab655816b441da4c17aabba5c8d9462172cd559d6d64461ca584ed496c4c4769f5e815f9ea

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.1.3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.6.0
+
+* Add support for `Actor.find_by!(ain:)` and `Actor#reload`
+
 ## v0.5.0
 
 * Unify on/off interface

data/README.md

@@ -41,6 +41,12 @@ actors = Fritzbox::Smarthome::Actor.all
 # Get all actors of type Heater
 heaters = Fritzbox::Smarthome::Heater.all
 heaters.last.update_hkr_temp_set(BigDecimal('21.5'))
+
+# Get a specific actor via it's AIN
+actor = Fritzbox::Smarthome::Actor.find_by!(ain: '0815 4711')
+
+# Reload the data of an already fetched actor
+actor.reload
 ```
 
 ## Development

data/fritzbox-smarthome.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|examples)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/fritzbox/smarthome/actor.rb

@@ -4,36 +4,63 @@ module Fritzbox
       include ActiveModel::Model
 
       attr_accessor \
-        :id,
-        :type,
-        :ain,
-        :present,
-        :name,
-        :manufacturer,
-        :group_members
+      :id,
+      :type,
+      :ain,
+      :present,
+      :name,
+      :manufacturer,
+      :group_members
+
+      ResourceNotFound = Class.new(RuntimeError)
 
       class << self
         def all(types: ['group', 'device'])
-          response = get(command: 'getdevicelistinfos')
-          xml = nori.parse(response.body)
+          xml = parse(get(command: 'getdevicelistinfos'))
+
           Array.wrap(types.map { |type| xml.dig('devicelist', type) }.flatten).compact.map do |data|
             klass = Actor.descendants.find { |k| k.match?(data) } || Actor
             self.in?([klass, Actor]) ? klass.new_from_api(data) : nil
           end.compact
         end
 
+        def find_by!(ain: nil)
+          data = parse(get(command: 'getdeviceinfos', ain: ain)).fetch('device')
+          klass = Actor.descendants.find { |k| k.match?(data) } || Actor
+
+          instance = klass.new(ain: ain)
+          instance.assign_from_api(data)
+          instance
+        rescue KeyError
+          raise ResourceNotFound, "Unable to find actor with ain='#{ain}'"
+        end
+
         def new_from_api(data)
-          new(
-            id:            data.dig('@id').to_s,
-            type:          data.dig('groupinfo').present? ? :group : :device,
-            ain:           data.dig('@identifier').to_s,
-            present:       data.dig('present') == '1',
-            name:          (data.dig('name') || data.dig('@productname')).to_s,
-            manufacturer:  (data.dig('manufacturer') || data.dig('@manufacturer')).to_s,
-            group_members: data.dig('groupinfo', 'members').to_s.split(',').presence
-          )
+          instance = new
+          instance.assign_from_api(data)
+          instance
         end
       end
+
+      def assign_from_api(data)
+        assign_attributes(
+          id:            data.dig('@id').to_s,
+          type:          data.dig('groupinfo').present? ? :group : :device,
+          ain:           data.dig('@identifier').to_s,
+          present:       data.dig('present') == '1',
+          name:          (data.dig('name') || data.dig('@productname')).to_s,
+          manufacturer:  (data.dig('manufacturer') || data.dig('@manufacturer')).to_s,
+          group_members: data.dig('groupinfo', 'members').to_s.split(',').presence
+        )
+      end
+
+      def reload
+        xml = parse(get(command: 'getdeviceinfos', ain: ain))
+        assign_from_api(xml.fetch('device'))
+        self
+      rescue KeyError
+        raise ResourceNotFound, "Unable to reload actor with ain='#{ain}'"
+      end
     end
   end
 end

data/lib/fritzbox/smarthome/heater.rb

@@ -14,19 +14,19 @@ module Fritzbox
         def match?(data)
           data.key?('hkr')
         end
+      end
 
-        def new_from_api(data)
-          instance = super
-          instance.assign_attributes(
-            battery:                data.dig('battery').to_i,
-            batterylow:             data.dig('batterylow').to_i,
-            hkr_temp_is:            data.dig('hkr', 'tist').to_i * 0.5,
-            hkr_temp_set:           data.dig('hkr', 'tsoll').to_i * 0.5,
-            hkr_next_change_period: Time.at(data.dig('hkr', 'nextchange', 'endperiod').to_i),
-            hkr_next_change_temp:   data.dig('hkr', 'nextchange', 'tchange').to_i * 0.5
-          )
-          instance
-        end
+      def assign_from_api(data)
+        super(data)
+
+        assign_attributes(
+          battery:                data.dig('battery').to_i,
+          batterylow:             data.dig('batterylow').to_i,
+          hkr_temp_is:            data.dig('hkr', 'tist').to_i * 0.5,
+          hkr_temp_set:           data.dig('hkr', 'tsoll').to_i * 0.5,
+          hkr_next_change_period: Time.at(data.dig('hkr', 'nextchange', 'endperiod').to_i),
+          hkr_next_change_temp:   data.dig('hkr', 'nextchange', 'tchange').to_i * 0.5
+        )
       end
 
       def update_hkr_temp_set(value)

data/lib/fritzbox/smarthome/resource.rb

@@ -17,6 +17,10 @@ module Fritzbox
           HTTParty.get(url, **httparty_options)
         end
 
+        def parse(response)
+          nori.parse(response.body)
+        end
+
         private
 
         delegate :config, to: Smarthome
@@ -52,6 +56,8 @@ module Fritzbox
           @nori ||= Nori.new
         end
       end
+
+      delegate :get, :parse, to: :class
     end
   end
 end

data/lib/fritzbox/smarthome/smoke_detector.rb

@@ -10,15 +10,15 @@ module Fritzbox
         def match?(data)
           data.key?('alert')
         end
+      end
 
-        def new_from_api(data)
-          instance = super
-          instance.assign_attributes(
-             alert_state: data.dig('alert', 'state').to_i,
-             last_alert:  Time.at(data.dig('alert', 'lastalertchgtimestamp').to_i)
-          )
-          instance
-        end
+      def assign_from_api(data)
+        super(data)
+
+        assign_attributes(
+          alert_state: data.dig('alert', 'state').to_i,
+          last_alert:  Time.at(data.dig('alert', 'lastalertchgtimestamp').to_i)
+        )
       end
     end
   end

data/lib/fritzbox/smarthome/switch.rb

@@ -19,22 +19,22 @@ module Fritzbox
         def match?(data)
           data.key?('switch')
         end
+      end
 
-        def new_from_api(data)
-          instance = super
-          instance.assign_attributes(
-            switch_state:        data.dig('switch', 'state').to_i,
-            switch_mode:         data.dig('switch', 'mode').to_s,
-            switch_lock:         data.dig('switch', 'lock').to_i,
-            switch_devicelock:   data.dig('switch', 'devicelock').to_i,
-            powermeter_voltage:  data.dig('powermeter', 'voltage').to_i,
-            powermeter_power:    data.dig('powermeter', 'power').to_i,
-            powermeter_energy:   data.dig('powermeter', 'energy').to_i,
-            temperature_celsius: data.dig('temperature', 'celsius').to_i,
-            temperature_offset:  data.dig('temperature', 'offset').to_i
-          )
-          instance
-        end
+      def assign_from_api(data)
+        super(data)
+
+        assign_attributes(
+          switch_state:        data.dig('switch', 'state').to_i,
+          switch_mode:         data.dig('switch', 'mode').to_s,
+          switch_lock:         data.dig('switch', 'lock').to_i,
+          switch_devicelock:   data.dig('switch', 'devicelock').to_i,
+          powermeter_voltage:  data.dig('powermeter', 'voltage').to_i,
+          powermeter_power:    data.dig('powermeter', 'power').to_i,
+          powermeter_energy:   data.dig('powermeter', 'energy').to_i,
+          temperature_celsius: data.dig('temperature', 'celsius').to_i,
+          temperature_offset:  data.dig('temperature', 'offset').to_i
+        )
       end
     end
   end

data/lib/fritzbox/smarthome/version.rb

@@ -1,5 +1,5 @@
 module Fritzbox
   module Smarthome
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fritzbox-smarthome
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Klaus Meyer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-09 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport