atrea_control 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88aee51ff62bb07d3020bb0a65f13361ae6c36055072da6dc09d80bf4c0b2aff
-  data.tar.gz: fd32eb80961e9355fc9bb9f9af1a9ed4b49072272b7e5142dbd5f1b17c2d4844
+  metadata.gz: 4a5ccc9d8596b46a4ec4c2eb98e26b820c62bfdbf91c8c1b732adc9f858f31bf
+  data.tar.gz: bac1c0183608fe7f16c679578203fba54c10d8e2270be7d0bf68fb1f17d7cce4
 SHA512:
-  metadata.gz: 03aeeac63edae08f4e6ed4f7a4316846015540d3c4d5439bbb914270c66e1bf897cc399f53eb2d7f2f884c6c176198b28ce4331b37572b0abeb895fa54de5c51
-  data.tar.gz: b9d55180b76bb447b6030f5b56cb1a617a07363ed9d239dea90264cacd450a18a7382ead94cb43de2c87fa447b02be2a0bceae3960354130ab6287a978142ec6
+  metadata.gz: 657e441b8aa3ecfaa5eb8905ff6e22064d70d43984156bd15c6b7dfc17f6ed92e1a7c8318cd7febeb2ce68c621ff06f69561cd8861b642f2313f4421df098597
+  data.tar.gz: 97dcc1fa4810f952e4b89d2f610c93a2359debb663b0138f8bf3d5771ca9e4ddfb96be2d9c8e0a0a2a2667f1daa4533606704adfc9a89571a4d0852800cf7bf1

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 /.idea
 /.bundle/
 /.yardoc

data/.rubocop_todo.yml

@@ -1,12 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2021-09-13 19:43:25 UTC using RuboCop version 1.20.0.
+# on 2021-10-30 20:32:55 UTC using RuboCop version 1.22.2.
 # 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: 1
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - '_x.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - '_x.rb'
+
+# Offense count: 2
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
@@ -14,6 +31,12 @@ Metrics/BlockLength:
     - '**/*.gemspec'
     - 'spec/atrea_control/duplex_spec.rb'
 
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne.
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/atrea_control/duplex.rb'
+
 # Offense count: 4
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
@@ -31,7 +54,7 @@ RSpec/StubbedMock:
   Exclude:
     - 'spec/atrea_control/duplex_spec.rb'
 
-# Offense count: 4
+# Offense count: 6
 RSpec/SubjectStub:
   Exclude:
     - 'spec/atrea_control/duplex_spec.rb'
@@ -44,14 +67,23 @@ Style/Documentation:
     - 'test/**/*'
     - 'lib/atrea_control.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
   Exclude:
+    - '_x.rb'
     - 'spec/atrea_control/duplex_spec.rb'
 
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - '_x.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
@@ -60,9 +92,9 @@ Style/MutableConstant:
   Exclude:
     - 'spec/atrea_control/duplex_spec.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
+## [1.3.0] - 2021-12-11
+### Changed
+- store auth tokens outside
+- minimize selenium only for login
 
-## [1.0.0] - 2021-09-13
+## [1.2.1] - 2021-10-30
+### Changed
+- login procedure
+- ensure logged user by window.user object
+
+## [1.2.0] - 2021-10-26
+### Changed
+- use internal unit.php for read values
+- reload login automatically if session expire
+## [1.1.0] - 2021-10-22
+### Added
+- to_json
 
+## [1.0.0] - 2021-09-13
 - Initial release

data/Gemfile

@@ -5,8 +5,12 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in atrea_control.gemspec
 gemspec
 
+gem "pry"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.10"
 gem "rubocop", "~> 1.7", require: false
 gem "rubocop-rspec", "~> 2.4", require: false
-gem "simplecov", require: false, group: :test
+group :test do
+  gem "simplecov", require: false
+  gem "webmock", "~> 3.14"
+end

data/Gemfile.lock

@@ -1,22 +1,52 @@
 PATH
   remote: .
   specs:
-    atrea_control (1.0.0)
+    atrea_control (1.3.0)
+      nokogiri (~> 1.12)
+      rest-client (~> 2.1)
       selenium-webdriver (~> 3.142)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     childprocess (3.0.0)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
     docile (1.4.0)
-    parallel (1.20.1)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.1115)
+    netrc (0.11.0)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    racc (1.6.0)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
+    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.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -31,20 +61,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.20.0)
+    rubocop (1.22.2)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     rubyzip (2.3.2)
     selenium-webdriver (3.142.7)
