gem: release 3.2.1

- prevents 'undefined method each_with_index for nil:NilClass' errors

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+---
+name: ci
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+  schedule:
+  - cron: '35 4 * * 4'  # weekly on thursday morning
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - '2.5'
+        - '2.6'
+        - '2.7'
+        - '3.0'
+        - '3.1'
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true  # runs 'bundle install' and caches installed gems automatically
+    - name: Lint and Test
+      run: |
+        bundle exec rake ci

.rubocop.yml

@@ -1,7 +1,14 @@
+require:
+- rubocop-rake
+- rubocop-rspec
+
 AllCops:
   TargetRubyVersion: '2.5'
   NewCops: enable
 
+Gemspec/RequireMFA:
+  Enabled: false
+
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
@@ -86,3 +93,13 @@ Style/Semicolon:
 
 Style/SymbolArray:
   Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/FilePath:
+  CustomTransform:
+    OpenVPNStatusWeb: openvpn-status-web
+
+RSpec/MultipleExpectations:
+  Max: 5

.travis.yml

@@ -1,10 +0,0 @@
----
-os: linux
-language: ruby
-rvm:
-- 2.7
-- 2.6
-- 2.5
-
-script:
-- bundle exec rake travis

README.md

@@ -1,6 +1,6 @@
 # openvpn-status-web
 
-[![Build Status](https://travis-ci.org/cmur2/openvpn-status-web.svg?branch=master)](https://travis-ci.org/cmur2/openvpn-status-web) [![Depfu](https://badges.depfu.com/badges/c264e2f70f2a19c43f880ddcb4a12ba8/overview.svg)](https://depfu.com/github/cmur2/openvpn-status-web?project_id=6194)
+![ci](https://github.com/cmur2/openvpn-status-web/workflows/ci/badge.svg) [![Depfu](https://badges.depfu.com/badges/c264e2f70f2a19c43f880ddcb4a12ba8/overview.svg)](https://depfu.com/github/cmur2/openvpn-status-web?project_id=6194)
 
 ## Description
 

Rakefile

@@ -9,16 +9,19 @@ RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 Bundler::Audit::Task.new
 
-desc 'Should be run by developer once to prepare initial solargraph usage (fill caches etc.)'
-task :'solargraph:init' do
-  sh 'solargraph download-core'
-end
-
 desc 'Run experimental solargraph type checker'
-task :'solargraph:tc' do
+task :solargraph do
   sh 'solargraph typecheck'
 end
 
-task default: [:rubocop, :spec, 'bundle:audit']
+namespace :solargraph do
+  desc 'Should be run by developer once to prepare initial solargraph usage (fill caches etc.)'
+  task :init do
+    sh 'solargraph download-core'
+  end
+end
 
-task travis: [:default, :'solargraph:init', :'solargraph:tc']
+task default: [:rubocop, :spec, 'bundle:audit', :solargraph]
+
+desc 'Run all tasks desired for CI'
+task ci: ['solargraph:init', :default]

docs/Dockerfile

@@ -1,8 +1,8 @@
-FROM alpine:3.12
+FROM alpine:3.13
 
 EXPOSE 8080
 
-ENV VERSION=3.0.1
+ENV VERSION=3.2.1
 
 RUN apk --no-cache add openssl ca-certificates && \
     apk --no-cache add ruby ruby-etc ruby-webrick && \

examples/status.v2

@@ -1,8 +1,8 @@
 TITLE,OpenVPN 2.1_rc15 mipsel-unknown-linux-gnu [SSL] [LZO1] [EPOLL] built on Mar 27 2009
 TIME,Sun Jan 1 23:42:00 2012,1238702330
 HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t)
-CLIENT_LIST,foo,1.2.3.4:1234,11811160064,4194304,Sun Jan 1 23:42:00 2012,1238702330
+CLIENT_LIST,foo,1.2.3.4:1234,192.168.66.2,11811160064,4194304,Sun Jan 1 23:42:00 2012,1238702330
-CLIENT_LIST,bar,1.2.3.5:1235,512,2048,Sun Jan 1 23:42:00 2012,1238702330
+CLIENT_LIST,bar,1.2.3.5:1235,2001:db8:0:0::1000,512,2048,Sun Jan 1 23:42:00 2012,1238702330
 HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)
 ROUTING_TABLE,192.168.0.0/24,foo,1.2.3.4:1234,Sun Jan 1 23:42:00 2012,1238702330
 ROUTING_TABLE,192.168.66.2,bar,1.2.3.5:1235,Sun Jan 1 23:42:00 2012,1238702330

examples/status.v3

@@ -1,8 +1,8 @@
 TITLE	OpenVPN 2.1_rc15 mipsel-unknown-linux-gnu [SSL] [LZO1] [EPOLL] built on Mar 27 2009
 TIME	Sun Jan 1 23:42:00 2012	1238702330
 HEADER	CLIENT_LIST	Common Name	Real Address	Virtual Address	Bytes Received	Bytes Sent	Connected Since	Connected Since (time_t)
-CLIENT_LIST	foo	1.2.3.4:1234	11811160064	4194304	Sun Jan 1 23:42:00 2012	1238702330
+CLIENT_LIST	foo	1.2.3.4:1234	192.168.66.2	11811160064	4194304	Sun Jan 1 23:42:00 2012	1238702330
-CLIENT_LIST	bar	1.2.3.5:1235	512	2048	Sun Jan 1 23:42:00 2012	1238702330
+CLIENT_LIST	bar	1.2.3.5:1235	2001:db8:0:0::1000	512	2048	Sun Jan 1 23:42:00 2012	1238702330
 HEADER	ROUTING_TABLE	Virtual Address	Common Name	Real Address	Last Ref	Last Ref (time_t)
 ROUTING_TABLE	192.168.0.0/24	foo	1.2.3.4:1234	Sun Jan 1 23:42:00 2012	1238702330
 ROUTING_TABLE	192.168.66.2	bar	1.2.3.5:1235	Sun Jan 1 23:42:00 2012	1238702330

examples/status2_5.v2

@@ -0,0 +1,8 @@
+TITLE,OpenVPN 2.5.1 x86_64-pc-linux-gnu [SSL (OpenSSL)] [LZO] [LZ4] [EPOLL] [PKCS11] [MH/PKTINFO] [AEAD] built on May 14 2021
+TIME,2012-01-01 23:42:00,1238702330
+HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Virtual IPv6 Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username,Client ID,Peer ID,Data Channel Cipher
+CLIENT_LIST,foo,1.2.3.4:1234,192.168.66.2,,11811160064,4194304,2012-01-01 23:42:00,1238702330,UNDEF,1,0,AES-256-GCM
+HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)
+ROUTING_TABLE,192.168.66.2,foo,1.2.3.4:1234,2012-01-01 23:42:00,1238702330
+GLOBAL_STATS,Max bcast/mcast queue length,42
+END

