watchfor 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4922ce5a8ab3f8757d67110dd6705ec23cd07190e2ce12fb8e3a76b0bef72cd7
-  data.tar.gz: 53ae8a93fb27b7e96ca47cd7383fbbbc1207c1cadc597316429b6b4f43232521
+  metadata.gz: b3d7fc66146ff02aa81bb3517188f14d8ce8c04b9b643b869aba9793610560b6
+  data.tar.gz: 19c2c8f08062072d54a90fe7d848b30ae24b5997a6179ba3aac6ddd5e31008be
 SHA512:
-  metadata.gz: a6fcfeb516a7621f6aa6b8dc18eb0492b928052158aee32cd51319344d06e210006527303927f5453f1b0106fcfe4dafeb10f18ea3b1584670b6532b8049f714
-  data.tar.gz: 37a2e3ad2df077d130609042d0c61cb2aabb8bacb1d9f56c2fff503f819f09d5847f5d6e33334c3267342d91f504f5e3811888c336e447a91341d6cf8386510d
+  metadata.gz: c53ae17ddbc628f745c8099df3d1425627c1da778e616fd2a4cfc8bfca0680b56ff188881383d8f1f6cc10b68f42f53264b1cbc3ebf5f33cc4f8fb069045a703
+  data.tar.gz: b2214618bce3e48a10c5c8bbac5c4ee60f79281445472bde3fe225e82606297b21c7e087d12da41f68a0e20c15d8e6863846608165064add64511a8562940dd2

data/README.md

@@ -43,6 +43,11 @@ wf.monitors.reset(mon["id"])
 # Page integrity: after a deploy, accept what the newest check saw as the new baseline
 wf.monitors.accept_baseline(integrity_monitor_id)
 
+# Browser checks: try a Playwright script once (nothing saved), then read the result
+run = wf.playwright.test_run(script: script, target: "https://shop.example.com")
+wf.playwright.get_test_run(run["id"]) # status: queued | running | done | error
+wf.variables.put("LOGIN_PASSWORD", value: password, secret: true)
+
 # Older checks: pass next_cursor back as cursor (keep the same hours/success)
 page = wf.monitors.checks(mon["id"], hours: 24, limit: 100)
 wf.monitors.checks(mon["id"], hours: 24, limit: 100, cursor: page["next_cursor"]) if page["next_cursor"]
@@ -85,6 +90,14 @@ Namespaces: `wf.monitors`, `wf.alert_rules`, `wf.incidents`,
 `wf.incident_stats(period)`, `wf.notifications`, `wf.activity`. Errors raise
 `Watchfor::Error` with `#status`, `#code`, `#message`.
 
