gem: release 3.2.0

- smooth fallback

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.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

.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 *.lock
 pkg/*
+.yardoc

.rubocop.yml

@@ -0,0 +1,105 @@
+require:
+- rubocop-rake
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: '2.5'
+  NewCops: enable
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+# allows nicer usage of private_class_method
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LeadingEmptyLines:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 200
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/IdenticalConditionalBranches:
+  Enabled: false
+
+Style/InverseMethods:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/SymbolArray:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/FilePath:
+  CustomTransform:
+    OpenVPNStatusWeb: openvpn-status-web
+
+RSpec/MultipleExpectations:
+  Max: 5

.solargraph.yml

@@ -0,0 +1,16 @@
+---
+include:
+- "**/*.rb"
+- "bin/openvpn-status-web"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+require_paths: []
+max_files: 5000

.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.0.0
-  - 1.9.3
-
-gemfile:
-  - Gemfile

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

README.md

@@ -1,6 +1,6 @@
 # openvpn-status-web
 
-[![Build Status](https://travis-ci.org/cmur2/openvpn-status-web.png)](https://travis-ci.org/cmur2/openvpn-status-web)
+![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
 
@@ -57,10 +57,12 @@ For more information about OpenVPN status file and version, see their [man page]
 
 If the information exposed is important to you serve it via the VPN or use a webserver as a proxy to handle SSL and/or HTTP authentication.
 
-### Init scripts
+### Startup
 
-The [Debian 6 init.d script](init.d/debian-6-openvpn-status-web) assumes that openvpn-status-web is installed into the system ruby (no RVM support) and the config.yaml is at /opt/openvpn-status-web/config.yaml. Modify to your needs.
+There is a [Dockerfile](docs/Dockerfile) that can be used to build a Docker image for running openvpn-status-web.
+
+The [Debian 6 init script](docs/debian-init-openvpn-status-web) assumes that openvpn-status-web is installed into the system ruby (no RVM support) and the config.yaml is at `/opt/openvpn-status-web/config.yaml`. Modify to your needs.
 
 ## License
 
-openvpn-statsu-web is licensed under the Apache License, Version 2.0. See LICENSE for more information.
+openvpn-status-web is licensed under the Apache License, Version 2.0. See LICENSE for more information.

Rakefile

@@ -1,6 +1,27 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'bundler/audit/task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+Bundler::Audit::Task.new
 
-task :default => :spec
+desc 'Run experimental solargraph type checker'
+task :solargraph do
+  sh 'solargraph typecheck'
+end
+
+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 default: [:rubocop, :spec, 'bundle:audit', :solargraph]
+
+desc 'Run all tasks desired for CI'
+task ci: ['solargraph:init', :default]

docs/Dockerfile

@@ -0,0 +1,15 @@
+FROM alpine:3.13
+
+EXPOSE 8080
+
+ENV VERSION=3.2.0
+
+RUN apk --no-cache add openssl ca-certificates && \
+    apk --no-cache add ruby ruby-etc ruby-webrick && \
+    apk --no-cache add --virtual .build-deps ruby-dev build-base tzdata && \
+    gem install --no-document openvpn-status-web -v ${VERSION} && \
+    # set timezone to Berlin
+    cp /usr/share/zoneinfo/Europe/Berlin /etc/localtime && \
+    apk del .build-deps
+
+ENTRYPOINT ["openvpn-status-web", "/etc/openvpn-status-web/config.yml"]

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,bar,1.2.3.5:1235,512,2048,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,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	bar	1.2.3.5:1235	512	2048	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	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

exe/openvpn-status-web

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'openvpn-status-web'
 

lib/openvpn-status-web.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'date'
 require 'etc'
@@ -8,7 +9,7 @@ require 'yaml'
 require 'rack'
 require 'erb'
 require 'metriks'
-require 'better_errors' if ENV['RACK_ENV'] == "development"
+require 'better_errors' if ENV['RACK_ENV'] == 'development'
 
 require 'openvpn-status-web/status'
 require 'openvpn-status-web/parser/v1'
@@ -18,17 +19,25 @@ require 'openvpn-status-web/int_patch'
 require 'openvpn-status-web/version'
 
 module OpenVPNStatusWeb
+  # @return [Logger]
   def self.logger
     @logger
   end
 
+  # @param logger [Logger]
+  # @return [Logger]
   def self.logger=(logger)
     @logger = logger
   end
 
   class LogFormatter
-    def call(lvl, time, progname, msg)
-      "[%s] %-5s %s\n" % [Time.now.strftime('%Y-%m-%d %H:%M:%S'), lvl, msg.to_s]
+    # @param lvl [Object]
+    # @param _time [DateTime]
+    # @param _progname [String]
+    # @param msg [Object]
+    # @return [String]
+    def call(lvl, _time, _progname, msg)
+      format("[%s] %-5s %s\n", Time.now.strftime('%Y-%m-%d %H:%M:%S'), lvl, msg.to_s)
     end
   end
 
@@ -40,8 +49,8 @@ module OpenVPNStatusWeb
     end
 
     def call(env)
-      return [405, {"Content-Type" => "text/plain"}, ["Method Not Allowed"]] if env["REQUEST_METHOD"] != "GET"
-      return [404, {"Content-Type" => "text/plain"}, ["Not Found"]] if env["PATH_INFO"] != "/"
+      return [405, {'Content-Type' => 'text/plain'}, ['Method Not Allowed']] if env['REQUEST_METHOD'] != 'GET'
+      return [404, {'Content-Type' => 'text/plain'}, ['Not Found']] if env['PATH_INFO'] != '/'
 
       # variables for template
       vpns = @vpns
@@ -52,17 +61,17 @@ module OpenVPNStatusWeb
       # eval
       html = @main_tmpl.result(binding)
 
-      [200, {"Content-Type" => "text/html"}, [html]]
+      [200, {'Content-Type' => 'text/html'}, [html]]
     end
 
     def read_template(file)
-      text = File.open(file, 'rb') do |f| f.read end
+      text = File.read(file, mode: 'rb')
 
       ERB.new(text)
     end
 
     def parse_status_log(vpn)
-      text = File.open(vpn['status_file'], 'rb') do |f| f.read end
+      text = File.read(vpn['status_file'], mode: 'rb')
 
       case vpn['version']
       when 1
@@ -76,56 +85,64 @@ module OpenVPNStatusWeb
       end
     end
 
+    # @return [void]
     def self.run!
       if ARGV.length != 1
-        puts "Usage: openvpn-status-web config_file"
+        puts 'Usage: openvpn-status-web config_file'
         exit 1
       end
 
       config_file = ARGV[0]
 
-      if not File.file?(config_file)
-        puts "Config file not found!"
+      if !File.file?(config_file)
+        puts 'Config file not found!'
         exit 1
       end
 
       puts "openvpn-status-web version #{OpenVPNStatusWeb::VERSION}"
       puts "Using config file #{config_file}"
 
-      config = YAML::load(File.open(config_file, 'r') { |f| f.read })
+      config = YAML.safe_load(File.read(config_file, mode: 'r'))
 
       if config['logfile']
         OpenVPNStatusWeb.logger = Logger.new(config['logfile'])
       else
-        OpenVPNStatusWeb.logger = Logger.new(STDOUT)
+        OpenVPNStatusWeb.logger = Logger.new($stdout)
       end
 
-      OpenVPNStatusWeb.logger.progname = "openvpn-status-web"
+      OpenVPNStatusWeb.logger.progname = 'openvpn-status-web'
       OpenVPNStatusWeb.logger.formatter = LogFormatter.new
 
-      OpenVPNStatusWeb.logger.info "Starting..."
+      OpenVPNStatusWeb.logger.info 'Starting...'
 
-      # drop privs (first change group than user)
-      Process::Sys.setgid(Etc.getgrnam(config['group']).gid) if config['group']
-      Process::Sys.setuid(Etc.getpwnam(config['user']).uid) if config['user']
+      # drop priviliges as soon as possible
+      # NOTE: first change group than user
+      if config['group']
+        group = Etc.getgrnam(config['group'])
+        Process::Sys.setgid(group.gid) if group
+      end
+      if config['user']
+        user = Etc.getpwnam(config['user'])
+        Process::Sys.setuid(user.uid) if user
+      end
 
       # configure rack
       app = Daemon.new(config['vpns'])
-      if ENV['RACK_ENV'] == "development"
+      if ENV['RACK_ENV'] == 'development'
         app = BetterErrors::Middleware.new(app)
-        BetterErrors.application_root = File.expand_path("..", __FILE__)
+        BetterErrors.application_root = File.expand_path(__dir__)
       end
 
       Signal.trap('INT') do
-        OpenVPNStatusWeb.logger.info "Quitting..."
+        OpenVPNStatusWeb.logger.info 'Quitting...'
         Rack::Handler::WEBrick.shutdown
       end
       Signal.trap('TERM') do
-        OpenVPNStatusWeb.logger.info "Quitting..."
+        OpenVPNStatusWeb.logger.info 'Quitting...'
         Rack::Handler::WEBrick.shutdown
       end
 
-      Rack::Handler::WEBrick.run app, :Host => config['host'], :Port => config['port']
+      Rack::Handler::WEBrick.run app, Host: config['host'], Port: config['port']
     end
   end
 end

lib/openvpn-status-web/int_patch.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 
 class Integer
   def as_bytes
-    return "1 Byte" if self == 1
+    return '1 Byte' if self == 1
 
-    label = ["Bytes", "KiB", "MiB", "GiB", "TiB"]
+    label = %w[Bytes KiB MiB GiB TiB]
     i = 0
-    num = self.to_f
-    while num >= 1024 do
-      num = num / 1024
+    num = to_f
+    while num >= 1024
+      num /= 1024
       i += 1
     end
 

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

@@ -50,20 +50,36 @@ thead {
   <div>
   <table>
     <thead>
-      <td class="first">Common Name</td>
-      <td class="middle">Real Address</td>
-      <td class="middle">Data Received</td>
-      <td class="middle">Data Sent</td>
-      <td class="last">Connected Since</td>
+<% status.client_list_headers.each_with_index do |header,i| %>
+<% if i == 0 %>
+      <td class="first">
+<% elsif i == status.client_list_headers.size-1 %>
+      <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>
-        <td class="middle"><%= client[1] %></td>
-        <td class="middle"><%= client[2].to_i.as_bytes %></td>
-        <td class="middle"><%= client[3].to_i.as_bytes %></td>
-        <td class="last"><%= client[4].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% status.client_list_headers.each_with_index do |header,i| %>
+<% if i == 0 %>
+        <td class="first">
+<% elsif i == status.client_list_headers.size-1 %>
+        <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>
-      <td class="middle">Common Name</td>
-      <td class="middle">Real Address</td>
-      <td class="last">Last Ref</td>
+<% status.routing_table_headers.each_with_index do |header,i| %>
+<% if i == 0 %>
+      <td class="first">
+<% 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>
-        <td class="middle"><%= route[1] %></td>
-        <td class="middle"><%= route[2] %></td>
-        <td class="last"><%= route[3].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% status.routing_table_headers.each_with_index do |header,i| %>
+<% if i == 0 %>
+        <td class="first">
+<% 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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module OpenVPNStatusWeb
   module Parser
@@ -10,32 +11,43 @@ module OpenVPNStatusWeb
 
         text.lines.each do |line|
           parts = line.strip.split(sep)
-          status.client_list << parse_client(parts[1..5]) if parts[0] == "CLIENT_LIST"
-          status.routing_table << parse_route(parts[1..4]) if parts[0] == "ROUTING_TABLE"
-          status.global_stats << parse_global(parts[1..2]) if parts[0] == "GLOBAL_STATS"
+          status.client_list_headers = parts[2..-1] if parts[0] == 'HEADER' && parts[1] == 'CLIENT_LIST'
+          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
+      private_class_method def self.parse_client(client, headers)
+        headers.each_with_index do |header, i|
+          client[i] = parse_date(client[i]) if header.end_with?('Since')
+          client[i] = client[i].to_i if header.start_with?('Bytes')
+        end
 
-      def self.parse_client(client)
-        client[2] = client[2].to_i
-        client[3] = client[3].to_i
-        client[4] = DateTime.strptime(client[4], '%a %b %d %k:%M:%S %Y')
         client
       end
 
-      def self.parse_route(route)
-        route[3] = DateTime.strptime(route[3], '%a %b %d %k:%M:%S %Y')
+      private_class_method def self.parse_route(route, headers)
+        headers.each_with_index do |header, i|
+          route[i] = parse_date(route[i]) if header.end_with?('Last Ref')
+        end
+
         route
       end
 
-      def self.parse_global(global)
+      private_class_method def self.parse_global(global)
         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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module OpenVPNStatusWeb
   module Parser
@@ -25,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/parser/v2.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-require 'openvpn-status-web/parser/modern_stateless'
+require_relative 'modern_stateless'
 
 module OpenVPNStatusWeb
   module Parser

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

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-require 'openvpn-status-web/parser/modern_stateless'
+require_relative 'modern_stateless'
 
 module OpenVPNStatusWeb
   module Parser

lib/openvpn-status-web/status.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
 
 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,4 +1,5 @@
+# frozen_string_literal: true
 
 module OpenVPNStatusWeb
-  VERSION = "1.1.0"
+  VERSION = '3.2.0'
 end

openvpn-status-web.gemspec

@@ -1,7 +1,6 @@
+# frozen_string_literal: true
 
-$:.push File.expand_path("../lib", __FILE__)
-
-require 'openvpn-status-web/version'
+require_relative 'lib/openvpn-status-web/version'
 
 Gem::Specification.new do |s|
   s.name = 'openvpn-status-web'
@@ -9,24 +8,37 @@ Gem::Specification.new do |s|
   s.summary = 'openvpn-status-web'
   s.description = 'Small Rack (Ruby) application serving OpenVPN status file.'
   s.author = 'Christian Nicolai'
-  s.email = 'chrnicolai@gmail.com'
-  s.license = 'Apache License Version 2.0'
+
   s.homepage = 'https://github.com/cmur2/openvpn-status-web'
+  s.license = 'Apache-2.0'
+  s.metadata = {
+    'bug_tracker_uri' => "#{s.homepage}/issues",
+    'source_code_uri' => s.homepage
+  }
 
-  s.files = `git ls-files`.split($/)
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
-
+  s.files = `git ls-files -z`.split("\x0").select do |f|
+    f.match(%r{^(init.d|lib)/})
+  end
   s.require_paths = ['lib']
-
+  s.bindir = 'exe'
   s.executables = ['openvpn-status-web']
+  s.extra_rdoc_files = Dir['README.md', 'LICENSE']
+
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_runtime_dependency 'rack'
   s.add_runtime_dependency 'metriks'
+  s.add_runtime_dependency 'rack', '~> 2.0'
+  s.add_runtime_dependency 'webrick', '>= 1.6.1'
 
-  s.add_development_dependency 'bundler', '~> 1.3'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rack-test'
   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.9.0'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop', '~> 1.24.0'
+  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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+
+describe OpenVPNStatusWeb::Parser::ModernStateless do
+  {
+    2 => status_v2,
+    3 => status_v3
+  }.each do |version, status|
+    context "for status-version #{version}" 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
+
+        it 'parses real addresses' 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[3] }).to eq([11_811_160_064, 512])
+        end
+
+        it 'parses sent bytes' do
+          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[5] }).to eq(
+            [
+              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 '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
+
+        it 'parses common names' do
+          expect(status.routing_table.map { |route| route[1] }).to eq(%w[foo bar foo bar])
+        end
+
+        it 'parses real addresses' do
+          expect(status.routing_table.map { |route| route[2] }).to eq(['1.2.3.4:1234', '1.2.3.5:1235', '1.2.3.4:1234', '1.2.3.5:1235'])
+        end
+
+        it 'parses last ref date' do
+          expect(status.routing_table.map { |route| route[3] }).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.routing_table[0].size).to eq(status.routing_table_headers.size)
+        end
+      end
+
+      it 'parses global stats' do
+        expect(status.global_stats.size).to eq(1)
+        expect(status.global_stats.first).to eq(['Max bcast/mcast queue length', 42])
+      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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+
+describe OpenVPNStatusWeb::Parser::V1 do
+  def status
+    status_v1
+  end
+
+  context 'with client list' do
+    it 'parses common names' do
+      expect(status.client_list.map { |client| client[0] }).to eq(%w[foo bar])
+    end
+
+    it 'parses real addresses' do
+      expect(status.client_list.map { |client| client[1] }).to eq(['1.2.3.4:1234', '1.2.3.5:1235'])
+    end
+
+    it 'parses received bytes' do
+      expect(status.client_list.map { |client| client[2] }).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])
+    end
+
+    it 'parses connected since date' do
+      expect(status.client_list.map { |client| client[4] }).to eq(
+        [
+          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].length).to eq(status.client_list_headers.length)
+    end
+  end
+
+  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
+
+    it 'parses common names' do
+      expect(status.routing_table.map { |route| route[1] }).to eq(%w[foo bar foo bar])
+    end
+
+    it 'parses real addresses' do
+      expect(status.routing_table.map { |route| route[2] }).to eq(['1.2.3.4:1234', '1.2.3.5:1235', '1.2.3.4:1234', '1.2.3.5:1235'])
+    end
+
+    it 'parses last ref date' do
+      expect(status.routing_table.map { |route| route[3] }).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.routing_table[0].length).to eq(status.routing_table_headers.length)
+    end
+  end
+
+  it 'parses global stats' do
+    expect(status.global_stats.size).to eq(1)
+    expect(status.global_stats.first).to eq(['Max bcast/mcast queue length', 42])
+  end
+end

