teams_rb 2.0.1

data/lib/teams/api/message_extension.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    # An attachment in a message extension result; preview: carries the
+    # optional preview card shown in the result list.
+    class MessagingExtensionAttachment
+      def initialize(content_type: nil, content: nil, content_url: nil, name: nil,
+                     thumbnail_url: nil, preview: nil)
+        @content_type = content_type
+        @content = content
+        @content_url = content_url
+        @name = name
+        @thumbnail_url = thumbnail_url
+        @preview = preview
+      end
+
+      def to_h
+        body = {}
+        body["contentType"] = @content_type if @content_type
+        body["content"] = serialize(@content) if @content
+        body["contentUrl"] = @content_url if @content_url
+        body["name"] = @name if @name
+        body["thumbnailUrl"] = @thumbnail_url if @thumbnail_url
+        body["preview"] = serialize(@preview) if @preview
+        body
+      end
+
+      private
+
+      def serialize(value)
+        value = value.to_h if value.respond_to?(:to_h) && !value.is_a?(Hash)
+        value.is_a?(Hash) ? Common::Hashes.deep_stringify_keys(value) : value
+      end
+    end
+
+    # type: "result", "auth", "config", "message", "botMessagePreview", or
+    # "silentAuth"; attachment_layout: "list" or "grid".
+    class MessagingExtensionResult
+      def initialize(type: nil, attachment_layout: nil, attachments: nil,
+                     suggested_actions: nil, text: nil, activity_preview: nil)
+        @type = type
+        @attachment_layout = attachment_layout
+        @attachments = attachments
+        @suggested_actions = suggested_actions
+        @text = text
+        @activity_preview = activity_preview
+      end
+
+      def to_h
+        body = {}
+        body["type"] = @type if @type
+        body["attachmentLayout"] = @attachment_layout if @attachment_layout
+        body["attachments"] = @attachments.map { |attachment| serialize(attachment) } if @attachments
+        body["suggestedActions"] = serialize(@suggested_actions) if @suggested_actions
+        body["text"] = @text if @text
+        body["activityPreview"] = serialize(@activity_preview) if @activity_preview
+        body
+      end
+
+      private
+
+      def serialize(value)
+        value = value.to_h if value.respond_to?(:to_h) && !value.is_a?(Hash)
+        value.is_a?(Hash) ? Common::Hashes.deep_stringify_keys(value) : value
+      end
+    end
+
+    # Response for the query-style message extension invokes (query,
+    # selectItem, queryLink, querySettingUrl, setting).
+    class MessagingExtensionResponse
+      def initialize(compose_extension, cache_info: nil)
+        @compose_extension = compose_extension
+        @cache_info = cache_info
+      end
+
+      def to_h
+        body = {}
+        if @compose_extension
+          body["composeExtension"] =
+            @compose_extension.respond_to?(:to_h) ? @compose_extension.to_h : @compose_extension
+        end
+        body["cacheInfo"] = Common::Hashes.deep_stringify_keys(@cache_info) if @cache_info
+        body
+      end
+    end
+
+    # Response for the action-style invokes (submitAction, fetchTask):
+    # either a dialog via task: (a TaskModuleContinueResponse /
+    # TaskModuleMessageResponse) or a result via compose_extension:.
+    class MessagingExtensionActionResponse
+      def initialize(task: nil, compose_extension: nil, cache_info: nil)
+        @task = task
+        @compose_extension = compose_extension
+        @cache_info = cache_info
+      end
+
+      def to_h
+        body = {}
+        body["task"] = @task.respond_to?(:to_h) ? @task.to_h : @task if @task
+        if @compose_extension
+          body["composeExtension"] =
+            @compose_extension.respond_to?(:to_h) ? @compose_extension.to_h : @compose_extension
+        end
+        body["cacheInfo"] = Common::Hashes.deep_stringify_keys(@cache_info) if @cache_info
+        body
+      end
+    end
+  end
+end

