senec 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 527ddd13c38f45eca03b8318f29222d8f4f2fc1d3c34139f1f0642cb10a7db1a
-  data.tar.gz: c277e0d2dd6f68ac0b02f77d36ff3b9dd0bee46206a902c189a1b715975d3c5c
+  metadata.gz: 30ce4b689a7e76c8c2a3c9a1f8657d24aadbcaa981c2e4d6892b5d65c490bd32
+  data.tar.gz: 5d353f3b783dd597fa0481efbcd117461f15bd2ffe174005c00e161b39aee458
 SHA512:
-  metadata.gz: e2013e5206c4ef197828440d7fc3549cfce2b4254b0e22c936edf288e00a7a19e4cec246b9a49f4b19c1979104603bb5f56e7fddf70261153f7c933b94f1c668
-  data.tar.gz: 6d0f15867763036a3edead7450fcfd8a27a3ea5d3a278cbb9960d7225e7d5226bd21d003d83417aa3eee8908f82ae8036437f7aec81f224dd3f085dd0f2623fe
+  metadata.gz: 6621fc5b71d198e428a6b51db406c1e3c5e0e75248d4767c5f9d91fa77235fa2d8866b3cc978adc5fce63c166ca01257b3f904af4d684c0f170bc210011c537b
+  data.tar.gz: 93f57a2a8c265c07670e0c99a8a0b492defa4d3e201c13dd9928d1abbfbb3860fc9d91602b0447b5c6025174a14bfd200fe841ab6e8d687b924a57e4e3bf7ef8

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"
@@ -39,7 +39,7 @@ puts "\n"
 puts "Wallbox charge power: [ #{request.wallbox_charge_power.join(',')} ] W"
 puts "\n"
 puts "Grid power: #{request.grid_power} W"
-puts "Current state of the system: #{request.current_state}"
+puts "Current state of the system: #{request.current_state_code}"
 puts "Measure time: #{Time.at request.measure_time}"
 
 # Example result:
@@ -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/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')
@@ -56,14 +54,14 @@ module Senec
       get('WIZARD', 'APPLICATION_VERSION')
     end
 
-    def current_state
+    def current_state_code
       get('ENERGY', 'STAT_STATE')
     end
 
     def current_state_name
       throw RuntimeError, 'No state names provided!' unless state_names
 
-      state_names[current_state]
+      state_names[current_state_code]
     end
 
     def measure_time
@@ -73,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|
@@ -91,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
+
+    def raw_response
+      @raw_response ||= begin
+        response = connection.post(url, request_body, request_header)
+        raise Senec::Error, response.status unless response.success?
 
-        res.parsed_response
+        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.10.0'.freeze
+  VERSION = '0.12.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.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-27 00:00:00.000000000 Z
+date: 2023-09-24 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:
   - - ">="