lib/openvpn-status-web/main.html.erb

@@ -50,20 +50,36 @@ thead {
   <div>
   <table>
     <thead>
-      <td class="first">Common Name</td>
+<% status.client_list_headers.each_with_index do |header,i| %>
-      <td class="middle">Real Address</td>
+<% if i == 0 %>
-      <td class="middle">Data Received</td>
+      <td class="first">
-      <td class="middle">Data Sent</td>
+<% elsif i == status.client_list_headers.size-1 %>
-      <td class="last">Connected Since</td>
+      <td class="last">
+<% else %>
+      <td class="middle">
+<% end %>
+      <%= header %></td>
+<% end %>
     </thead>
     <tbody>
 <% status.client_list.each do |client| %>
       <tr>
-        <td class="first"><%= client[0] %></td>
+<% status.client_list_headers.each_with_index do |header,i| %>
-        <td class="middle"><%= client[1] %></td>
+<% if i == 0 %>
-        <td class="middle"><%= client[2].to_i.as_bytes %></td>
+        <td class="first">
-        <td class="middle"><%= client[3].to_i.as_bytes %></td>
+<% elsif i == status.client_list_headers.size-1 %>
-        <td class="last"><%= client[4].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+        <td class="last">
+<% else %>
+        <td class="middle">
+<% end %>
+<% if header =~ /(Received|Sent)/ %>
+        <%= client[i].as_bytes %></td>
+<% elsif client[i].is_a? DateTime %>
+        <%= client[i].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% else %>
+        <%= client[i] %></td>
+<% end %>
+<% end %>
       </tr>
 <% end %>
     </tbody>
@@ -74,18 +90,34 @@ thead {
   <div>
   <table>
     <thead>
-      <td class="first">Virtual Address</td>
+<% status.routing_table_headers.each_with_index do |header,i| %>
-      <td class="middle">Common Name</td>
+<% if i == 0 %>
-      <td class="middle">Real Address</td>
+      <td class="first">
-      <td class="last">Last Ref</td>
+<% elsif i == status.routing_table_headers.size-1 %>
+      <td class="last">
+<% else %>
+      <td class="middle">
+<% end %>
+      <%= header %></td>
+<% end %>
     </thead>
     <tbody>
 <% status.routing_table.each do |route| %>
       <tr>
-        <td class="first"><%= route[0] %></td>
+<% status.routing_table_headers.each_with_index do |header,i| %>
-        <td class="middle"><%= route[1] %></td>
+<% if i == 0 %>
-        <td class="middle"><%= route[2] %></td>
+        <td class="first">
-        <td class="last"><%= route[3].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% elsif i == status.routing_table_headers.size-1 %>
+        <td class="last">
+<% else %>
+        <td class="middle">
+<% end %>
+<% if route[i].is_a? DateTime %>
+        <%= route[i].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% else %>
+        <%= route[i] %></td>
+<% end %>
+<% end %>
       </tr>
 <% end %>
     </tbody>

lib/openvpn-status-web/parser/modern_stateless.rb

@@ -5,29 +5,38 @@ module OpenVPNStatusWeb
     class ModernStateless
       def self.parse_status_log(text, sep)
         status = Status.new
+        status.client_list_headers = []
         status.client_list = []
+        status.routing_table_headers = []
         status.routing_table = []
         status.global_stats = []
 
         text.lines.each do |line|
           parts = line.strip.split(sep)
-          status.client_list << parse_client(parts[1..5]) if parts[0] == 'CLIENT_LIST'
+          status.client_list_headers = parts[2..-1] if parts[0] == 'HEADER' && parts[1] == 'CLIENT_LIST'
-          status.routing_table << parse_route(parts[1..4]) if parts[0] == 'ROUTING_TABLE'
+          status.client_list << parse_client(parts[1..-1], status.client_list_headers) if parts[0] == 'CLIENT_LIST'
+          status.routing_table_headers = parts[2..-1] if parts[0] == 'HEADER' && parts[1] == 'ROUTING_TABLE'
+          status.routing_table << parse_route(parts[1..-1], status.routing_table_headers) if parts[0] == 'ROUTING_TABLE'
           status.global_stats << parse_global(parts[1..2]) if parts[0] == 'GLOBAL_STATS'
         end
 
         status
       end
 
-      private_class_method def self.parse_client(client)
+      private_class_method def self.parse_client(client, headers)
-        client[2] = client[2].to_i
+        headers.each_with_index do |header, i|
-        client[3] = client[3].to_i
+          client[i] = parse_date(client[i]) if header.end_with?('Since')
-        client[4] = DateTime.strptime(client[4], '%a %b %d %k:%M:%S %Y')
+          client[i] = client[i].to_i if header.start_with?('Bytes')
+        end
+
         client
       end
 
-      private_class_method def self.parse_route(route)
+      private_class_method def self.parse_route(route, headers)
-        route[3] = DateTime.strptime(route[3], '%a %b %d %k:%M:%S %Y')
+        headers.each_with_index do |header, i|
+          route[i] = parse_date(route[i]) if header.end_with?('Last Ref')
+        end
+
         route
       end
 
@@ -35,6 +44,12 @@ module OpenVPNStatusWeb
         global[1] = global[1].to_i
         global
       end
+
+      private_class_method def self.parse_date(date_string)
+        DateTime.strptime(date_string, '%a %b %d %k:%M:%S %Y')
+      rescue ArgumentError
+        DateTime.strptime(date_string, '%Y-%m-%d %k:%M:%S')
+      end
     end
   end
 end

lib/openvpn-status-web/parser/v1.rb

@@ -26,7 +26,9 @@ module OpenVPNStatusWeb
         end
 
         status = Status.new
+        status.client_list_headers = ['Common Name', 'Real Address', 'Data Received', 'Data Sent', 'Connected Since']
         status.client_list = client_list[2..-1].map { |client| parse_client(client) }
+        status.routing_table_headers = ['Virtual Address', 'Common Name', 'Real Address', 'Last Ref']
         status.routing_table = routing_table[1..-1].map { |route| parse_route(route) }
         status.global_stats = global_stats.map { |global| parse_global(global) }
         status

lib/openvpn-status-web/status.rb

@@ -2,7 +2,9 @@
 
 module OpenVPNStatusWeb
   class Status
+    attr_accessor :client_list_headers
     attr_accessor :client_list
+    attr_accessor :routing_table_headers
     attr_accessor :routing_table
     attr_accessor :global_stats
   end

lib/openvpn-status-web/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenVPNStatusWeb
-  VERSION = '3.0.1'
+  VERSION = '3.2.1'
 end

openvpn-status-web.gemspec

@@ -33,10 +33,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'better_errors'
   s.add_development_dependency 'binding_of_caller'
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'bundler-audit', '~> 0.7.0'
+  s.add_development_dependency 'bundler-audit', '~> 0.9.0'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 0.92.0'
+  s.add_development_dependency 'rubocop', '~> 1.24.0'
-  s.add_development_dependency 'solargraph'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.7.0'
+  s.add_development_dependency 'solargraph', '~> 0.44.0'
 end

spec/openvpn-status-web/parser/modern_stateless_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../spec_helper'
+require_relative '../../spec_helper'
 
 describe OpenVPNStatusWeb::Parser::ModernStateless do
   {
@@ -8,7 +8,7 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
     3 => status_v3
   }.each do |version, status|
     context "for status-version #{version}" do
-      context 'for client list' do
+      context 'with client list' do
         it 'parses common names' do
           expect(status.client_list.map { |client| client[0] }).to eq(%w[foo bar])
         end
@@ -17,24 +17,33 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
           expect(status.client_list.map { |client| client[1] }).to eq(['1.2.3.4:1234', '1.2.3.5:1235'])
         end
 
+        it 'parses virtual addresses' do
+          expect(status.client_list.map { |client| client[2] }).to eq(['192.168.66.2', '2001:db8:0:0::1000'])
+        end
+
         it 'parses received bytes' do
-          expect(status.client_list.map { |client| client[2] }).to eq([11_811_160_064, 512])
+          expect(status.client_list.map { |client| client[3] }).to eq([11_811_160_064, 512])
         end
 
         it 'parses sent bytes' do
-          expect(status.client_list.map { |client| client[3] }).to eq([4_194_304, 2048])
+          expect(status.client_list.map { |client| client[4] }).to eq([4_194_304, 2048])
         end
 
         it 'parses connected since date' do
-          expect(status.client_list.map { |client| client[4] }).to eq(
+          expect(status.client_list.map { |client| client[5] }).to eq(
             [
-              DateTime.new(2012, 1, 1, 23, 42, 0), DateTime.new(2012, 1, 1, 23, 42, 0)
+              DateTime.new(2012, 1, 1, 23, 42, 0),
+              DateTime.new(2012, 1, 1, 23, 42, 0)
             ]
           )
         end
+
+        it 'has the same number of headers' do
+          expect(status.client_list[0].size).to eq(status.client_list_headers.size)
+        end
       end
 
-      context 'for routing table' do
+      context 'with routing table' do
         it 'parses virtual addresses' do
           expect(status.routing_table.map { |route| route[0] }).to eq(['192.168.0.0/24', '192.168.66.2', '192.168.66.3', '2001:db8:0:0::1000'])
         end
@@ -55,6 +64,10 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
             ]
           )
         end
+
+        it 'has the same number of headers' do
+          expect(status.routing_table[0].size).to eq(status.routing_table_headers.size)
+        end
       end
 
       it 'parses global stats' do
@@ -63,4 +76,8 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
       end
     end
   end
+
+  it 'parses status-version 2 of OpenVPN 2.5' do
+    expect(status_2_5_v2).not_to be_nil
+  end
 end

spec/openvpn-status-web/parser/v1_spec.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative '../spec_helper'
+require_relative '../../spec_helper'
 
 describe OpenVPNStatusWeb::Parser::V1 do
   def status
     status_v1
   end
 
-  context 'for client list' do
+  context 'with client list' do
     it 'parses common names' do
       expect(status.client_list.map { |client| client[0] }).to eq(%w[foo bar])
     end
@@ -31,9 +31,13 @@ describe OpenVPNStatusWeb::Parser::V1 do
         ]
       )
     end
