senec 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adfa786a844f0a43a8e3a87763249da55e2e6165e80600ada958fe7aed674d32
-  data.tar.gz: ff9d52cc6e3fd5be19d49d474ee145526cbe0930438859b05423c92163b95274
+  metadata.gz: 1b624e179ea03733c86e4cbe7c93221809921317a274f33fd291ae007dafec2e
+  data.tar.gz: 4c96d04accfa2f6a091ffa0051a939c9d2e5f69196a0f45b6a33a24c50b80de7
 SHA512:
-  metadata.gz: c7b507db12c1b6712da5ba93b2780ac34b31c0ff5c108714d0b540f1e43a270ee30f4f4de234c5948e29a1b2d28f872aed1590f87945b6ac56e7e32b80ee7d43
-  data.tar.gz: c2739c6d4ef96c3d359e1d0a1398a5ce07363517db15c6032fb339aadbe802758751149af0f4d4d1b58e3d9a649367ed82667905a68259b7bce0ae3fc373f29a
+  metadata.gz: 9f3e1c33b8240d88495faef212b811b4301718a84ddc1b1b994ed07a7c08653db49046b185ff42490308e29afca2a59b9a0cec0a0eeed390fbe785c6d78bd864
+  data.tar.gz: 111937617cf40d17e6b850b158918c93a0cd661f7d8231483685b2048f5df8a91fa4780aa228fb136e2945c6ef6eb33bbfc1dbb9987b9fd9e033e984f443912b

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 }}

data/Gemfile

@@ -3,6 +3,12 @@ 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'
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020,2023 Georg Ledermann
+Copyright (c) 2020-2024 Georg Ledermann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.14.0'.freeze
+  VERSION = '0.15.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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-13 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -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.5
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home