atrea_control 3.2.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 882aba37152d02169b498490ecf172a54dd23d13ce1adbd1942d0352b7657631
-  data.tar.gz: e9476fea5a2f52ab43daefd238afd31a2e47f48c9ff0e522c2380c0ff020c43c
+  metadata.gz: da49b797a6e3e359751ab8ef6b64768d53ddc81b06f91c78dbe868f510540926
+  data.tar.gz: 869cddecea901cc565ff961818a0788e45243a9ec337978ebcb2e3e157de6f53
 SHA512:
-  metadata.gz: cff2b7d059df5833e7d7caa24c8db787c4ae79b566023923f93bf4d46c70710171c5ed59734364d4c91bff4d1743b98ec2a9dc7f03bd0bb0d3dccf635b9c4f7c
-  data.tar.gz: 36053dfa7f5a609672cd07408f678b7187f94b88b6e116d7c1c602e229da194766f73b2a5de45d339ff9bf1092081b120427a06322b99c2940b44a46d7afadfd
+  metadata.gz: ceba4c6afb798d0f72fb58b087bf65594881894b5d6284b1623122774c14df01ac3904f824c96fc00ff09b57698aa1d8578b33223e8874696c7ea76155955457
+  data.tar.gz: 3035973ce25e37db961c3a8aac07c124e75284afce1f8caa7d90b43b60771e359196e65f6496f71a6e8f5888f3419852f8627a7425bc8b665ea2dd26c87ea9f9

data/.github/workflows/main.yml

@@ -17,3 +17,14 @@ jobs:
         bundler-cache: true
     - name: Run tests
       run: bundle exec rspec
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '4'
+        bundler-cache: true
+    - name: Run RuboCop
+      run: bundle exec rubocop

data/.rubocop_todo.yml

@@ -18,10 +18,16 @@ Gemspec/RequiredRubyVersion:
 Metrics/AbcSize:
   Max: 34
 
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/atrea_control/duplex/login.rb'
+
 # Offense count: 3
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 21
+  Max: 23
 
 # Offense count: 1
 # Configuration parameters: Prefixes, AllowedPatterns.

data/.ruby-version

@@ -1 +1 @@
-4.0.2
+4.0.7

data/AGENTS.md

@@ -0,0 +1,51 @@
+# Repository guidance
+
+## Commands and toolchain
+- Install dependencies: `bin/setup` (`bundle install`).
+- Full local checks: `bundle exec rake` runs specs, then RuboCop.
+- CI runs the RSpec Ruby matrix and a separate `bundle exec rubocop` job.
+- Focused test: `bundle exec rspec spec/atrea_control/duplex/unit_spec.rb`;
+  append `:LINE` to select an example.
+- Ruby versions differ across config: `.ruby-version` pins 4.0.7, gemspec
+  allows >= 3.2, RuboCop targets 3.3. Do not infer minimum Ruby from local version.
+- RuboCop inherits `.rubocop_todo.yml`; RSpec message expectations use
+  `receive`, not `have_received`.
+
+## Protocol and state
+- This gem wraps Atrea RD5's web portal. `Duplex::Login` obtains tokens;
+  `Duplex::Request` performs unit requests; `UserCtrl` discovers sensor/mode
+  mappings; `SensorParser` decodes readings and encodes writes.
+- Sensor and mode maps use string keys. Derive sensor IDs from `UserCtrl`;
+  fixture IDs are not universal device configuration.
+- `UserCtrl.data` is persisted by `home_control`. Preserve JSON-safe
+  `input_temperature_source` metadata when exporting/reconstructing `user_ctrl:`;
+  a sensor ID alone cannot represent conditional inlet-temperature selection.
+- RD5 Modbus register semantics inform command policy, not cloud HTTP framing.
+  See `docs/rd5-cloud-protocol.md` for supported profiles and evidence limits.
+- `Unit` caches parsed readings; `refresh!` fetches again. `values` raises
+  `AtreaControl::SessionExpired` when device timestamp is missing or older
+  than 15 minutes, rather than relying on HTTP authentication errors.
+- All current-value readers validate snapshots. Failed refresh stays failed until
+  explicit `refresh!`; write attempts discard prewrite data even on failure.
+- `set_power`/`set_mode` verify by default and require caller-proven
+  `verification_registers:`; legacy setters are transport-only. Never infer a
+  read-back register from PDF addresses or automatically replay timed-out writes.
+- Use Faraday/Net::HTTP: login has a 300-second total limit, HTTP requests 60.
+  Standard `Timeout` wrappers use an explicit exception class so Net::HTTP closes
+  sockets during TLS setup; do not reintroduce a custom transport or write retries.
+- Loading `atrea_control` registers `config/locales/*.yml` and sets global
+  `I18n.default_locale` to `:cs`.
+
+## Tests
+- Specs use WebMock and XML/HTML fixtures in `spec/fixtures/files`;
+  normal test runs need no portal credentials or physical unit.
+- Support files are not auto-loaded. Specs using shared `"userCtrl"` context
+  explicitly require `spec/support/user_ctrl.rb`.
+- `unit.xml` contains an old timestamp; most Unit specs stub `valid?`.
+  Exercise real validity behavior with controlled timestamps.
+
+## Packaging
+- Gem contents come from `git ls-files`, excluding test/spec/features.
+  New runtime files must be tracked to enter built gem.
+- `bundle exec rake release` pushes commits/tags and publishes to RubyGems;
+  it is not a local verification command.

