atrea_control 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd2ed6c46c2b1c7caef1d39ee4ed6e67971265273b1f985ba522876c6aaaa991
-  data.tar.gz: d076c8e9079314311694dc98429bad429a4b49e55456bf44699fb2ec33d7101e
+  metadata.gz: 919ab4f4ed1dde112816e58cecfb4ffc393cb539cecf81796a2490219683c75d
+  data.tar.gz: 7b450714f08130ad30ad565c5ce04b22b29435c43cd8230dbf10103a04c9e624
 SHA512:
-  metadata.gz: b7fc76c48e32e116d94135d23073df680f33ad30bc6637ee596a4762b61ed57f00a8af418a8e7e6a29ffb92d2daa11aecc67e4de2353b31681670de802e06bd2
-  data.tar.gz: e2ff402d8e723d43c5baec15a694ee941ba3f8d5f96c31c3e30b080c03d0090209456b7e55b71085d89dd9b355840e4bf1413921e502ddef984edc4d6ad99000
+  metadata.gz: 360fc2c895cc21dabffd4450a5013899263077b7a9f5c968c7046584728e457f795e8a159dc714021ac2dfaed2b5fe3792debd67c88c52810144d83bea792cff
+  data.tar.gz: bfdd992e729adccf960aee9d26e9088ef9fe7beb20f1067396099248659c187e079f303504e04fefb7bdac9dee0dd0249f01c053b39966cef67f55c2da2ada69

data/.github/workflows/main.yml

@@ -1,17 +1,19 @@
 name: Ruby
 
-on: [push,pull_request]
+on: [push, pull_request]
 
 jobs:
   spec:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [3.2, 3.3, 3]
     steps:
     - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.2.2
+        ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
-    - uses: browser-actions/setup-firefox@latest
     - name: Run tests
-      run: bundle exec rspec
+      run: bundle exec rspec

data/.gitignore

@@ -11,3 +11,4 @@
 
 # rspec failure tracking
 .rspec_status
+.env

data/.rubocop.yml

@@ -5,7 +5,7 @@ require:
 AllCops:
   NewCops: enable
   SuggestExtensions: false
-  TargetRubyVersion: 3.2
+  TargetRubyVersion: 3.3
 
 Style/StringLiterals:
   Enabled: true

data/.rubocop_todo.yml

@@ -1,17 +1,24 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-01 20:32:36 UTC using RuboCop version 1.47.0.
+# on 2025-01-24 16:50:34 UTC using RuboCop version 1.70.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'atrea_control.gemspec'
+
+# Offense count: 5
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 34
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 21
@@ -28,28 +35,30 @@ RSpec/ExpectInHook:
   Exclude:
     - 'spec/atrea_control/duplex/unit_spec.rb'
 
-# Offense count: 7
-# Configuration parameters: EnforcedStyle.
+# Offense count: 4
+# Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
-  Exclude:
-    - 'spec/atrea_control/duplex/login_spec.rb'
-    - 'spec/atrea_control/duplex/unit_spec.rb'
+  EnforcedStyle: receive
 
-# Offense count: 2
+# Offense count: 1
 RSpec/MultipleExpectations:
   Max: 3
 
-# Offense count: 3
+# Offense count: 4
+# This cop supports unsafe autocorrection (--autocorrect-all).
+RSpec/ReceiveMessages:
+  Exclude:
+    - 'spec/atrea_control/duplex/unit_spec.rb'
+
+# Offense count: 1
 RSpec/StubbedMock:
   Exclude:
-    - 'spec/atrea_control/duplex/login_spec.rb'
     - 'spec/atrea_control/duplex/unit_spec.rb'
 
-# Offense count: 6
+# Offense count: 9
 RSpec/SubjectStub:
   Exclude:
-    - 'spec/atrea_control/duplex/login_spec.rb'
     - 'spec/atrea_control/duplex/unit_spec.rb'
     - 'spec/atrea_control/duplex/user_ctrl_spec.rb'
 
@@ -57,7 +66,6 @@ RSpec/SubjectStub:
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:
-    - 'spec/atrea_control/duplex/login_spec.rb'
     - 'spec/atrea_control/duplex/unit_spec.rb'
     - 'spec/atrea_control/duplex/user_ctrl_spec.rb'
 
