senec 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c99082ac76970b9dd8c23b3d847c329bae0a1499108cb4da23cc6890db0799c1
-  data.tar.gz: 2a7b3fd24ec219b64ad3345745d3dbe783293327849bf225356d63b3b02a1ca8
+  metadata.gz: 0d619a385d96958f3d69b8486977b64ec6c0d758dff3179138714ba22f7915d5
+  data.tar.gz: 52991e9de034ebeda649ebf48f138d9f3dc71d69d005e25d8e45bcac2bd79804
 SHA512:
-  metadata.gz: 046047abcc8df94341e6da4e1209bd828045a93c0d64f4970b49fdffa41afd88c815194b64372ceee09cacf30dbdacdd12be36a6d6d0bdf40a6b5a8f04a367c7
-  data.tar.gz: 4620d56810a324f10a9a14607afb35f198e6275c77eea18d41aa5ee1339ce0f97e207ba82a5f9d12636bcaacef8709e273dcd8dc1f524bf9b0ea2825b8a06421
+  metadata.gz: af0afea0cbee005eb14a502cc065c8218b5e61ad466c30c32ce9cc912fea3de7471b1c39ae8feef66b29d64af5b63015ae4833e40065157e3fdc67ac141431ad
+  data.tar.gz: 60ecf0d725aa18fa9f80e94cfce90ae164d0118b468b128ec2a8ac5f312cdc578d22d2a8e0f7c12ce9d7b5a08c6dd37aca4de917018fc5806ef0d12c75c9d5e8

data/.github/workflows/push.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.0', '3.1', '3.2']
+        ruby: ['3.2']
 
     steps:
       - name: Checkout the code

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
   - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.2
   NewCops: enable
 
 Style/Documentation:

data/Gemfile

@@ -23,6 +23,3 @@ gem 'rubocop-rake'
 
 # Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests. (https://relishapp.com/vcr/vcr/docs)
 gem 'vcr'
-
-# Library for stubbing HTTP requests in Ruby. (https://github.com/bblimke/webmock)
-gem 'webmock'

data/README.md

@@ -23,8 +23,8 @@ $ gem install senec
 ```ruby
 require 'senec'
 
-senec_ip = '10.0.1.99'
-request = Senec::Request.new host: senec_ip
+connection = Senec::Connection.new(host: '192.168.178.123', schema: 'https')
+request = Senec::Request.new(connection:)
 
 puts "PV production: #{request.inverter_power} W"
 puts "House power consumption: #{request.house_power} W"
@@ -61,17 +61,19 @@ puts "Measure time: #{Time.at request.measure_time}"
 # Measure time: 2021-10-06 17:50:22 +0200
 ```
 
-To get the state name (in German) instead of just the number:
+To get the state name (in English, German or Italian) instead of just the number:
 
 ```ruby
-state_names = Senec::State.new(host: senec_ip).names
-request = Senec::Request.new host: senec_ip, state_names: state_names
+# Get a Hash with all available state names:
+state_names = Senec::State.new(connection:).names(language: :de) # or :en or :it
+# Use this hash for the number => string mapping:
+request = Senec::Request.new(connection:, state_names:)
 
 puts request.current_state_name
 # => "LADEN"
 ```
 
-The state names are extracted on-the-fly from the JavaScript source code returned by the SENEC web interface.
+The state names are extracted from the JavaScript source code returned by the SENEC web interface.
 
 ## Development
 

data/lib/senec/connection.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'faraday/net_http_persistent'
+require 'faraday-request-timer'
+require 'forwardable'
+
+module Senec
+  class Connection
+    def initialize(host:, schema: 'http')
+      @url = "#{schema}://#{host}"
+    end
+
+    extend Forwardable
+    def_delegators :faraday, :get, :post
+
+    private
+
+    def faraday
+      @faraday ||= Faraday.new @url,
+                               ssl: { verify: false },
+                               headers: {
+                                 'Connection' => 'keep-alive'
+                               } do |f|
+        f.request :timer
+        f.adapter :net_http_persistent, pool_size: 5 do |http|
+          http.idle_timeout = 30
+        end
+      end
+    end
+  end
+end

data/lib/senec/constants.rb

@@ -13,6 +13,9 @@ module Senec
       GUI_INVERTER_POWER: '',           # PV production (W)
       STAT_HOURS_OF_OPERATION: ''       # Appliance hours of operation
     },
