Merge branch 'release/0.10.0'

Author: ledermann

.env.example

@@ -1,10 +1,13 @@
 # IP of your SENEC
 SENEC_HOST=192.168.1.1
-SENEC_SCHEMA=http
+SENEC_SCHEMA=https
 
 # Interval in seconds to get data from SENEC
 SENEC_INTERVAL=5
 
+# Language for retrieving state names
+SENEC_LANGUAGE=de
+
 # Credentials of your InfluxDB installation
 INFLUX_HOST=influxdb.example.com
 INFLUX_SCHEMA=https

.env.test

@@ -1,7 +1,8 @@
 # Example of a SENEC host
-SENEC_HOST=10.0.1.123
-SENEC_SCHEMA=http
+SENEC_HOST=192.168.178.29
+SENEC_SCHEMA=https
 SENEC_INTERVAL=5
+SENEC_LANGUAGE=de
 
 # Example of an InfluxDB host
 INFLUX_HOST=localhost

.github/workflows/push.yml

@@ -18,9 +18,13 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
+    env:
+      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      CI: true
+
     steps:
       - name: Checkout the code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -33,20 +37,26 @@ jobs:
       - name: Run tests
         run: bundle exec rake test
 
+      - name: Send test coverage to CodeClimate
+        uses: paambaati/codeclimate-action@v5.0.0
+        if: ${{ env.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: true
+
   build:
     runs-on: ubuntu-latest
     needs: test
     if: ${{ github.triggering_actor != 'dependabot[bot]' }}
 
     steps:
       - name: Checkout the code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           # list of Docker images to use as base name for tags
           images: |
@@ -61,22 +71,22 @@ jobs:
             type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', 'main') }}
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
         with:
           platforms: linux/amd64,linux/arm64,linux/arm/v7
 
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.CR_PAT }}
 
       - name: Build and push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: .
           platforms: linux/amd64,linux/arm64,linux/arm/v7

.gitignore

@@ -1,2 +1,3 @@
 .env
 .env.development.local
+coverage/

.rubocop.yml

@@ -19,6 +19,9 @@ Style/FrozenStringLiteralComment:
 Metrics/MethodLength:
   Max: 20
 
+Metrics/ClassLength:
+  Enabled: false
+
 Minitest/MultipleAssertions:
   Max: 10
 
@@ -28,5 +31,8 @@ Style/TrailingCommaInArguments:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
 Layout/LineEndStringConcatenationIndentation:
   Enabled: false

Gemfile

@@ -36,4 +36,7 @@ group :development, :test do
 
   # Library for stubbing HTTP requests in Ruby. (https://github.com/bblimke/webmock)
   gem 'webmock'
+
+  # Code coverage for Ruby (https://github.com/simplecov-ruby/simplecov)
+  gem 'simplecov'
 end

Gemfile.lock

@@ -5,20 +5,29 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.1.1)
+    connection_pool (2.4.1)
     crack (0.4.5)
       rexml
+    docile (1.4.0)
     dotenv (2.8.1)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    faraday-net_http_persistent (2.1.0)
+      faraday (~> 2.5)
+      net-http-persistent (~> 4.0)
+    faraday-request-timer (0.2.0)
+      faraday (>= 0.9.0)
     hashdiff (1.0.1)
-    httparty (0.21.0)
-      mini_mime (>= 1.0.0)
-      multi_xml (>= 0.5.2)
     influxdb-client (2.9.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
-    mini_mime (1.1.5)
-    minitest (5.19.0)
-    multi_xml (0.6.0)
-    oj (3.16.0)
+    minitest (5.20.0)
+    net-http-persistent (4.0.2)
+      connection_pool (~> 2.2)
+    oj (3.16.1)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
@@ -29,7 +38,7 @@ GEM
     rake (13.0.6)
     regexp_parser (2.8.1)
     rexml (3.2.6)
-    rubocop (1.56.0)
+    rubocop (1.56.3)
       base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -43,19 +52,28 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-minitest (0.31.0)
+    rubocop-minitest (0.32.2)
       rubocop (>= 1.39, < 2.0)
-    rubocop-performance (1.19.0)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
-    senec (0.9.0)
-      httparty
+    ruby2_keywords (0.0.5)
+    senec (0.12.0)
+      faraday
+      faraday-net_http_persistent
+      faraday-request-timer
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     unicode-display_width (2.4.2)
     vcr (6.2.0)
-    webmock (3.18.1)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -74,8 +92,9 @@ DEPENDENCIES
   rubocop-performance
   rubocop-rake
   senec
+  simplecov
   vcr
   webmock
 
 BUNDLED WITH
-   2.4.19
+   2.4.20

README.md

@@ -1,5 +1,7 @@
 [![Continuous integration](https://github.com/solectrus/senec-collector/actions/workflows/push.yml/badge.svg)](https://github.com/solectrus/senec-collector/actions/workflows/push.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ae0d21c0c4eb9c430505/maintainability)](https://codeclimate.com/github/solectrus/senec-collector/maintainability)
 [![wakatime](https://wakatime.com/badge/user/697af4f5-617a-446d-ba58-407e7f3e0243/project/e8426066-7e79-40d8-8d8b-583dd965720a.svg)](https://wakatime.com/badge/user/697af4f5-617a-446d-ba58-407e7f3e0243/project/e8426066-7e79-40d8-8d8b-583dd965720a)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ae0d21c0c4eb9c430505/test_coverage)](https://codeclimate.com/github/solectrus/senec-collector/test_coverage)
 
 # SENEC collector
 

Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'bundler'
 require 'rake/testtask'
 require 'dotenv'
-Dotenv.load('.env', '.env.test')
+Dotenv.load('.env.test')
 
 Rake::TestTask.new :test do |t|
   t.libs << 'test' << 'app'

app/config.rb

@@ -3,6 +3,7 @@
     :senec_host,
     :senec_schema,
     :senec_interval,
+    :senec_language,
     :influx_schema,
     :influx_host,
     :influx_port,
@@ -24,20 +25,15 @@ def influx_url
       "#{influx_schema}://#{influx_host}:#{influx_port}"
     end
 
-    def senec_state_names
-      @senec_state_names ||=
-        begin
-          puts 'Getting state names from SENEC by parsing source code...'
-          names = Senec::State.new(host: senec_host, schema: senec_schema).names
-          puts "OK, got #{names.length} state names"
-          names
-        end
-    end
-
     def senec_url
       "#{senec_schema}://#{senec_host}"
     end
 
+    def senec_connection
+      @senec_connection ||=
+        Senec::Connection.new(host: senec_host, schema: senec_schema)
+    end
+
     private
 
     def validate_interval!(interval)
@@ -59,6 +55,7 @@ def self.from_env(options = {})
           senec_host: ENV.fetch('SENEC_HOST'),
           senec_schema: ENV.fetch('SENEC_SCHEMA', 'http'),
           senec_interval: ENV.fetch('SENEC_INTERVAL').to_i,
+          senec_language: ENV.fetch('SENEC_LANGUAGE', 'de').to_sym,
           influx_host: ENV.fetch('INFLUX_HOST'),
           influx_schema: ENV.fetch('INFLUX_SCHEMA', 'http'),
           influx_port: ENV.fetch('INFLUX_PORT', '8086'),