watchfor 0.11.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30416669c4f7bb2b6361e750e035cd588c36911d9a1dea6d4805dd82c90edc0d
-  data.tar.gz: fbca77d7ef766ebf9b8579a3247935919bc877e966f1fed665d09d79f5437124
+  metadata.gz: 24445c1731afb7a7acc92e91e6e96ddae0c59d837111c2addcd5fed3c0d3727d
+  data.tar.gz: f38989c598bca87881af765542036fe1b8fb310c7c8c75a64487e4ef22bfa5a9
 SHA512:
-  metadata.gz: c9a3425976be45501efba88d5d777552ad53230ce6db50b30f6e91c26da3d06003b1e6ba3ef0b518350782dc9b0e55a82e17b6368a6fe23d13cdafe3377df53b
-  data.tar.gz: 87e6389322c82c4cbb9b79ec25a808a9db0c0c4c9e8c4cccd26bd9ad58dc812d2ade6210a3ecd705c418b3d4b9d0c9dc4142198f7608f2b047f2817530ae8347
+  metadata.gz: 1e9b130b18719ef0a4a08ba2df4c17b245884222e00cd140a6164a10bc8026098d99cf3db469bfea2af0b44cb98d286ddf5231d62967a2a95d1df75974a7d316
+  data.tar.gz: bb479462a71d46c19220fbd488c628f69bfce49b07cc6daa5430b6fc1ff3f58cf56598b2fcb3f601f086aeb60e406cc415530880cb206486ae337d95fd5e4b95

data/README.md

@@ -48,6 +48,11 @@ 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)
 
+# The same org secrets in HTTP/API/MCP checks: {{NAME}} in auth, a header or the body
+wf.variables.put("API_TOKEN", value: token, secret: true)
+wf.monitors.update(api_monitor_id, { config: { requestHeaders: [
+  { key: "Authorization", value: "Bearer {{API_TOKEN}}" }] } })
+
 # 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"]
@@ -90,6 +95,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

@@ -51,7 +51,7 @@ module Watchfor
     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 == "" }
@@ -65,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?
@@ -80,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"] || {}) : {}
@@ -92,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 })
 
@@ -123,7 +133,16 @@ module Watchfor
       def list(**query) = @c.request("GET", "/monitors", query: query)
       # The monitor plus available_metrics (alert metrics valid for its type).
       def get(id) = @c.request("GET", "/monitors/#{id}")
+      # Credentials (catalog fields marked secret: mailbox/SMTP/FTP passwords,
+      # SSH keys, HTTP/API/MCP auth passwords, bearer tokens and credential
+      # header values) are write-only: stored encrypted, returned as
+      # "[redacted]". {{NAME}} in an auth field, header or body uses an org
+      # variable or secret.
       def create(body, idempotency_key: nil) = @c.request("POST", "/monitors", body: body, idempotency_key: idempotency_key)
+      # config is merged (omitted keys kept, nil removes). A "[redacted]"
+      # credential is kept when omitted or sent back; changing the server,
+      # port, TLS mode or login it is used with (HTTP: the URL's host, port
+      # or scheme) needs it again (else 400).
       def update(id, body) = @c.request("PATCH", "/monitors/#{id}", body: body)
       def delete(id) = @c.request("DELETE", "/monitors/#{id}")
       def pause(id) = @c.request("POST", "/monitors/#{id}/pause")
@@ -168,7 +187,8 @@ module Watchfor
       def get_test_run(id) = @c.request("GET", "/playwright/test-runs/#{id}")
     end
 
-    # Org variables and secrets (process.env.NAME); secrets are write-only.
+    # Org variables and secrets (process.env.NAME in browser checks, {{NAME}}
+    # in HTTP/API/MCP checks); secrets are write-only.
     class Variables < Namespace
       def list = @c.request("GET", "/variables")
       def put(name, value: nil, secret: false)

data/lib/watchfor/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: watchfor
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.1
 platform: ruby
 authors:
 - WatchFor
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-01 00:00:00.000000000 Z
+date: 1980-01-02 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.
@@ -33,7 +32,6 @@ metadata:
   documentation_uri: https://watchfor.io/docs/api
   changelog_uri: https://watchfor.io/changelog
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -48,8 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Official Ruby SDK + CLI for WatchFor — uptime & infrastructure monitoring.
 test_files: []