emiliosetiadarma commented on code in PR #5947:
URL: https://github.com/apache/nifi/pull/5947#discussion_r848782906
##########
nifi-nar-bundles/nifi-social-media-bundle/nifi-twitter-processors/pom.xml:
##########
@@ -69,5 +80,17 @@
<version>1.17.0-SNAPSHOT</version>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>com.squareup.okhttp3</groupId>
+ <artifactId>okhttp</artifactId>
+ <version>4.9.3</version>
+ <scope>test</scope>
Review Comment:
Making the changes
##########
nifi-nar-bundles/nifi-social-media-bundle/nifi-twitter-processors/src/main/java/org/apache/nifi/processors/twitter/ConsumeTwitter.java:
##########
@@ -0,0 +1,318 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.nifi.processors.twitter;
+
+import org.apache.nifi.annotation.behavior.InputRequirement;
+import org.apache.nifi.annotation.behavior.InputRequirement.Requirement;
+import org.apache.nifi.annotation.behavior.PrimaryNodeOnly;
+import org.apache.nifi.annotation.behavior.SupportsBatching;
+import org.apache.nifi.annotation.behavior.WritesAttribute;
+import org.apache.nifi.annotation.documentation.CapabilityDescription;
+import org.apache.nifi.annotation.documentation.Tags;
+import org.apache.nifi.annotation.lifecycle.OnScheduled;
+import org.apache.nifi.annotation.lifecycle.OnStopped;
+import org.apache.nifi.components.AllowableValue;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.flowfile.FlowFile;
+import org.apache.nifi.flowfile.attributes.CoreAttributes;
+import org.apache.nifi.processor.AbstractProcessor;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.ProcessorInitializationContext;
+import org.apache.nifi.processor.Relationship;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.io.OutputStreamCallback;
+import org.apache.nifi.processor.util.StandardValidators;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Set;
+import java.util.List;
+import java.util.HashSet;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Map;
+import java.util.HashMap;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.LinkedBlockingQueue;
+
+@PrimaryNodeOnly
+@SupportsBatching
+@InputRequirement(Requirement.INPUT_FORBIDDEN)
+@Tags({"twitter", "tweets", "social media", "status", "json"})
+@CapabilityDescription("Streams tweets from Twitter's streaming API v2. The
stream provides a sample stream or a search "
+ + "stream based on previously uploaded rules. This processor also provides
a pass through for certain fields of the "
+ + "tweet to be returned as part of the response. See "
+ +
"https://developer.twitter.com/en/docs/twitter-api/data-dictionary/introduction
for more information regarding the "
+ + "Tweet object model. \n\n"
+ + "Warning: the underlying Java SDK used is still in beta as of the
publishing of this processor feature.")
+@WritesAttribute(attribute = "mime.type", description = "Sets mime type to
application/json")
+public class ConsumeTwitter extends AbstractProcessor {
+
+ static final AllowableValue ENDPOINT_SAMPLE = new AllowableValue("Sample
Endpoint",
+ "Sample Endpoint",
+ "The endpoint that provides a stream of about 1% of tweets in
real-time");
+ static final AllowableValue ENDPOINT_SEARCH = new AllowableValue("Search
Endpoint",
+ "Search Endpoint",
+ "The endpoint that provides a stream of tweets that matches the
rules you added to the stream. " +
+ "If rules are not configured, then the stream will be
empty");
+
+ public static final PropertyDescriptor ENDPOINT = new
PropertyDescriptor.Builder()
+ .name("consume-twitter-endpoint")
+ .displayName("Twitter Endpoint")
+ .description("Specifies which endpoint tweets should be pulled
from. " +
+ "Usage of search endpoint requires that rules be uploaded
beforehand. See " +
+
"https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/";
+
+ "post-tweets-search-stream-rules")
+ .required(true)
+ .allowableValues(ENDPOINT_SAMPLE, ENDPOINT_SEARCH)
+ .defaultValue(ENDPOINT_SAMPLE.getValue())
+ .build();
+ public static final PropertyDescriptor BASE_PATH = new
PropertyDescriptor.Builder()
+ .name("base-path")
+ .displayName("Base Path")
+ .description("Specifies which base path the API client will use
for HTTP requests. " +
+ "Generally should not be changed from the default
https://api.twitter.com except for testing")
+ .required(true)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .defaultValue("https://api.twitter.com";)
+ .build();
+ public static final PropertyDescriptor BEARER_TOKEN = new
PropertyDescriptor.Builder()
+ .name("bearer-token")
+ .displayName("Bearer Token")
+ .description("The Bearer Token provided by Twitter.")
+ .required(true)
+ .sensitive(true)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor QUEUE_SIZE = new
PropertyDescriptor.Builder()
+ .name("queue-size")
+ .displayName("Queue Size")
+ .description("The size of the queue used to queue tweets")
Review Comment:
Making the changes
##########
nifi-nar-bundles/nifi-social-media-bundle/nifi-twitter-processors/src/main/java/org/apache/nifi/processors/twitter/ConsumeTwitter.java:
##########
@@ -0,0 +1,318 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.nifi.processors.twitter;
+
+import org.apache.nifi.annotation.behavior.InputRequirement;
+import org.apache.nifi.annotation.behavior.InputRequirement.Requirement;
+import org.apache.nifi.annotation.behavior.PrimaryNodeOnly;
+import org.apache.nifi.annotation.behavior.SupportsBatching;
+import org.apache.nifi.annotation.behavior.WritesAttribute;
+import org.apache.nifi.annotation.documentation.CapabilityDescription;
+import org.apache.nifi.annotation.documentation.Tags;
+import org.apache.nifi.annotation.lifecycle.OnScheduled;
+import org.apache.nifi.annotation.lifecycle.OnStopped;
+import org.apache.nifi.components.AllowableValue;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.flowfile.FlowFile;
+import org.apache.nifi.flowfile.attributes.CoreAttributes;
+import org.apache.nifi.processor.AbstractProcessor;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.ProcessorInitializationContext;
+import org.apache.nifi.processor.Relationship;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.io.OutputStreamCallback;
+import org.apache.nifi.processor.util.StandardValidators;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Set;
+import java.util.List;
+import java.util.HashSet;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Map;
+import java.util.HashMap;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.LinkedBlockingQueue;
+
+@PrimaryNodeOnly
+@SupportsBatching
+@InputRequirement(Requirement.INPUT_FORBIDDEN)
+@Tags({"twitter", "tweets", "social media", "status", "json"})
+@CapabilityDescription("Streams tweets from Twitter's streaming API v2. The
stream provides a sample stream or a search "
+ + "stream based on previously uploaded rules. This processor also provides
a pass through for certain fields of the "
+ + "tweet to be returned as part of the response. See "
+ +
"https://developer.twitter.com/en/docs/twitter-api/data-dictionary/introduction
for more information regarding the "
+ + "Tweet object model. \n\n"
+ + "Warning: the underlying Java SDK used is still in beta as of the
publishing of this processor feature.")
+@WritesAttribute(attribute = "mime.type", description = "Sets mime type to
application/json")
+public class ConsumeTwitter extends AbstractProcessor {
+
+ static final AllowableValue ENDPOINT_SAMPLE = new AllowableValue("Sample
Endpoint",
+ "Sample Endpoint",
+ "The endpoint that provides a stream of about 1% of tweets in
real-time");
+ static final AllowableValue ENDPOINT_SEARCH = new AllowableValue("Search
Endpoint",
+ "Search Endpoint",
+ "The endpoint that provides a stream of tweets that matches the
rules you added to the stream. " +
+ "If rules are not configured, then the stream will be
empty");
+
+ public static final PropertyDescriptor ENDPOINT = new
PropertyDescriptor.Builder()
+ .name("consume-twitter-endpoint")
+ .displayName("Twitter Endpoint")
+ .description("Specifies which endpoint tweets should be pulled
from. " +
+ "Usage of search endpoint requires that rules be uploaded
beforehand. See " +
+
"https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/";
+
+ "post-tweets-search-stream-rules")
+ .required(true)
+ .allowableValues(ENDPOINT_SAMPLE, ENDPOINT_SEARCH)
+ .defaultValue(ENDPOINT_SAMPLE.getValue())
+ .build();
+ public static final PropertyDescriptor BASE_PATH = new
PropertyDescriptor.Builder()
+ .name("base-path")
+ .displayName("Base Path")
+ .description("Specifies which base path the API client will use
for HTTP requests. " +
+ "Generally should not be changed from the default
https://api.twitter.com except for testing")
+ .required(true)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .defaultValue("https://api.twitter.com";)
+ .build();
+ public static final PropertyDescriptor BEARER_TOKEN = new
PropertyDescriptor.Builder()
+ .name("bearer-token")
+ .displayName("Bearer Token")
+ .description("The Bearer Token provided by Twitter.")
+ .required(true)
+ .sensitive(true)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor QUEUE_SIZE = new
PropertyDescriptor.Builder()
+ .name("queue-size")
+ .displayName("Queue Size")
+ .description("The size of the queue used to queue tweets")
+ .required(true)
+ .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR)
+ .defaultValue("10000")
+ .build();
+ public static final PropertyDescriptor BATCH_SIZE = new
PropertyDescriptor.Builder()
+ .name("batch-size")
+ .displayName("Batch Size")
+ .description("The maximum size of the number of tweets to be
written to a single FlowFile." +
+ "Will write less tweets if it there are not any tweets
left in queue")
+ .required(true)
+ .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR)
+ .defaultValue("10")
+ .build();
+ public static final PropertyDescriptor TWEET_FIELDS = new
PropertyDescriptor.Builder()
+ .name("tweet-fields")
+ .displayName("Tweet Fields")
+ .description("A comma-separated list of tweet fields to be
returned as part of the tweet. Refer to " +
+
"https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet
" +
+ "for proper usage. Possible field values are: " +
Review Comment:
Making the changes
##########
nifi-nar-bundles/nifi-social-media-bundle/nifi-twitter-processors/src/main/java/org/apache/nifi/processors/twitter/ConsumeTwitter.java:
##########
@@ -0,0 +1,318 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.nifi.processors.twitter;
+
+import org.apache.nifi.annotation.behavior.InputRequirement;
+import org.apache.nifi.annotation.behavior.InputRequirement.Requirement;
+import org.apache.nifi.annotation.behavior.PrimaryNodeOnly;
+import org.apache.nifi.annotation.behavior.SupportsBatching;
+import org.apache.nifi.annotation.behavior.WritesAttribute;
+import org.apache.nifi.annotation.documentation.CapabilityDescription;
+import org.apache.nifi.annotation.documentation.Tags;
+import org.apache.nifi.annotation.lifecycle.OnScheduled;
+import org.apache.nifi.annotation.lifecycle.OnStopped;
+import org.apache.nifi.components.AllowableValue;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.flowfile.FlowFile;
+import org.apache.nifi.flowfile.attributes.CoreAttributes;
+import org.apache.nifi.processor.AbstractProcessor;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.ProcessorInitializationContext;
+import org.apache.nifi.processor.Relationship;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.io.OutputStreamCallback;
+import org.apache.nifi.processor.util.StandardValidators;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Set;
+import java.util.List;
+import java.util.HashSet;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Map;
+import java.util.HashMap;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.LinkedBlockingQueue;
+
+@PrimaryNodeOnly
+@SupportsBatching
+@InputRequirement(Requirement.INPUT_FORBIDDEN)
+@Tags({"twitter", "tweets", "social media", "status", "json"})
+@CapabilityDescription("Streams tweets from Twitter's streaming API v2. The
stream provides a sample stream or a search "
+ + "stream based on previously uploaded rules. This processor also provides
a pass through for certain fields of the "
+ + "tweet to be returned as part of the response. See "
+ +
"https://developer.twitter.com/en/docs/twitter-api/data-dictionary/introduction
for more information regarding the "
+ + "Tweet object model. \n\n"
+ + "Warning: the underlying Java SDK used is still in beta as of the
publishing of this processor feature.")
+@WritesAttribute(attribute = "mime.type", description = "Sets mime type to
application/json")
+public class ConsumeTwitter extends AbstractProcessor {
+
+ static final AllowableValue ENDPOINT_SAMPLE = new AllowableValue("Sample
Endpoint",
+ "Sample Endpoint",
+ "The endpoint that provides a stream of about 1% of tweets in
real-time");
+ static final AllowableValue ENDPOINT_SEARCH = new AllowableValue("Search
Endpoint",
+ "Search Endpoint",
+ "The endpoint that provides a stream of tweets that matches the
rules you added to the stream. " +
+ "If rules are not configured, then the stream will be
empty");
+
+ public static final PropertyDescriptor ENDPOINT = new
PropertyDescriptor.Builder()
+ .name("consume-twitter-endpoint")
+ .displayName("Twitter Endpoint")
+ .description("Specifies which endpoint tweets should be pulled
from. " +
+ "Usage of search endpoint requires that rules be uploaded
beforehand. See " +
+
"https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/";
+
+ "post-tweets-search-stream-rules")
+ .required(true)
+ .allowableValues(ENDPOINT_SAMPLE, ENDPOINT_SEARCH)
+ .defaultValue(ENDPOINT_SAMPLE.getValue())
+ .build();
+ public static final PropertyDescriptor BASE_PATH = new
PropertyDescriptor.Builder()
+ .name("base-path")
+ .displayName("Base Path")
+ .description("Specifies which base path the API client will use
for HTTP requests. " +
+ "Generally should not be changed from the default
https://api.twitter.com except for testing")
+ .required(true)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .defaultValue("https://api.twitter.com";)
+ .build();
+ public static final PropertyDescriptor BEARER_TOKEN = new
PropertyDescriptor.Builder()
+ .name("bearer-token")
+ .displayName("Bearer Token")
+ .description("The Bearer Token provided by Twitter.")
+ .required(true)
+ .sensitive(true)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor QUEUE_SIZE = new
PropertyDescriptor.Builder()
+ .name("queue-size")
+ .displayName("Queue Size")
+ .description("The size of the queue used to queue tweets")
+ .required(true)
+ .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR)
+ .defaultValue("10000")
+ .build();
+ public static final PropertyDescriptor BATCH_SIZE = new
PropertyDescriptor.Builder()
+ .name("batch-size")
+ .displayName("Batch Size")
+ .description("The maximum size of the number of tweets to be
written to a single FlowFile." +
+ "Will write less tweets if it there are not any tweets
left in queue")
+ .required(true)
+ .addValidator(StandardValidators.POSITIVE_INTEGER_VALIDATOR)
+ .defaultValue("10")
+ .build();
+ public static final PropertyDescriptor TWEET_FIELDS = new
PropertyDescriptor.Builder()
+ .name("tweet-fields")
+ .displayName("Tweet Fields")
+ .description("A comma-separated list of tweet fields to be
returned as part of the tweet. Refer to " +
+
"https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet
" +
+ "for proper usage. Possible field values are: " +
+ "attachments, author_id, context_annotations,
conversation_id, created_at, entities, geo, id, " +
+ "in_reply_to_user_id, lang, non_public_metrics,
organic_metrics, possibly_sensitive, promoted_metrics, " +
+ "public_metrics, referenced_tweets, reply_settings,
source, text, withheld")
+ .required(false)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .build();
+ public static final PropertyDescriptor USER_FIELDS = new
PropertyDescriptor.Builder()
+ .name("user-fields")
+ .displayName("User Fields")
+ .description("A comma-separated list of user fields to be returned
as part of the tweet. Refer to " +
+
"https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user
" +
+ "for proper usage. Possible field values are: " +
Review Comment:
Making the changes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