+## Prometheus metrics (Pro plan and above)
+
+```ruby
+text = wf.metrics(tag: "production") # Prometheus text format
+```
+
+Usually you point Prometheus at `https://watchfor.io/api/v1/metrics` directly; this is for scripts and one-off checks. See https://watchfor.io/docs/api/prometheus.
+
 ## CLI
 
 ```bash

data/exe/watchfor

@@ -36,8 +36,13 @@ begin
       cursor = args.include?("--cursor") ? args[args.index("--cursor") + 1] : nil
       wf.monitors.checks(monitor_id, cursor: cursor)
     when "report" then wf.report(period: args.include?("--period") ? args[args.index("--period") + 1] : nil)
+    when "metrics"
+      tag = args.include?("--tag") ? args[args.index("--tag") + 1] : nil
+      type = args.include?("--type") ? args[args.index("--type") + 1] : nil
+      print wf.metrics(tag: tag, type: type)
+      exit 0
     else
-      warn "Usage: watchfor [summary|plan|monitors|locations|monitor-types|incidents|checks <monitor_id> [--cursor c]|report [--period 7d|30d]]"
+      warn "Usage: watchfor [summary|plan|monitors|locations|monitor-types|incidents|checks <monitor_id> [--cursor c]|report [--period 7d|30d]|metrics [--tag t] [--type t]]"
       exit 2
     end
   puts JSON.pretty_generate(result)

data/lib/watchfor/client.rb

@@ -27,7 +27,7 @@ module Watchfor
   class Client
     attr_reader :monitors, :alert_rules, :incidents, :hosts, :status_pages, :on_call, :notification_channels,
                 :maintenance_windows, :contacts, :contact_groups,
-                :diagnostics
+                :diagnostics, :playwright, :variables
 
     def initialize(api_key:, base_url: DEFAULT_BASE_URL, timeout: 30)
       raise ArgumentError, "api_key is required" if api_key.nil? || api_key.empty?
@@ -46,10 +46,12 @@ module Watchfor
       @contacts = Contacts.new(self)
       @contact_groups = ContactGroups.new(self)
       @diagnostics = Diagnostics.new(self)
+      @playwright = Playwright.new(self)
+      @variables = Variables.new(self)
     end
 
     # Core request. +query+ and +body+ are optional hashes.
-    def request(method, path, query: nil, body: nil, idempotency_key: nil)
+    def request(method, path, query: nil, body: nil, idempotency_key: nil, text: false)
       uri = URI("#{@base_url}#{path}")
       unless query.nil? || query.empty?
         cleaned = query.reject { |_, v| v.nil? || v == "" }
@@ -63,7 +65,7 @@ module Watchfor
       }.fetch(method)
       req = klass.new(uri)
       req["Authorization"] = "Bearer #{@api_key}"
-      req["Accept"] = "application/json"
+      req["Accept"] = text ? "text/plain, application/json" : "application/json"
       req["User-Agent"] = "watchfor-ruby/#{Watchfor::VERSION}"
       req["Idempotency-Key"] = idempotency_key if idempotency_key
       unless body.nil?
@@ -78,6 +80,8 @@ module Watchfor
       end
 
       raw = res.body.to_s
+      return raw if text && res.code.to_i.between?(200, 299)
+
       parsed = raw.empty? ? nil : (JSON.parse(raw) rescue nil)
       unless res.code.to_i.between?(200, 299)
         err = parsed.is_a?(Hash) ? (parsed["error"] || {}) : {}
@@ -90,6 +94,14 @@ module Watchfor
     # Top-level reads
     def me = request("GET", "/me")
     def summary = request("GET", "/summary")
+
+    # The organization in Prometheus text format (Pro plan and above):
+    # status, uptime, response times, expiry, heartbeats, hosts. Cached 60 s.
+    def metrics(tag: nil, type: nil, monitor_id: nil, include_hosts: nil)
+      query = { tag: tag, type: type, monitor_id: monitor_id,
+                include_hosts: include_hosts.nil? ? nil : include_hosts.to_s }
+      request("GET", "/metrics", query: query, text: true)
+    end
     def plan = request("GET", "/plan")
     def incident_stats(period = nil) = request("GET", "/incidents/stats", query: { period: period })
 
@@ -141,6 +153,14 @@ module Watchfor
       end
       # One check in full detail (redacted).
       def check_detail(id, run_id) = @c.request("GET", "/monitors/#{id}/checks/#{run_id}")
+      # Browser checks: runs, newest first (status: "failed" | "flaky").
+      def runs(id, status: nil, limit: nil, cursor: nil)
+        @c.request("GET", "/monitors/#{id}/runs", query: { status: status, limit: limit, cursor: cursor })
+      end
+      # Browser checks: one run — steps, errors, Web Vitals, screenshots, trace link.
+      def run(id, run_id) = @c.request("GET", "/monitors/#{id}/runs/#{run_id}")
+      def script_versions(id) = @c.request("GET", "/monitors/#{id}/script/versions")
+      def script_version(id, version) = @c.request("GET", "/monitors/#{id}/script/versions/#{version}")
       # Page integrity monitors: the accepted baseline of every watched page.
       def baseline(id) = @c.request("GET", "/monitors/#{id}/baseline")
       # Page integrity monitors: accept what the newest check saw as the new
@@ -152,6 +172,23 @@ module Watchfor
       end
     end
 
+    # Browser checks: run a Playwright script once without saving it.
+    class Playwright < Namespace
+      def test_run(body) = @c.request("POST", "/playwright/test-runs", body: body)
+      def get_test_run(id) = @c.request("GET", "/playwright/test-runs/#{id}")
+    end
+
+    # Org variables and secrets (process.env.NAME); secrets are write-only.
+    class Variables < Namespace
+      def list = @c.request("GET", "/variables")
+      def put(name, value: nil, secret: false)
+        body = { secret: secret }
+        body[:value] = value unless value.nil?
+        @c.request("PUT", "/variables/#{name}", body: body)
+      end
+      def delete(name) = @c.request("DELETE", "/variables/#{name}")
+    end
+
     class AlertRules < Namespace
       def list(monitor_id) = @c.request("GET", "/monitors/#{monitor_id}/alert-rules")
       def get(monitor_id, rule_id) = @c.request("GET", "/monitors/#{monitor_id}/alert-rules/#{rule_id}")

data/lib/watchfor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Watchfor
-  VERSION = "0.10.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watchfor
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - WatchFor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-25 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies: []
 description: Zero-dependency Ruby client for the WatchFor REST API (monitors, alert
   rules, incidents, maintenance windows) plus a `watchfor` CLI.