senec 0.18.0 → 0.20.0

data/lib/senec/cloud/connection.rb

@@ -1,72 +1,192 @@
+require 'oauth2'
+
 module Senec
   module Cloud
+    CONFIG_URL =
+      'https://sso.senec.com/realms/senec/.well-known/openid-configuration'.freeze
+
+    CLIENT_ID = 'endcustomer-app-frontend'.freeze
+    REDIRECT_URI = 'senec-app-auth://keycloak.prod'.freeze
+    SCOPE = 'roles meinsenec'.freeze
+
+    SYSTEMS_HOST = 'https://senec-app-systems-proxy.prod.senec.dev'.freeze
+    MEASUREMENTS_HOST = 'https://senec-app-measurements-proxy.prod.senec.dev'.freeze
+    WALLBOX_HOST = 'https://senec-app-wallbox-proxy.prod.senec.dev'.freeze
+
     class Connection
-      def initialize(username:, password:, token: nil)
+      DEFAULT_USER_AGENT = "ruby-senec/#{Senec::VERSION} (+https://github.com/solectrus/senec)".freeze
+
+      def initialize(username:, password:, user_agent: DEFAULT_USER_AGENT)
         @username = username
         @password = password
-        @token = token
+        @user_agent = user_agent
       end
 
-      attr_reader :username, :password
+      attr_reader :username, :password, :user_agent
+
+      def authenticate!
+        code_verifier = SecureRandom.alphanumeric(43)
+        digest = Digest::SHA256.digest(code_verifier)
+        code_challenge = Base64.urlsafe_encode64(digest).delete('=')
+
+        auth_url =
+          oauth_client.auth_code.authorize_url(
+            redirect_uri: REDIRECT_URI,
+            scope: SCOPE,
+            code_challenge:,
+            code_challenge_method: 'S256',
+          )
+
+        # Manual HTTP needed for Keycloak cross-domain form handling
+        login_form_url = fetch_login_form_url(auth_url)
+        redirect_url = submit_credentials(login_form_url)
+        authorization_code = extract_authorization_code(redirect_url)
+
+        self.oauth_token =
+          oauth_client.auth_code.get_token(
+            authorization_code,
+            redirect_uri: REDIRECT_URI,
+            code_verifier:,
+          )
+      end
 
       def authenticated?
-        !token.nil?
+        !!oauth_token
       end
 
       def systems
-        get('/v1/senec/systems')
+        fetch_payload "#{SYSTEMS_HOST}/v1/systems"
       end
 
-      def default_system_id
-        raise Error.new('No systems found!', :not_found) if systems.nil?
+      def system_details(system_id)
+        fetch_payload "#{SYSTEMS_HOST}/systems/#{system_id}/details"
+      end
 
-        systems[0]['id']
+      def dashboard(system_id)
+        fetch_payload "#{MEASUREMENTS_HOST}/v1/systems/#{system_id}/dashboard"
       end
 
-      def get(path, params: nil)
-        return_body do
-          connection.get(path, params, { authorization: token })
-        end
+      def wallbox(system_id, wallbox_id)
+        fetch_payload "#{WALLBOX_HOST}/v1/systems/#{system_id}/wallboxes/#{wallbox_id}"
       end
 