data/lib/teams/api/model.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class Model
+      attr_reader :raw
+
+      def initialize(raw = {})
+        @raw = normalize_hash(raw)
+      end
+
+      def to_h
+        raw.dup
+      end
+
+      private
+
+      def read(*keys)
+        keys.each do |key|
+          return raw[key] if raw.key?(key)
+          return raw[key.to_s] if raw.key?(key.to_s)
+          return raw[key.to_sym] if raw.key?(key.to_sym)
+        end
+
+        nil
+      end
+
+      def normalize_hash(value)
+        value = value.to_h if value.respond_to?(:to_h)
+        return {} if value.nil?
+
+        value.each_with_object({}) do |(key, item), result|
+          result[key.to_s] = normalize_value(item)
+        end
+      end
+
+      def normalize_value(value)
+        case value
+        when Hash
+          normalize_hash(value)
+        when Array
+          value.map { |item| normalize_value(item) }
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/teams/api/notification_info.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class NotificationInfo < Model
+      def alert
+        read("alert")
+      end
+
+      def alert_in_meeting
+        read("alertInMeeting", "alert_in_meeting")
+      end
+
+      def external_resource_url
+        read("externalResourceUrl", "external_resource_url")
+      end
+
+      def to_h
+        body = raw.dup
+        body["alertInMeeting"] = alert_in_meeting unless alert_in_meeting.nil?
+        body["externalResourceUrl"] = external_resource_url if external_resource_url
+        body.delete("alert_in_meeting")
+        body.delete("external_resource_url")
+        body
+      end
+    end
+  end
+end

data/lib/teams/api/paged_members_result.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class PagedMembersResult < Model
+      def members
+        Array(read("members")).map { |member| Account.new(member) }
+      end
+
+      # Token to fetch the next page of members; nil on the last page.
+      def continuation_token
+        read("continuationToken", "continuation_token")
+      end
+    end
+  end
+end

data/lib/teams/api/quoted_reply_entity.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class QuotedReplyData < Model
+      def message_id
+        read("messageId", "message_id")
+      end
+
+      def sender_id
+        read("senderId", "sender_id")
+      end
+
+      def sender_name
+        read("senderName", "sender_name")
+      end
+
+      def preview
+        read("preview")
+      end
+
+      def time
+        read("time")
+      end
+
+      def is_reply_deleted
+        read("isReplyDeleted", "is_reply_deleted")
+      end
+
+      def validated_message_reference
+        read("validatedMessageReference", "validated_message_reference")
+      end
+
+      def to_h
+        body = {}
+        body["messageId"] = message_id if message_id
+        body["senderId"] = sender_id if sender_id
+        body["senderName"] = sender_name if sender_name
+        body["preview"] = preview if preview
+        body["time"] = time if time
+        body["isReplyDeleted"] = is_reply_deleted unless is_reply_deleted.nil?
+        body["validatedMessageReference"] = validated_message_reference unless validated_message_reference.nil?
+        body
+      end
+    end
+
+    class QuotedReplyEntity < Model
+      def type
+        "quotedReply"
+      end
+
+      def quoted_reply
+        value = read("quotedReply", "quoted_reply")
+        value.is_a?(QuotedReplyData) ? value : QuotedReplyData.new(value || {})
+      end
+
+      def to_h
+        {
+          "type" => type,
+          "quotedReply" => quoted_reply.to_h
+        }
+      end
+    end
+  end
+end

data/lib/teams/api/reaction_client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Teams
+  module Api
+    class ReactionClient
+      attr_reader :service_url, :http
+
+      def initialize(service_url:, http:)
+        @service_url = service_url.sub(%r{/+\z}, "")
+        @http = http
+      end
+
+      def add(conversation_id, activity_id, reaction_type)
+        http.put(path(conversation_id, activity_id, reaction_type))
+      end
+
+      def delete(conversation_id, activity_id, reaction_type)
+        http.delete(path(conversation_id, activity_id, reaction_type))
+      end
+
+      private
+
+      def path(conversation_id, activity_id, reaction_type)
+        "#{service_url}/v3/conversations/#{escape(conversation_id)}/activities/#{escape(activity_id)}/reactions/#{escape(reaction_type)}"
+      end
+
+      def escape(value)
+        URI.encode_www_form_component(value.to_s)
+      end
+    end
+  end
+end