@@ -66,7 +74,7 @@ Security/Eval:
   Exclude:
     - 'lib/atrea_control/duplex/user_ctrl.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
@@ -74,3 +82,10 @@ Style/Documentation:
     - 'test/**/*'
     - 'lib/atrea_control.rb'
     - 'lib/atrea_control/logger.rb'
+
+# Offense count: 9
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 238

data/.ruby-version

@@ -1 +1 @@
-3.3.4
+3.3.6

data/CHANGELOG.md

@@ -1,4 +1,14 @@
 ## [Unreleased]
+## [3.0.0] - 2025-01-25
+### Removed
+- selenium-based login procedure
+### Added
+- token / phpsessionid-based login in background
+- "session" validity check & expiration (exception)
+### Changed
+- ruby version 3.3+
+- 
+## [2.2.0] - 2024-10-20
 ### Added
 - timestamp from atrea server
 ### Changed

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    atrea_control (2.3.0)
+    atrea_control (3.0.0)
       i18n (~> 1.14)
       nokogiri (~> 1.15)
       rest-client (~> 2.1)
-      selenium-webdriver (~> 4.25.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,55 +12,54 @@ GEM
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
+    bigdecimal (3.1.9)
     coderay (1.1.3)
-    concurrent-ruby (1.3.4)
+    concurrent-ruby (1.3.5)
     crack (1.0.0)
       bigdecimal
       rexml
     diff-lcs (1.5.1)
     docile (1.4.1)
     domain_name (0.6.20240107)
-    hashdiff (1.1.1)
+    hashdiff (1.1.2)
     http-accept (1.7.0)
-    http-cookie (1.0.7)
+    http-cookie (1.0.8)
       domain_name (~> 0.5)
-    i18n (1.14.6)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.7.2)
+    json (2.9.1)
     language_server-protocol (3.17.0.3)
-    logger (1.6.1)
+    logger (1.6.5)
     method_source (1.1.0)
     mime-types (3.6.0)
       logger
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2024.1001)
+    mime-types-data (3.2025.0107)
     netrc (0.11.0)
-    nokogiri (1.16.7-arm64-darwin)
+    nokogiri (1.18.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-darwin)
+    nokogiri (1.18.2-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-linux)
+    nokogiri (1.18.2-x86_64-linux-gnu)
       racc (~> 1.4)
     parallel (1.26.3)
-    parser (3.3.5.0)
+    parser (3.3.7.0)
       ast (~> 2.4.1)
       racc
-    pry (0.14.2)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.2)
+    regexp_parser (2.10.0)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rexml (3.3.8)
+    rexml (3.4.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -74,45 +72,40 @@ GEM
     rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.67.0)
+    rspec-support (3.13.2)
+    rubocop (1.70.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
       parser (>= 3.3.1.0)
-    rubocop-rspec (3.1.0)
+    rubocop-rspec (3.4.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    rubyzip (2.3.2)
-    selenium-webdriver (4.25.0)
-      base64 (~> 0.2)
-      logger (~> 1.4)
-      rexml (~> 3.2, >= 3.2.5)
-      rubyzip (>= 1.2.2, < 3.0)
-      websocket (~> 1.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.6.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
     webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    websocket (1.2.11)
 
 PLATFORMS
   arm64-darwin-22
   arm64-darwin-23
+  arm64-darwin-24
   x86_64-darwin-20
   x86_64-linux
 
@@ -127,4 +120,4 @@ DEPENDENCIES
   webmock (~> 3.14)
 
 BUNDLED WITH
-   2.5.17
+   2.6.3

data/README.md

@@ -1,7 +1,7 @@
 # atrea_control
 Ventilation systems by https://www.atrea.eu are build with web UI portal - but this portal did not provide any API interface...
 
-This gem provide simple DSL by parsing content of https://control.atrea.eu with selenium webdriver.
+This gem provide way how to connect to portal and obtain data from unit as API.
 
 ## Highlights
 
@@ -19,25 +19,38 @@ This gem provide simple DSL by parsing content of https://control.atrea.eu with
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'atrea_control'
+gem "atrea_control"
 ```
 
 And then execute:
+```bash
+bundle install
+```
 
-    $ bundle install
+Or 
+```bash
+bundle add atrea_control
+```
 
 Or install it yourself as:
 
-    $ gem install atrea_control
+```bash
+gem install atrea_control
+```
 
 ## Usage
 
 At the begin you need obtain `user_id`, `unit_id` and `sid` (auth token). For this use "Login"
+
+* `user_id` is atrea internal ID of user account
+* `unit_id` is atrea `ident` - identification number of airflow unit (ventilation system) - 10 digits
+* `sid` is session ID - auth token, valid for logged session. Its validity is unknown
+
 ```ruby
 tokens = AtreaControl::Duplex::Login.user_tokens login: "myhome", password: "sup3r-S3CR3T-kocicka"
 tokens # => { user_id: "1234", unit_id: "85425324672", sid: 4012 }
 ```
-I recommend to store then somewhere... 
+I recommend to store then somewhere...
 Then you can call Unit for data...
 
 Example usage:
@@ -46,6 +59,7 @@ control = AtreaControl::Duplex::Unit.new user_id: "1234", unit_id: "85425324672"
 control.values # => { current_power: 88.0, current_mode: "CO2" }
 control.power # => 88.0 
 ```
+
 ### Dig deeper
 `AtreaControl::Duplex::Unit` expect optional argument `user_ctrl` which should be object respond to 
 
@@ -56,36 +70,12 @@ control.power # => 88.0
 
 __Please check [lib/atrea_control/duplex/user_ctrl.rb](./lib/atrea_control/duplex/user_ctrl.rb) for more details !__
 
-## Development / TODO
-Login is currently done by selenium - fill login form. 
-I found that Atre submit form to BE, generate some "empty" HTML and JS which onLoad start doing request to queue for "login".
-
-Re-login user, add login procedure into queue:
-```bash
-curl -X POST -d "comm=config%2Flogin.cgi" "https://control.atrea.eu/apps/rd5Control/handle.php?action=unitLogin&user=XXXX&unit=NNNNNNN&table=userUnits&idPwd=YYYYYYY&NFP"
-```
-Response is time in seconds when login will ready:
-```xml
-<root><sended time="264"/></root>
-```
-Based it su shown countdown ...
-
-
-Request for current queue status
-```bash
-curl 'https://control.atrea.eu/apps/rd5Control/handle.php?Sync=1&action=unitQuery&query=loged&user=XXXX&unit=NNNNNNN'
-```
-if queue is processed:
-```xml
-<root><login uconn="16395889" sid="010101" ver="3001009"/></root>
-```
-else
-```xml
-<root><login uconn="16390480" sid="0"/></root>
-```
+This object is used to translate internal unit modes to user-friendly texts & translations.
 
-Goal is to obtain "SID".
+I strong recommend to use `AtreaControl::Duplex::UserCtrl` object from "cache",
+for optimize network traffic - because they are static data.
 
+## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/atrea_control.gemspec

@@ -39,5 +39,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency "i18n", "~> 1.14"
   spec.add_dependency "nokogiri", "~> 1.15"
   spec.add_dependency "rest-client", "~> 2.1"
-  spec.add_dependency "selenium-webdriver", "~> 4.25.0"
 end

data/bin/console

@@ -8,8 +8,8 @@ require "atrea_control"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)

data/lib/atrea_control/duplex/login.rb

@@ -1,23 +1,19 @@
 # frozen_string_literal: true
 
-require "digest"
+require "nokogiri"
 require "rest-client"
-require "selenium-webdriver"
+require "securerandom"
 
 module AtreaControl
   module Duplex
-    # Process login into RD5 with selenium to get `sid` ( auth_token ) for direct API communication
+    # Process login into RD5 to get `sid` ( auth_token ) for direct API communication
     class Login
       include AtreaControl::Logger
 
       # @return [Hash] - user_id, unit_id, sid
       def self.user_tokens(login:, password:)
-        i = new(login: login, password: password)
-        tokens = i.user
-
-        tokens
-      ensure
-        i.close
+        instance = new(login: login, password: password)
+        instance.call
       end
 
       # @param [String] login
@@ -26,101 +22,107 @@ module AtreaControl
         @login = login
         @password = password
       end
-      #
-      # def crypto_password
-      #   md5 = Digest::MD5.new
-      #   md5 << "\r\n"
-      #   md5 << @password
-      #   md5.hexdigest
-      # end
-      #
-      # def token
-      #   RestClient.get "#{AtreaControl::Duplex::CONTROL_URI}/config/login.cgi", params: { magic: crypto_password }
-      # end
 
-      def user
-        raise AtreaControl::Error, "Must be logged in" unless login
+      # Perform login procedure for retrieve `sid` (auth_token)
+      # @return [Hash] - user_id, unit_id, sid
+      # @raise [AtreaControl::Error] if login failed
+      def call
+        @sid = sid
+        if @sid == "0"
+          re_login = RestClient.post "#{AtreaControl::Duplex::CONTROL_URI}/apps/rd5Control/handle.php?action=unitLogin&user=#{user_id}&unit=#{unit_id}&table=userUnits&idPwd=#{unit[:iid]}&#{SecureRandom.hex(2)}&_ts=#{SecureRandom.hex(4)}",
+                                     { comm: "config/login.cgi?magic=" }, headers
+          time = Nokogiri::XML(re_login.body).at_xpath("//sended")["time"].to_i
+          logger.debug "Login in #{time} seconds..."
+          time.times do
+            @sid = sid
+            break if @sid != "0"
+
+            sleep 1
+          end
+          raise AtreaControl::Error, "Login failed" if @sid == "0"
+
+          logger.debug "Login complete !"
+        else
+          logger.debug "Login is not necessary ! SID: #{@sid}"
+        end
+        { user_id:, unit_id:, sid: @sid }
+      end
 
-        logger.debug "refresh user data based on session"
-        @user_id = driver.execute_script("return window._user")
-        @unit_id = driver.execute_script("return window._unit")
-        @auth_token = driver.execute_script("return window.user")&.[]("auth") # sid
+      private
 
-        { user_id: @user_id, unit_id: @unit_id, sid: @auth_token }
-      end
+      # @!group Login steps, order is important
 
-      # @return [Selenium::WebDriver::Firefox::Driver]
-      def driver
-        return @driver if defined?(@driver)
+      # Retrieve user details from RD5 core.php?action=init
+      # @return [Hash] - user_id, name
+      def user
+        core_init = RestClient.get "#{AtreaControl::Duplex::CONTROL_URI}/core/core.php?action=init&_ts=#{SecureRandom.hex(4)}",
+                                   headers
+        client = Nokogiri::XML(core_init.body).at_xpath("//client")
+        user_id = client["id"]
+        name = client["name"]
+        logger.debug "User ID: #{user_id}, User Name: #{name}"
+
+        { user_id:, name: }
+      end
 
-        # options = Selenium::WebDriver::Firefox::Options.new
-        # options.headless! unless ENV["NO_HEADLESS"]
-        # @driver ||= Selenium::WebDriver.for :firefox, capabilities: [options]
-        options = Selenium::WebDriver::Firefox::Options.new
-        options.add_argument "-headless" unless ENV["NO_HEADLESS"]
-        @driver ||= Selenium::WebDriver::Firefox::Driver.new options: options
+      def user_id
+        @user_id ||= user[:user_id]
       end
 
-      # Login into control
-      def login
-        return driver if @logged
-
-        @login_in_progress = true
-        logger.debug "start new login..."
-        driver.get "#{AtreaControl::Duplex::CONTROL_URI}?action=logout"
-        submit_login_form
-        finish_login
-        driver
-      ensure
-        @login_in_progress = false
+      # For some reason, this requests must be done before `unit_id` requested
+      def run_rd5_app
+        RestClient.post "#{AtreaControl::Duplex::CONTROL_URI}/core/core.php?Sync=1&action=run&object=app&lng=28&rVer=1&_ts=#{SecureRandom.hex(4)}",
+                        { name: "rd5Control", path: "apps/rd5Control/" }, headers
+        RestClient.post "#{AtreaControl::Duplex::CONTROL_URI}/core/core.php?Sync=1&action=load&object=setting&_ts=#{SecureRandom.hex(4)}",
+                        { path: "apps/rd5Control" }, headers
       end
 
-      # Submit given credentials and proceed login
-      def submit_login_form
-        form = driver.find_element(id: "loginFrm")
-        username = form.find_element(name: "username")
-        username.send_keys @login
-        password = form.find_element(name: "password")
-        password.send_keys @password
-        logger.debug "Submit login form..."
-
-        submit = form.find_element(css: "input[type=submit]")
-        submit.click
+      # Retrieve overview of RD5 unit
+      # @return [Hash] - unit_number (digit code/ID from list) and iid (unit salt?)
+      def unit
+        return @unit if @unit
+
+        # run_rd5_app
+        units_table = RestClient.get "#{AtreaControl::Duplex::CONTROL_URI}/_data/data.php?Sync=1&action=getdata&rH&rE&table=userUnits&ds=rd5&_ts=#{SecureRandom.hex(4)}",
+                                     headers
+        item = Nokogiri::XML(units_table.body).at_xpath("//i")
+        unit_number = item["unit"]
+        iid = item["id"]
+        @unit ||= { unit_number:, iid: }
       end
 
-      # Retrieve dashboard URI from object tag and open it again
-      def open_dashboard
-        uri = driver.find_element(tag_name: "object").attribute "data"
-        # Open "iframe" with atrea dashboard - it propagate window objects...
-        driver.get uri
-        logger.debug "login success"
-        @logged = true
+      # With `unit_number` from `unit` method, get `unit_id` from RD5 unit records
+      # @return [String] - unit_id
+      def unit_id
+        return @unit_id if @unit_id
+
+        records = RestClient.get "#{AtreaControl::Duplex::CONTROL_URI}/_data/data.php?Sync=1&action=getrecord&id=#{unit[:unit_number]}&table=units&ds=rd5&_ts=#{SecureRandom.hex(4)}",
+                                 headers
+        @unit_id ||= Nokogiri::XML(records.body).at_xpath("//table/i")["ident"]
       end
 
-      # quit selenium browser
-      def close
-        begin
-          driver.quit
-        rescue StandardError
-          nil
-        end
-        logger.debug "driver closed & destroyed"
-      ensure
-        remove_instance_variable :@driver
+      def sid
+        data = RestClient.get "#{AtreaControl::Duplex::CONTROL_URI}/apps/rd5Control/handle.php?Sync=1&action=unitQuery&query=loged&user=#{user_id}&unit=#{unit_id}&#{SecureRandom.hex(2)}&_ts=#{SecureRandom.hex(4)}",
+                              headers
+        logger.debug data.body
+        Nokogiri::XML(data.body).at_xpath("//login")["sid"]
       end
 
-      private
+      # @!group Private methods
 
-      def finish_login
-        30.times do |i|
-          return true if open_dashboard
-        rescue Selenium::WebDriver::Error::NoSuchElementError => e
-          logger.debug e.message
-          logger.debug "#{i + 1}/30 attempt for login..."
-          sleep 10
+      # @return [String] session ID from PHP BE
+      def php_session_id
+        return @php_session_id if @php_session_id
+
+        payload = { username: @login, password: @password }
+        RestClient.post "#{AtreaControl::Duplex::CONTROL_URI}?action=login", payload do |response|
+          @php_session_id = response.cookies["PHPSESSID"]
         end
-        File.write("/tmp/failed_login-#{@login}.html", driver.page_source)
-        raise AtreaControl::Error, "unable to login"
+        @php_session_id
+      end
+
+      def headers
+        { cookies: { PHPSESSID: php_session_id }, "App-name": "rd5Control" }
       end
     end
   end

data/lib/atrea_control/duplex/request.rb

@@ -29,3 +29,4 @@ module AtreaControl
     end
   end
 end
+# https://control.atrea.eu/comm/sw/unit.php?ver=003001022&_user=2113&_unit=126399332270040&auth=49852&_t=config/xml.xml&_X=Ti&_async=1

data/lib/atrea_control/duplex/unit.rb

@@ -9,8 +9,6 @@ module AtreaControl
       attr_reader :current_mode, :current_power, :outdoor_temperature, :preheat_temperature, :input_temperature
       # @return [Boolean] preheating air is ON ?
       attr_reader :preheating
-      # @return [DateTime] store time of last update
-      attr_reader :valid_for
       # @return [UserCtrl]
       attr_reader :user_ctrl
       # @return [Time, DateTime]
@@ -69,6 +67,8 @@ module AtreaControl
         parsed.each do |name, value|
           instance_variable_set :"@#{name}", value
         end
+        raise AtreaControl::SessionExpired unless valid?
+
         as_json
       end
 
@@ -80,7 +80,6 @@ module AtreaControl
           preheat_temperature: preheat_temperature,
           input_temperature: input_temperature,
           preheating: preheating,
-          valid_for: valid_for,
           timestamp: timestamp,
         }
       end
@@ -89,15 +88,29 @@ module AtreaControl
         values.to_json(*)
       end
 
-      # Additional "parameters" for each sensors
-      # @note its changed in time ?
+      # Expire cached data and fetch them again
+      # @return [Hash] new values
+      def refresh!
+        remove_instance_variable(:@parsed) if defined?(@parsed)
+        values
+      end
+
+      # Data are valid if timestamp within 15.minutes
+      def valid?
+        return false unless timestamp
+
+        timestamp > (Time.now - (15 * 60.0))
+      end
+
+      private
+
+      # Additional "parameters" for each sensor
+      # @note it's changed in time ?
       def params
         response = request.call(_t: "user/params.xml")
         Nokogiri::XML response.body
       end
 
-      private
-
       def parser
         @parser ||= ::AtreaControl::SensorParser.new(@user_ctrl)
       end

data/lib/atrea_control/duplex/user_ctrl.rb

@@ -33,7 +33,7 @@ module AtreaControl
 
       # Get and parse XML with user/unit configuration source
       def user_ctrl
-        response = request.call(_t: "lang/userCtrl.xml")
+        response = request.call(_t: "lang/userCtrl.xml", _async: 1)
         Nokogiri::XML response.body
       end
 

data/lib/atrea_control/duplex.rb

@@ -4,7 +4,7 @@ module AtreaControl
   # Controller for +control.atrea.eu+
   module Duplex
     CONTROL_URI = "https://control.atrea.eu/"
-    CONTROL_VERSION = "003001009"
+    CONTROL_VERSION = "003001022"
 
     autoload :Login, "atrea_control/duplex/login"
     autoload :Request, "atrea_control/duplex/request"

data/lib/atrea_control/sensor_parser.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "nokogiri"
+require "time"
 
 module AtreaControl
   # Call RD5 unit ang get current sensors values
@@ -43,6 +44,7 @@ module AtreaControl
       preheating = %w[C10200 C10202 C10215 C10217].any? do |i|
         xml.xpath("//O[@I=\"#{i}\"]/@V").last&.value == "1"
       end
+      # @note timestamp seems to be localtime of creation of xml
       parsed["timestamp"] = xml.xpath("//RD5WEB").attribute("t").to_s
       parsed["preheating"] = preheating
       parsed
@@ -58,8 +60,7 @@ module AtreaControl
         "preheat_temperature" => values["preheat_temperature"].to_f / 10.0,
         "input_temperature" => values["input_temperature"].to_f / 10.0,
         "preheating" => values["preheating"],
-        "timestamp" => DateTime.parse(values["timestamp"]),
-        "valid_for" => Time.now,
+        "timestamp" => Time.strptime(values["timestamp"], "%Y-%m-%d %H:%M:%S"),
       }
     end
 

data/lib/atrea_control/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
+# :nocov:
 
 module AtreaControl
-  VERSION = "2.3.0"
+  VERSION = "3.0.0"
 end

data/lib/atrea_control.rb

@@ -7,6 +7,12 @@ require "yaml"
 module AtreaControl
   class Error < StandardError; end
 
+  class SessionExpired < Error
+    def message
+      "Session expired. Please perform login again."
+    end
+  end
+
   autoload :Duplex, "atrea_control/duplex"
   autoload :Logger, "atrea_control/logger"
   autoload :SensorParser, "atrea_control/sensor_parser"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atrea_control
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-20 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.25.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.25.0
 description: Read data from web controller of RD5 duplex by Atrea.
 email:
 - pokorny@luk4s.cz
@@ -119,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Get data control.atrea.eu