raygatherer 0.1.0 → 0.3.0

data/lib/raygatherer/commands/time/sync.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "time"
+require_relative "../base"
+
+module Raygatherer
+  module Commands
+    module Time
+      class Sync < Base
+        def run
+          with_error_handling do
+            parse_options
+
+            time_data = @api_client.fetch_time
+            device_system_time = ::Time.parse(time_data["system_time"])
+            offset = (::Time.now - device_system_time).round
+            @api_client.set_time_offset(offset)
+            @stdout.puts "Clock synced. Offset: #{offset}s"
+
+            EXIT_CODE_SUCCESS
+          end
+        end
+
+        private
+
+        def parse_options
+          OptionParser.new do |opts|
+            opts.banner = "Usage: raygatherer time sync"
+            opts.separator ""
+            opts.separator "Options:"
+
+            add_help_option(opts)
+          end.parse!(@argv)
+        end
+
+        def show_help(output = @stdout)
+          output.puts "Usage: raygatherer [global options] time sync"
+          output.puts ""
+          output.puts "Syncs the device clock to this machine's time."
+          output.puts ""
+          output.puts "Options:"
+          output.puts "    -h, --help                       Show this help message"
+          output.puts ""
+          print_global_options(output)
+          output.puts ""
+          output.puts "Examples:"
+          output.puts "  raygatherer --host http://192.168.1.100:8080 time sync"
+        end
+      end
+    end
+  end
+end

data/lib/raygatherer/commands/update/status.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "optparse"
+require_relative "../base"
+require_relative "../../formatters/update_status_json"
+require_relative "../../formatters/update_status_human"
+
+module Raygatherer
+  module Commands
+    module Update
+      class Status < Base
+        EXIT_CODE_UPDATE_AVAILABLE = 20
+
+        def run
+          with_error_handling do
+            parse_options
+
+            status = @api_client.fetch_update_status
+
+            warn_if_rayhunter_outdated(status["current_version"]) if status["current_version"]
+
+            formatter = @json ? Formatters::UpdateStatusJSON.new : Formatters::UpdateStatusHuman.new
+            @stdout.puts formatter.format(status)
+
+            status["update_available"] ? EXIT_CODE_UPDATE_AVAILABLE : EXIT_CODE_SUCCESS
+          end
+        end
+
+        private
+
+        def parse_options
+          OptionParser.new do |opts|
+            opts.banner = "Usage: raygatherer update status [options]"
+            opts.separator ""
+            opts.separator "Options:"
+
+            add_help_option(opts)
+          end.parse!(@argv)
+        end
+
+        def show_help(output = @stdout)
+          output.puts "Usage: raygatherer [global options] update status [options]"
+          output.puts ""
+          output.puts "Options:"
+          output.puts "    -h, --help                       Show this help message"
+          output.puts ""
+          print_global_options(output, json: true)
+          output.puts ""
+          output.puts "Exit Codes:"
+          output.puts "    #{EXIT_CODE_SUCCESS}   Up to date (or auto_check_updates is disabled on the device)"
+          output.puts "    #{EXIT_CODE_ERROR}   Error (connection, parse, missing --host, etc.)"
+          output.puts "    #{EXIT_CODE_UPDATE_AVAILABLE}  Update available"
+          output.puts ""
+          output.puts "Examples:"
+          output.puts "  raygatherer --host http://192.168.1.100:8080 update status"
+          output.puts "  raygatherer --host http://192.168.1.100:8080 --json update status"
+          output.puts "  raygatherer --host http://rayhunter update status; [ $? -eq #{EXIT_CODE_UPDATE_AVAILABLE} ] && telegram-send 'Rayhunter update available!'"
+        end
+      end
+    end
+  end
+end

