Skip to content

Commit

Permalink
Added Twitter Direct Message Source Kamelet
Browse files Browse the repository at this point in the history
  • Loading branch information
oscerd authored and nicolaferraro committed Mar 29, 2021
1 parent d12e8fa commit 3a6da54
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
71 changes: 71 additions & 0 deletions docs/modules/ROOT/pages/twitter-directmessage-source.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/twitter-directmessage-source.svg[] Twitter Direct Message Source

*Provided by: "Apache Software Foundation"*

Allows to get all direct messages for your Twitter account.

It requires tokens that can be obtained by creating an application
in the Twitter developer portal: https://developer.twitter.com/.

== Configuration Options

The following table summarizes the configuration options available for the `twitter-directmessage-source` Kamelet:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *accessToken {empty}* *| Access Token| The Access Token from the Twitter application in the developer portal| string| |
| *accessTokenSecret {empty}* *| Access Token Secret| The Access Token Secret from the Twitter application in the developer portal| string| |
| *apiKey {empty}* *| API Key| The API Key from the Twitter application in the developer portal| string| |
| *apiKeySecret {empty}* *| API Key Secret| The API Key Secret from the Twitter application in the developer portal| string| |
| *user {empty}* *| User| The user we want to read the direct messages| string| | `"ApacheCamel"`
|===

NOTE: Fields marked with ({empty}*) are mandatory.

== Usage

This section summarizes how the `twitter-directmessage-source` can be used in various contexts.

=== Knative Source

The `twitter-directmessage-source` Kamelet can be used as Knative source by binding it to a Knative object.

.twitter-directmessage-source-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: twitter-directmessage-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: twitter-directmessage-source
properties:
accessToken: "The Access Token"
accessTokenSecret: "The Access Token Secret"
apiKey: "The API Key"
apiKeySecret: "The API Key Secret"
user: "ApacheCamel"
sink:
ref:
kind: InMemoryChannel
apiVersion: messaging.knative.dev/v1
name: mychannel
----

Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.

Save the `twitter-directmessage-source-binding.yaml` file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

[source,shell]
----
kubectl apply -f twitter-directmessage-source-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT

0 comments on commit 3a6da54

Please sign in to comment.