fritzbox-smarthome 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8e0195a6e63ff7455d046a2795abecb92cc7f90534f2e66780b7b55a36e867c
-  data.tar.gz: b3813af3a7b38b0fac17bb83bd24bea5d312cd7ab0db5c5adba39cb983599547
+  metadata.gz: c4ed289626e1d8c8cacccb9f89eed39178c5b11c781c99a649b3872521a3d0d4
+  data.tar.gz: 02b35061da61c6f1084b87192eefe55cc83113526addf7caff584240256997f7
 SHA512:
-  metadata.gz: 0ba494fb0ba09894f97696a94c471f486cec8bc820fe1c02467f2071fc384bb94df6864e0f4d85e399e7851e6123061c036093048b7cde96369aa02352d38e92
-  data.tar.gz: f58785489fab952caa6a37c10a32385f7eb14d55f1712ea034f2fced9e98b480840c6277642e264a76e902aae4166fd87c84e11deacff4165b342cd27b50ec4b
+  metadata.gz: d2840a781e1717f8e9b11fa1a18929b316c930e57ee3b5e57a24574ad2f065c1b44fa3837e85dc0e88367ff1f402826d5210d8bbf2b9a9079b48dbe655a9d1e8
+  data.tar.gz: 02f972de29e194f5c42f7671c3caddfdfe046951e0fd91095f4614412c5afb76a1861ed71211f89d0e44b52ff909dd79df4f7e93d558d50e9903d217ab0e8be4

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2.0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.7.0
+
+* Measure HTTP request duration
+  * Print the request time in debug log-level
+* Cache authentication between requests
+  * Keep the returned SessionID for 60 minutes in memory
+
+## 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

@@ -1,6 +1,10 @@
 module Fritzbox
   module Smarthome
     class Resource
+      cattr_accessor :session
+
+      AuthenticationError = Class.new(RuntimeError)
+
       class << self
         # @param params [Hash] key/value pairs that will be appended to the switchcmd query string
         def get(command:, ain: nil, param: nil, **params)
@@ -12,9 +16,20 @@ module Fritzbox
             url = "#{url}&#{key}=#{value}"
           end
 
-          config.logger.debug(url)
+          response = measure(url) { HTTParty.get(url, **httparty_options) }
+
+          raise AuthenticationError if response.code == 403
+
+          response
+        rescue AuthenticationError
+          raise if session.nil?
 
-          HTTParty.get(url, **httparty_options)
+          self.session = nil
+          retry
+        end
+
+        def parse(response)
+          nori.parse(response.body)
         end
 
         private
@@ -22,19 +37,28 @@ module Fritzbox
         delegate :config, to: Smarthome
 
         def authenticate
-          response = HTTParty.get(login_endpoint, **httparty_options)
-          xml = nori.parse(response.body)
-          challenge = xml.dig('SessionInfo', 'Challenge')
+          return session.id if session.present? && session.valid?
+
+          session_id = measure("authentication") do
+            response = HTTParty.get(login_endpoint, **httparty_options)
+            xml = nori.parse(response.body)
+            challenge = xml.dig('SessionInfo', 'Challenge')
 
-          md5 = Digest::MD5.hexdigest("#{challenge}-#{config.password}".encode('UTF-16LE'))
+            md5 = Digest::MD5.hexdigest("#{challenge}-#{config.password}".encode('UTF-16LE'))
 
-          url = "#{login_endpoint}?response=#{challenge}-#{md5}"
-          url = "#{url}&username=#{config.username}" if config.username.present?
+            url = "#{login_endpoint}?response=#{challenge}-#{md5}"
+            url = "#{url}&username=#{config.username}" if config.username.present?
 
-          response = HTTParty.get(url, **httparty_options)
+            response = HTTParty.get(url, **httparty_options)
 
-          xml = nori.parse(response.body)
-          xml.dig('SessionInfo', 'SID')
+            xml = nori.parse(response.body)
+
+            xml.dig('SessionInfo', 'SID')
+          end
+
+          self.session = Session.new(session_id)
+
+          session_id
         end
 
         def login_endpoint
@@ -51,7 +75,17 @@ module Fritzbox
         def nori
           @nori ||= Nori.new
         end
+
+        def measure(identifier, &block)
+          time_start = Time.now
+          result = block.call
+          time_elapsed = (Time.now - time_start).to_f.round(3)
+          config.logger.debug("Request `#{identifier}` took #{time_elapsed} seconds")
+          result
+        end
       end
+
+      delegate :get, :parse, to: :class
     end
   end
 end

data/lib/fritzbox/smarthome/session.rb

@@ -0,0 +1,22 @@
+module Fritzbox
+  module Smarthome
+    class Session
+      TIMEOUT_MINUTES = 60
+
+      def initialize(id)
+        self.id = id
+        self.valid_until = Time.now + TIMEOUT_MINUTES.minutes
+      end
+
+      def valid?
+        self.valid_until > Time.now
+      end
+
+      attr_reader :id, :valid_until
+
+      private
+
+      attr_writer :id, :valid_until
+    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.7.0'.freeze
   end
 end

data/lib/fritzbox/smarthome.rb

@@ -6,6 +6,7 @@ require 'nori'
 require 'fritzbox/smarthome/version'
 require 'fritzbox/smarthome/null_logger'
 require 'fritzbox/smarthome/properties'
+require 'fritzbox/smarthome/session'
 require 'fritzbox/smarthome/resource'
 require 'fritzbox/smarthome/actor'
 require 'fritzbox/smarthome/heater'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fritzbox-smarthome
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Klaus Meyer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-09 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -176,6 +176,7 @@ files:
 - lib/fritzbox/smarthome/properties.rb
 - lib/fritzbox/smarthome/properties/simple_on_off.rb
 - lib/fritzbox/smarthome/resource.rb
+- lib/fritzbox/smarthome/session.rb
 - lib/fritzbox/smarthome/smoke_detector.rb
 - lib/fritzbox/smarthome/switch.rb
 - lib/fritzbox/smarthome/version.rb
@@ -198,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Client library to interface with Smarthome features of your FritzBox