data/lib/raygatherer/commands/wifi/scan.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "optparse"
+require_relative "../base"
+require_relative "../../formatters/wifi_scan_json"
+require_relative "../../formatters/wifi_scan_human"
+
+module Raygatherer
+  module Commands
+    module Wifi
+      class Scan < Base
+        def run
+          with_error_handling do
+            parse_options
+
+            networks = @api_client.scan_wifi
+
+            formatter = @json ? Formatters::WifiScanJSON.new : Formatters::WifiScanHuman.new
+            @stdout.puts formatter.format(networks)
+
+            EXIT_CODE_SUCCESS
+          end
+        end
+
+        private
+
+        def parse_options
+          OptionParser.new do |opts|
+            opts.banner = "Usage: raygatherer wifi scan [options]"
+            opts.separator ""
+            opts.separator "Options:"
+
+            add_help_option(opts)
+          end.parse!(@argv)
+        end
+
+        def show_help(output = @stdout)
+          output.puts "Usage: raygatherer [global options] wifi scan [options]"
+          output.puts ""
+          output.puts "Scan for nearby wifi networks the device could connect to as a client."
+          output.puts ""
+          output.puts "Options:"
+          output.puts "    -h, --help                       Show this help message"
+          output.puts ""
+          print_global_options(output, json: true)
+          output.puts ""
+          output.puts "Examples:"
+          output.puts "  raygatherer --host http://192.168.1.100:8080 wifi scan"
+          output.puts "  raygatherer --host http://192.168.1.100:8080 --json wifi scan"
+        end
+      end
+    end
+  end
+end

data/lib/raygatherer/commands/wifi/show.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "optparse"
+require_relative "../base"
+require_relative "../../formatters/wifi_status_json"
+require_relative "../../formatters/wifi_status_human"
+
+module Raygatherer
+  module Commands
+    module Wifi
+      class Show < Base
+        def run
+          with_error_handling do
+            parse_options
+
+            status = @api_client.fetch_wifi_status
+
+            formatter = @json ? Formatters::WifiStatusJSON.new : Formatters::WifiStatusHuman.new
+            @stdout.puts formatter.format(status)
+
+            EXIT_CODE_SUCCESS
+          end
+        end
+
+        private
+
+        def parse_options
+          OptionParser.new do |opts|
+            opts.banner = "Usage: raygatherer wifi show [options]"
+            opts.separator ""
+            opts.separator "Options:"
+
+            add_help_option(opts)
+          end.parse!(@argv)
+        end
+
+        def show_help(output = @stdout)
+          output.puts "Usage: raygatherer [global options] wifi show [options]"
+          output.puts ""
+          output.puts "Show the device's wifi client connection status (the daemon's own outbound"
+          output.puts "connection to an upstream network, separate from the AP it hosts)."
+          output.puts ""
+          output.puts "Options:"
+          output.puts "    -h, --help                       Show this help message"
+          output.puts ""
+          print_global_options(output, json: true)
+          output.puts ""
+          output.puts "Examples:"
+          output.puts "  raygatherer --host http://192.168.1.100:8080 wifi show"
+          output.puts "  raygatherer --host http://192.168.1.100:8080 --json wifi show"
+        end
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/{human.rb → alerts_human.rb}

@@ -2,7 +2,7 @@
 
 module Raygatherer
   module Formatters
-    class Human
+    class AlertsHuman
       def format(alerts)
         if alerts.empty?
           colorize("✓ No alerts detected", :green)

data/lib/raygatherer/formatters/{json.rb → alerts_json.rb}

@@ -4,7 +4,7 @@ require "json"
 
 module Raygatherer
   module Formatters
-    class JSON
+    class AlertsJSON
       def format(alerts)
         output = alerts.map do |alert|
           {
@@ -15,7 +15,7 @@ module Raygatherer
           }
         end
 
-        ::JSON.generate(output)
+        JSON.generate(output)
       end
     end
   end