@@ -56,7 +85,14 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    unicode-display_width (2.0.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   x86_64-darwin-19
@@ -64,11 +100,13 @@ PLATFORMS
 
 DEPENDENCIES
   atrea_control!
+  pry
   rake (~> 13.0)
   rspec (~> 3.10)
   rubocop (~> 1.7)
   rubocop-rspec (~> 2.4)
   simplecov
+  webmock (~> 3.14)
 
 BUNDLED WITH
    2.2.17

data/README.md

@@ -58,7 +58,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/atrea_control. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/luk4s/atrea_control/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/luk4s/atrea_control. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/luk4s/atrea_control/blob/master/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 

data/atrea_control.gemspec

@@ -34,5 +34,7 @@ Gem::Specification.new do |spec|
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
 
+  spec.add_dependency "nokogiri", "~> 1.12"
+  spec.add_dependency "rest-client", "~> 2.1"
   spec.add_dependency "selenium-webdriver", "~> 3.142"
 end

data/lib/atrea_control/duplex.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "logger"
+require "nokogiri"
+require "rest-client"
 require "selenium-webdriver"
 
 module AtreaControl
@@ -8,7 +10,11 @@ module AtreaControl
   class Duplex
     CONTROL_URI = "https://control.atrea.eu/"
 
-    attr_reader :driver
+    attr_reader :current_mode, :current_power, :outdoor_temperature
+    # @return [DateTime] store time of last update
+    attr_reader :valid_for
+
+    attr_accessor :user_id, :unit_id, :auth_token
 
     # @param [String] login
     # @param [String] password
@@ -17,23 +23,43 @@ module AtreaControl
     # @option sensors_map [String] :current_power
     # @option sensors_map [String] :current_mode
     def initialize(login:, password:, sensors_map: Config.default_sensors_map)
-      @logged = false
       @login = login
       @password = password
       @sensors = sensors_map
+    end
+
+    # @return [Selenium::WebDriver::Firefox::Driver]
+    def driver
+      return @driver if defined?(@driver)
 
       options = Selenium::WebDriver::Firefox::Options.new
       options.headless! unless ENV["NO_HEADLESS"]
-      @driver = Selenium::WebDriver.for :firefox, options: options
+      @driver ||= Selenium::WebDriver.for :firefox, capabilities: [options]
     end
 
     def logged?
-      @logged
+      user&.[] "loged"
+    end
+
+    def login_in_progress?
+      @login_in_progress
     end
 
     # Login into control
     def login
+      @login_in_progress = true
+      logger.debug "start new login"
       driver.get CONTROL_URI
+      submit_login_form unless logged?
+      finish_login
+      refresh!
+      inspect
+    ensure
+      @login_in_progress = false
+    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
@@ -42,87 +68,161 @@ module AtreaControl
 
       submit = form.find_element(css: "input[type=submit]")
       submit.click
-      finish_login
-      inspect
     end
 
     # Retrieve dashboard URI from object tag and open it again
     def open_dashboard
       uri = driver.find_element(tag_name: "object").attribute "data"
       driver.get uri
+      user_id && unit_id && auth_token
       logger.debug "#{name} login success"
-      @logged = true
     end
 
     # @return [String]
     def name
-      return unless logged?
+      @name ||= driver.find_element(css: "div#pageTitle > h2")&.text if logged?
+      @name
+    end
 
-      container = driver.find_element css: "div#pageTitle > h2"
-      container.text
+    # # @return [String] ID of logged user
+    # def user_id
+    #   @user_id ||= driver.execute_script("return window._user")
+    # end
+    #
+    # # @return [String] ID of recuperation unit
+    # def unit_id
+    #   @unit_id ||= driver.execute_script("return window._unit")
+    # end
+    #
+    # # @return [String] session token
+    # def auth_token
+    #   @auth_token ||= user&.[]("auth")
+    # end
+
+    # Window.user object from atrea
+    # @return [Hash, nil]
+    def user
+      driver.execute_script("return window.user")
     end
 
-    def unit_id
-      return unless logged?
+    # @return [String]
+    def current_mode_name
+      return current_mode unless logged?
+
+      element = sensor_element(@sensors[:current_mode])
+      element.find_element(css: "div:first-child").text
+    end
 
-      element = driver.find_element css: "div#pageTitle > a"
-      element.attribute(:href) =~ /unit=(\d+)/
-      Regexp.last_match(1)
+    # quit selenium browser
+    def close
+      driver.quit
+    ensure
+      remove_instance_variable :@driver
     end
 
-    # @return [Float]
-    def outdoor_temperature
-      return unless logged?
+    alias logout! close
 
-      element = sensor_element(@sensors[__method__])
-      element.find_element(css: "div").text.to_f
+    def as_json(_options = nil)
+      {
+        current_mode: current_mode,
+        current_power: current_power,
+        outdoor_temperature: outdoor_temperature,
+        valid_for: valid_for,
+      }
     end
 
-    # @return [Float] in %
-    def current_power
-      return unless logged?
+    alias values as_json
 
-      # element = driver.find_element id: "contentBox#{@sensors[__method__]}"
-      element = sensor_element(@sensors[__method__])
-      element.find_element(css: "div:first-child").text.to_f
+    def to_json(*args)
+      as_json.to_json(*args)
     end
 
-    # @return [String]
-    def current_mode
-      return unless logged?
+    # def inspect
+    #   "<AtreaControl name: '#{name}' outdoor_temperature: '#{outdoor_temperature}°C' current_power: '#{current_power}%' current_mode: '#{current_mode}' valid_for: '#{valid_for}'>"
+    # end
 
-      element = sensor_element(@sensors[__method__])
-      element.find_element(css: "div:first-child").text
+    def call_unit!
+      return false if @login_in_progress
+
+      logger.debug "call_unit!"
+      parse_response(response_comm_unit)
+      @valid_for = Time.now
+      as_json
     end
 
-    def inspect
-      "<AtreaControl name: '#{name}' outdoor_temperature: #{outdoor_temperature}°C current_power: #{current_power}% current_mode: '#{current_mode}>'"
+    private
+
+    # @see scripts.php -> loadRD5Values(node, init)
+    # @note
+    #   if(values[key]>32767) values[key]-=65536;
+    # 			if(params[key] && params[key].offset)
+    # 				values[key]=values[key]-params[key].offset;
+    # 			if(params[key] && params[key].coef)
+    # 				values[key]=values[key]/params[key].coef;
+    def parse_response(response)
+      xml = Nokogiri::XML response.body
+      sensors_values = @sensors.transform_values do |id|
+        value = xml.xpath("//O[@I=\"#{id}\"]/@V").last&.value.to_i
+        value -= 65_536 if value > 32_767
+        # value -= 0 if "offset"
+        # value -= 0 if "coef"
+        value
+      end
+      refresh_data(sensors_values)
     end
 
-    def close
-      @logged = false
-      driver.quit
+    # @param [Hash] values
+    # @return [Hash]
+    def refresh_data(values)
+      @outdoor_temperature = values[:outdoor_temperature].to_f / 10.0
+      @current_power = values[:current_power].to_f
+      @current_mode = mode_map[values[:current_mode]]
+
+      as_json
     end
 
-    private
+    # ? I10204 ?
+    def mode_map
+      { 0 => "Vypnuto", 1 => "Automat", 2 => "Větrání", 6 => "Rozvážení" }
+    end
 
     def logger
       @logger ||= ::Logger.new($stdout)
     end
 
-    def sensor_element(sensor_id)
-      driver.find_element id: "contentBox#{sensor_id}"
-    end
-
     def finish_login
-      8.times do |i|
+      13.times do |i|
         return true if open_dashboard
       rescue Selenium::WebDriver::Error::NoSuchElementError => _e
-        t = 5 * (1 + i)
+        t = [3 * (1 + i), 25].min
         logger.debug "waiting #{t}s for login..."
         sleep t
       end
       raise Error, "unable to login"
     end
+
+    def sensor_element(sensor_id)
+      driver.find_element id: "contentBox#{sensor_id}"
+    end
+
+    # @return [RestClient::Response]
+    def response_comm_unit
+      params = {
+        _user: user_id.to_i,
+        _unit: unit_id,
+        auth: auth_token || "null",
+        _t: "config/xml.xml",
+      }
+      autologin_token = CGI.escape([@login, @password].join("\b"))
+      RestClient.get "https://control.atrea.eu/comm/sw/unit.php", { Cookie: "autoLogin=#{autologin_token}", params: params }
+    end
+
+    # Update tokens based on current state
+    def refresh!
+      @user_id = driver.execute_script("return window._user")
+      @unit_id = driver.execute_script("return window._unit")
+      @auth_token = user&.[]("auth")
+    end
+
   end
 end

data/lib/atrea_control/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module AtreaControl
-  VERSION = "1.0.0"
+
+  VERSION = "1.3.0"
+
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: atrea_control
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Lukáš Pokorný
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement