add main methods and instructions on how to run to each Provider (STREAMS-411)


Project: http://git-wip-us.apache.org/repos/asf/incubator-streams/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams/commit/770a8cb1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams/tree/770a8cb1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams/diff/770a8cb1

Branch: refs/heads/master
Commit: 770a8cb16db77372d1d50895045472211db4cd40
Parents: a0fb193
Author: Steve Blackmon @steveblackmon <[email protected]>
Authored: Fri Oct 14 15:50:25 2016 -0500
Committer: Steve Blackmon @steveblackmon <[email protected]>
Committed: Fri Oct 14 15:50:25 2016 -0500

----------------------------------------------------------------------
 .../provider/GPlusUserActivityProvider.java     | 13 ++++++++++
 .../gplus/provider/GPlusUserDataProvider.java   | 13 ++++++++++
 .../google-gplus/src/site/markdown/index.md     | 25 +++++++++++++++++++-
 3 files changed, 50 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/770a8cb1/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserActivityProvider.java
----------------------------------------------------------------------
diff --git 
a/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserActivityProvider.java
 
b/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserActivityProvider.java
index 172c649..ab77973 100644
--- 
a/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserActivityProvider.java
+++ 
b/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserActivityProvider.java
@@ -42,7 +42,20 @@ import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.TimeUnit;
 
 /**
+ *  Retrieve recent activity from a list of accounts.
  *
+ *  To use from command line:
+ *
+ *  Supply (at least) the following required configuration in application.conf:
+ *
+ *  gplus.oauth.pathToP12KeyFile
+ *  gplus.oauth.serviceAccountEmailAddress
+ *  gplus.apiKey
+ *  gplus.googlePlusUsers
+ *
+ *  Launch using:
+ *
+ *  mvn exec:java 
-Dexec.mainClass=com.google.gplus.provider.GPlusUserActivityProvider 
-Dexec.args="application.conf activity.json"
  */
 public class GPlusUserActivityProvider extends AbstractGPlusProvider{
 

http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/770a8cb1/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserDataProvider.java
----------------------------------------------------------------------
diff --git 
a/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserDataProvider.java
 
b/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserDataProvider.java
index d31d764..1541818 100644
--- 
a/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserDataProvider.java
+++ 
b/streams-contrib/streams-provider-google/google-gplus/src/main/java/com/google/gplus/provider/GPlusUserDataProvider.java
@@ -46,7 +46,20 @@ import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.TimeUnit;
 
 /**
+ *  Retrieve current profile status for a list of accounts.
  *
+ *  To use from command line:
+ *
+ *  Supply (at least) the following required configuration in application.conf:
+ *
+ *  gplus.oauth.pathToP12KeyFile
+ *  gplus.oauth.serviceAccountEmailAddress
+ *  gplus.apiKey
+ *  gplus.googlePlusUsers
+ *
+ *  Launch using:
+ *
+ *  mvn exec:java 
-Dexec.mainClass=com.google.gplus.provider.GPlusUserDataProvider 
-Dexec.args="application.conf profiles.json"
  */
 public class GPlusUserDataProvider extends AbstractGPlusProvider{
 

http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/770a8cb1/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git 
a/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md
 
b/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md
index fb297e3..ec5bcee 100644
--- 
a/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md
+++ 
b/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md
@@ -1,4 +1,4 @@
-org.apache.streams:google-gmail
+org.apache.streams:google-gplus
 ===============================
 
 google-gplus contains providers, conversions, and utility classes for activity 
exchange with Google+
@@ -19,6 +19,29 @@ google-gplus contains providers, conversions, and utility 
classes for activity e
 | GPlusUserActivityProvider | 
[GPlusUserActivityProvider.html](apidocs/com/google/gplus/provider/GPlusUserActivityProvider.html
 "GPlusUserActivityProvider.html") |
 | GooglePlusTypeConverter | 
[GooglePlusTypeConverter.html](apidocs/com/google/gplus/processor/GooglePlusTypeConverter.html
 "GooglePlusTypeConverter.html") |
 
+Test:
+-----
+
+Log into admin console
+Create project
+Enable Data API on project
+Create service account
+Download p12 file
+
+Create a local file `gplus.conf` with valid gplus credentials
+
+    gplus {
+      apiKey = ""
+      oauth {
+        serviceAccountEmailAddress = ""
+        pathToP12KeyFile = ""
+      }
+    }
+    
+Build with integration testing enabled, using your credentials
+
+    mvn clean test verify -DskipITs=false 
-DargLine="-Dconfig.file=`pwd`/gplus.conf"
+    
 [JavaDocs](apidocs/index.html "JavaDocs")
 
 ###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0

Reply via email to