fritzbox-smarthome 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87ca99bd2b9c7f0ab8cc157255593d9211b16e168f838e3a7b643dd273b541e2
-  data.tar.gz: c9d862aa7dfae2b02cb16694e2caf8595397fbdc990e84fb0539159b1a5dfee6
+  metadata.gz: c4ed289626e1d8c8cacccb9f89eed39178c5b11c781c99a649b3872521a3d0d4
+  data.tar.gz: 02b35061da61c6f1084b87192eefe55cc83113526addf7caff584240256997f7
 SHA512:
-  metadata.gz: de120146d37f15a50a43c0ba89c19cee46f91131a4765a01d518cedf897ecaa053269c6cae7bb5a6ccbdd35bd48904571722c6bafcd475d28e92ce4ff636d63c
-  data.tar.gz: 62629678cefbef554aa83ff465a3086661c0100075375723fdefe0ab655816b441da4c17aabba5c8d9462172cd559d6d64461ca584ed496c4c4769f5e815f9ea
+  metadata.gz: d2840a781e1717f8e9b11fa1a18929b316c930e57ee3b5e57a24574ad2f065c1b44fa3837e85dc0e88367ff1f402826d5210d8bbf2b9a9079b48dbe655a9d1e8
+  data.tar.gz: 02f972de29e194f5c42f7671c3caddfdfe046951e0fd91095f4614412c5afb76a1861ed71211f89d0e44b52ff909dd79df4f7e93d558d50e9903d217ab0e8be4

data/.ruby-version

@@ -1 +1 @@
-3.1.3
+3.2.0

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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`

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,16 @@ 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
 
-          HTTParty.get(url, **httparty_options)
+          response
+        rescue AuthenticationError
+          raise if session.nil?
+
+          self.session = nil
+          retry
         end
 
         def parse(response)
@@ -26,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 = nori.parse(response.body)
-          xml.dig('SessionInfo', 'SID')
+            xml.dig('SessionInfo', 'SID')
+          end
+
+          self.session = Session.new(session_id)
+
+          session_id
         end
 
         def login_endpoint
@@ -55,6 +75,14 @@ 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

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/version.rb

@@ -1,5 +1,5 @@
 module Fritzbox
   module Smarthome
-    VERSION = '0.6.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.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Klaus Meyer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-06 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