data/CHANGELOG.md

@@ -1,4 +1,66 @@
 ## [Unreleased]
+
+## [4.0.0] - 2026-10-26
+### Breaking changes
+- Reject `nil` (formerly liable to become zero), booleans, negative/fractional
+  values and malformed setter strings with `ArgumentError`; never truncate or clamp.
+- Validate power domains, discovered modes, equipment prerequisites and schedule
+  state. Unsupported or incomplete configuration now fails explicitly.
+- Recheck freshness on all current-value getters and serializers. Failed refresh
+  invalidates accessible data until `refresh!`; stale cached values no longer leak.
+- Preserve manual schedule control; scheduled/temporary writes request temporary
+  control even for zero power, rather than unconditionally switching policy.
+- Return `nil` for unavailable/unsupported optional inlet temperature, not a
+  fabricated zero. Add `required_temperature` reader/hash key while retaining
+  historical `preheat_temperature`; both mean requested temperature.
+
+### Change
+- Export JSON-safe `input_temperature_source` in `UserCtrl.data` so persisted
+  configuration retains conditional inlet sensor selection. Custom `user_ctrl:`
+  objects should expose that metadata; the unreleased `input_temperature_profile`
+  accessor is replaced. Sensor-selection rules stay in the gem, not consumer UIs.
+- Include `Sync=1` on the unit-login POST, matching the current portal's
+  synchronous handshake. Without it, the session query could stay at SID zero
+  despite recent unit communication. Add a regression that requires this flag
+  before establishing a session.
+- Parse strict unit/configuration XML and unsigned raw registers; decode signed
+  temperatures only at projection. Reject malformed data through library errors.
+- Accept valid device timestamps without leading zeroes, as observed live
+  (`17:7:32`), while retaining strict date/time and timezone validation.
+- Publish atomic snapshots, enforce the strict 15-minute age boundary and allow
+  at most 60 seconds of future clock skew. Discard snapshots on every write attempt.
+- Add `RD5Configuration`, configuration-derived command/control mappings and exact
+  unsigned 16-bit command encoding. Never execute downloaded configuration code.
+- Add optional IANA `time_zone:`; `nil` retains process-local interpretation.
+  Invalid zones and ambiguous/nonexistent DST timestamps raise `ProtocolError`.
+- Add `set_power`/`set_mode` with verification enabled by default, a 30-second
+  absolute budget and five-second polling. Verification requires caller-supplied,
+  independently proven `verification_registers:`; no current cloud read-back
+  profile is automatically trusted. Missing mappings fail before writing.
+- Keep assignment setters unconfirmed (`verify: false`); HTTP success alone is
+  not application acknowledgement. Verification timeout after dispatch reports
+  unknown outcome through `WriteNotConfirmed`, without write retries.
+- Add explicit login unit selection by `ident` (default: first listed unit), a
+  five-minute total limit, one-second polling and bounded HTTP requests.
+  Distinguish authentication, protocol, transport, timeout and configuration errors.
+- Add `tzinfo ~> 2.0` for explicit IANA/DST handling. Keep Faraday/Net::HTTP as
+  the sole HTTP transport, with standard-library total timeouts: login at most
+  300 seconds, each HTTP operation at most 60 seconds. Remove the HTTPX dependency,
+  custom transport plugin and socket/resolver machinery. Explicit timeout exception
+  classes preserve Net::HTTP TLS cleanup. Automatic retries remain disabled.
+- Verify live RD5 login, configuration, values, getters/JSON, three refreshes and
+  expiry/recovery on 2026-10-25 after correcting the handshake. Validate command
+  construction against the live configuration without dispatching writes.
+  Acknowledgements, live writes and requested-value read-back remain unverified.
+  Add an independent RuboCop CI job alongside the Ruby spec matrix.
+
+### Security
+- Remove credential-bearing response/URL/SID diagnostics and executable locale
+  regeneration; validate XML without DTD/network resolution. Login diagnostics
+  retain stage, status, elapsed time and poll counts without secrets.
+- upgrade ruby 4.0.7
+- upgrade gems
+
 ## [3.2.0] - 2026-04-16
 ### Security
 - upgrade gems
