senec 0.17.2 → 0.19.0

data/lib/senec/cloud/connection.rb

@@ -1,72 +1,129 @@
+require 'faraday'
+require 'json'
+
 module Senec
   module Cloud
+    BASE_URL = 'https://mein-senec.de'.freeze
+
     class Connection
-      def initialize(username:, password:, token: nil)
+      DEFAULT_USER_AGENT = "ruby-senec/#{Senec::VERSION} (+https://github.com/solectrus/senec)".freeze
+      MAX_REDIRECTS = 10
+
+      def initialize(username:, password:, user_agent: DEFAULT_USER_AGENT)
         @username = username
         @password = password
-        @token = token
+        @user_agent = user_agent
+        @cookies = {}
       end
 
-      attr_reader :username, :password
+      attr_reader :username, :password, :user_agent, :cookies
 
       def authenticated?
-        !token.nil?
-      end
+        authenticate if cookies.empty?
 
-      def systems
-        get('/v1/senec/systems')
+        cookies.key?('sso.senec.com_KEYCLOAK_IDENTITY')
       end
 
-      def default_system_id
-        raise Error.new('No systems found!', :not_found) if systems.nil?
+      def authenticate
+        response = request_with_redirects(Cloud::BASE_URL)
+
+        # Find form with username and password inputs
+        form_match = find_login_form(response.body)
+        raise Error, 'Login form not found!' unless form_match
 
-        systems[0]['id']
+        # Perform the login request with the extracted form action URL
+        form_action = form_match.gsub('&', '&')
+        request_with_redirects(
+          form_action, {
+            'username' => username,
+            'password' => password
+          },
+        )
       end
 
-      def get(path, params: nil)
-        return_body do
-          connection.get(path, params, { authorization: token })
-        end
+      def simple_request(url)
+        perform_request(url)
       end
 
-      def post(path, data)
-        return_body do
-          connection.post(path, data)
+      def request_with_redirects(url, data = nil)
+        uri = URI(url)
+        redirect_count = 0
+        response = nil
+
+        loop do
+          response = perform_request(uri.to_s, data)
+          store_cookies(response)
+
+          break unless (300..399).cover?(response.status)
+
+          location = response.headers['location']
+          break unless location
+
+          redirect_count += 1
+          raise 'Too many redirects!' if redirect_count > MAX_REDIRECTS
+
+          uri = location.start_with?('http') ? URI(location) : URI.join(uri, location)
+          data = nil # Clear data after first request (no POST redirects)
         end
-      end
 
-      def token
-        @token ||= login['token']
+        response
       end
 
       private
 