data/lib/raygatherer/formatters/analysis_report_human.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "time"
+
+module Raygatherer
+  module Formatters
+    class AnalysisReportHuman
+      def format(data)
+        metadata = data[:metadata] || {}
+        rows = data[:rows] || []
+
+        lines = []
+        lines << format_header(metadata)
+        lines << format_analyzers(metadata)
+        lines << ""
+
+        rows.each do |row|
+          lines.concat(format_row(row, metadata))
+        end
+
+        lines.join("\n")
+      end
+
+      private
+
+      def format_header(metadata)
+        rayhunter = metadata["rayhunter"] || {}
+        version = rayhunter["rayhunter_version"]
+        os = rayhunter["system_os"]
+        arch = rayhunter["arch"]
+        report_version = metadata["report_version"]
+
+        parts = []
+        parts << "Rayhunter v#{version}" if version
+        os_arch = [os, arch].compact.join(" ")
+        parts << os_arch unless os_arch.empty?
+        parts << "Report version #{report_version}" if report_version
+
+        parts.join("  |  ")
+      end
+
+      def format_analyzers(metadata)
+        analyzers = metadata["analyzers"] || []
+        return "Analyzers: (none)" if analyzers.empty?
+
+        names = analyzers.filter_map do |a|
+          next unless a
+          v = a["version"] ? " (v#{a["version"]})" : ""
+          "#{a["name"]}#{v}"
+        end
+
+        "Analyzers: #{names.join(", ")}"
+      end
+
+      def format_row(row, metadata)
+        analyzers = metadata["analyzers"] || []
+        timestamp = format_timestamp(row["packet_timestamp"])
+
+        if (reason = row["skipped_message_reason"])
+          return ["#{timestamp}  Skipped: #{reason}"]
+        end
+
+        events = row["events"] || []
+        present_events = events.each_with_index.reject { |e, _| e.nil? }
+
+        if present_events.empty?
+          return ["#{timestamp}  No events"]
+        end
+
+        present_events.map do |event, index|
+          event_type = event["event_type"] || "Unknown"
+          message = event["message"]
+          analyzer = analyzers.dig(index, "name")
+          analyzer_part = analyzer ? "(#{analyzer}) " : ""
+          "#{timestamp}  #{event_type.ljust(13)}  #{analyzer_part}#{message}"
+        end
+      end
+
+      def format_timestamp(ts)
+        return "[no timestamp]" unless ts
+        time = Time.parse(ts).utc
+        "[#{time.strftime("%Y-%m-%d %H:%M:%S UTC")}]"
+      rescue ArgumentError
+        "[#{ts}]"
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/analysis_report_json.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Raygatherer
+  module Formatters
+    class AnalysisReportJSON
+      def format(data)
+        ::JSON.generate({"metadata" => data[:metadata], "rows" => data[:rows]})
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/config_human.rb

@@ -7,12 +7,49 @@ module Raygatherer
         lines = []
 
         lines << "Port: #{config["port"]}"
-        lines << "Readonly port: #{config["readonly_port"]}"
         lines << "QMDL store path: #{config["qmdl_store_path"]}"
+        lines << "Device: #{config["device"]}" if config.key?("device")
+        lines << "Debug mode: #{config["debug_mode"]}" if config.key?("debug_mode")
+        lines << "UI level: #{config["ui_level"]}" if config.key?("ui_level")
+        lines << "Colorblind mode: #{config["colorblind_mode"]}" if config.key?("colorblind_mode")
+        lines << "Key input mode: #{config["key_input_mode"]}" if config.key?("key_input_mode")
 
-        notification_url = config["notification_url"]
+        notification_url = config["ntfy_url"] || config["notification_url"]
         lines << "Notification URL: #{notification_url || "(not set)"}"
 
