release: 3.1.0

- Ruby 3.0
- move from Travis CI to Github Actions
- dependency updates

.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,32 @@
+---
+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'
+    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,5 +1,10 @@
+require:
+- rubocop-rake
+- rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: '2.3'
+  TargetRubyVersion: '2.5'
+  NewCops: enable
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
@@ -44,6 +49,9 @@ Naming/MethodParameterName:
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 
+Style/AccessorGrouping:
+  Enabled: false
+
 Style/ConditionalAssignment:
   Enabled: false
 
@@ -82,3 +90,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,12 +0,0 @@
----
-os: linux
-language: ruby
-rvm:
-- 2.7
-- 2.6
-- 2.5
-- 2.4
-- 2.3
-
-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)](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
 
@@ -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

@@ -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:tc']
+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.1.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"]

lib/openvpn-status-web.rb

@@ -107,7 +107,7 @@ module OpenVPNStatusWeb
       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'

lib/openvpn-status-web/version.rb

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

openvpn-status-web.gemspec

@@ -24,18 +24,21 @@ Gem::Specification.new do |s|
   s.executables = ['openvpn-status-web']
   s.extra_rdoc_files = Dir['README.md', 'LICENSE']
 
-  s.required_ruby_version = '>= 2.3'
+  s.required_ruby_version = '>= 2.5'
 
   s.add_runtime_dependency 'metriks'
   s.add_runtime_dependency 'rack', '~> 2.0'
+  s.add_runtime_dependency 'webrick', '>= 1.6.1'
 
   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.6.0'
+  s.add_development_dependency 'bundler-audit', '~> 0.7.0'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 0.80.0'
-  s.add_development_dependency 'solargraph'
+  s.add_development_dependency 'rubocop', '~> 1.8.1'
+  s.add_development_dependency 'rubocop-rake', '~> 0.5.1'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.1.0'
+  s.add_development_dependency 'solargraph', ' ~> 0.40.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
@@ -34,7 +34,7 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
         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

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
@@ -33,7 +33,7 @@ describe OpenVPNStatusWeb::Parser::V1 do
     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