senec 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adfa786a844f0a43a8e3a87763249da55e2e6165e80600ada958fe7aed674d32
-  data.tar.gz: ff9d52cc6e3fd5be19d49d474ee145526cbe0930438859b05423c92163b95274
+  metadata.gz: b3e63fe0591b80a7672ba4a6b0374ec573f764040bfbf487b941afea116291b0
+  data.tar.gz: 8251e37f00a8239bb366c6ac09dbedc53ec6353d702dc473c87bf6fbcf6e9d68
 SHA512:
-  metadata.gz: c7b507db12c1b6712da5ba93b2780ac34b31c0ff5c108714d0b540f1e43a270ee30f4f4de234c5948e29a1b2d28f872aed1590f87945b6ac56e7e32b80ee7d43
-  data.tar.gz: c2739c6d4ef96c3d359e1d0a1398a5ce07363517db15c6032fb339aadbe802758751149af0f4d4d1b58e3d9a649367ed82667905a68259b7bce0ae3fc373f29a
+  metadata.gz: 59e850b996a75f2c3046c8ee3bca754d2aca77946c22e8e6c405dbe6b11034099f16c270e7522a092247d1530c124a87fed1d1387447f2c91e93097b06bf3b34
+  data.tar.gz: 7c81e4ffc43770c93f494a82bb5edc485327df7e357f592c8ce90bc9336ed37ad996303fbca98f6066e8cce2644083e2977fe1d248bf193166b1098e0d225aea

data/.env.test

@@ -1,3 +1,6 @@
 SENEC_USERNAME=mail@example.com
 SENEC_PASSWORD=topsecret
 SENEC_SYSTEM_ID=123456
+
+SENEC_HOST=senec
+SENEC_SCHEMA=https

data/.github/workflows/push.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.2']
+        ruby: ['3.2', '3.3']
 
     env:
       CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
@@ -31,7 +31,7 @@ jobs:
         run: bundle exec dotenv -f ".env.test" rspec
 
       - name: Send test coverage to CodeClimate
-        uses: paambaati/codeclimate-action@v5.0.0
+        uses: paambaati/codeclimate-action@v8
         if: ${{ env.CC_TEST_REPORTER_ID }}
         with:
           coverageCommand: true

data/.vscode/settings.json