+        if config.key?("enabled_notifications")
+          lines << "Notifications enabled: #{config["enabled_notifications"].join(", ")}"
+        end
+
+        if config.key?("min_space_to_start_recording_mb")
+          lines << "Min space to start recording: #{config["min_space_to_start_recording_mb"]} MB"
+        end
+        if config.key?("min_space_to_continue_recording_mb")
+          lines << "Min space to continue recording: #{config["min_space_to_continue_recording_mb"]} MB"
+        end
+
+        lines << "Auto check updates: #{config["auto_check_updates"]}" if config.key?("auto_check_updates")
+        lines << "Clock sync mode: #{config["clock_sync_mode"]}" if config.key?("clock_sync_mode")
+        lines << "GPS mode: #{config["gps_mode"]}" if config.key?("gps_mode")
+        lines << "GPS fixed latitude: #{config["gps_fixed_latitude"]}" if config["gps_fixed_latitude"]
+        lines << "GPS fixed longitude: #{config["gps_fixed_longitude"]}" if config["gps_fixed_longitude"]
+        lines << "WiFi enabled: #{config["wifi_enabled"]}" if config.key?("wifi_enabled")
+        lines << "WiFi SSID: #{config["wifi_ssid"]}" if config["wifi_ssid"]
+        lines << "WiFi security: #{config["wifi_security"]}" if config["wifi_security"]
+        lines << "DNS servers: #{config["dns_servers"].join(", ")}" if config["dns_servers"]&.any?
+
+        webdav = config["webdav"]
+        if webdav && !webdav["url"].to_s.empty?
+          lines << ""
+          lines << "WebDAV:"
+          lines << "  URL: #{webdav["url"]}"
+          lines << "  Username: #{webdav["username"]}" if webdav["username"]
+          lines << "  Upload timeout: #{webdav["upload_timeout_secs"]}s" if webdav.key?("upload_timeout_secs")
+          lines << "  Poll interval: #{webdav["poll_interval_secs"]}s" if webdav.key?("poll_interval_secs")
+          lines << "  Min age: #{webdav["min_age_secs"]}s" if webdav.key?("min_age_secs")
+          lines << "  Delete on upload: #{webdav["delete_on_upload"]}" if webdav.key?("delete_on_upload")
+        end
+
         analyzers = config["analyzers"]
         if analyzers
           lines << ""

data/lib/raygatherer/formatters/gps_human.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Raygatherer
+  module Formatters
+    class GpsHuman
+      def format(gps)
+        return "No GPS position recorded yet (nothing has been submitted to /api/gps this session)." if gps.nil?
+
+        "Latitude:  #{gps["latitude"]}\nLongitude: #{gps["longitude"]}"
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/gps_json.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Raygatherer
+  module Formatters
+    class GpsJSON
+      def format(gps)
+        ::JSON.generate(gps)
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/recording_list_human.rb

@@ -59,13 +59,18 @@ module Raygatherer
 
         lines << "  Size:         #{format_size(entry["qmdl_size_bytes"])}"
 
+        if !active && entry["stop_reason"]
+          lines << "  Stop reason:  #{entry["stop_reason"]}"
+        end
+
         lines.join("\n")
       end
 
       def format_time(time_string)
         return "" unless time_string
-
         Time.parse(time_string).strftime("%Y-%m-%d %H:%M:%S")
+      rescue ArgumentError
+        time_string
       end
     end
   end

data/lib/raygatherer/formatters/time_human.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Raygatherer
+  module Formatters
+    class TimeHuman
+      def format(time)
+        lines = []
+        lines << "System time:   #{time["system_time"]}"
+        lines << "Adjusted time: #{time["adjusted_time"]}"
+        lines << "Offset:        #{time["offset_seconds"]}s"
+        lines.join("\n")
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/time_json.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Raygatherer
+  module Formatters
+    class TimeJSON
+      def format(time)
+        ::JSON.generate(time)
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/update_status_human.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Raygatherer
+  module Formatters
+    class UpdateStatusHuman
+      def format(status)
+        lines = []
+
+        lines << "Current version: #{status["current_version"]}"
+        lines << "Update available: #{status["update_available"] ? "yes" : "no"}"
+        lines << "Latest version: #{status["latest_version"]}" if status["latest_version"]
+        lines << "Release notes: #{status["latest_release_url"]}" if status["latest_release_url"]
+        lines << "Last checked: #{status["last_checked"]}" if status["last_checked"]
+        lines << "Last error: #{status["last_error"]}" if status["last_error"]
+
+        if status["latest_version"].nil? && status["last_checked"].nil?
+          lines << ""
+          lines << "No update check has run yet — check that auto_check_updates is enabled in rayhunter's config."
+        end
+
+        lines.join("\n")
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/update_status_json.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Raygatherer
+  module Formatters
+    class UpdateStatusJSON
+      def format(status)
+        ::JSON.generate(status)
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/wifi_scan_human.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Raygatherer
+  module Formatters
+    class WifiScanHuman
+      def format(networks)
+        return "No networks found" if networks.empty?
+
+        lines = ["Networks: #{networks.length}", ""]
+        networks.each do |network|
+          lines << "#{network["ssid"]} (#{network["signal_dbm"]} dBm, #{network["security"]})"
+        end
+        lines.join("\n")
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/wifi_scan_json.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Raygatherer
+  module Formatters
+    class WifiScanJSON
+      def format(networks)
+        ::JSON.generate(networks)
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/wifi_status_human.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Raygatherer
+  module Formatters
+    class WifiStatusHuman
+      def format(status)
+        lines = []
+
+        lines << "State: #{status["state"]}"
+        lines << "SSID: #{status["ssid"]}" if status["ssid"]
+        lines << "IP: #{status["ip"]}" if status["ip"]
+        lines << "TX packets: #{status["txPackets"]}" if status["txPackets"]
+        lines << "Error: #{status["error"]}" if status["error"]
+
+        lines.join("\n")
+      end
+    end
+  end
+end

