puny-monitor 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef7da3ad71ee116621cfd11bc930e6ab5624aad481afaa024e6e09790916cde4
-  data.tar.gz: d590745c16a3ca947e1a1af8b91931cbf9daec21e9f1703a308b8be7e92e5bf5
+  metadata.gz: 5563bcd36e5c112a41100ba5138ca04eb9c2d8ad4cdf7782f9b3847d4d7cc44c
+  data.tar.gz: dcab8591a17194d2a92e0ff23f052d6680348d3925a36f45cef69caf8e5c2130
 SHA512:
-  metadata.gz: 345ed87c689aa7c153009f8a3f21fa33778ed97cf1db0a3e60948717ee0906886c4d9eb037a6b4602567354a34c89378f9fa57fb7b1f4a3596024f1580f2b687
-  data.tar.gz: af40c578d0c669f4216e0eaaa456154835819934c79f6befb40ea9200e888eba3854bef9594278644718ab242bc0c9804c862f8bdbca02d1df323ebeae6892e3
+  metadata.gz: e1f2e834bb72b0918f50d80c7a842d8bcdf685d3caddcb28e7aea60808836e90371330cfc2f31d8f479b4414f6db85bdd2883c17dce6cb44db6a47351245a7d5
+  data.tar.gz: ba927bfbd53adfe1aab34ed2b2c0e5cb7452a6128a99cdf61c52d1e6ab2876b59673c24357cf5d6a75defd1830d5a1ad700c2b2124fdbf019d805b796e76bf31

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [Unreleased]
+
+## [0.2.0] - 2025-08-18
+
+- Add HTTP authentication
+- Upgrade to Ruby 3.4
+
+## [0.1.0] - 2024-09-15
+
+- Initial release

data/README.md

