cloudflare-ruby 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e55c381f1697329fa6cb8bd393493b4b63b31d0f3b4b672d43e61c2799c0c40
-  data.tar.gz: dba84759f533e9203bb0f70404b4d719ece8509a883bb83d2aa5accd607d0375
+  metadata.gz: e840df4dc6ff74e2cb0fddaba160fc041c80472c52f7a583f9c23185d24b8765
+  data.tar.gz: 9a42b0db13ed3d842fb1bc1b9df86011de55223a6667a666e3431bd455d4e4fd
 SHA512:
-  metadata.gz: e90e2f05d9b52b24195ff9d95c9849ff04290ac8d460ec0e59917869125e03cdc176a4717b2c1895891b463076d04ddbf30b17f4a8c52693d0f365bd6bef025f
-  data.tar.gz: 364098f7920cebdb13e6751be1bd28c32ba74b144e5a6f06e947a333a1b49b27efd5da9ae6befa3361253171df1755aa51816494f2b2821ee0190830733337e5
+  metadata.gz: 71d24e6e2fbb63aee5c96e23e581f668207df71b7cc281cc02bfdb8c07e2e377e3a30e5a5888c90a5dd1acb0b0b4a4d734faf779bc9140b51a2400cad6029769
+  data.tar.gz: 9a73874dadf0b7847b5058a4ab40dec0acedb93765438d0c2b96632c376bddf1a9b23f04ee167206c7ee35a138ca8cfabca8c2e6eba66a20bd646050e13f5c7a

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.2.0
+
+- **Default `app_id` per process.** Set `Cloudflare::RealtimeKit.app_id`
+  once at boot and every RealtimeKit call defaults to it; pass `app_id:`
+  per-call only to override. Mirrors the existing `Cloudflare.account_id`
+  pattern. Eliminates `app_id:` repetition in apps that talk to a single
+  RealtimeKit app per process (the common case).
+- `Resource.build_scope` and `extract_scope!` now consult a generic
+  `global_default_for(key)` helper that resolves `:account_id` against
+  `Cloudflare.account_id` and any other key against a same-named
+  accessor on the resource's product namespace
+  (e.g., `:app_id` → `Cloudflare::RealtimeKit.app_id`). Generalizes for
+  future product surfaces.
+- `Recording.start_track`, `Recording.active_for`,
+  `Session.find_participant_by_peer_id`, `Analytics.daywise`, and
+  `Analytics.livestreams_overall` now accept `app_id:` as optional with
+  the default falling through.
+
 ## 0.1.2
 
 - Add `require "bundler/gem_tasks"` to the Rakefile so `rake release`

data/lib/cloudflare/realtime_kit/README.md

@@ -12,10 +12,15 @@ Cloudflare.configure do |c|
   c.account_id = ENV.fetch("CLOUDFLARE_ACCOUNT_ID")
 end
 
+# Default app_id for every RealtimeKit call this process makes.
+# Pass `app_id:` per-call only to override (e.g., admin tools that hop
+# between apps).
+Cloudflare::RealtimeKit.app_id = ENV.fetch("REALTIMEKIT_APP_ID")
+
 RK = Cloudflare::RealtimeKit  # alias to taste
 ```
 
-After that, `account_id:` is implicit on every call — pass it per-call only to override.
+After that, both `account_id:` and `app_id:` are implicit on every call — pass either per-call only to override.
 
 ## Apps
 
@@ -28,6 +33,8 @@ RK::App.all                          # GET  /apps
 
 ## Meetings
 
+Most calls below show `app_id:` for clarity. With `Cloudflare::RealtimeKit.app_id` set globally (see Setup), you can omit it.
+
 ```ruby
 meeting = RK::Meeting.create(app_id: app.id, title: "Standup", record_on_start: true)
 meeting.id            # => "mtg-…"

data/lib/cloudflare/realtime_kit/analytics.rb

@@ -18,14 +18,14 @@ module Cloudflare
     module Analytics
       class << self
         # GET /analytics/daywise — daily breakdown of meeting activity.
-        def daywise(app_id:, start_date:, end_date:, account_id: nil)
+        def daywise(start_date:, end_date:, app_id: nil, account_id: nil)
           fetch("/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise",
                 app_id: app_id, account_id: account_id,
                 params: { start_date: start_date, end_date: end_date })
         end
 
         # GET /analytics/livestreams/overall — overall livestream metrics.
-        def livestreams_overall(app_id:, start_time:, end_time:, account_id: nil)
+        def livestreams_overall(start_time:, end_time:, app_id: nil, account_id: nil)
           fetch("/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall",
                 app_id: app_id, account_id: account_id,
                 params: { start_time: start_time, end_time: end_time })
@@ -41,11 +41,16 @@ module Cloudflare
 
           # Local copies of the two private helpers from Resource — Analytics
           # isn't a Resource subclass (no instances, just a function namespace),
-          # so it can't inherit the private class methods.
+          # so it can't inherit the private class methods. Falls back to
+          # +Cloudflare.account_id+ and +Cloudflare::RealtimeKit.app_id+ for
+          # the same per-process default behavior the Resource subclasses
+          # get for free.
           def build_scope(account_id:, app_id:)
             account = account_id || Cloudflare.account_id
+            app     = app_id     || RealtimeKit.app_id
             raise ArgumentError, "missing required scope param: account_id" unless account
-            { account_id: account, app_id: app_id }
+            raise ArgumentError, "missing required scope param: app_id"     unless app
+            { account_id: account, app_id: app }
           end
 
           def interpolate(path, values)

data/lib/cloudflare/realtime_kit/recording.rb