+    WIZARD: {
+      APPLICATION_VERSION: ''
+    },
     RTC: {
       UTC_OFFSET: '',
       WEB_TIME: ''

data/lib/senec/request.rb

@@ -1,16 +1,14 @@
-require 'httparty'
 require 'senec/value'
 require 'senec/constants'
 
 module Senec
   class Request
-    def initialize(host:, schema: 'http', state_names: nil)
-      @host = host
-      @schema = schema
+    def initialize(connection:, state_names: nil)
+      @connection = connection
       @state_names = state_names
     end
 
-    attr_reader :host, :schema, :state_names
+    attr_reader :connection, :state_names
 
     def house_power
       get('ENERGY', 'GUI_HOUSE_POW')
@@ -52,6 +50,10 @@ module Senec
       get('TEMPMEASURE', 'CASE_TEMP')
     end
 
+    def application_version
+      get('WIZARD', 'APPLICATION_VERSION')
+    end
+
     def current_state
       get('ENERGY', 'STAT_STATE')
     end
@@ -69,10 +71,16 @@ module Senec
       web_time - (utc_offset * 60)
     end
 
+    def response_duration
+      raw_response.env[:duration]
+    end
+
     private
 
     def get(*keys)
-      value = response.dig(*keys)
+      return unless parsed_response
+
+      value = parsed_response.dig(*keys)
 
       if value.is_a?(Array)
         value.map do |v|
@@ -87,24 +95,32 @@ module Senec
       raise Senec::Error, "Decoding failed for #{keys.join('.')}: #{e.message}"
     end
 
-    def response
-      @response ||= begin
-        res = HTTParty.post(
-          url,
-          body: JSON.generate(Senec::BASIC_REQUEST),
-          headers: {
-            'Content-Type' => 'application/x-www-form-urlencoded; charset=UTF-8'
-          },
-          verify: false
-        )
-        raise Senec::Error, res.message.to_s unless res.success?
+    def parsed_response
+      @parsed_response ||= JSON.parse(raw_response.body)
+    end
 
-        res.parsed_response
+    def raw_response
+      @raw_response ||= begin
+        response = connection.post(url, request_body, request_header)
+        raise Senec::Error, response.status unless response.success?
+
+        response
       end
     end
 
     def url
-      "#{schema}://#{host}/lala.cgi"
+      '/lala.cgi'
+    end
+
+    def request_body
+      JSON.generate(Senec::BASIC_REQUEST)
+    end
+
+    def request_header
+      {
+        'Content-Type' => 'application/x-www-form-urlencoded; charset=UTF-8',
+        'Accept' => 'application/json, text/javascript, */*; q=0.01'
+      }
     end
   end
 end

data/lib/senec/state.rb

@@ -1,13 +1,10 @@
-require 'httparty'
-
 module Senec
   class State
-    def initialize(host:, schema: 'http')
-      @host = host
-      @schema = schema
+    def initialize(connection:)
+      @connection = connection
     end
 
-    attr_reader :host, :schema
+    attr_reader :connection
 
     # Extract state names from JavaScript file, which is formatted like this:
     #
@@ -16,8 +13,8 @@ module Senec
     #   1: "SECOND STATE",
     #   ...
     #  };
-    def names
-      response.match(FILE_REGEX)[0].split("\n").each_with_object({}) do |line, hash|
+    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
 
@@ -30,18 +27,25 @@ module Senec
     FILE_REGEX = /var system_state_name = \{(.*?)\};/m
     LINE_REGEX = /(\d+)\s*:\s*"(.*)"/
 
-    def response
-      @response ||= begin
-        res = HTTParty.get url, verify: false
-        raise Senec::Error, res.message unless res.success?
+    def response(language:)
+      res = connection.get url(language:)
+      raise Senec::Error, res.message unless res.success?
 
-        res.body
-      end
+      res.body
     end
 
-    # Use the JavaScript file with German names from the SENEC web interface
-    def url
-      "#{schema}://#{host}/js/DE-de.js"
+    # Use the JavaScript file containing English/German/Italian names from the SENEC web interface
+    def url(language:)
+      case language
+      when :en
+        '/js/EN-en.js'
+      when :de
+        '/js/DE-de.js'
+      when :it
+        '/js/IT-it.js'
+      else
+        raise Senec::Error, "Language #{language} not supported"
+      end
     end
   end
 end

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.11.0'.freeze
 end

data/lib/senec.rb

@@ -1,4 +1,5 @@
 require 'senec/version'
+require 'senec/connection'
 require 'senec/state'
 require 'senec/request'
 

data/senec.gemspec

@@ -10,8 +10,10 @@ Gem::Specification.new do |spec|
   spec.description   = 'Access your local SENEC Solar Battery Storage System'
   spec.homepage      = 'https://github.com/solectrus/senec'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
-  spec.add_runtime_dependency 'httparty'
+  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.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/solectrus/senec'

metadata

@@ -1,17 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday-request-timer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -44,6 +72,7 @@ files:
 - bin/console
 - bin/setup
 - lib/senec.rb
+- lib/senec/connection.rb
 - lib/senec/constants.rb
 - lib/senec/request.rb
 - lib/senec/state.rb
@@ -66,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="