teams_rb 2.0.1 → 2.0.2

data/README.md

@@ -1,40 +1,40 @@
-# teams_rb
+# teams_rb — Teams SDK for Ruby
 
-A Ruby-native port of the Microsoft Teams SDKs ([TypeScript](https://microsoft.github.io/teams-sdk/typescript/getting-started), [Python](https://microsoft.github.io/teams-sdk/python/getting-started), [C#](https://microsoft.github.io/teams-sdk/csharp/getting-started)) for building Teams bots and apps from Rack/Rails.
+[![Gem Version](https://img.shields.io/gem/v/teams_rb)](https://rubygems.org/gems/teams_rb)
+[![Documentation](https://img.shields.io/badge/docs-getting_started-blue)](docs/getting-started/README.md)
 
-> **Unofficial.** `teams_rb` is an independent, community-maintained project. It is not affiliated with, endorsed by, or sponsored by Microsoft. The official Teams SDKs (TypeScript, Python, C#) are developed by Microsoft at [github.com/microsoft/teams-sdk](https://github.com/microsoft/teams-sdk). "Microsoft", "Microsoft Teams", and "Microsoft 365" are trademarks of the Microsoft group of companies.
+A Ruby-native port of the Microsoft Teams SDKs for building Teams bots and apps with Rack or Rails. It includes message routing, proactive messaging, the Bot Framework API client, typed Adaptive Cards, dialogs, message extensions, streaming, meetings, OAuth, Microsoft Graph, tabs, and remote functions.
 
-It preserves the Teams SDK concepts and wire behavior while using Ruby idioms for the public API, and versions alongside the Teams SDK v2 generation it ports. Every capability is verified against all three upstream SDKs and live-tested in Teams:
+`teams_rb` preserves the concepts and wire behavior of the official [TypeScript](https://microsoft.github.io/teams-sdk/typescript/getting-started), [Python](https://microsoft.github.io/teams-sdk/python/getting-started), and [C#](https://microsoft.github.io/teams-sdk/csharp/getting-started) SDKs while providing an idiomatic Ruby API. Inbound JWT validation and outbound bot token management are built in.
 
-- Message routing, middleware, and the activity context
-- Sending: post, reply, quote, update, typing, formatting, mentions, sensitivity labels, citations
-- Proactive messaging and conversation creation
-- The full API client — conversations, teams, meetings, users, bot sign-in
-- Adaptive Cards (all 112 element classes, generated from the SDK card model)
-- Dialogs, message extensions, streaming, meeting events
-- OAuth user sign-in and Microsoft Graph (app and user identity)
-- Tabs and remote functions
-- Inbound JWT validation, bot token management, thread-safe by design
+> **Unofficial.** `teams_rb` is an independent, community-maintained project. It is not affiliated with, endorsed by, or sponsored by Microsoft. The official Teams SDKs are developed by Microsoft at [github.com/microsoft/teams-sdk](https://github.com/microsoft/teams-sdk).
 
-## Documentation
-
-Full documentation lives in [`docs/`](docs/README.md), structured like the official SDK docs:
+## Getting started
 
-- **[Getting started](docs/getting-started/README.md)** — quickstart, code basics, running in Teams
-- **[Essentials](docs/essentials/README.md)** — app, activities, sending, proactive, API client, auth, Graph
-- **[In-depth guides](docs/in-depth-guides/README.md)** — cards, dialogs, message extensions, streaming, user auth, tabs
+### Prerequisites
 
-The rest of this file is a condensed reference; the docs are the primary source.
+- Ruby 4.0 or newer
+- A Microsoft 365 tenant with custom app upload enabled
+- A public HTTPS tunnel for local development, such as [Dev Tunnels](https://learn.microsoft.com/azure/developer/dev-tunnels/get-started)
 
-## Local Usage
+### Install
 
-From another Ruby app:
+Add the SDK and a Rack server for this standalone example to your `Gemfile`:
 
 ```ruby
-gem "teams_rb", path: "../teams_rb"
+gem "teams_rb"
+gem "puma"
+```
+
+Then install it:
+
+```sh
+bundle install
 ```
 
-Then:
+### Create your first bot
+
+Create a `config.ru`:
 
 ```ruby
 require "teams"
@@ -43,458 +43,115 @@ teams = Teams::App.new
 
 teams.on_message do |ctx|
   ctx.typing
-  puts ctx.ref.conversation_id
-  ctx.reply "reply: #{ctx.activity.text.inspect}"
-  ctx.post "post: #{ctx.activity.text.inspect}"
+  ctx.reply "echo: #{ctx.activity.text}"
 end
 
 run teams.to_rack
 ```
 
-Suggested action submit invokes use the SDK route name and expose the submitted payload through `ctx.activity.value`:
-
-```ruby
-teams.on_suggested_action_submit do |ctx|
-  ctx.post "submitted: #{ctx.activity.value.to_h.inspect}"
-end
-```
-
-Message update events fire when a user edits or restores a Teams message:
-
-```ruby
-teams.on_edit_message do |ctx|
-  puts "edited text: #{ctx.activity.text}"
-end
-
-teams.on_undelete_message do |ctx|
-  puts "restored text: #{ctx.activity.text}"
-end
-```
-
-Reactions use the API client shape from the Microsoft SDKs:
-
-```ruby
-teams.api.conversations.add_reaction(conversation_id, activity_id, "like")
-teams.api.conversations.delete_reaction(conversation_id, activity_id, "like")
-```
-
-To update a message later, keep the activity id returned from the original send:
-
-```ruby
-sent = teams.post(conversation_id, "We have 2 Free iPhones, ready to pick up. While supplies last")
-
-teams.update(conversation_id, sent.fetch("id"), "Free phones gone now.")
-# equivalent SDK-send style:
-teams.post(conversation_id, Teams::Api::MessageActivity.new("Free phones gone now.").with_id(sent.fetch("id")))
-# lower-level parity surface:
-teams.api.conversations.update_activity(conversation_id, sent.fetch("id"), Teams::Api::MessageActivity.new("Free phones gone now."))
-```
-
-More Rack examples live in `examples/`.
-
-The Teams messaging endpoint defaults to `/api/messages`, matching the TypeScript and Python SDK defaults. If your app needs another path, configure it on the app and register the same full URL with Teams:
-
-```ruby
-teams = Teams::App.new(messaging_endpoint: "/bot/incoming")
-run teams.to_rack
-```
-
-Use `ctx.post` for a plain message in the conversation. The Microsoft Teams SDKs call this `send`, but Ruby already defines `Object#send` for dynamic dispatch, so this SDK uses `post` for the public Ruby API. Treat `post` as Ruby's spelling of SDK `send`: if the activity already has an `id`, it updates that activity instead of creating a new one. Use `ctx.reply` when you want Teams reply semantics: `replyToId` plus the Teams `quotedReply` entity and quote placeholder, matching the Microsoft SDK behavior. Use `ctx.update(activity_id, activity)` to replace a previous bot message in the current conversation.
-
-`ctx.ref` returns a `Teams::Api::ConversationReference`, matching the Teams SDK concept used for the current conversation. The same object is also available as `ctx.conversation_reference`. Store `ctx.ref.to_h` from a validated inbound activity if you need to post, reply, or update later from a job, then restore it with `Teams::Api::ConversationReference.from_h` and pass its `conversation_id` and `service_url` to `teams.post` / `teams.reply` / `teams.update`.
+### Register it with Teams
 
-To message a user without a stored conversation, create (or re-fetch) the 1:1 conversation first. Teams returns the existing conversation if one already exists for the same members:
+The easiest registration path is the optional [Teams CLI](https://www.npmjs.com/package/@microsoft/teams.cli), which requires Node.js 20 or newer. Install it, sign in, and check that your tenant allows sideloading:
 
-```ruby
-conversation = teams.api.conversations.create(
-  members: [{ id: user_id }],   # the user's Teams/Bot Framework id, e.g. "29:..."
-  tenant_id: tenant_id
-)
-teams.post(conversation.id, "Hello from your SaaS backend")
-```
-
-Conversation rosters come from the members APIs, which return `Teams::Api::Account` objects (with `aadObjectId` normalized, matching the other SDKs):
-
-```ruby
-teams.api.conversations.get_members(conversation_id)
-teams.api.conversations.get_member_by_id(conversation_id, member_id)
-teams.api.conversations.get_paged_members(conversation_id, page_size: 200)          # => Teams::Api::PagedMembersResult
-teams.api.conversations.get_activity_members(conversation_id, activity_id)
-```
-
-Use `get_paged_members` for large rosters: pass the result's `continuation_token` back in until it returns `nil`.
-
-Team and meeting lookups follow the same client shape:
-
-```ruby
-teams.api.teams.get_by_id(team_id)            # => Teams::Api::TeamDetails
-teams.api.teams.get_conversations(team_id)    # => [Teams::Api::ChannelInfo] (the team's channels)
-teams.api.meetings.get_by_id(meeting_id)      # => Teams::Api::MeetingInfo
-teams.api.meetings.get_participant(meeting_id, aad_object_id, tenant_id)
-teams.api.meetings.send_notification(meeting_id, { value: { recipients: [aad_object_id], surfaces: [{ surface: "meetingStage", contentType: "task", content: { ... } }] } })
-```
-
-`send_notification` returns `nil` when every recipient was notified (HTTP 202) and a `Teams::Api::MeetingNotificationResponse` with `recipients_failure_info` on partial success (HTTP 207).
-
-For modeled Ruby object access, use snake_case field names:
-
-```ruby
-ctx.activity.service_url
-ctx.activity.reply_to_id
-ctx.activity.from.aad_object_id
-ctx.activity.conversation.conversation_type
-```
-
-Raw payload access stays unchanged through `raw` / `to_h`:
-
-```ruby
-ctx.activity.raw["serviceUrl"]
-ctx.activity.raw.dig("from", "aadObjectId")
-```
-
-Quoted replies use the same SDK concepts as TypeScript, Python, and .NET:
-
-```ruby
-ctx.reply "auto-quotes the inbound activity"
-ctx.quote "message-id", "quotes a specific activity"
-
-message = Teams::Api::MessageActivity.new
-  .add_quote("message-id", "builder response")
-
-quotes = ctx.activity.get_quoted_messages
-```
-
-For formatted text, use a message activity with `text_format`:
-
-```ruby
-ctx.post Teams::Api::MessageActivity.new("plain text", text_format: "plain")
-ctx.post Teams::Api::MessageActivity.new("**markdown**", text_format: "markdown")
-ctx.post Teams::Api::MessageActivity.new("line 1<br>line 2", text_format: "xml")
-ctx.post Teams::Api::MessageActivity.new("extended markdown", text_format: "extendedmarkdown")
-```
-
-Teams delivers activities with at-least-once semantics, so a message can occasionally reach your bot twice. Like the other Teams SDKs, `teams_rb` does not deduplicate inbound activities; if a handler performs side effects that must not repeat, deduplicate by `ctx.activity.id`.
-
-For a typing indicator, use `ctx.typing`. Teams renders it as an animated ellipsis in the chat. It accepts optional text for wire parity with the other Teams SDKs, but the Teams client does not display that text on a plain typing activity — for a visible status line, use `ctx.stream.update` instead:
-
-```ruby
-ctx.typing                        # animated ellipsis
-ctx.stream.update("Thinking...")  # visible status line above the streamed response
-```
-
-Updating an activity replaces it entirely: Teams does not merge with the previous version, so metadata such as the AI-generated label, sensitivity label, citations, and mentions must be re-attached on every update or they disappear (verified live). For example:
-
-```ruby
-sent = ctx.post Teams::Api::MessageActivity.new("Thinking...").add_ai_generated
-ctx.update sent.id, Teams::Api::MessageActivity.new("Final answer.").add_ai_generated
-```
-
-Every send returns a `Teams::Api::SentActivity` carrying the outbound activity merged with the server response, so the sent message id is always available:
-
-```ruby
-sent = ctx.reply("hello")
-sent.id   # server-assigned activity id
-sent.text # "hello"
-sent.to_h # full merged activity hash
-```
-
-When the inbound message is targeted (visible only to the sender), `ctx.post` and `ctx.reply` automatically respond as targeted messages to that sender, matching the other Teams SDKs: the recipient is inferred, a `targetedMessageInfo` entity is attached for prompt preview, and the send routes through the targeted activity endpoints. Pass an explicit recipient to opt out, or send an explicitly targeted message from any handler:
-
-```ruby
-ctx.post Teams::Api::MessageActivity.new("Only for you").with_recipient(account, is_targeted: true)
+```sh
+npm install -g @microsoft/teams.cli
+teams login
+teams status
 ```
 
-Targeted messages are rejected in 1:1 (personal) chats, where every message is already private.
-
-This repository is self-contained: the generated card classes and their golden fixtures are committed, so the gem and its test suite need nothing beyond Ruby. Regenerating the card classes requires a clone of Microsoft's Python SDK and [uv](https://docs.astral.sh/uv/); by default a checkout next to this repository is used, and `TEAMS_PY_PATH` points anywhere else:
+Start your HTTPS tunnel, then let the CLI create the app, bot registration, and install link:
 
 ```sh
-bundle exec rake cards:generate
-# or with a custom checkout location:
-TEAMS_PY_PATH=/path/to/teams.py bundle exec rake cards:generate
+teams app create \
+  --name my-teams-ruby-bot \
+  --endpoint https://<your-tunnel>/api/messages
 ```
 
-The SDK-parity comparison workflow additionally uses sibling clones of `teams.ts` and `teams.net`, as described in the porting workspace's `AGENTS.md`.
+The command prints `CLIENT_ID`, `CLIENT_SECRET`, `TENANT_ID`, and an **Install in Teams** link. You can also create the app manually in the [Teams Developer Portal](https://dev.teams.microsoft.com/apps).
 
-The full Adaptive Card schema (112 typed classes) is available under `Teams::Cards`, generated from the Python SDK's card models and golden-tested to serialize identically. Cards serialize with the same defaults the other SDKs emit. Raw card JSON via `add_card(hash)` remains available as an escape hatch. Two live-verified gotchas: some card fields are server-side enums (for example `CodeBlock` `language:` — Teams rejects the whole message for values outside the enum), and a card `Action.Submit` arrives as a message activity with `nil` text, an ephemeral id, and the inputs in `value` — answer it with `ctx.post`, since quote-replying to the invisible submit activity is rejected by Teams.
+### Run it
 
-For streamed responses, use `ctx.stream`:
+This standalone example uses Puma; `teams_rb` itself does not require a server gem. Start the bot with the credentials printed by the CLI:
 
-```ruby
-teams.on_message do |ctx|
-  ctx.stream.update("Thinking...")
-  ctx.stream.emit("Hello")
-  ctx.stream.emit(", world")
-end
-```
-
-The stream emits events: `on_chunk` fires with the `SentActivity` of every sent chunk, and `on_close` fires with the final `SentActivity` when the stream finalizes. Handlers persist across stream reuse:
-
-```ruby
-ctx.stream.on_chunk { |sent| logger.debug("chunk #{sent.id}") }
-ctx.stream.on_close { |sent| MessageLog.record(sent.id) }
-```
-
-Emits are queued and flushed by a background thread, matching the TypeScript and Python streamers: rapid emits coalesce into fewer chunks (spaced to respect Teams rate limits), transient send failures retry with backoff, and `close` waits for the queue to drain before sending the final message. Emitting again after `ctx.stream.close` starts a new streamed message on the same stream. If Teams stops a stream, the SDK raises typed errors: `Teams::StreamCancelledError` when the user cancels (sets the sticky `canceled` flag and makes the next `emit` raise), and `Teams::StreamNotAllowedError` or `Teams::TerminalStreamError` for terminal streaming failures — chunk-send errors are recorded on the stream and surface when `close` sends the final message. A stream that exceeds the Teams two-minute streaming limit finalizes automatically by updating the streamed message in place. Note that a card-only stream (no text ever emitted) sends nothing, like the other SDKs: emit text chunks first, then `clear_text` and emit the card as the final message.
-
-To mark a final message as AI-generated, use `add_ai_generated` on `MessageActivity`. This also works as the final streamed message metadata:
-
-```ruby
-teams.on_message do |ctx|
-  ctx.stream.update("Thinking...")
-  ctx.stream.emit("Hello")
-  ctx.stream.emit("! I'm a friendly AI bot. ")
-  ctx.stream.emit(Teams::Api::MessageActivity.new.add_ai_generated)
-end
+```sh
+CLIENT_ID=... CLIENT_SECRET=... TENANT_ID=... bundle exec puma -p 3978
 ```
 
-Dialogs (Teams task modules) open from a card action whose data carries `msteams: { type: "task/fetch" }`. Route them with `on_dialog_open` / `on_dialog_submit`; the reserved `dialog_id` and `action` data keys select specific handlers, matching the other SDKs. The handler's return value — a `Teams::Api::TaskModuleResponse` (or an equivalent hash) — becomes the invoke response Teams renders:
+Open the install link and send the bot a message. It receives Teams activities at `POST /api/messages`, validates each request, and replies to incoming messages.
 
-```ruby
-teams.on_message(/^form$/i) do |ctx|
-  ctx.post Teams::Api::MessageActivity.new.add_card(
-    Teams::Cards::AdaptiveCard.new(
-      Teams::Cards::TextBlock.new("Open the form"),
-      actions: [Teams::Cards::SubmitAction.new(
-        title: "Open",
-        data: { "msteams" => { "type" => "task/fetch" }, "dialog_id" => "simple_form" }
-      )]
-    )
-  )
-end
+See [Running in Teams](docs/getting-started/running-in-teams.md) for the complete registration, tunnel, and installation walkthrough.
 
-teams.on_dialog_open("simple_form") do |ctx|
-  Teams::Api::TaskModuleResponse.new(
-    Teams::Api::TaskModuleContinueResponse.new(
-      Teams::Api::TaskModuleTaskInfo.new(title: "Simple Form", card: dialog_card)
-    )
-  )
-end
+## Code basics
 
-teams.on_dialog_submit("submit_simple_form") do |ctx|
-  ctx.post "Hi #{ctx.activity.value.data["name"]}!"
-  Teams::Api::TaskModuleResponse.new(Teams::Api::TaskModuleMessageResponse.new("Form was submitted"))
-end
-```
-
-`TaskModuleTaskInfo` takes `card:` (an `AdaptiveCard`, card hash, or ready attachment — cards are wrapped into an attachment automatically) or `url:` for webpage dialogs, plus `title:`, `height:`/`width:` (`"small"`/`"medium"`/`"large"` or pixels), `fallback_url:`, and `completion_bot_id:`. Returning a `TaskModuleContinueResponse` from a submit handler chains multi-step dialogs; a `TaskModuleMessageResponse` shows a message and closes.
-
-Message extensions (compose extensions) route the `composeExtension/*` invokes with the same handler names as the Python SDK: `on_message_ext_query`, `on_message_ext_select_item`, `on_message_ext_submit`, `on_message_ext_open` (fetchTask), `on_message_ext_query_link`, `on_message_ext_anon_query_link`, `on_message_ext_query_settings_url`, `on_message_ext_setting`, and `on_message_ext_card_button_clicked`. The commands themselves are declared in the Teams app manifest; query handlers return a `MessagingExtensionResponse`, action handlers a `MessagingExtensionActionResponse` (which can open a dialog via `task:`, reusing the task module responses):
+Handlers can match message text and respond with typed Adaptive Cards:
 
 ```ruby
-teams.on_message_ext_query do |ctx|
-  query = ctx.activity.value.parameters.find { |p| p["name"] == "searchQuery" }&.dig("value")
-  results = Item.search(query).map do |item|
-    Teams::Api::MessagingExtensionAttachment.new(
-      content_type: "application/vnd.microsoft.card.adaptive",
-      content: item.to_card,
-      preview: { "contentType" => "application/vnd.microsoft.card.thumbnail",
-                 "content" => { "title" => item.title } }
-    )
-  end
-
-  Teams::Api::MessagingExtensionResponse.new(
-    Teams::Api::MessagingExtensionResult.new(type: "result", attachment_layout: "list", attachments: results)
-  )
-end
+teams.on_message(/^status$/i) do |ctx|
+  ctx.typing
 
-teams.on_message_ext_query_link do |ctx|
-  card = unfurl(ctx.activity.value.raw["url"])
-  Teams::Api::MessagingExtensionResponse.new(
-    Teams::Api::MessagingExtensionResult.new(type: "result", attachment_layout: "list", attachments: [card])
+  card = Teams::Cards::AdaptiveCard.new(
+    Teams::Cards::TextBlock.new("Service status", size: "Large", weight: "Bolder"),
+    Teams::Cards::TextBlock.new("All systems operational.", wrap: true)
   )
-end
-```
-
-User sign-in (OAuth) needs an OAuth connection configured on the bot's Azure registration (name it to match `default_connection_name`, default `"graph"`). `ctx.sign_in` returns the token when the user is already signed in; otherwise it sends an OAuth card (to a 1:1 conversation when invoked from a group chat) and returns `nil`. The SDK's default handlers then complete the sign-in invokes — token exchange for silent SSO, verify-state for the interactive card — and hand the token to `on_sign_in`:
-
-```ruby
-teams = Teams::App.new(default_connection_name: "graph")
-
-teams.on_message(/^login$/i) do |ctx|
-  token = ctx.sign_in
-  ctx.reply "Already signed in!" if token
-end
-
-teams.on_sign_in do |ctx, token|
-  ctx.post "Welcome! You are signed in."
-  # token.token is the user's access token for the connection's scopes
-end
-
-teams.on_error do |error, activity|
-  # unexpected OAuth failures and client-reported sign-in failures
-end
-```
-
-`ctx.sign_out` clears the token. Handlers registered on `on_signin_token_exchange` / `on_signin_verify_state` / `on_signin_failure` run after the defaults for custom behavior. The lower-level surface lives on `teams.api.users` (`get_token`, `get_aad_tokens`, `get_token_status`, `sign_out`, `exchange_token`) and `teams.api.bots.sign_in` (`get_url`, `get_resource`) against the Bot Framework token service.
-
-Microsoft Graph is available through a thin request client (following the TypeScript SDK's core Graph client; the generated endpoint packages are not ported — the raw request surface is the API, like TypeScript's `client.http` escape hatch). `teams.graph` / `ctx.app_graph` use the app's own identity (app-only tokens via the client-credentials flow — grant the app *application* permissions in Entra for these). `ctx.user_graph` uses the signed-in user's token and raises if the user hasn't signed in:
-
-```ruby
-teams.on_message(/^whoami$/i) do |ctx|
-  me = ctx.user_graph.get("/me")   # requires prior ctx.sign_in
-  ctx.reply "You are #{me["displayName"]} (#{me["userPrincipalName"]})"
-end
-
-app_info = teams.graph.get("/applications", params: { "$top" => 1 })
-teams.graph.post("/users/#{user_id}/sendMail", json: { message: { subject: "Hi" } })
-```
-
-`get`/`post`/`patch`/`put`/`delete` take a path relative to `/v1.0`, return parsed hashes, and raise `Teams::GraphError` (with `status`, the Graph error `code`, and the full `body`) on failure. Sovereign clouds route automatically from the configured cloud's graph scope.
-
-Remote functions let a tab (or any Teams-hosted web page) call your bot backend as the signed-in user. The page acquires an Entra token through the Teams JS SDK and POSTs to `/api/functions/{name}` with the token plus the Teams client-context headers; the SDK validates the token against your app registration (client id audience forms, tenant issuer) and requires the `oid`/`tid`/`name` claims:
-
-```ruby
-teams.on_function("create-ticket") do |ctx|
-  ticket = Ticket.create!(title: ctx.data["title"], creator_oid: ctx.user_id)
-  ctx.post "#{ctx.user_name} created ticket #{ticket.id} from the tab"
-  { "id" => ticket.id }
-end
-```
-
-`ctx.data` is the parsed JSON body; identity (`user_id`, `tenant_id`, `user_name`) comes from the validated token; the client context (`chat_id`, `channel_id`, `meeting_id`, `team_id`, `page_id`, `app_session_id`, …) comes from the `X-Teams-*` headers. `ctx.conversation_id` resolves the chat/channel after validating the user's membership — or creates the 1:1 conversation in personal scope — and `ctx.post` sends into it proactively. The handler's return value becomes the JSON response body; invalid requests get `401` with a `detail` message.
 
-For @mentions, use `add_mention` on the outbound message and the mention readers on inbound activities:
-
-```ruby
-ctx.post Teams::Api::MessageActivity.new("ping ").add_mention(ctx.activity.from.to_h)
-
-teams.on_message do |ctx|
-  if ctx.activity.recipient_mentioned?
-    ctx.reply "You said: #{ctx.activity.strip_mentions_text}"
-  end
+  ctx.post card
 end
 ```
 
-To mark a message with a content sensitivity label:
-
-```ruby
-ctx.post Teams::Api::MessageActivity.new("Q3 numbers...").add_sensitivity_label(
-  "Confidential",
-  description: "Internal use only"
-)
-```
-
-The label is informational: Teams renders a shield icon whose popup shows the name in bold, the description underneath, and an automatic "Sensitivity set by {bot}" attribution. Name and description are free text. The optional `pattern:` (a schema.org DefinedTerm hash) is carried on the wire but not rendered by the Teams client. No enforcement or Microsoft Purview integration is attached.
-
-For citations, include the matching inline position marker in the text and add the citation to the message activity. The optional citation `text:` must be a stringified Adaptive Card (it renders in a modal when the citation is clicked); passing plain prose makes Teams reject the whole message with `400 BadSyntax`:
+The official SDKs call plain message sending `send`. Ruby already defines `Object#send`, so `teams_rb` intentionally uses `post`. This is the one deliberate public API naming difference.
 
-```ruby
-message = Teams::Api::MessageActivity.new("The policy allows this [1].")
-  .add_ai_generated
-  .add_citation(
-    1,
-    Teams::Api::CitationAppearance.new(
-      name: "Policy Guide",
-      abstract: "Relevant policy excerpt",
-      url: "https://example.com/policy",
-      icon: "PDF"
-    )
-  )
+For Rails, define one `Teams::App` instance during boot and route `POST /api/messages` to `app.to_rack`. See [App basics](docs/essentials/app-basics.md#serving) for the Rack and Rails forms.
 
-ctx.post message
-```
+## Feature status
 
-Citation `name` and `abstract` are required. Teams expects `name` to be at most 80 characters and `abstract` to be at most 160 characters. Keywords are documented as limited to 3 items, each at most 28 characters.
+This table tracks supported Teams SDK capabilities. Deprecated upstream AI and devtools packages are intentionally excluded.
 
-To show Teams' built-in feedback controls on a message:
-
-```ruby
-ctx.post Teams::Api::MessageActivity.new("Was this helpful?").add_feedback
-```
-
-For a custom feedback dialog flow, use `custom`:
-
-```ruby
-ctx.post Teams::Api::MessageActivity.new("Was this helpful?").add_feedback("custom")
-```
-
-For Adaptive Cards, use `Teams::Cards` objects directly or wrap them in a message activity:
-
-```ruby
-card = Teams::Cards::AdaptiveCard.new(
-  Teams::Cards::TextBlock.new("Create ticket", weight: "Bolder", size: "Large", wrap: true),
-  Teams::Cards::TextInput.new(id: "title", label: "Title", is_required: true),
-  actions: [
-    Teams::Cards::SubmitAction.new(title: "Create", data: { action: "create_ticket" })
-  ]
-)
-
-ctx.post card
-ctx.reply card
-ctx.post Teams::Api::MessageActivity.new.add_card(card)
-```
+| Feature | Status | Guide |
+|---|---|---|
+| App setup and Rack/Rails integration | ✅ Done | [App basics](docs/essentials/app-basics.md) |
+| Activity routing and middleware | ✅ Done | [Listening to activities](docs/essentials/on-activity.md) |
+| App and error events | ✅ Done | [Listening to events](docs/essentials/on-event.md) |
+| Typed activity models and raw payload access | ✅ Done | [Code basics](docs/getting-started/code-basics.md) |
+| Posts, replies, updates, typing, formatting, mentions, citations, and labels | ✅ Done | [Sending messages](docs/essentials/sending-messages.md) |
+| Proactive messaging and conversation references | ✅ Done | [Proactive messaging](docs/essentials/proactive-messaging.md) |
+| Conversations, teams, meetings, users, and bot sign-in APIs | ✅ Done | [API client](docs/essentials/api-client.md) |
+| Adaptive Cards | ✅ Done | [Adaptive Cards](docs/in-depth-guides/adaptive-cards.md) |
+| Dialogs | ✅ Done | [Dialogs](docs/in-depth-guides/dialogs.md) |
+| Message extensions | ✅ Done | [Message extensions](docs/in-depth-guides/message-extensions.md) |
+| Streaming responses | ✅ Done | [Streaming](docs/in-depth-guides/streaming.md) |
+| OAuth user authentication | ✅ Done | [User authentication](docs/in-depth-guides/user-authentication.md) |
+| Microsoft Graph | ✅ Done | [Microsoft Graph](docs/essentials/graph.md) |
+| Tabs and remote functions | ✅ Done | [Tabs and remote functions](docs/in-depth-guides/tabs.md) |
+| Feedback | ✅ Done | [Feedback](docs/in-depth-guides/feedback.md) |
+| Message reactions | ✅ Done | [Message reactions](docs/in-depth-guides/message-reactions.md) |
+| Meeting events and notifications | ✅ Done | [Meeting events](docs/in-depth-guides/meeting-events.md) |
+| Inbound authentication and bot tokens | ✅ Done | [App authentication](docs/essentials/app-authentication.md) |
+| Sovereign cloud support | ✅ Done | [Sovereign clouds](docs/essentials/sovereign-cloud.md) |
+| Logging and observability | ✅ Done | [Observability](docs/in-depth-guides/observability.md) |
 
-## Configuration
-
-`Teams::App.new` reads its configuration from the environment by default; every value can also be passed explicitly as a keyword argument:
-
-| Env var | Keyword | Required | Purpose |
-|---|---|---|---|
-| `CLIENT_ID` | `client_id:` | production | The bot's Microsoft App ID. Used for bot token requests and to validate inbound JWT audiences. |
-| `CLIENT_SECRET` | `client_secret:` | production | The bot's client secret for the client-credentials token flow. |
-| `TENANT_ID` | `tenant_id:` | single-tenant bots | Entra tenant for bot tokens and tenant-issuer JWT validation. |
-| `SERVICE_URL` | `service_url:` | no | Default Bot Framework service URL for proactive sends (defaults to `https://smba.trafficmanager.net/teams`). Inbound requests always use the service URL from the activity. |
-| — | `skip_auth:` | no | Disables inbound request validation. Local development only. |
-| — | `messaging_endpoint:` | no | Inbound path, defaults to `/api/messages`. |
-| — | `logger:`, `storage:`, `cloud:` | no | Logger (defaults to stdout), state store (defaults to the in-memory store), and cloud environment for sovereign clouds. |
-
-For local tests only:
-
-```ruby
-teams = Teams::App.new(skip_auth: true)
-```
-
-Production apps must provide `CLIENT_ID`, `CLIENT_SECRET`, and `TENANT_ID`. Without credentials the app logs a startup warning and rejects every inbound request unless `skip_auth: true` was set explicitly — the same behavior as the TypeScript, Python, and .NET SDKs.
-
-## Rails
-
-Define the app once (an initializer works well) and route the messaging endpoint to it:
-
-```ruby
-# config/initializers/teams_bot.rb
-TEAMS_BOT = Teams::App.new
-
-TEAMS_BOT.on_message do |ctx|
-  ctx.reply "Hello from Rails"
-end
-```
-
-```ruby
-# config/routes.rb
-post "/api/messages" => TEAMS_BOT.to_rack
-```
+## Documentation
 
-Routing the exact path (rather than `mount`) keeps the request's full path intact, which the endpoint check relies on. If you prefer `mount`, mount at root — `mount TEAMS_BOT.to_rack => "/"` — and let the SDK's own endpoint matching answer 404 for everything else; register whichever full URL you chose with Teams.
+- [Getting started](docs/getting-started/README.md) — quickstart, code basics, and running in Teams
+- [Essentials](docs/essentials/README.md) — app setup, activities, sending, proactive messaging, API clients, authentication, and Graph
+- [In-depth guides](docs/in-depth-guides/README.md) — cards, dialogs, extensions, streaming, user authentication, tabs, and events
+- [Examples](examples/README.md) — runnable Rack apps for common SDK features
+- [Changelog](CHANGELOG.md) — release history
 
-Handlers run inside the web request, so treat them like controller actions: keep them fast, and push slow work (LLM calls, big queries) to a job, then deliver the result proactively with the stored conversation reference. Remember that Bot Framework delivers at-least-once — if a handler's side effect must not repeat, dedupe by `ctx.activity.id` before performing it:
+## Development
 
-```ruby
-teams.on_message do |ctx|
-  next if ProcessedActivity.exists?(activity_id: ctx.activity.id)
-  ProcessedActivity.create!(activity_id: ctx.activity.id)
+Install dependencies and run the Minitest suite:
 
-  answer = Assistant.answer(user: ctx.activity.from.aad_object_id, text: ctx.activity.text)
-  ctx.stream.emit(answer)
-end
+```sh
+bundle install
+bundle exec rake test
 ```
 
-## Local development
+The gem is self-contained. Regenerating the typed Adaptive Card classes requires a sibling checkout of Microsoft's Python SDK; see the [Adaptive Cards guide](docs/in-depth-guides/adaptive-cards.md#regenerating).
 
-1. Register a bot (Microsoft's [Teams CLI](https://github.com/microsoft/teams-sdk) or the Developer Portal) and note the client id, client secret, and tenant id. Put them in `.env` as `CLIENT_ID`, `CLIENT_SECRET`, `TENANT_ID`.
-2. Expose your local port with a persistent tunnel, e.g. Dev Tunnels: `devtunnel create teams-bot -a && devtunnel port create teams-bot -p 3978`, then `devtunnel host teams-bot`.
-3. Set the bot's messaging endpoint to `https://<your-tunnel>/api/messages` in the bot registration, and install the app in Teams.
-4. Run the app: `bundle exec rackup -p 3978 -o 0.0.0.0`. Inbound requests are JWT-validated with your real credentials — no `skip_auth` needed behind a tunnel.
+## Questions and issues
 
-If the tunnel URL is stable (Dev Tunnels URLs are), steps 1–3 are one-time setup.
+Use [GitHub Issues](https://github.com/bavmind/teams_rb/issues) for bug reports and feature requests.
 
-## API reference
+## License
 
-| Surface | Methods |
-|---|---|
-| Routing | `teams.on_message(pattern = nil)`, `on_message_update`, `on_edit_message`, `on_undelete_message`, `on_dialog_open(dialog_id = nil)`, `on_dialog_submit(action = nil)`, `on_message_ext_*` (nine composeExtension routes), `on_meeting_start`, `on_meeting_end`, `on_message_submit_feedback`, `on_suggested_action_submit`, `on(type)` (escape hatch), `use` (middleware, `(ctx, next)`) |
-| Context (`ctx`) | `activity`, `ref` / `conversation_reference`, `post`, `reply`, `quote(message_id, ...)`, `update(activity_id, ...)`, `typing(text = nil)`, `stream` (`emit`, `update`, `clear_text`, `close`, `on_chunk`, `on_close`), `api`, `storage`, `log` |
-| Proactive (`teams`) | `post(conversation_id, activity)`, `reply(conversation_id, activity_id, activity)`, `update(conversation_id, activity_id, activity)`, `send_activity(reference, activity)` |
-| API client (`teams.api`) | `conversations` (`create`, `create_activity`, `reply_to_activity`, `update_activity`, `delete_activity`, targeted variants, `get_members`, `get_member_by_id`, `get_paged_members`, `get_activity_members`, `add_reaction`, `delete_reaction`), `teams` (`get_by_id`, `get_conversations`), `meetings` (`get_by_id`, `get_participant`, `send_notification`) |
-| Sends return | `Teams::Api::SentActivity` (outbound activity merged with the server response; `#id`, `#[]`, `#to_h`) |
-| Auth | Inbound JWTs validated against Bot Framework/Entra issuers, the three audience forms, expiry/nbf, signature, and the `serviceurl` claim. Outbound bot tokens via client-credentials flow, cached with refresh skew. `AuthenticationError` → 401, `BadRequestError` → 400, handler errors → 500 (Bot Framework then redelivers). |
+`teams_rb` is available under the [MIT License](LICENSE).

data/docs/essentials/app-authentication.md

@@ -12,7 +12,7 @@ Every `POST /api/messages` request must carry a Bot Framework JWT. The app valid
 - **Expiry / not-before**
 - **`serviceurl` claim** — must match the activity's service URL, preventing spoofed routing
 
-Rejected requests get a 401 with a warn log line. Requests are rejected wholesale when no credentials are configured (with a loud startup warning) unless `skip_auth: true` is set explicitly — which is for local development only.
+Rejected requests get a 401 with a warn log line. Requests are rejected wholesale when no credentials are configured (with a loud startup warning) unless `dangerously_allow_unauthenticated_requests: true` is set explicitly — which is for local development only. The option can also come from the `DANGEROUSLY_ALLOW_UNAUTHENTICATED_REQUESTS` environment variable (`true`/`false`, `1`/`0`, `yes`/`no`, or `on`/`off`); the older `skip_auth:` name still works as a deprecated alias.
 
 ## Outbound bot tokens
 

data/docs/essentials/app-basics.md

@@ -10,12 +10,12 @@
 | `CLIENT_SECRET` | `client_secret:` | production | Client secret for the client-credentials flow |
 | `TENANT_ID` | `tenant_id:` | single-tenant | Entra tenant for bot tokens and tenant-issuer validation |
 | `SERVICE_URL` | `service_url:` | no | Default Bot Framework URL for proactive sends (inbound requests always use the activity's own service URL) |
-| — | `skip_auth:` | no | Disables inbound validation — local development only |
+| `DANGEROUSLY_ALLOW_UNAUTHENTICATED_REQUESTS` | `dangerously_allow_unauthenticated_requests:` | no | Disables inbound validation — local development only (`skip_auth:` is a deprecated alias) |
 | — | `messaging_endpoint:` | no | Inbound path, default `/api/messages` |
 | — | `default_connection_name:` | no | OAuth connection name for user sign-in, default `"graph"` |
 | — | `logger:`, `storage:`, `cloud:` | no | Logger (stdout default), state store (in-memory default), cloud environment for sovereign clouds |
 
-Without credentials the app logs a startup warning and rejects every inbound request unless `skip_auth: true` was set explicitly — the same behavior as the TypeScript, Python, and .NET SDKs.
+Without credentials the app logs a startup warning and rejects every inbound request unless `dangerously_allow_unauthenticated_requests: true` was set explicitly — the same behavior as the TypeScript, Python, and .NET SDKs.
 
 ## One app instance