watchfor 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5ad40afc1187be8bcdf41c4c418b3c18b304b097a901219edfe777ae41087d1
-  data.tar.gz: b4da046bc763240825953b51a69e13e50838272d7e642bf78f450b4f7914810d
+  metadata.gz: 3af4a4c0ee9b7d5b20fc4873a6710d37cc3d4c2d5197ff8a41fc108bc5c1bd38
+  data.tar.gz: 4ca5dea1cb43c7f1a2afc51c0eaf05048e1f5fd2db6f2545b4ebcc7d822e227b
 SHA512:
-  metadata.gz: 73e41e8dc6673385ab4bfca74bb41a6e2d83d08429b88ff1bf826c835201295eda5c5b1edd76cf32518cb86ba9829b4b8d9b4641e9f1ee0f5a50743e2fe848e6
-  data.tar.gz: 1a4951d407a131eec5206d4b909de80a26f4833aaa916a08aa914846c6f71b8b6161cb5ceb90b982c3a0a2ce91fb465d5f7c297ce7bac2db92215e3b3481160d
+  metadata.gz: 8ff5740ebc2e684b7aace9f419e0801b6e01d03c1770202a4670361023818c64ae2c43fbdb76787bffc714999411f6be30d7c765daaee73300ce04f1e9573a1e
+  data.tar.gz: 90f73616551e75ddf5e0093653609cd3375f7445d3bd1880b0159d0981cfd1947051037e908765feaa75bb7a2489cf2352a20cb150666fec3ed7c2727ca8ca0d

data/README.md

@@ -113,7 +113,7 @@ Runs need a `write` key (a probe sends real traffic from WatchFor's IPs)
 and spend the same per-plan hourly allowance as the dashboard Toolbox.
 Details: <https://watchfor.io/docs/api/diagnostics>
 
-Namespaces: `wf.monitors`, `wf.alert_rules`, `wf.incidents`,
+Namespaces: `wf.organizations`, `wf.monitors`, `wf.alert_rules`, `wf.incidents`,
 `wf.hosts`, `wf.status_pages`, `wf.on_call`, `wf.notification_channels`, `wf.maintenance_windows`, `wf.contacts`, `wf.contact_groups`,
 `wf.diagnostics`, `wf.playwright`, `wf.variables`. Top-level:
 `wf.summary`, `wf.plan`, `wf.me`, `wf.locations`, `wf.monitor_types`,
@@ -129,12 +129,21 @@ belongs to; choose one with `organization:` — the SDK sends it as the
 `X-WatchFor-Organization` header on every request:
 
 ```ruby
+wf = Watchfor::Client.new(api_key: oauth_access_token)
+wf.organizations.list["data"].each do |org|
+  puts "#{org['id']} #{org['name']} #{org['role']} is_default=#{org['is_default']} is_current=#{org['is_current']}"
+end
+
 acme = Watchfor::Client.new(api_key: oauth_access_token, organization: "<organization-id>")
 acme.me # {"organization" => {"id", "name", "slug"}, "scope" => ...}
 other = acme.with_organization("<another-organization-id>") # new client, same token
 other.monitors.list
 ```
 
+- `organizations.list` returns the ids to use: every organization of the
+  token's user with their `role`, `is_default` (used without `organization:`)
+  and `is_current` (what this client acts on). With an API key it returns just
+  the key's own organization (`role` is `nil`).
 - Without `organization:`, an OAuth token acts on the user's oldest owned
   organization (else their oldest membership).
 - The user must be a member of that organization (otherwise `403
@@ -165,6 +174,7 @@ watchfor incidents
 watchfor checks <monitor_id> [--cursor <next_cursor>]
 watchfor report --period 30d
 watchfor me                       # which organization + scope
+watchfor organizations            # ids for --organization
 
 # OAuth token: pick the organization per call or via the environment
 export WATCHFOR_API_KEY=<oauth-access-token>

data/exe/watchfor

@@ -42,6 +42,7 @@ begin
   result =
     case command
     when "me" then wf.me
+    when "organizations", "orgs" then wf.organizations.list
     when "summary" then wf.summary
     when "plan" then wf.plan
     when "monitors" then wf.monitors.list
@@ -60,7 +61,7 @@ begin
       exit 0
     else
       warn "Usage: watchfor [--organization <id>] " \
-           "[me|summary|plan|monitors|locations|monitor-types|incidents|checks <monitor_id> [--cursor c]|" \
+           "[me|organizations|summary|plan|monitors|locations|monitor-types|incidents|checks <monitor_id> [--cursor c]|" \
            "report [--period 7d|30d]|metrics [--tag t] [--type t]]\n" \
            "Env: WATCHFOR_API_KEY (API key or OAuth access token), WATCHFOR_ORGANIZATION, WATCHFOR_BASE_URL"
       exit 2

data/lib/watchfor/client.rb

@@ -36,7 +36,7 @@ module Watchfor
   # An API key belongs to one organization: leave +organization:+ unset, or
   # pass that same id (any other id is 403 forbidden).
   class Client
-    attr_reader :monitors, :alert_rules, :incidents, :hosts, :status_pages, :on_call, :notification_channels,
+    attr_reader :organizations, :monitors, :alert_rules, :incidents, :hosts, :status_pages, :on_call, :notification_channels,
                 :maintenance_windows, :contacts, :contact_groups,
                 :diagnostics, :playwright, :variables, :organization
 
@@ -48,6 +48,7 @@ module Watchfor
       @timeout = timeout
       org = organization.to_s.strip
       @organization = org.empty? ? nil : org
+      @organizations = Organizations.new(self)
       @monitors = Monitors.new(self)
       @alert_rules = AlertRules.new(self)
       @incidents = Incidents.new(self)
@@ -268,6 +269,15 @@ module Watchfor
       def delete(name) = @c.request("DELETE", "/variables/#{name}")
     end
 
+    # The organizations this credential can act on: the ids +organization:+ /
+    # +with_organization+ accept. An OAuth token lists every organization of
+    # its user ("role", plus "is_default" for the one used without
+    # +organization:+ and "is_current" for the one the request acted on); an
+    # API key only its own ("role" nil).
+    class Organizations < Namespace
+      def list = @c.request("GET", "/organizations")
+    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.15.0"
+  VERSION = "0.16.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watchfor
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - WatchFor