data/lib/teams/api/sent_activity.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    # Represents an activity that was sent: the outbound activity merged with
+    # the server response, so the server-assigned id is always available.
+    # Mirrors the SDKs' SentActivity.
+    class SentActivity
+      attr_reader :raw
+
+      def self.merge(activity, response)
+        activity_hash = activity.respond_to?(:to_h) ? activity.to_h : activity
+        activity_hash = {} unless activity_hash.is_a?(Hash)
+        response_hash = response.is_a?(Hash) ? response : {}
+
+        new(activity_hash.merge(response_hash))
+      end
+
+      def initialize(raw = {})
+        @raw = raw
+      end
+
+      def id
+        raw["id"] || raw[:id]
+      end
+
+      def type
+        raw["type"]
+      end
+
+      def text
+        raw["text"]
+      end
+
+      def conversation_id
+        raw.dig("conversation", "id")
+      end
+
+      def [](key)
+        raw[key]
+      end
+
+      def to_h
+        raw.dup
+      end
+    end
+  end
+end

data/lib/teams/api/task_module.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    # Dialog (task module) content definition: either a card dialog (card:)
+    # or a webpage dialog (url:). height/width take "small"/"medium"/"large"
+    # or pixel integers.
+    class TaskModuleTaskInfo
+      def initialize(title: nil, height: nil, width: nil, url: nil, card: nil,
+                     fallback_url: nil, completion_bot_id: nil)
+        @title = title
+        @height = height
+        @width = width
+        @url = url
+        @card = card
+        @fallback_url = fallback_url
+        @completion_bot_id = completion_bot_id
+      end
+
+      def to_h
+        body = {}
+        body["title"] = @title if @title
+        body["height"] = @height if @height
+        body["width"] = @width if @width
+        body["url"] = @url if @url
+        body["card"] = card_attachment(@card) if @card
+        body["fallbackUrl"] = @fallback_url if @fallback_url
+        body["completionBotId"] = @completion_bot_id if @completion_bot_id
+        body
+      end
+
+      private
+
+      # Accepts a ready attachment hash, or a card (Cards::AdaptiveCard or
+      # hash) which is wrapped like MessageActivity#add_card.
+      def card_attachment(card)
+        card = card.to_h if card.respond_to?(:to_h) && !card.is_a?(Hash)
+        return Common::Hashes.deep_stringify_keys(card) if card.is_a?(Hash) && card.key?("contentType")
+
+        {
+          "contentType" => "application/vnd.microsoft.card.adaptive",
+          "content" => card.is_a?(Hash) ? Common::Hashes.deep_stringify_keys(card) : card
+        }
+      end
+    end
+
+    class TaskModuleContinueResponse
+      def initialize(value)
+        @value = value
+      end
+
+      def to_h
+        {
+          "type" => "continue",
+          "value" => @value.respond_to?(:to_h) ? @value.to_h : @value
+        }
+      end
+    end
+
+    class TaskModuleMessageResponse
+      def initialize(value)
+        @value = value
+      end
+
+      def to_h
+        { "type" => "message", "value" => @value.to_s }
+      end
+    end
+
+    class TaskModuleResponse
+      def initialize(task, cache_info: nil)
+        @task = task
+        @cache_info = cache_info
+      end
+
+      def to_h
+        body = { "task" => @task.respond_to?(:to_h) ? @task.to_h : @task }
+        body["cacheInfo"] = Common::Hashes.deep_stringify_keys(@cache_info) if @cache_info
+        body
+      end
+    end
+  end
+end

data/lib/teams/api/team_client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Teams
+  module Api
+    class TeamClient
+      attr_reader :service_url, :http
+
+      def initialize(service_url:, http:, logger: nil)
+        @service_url = service_url.sub(%r{/+\z}, "")
+        @http = http
+        @logger = logger
+      end
+
+      def get_by_id(team_id, service_url: nil)
+        path = "/v3/teams/#{escape(team_id)}"
+        url = absolute(path, service_url:)
+        @logger&.debug("Teams API GET #{url}")
+        TeamDetails.new(http.get(url))
+      end
+
+      # Returns the team's channels; the service wraps them in a
+      # "conversations" envelope, which all the SDKs unwrap.
+      def get_conversations(team_id, service_url: nil)
+        path = "/v3/teams/#{escape(team_id)}/conversations"
+        url = absolute(path, service_url:)
+        @logger&.debug("Teams API GET #{url}")
+        response = http.get(url)
+        conversations = response.is_a?(Hash) ? Array(response["conversations"]) : []
+        conversations.map { |channel| ChannelInfo.new(channel) }
+      end
+
+      private
+
+      def absolute(path, service_url: nil)
+        "#{(service_url || self.service_url).sub(%r{/+\z}, "")}#{path}"
+      end
+
+      def escape(value)
+        URI.encode_www_form_component(value.to_s)
+      end
+    end
+  end
+end