@@ -33,6 +33,20 @@ docker run --rm \
 
 Visit [localhost:4567](http://localhost:4567) to check your system data. To see how to deploy Puny Monitor in a production environment see [Deployment].
 
+## Authentication
+
+Puny monitor supports Basic HTTP Authentication. To enable authentication set both the `PUNY_USERNAME` and `PUNY_PASSWORD` environment variables. For example, using with `docker run`:
+
+```
+docker run --rm \
+  -v=/:/host:ro,rslave -v=puny-data:/puny-monitor/db \
+  -e HOST_PATH=/host \
+  -e PUNY_USERNAME=admin \
+  -e PUNY_PASSWORD=secret \
+  -p 4567:4567 \
+  hschne/puny-monitor:latest
+```
+
 ## Deployment
 
 Puny Monitor was made with [Kamal](https://kamal-deploy.org/) and [Ruby on Rails](https://rubyonrails.org/) in mind. It is recommended that you deploy it as an accessory to your application. Add the following lines to `config/deploy.yml`:
@@ -81,7 +95,14 @@ To put it simply, Puny Monitor replicates [Digital Ocean's Monitoring](https://w
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.  To run Puny Monitor locally use 
+```
+bundle exec rackup
+```
+
+Alternatively, you may use the various docker helpers defined in the [Rakefile].
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/app/authorization.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PunyMonitor
+  module Authorization
+    def self.included(base)
+      return unless authorize?
+
+      base.use Rack::Auth::Basic, 'Puny Monitor' do |username, password|
+        username == self.username && password == self.password
+      end
+    end
+
+    def self.username
+      @username ||= ENV.fetch('PUNY_USERNAME', nil)
+    end
+
+    def self.password
+      @password ||= ENV.fetch('PUNY_PASSWORD', nil)
+    end
+
+    def self.authorize?
+      puts username
+      puts password
+      username && password
+    end
+  end
+end

data/app/models/bandwidth.rb

@@ -4,8 +4,8 @@ class Bandwidth < ActiveRecord::Base
   class << self
     def average_usage(start_time, group_by)
       [
-        { name: "Incoming Mbps", data: average_for_period(:incoming_mbps, start_time, group_by) },
-        { name: "Outgoing Mbps", data: average_for_period(:outgoing_mbps, start_time, group_by) }
+        {name: "Incoming Mbps", data: average_for_period(:incoming_mbps, start_time, group_by)},
+        {name: "Outgoing Mbps", data: average_for_period(:outgoing_mbps, start_time, group_by)}
       ]
     end
 

data/app/models/cpu_load.rb

@@ -3,9 +3,9 @@
 class CpuLoad < ActiveRecord::Base
   def self.average_load(start_time, end_time, group_by)
     [
-      { name: "1 minute", data: average_for_period(:one_minute, start_time, end_time, group_by) },
-      { name: "5 minutes", data: average_for_period(:five_minutes, start_time, end_time, group_by) },
-      { name: "15 minutes", data: average_for_period(:fifteen_minutes, start_time, end_time, group_by) }
+      {name: "1 minute", data: average_for_period(:one_minute, start_time, end_time, group_by)},
+      {name: "5 minutes", data: average_for_period(:five_minutes, start_time, end_time, group_by)},
+      {name: "15 minutes", data: average_for_period(:fifteen_minutes, start_time, end_time, group_by)}
     ]
   end
 

data/app/models/disk_io.rb

@@ -4,8 +4,8 @@ class DiskIO < ActiveRecord::Base
   class << self
     def average_io(start_time, group_by)
       [
-        { name: "Read MB/s", data: average_for_period(:read_mb_per_sec, start_time, group_by) },
-        { name: "Write MB/s", data: average_for_period(:write_mb_per_sec, start_time, group_by) }
+        {name: "Read MB/s", data: average_for_period(:read_mb_per_sec, start_time, group_by)},
+        {name: "Write MB/s", data: average_for_period(:write_mb_per_sec, start_time, group_by)}
       ]
     end
 

data/app/puny_monitor.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-require "rufus-scheduler"
-require_relative "scheduler"
-require_relative "../lib/system_utils"
+require 'rufus-scheduler'
+require_relative 'scheduler'
+require_relative 'authorization'
+require_relative '../lib/system_utils'
 
 module PunyMonitor
   class App < Sinatra::Base
+    # include Authorization
+
     configure do
       register Sinatra::ActiveRecordExtension
       @scheduler = Rufus::Scheduler.new
-      @scheduler.every("5s") { Scheduler.collect_data }
-      @scheduler.every("1h") { Scheduler.cleanup_old_data }
+      @scheduler.every('5s') { Scheduler.collect_data }
+      @scheduler.every('1h') { Scheduler.cleanup_old_data }
     end
 
     configure :development do
@@ -18,43 +21,43 @@ module PunyMonitor
     end
 
     set :erb, layout: :layout
-    set :public_folder, File.join(__dir__, "..", "public")
-    set :database_file, "../config/database.yml"
+    set :public_folder, File.join(__dir__, '..', 'public')
+    set :database_file, '../config/database.yml'
 
-    get "/" do
+    get '/' do
       erb :index, locals: { params:, logo: }
     end
 
-    get "/up" do
+    get '/up' do
       200
     end
 
-    get "/data/cpu_usage" do
+    get '/data/cpu_usage' do
       content_type :json
       CpuUsage.average_usage(start_time, group_by).to_json
     end
 
-    get "/data/cpu_load" do
+    get '/data/cpu_load' do
       content_type :json
       CpuLoad.average_load(start_time, Time.now, group_by).to_json
     end
 
-    get "/data/memory_usage" do
+    get '/data/memory_usage' do
       content_type :json
       MemoryUsage.average_usage(start_time, group_by).to_json
     end
 
-    get "/data/filesystem_usage" do
+    get '/data/filesystem_usage' do
       content_type :json
       FilesystemUsage.average_usage(start_time, group_by).to_json
     end
 
-    get "/data/disk_io" do
+    get '/data/disk_io' do
       content_type :json
       DiskIO.average_io(start_time, group_by).to_json
     end
 
-    get "/data/bandwidth" do
+    get '/data/bandwidth' do
       content_type :json
       Bandwidth.average_usage(start_time, group_by).to_json
     end
@@ -63,28 +66,28 @@ module PunyMonitor
 
     def logo
       @logo ||= begin
-        file = File.open("public/icon.svg")
+        file = File.open('public/icon.svg')
         file.read
       end
     end
 
     def duration
-      params[:duration] || "1d"
+      params[:duration] || '1d'
     end
 
     def start_time
       case duration
-      when "1h" then 1.hour.ago
-      when "3d" then 3.days.ago
-      when "1w" then 1.week.ago
-      when "1m" then 1.month.ago
+      when '1h' then 1.hour.ago
+      when '3d' then 3.days.ago
+      when '1w' then 1.week.ago
+      when '1m' then 1.month.ago
       else 1.day.ago
       end
     end
 
     def group_by
       case duration
-      when "1h", "1d" then :minute
+      when '1h', '1d' then :minute
       else :hour
       end
     end

data/app/scheduler.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../lib/system_utils"
-require "debug"
+require_relative '../lib/system_utils'
 
 module PunyMonitor
   class Scheduler
@@ -25,7 +24,7 @@ module PunyMonitor
       def cleanup_old_data
         one_month_ago = 1.month.ago
         [CpuUsage, CpuLoad, MemoryUsage, FilesystemUsage, DiskIO, Bandwidth].each do |model|
-          model.where("created_at < ?", one_month_ago).delete_all
+          model.where('created_at < ?', one_month_ago).delete_all
         end
       end
     end

data/app/views/layout.erb

@@ -13,13 +13,16 @@
     <link rel="icon" href="favicon.ico" sizes="32x32">
     <link rel="icon" href="icon.svg" type="image/svg+xml">
 
-    <script
-      src="https://cdn.jsdelivr.net/npm/chartkick@4.2.0/dist/chartkick.min.js"
-    ></script>
-    <script src="https://cdn.jsdelivr.net/npm/chart.js@3.7.1/dist/chart.min.js"></script>
-    <script
-      src="https://cdn.jsdelivr.net/npm/chartjs-adapter-date-fns@2.0.0/dist/chartjs-adapter-date-fns.bundle.min.js"
-    ></script>
+    <script type="importmap">
+    {
+      "imports": {
+        "chartkick": "./javascript/chartkick.js",
+        "Chart.bundle": "./javascript/Chart.bundle.js"
+      }
+    }
+    </script>
+    <script type="module" src="javascript/index.js"></script>
+
     <link
       rel="preload"
       href="fonts/Rubik.woff2"

data/lib/puny_monitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PunyMonitor
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/system_utils.rb

@@ -13,9 +13,9 @@ class SystemUtils
       idle = current_cpu[:idle] + current_cpu[:iowait]
 
       prev_non_idle = prev_cpu[:user] + prev_cpu[:nice] + prev_cpu[:system] +
-                      prev_cpu[:irq] + prev_cpu[:softirq] + prev_cpu[:steal]
+        prev_cpu[:irq] + prev_cpu[:softirq] + prev_cpu[:steal]
       non_idle = current_cpu[:user] + current_cpu[:nice] + current_cpu[:system] +
-                 current_cpu[:irq] + current_cpu[:softirq] + current_cpu[:steal]
+        current_cpu[:irq] + current_cpu[:softirq] + current_cpu[:steal]
 
       prev_total = prev_idle + prev_non_idle
       total = idle + non_idle
@@ -29,8 +29,8 @@ class SystemUtils
 
     def cpu_load_average
       File.read("#{proc_path}/loadavg").split.take(3)
-          .map(&:to_f)
-          .map { |value| value.round(2) }
+        .map(&:to_f)
+        .map { |value| value.round(2) }
     end
 
     def memory_usage_percent
@@ -111,16 +111,16 @@ class SystemUtils
 
     def read_disk_stats
       primary_disk = File.read("#{proc_path}/partitions")
-                         .lines
-                         .drop(2)
-                         .first
-                         .split
-                         .last
+        .lines
+        .drop(2)
+        .first
+        .split
+        .last
 
       stats = File.read("#{proc_path}/diskstats")
-                  .lines
-                  .map(&:split)
-                  .find { |line| line[2] == primary_disk }
+        .lines
+        .map(&:split)
+        .find { |line| line[2] == primary_disk }
 
       {
         read_sectors: stats[5].to_i,
@@ -130,14 +130,14 @@ class SystemUtils
 
     def read_network_stats
       primary_interface = File.read("#{proc_path}/net/route")
-                              .lines
-                              .drop(1)
-                              .find { |line| line.split[1] == "00000000" }
-                              &.split&.first
+        .lines
+        .drop(1)
+        .find { |line| line.split[1] == "00000000" }
+        &.split&.first
       stats = File.read("#{proc_path}/net/dev")
-                  .lines
-                  .map(&:split)
-                  .find { |line| line[0].chomp(":") == primary_interface }
+        .lines
+        .map(&:split)
+        .find { |line| line[0].chomp(":") == primary_interface }
 
       {
         rx_bytes: stats[1].to_i,