@@ -38,7 +38,7 @@ module Cloudflare
         # POST /recordings/track — start a multi-file (per-track) recording.
         # Different upstream endpoint than +create+; use this when you need
         # one media file per participant track.
-        def start_track(meeting_id:, layers:, app_id:, account_id: nil, max_seconds: nil)
+        def start_track(meeting_id:, layers:, app_id: nil, account_id: nil, max_seconds: nil)
           scope    = build_scope(account_id: account_id, app_id: app_id)
           path     = interpolate("/accounts/{account_id}/realtime/kit/{app_id}/recordings/track", scope)
           response = Connection.instance.request(:post, path,
@@ -48,7 +48,7 @@ module Cloudflare
 
         # GET /recordings/active-recording/{meeting_id} — fetch the recording
         # currently in progress for a meeting (404 if none).
-        def active_for(meeting_id:, app_id:, account_id: nil)
+        def active_for(meeting_id:, app_id: nil, account_id: nil)
           scope    = build_scope(account_id: account_id, app_id: app_id)
           path     = interpolate("/accounts/{account_id}/realtime/kit/{app_id}/recordings/active-recording/{meeting_id}",
                                  scope.merge(meeting_id: meeting_id))

data/lib/cloudflare/realtime_kit/session.rb

@@ -41,7 +41,7 @@ module Cloudflare
         # GET /sessions/peer-report/{peer_id} — reverse lookup from a peer id.
         # Returns participant-shaped data, not a session, so we expose it as a
         # SessionParticipant instance.
-        def find_participant_by_peer_id(peer_id, app_id:, account_id: nil, filters: nil)
+        def find_participant_by_peer_id(peer_id, app_id: nil, account_id: nil, filters: nil)
           scope = build_scope(account_id: account_id, app_id: app_id)
           path  = interpolate("/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}",
                               scope.merge(peer_id: peer_id))

data/lib/cloudflare/realtime_kit.rb

@@ -2,7 +2,24 @@ module Cloudflare
   # Cloudflare RealtimeKit (formerly Dyte) — managed video/audio infrastructure
   # for meetings, livestreams, recordings, sessions, and analytics. Each
   # resource maps to a hand-written class under this namespace.
+  #
+  # == Default app_id
+  #
+  # Most resources (Meeting, Participant, Recording, ...) live under an app.
+  # Set +app_id+ once at process boot and every call defaults to it; pass
+  # +app_id:+ per-call only to override.
+  #
+  #   Cloudflare::RealtimeKit.app_id = ENV["REALTIMEKIT_APP_ID"]
+  #
+  #   Cloudflare::RealtimeKit::Meeting.create(title: "Standup")          # uses default
+  #   Cloudflare::RealtimeKit::Meeting.find(id, app_id: "other-app-id")  # override
   module RealtimeKit
+    class << self
+      # Default app_id used when a resource call doesn't pass one explicitly.
+      # Mirrors how +Cloudflare.account_id+ defaults the account scope.
+      attr_accessor :app_id
+    end
+
     autoload :App,                     "cloudflare/realtime_kit/app"
     autoload :Meeting,                 "cloudflare/realtime_kit/meeting"
     autoload :Participant,             "cloudflare/realtime_kit/participant"

data/lib/cloudflare/resource.rb

@@ -180,11 +180,12 @@ module Cloudflare
       end
 
       private
-        # Pulls scope params out of the kwargs hash (mutating). Defaults
-        # account_id from global config if not provided.
+        # Pulls scope params out of the kwargs hash (mutating). Falls back
+        # to product-level defaults (see +global_default_for+) when a key
+        # isn't provided.
         def extract_scope!(attrs)
           scope_params.each_with_object({}) do |key, h|
-            value = attrs.delete(key) || (key == :account_id && Cloudflare.account_id)
+            value = attrs.delete(key) || global_default_for(key)
             raise ArgumentError, "missing required scope param: #{key}" unless value
             h[key] = value
           end
@@ -192,12 +193,35 @@ module Cloudflare
 
         def build_scope(provided)
           scope_params.each_with_object({}) do |key, h|
-            value = provided[key] || (key == :account_id && Cloudflare.account_id)
+            value = provided[key] || global_default_for(key)
             raise ArgumentError, "missing required scope param: #{key}" unless value
             h[key] = value
           end
         end
 
+        # Resolve a scope key to its module-level default:
+        # +:account_id+ → +Cloudflare.account_id+ (top-level config), and any
+        # other key → a same-named accessor on the resource's product
+        # namespace (e.g., +:app_id+ → +Cloudflare::RealtimeKit.app_id+).
+        # Lets callers configure once per process and stop repeating
+        # +app_id:+ at every call site. Returns nil when no default is set,
+        # which lets the caller raise the +missing required scope+ error.
+        def global_default_for(key)
+          return Cloudflare.account_id if key == :account_id
+          namespace = product_namespace
+          namespace&.respond_to?(key) ? namespace.public_send(key) : nil
+        end
+
+        # +Cloudflare::RealtimeKit::Meeting+ → +Cloudflare::RealtimeKit+.
+        # Returns nil for resources without a product namespace (i.e.,
+        # +Cloudflare::Resource+ direct subclasses, which we don't have in
+        # practice).
+        def product_namespace
+          parts = name.split("::")
+          return nil if parts.size < 3
+          parts[0..-2].inject(Object) { |const, seg| const.const_get(seg) }
+        end
+
         def interpolate(path, values)
           path.gsub(/\{(\w+)\}/) do
             key = $1.to_sym

data/lib/cloudflare/version.rb

@@ -1,3 +1,3 @@
 module Cloudflare
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - tokimonki