edgebase_admin 0.1.4

data/llms.txt

@@ -0,0 +1,117 @@
+# EdgeBase Ruby Admin SDK
+
+Use this file as a quick-reference contract for AI coding assistants working with `edgebase_admin`.
+
+## Package Boundary
+
+Use `edgebase_admin` only in trusted server-side Ruby environments.
+
+Do not ship this package to browser code, untrusted jobs, or client-side Ruby runtimes. It is meant for backend apps, scripts, cron jobs, and other places where a Service Key can stay private.
+
+## Source Of Truth
+
+- Package README: https://github.com/edge-base/edgebase/blob/main/packages/sdk/ruby/packages/admin/README.md
+- Database Admin SDK: https://edgebase.fun/docs/database/admin-sdk
+- Admin users: https://edgebase.fun/docs/authentication/admin-users
+- Storage: https://edgebase.fun/docs/storage/upload-download
+- Push Admin SDK: https://edgebase.fun/docs/push/admin-sdk
+- Analytics Admin SDK: https://edgebase.fun/docs/analytics/admin-sdk
+- Admin SDK reference: https://edgebase.fun/docs/admin-sdk/reference
+
+If docs, examples, and assumptions disagree, prefer the current package API and the official docs over guessed patterns.
+
+## Canonical Examples
+
+### Create an admin client
+
+```ruby
+require "edgebase_admin"
+
+admin = EdgebaseAdmin::AdminClient.new(
+  "https://your-project.edgebase.fun",
+  service_key: ENV.fetch("EDGEBASE_SERVICE_KEY")
+)
+```
+
+### Query a table
+
+```ruby
+posts = admin.db("app").table("posts")
+rows = posts.where("status", "==", "published").get
+```
+
+### Manage users
+
+```ruby
+created = admin.admin_auth.create_user(
+  email: "june@example.com",
+  password: "pass1234",
+  data: { "displayName" => "June" }
+)
+
+admin.admin_auth.set_custom_claims(created["id"], {
+  "role" => "moderator"
+})
+```
+
+### Execute SQL
+
+```ruby
+rows = admin.sql(
+  "workspace",
+  "SELECT * FROM documents WHERE status = ?",
+  ["published"],
+  instance_id: "ws-1"
+)
+```
+
+### Send push and query analytics
+
+```ruby
+admin.push.send("user-123", {
+  "title" => "Hello",
+  "body" => "From the admin SDK"
+})
+
+overview = admin.analytics.overview("range" => "7d")
+```
+
+## Hard Rules
+
+- keep Service Keys on trusted servers only
+- all Ruby admin methods are synchronous
+- `admin.admin_auth` is canonical; `admin.auth` is an alias
+- `admin.sql(namespace, query, params = nil, instance_id: nil)` uses a keyword `instance_id:` for dynamic DOs
+- `admin.admin_auth.create_user()` accepts a hash or keyword arguments, but hash payloads are safest for docs and agents
+- `admin.storage` returns `EdgebaseCore::StorageClient`
+- `admin.functions` exposes `call()`, `get()`, `post()`, `put()`, `patch()`, and `delete()`
+- `admin.push` exposes `send()`, `send_many()`, `send_to_token()`, `get_tokens()`, `get_logs()`, `send_to_topic()`, and `broadcast()`
+- `admin.broadcast(channel, event, payload = {})` is server-side broadcast
+- `admin.destroy` is a no-op cleanup hook
+
+## Common Mistakes
+
+- do not use `edgebase_admin` in client-side Ruby code
+- do not copy JavaScript promise-based examples into Ruby
+- do not call `sql("SELECT ...")` without a namespace
+- do not pass the instance id positionally to `sql`; use `instance_id:`
+- do not expect `admin_auth` to return a promise or future
+
+## Quick Reference
+
+```text
+EdgebaseAdmin::AdminClient.new(url, service_key:)          -> AdminClient
+admin.db(namespace = "shared", instance_id = nil)         -> DbRef
+admin.admin_auth                                           -> AdminAuthClient
+admin.auth                                                 -> AdminAuthClient
+admin.sql(namespace, query, params = nil, instance_id: nil) -> Array or raw payload
+admin.storage                                              -> EdgebaseCore::StorageClient
+admin.push                                                 -> PushClient
+admin.functions                                            -> FunctionsClient
+admin.analytics                                            -> AnalyticsClient
+admin.kv(namespace)                                        -> KvClient
+admin.d1(database)                                         -> D1Client
+admin.vector(index)                                        -> VectorizeClient
+admin.broadcast(channel, event, payload = {})             -> nil
+admin.destroy                                              -> nil
+```

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: edgebase_admin
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- EdgeBase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: edgebase_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+description: Admin module for EdgeBase Ruby SDK. Provides AdminClient, AdminAuthClient,
+  KvClient, D1Client, VectorizeClient, PushClient via Service Key auth.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/edgebase_admin.rb
+- lib/edgebase_admin/admin_auth.rb
+- lib/edgebase_admin/admin_client.rb
+- lib/edgebase_admin/analytics_client.rb
+- lib/edgebase_admin/d1_client.rb
+- lib/edgebase_admin/functions_client.rb
+- lib/edgebase_admin/generated/admin_api_core.rb
+- lib/edgebase_admin/kv_client.rb
+- lib/edgebase_admin/push_client.rb
+- lib/edgebase_admin/vectorize_client.rb
+- llms.txt
+homepage: https://edgebase.fun/docs/admin-sdk/reference
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://edgebase.fun/docs/admin-sdk/reference
+  bug_tracker_uri: https://github.com/edge-base/edgebase/issues
+  source_code_uri: https://github.com/edge-base/edgebase/tree/main/packages/sdk/ruby/packages/admin
+  documentation_uri: https://edgebase.fun/docs/admin-sdk/reference
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: EdgeBase Admin SDK for Ruby — server-side admin operations.
+test_files: []