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.
bot-connector-twitter.24.9.0.source-code.TwitterClient.kt Maven / Gradle / Ivy
/*
* Copyright (C) 2017/2021 e-voyageurs technologies
*
* 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 ai.tock.bot.connector.twitter
import ai.tock.bot.connector.ConnectorException
import ai.tock.bot.connector.twitter.model.AccessToken
import ai.tock.bot.connector.twitter.model.Attachment
import ai.tock.bot.connector.twitter.model.AttachmentMedia
import ai.tock.bot.connector.twitter.model.Command
import ai.tock.bot.connector.twitter.model.MediaCategory
import ai.tock.bot.connector.twitter.model.MediaUpload
import ai.tock.bot.connector.twitter.model.RequestToken
import ai.tock.bot.connector.twitter.model.User
import ai.tock.bot.connector.twitter.model.Webhook
import ai.tock.bot.connector.twitter.model.outcoming.OutcomingEvent
import ai.tock.shared.addJacksonConverter
import ai.tock.shared.create
import ai.tock.shared.error
import ai.tock.shared.longProperty
import ai.tock.shared.retrofitBuilderWithTimeoutAndLogger
import mu.KotlinLogging
import oauth.signpost.http.HttpParameters
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.MultipartBody
import okhttp3.RequestBody
import retrofit2.Call
import retrofit2.Response
import retrofit2.converter.scalars.ScalarsConverterFactory
import retrofit2.http.Body
import retrofit2.http.DELETE
import retrofit2.http.GET
import retrofit2.http.Multipart
import retrofit2.http.POST
import retrofit2.http.Part
import retrofit2.http.Path
import retrofit2.http.Query
import se.akerfeldt.okhttp.signpost.OkHttpOAuthConsumer
import se.akerfeldt.okhttp.signpost.SigningInterceptor
import java.net.URLDecoder
import java.net.URLEncoder
import java.util.Base64
import java.util.Date
import java.util.LinkedHashMap
import javax.crypto.Mac
import javax.crypto.spec.SecretKeySpec
import ai.tock.bot.connector.twitter.model.Tweet as InputTweet
import ai.tock.bot.connector.twitter.model.outcoming.Tweet as OutputTweet
/**
* Twitter client
*/
internal class TwitterClient(
val environment: String,
val consumerKey: String,
val consumerSecret: String,
token: String? = null,
secret: String? = null
) {
private val BASE_URL = "https://api.twitter.com"
private val BASE_MEDIA_URL = "https://upload.twitter.com"
private val MEDIA_CHUNK_SIZE = 1024 * 500
/**
* @see https://developer.twitter.com/en/docs/basics/authentication/api-reference/authenticate
*
*/
interface OAuthApi {
@POST("/oauth/request_token")
fun requestToken(): Call
@POST("/oauth/access_token")
fun accessToken(): Call
}
/**
* @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/overview
*
*/
interface UserApi {
@GET("/1.1/users/show.json")
fun user(@Query("user_id") userId: String): Call
}
/***
* @see https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-premium#get-account-activity-all-env-name-subscriptions
*
*/
interface AccountActivityApi {
@POST("/1.1/account_activity/all/{environment}/webhooks.json")
fun registerWebhook(@Path("environment") environment: String, @Query("url") url: String): Call
@POST("/1.1/account_activity/all/{environment}/subscriptions.json")
fun subscribe(@Path("environment") environment: String): Call
@GET("/1.1/account_activity/all/{environment}/subscriptions.json")
fun subscriptions(@Path("environment") environment: String): Call
@DELETE("/1.1/account_activity/all/{environment}/webhooks/{webhook_id}.json")
fun unregisterWebhook(@Path("environment") environment: String, @Path("webhook_id") webhookId: String): Call
@GET("/1.1/account_activity/all/{environment}/webhooks.json")
fun webhooks(@Path("environment") environment: String): Call>
}
/**
* @see https://developer.twitter.com/en/docs/direct-messages/sending-and-receiving/api-reference
*
*/
interface DirectMessageApi {
@POST("/1.1/direct_messages/events/new.json")
fun new(@Body OutcomingEvent: OutcomingEvent): Call
@GET("/1.1/direct_messages/events/show.json")
fun show(): Call
@GET("/1.1/direct_messages/events/list.json")
fun events(): Call
@DELETE("/1.1/direct_messages/events/destroy.json")
fun destroy(): Call
}
/**
* @see https://developer.twitter.com/en/docs/media/upload-media/overview
*
*/
interface MediaApi {
@POST("/1.1/media/upload.json")
fun init(
@Query("command") command: Command = Command.INIT,
@Query("total_bytes") totalBytes: Long,
@Query("media_type") mediaTYpe: String,
@Query("media_category") mediaCategory: String?,
@Query("additional_owners") additionalOwners: String?
): Call
@Multipart
@POST("/1.1/media/upload.json")
fun append(
@Query("command") command: Command = Command.APPEND,
@Query("media_id") mediaId: String,
@Query("segment_index") segmentIndex: Int,
@Part file: MultipartBody.Part
): Call
@POST("/1.1/media/upload.json")
fun finalize(
@Query("command") command: Command = Command.FINALIZE,
@Query("media_id") mediaId: String
): Call
}
interface StatusApi {
@POST("/1.1/statuses/update.json")
fun status(
@Query("status") statusMessage: String,
@Query("in_reply_to_status_id") replyStatusId: String? = null,
@Query("auto_populate_reply_metadata") autoPopulateMetadata: String = "true",
@Query("enable_dmcommands") enableDM: String = "false"
): Call
}
private val logger = KotlinLogging.logger {}
private val accountActivityApi: AccountActivityApi
private val directMessageApi: DirectMessageApi
private val userApi: UserApi
private val mediaApi: MediaApi
private val statusApi: StatusApi
init {
val twitterOAuthConsumer = OkHttpOAuthConsumer(consumerKey, consumerSecret)
if (token != null) {
twitterOAuthConsumer.setTokenWithSecret(token, secret)
}
accountActivityApi = retrofitBuilderWithTimeoutAndLogger(
longProperty("tock_twitter_request_timeout_ms", 30000),
logger,
interceptors = listOf(SigningInterceptor(twitterOAuthConsumer))
)
.baseUrl(BASE_URL)
.addJacksonConverter()
.build()
.create()
directMessageApi = retrofitBuilderWithTimeoutAndLogger(
longProperty("tock_twitter_request_timeout_ms", 30000),
logger,
interceptors = listOf(SigningInterceptor(twitterOAuthConsumer))
)
.baseUrl(BASE_URL)
.addJacksonConverter()
.build()
.create()
userApi = retrofitBuilderWithTimeoutAndLogger(
longProperty("tock_twitter_request_timeout_ms", 30000),
logger,
interceptors = listOf(SigningInterceptor(twitterOAuthConsumer))
)
.baseUrl(BASE_URL)
.addJacksonConverter()
.build()
.create()
mediaApi = retrofitBuilderWithTimeoutAndLogger(
longProperty("tock_twitter_request_timeout_ms", 30000),
logger,
interceptors = listOf(SigningInterceptor(twitterOAuthConsumer))
)
.baseUrl(BASE_MEDIA_URL)
.addJacksonConverter()
.build()
.create()
statusApi = retrofitBuilderWithTimeoutAndLogger(
longProperty("tock_twitter_request_timeout_ms", 30000),
logger,
interceptors = listOf(SigningInterceptor(twitterOAuthConsumer))
)
.baseUrl(BASE_URL)
.addJacksonConverter()
.build()
.create()
}
private fun defaultUser(): User {
return User("", "", "", Date().time, null, null, null, "", "", false, false, 0, 0, 0, "", "")
}
private fun Response<*>.logError() {
val error = message()
val errorCode = code()
logger.warn { "Twitter Error : $errorCode $error" }
val errorBody = errorBody()?.string()
logger.warn { "Twitter Error body : $errorBody" }
}
private fun splitQuery(query: String): Map {
val queryPairs = LinkedHashMap()
val pairs = query.split("&".toRegex()).dropLastWhile { it.isEmpty() }.toTypedArray()
for (pair in pairs) {
val idx = pair.indexOf("=")
queryPairs[URLDecoder.decode(pair.substring(0, idx), "UTF-8")] = URLDecoder.decode(pair.substring(idx + 1), "UTF-8")
}
return queryPairs
}
/**
* Allows a Consumer application to obtain an OAuth Request Token to request user authorization
*
* @return requestToken null if failed
*/
fun requestToken(): RequestToken? {
val oAuthApiConsumer = OkHttpOAuthConsumer(consumerKey, consumerSecret)
val httpParameters = HttpParameters()
httpParameters.put("oauth_callback", "oob")
oAuthApiConsumer.setAdditionalParameters(httpParameters)
val oAuthApi: OAuthApi = retrofitBuilderWithTimeoutAndLogger(
longProperty("tock_twitter_request_timeout_ms", 30000),
logger,
interceptors = listOf(SigningInterceptor(oAuthApiConsumer))
)
.baseUrl(BASE_URL)
.addConverterFactory(ScalarsConverterFactory.create())
.build()
.create()
return try {
val response = oAuthApi.requestToken().execute()
if (response.isSuccessful) {
response.body()?.let {
logger.debug { it }
val queryPairs = splitQuery(it)
RequestToken(
queryPairs.get("oauth_token") ?: "",
queryPairs.get("oauth_token_secret") ?: "",
queryPairs.get("oauth_callback_confirmed")?.toBoolean() ?: false
)
}
} else {
response.logError()
null
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
null
}
}
/**
* Allows a Consumer application to use an OAuth Request Token to request user authorization.
*
* @return url for request user authorization
*/
fun authorizationUrl(requestToken: RequestToken): String {
return "$BASE_URL/oauth/authorize?oauth_token=${requestToken.oauthToken}"
}
/**
* Allows a Consumer application to use an OAuth Request Token to request user authorization.
*
* @return user accessToken null if failed
*/
fun accessToken(requestToken: RequestToken, oauthVerifier: String): AccessToken? {
val oAuthApiConsumer = OkHttpOAuthConsumer(consumerKey, consumerSecret)
oAuthApiConsumer.setTokenWithSecret(requestToken.oauthToken, requestToken.oauthTokenSecret)
val httpParameters = HttpParameters()
httpParameters.put("oauth_verifier", oauthVerifier)
oAuthApiConsumer.setAdditionalParameters(httpParameters)
val oAuthApi: OAuthApi = retrofitBuilderWithTimeoutAndLogger(
longProperty("tock_twitter_request_timeout_ms", 30000),
logger,
interceptors = listOf(SigningInterceptor(oAuthApiConsumer))
)
.baseUrl(BASE_URL)
.addConverterFactory(ScalarsConverterFactory.create())
.build()
.create()
return try {
val response = oAuthApi.accessToken().execute()
if (response.isSuccessful) {
response.body()?.let {
logger.debug { it }
val queryPairs = splitQuery(it)
AccessToken(
queryPairs["oauth_token"] ?: "",
queryPairs["oauth_token_secret"] ?: "",
queryPairs.get("user_id") ?: "",
queryPairs["screen_name"] ?: ""
)
}
} else {
response.logError()
null
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
null
}
}
/**
* Registers a webhook URL for all event types. The URL will be validated via CRC request before saving.
* In case the validation failed, returns comprehensive error message to the requester.
*
* @param webhook endpoint
*
* @return webhook or null if registration failed
*
*/
fun registerWebhook(url: String): Webhook? {
return try {
val response = accountActivityApi.registerWebhook(environment, url).execute()
if (response.isSuccessful) {
response.body()?.also {
logger.debug { it }
}
} else {
response.logError()
null
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
null
}
}
/**
* Subscribes the provided application to all events for the provided environment for all message types.
* After activation, all events for the requesting user will be sent to the application’s webhook via POST request.
*
* Subscriptions are limited to a maximum of 15 unique users per application in the free (sandbox) tier.
*
* @return true if Subscription success
*/
fun subscribe(): Boolean {
return try {
val response = accountActivityApi.subscribe("develop").execute()
if (!response.isSuccessful) {
response.logError()
false
} else {
true
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
false
}
}
/**
* Provides a way to determine if a webhook configuration is subscribed to the provided user’s events.
*
* @return If the provided user context has an active subscription with provided application, returns true.
* false if the user does not have an active subscription.
*
*/
fun subscriptions(): Boolean {
return try {
val response = accountActivityApi.subscriptions("develop").execute()
response.code() == 204
} catch (e: Exception) {
// log and ignore
logger.error(e)
false
}
}
/**
* Removes the webhook from the provided application's all activities configuration.
*
* @param The webhook ID can be accessed by making a call to {@link TwitterClient#webhooks()} method
*
* @return true if success else false
*
*/
fun unregisterWebhook(webhookId: String): Boolean {
return try {
val response = accountActivityApi.unregisterWebhook(environment, webhookId).execute()
if (!response.isSuccessful) {
response.logError()
false
} else {
true
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
false
}
}
/**
* Returns a variety of information about the user specified by the required user_id
*
* @return a user profile
*/
fun user(userId: String): User {
return try {
val response = userApi.user(userId).execute()
if (response.isSuccessful) {
response.body()?.also {
logger.debug { it }
} ?: defaultUser()
} else {
response.logError()
defaultUser()
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
defaultUser()
}
}
/**
* Returns all environments, webhook URLs and their statuses for the authenticating app. Currently, only one webhook URL can be registered to each environment.
* We mark a URL as invalid if it fails the daily validation check. In order to re-enable the URL, call the update endpoint.
*
* Alternatively, this endpoint can be used with an environment name to only return webhook URLS for the given environment: GET account_activity/all/:env_name/webhooks (see second example)
*
* @return list of webhooks
*/
fun webhooks(): List = try {
val response = accountActivityApi.webhooks(environment).execute()
if (response.isSuccessful) {
response.body()?.also {
logger.debug { it }
} ?: emptyList()
} else {
response.logError()
emptyList()
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
emptyList()
}
fun sendDirectMessage(outcomingEvent: OutcomingEvent): Boolean = try {
val response = directMessageApi.new(outcomingEvent).execute()
if (!response.isSuccessful) {
response.logError()
false
} else {
true
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
false
}
fun sendTweet(tweet: OutputTweet, threadId: Long?): Boolean = try {
val enableDM = tweet.dmRecipientID != null
val enableWelcomeMessage = tweet.welcomeMessageID != null
val enableDefaultMessage = tweet.defaultMessage != null
val message = if (enableDM) {
tweet.text +
" https://twitter.com/messages/compose?recipient_id=" + tweet.dmRecipientID +
(if (enableWelcomeMessage) "&welcome_message_id=" + tweet.welcomeMessageID else "") +
(if (enableDefaultMessage) "&text=" + URLEncoder.encode(tweet.defaultMessage, "UTF-8") else "")
} else {
tweet.text
}
val response = statusApi.status(message, threadId?.toString(), enableDM = enableDM.toString()).execute()
if (!response.isSuccessful) {
response.logError()
false
} else {
true
}
} catch (e: Exception) {
// log and ignore
logger.error(e)
false
}
fun createAttachment(mediaCategory: MediaCategory, contentType: String, data: ByteArray): Attachment {
val mediaUploadInit = uploadMediaInit(mediaCategory, contentType, data.size.toLong())
uploadMedia(data, mediaUploadInit.mediaIdString)
val mediaUpload = uploadMediaFinalize(mediaUploadInit.mediaIdString)
return Attachment(type = "media", media = AttachmentMedia(mediaUpload.mediaIdString))
}
private fun uploadMedia(data: ByteArray, mediaId: String) {
var segmentIndex = 0
val segmentCount = (data.size + MEDIA_CHUNK_SIZE - 1) / MEDIA_CHUNK_SIZE
while (segmentIndex < segmentCount) {
val start = segmentIndex * MEDIA_CHUNK_SIZE
val end = if (segmentIndex < segmentCount - 1) MEDIA_CHUNK_SIZE * (segmentIndex + 1) else data.size
val chunk = data.copyOfRange(start, end)
val append = uploadMediaAppend(mediaId, segmentIndex, chunk)
if (!append) {
throw ConnectorException("Media upload append segment_index $segmentIndex failed")
}
segmentIndex++
}
}
private fun uploadMediaInit(mediaCategory: MediaCategory, contentType: String, totalBytes: Long): MediaUpload {
val response = mediaApi.init(Command.INIT, totalBytes, contentType, mediaCategory.mediaCategory, null).execute()
if (response.isSuccessful) {
return response.body()?.also {
logger.debug { it }
} ?: throw ConnectorException("null body")
} else {
response.logError()
throw ConnectorException("Media upload init failed")
}
}
private fun uploadMediaAppend(mediaId: String, segmentIndex: Int, chunk: ByteArray): Boolean {
val requestChunk: RequestBody = RequestBody.create(
"application/octet-stream".toMediaType(),
chunk
)
val body = MultipartBody.Part.createFormData("media", "chunk-segment-$segmentIndex", requestChunk)
val response = mediaApi.append(Command.APPEND, mediaId, segmentIndex, body).execute()
if (!response.isSuccessful) {
response.logError()
}
return response.isSuccessful
}
private fun uploadMediaFinalize(mediaId: String): MediaUpload {
val response = mediaApi.finalize(Command.FINALIZE, mediaId).execute()
if (response.isSuccessful) {
return response.body()?.also {
logger.debug { it }
} ?: throw ConnectorException("null body")
} else {
response.logError()
throw ConnectorException("Media upload finalize failed")
}
}
fun b64HmacSHA256(payload: String): String {
val signingKey = SecretKeySpec(
consumerSecret.toByteArray(),
"HmacSHA256"
)
val mac = Mac.getInstance("HmacSHA256")
mac.init(signingKey)
val bytes = mac.doFinal(payload.toByteArray())
return String(Base64.getEncoder().encode(bytes))
}
}