-      def login
-        post('/v1/senec/login', { username:, password: })
+      def find_login_form(html_body)
+        # Find all forms and check if they contain both username and password inputs
+        html_body.scan(%r{<form[^>]*action="([^"]+)"[^>]*>(.*?)</form>}m).each do |action, form_content|
+          has_username = form_content.match(/input[^>]*name=["']username["'][^>]*/)
+          has_password = form_content.match(/input[^>]*name=["']password["'][^>]*/)
+
+          return action if has_username && has_password
+        end
+
+        # :nocov:
+        nil
+        # :nocov:
       end
 
-      def connection
-        @connection ||=
-          Faraday.new(url: 'https://app-gateway.prod.senec.dev') do |f|
-            f.request :json
-            f.response :json
-
-            f.adapter :net_http_persistent, pool_size: 5 do |http|
-              # :nocov:
-              http.idle_timeout = 120
-              # :nocov:
-            end
+      def faraday
+        @faraday ||= Faraday.new do |f|
+          f.adapter :net_http_persistent, pool_size: 1 do |http|
+            # :nocov:
+            http.idle_timeout = 400
+            # :nocov:
           end
+        end
       end
 
-      def return_body(&)
-        response = yield
-
-        unless response.success?
-          raise Error.new("Error #{response.status}", response.status)
+      def perform_request(url, data = nil)
+        method = data ? :post : :get
+        faraday.public_send(method, url) do |req|
+          configure_request_headers(req)
+          if method == :post
+            req.body = URI.encode_www_form(data)
+            req.headers['content-type'] = 'application/x-www-form-urlencoded'
+          end
         end
+      end
+
+      def configure_request_headers(request)
+        request.headers['user-agent'] = user_agent
+        request.headers['connection'] = 'keep-alive'
+        request.headers['cookie'] = cookies.values.join('; ') unless cookies.empty?
+      end
 
-        response.body
+      def store_cookies(response)
+        host = URI(response.env.url).host
+        cookie_header = response.headers['set-cookie']
+        return unless cookie_header
+
+        Array(cookie_header).each do |cookie_string|
+          cookie_string.split(', ').each do |cookie|
+            cookie_name = cookie.split('=').first
+            cookie_value = cookie.split(';').first
+            @cookies["#{host}_#{cookie_name}"] = cookie_value
+          end
+        end
       end
     end
   end

data/lib/senec/cloud/error.rb

@@ -1,12 +1,6 @@
 module Senec
   module Cloud
     class Error < StandardError
-      attr_reader :status
-
-      def initialize(message, status)
-        super(message)
-        @status = status
-      end
     end
   end
 end

data/lib/senec/cloud/stats_overview.rb

@@ -0,0 +1,52 @@
+require_relative 'connection'
+require 'net/http'
+require 'json'
+
+# Model for the Senec statistics overview data.
+#
+# Example use:
+#
+# connection = Senec::Cloud::Connection.new(username: '...', password: '...')
+#
+# # Get the data of a specific system:
+# Senec::Cloud::StatsOverview.new(connection:, system_id: 1).data
+#
+# # Get the data of the default system (system_id 0):
+# Senec::Cloud::StatsOverview.new(connection:).data
+#
+module Senec
+  module Cloud
+    class StatsOverview
+      PATH = '/endkunde/api/status/getstatusoverview.php'.freeze
+
+      def initialize(connection: nil, system_id: 0)
+        raise ArgumentError unless connection
+
+        @connection = connection
+        @system_id = system_id
+      end
+
+      attr_reader :connection, :system_id
+
+      def data
+        @data ||= fetch_data
+      end
+
+      private
+
+      def fetch_data
+        connection.authenticate unless connection.authenticated?
+
+        uri = URI("#{Cloud::BASE_URL}#{PATH}")
+        uri.query = URI.encode_www_form(anlageNummer: system_id)
+
+        response = connection.simple_request(uri.to_s)
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        # :nocov:
+        raise Error, "Failed to parse response from #{PATH}"
+        # :nocov:
+      end
+    end
+  end
+end

data/lib/senec/cloud/wallboxes.rb

@@ -0,0 +1,52 @@
+require_relative 'connection'
+require 'net/http'
+require 'json'
+
+# Model for the Senec wallboxes data.
+#
+# Example use:
+#
+# connection = Senec::Cloud::Connection.new(username: '...', password: '...')
+#
+# # Get the data of a specific system:
+# Senec::Cloud::Wallboxes.new(connection:, system_id: 1).data
+#
+# # Get the data of the default system (system_id 0):
+# Senec::Cloud::Wallboxes.new(connection:).data
+#
+module Senec
+  module Cloud
+    class Wallboxes
+      PATH = '/endkunde/api/wallboxes'.freeze
+
+      def initialize(connection: nil, system_id: 0)
+        raise ArgumentError unless connection
+
+        @connection = connection
+        @system_id = system_id
+      end
+
+      attr_reader :connection, :system_id
+
+      def data
+        @data ||= fetch_data
+      end
+
+      private
+
+      def fetch_data
+        connection.authenticate unless connection.authenticated?
+
+        uri = URI("#{Cloud::BASE_URL}#{PATH}")
+        uri.query = URI.encode_www_form(anlageNummer: system_id)
+
+        response = connection.simple_request(uri.to_s)
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        # :nocov:
+        raise Error, "Failed to parse response from #{PATH}"
+        # :nocov:
+      end
+    end
+  end
+end

data/lib/senec/local/request.rb

@@ -12,7 +12,7 @@ module Senec
 
       attr_reader :connection, :body, :state_names
 
-      def perform!
+      def perform! # rubocop:disable Naming/PredicateMethod
         parsed_response
         true
       end

data/lib/senec/local/state.rb

@@ -39,6 +39,7 @@ module Senec
       # 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
+      private_constant :FILE_REGEX
 
       def response(language:)
         res = connection.get url(language:)

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.17.2'.freeze
+  VERSION = '0.19.0'.freeze
 end

data/lib/senec.rb

@@ -4,6 +4,6 @@ require 'senec/local/state'
 require 'senec/local/request'
 require 'senec/local/error'
 
-require 'senec/cloud/dashboard'
-require 'senec/cloud/technical_data'
+require 'senec/cloud/stats_overview'
+require 'senec/cloud/wallboxes'
 require 'senec/cloud/error'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.19.0
 platform: ruby
 authors:
 - Georg Ledermann
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,24 +58,63 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
+- ".env"
 - ".env.test"
-- ".github/workflows/push.yml"
 - ".gitignore"
 - ".rspec"
+- ".rspec_status"
 - ".rubocop.yml"
+- ".ruby-lsp/.gitignore"
+- ".ruby-lsp/Gemfile"
+- ".ruby-lsp/Gemfile.lock"
+- ".ruby-lsp/main_lockfile_hash"
+- ".ruby-lsp/needs_update"
 - ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- coverage/.last_run.json
+- coverage/.resultset.json
+- coverage/.resultset.json.lock
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_asc.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_asc_disabled.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_both.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_desc.png
+- coverage/assets/0.13.2/DataTables-1.10.20/images/sort_desc_disabled.png
+- coverage/assets/0.13.2/application.css
+- coverage/assets/0.13.2/application.js
+- coverage/assets/0.13.2/colorbox/border.png
+- coverage/assets/0.13.2/colorbox/controls.png
+- coverage/assets/0.13.2/colorbox/loading.gif
+- coverage/assets/0.13.2/colorbox/loading_background.png
+- coverage/assets/0.13.2/favicon_green.png
+- coverage/assets/0.13.2/favicon_red.png
+- coverage/assets/0.13.2/favicon_yellow.png
+- coverage/assets/0.13.2/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.13.2/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.13.2/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.13.2/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.13.2/images/ui-icons_222222_256x240.png
+- coverage/assets/0.13.2/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.13.2/images/ui-icons_454545_256x240.png
+- coverage/assets/0.13.2/images/ui-icons_888888_256x240.png
+- coverage/assets/0.13.2/images/ui-icons_cd0a0a_256x240.png
+- coverage/assets/0.13.2/loading.gif
+- coverage/assets/0.13.2/magnify.png
+- coverage/coverage.json
+- coverage/index.html
+- lib/.DS_Store
 - lib/senec.rb
 - lib/senec/cloud/connection.rb
-- lib/senec/cloud/dashboard.rb
 - lib/senec/cloud/error.rb
-- lib/senec/cloud/technical_data.rb
+- lib/senec/cloud/stats_overview.rb
+- lib/senec/cloud/wallboxes.rb
 - lib/senec/local/connection.rb
 - lib/senec/local/constants.rb
 - lib/senec/local/error.rb
@@ -84,7 +122,29 @@ files:
 - lib/senec/local/state.rb
 - lib/senec/local/value.rb
 - lib/senec/version.rb
-- senec.gemspec
+- pkg/senec-0.1.0.gem
+- pkg/senec-0.10.0.gem
+- pkg/senec-0.11.0.gem
+- pkg/senec-0.12.0.gem
+- pkg/senec-0.13.0.gem
+- pkg/senec-0.14.0.gem
+- pkg/senec-0.15.0.gem
+- pkg/senec-0.17.0.gem
+- pkg/senec-0.17.1.gem
+- pkg/senec-0.17.2.gem
+- pkg/senec-0.18.0.gem
+- pkg/senec-0.2.0.gem
+- pkg/senec-0.3.0.gem
+- pkg/senec-0.4.0.gem
+- pkg/senec-0.5.0.gem
+- pkg/senec-0.6.0.gem
+- pkg/senec-0.6.1.gem
+- pkg/senec-0.6.2.gem
+- pkg/senec-0.7.0.gem
+- pkg/senec-0.7.1.gem
+- pkg/senec-0.7.2.gem
+- pkg/senec-0.8.0.gem
+- pkg/senec-0.9.0.gem
 homepage: https://github.com/solectrus/senec
 licenses:
 - MIT
@@ -93,7 +153,6 @@ metadata:
   source_code_uri: https://github.com/solectrus/senec
   changelog_uri: https://github.com/solectrus/senec/releases
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home
 test_files: []

data/.github/workflows/push.yml

@@ -1,37 +0,0 @@
-name: Continuous integration
-
-on: push
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ['3.2', '3.3']
-
-    env:
-      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-
-    steps:
-      - name: Checkout the code
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: ${{ matrix.ruby }}
-
-      - name: Lint with RuboCop
-        run: bundle exec rubocop
-
-      - name: Run tests
-        run: bundle exec dotenv -f ".env.test" rspec
-
-      - name: Send test coverage to CodeClimate
-        uses: paambaati/codeclimate-action@v8
-        if: ${{ env.CC_TEST_REPORTER_ID }}
-        with:
-          coverageCommand: true

data/Gemfile

@@ -1,43 +0,0 @@
-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.13.0 (http://github.com/rspec)
-gem 'rspec'
-
-# Automatic Ruby code style checking tool. (https://github.com/rubocop/rubocop)
-gem 'rubocop', require: false
-
-# Automatic performance checking tool for Ruby code. (https://github.com/rubocop/rubocop-performance)
-gem 'rubocop-performance', require: false
-
-# Code style checking for RSpec files (https://github.com/rubocop/rubocop-rspec)
-gem 'rubocop-rspec', require: false
-
-# A RuboCop plugin for Rake (https://github.com/rubocop/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
-
-# Loads environment variables from `.env`. (https://github.com/bkeepers/dotenv)
-gem 'dotenv'
-
-# Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests. (https://benoittgt.github.io/vcr)
-gem 'vcr'
-
-# Code coverage for Ruby (https://github.com/simplecov-ruby/simplecov)
-gem 'simplecov'
-
-# Library for stubbing HTTP requests in Ruby. (https://github.com/bblimke/webmock)
-gem 'webmock'

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'senec'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# 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 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here