• Home
• fr.vsct.tock
• tock-bot-connector-twitter
• 19.3.2
• source code
• TwitterBuilders.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

fr.vsct.tock.bot.connector.twitter.TwitterBuilders.kt Maven / Gradle / Ivy

/*
 * Copyright (C) 2019 VSCT
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package fr.vsct.tock.bot.connector.twitter

import fr.vsct.tock.bot.connector.ConnectorType
import fr.vsct.tock.bot.connector.twitter.model.AttachmentData
import fr.vsct.tock.bot.connector.twitter.model.CTA
import fr.vsct.tock.bot.connector.twitter.model.MediaCategory
import fr.vsct.tock.bot.connector.twitter.model.MessageCreate
import fr.vsct.tock.bot.connector.twitter.model.MessageData
import fr.vsct.tock.bot.connector.twitter.model.Option
import fr.vsct.tock.bot.connector.twitter.model.Options
import fr.vsct.tock.bot.connector.twitter.model.Recipient
import fr.vsct.tock.bot.connector.twitter.model.TwitterConnectorMessage
import fr.vsct.tock.bot.connector.twitter.model.TwitterPublicConnectorMessage
import fr.vsct.tock.bot.connector.twitter.model.WebUrl
import fr.vsct.tock.bot.connector.twitter.model.outcoming.DirectMessageOutcomingEvent
import fr.vsct.tock.bot.connector.twitter.model.outcoming.OutcomingEvent
import fr.vsct.tock.bot.connector.twitter.model.outcoming.Tweet
import fr.vsct.tock.bot.definition.IntentAware
import fr.vsct.tock.bot.definition.StoryHandlerDefinition
import fr.vsct.tock.bot.definition.StoryStep
import fr.vsct.tock.bot.engine.BotBus
import fr.vsct.tock.bot.engine.Bus
import fr.vsct.tock.bot.engine.action.ActionVisibility
import fr.vsct.tock.bot.engine.action.SendChoice
import mu.KotlinLogging

private val logger = KotlinLogging.logger {}

internal const val TWITTER_CONNECTOR_TYPE_ID = "twitter"

/**
 * The Twitter connector type.
 */
val twitterConnectorType = ConnectorType(TWITTER_CONNECTOR_TYPE_ID)

private const val MAX_OPTION_LABEL = 36
private const val MAX_OPTION_DESCRIPTION = 72
private const val MAX_METADATA = 1000

internal fun CharSequence.truncateIfLongerThan(maxCharacter: Int): String =
    if (maxCharacter >= 0 && this.length > maxCharacter) {
        if (maxCharacter > 3) this.substring(0, maxCharacter - 3) + "..."
        else this.substring(0, maxCharacter)
    } else this.toString()

/**
 * Creates a direct message with only text
 */
fun > T.directMessage(message: CharSequence): OutcomingEvent =
    OutcomingEvent(
        DirectMessageOutcomingEvent(
            MessageCreate(
                target = Recipient(userId.id),
                sourceAppId = applicationId,
                senderId = botId.id,
                messageData = MessageData(translate(message).toString())
            )
        )
    )

/**
 * Creates a direct message with Buttons
 * @see https://developer.twitter.com/en/docs/direct-messages/buttons/api-reference/buttons
 */
fun > T.directMessageWithButtons(message: CharSequence, ctas: List): OutcomingEvent =
    OutcomingEvent(
        DirectMessageOutcomingEvent(
            MessageCreate(
                target = Recipient(userId.id),
                sourceAppId = applicationId,
                senderId = botId.id,
                messageData = MessageData(
                    translate(message).toString(),
                    ctas = if (ctas.isNotEmpty()) ctas else null
                )
            )
        )
    )

/**
 * Creates a direct message with Buttons
 * @see https://developer.twitter.com/en/docs/direct-messages/buttons/api-reference/buttons
 */
fun > T.directMessageWithButtons(message: CharSequence, vararg ctas: CTA): OutcomingEvent =
    directMessageWithButtons(message, ctas.toList())

/**
 * Creates a direct message with quick replies
 * @see https://developer.twitter.com/en/docs/direct-messages/quick-replies/overview
 */
fun > T.directMessageWithOptions(message: CharSequence, options: List): OutcomingEvent =
    OutcomingEvent(
        DirectMessageOutcomingEvent(
            MessageCreate(
                target = Recipient(userId.id),
                sourceAppId = applicationId,
                senderId = botId.id,
                messageData = MessageData(
                    translate(message).toString(),
                    quickReply = if (options.isNotEmpty()) Options(options) else null
                )
            )
        )
    )

/**
 * Creates a direct message with quick replies
 * @see https://developer.twitter.com/en/docs/direct-messages/quick-replies/overview
 */
fun > T.directMessageWithOptions(message: CharSequence, vararg options: Option): OutcomingEvent =
    directMessageWithOptions(message, options.toList())


/**
 * Creates a direct message with an attachment
 * @see https://developer.twitter.com/en/docs/direct-messages/message-attachments/overview
 */
fun > T.directMessageWithAttachment(
    message: CharSequence,
    mediaCategory: MediaCategory,
    contentType: String,
    bytes: ByteArray,
    vararg options: Option
): OutcomingEvent = OutcomingEvent(
    DirectMessageOutcomingEvent(
        MessageCreate(
            target = Recipient(userId.id),
            sourceAppId = applicationId,
            senderId = botId.id,
            messageData = MessageData(
                translate(message).toString(),
                quickReply = if (options.size > 0) Options(options.toList()) else null
            )
        )
    ),
    AttachmentData(
        mediaCategory,
        contentType,
        bytes
    )
)

/**
 * Creates a direct message with a gif (Max 15MB)
 * @see https://developer.twitter.com/en/docs/direct-messages/message-attachments/overview
 */
fun > T.directMessageWithGIF(
    message: CharSequence,
    contentType: String,
    bytes: ByteArray,
    vararg options: Option
): OutcomingEvent = directMessageWithAttachment(message, MediaCategory.GIF, contentType, bytes, *options)

/**
 * Creates a direct message with a gif (Max 15MB)
 * @see https://developer.twitter.com/en/docs/direct-messages/message-attachments/overview
 */
fun > T.directMessageWithGIF(
    contentType: String,
    bytes: ByteArray,
    vararg options: Option
): OutcomingEvent = directMessageWithImage("", contentType, bytes, *options)

/**
 * Creates a direct message with an image (Max 5MB)
 * @see https://developer.twitter.com/en/docs/direct-messages/message-attachments/overview
 */
fun > T.directMessageWithImage(
    message: CharSequence,
    contentType: String,
    bytes: ByteArray,
    vararg options: Option
): OutcomingEvent = directMessageWithAttachment(message, MediaCategory.IMAGE, contentType, bytes, *options)

/**
 * Creates a direct message with an image (Max 5MB)
 * @see https://developer.twitter.com/en/docs/direct-messages/message-attachments/overview
 */
fun > T.directMessageWithImage(
    contentType: String,
    bytes: ByteArray,
    vararg options: Option
): OutcomingEvent = directMessageWithImage("", contentType, bytes, *options)

/**
 * Creates a direct message with a video (Max 15MB)
 * @see https://developer.twitter.com/en/docs/direct-messages/message-attachments/overview
 */
fun > T.directMessageWithVideo(
    message: CharSequence,
    contentType: String,
    bytes: ByteArray,
    vararg options: Option
): OutcomingEvent = directMessageWithAttachment(message, MediaCategory.VIDEO, contentType, bytes, *options)

/**
 * Creates a direct message with a video (Max 15MB)
 * @see https://developer.twitter.com/en/docs/direct-messages/message-attachments/overview
 */
fun > T.directMessageWithVideo(
    contentType: String,
    bytes: ByteArray,
    vararg options: Option
): OutcomingEvent = directMessageWithVideo("", contentType, bytes, *options)

/**
 * Creates a url button
 * @see https://developer.twitter.com/en/docs/direct-messages/buttons/api-reference/buttons
 */