data/lib/raygatherer/formatters/wifi_status_json.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Raygatherer
+  module Formatters
+    class WifiStatusJSON
+      def format(status)
+        ::JSON.generate(status)
+      end
+    end
+  end
+end

data/lib/raygatherer/version.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
 module Raygatherer
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
+
+  # The rayhunter daemon version this release was last verified against. Used only to warn
+  # when talking to an older daemon that may lack fields/endpoints raygatherer expects;
+  # never enforced.
+  TESTED_RAYHUNTER_VERSION = "0.12.0"
 end

data/lib/raygatherer.rb

@@ -4,16 +4,28 @@ require_relative "raygatherer/version"
 require_relative "raygatherer/config"
 require_relative "raygatherer/cli"
 require_relative "raygatherer/api_client"
-require_relative "raygatherer/formatters/human"
-require_relative "raygatherer/formatters/json"
+require_relative "raygatherer/formatters/alerts_human"
+require_relative "raygatherer/formatters/alerts_json"
 require_relative "raygatherer/formatters/recording_list_json"
 require_relative "raygatherer/formatters/recording_list_human"
 require_relative "raygatherer/formatters/stats_json"
 require_relative "raygatherer/formatters/stats_human"
 require_relative "raygatherer/formatters/analysis_status_json"
 require_relative "raygatherer/formatters/analysis_status_human"
+require_relative "raygatherer/formatters/analysis_report_json"
+require_relative "raygatherer/formatters/analysis_report_human"
 require_relative "raygatherer/formatters/config_json"
 require_relative "raygatherer/formatters/config_human"
+require_relative "raygatherer/formatters/time_json"
+require_relative "raygatherer/formatters/time_human"
+require_relative "raygatherer/formatters/update_status_json"
+require_relative "raygatherer/formatters/update_status_human"
+require_relative "raygatherer/formatters/gps_json"
+require_relative "raygatherer/formatters/gps_human"
+require_relative "raygatherer/formatters/wifi_status_json"
+require_relative "raygatherer/formatters/wifi_status_human"
+require_relative "raygatherer/formatters/wifi_scan_json"
+require_relative "raygatherer/formatters/wifi_scan_human"
 require_relative "raygatherer/spinner"
 require_relative "raygatherer/commands/base"
 require_relative "raygatherer/commands/alerts"
@@ -22,12 +34,22 @@ require_relative "raygatherer/commands/recording/download"
 require_relative "raygatherer/commands/recording/delete"
 require_relative "raygatherer/commands/recording/stop"
 require_relative "raygatherer/commands/recording/start"
+require_relative "raygatherer/commands/log"
 require_relative "raygatherer/commands/stats"
 require_relative "raygatherer/commands/analysis/status"
 require_relative "raygatherer/commands/analysis/run"
+require_relative "raygatherer/commands/analysis/report"
 require_relative "raygatherer/commands/config/show"
 require_relative "raygatherer/commands/config/set"
 require_relative "raygatherer/commands/config/test_notification"
+require_relative "raygatherer/commands/debug/display_state"
+require_relative "raygatherer/commands/time/show"
+require_relative "raygatherer/commands/time/sync"
+require_relative "raygatherer/commands/update/status"
+require_relative "raygatherer/commands/gps/show"
+require_relative "raygatherer/commands/gps/set"
+require_relative "raygatherer/commands/wifi/show"
+require_relative "raygatherer/commands/wifi/scan"
 
 module Raygatherer
   class Error < StandardError; end