spec/parser/modern_stateless_spec.rb

@@ -1,55 +0,0 @@
-require 'spec_helper'
-
-describe OpenVPNStatusWeb::Parser::ModernStateless do
-  {
-    2 => status_v2,
-    3 => status_v3
-  }.each do |version, status|
-    context "for status-version #{version}" do
-      context 'for client list' do
-        it 'parses common names' do
-          status.client_list.map { |client| client[0] }.should be == ["foo", "bar"]
-        end
-
-        it 'parses real addresses' do
-          status.client_list.map { |client| client[1] }.should be == ["1.2.3.4:1234", "1.2.3.5:1235"]
-        end
-        
-        it 'parses received bytes' do
-          status.client_list.map { |client| client[2] }.should be == [11811160064, 512]
-        end
-
-        it 'parses sent bytes' do
-          status.client_list.map { |client| client[3] }.should be == [4194304, 2048]
-        end
-
-        it 'parses connected since date' do
-          status.client_list.map { |client| client[4] }.should be == [DateTime.new(2012,1,1,23,42,0), DateTime.new(2012,1,1,23,42,0)]
-        end
-      end
-
-      context 'for routing table' do
-        it 'parses virtual addresses' do
-          status.routing_table.map { |route| route[0] }.should be == ["192.168.0.0/24", "192.168.66.2", "192.168.66.3", "2001:db8:0:0::1000"]
-        end
-
-        it 'parses common names' do
-          status.routing_table.map { |route| route[1] }.should be == ["foo", "bar", "foo", "bar"]
-        end
-
-        it 'parses real addresses' do
-          status.routing_table.map { |route| route[2] }.should be == ["1.2.3.4:1234", "1.2.3.5:1235", "1.2.3.4:1234", "1.2.3.5:1235"]
-        end
-
-        it 'parses last ref date' do
-          status.routing_table.map { |route| route[3] }.should be == [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
-      end
-
-      it 'parses global stats' do
-        status.global_stats.size.should be == 1
-        status.global_stats.first.should be == ["Max bcast/mcast queue length", 42]
-      end
-    end
-  end
-end

spec/parser/v1_spec.rb

@@ -1,50 +0,0 @@
-require 'spec_helper'
-
-describe OpenVPNStatusWeb::Parser::V1 do
-  def status; status_v1; end
-
-  context 'for client list' do
-    it 'parses common names' do
-      status.client_list.map { |client| client[0] }.should be == ["foo", "bar"]
-    end
-
-    it 'parses real addresses' do
-      status.client_list.map { |client| client[1] }.should be == ["1.2.3.4:1234", "1.2.3.5:1235"]
-    end
-    
-    it 'parses received bytes' do
-      status.client_list.map { |client| client[2] }.should be == [11811160064, 512]
-    end
-
-    it 'parses sent bytes' do
-      status.client_list.map { |client| client[3] }.should be == [4194304, 2048]
-    end
-
-    it 'parses connected since date' do
-      status.client_list.map { |client| client[4] }.should be == [DateTime.new(2012,1,1,23,42,0), DateTime.new(2012,1,1,23,42,0)]
-    end
-  end
-
-  context 'for routing table' do
-    it 'parses virtual addresses' do
-      status.routing_table.map { |route| route[0] }.should be == ["192.168.0.0/24", "192.168.66.2", "192.168.66.3", "2001:db8:0:0::1000"]
-    end
-
-    it 'parses common names' do
-      status.routing_table.map { |route| route[1] }.should be == ["foo", "bar", "foo", "bar"]
-    end
-
-    it 'parses real addresses' do
-      status.routing_table.map { |route| route[2] }.should be == ["1.2.3.4:1234", "1.2.3.5:1235", "1.2.3.4:1234", "1.2.3.5:1235"]
-    end
-
-    it 'parses last ref date' do
-      status.routing_table.map { |route| route[3] }.should be == [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
-  end
-
-  it 'parses global stats' do
-    status.global_stats.size.should be == 1
-    status.global_stats.first.should be == ["Max bcast/mcast queue length", 42]
-  end
-end

spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler/setup'
@@ -6,16 +7,21 @@ require 'rack/test'
 require 'openvpn-status-web'
 
 def status_v1
-  text = File.open('examples/status.v1', 'rb') do |f| f.read end
+  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') do |f| f.read end
+  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') do |f| f.read end
+  text = File.binread('examples/status.v3')
   OpenVPNStatusWeb::Parser::V3.new.parse_status_log text
 end