@@ -1,16 +1,9 @@
 {
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "editor.tabSize": 2,
 
   "files.trimTrailingWhitespace": true,
 
-  "ruby.lint": {
-    "rubocop": {
-      "forceExclusion": true
-    }
-  },
-
   "[ruby]": {
     "editor.defaultFormatter": "Shopify.ruby-lsp",
     "editor.formatOnSave": true

data/CODE_OF_CONDUCT.md

@@ -2,73 +2,131 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-Examples of unacceptable behavior by participants include:
+## Our Standards
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at georg@ledermann.dev. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -3,23 +3,29 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in senec.gemspec
 gemspec
 
+# Support for encoding and decoding binary data using a Base64 representation. (https://github.com/ruby/base64)
+gem 'base64'
+
+# Arbitrary-precision decimal floating-point number library. (https://github.com/ruby/bigdecimal)
+gem 'bigdecimal'
+
 # Rake is a Make-like program implemented in Ruby (https://github.com/ruby/rake)
 gem 'rake'
 
-# rspec-3.12.0 (http://github.com/rspec)
+# rspec-3.13.0 (http://github.com/rspec)
 gem 'rspec'
 
 # Automatic Ruby code style checking tool. (https://github.com/rubocop/rubocop)
-gem 'rubocop'
+gem 'rubocop', require: false
 
 # Automatic performance checking tool for Ruby code. (https://github.com/rubocop/rubocop-performance)
-gem 'rubocop-performance'
+gem 'rubocop-performance', require: false
 
 # Code style checking for RSpec files (https://github.com/rubocop/rubocop-rspec)
-gem 'rubocop-rspec'
+gem 'rubocop-rspec', require: false
 
 # A RuboCop plugin for Rake (https://github.com/rubocop/rubocop-rake)
-gem 'rubocop-rake'
+gem 'rubocop-rake', require: false
 
 # Thread-safety checks via static analysis (https://github.com/rubocop/rubocop-thread_safety)
 gem 'rubocop-thread_safety', require: false

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2020,2023 Georg Ledermann
+Copyright (c) 2020-2024 Georg Ledermann <georg@ledermann.dev>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -36,7 +36,7 @@ puts connection.systems
 
 # => [{"id"=>"123456", "steuereinheitnummer"=>"S123XXX", "gehaeusenummer"=>"DE-V3-XXXX", "strasse"=>"Musterstraße", "hausnummer"=>"27a", "postleitzahl"=>"99999", "ort"=>"Musterort", "laendercode"=>"DE", "zeitzone"=>"Europe/Berlin", "wallboxIds"=>["1"], "systemType"=>"V3"}]
 
-# Get the data of first systems (without knowing the ID):
+# Get the Dashboard data of first systems (without knowing the ID):
 puts Senec::Cloud::Dashboard[connection].first.data
 
 # => {"aktuell"=>
@@ -62,13 +62,24 @@ puts Senec::Cloud::Dashboard[connection].first.data
 #  "zeitstempel"=>"2023-11-26T18:45:23Z",
 #  "electricVehicleConnected"=>false}
 
-
-# Get the data of a specific system (by ID):
-puts Senc::Cloud::Dashboard[connection].find("123456").data
+# Get the Dashboard data of a specific system (by ID):
+puts Senec::Cloud::Dashboard[connection].find("123456").data
 
 # => {"aktuell"=>
 #   {"stromerzeugung"=>{"wert"=>0.01, "einheit"=>"W"},
 # ....
+
+# Get the Technical Data of a specific system (by ID):
+
+puts Senec::Cloud::TechnicalData[connection].find("123456").data
+
+# => {"systemOverview"=>{"systemId"=>123456, "productName"=>"SENEC.Home V3 hybrid duo", ...
+
+# Get the Technical Data of first systems (without knowing the ID):
+
+puts Senec::Cloud::TechnicalData[connection].first.data
+
+# => {"systemOverview"=>{"systemId"=>123456, "productName"=>"SENEC.Home V3 hybrid duo", ...
 ```
 
 ### Local access (V2.1 and V3 only)
@@ -142,7 +153,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/solect
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-Copyright (c) 2020,2023 Georg Ledermann
+Copyright (c) 2020-2024 Georg Ledermann
 
 ## Code of Conduct
 

data/lib/senec/cloud/connection.rb

@@ -1,9 +1,10 @@
 module Senec
   module Cloud
     class Connection
-      def initialize(username:, password:)
+      def initialize(username:, password:, token: nil)
         @username = username
         @password = password
+        @token = token
       end
 
       attr_reader :username, :password
@@ -34,12 +35,12 @@ module Senec
         end
       end
 
-      private
-
       def token
         @token ||= login['token']
       end
 
+      private
+
       def login
         post('/v1/senec/login', { username:, password: })
       end

data/lib/senec/cloud/technical_data.rb

@@ -0,0 +1,69 @@
+require_relative 'connection'
+
+# Model for the Senec technical data.
+#
+# Example use:
+#
+# connection = Senec::Cloud::Connection.new(username: '...', password: '...')
+#
+# # Get the data of a specific system:
+# TechnicalData[connection].find('123456')
+#
+# # Get the data of the default system:
+# TechnicalData[connection].first
+#
+module Senec
+  module Cloud
+    class TechnicalData
+      class Finder
+        def initialize(connection)
+          @connection = connection
+        end
+        attr_reader :connection
+
+        def find(system_id)
+          TechnicalData.new(connection:, system_id:).tap(&:load_data)
+        end
+
+        def first
+          find(connection.default_system_id)
+        end
+      end
+
+      def self.[](connection)
+        Finder.new(connection)
+      end
+
+      def initialize(connection: nil, system_id: nil, data: nil)
+        raise ArgumentError unless connection.nil? ^ data.nil?
+
+        @connection = connection
+        @system_id = system_id
+
+        # Useful for testing only
+        @data = data
+      end
+
+      def load_data
+        raise 'Data already present!' if @data
+
+        @system_id ||= connection.default_system_id
+        @data = fetch_data
+      end
+
+      attr_reader :system_id, :data
+
+      private
+
+      def get(path, params: nil)
+        @connection.get(path, params:)
+      end
+
+      def fetch_data
+        return unless system_id
+
+        get("/v1/senec/systems/#{system_id}/technical-data")
+      end
+    end
+  end
+end

data/lib/senec/local/state.rb

@@ -15,18 +15,30 @@ module Senec
       #   ...
       #  };
       def names(language: :de)
-        response(language:).match(FILE_REGEX)[0].split("\n").each_with_object({}) do |line, hash|
-          key, value = line.match(LINE_REGEX)&.captures
-          next unless key && value
+        js_content = response(language:)
 
-          hash[key.to_i] = value
-        end
+        # Extract the matched content
+        match = js_content.match(FILE_REGEX)
+        return unless match
+
+        # Extract the JSON-like part
+        json_like = "{#{match[1]}}"
+
+        # The keys are numbers, which is not valid JSON, so we need to convert them to strings
+        json = json_like.gsub(/(\d+)\s*:/, '"\1":')
+
+        # Convert the JSON string to a Ruby hash
+        hash = JSON.parse(json)
+
+        # Convert keys from strings to integers
+        hash.transform_keys(&:to_i)
       end
 
       private
 
-      FILE_REGEX = /var system_state_name = \{(.*?)\};/m
-      LINE_REGEX = /(\d+)\s*:\s*"(.*)"/
+      # Regex pattern to match the system_state_name definition in the JavaScript file
+      # The file may be minimized, so we need to be flexible with whitespace and line breaks
+      FILE_REGEX = /system_state_name\s*=\s*{\s*([^}]*)\s*}/m
 
       def response(language:)
         res = connection.get url(language:)

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.14.0'.freeze
+  VERSION = '0.16.0'.freeze
 end

data/lib/senec.rb

@@ -5,4 +5,5 @@ require 'senec/local/request'
 require 'senec/local/error'
 
 require 'senec/cloud/dashboard'
+require 'senec/cloud/technical_data'
 require 'senec/cloud/error'

data/senec.gemspec

@@ -11,9 +11,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/solectrus/senec'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 3.2.0')
-  spec.add_runtime_dependency 'faraday'
-  spec.add_runtime_dependency 'faraday-net_http_persistent'
-  spec.add_runtime_dependency 'faraday-request-timer'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday-net_http_persistent'
+  spec.add_dependency 'faraday-request-timer'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/solectrus/senec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-13 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -67,7 +67,7 @@ files:
 - ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -76,6 +76,7 @@ files:
 - lib/senec/cloud/connection.rb
 - lib/senec/cloud/dashboard.rb
 - lib/senec/cloud/error.rb
+- lib/senec/cloud/technical_data.rb
 - lib/senec/local/connection.rb
 - lib/senec/local/constants.rb
 - lib/senec/local/error.rb
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home