@@ -23,7 +85,7 @@
 - "session" validity check & expiration (exception)
 ### Changed
 - ruby version 3.3+
-- 
+
 ## [2.2.0] - 2024-10-20
 ### Added
 - timestamp from atrea server

data/Gemfile

@@ -7,10 +7,10 @@ gemspec
 
 gem "pry"
 gem "rake", "~> 13.0"
-gem "rspec", "~> 3.10"
-gem "rubocop", "~> 1.7", require: false
-gem "rubocop-rspec", "~> 3.1", require: false
+gem "rspec", "~> 3.13"
+gem "rubocop", "~> 1.88", require: false
+gem "rubocop-rspec", "~> 3.10", require: false
 group :test do
   gem "simplecov", require: false
-  gem "webmock", "~> 3.14"
+  gem "webmock", "~> 3.26"
 end

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    atrea_control (3.2.1)
-      faraday (~> 2.7)
+    atrea_control (4.0.0)
+      faraday (~> 2.14)
       faraday-cookie_jar (~> 0.0)
-      i18n (~> 1.14)
-      nokogiri (~> 1.15)
+      i18n (~> 1.15)
+      nokogiri (~> 1.16)
+      tzinfo (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,49 +14,51 @@ GEM
     addressable (2.9.0)
       public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
-    bigdecimal (4.1.1)
+    bigdecimal (4.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.3.6)
+    concurrent-ruby (1.3.8)
     crack (1.0.1)
       bigdecimal
       rexml
     diff-lcs (1.6.2)
-    docile (1.4.1)
-    domain_name (0.6.20240107)
-    faraday (2.14.1)
-      faraday-net_http (>= 2.0, < 3.5)
+    domain_name (0.7.20261007)
+    faraday (2.15.0)
+      faraday-net_http (>= 2.0, < 3.6)
       json
       logger
     faraday-cookie_jar (0.0.8)
       faraday (>= 0.8.0)
       http-cookie (>= 1.0.0)
-    faraday-net_http (3.4.2)
+    faraday-net_http (3.5.0)
       net-http (~> 0.5)
     hashdiff (1.2.1)
-    http-cookie (1.1.4)
+    http-cookie (1.1.6)
       domain_name (~> 0.5)
-    i18n (1.14.8)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
-    io-console (0.8.2)
-    json (2.19.3)
-    language_server-protocol (3.17.0.5)
+    io-console (0.9.4)
+    json (3.1.0)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     method_source (1.1.0)
-    net-http (0.9.1)
+    net-http (0.10.0)
+      net-protocol (>= 0.3.0)
       uri (>= 0.11.1)
-    nokogiri (1.19.2-arm64-darwin)
+    net-protocol (0.4.0)
+      timeout
+    nokogiri (1.19.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.2-x86_64-darwin)
+    nokogiri (1.19.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.19.2-x86_64-linux-gnu)
+    nokogiri (1.19.4-x86_64-linux-gnu)
       racc (~> 1.4)
-    parallel (2.0.1)
-    parser (3.3.11.1)
+    parallel (2.3.0)
+    parser (3.3.13.0)
       ast (~> 2.4.1)
       racc
     prism (1.9.0)
-    pry (0.16.0)
+    pry (0.16.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
       reline (>= 0.6.0)
@@ -63,8 +66,8 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.4.2)
-    regexp_parser (2.12.0)
-    reline (0.6.3)
+    regexp_parser (2.13.1)
+    reline (0.7.0)
       io-console (~> 0.5)
     rexml (3.4.4)
     rspec (3.13.2)
@@ -80,35 +83,34 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.86.1)
-      json (~> 2.3)
+    rubocop (1.92.1)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
+      regexp_parser (>= 2.11.3, < 3.0)
       rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.1)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
-    rubocop-rspec (3.9.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.81)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.2)
-    simplecov_json_formatter (0.1.4)
-    unicode-display_width (3.2.0)
-      unicode-emoji (~> 4.1)
-    unicode-emoji (4.2.0)
-    uri (1.1.1)
-    webmock (3.26.2)
+    simplecov (1.3.2)
+    timeout (0.6.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
+    uri (1.1.2)
+    webmock (3.34.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -125,11 +127,11 @@ DEPENDENCIES
   atrea_control!
   pry
   rake (~> 13.0)
-  rspec (~> 3.10)
-  rubocop (~> 1.7)
-  rubocop-rspec (~> 3.1)
+  rspec (~> 3.13)
+  rubocop (~> 1.88)
+  rubocop-rspec (~> 3.10)
   simplecov
-  webmock (~> 3.14)
+  webmock (~> 3.26)
 
 BUNDLED WITH
-  4.0.10
+  4.0.20