-      def post(path, data)
-        return_body do
-          connection.post(path, data)
+      private
+
+      attr_accessor :oauth_token
+
+      def fetch_login_form_url(auth_url)
+        response = http_request(:get, auth_url)
+        store_cookies(response) # Required for Keycloak CSRF protection
+        extract_form_action_url(response.body)
+      end
+
+      def extract_form_action_url(html)
+        forms = html.scan(%r{<form[^>]*action="([^"]+)"[^>]*>(.*?)</form>}mi)
+
+        forms.each do |action_url, form_content|
+          has_username = form_content.match(/name=["']?username["']?/i)
+          has_password = form_content.match(/name=["']?password["']?/i)
+
+          return CGI.unescapeHTML(action_url) if has_username && has_password
         end
+
+        # :nocov:
+        raise 'Login form not found'
+        # :nocov:
       end
 
-      def token
-        @token ||= login['token']
+      def submit_credentials(form_url)
+        credentials = { username:, password: }
+        response = http_request(:post, form_url, data: credentials)
+        raise 'Login failed' unless response.status == 302
+
+        response.headers['location'] || raise('No redirect location')
       end
 
-      private
+      def extract_authorization_code(redirect_url)
+        raise 'Invalid redirect URL' unless redirect_url&.start_with?(REDIRECT_URI)
+
+        uri = URI(redirect_url)
+        params = URI.decode_www_form(uri.query).to_h
+
+        params['code'] || raise('No authorization code found')
+      end
+
+      def ensure_token_valid
+        authenticate! unless authenticated?
+        return true unless oauth_token.expired?
 
-      def login
-        post('/v1/senec/login', { username:, password: })
+        self.oauth_token = oauth_token.refresh!
+        true
+      rescue StandardError => e
+        # :nocov:
+        warn "Token refresh failed: #{e.message}"
+        false
+        # :nocov:
       end
 
-      def connection
-        @connection ||=
-          Faraday.new(url: 'https://app-gateway.prod.senec.dev') do |f|
-            f.request :json
-            f.response :json
+      def fetch_payload(url, default = nil)
+        return default unless ensure_token_valid
+
+        response = oauth_token.get(url)
+        return default unless response.status == 200
+
+        JSON.parse(response.body)
+      rescue StandardError => e
+        # :nocov:
+        warn "API error: #{e.message}"
+        default
+        # :nocov:
+      end
 
-            f.adapter :net_http_persistent, pool_size: 5 do |http|
-              # :nocov:
-              http.idle_timeout = 120
-              # :nocov:
-            end
+      def http_request(method, url, data: nil)
+        Faraday
+          .new
+          .send(method, url) do |req|
+            req.headers['user-agent'] = user_agent
+            req.headers['connection'] = 'keep-alive'
+            req.headers['cookie'] = cookie_string if cookies.any?
+            req.body = URI.encode_www_form(data) if data
           end
       end
 
-      def return_body(&)
-        response = yield
+      def oauth_client
+        @oauth_client ||=
+          OAuth2::Client.new(
+            CLIENT_ID,
+            nil,
+            site: openid_config['issuer'],
+            authorize_url: openid_config['authorization_endpoint'],
+            token_url: openid_config['token_endpoint'],
+          )
+      end
 
-        unless response.success?
-          raise Error.new("Error #{response.status}", response.status)
-        end
+      def openid_config
+        @openid_config ||= JSON.parse(http_request(:get, CONFIG_URL).body)
+      rescue StandardError => e
+        # :nocov:
+        raise "Failed to load OpenID configuration: #{e.message}"
+        # :nocov:
+      end
+
+      def cookies
+        @cookies ||= {}
+      end
 
-        response.body
+      def cookie_string
+        cookies.map { |k, v| "#{k}=#{v}" }.join('; ')
+      end
+
+      def store_cookies(response)
+        set_cookie = response.headers['set-cookie']
+        return unless set_cookie
+
+        set_cookie
+          .split(', ')
+          .each do |cookie_header|
+            name, value = cookie_header.split(';').first.split('=', 2)
+            cookies[name] = value if name && value
+          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/local/connection.rb

@@ -13,6 +13,7 @@ module Senec
       attr_reader :url
 
       extend Forwardable
+
       def_delegators :faraday, :get, :post
 
       private

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.18.0'.freeze
+  VERSION = '0.20.0'.freeze
 end

data/lib/senec.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Georg Ledermann
 bindir: exe
 cert_chain: []
-date: 2025-01-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -51,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Access your local SENEC Solar Battery Storage System
 email:
 - georg@ledermann.dev
@@ -58,19 +72,62 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
+- ".env"
 - ".env.test"
+- ".gitignore"
 - ".rspec"
+- ".rspec_status"
 - ".rubocop.yml"
+- ".ruby-lsp/.gitignore"
+- ".ruby-lsp/Gemfile"
+- ".ruby-lsp/Gemfile.lock"
+- ".ruby-lsp/last_updated"
+- ".ruby-lsp/main_lockfile_hash"
+- ".ruby-lsp/needs_update"
 - ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
 - LICENSE
 - README.md
 - Rakefile
+- 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/local/connection.rb
 - lib/senec/local/constants.rb
 - lib/senec/local/error.rb
@@ -78,6 +135,30 @@ files:
 - lib/senec/local/state.rb
 - lib/senec/local/value.rb
 - lib/senec/version.rb
+- 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.19.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
@@ -100,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home
 test_files: []

data/lib/senec/cloud/dashboard.rb

@@ -1,80 +0,0 @@
-require_relative 'connection'
-
-# Model for the Senec dashboard data.
-#
-# Example use:
-#
-# connection = Senec::Cloud::Connection.new(username: '...', password: '...')
-#
-# # Get the data of a specific system:
-# Dashboard[connection].find('123456').data
-#
-# # Get the data of the default system:
-# Dashboard[connection].first.data
-#
-# By default, it returns v1 data. To get v2 data, use:
-#
-# Dashboard[connection].find('123456').data(version: 'v2')
-# or
-# Dashboard[connection].first.data(version: 'v2')
-#
-module Senec
-  module Cloud
-    class Dashboard
-      AVAILABLE_VERSIONS = %w[v1 v2].freeze
-      DEFAULT_VERSION = 'v1'.freeze
-
-      class Finder
-        def initialize(connection)
-          @connection = connection
-        end
-        attr_reader :connection
-
-        def find(system_id)
-          Dashboard.new(connection:, system_id:)
-        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 = {
-          'v1' => data,
-          'v2' => data
-        }
-      end
-
-      def data(version: DEFAULT_VERSION)
-        @data ||= {}
-        @data[version] ||= fetch_data(version:)
-      end
-
-      attr_reader :system_id
-
-      private
-
-      def get(path, params: nil)
-        @connection.get(path, params:)
-      end
-
-      def fetch_data(version:)
-        raise ArgumentError unless AVAILABLE_VERSIONS.include?(version)
-        return unless system_id
-
-        get("/#{version}/senec/systems/#{system_id}/dashboard")
-      end
-    end
-  end
-end

data/lib/senec/cloud/technical_data.rb

@@ -1,69 +0,0 @@
-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