data/lib/teams/api/team_details.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class TeamDetails < Model
+      def id
+        read("id")
+      end
+
+      def name
+        read("name")
+      end
+
+      # "standard", "sharedChannel", or "privateChannel".
+      def type
+        read("type")
+      end
+
+      def aad_group_id
+        read("aadGroupId", "aad_group_id")
+      end
+
+      def channel_count
+        read("channelCount", "channel_count")
+      end
+
+      def member_count
+        read("memberCount", "member_count")
+      end
+
+      def tenant_id
+        read("tenantId", "tenant_id")
+      end
+    end
+  end
+end

data/lib/teams/api/team_info.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class TeamInfo < Model
+      def id
+        read("id")
+      end
+
+      def name
+        read("name")
+      end
+
+      def team_type
+        read("teamType", "team_type")
+      end
+
+      def member_count
+        read("memberCount", "member_count")
+      end
+
+      def channel_count
+        read("channelCount", "channel_count")
+      end
+
+      def aad_group_id
+        read("aadGroupId", "aad_group_id")
+      end
+
+      def to_h
+        body = raw.dup
+        body["teamType"] = team_type if team_type
+        body["memberCount"] = member_count if member_count
+        body["channelCount"] = channel_count if channel_count
+        body["aadGroupId"] = aad_group_id if aad_group_id
+        body.delete("team_type")
+        body.delete("member_count")
+        body.delete("channel_count")
+        body.delete("aad_group_id")
+        body
+      end
+    end
+  end
+end

data/lib/teams/api/tenant_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class TenantInfo < Model
+      def id
+        read("id")
+      end
+    end
+  end
+end

data/lib/teams/api/token.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class TokenResponse < Model
+      def channel_id
+        read("channelId", "channel_id")
+      end
+
+      def connection_name
+        read("connectionName", "connection_name")
+      end
+
+      def token
+        read("token")
+      end
+
+      def expiration
+        read("expiration")
+      end
+
+      def properties
+        read("properties")
+      end
+    end
+
+    class TokenStatus < Model
+      def channel_id
+        read("channelId", "channel_id")
+      end
+
+      def connection_name
+        read("connectionName", "connection_name")
+      end
+
+      def has_token
+        read("hasToken", "has_token")
+      end
+
+      def service_provider_display_name
+        read("serviceProviderDisplayName", "service_provider_display_name")
+      end
+    end
+
+    class TokenExchangeResource < Model
+      def id
+        read("id")
+      end
+
+      def uri
+        read("uri")
+      end
+
+      def provider_id
+        read("providerId", "provider_id")
+      end
+    end
+
+    class TokenPostResource < Model
+      def sas_url
+        read("sasUrl", "sas_url")
+      end
+    end
+
+    class SignInUrlResponse < Model
+      def sign_in_link
+        read("signInLink", "sign_in_link")
+      end
+
+      def token_exchange_resource
+        value = read("tokenExchangeResource", "token_exchange_resource")
+        value ? TokenExchangeResource.new(value) : nil
+      end
+
+      def token_post_resource
+        value = read("tokenPostResource", "token_post_resource")
+        value ? TokenPostResource.new(value) : nil
+      end
+    end
+  end
+end

data/lib/teams/api/typing_activity.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Teams
+  module Api
+    class TypingActivity
+      attr_reader :text
+
+      def initialize(text = nil)
+        @text = text
+      end
+
+      def to_h
+        body = { "type" => "typing" }
+        body["text"] = text if text
+        body
+      end
+    end
+  end
+end