+
+    it 'has the same number of headers' do
+      expect(status.client_list[0].length).to eq(status.client_list_headers.length)
+    end
   end
 
-  context 'for routing table' do
+  context 'with routing table' do
     it 'parses virtual addresses' do
       expect(status.routing_table.map { |route| route[0] }).to eq(['192.168.0.0/24', '192.168.66.2', '192.168.66.3', '2001:db8:0:0::1000'])
     end
@@ -54,6 +58,10 @@ describe OpenVPNStatusWeb::Parser::V1 do
         ]
       )
     end
+
+    it 'has the same number of headers' do
+      expect(status.routing_table[0].length).to eq(status.routing_table_headers.length)
+    end
   end
 
   it 'parses global stats' do

spec/spec_helper.rb

@@ -7,16 +7,21 @@ require 'rack/test'
 require 'openvpn-status-web'
 
 def status_v1
-  text = File.open('examples/status.v1', 'rb', &:read)
+  text = File.binread('examples/status.v1')
   OpenVPNStatusWeb::Parser::V1.new.parse_status_log text
 end
 
 def status_v2
-  text = File.open('examples/status.v2', 'rb', &:read)
+  text = File.binread('examples/status.v2')
+  OpenVPNStatusWeb::Parser::V2.new.parse_status_log text
+end
+
+def status_2_5_v2
+  text = File.binread('examples/status2_5.v2')
   OpenVPNStatusWeb::Parser::V2.new.parse_status_log text
 end
 
 def status_v3
-  text = File.open('examples/status.v3', 'rb', &:read)
+  text = File.binread('examples/status.v3')
   OpenVPNStatusWeb::Parser::V3.new.parse_status_log text
 end