fun > T.webUrl(
    label: CharSequence,
    url: CharSequence
): WebUrl {
    val l = translate(label)
    if (l.length > MAX_OPTION_LABEL) {
        logger.warn { "label $l has more than $MAX_OPTION_LABEL chars, it will be truncated" }
        return WebUrl(l.truncateIfLongerThan(MAX_OPTION_LABEL), url.toString())
    }
    return WebUrl(l.toString(), url.toString())
}

/**
 * Creates an Option Quick Reply
 * @see https://developer.twitter.com/en/docs/direct-messages/quick-replies/overview
 */
fun > T.option(
    label: CharSequence,
    description: CharSequence,
    targetIntent: IntentAware,
    step: StoryStep? = null,
    vararg parameters: Pair
): Option =
    option(label, description, targetIntent.wrappedIntent(), step, parameters.toMap())

/**
 * Creates an Option Quick Reply
 * @see https://developer.twitter.com/en/docs/direct-messages/quick-replies/overview
 */
fun > T.option(
    label: CharSequence,
    description: CharSequence,
    targetIntent: IntentAware,
    step: StoryStep? = null,
    parameters: Map
): Option =
    option(label, description, targetIntent, step, parameters) { intent, s, params ->
        SendChoice.encodeChoiceId(this, intent, s, params)
    }

/**
 * Creates an Option Quick Reply
 * @see https://developer.twitter.com/en/docs/direct-messages/quick-replies/overview
 */
private fun > T.option(
    label: CharSequence,
    description: CharSequence,
    targetIntent: IntentAware,
    step: StoryStep? = null,
    parameters: Map,
    metadataEncoder: (IntentAware, StoryStep?, Map) -> String
): Option {
    val l = translate(label)
    if (l.length > MAX_OPTION_LABEL) {
        logger.warn { "label $l has more than $MAX_OPTION_LABEL chars, it will be truncated" }
    }
    val d = translate(description)
    if (d.length > MAX_OPTION_DESCRIPTION) {
        logger.warn { "label $d has more than $MAX_OPTION_DESCRIPTION chars, it will be truncated" }
    }
    val metadata = metadataEncoder.invoke(targetIntent, step, parameters)
    if (metadata.length > MAX_METADATA) {
        logger.warn { "payload $metadata has more than $MAX_METADATA chars, it will be truncated" }
    }
    return Option(
        l.truncateIfLongerThan(MAX_OPTION_LABEL),
        d.truncateIfLongerThan(MAX_OPTION_DESCRIPTION),
        metadata.truncateIfLongerThan(MAX_METADATA)
    )
}

/**
 * Adds a Twitter [ConnectorMessage] if the current connector is Twitter and the interface is not public.
 * You need to call [BotBus.send] or [BotBus.end] later to send this message.
 */
fun BotBus.withTwitter(messageProvider: () -> TwitterConnectorMessage): BotBus {
    withVisibility(action.metadata.visibility)
    return if (action.metadata.visibility != ActionVisibility.public) {
        withMessage(twitterConnectorType, messageProvider)
    } else {
        this
    }
}

/**
 * Adds a Twitter [ConnectorMessage] if the current connector is Twitter and the interface is public.
 * You need to call [BotBus.send] or [BotBus.end] later to send this message.
 */
fun BotBus.withPublicTwitter(messageProvider: () -> TwitterPublicConnectorMessage): BotBus {
    withVisibility(action.metadata.visibility)
    return if (action.metadata.visibility == ActionVisibility.public) {
        withMessage(twitterConnectorType, messageProvider)
    } else {
        this
    }
}

/**
 * End the conversation only if the visibility is public
 */
fun BotBus.endIfPublicTwitter() {
    if (targetConnectorType == twitterConnectorType && action.metadata.visibility == ActionVisibility.public) {
        end()
    }
}

/**
 * Create a tweet
 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/overview
 */
fun BotBus.tweet(message: CharSequence): Tweet {
    return Tweet(translate(message).toString())
}


/**
 * Create a tweet with a link for DM to the account listened
 * @see https://developer.twitter.com/en/docs/tweets/post-and-engage/overview
 */
fun BotBus.tweetWithInviteForDM(message: CharSequence): Tweet {
    return Tweet(translate(message).toString(), botId.id)
}