move all README.md into src/site/markdown, add example configurations, link to jsons, confs, and javadocs from module index.md
Project: http://git-wip-us.apache.org/repos/asf/incubator-streams/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams/commit/25f1ca14 Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams/tree/25f1ca14 Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams/diff/25f1ca14 Branch: refs/heads/STREAMS-389 Commit: 25f1ca1431026a57dfb5935edc655765f3b13fe2 Parents: c7490d3 Author: Steve Blackmon <sblack...@apache.org> Authored: Sun Mar 27 12:42:30 2016 -0500 Committer: Steve Blackmon <sblack...@apache.org> Committed: Sun Mar 27 12:42:30 2016 -0500 ---------------------------------------------------------------------- README.md | 45 +------------------- pom.xml | 26 +++++++++-- src/site/markdown/index.md | 39 +++++++++++++++++ src/site/site.xml | 16 +++++++ streams-components/pom.xml | 6 +-- .../google-gmail/src/main/resources/gmail.conf | 6 +++ .../google-gmail/src/site/markdown/index.md | 20 +++++++++ .../google-gplus/src/site/markdown/index.md | 21 +++++++++ .../streams-provider-instagram/README.md | 22 +++------- .../src/site/markdown/index.md | 18 ++++++++ .../streams-provider-rss/README.markdown | 17 -------- streams-contrib/streams-provider-rss/README.md | 8 ++++ .../src/site/markdown/index.md | 19 +++++++++ .../src/test/resources/rss.conf | 15 +++++++ .../streams-provider-sysomos/README.md | 23 +++------- .../src/main/resources/sysomos.conf | 10 +++++ .../src/site/markdown/index.md | 20 +++++++-- .../streams-provider-twitter/README.md | 42 +++--------------- .../jsonschema/com/twitter/UserstreamEvent.json | 1 + .../src/main/resources/followers.conf | 14 ++++++ .../src/main/resources/friends.conf | 14 ++++++ .../src/main/resources/sample.conf | 17 ++++++++ .../src/main/resources/userinfo.conf | 14 ++++++ .../src/main/resources/userstream.conf | 11 +++++ .../src/site/markdown/index.md | 31 ++++++++++---- .../src/site/resources/readme.txt | 1 + .../jsonschema/SparkRuntimeConfiguration.json | 27 ++++++++++++ 27 files changed, 353 insertions(+), 150 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 2798f93..51970dc 100644 --- a/README.md +++ b/README.md @@ -2,47 +2,4 @@ Apache Streams (incubating) Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 -------------------------------------------------------------------------------- -About -===== -Apache Streams is a lightweight (yet scalable) server for ActivityStreams. The role of Apache Streams is to provide a central point of aggregation, filtering and querying for Activities that have been submitted by disparate systems. Apache Streams also intends to include a mechanism for intelligent filtering and recommendation to reduce the noise to end users. - -Release Notes -============= - -[CHANGELOG.md](CHANGELOG.md "CHANGELOG.md") - -Getting Started -=============== - -Please visit the project website for the latest information: - http://streams.incubator.apache.org/ - -Check out the following repository for ready-to-run examples: - https://git-wip-us.apache.org/repos/asf/incubator-streams-examples.git - -Along with the developer mailing list archive: - http://mail-archives.apache.org/mod_mbox/streams-dev/ - -Auto-generated documentation and resources are located here: - http://streams.incubator.apache.org/site/0.2-incubating/streams-project/ - -System Requirements -=================== -You need a platform that supports Java SE 7 or later. - - - Sources compilation require Java SE 7 or higher. - - - Streams currently requires Java 1.7.0u72+, or Java 1.8.0u25+ during build phase. - - - The project is built with Apache Maven 3+ (suggested is 3.2.5). - -Building -==================== -To build from source code: - - - Invoke maven in the root directory. - - `export MAVEN_OPTS="-Xmx2G"` - - `mvn install` - +[README.md](src/site/index.md "README") http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 74e5cf4..3290bf3 100644 --- a/pom.xml +++ b/pom.xml @@ -32,7 +32,7 @@ <name>Apache Streams Project</name> <description>Apache Streams Project</description> - <url>http://streams.incubator.apache.org/${project.version}/${project.artifactId}</url> + <url>http://streams.incubator.apache.org/site/${project.version}/${project.artifactId}</url> <licenses> <license> @@ -172,7 +172,7 @@ <module>streams-contrib</module> <module>streams-components</module> <module>streams-monitoring</module> - <module>streams-osgi-components</module> + <!--<module>streams-osgi-components</module>--> <module>streams-pojo</module> <module>streams-pojo-extensions</module> <module>streams-runtimes</module> @@ -222,13 +222,31 @@ <reporting> <plugins> <plugin> + <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-project-info-reports-plugin</artifactId> + <version>${reports.plugin.version}</version> + <configuration> + <dependencyLocationsEnabled>false</dependencyLocationsEnabled> + </configuration> + <reportSets> + <reportSet> + <inherited>false</inherited> + <reports> + <report>index</report> + <report>modules</report> + </reports> + </reportSet> + </reportSets> </plugin> <plugin> - <artifactId>maven-javadoc-plugin</artifactId> + <artifactId>maven-site-plugin</artifactId> + <version>${site.plugin.version}</version> + <configuration> + <topSiteURL>scm:svn:https://svn.apache.org/repos/infra/websites/production/streams/content/site/${project.version}/${project.artifactId}</topSiteURL> + </configuration> </plugin> <plugin> - <artifactId>maven-site-plugin</artifactId> + <artifactId>maven-javadoc-plugin</artifactId> </plugin> </plugins> </reporting> http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md new file mode 100644 index 0000000..7dc4e4f --- /dev/null +++ b/src/site/markdown/index.md @@ -0,0 +1,39 @@ +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- + +# org.apache.streams:streams-project + +Release Notes +============= + +[CHANGELOG.md](CHANGELOG.md "CHANGELOG.md") + +System Requirements +=================== +You need a platform that supports Java SE 7 or later. + + - Sources compilation require Java SE 7 or higher. + + - Streams currently requires Java 1.7.0u72+, or Java 1.8.0u25+ during build phase. + + - The project is built with Apache Maven 3+ (suggested is 3.2.5). + +Building +==================== +To build from source code: + + - Invoke maven in the root directory. + + `export MAVEN_OPTS="-Xmx2G"` + + `mvn install` + +Additional Documentation +======================== + +[Modules](modules.md "Modules") + +[JavaDocs](apidocs/index.html "JavaDocs") + +[TestJavaDocs](testapidocs/index.html "TestJavaDocs") http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index fef0628..08ab14c 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -24,6 +24,22 @@ <version>1.3.0</version> </skin> <body> + <menu ref="parent" inherit="top"/> <menu ref="reports"/> </body> + <custom> + <fluidoSkin> + <gitHub> + <projectId>apache/incubator-streams</projectId> + <ribbonOrientation>right</ribbonOrientation> + <ribbonColor>black</ribbonColor> + </gitHub> + <googleSearch/> + <twitter> + <user>steveblackmon</user> + <showUser>true</showUser> + <showFollowers>true</showFollowers> + </twitter> + </fluidoSkin> + </custom> </project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-components/pom.xml ---------------------------------------------------------------------- diff --git a/streams-components/pom.xml b/streams-components/pom.xml index 7186dc1..421dc6f 100644 --- a/streams-components/pom.xml +++ b/streams-components/pom.xml @@ -28,11 +28,9 @@ <artifactId>streams-components</artifactId> <packaging>pom</packaging> - <name>streams-components</name> - - <properties> - </properties> + <name>streams-components</name> + <description>Functional components to embed in streams, or extend to customize behavior.</description> <modules> <module>streams-converters</module> http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-google/google-gmail/src/main/resources/gmail.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-google/google-gmail/src/main/resources/gmail.conf b/streams-contrib/streams-provider-google/google-gmail/src/main/resources/gmail.conf new file mode 100644 index 0000000..e99e964 --- /dev/null +++ b/streams-contrib/streams-provider-google/google-gmail/src/main/resources/gmail.conf @@ -0,0 +1,6 @@ +# Apache Streams (incubating) +# Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +gmail { + username = "" + password = "" +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md b/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md new file mode 100644 index 0000000..cd68c94 --- /dev/null +++ b/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md @@ -0,0 +1,20 @@ +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- + +org.apache.streams:google-gmail +=============================== + +google-gmail contains providers, conversions, and utility classes for activity exchange with gmail.com + +## Configuration + +| Schema | JavaDoc | Example Configuration(s) | +|--------|---------|--------------------------| +| [GMailConfiguration.json](com/google/gmail/GMailConfiguration.json "GMailConfiguration.json") | [GMailConfiguration.html](apidocs/com/google/gmail/GMailConfiguration.html "GMailConfiguration.html") | [gmail.conf](gmail.conf "gmail.conf") | + +## Components + +| Class | Class JavaDoc | +|-------|---------------| +| GMailProvider | [GMailProvider.html](apidocs/com/google/gmail/provider/GMailProvider.html "GMailProvider.html") | [TwitterUserInformationConfiguration.json](com/twitter/TwitterUserInformationConfiguration.json "TwitterUserInformationConfiguration.json") | \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/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 new file mode 100644 index 0000000..e5272b3 --- /dev/null +++ b/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md @@ -0,0 +1,21 @@ +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- + +org.apache.streams:google-gmail +=============================== + +google-gplus contains providers, conversions, and utility classes for activity exchange with Google+ + +## Configuration + +| Schema | JavaDoc | Example Configuration(s) | +|--------|---------|--------------------------| +| [GPlusConfiguration.json](com/google/gplus/GPlusConfiguration.json "GPlusConfiguration.json") | [GPlusConfiguration.html](apidocs/com/google/gplus/GPlusConfiguration.html "GPlusConfiguration.html") | [reference.conf](reference.conf "reference.conf") | + +## Components + +| Class | Class JavaDoc | +|-------|---------------| +| GPlusUserDataProvider | [GPlusUserDataProvider.html](apidocs/com/google/gplus/provider/GPlusUserDataProvider.html "GPlusUserDataProvider.html") | +| GPlusUserActivityProvider | [GPlusUserActivityProvider.html](apidocs/com/google/gplus/provider/GPlusUserActivityProvider.html "GPlusUserActivityProvider.html") | http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-instagram/README.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-instagram/README.md b/streams-contrib/streams-provider-instagram/README.md index 95de3f3..3432b54 100644 --- a/streams-contrib/streams-provider-instagram/README.md +++ b/streams-contrib/streams-provider-instagram/README.md @@ -1,18 +1,8 @@ -streams-provider-instagram -========================== +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- -Purpose +org.apache.streams:streams-provider-instagram +============================================= - Module connects to instagram API, collects events, converts to activity, and passes each activity downstream. - -Example configuration - - "instagram": { - "version": "v1", - "endpoint": "media/recent", - "accessToken": "", - "info": [ - "3", - "kevin" - ] - } \ No newline at end of file +[README.md](src/site/index.md "README") http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-instagram/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-instagram/src/site/markdown/index.md b/streams-contrib/streams-provider-instagram/src/site/markdown/index.md new file mode 100644 index 0000000..95de3f3 --- /dev/null +++ b/streams-contrib/streams-provider-instagram/src/site/markdown/index.md @@ -0,0 +1,18 @@ +streams-provider-instagram +========================== + +Purpose + + Module connects to instagram API, collects events, converts to activity, and passes each activity downstream. + +Example configuration + + "instagram": { + "version": "v1", + "endpoint": "media/recent", + "accessToken": "", + "info": [ + "3", + "kevin" + ] + } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-rss/README.markdown ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-rss/README.markdown b/streams-contrib/streams-provider-rss/README.markdown deleted file mode 100644 index 7199fe9..0000000 --- a/streams-contrib/streams-provider-rss/README.markdown +++ /dev/null @@ -1,17 +0,0 @@ -streams-provider-rss -==================== - -Purpose - - Module connects to rss feeds, collects events, and passes each message downstream once. - -Capabilities - - Simplification - - Optionally, module can output messages as basic text - - Normalization - - Optionally, module can output messages as other json objects such as Activity - http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-rss/README.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-rss/README.md b/streams-contrib/streams-provider-rss/README.md new file mode 100644 index 0000000..e2ed2b2 --- /dev/null +++ b/streams-contrib/streams-provider-rss/README.md @@ -0,0 +1,8 @@ +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- + +org.apache.streams:streams-provider-rss +======================================= + +[README.md](src/site/index.md "README") http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-rss/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-rss/src/site/markdown/index.md b/streams-contrib/streams-provider-rss/src/site/markdown/index.md new file mode 100644 index 0000000..c7d221f --- /dev/null +++ b/streams-contrib/streams-provider-rss/src/site/markdown/index.md @@ -0,0 +1,19 @@ +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- + +streams-provider-rss +==================== + +## Data Types + +| Schema | +|--------| +| [contents.xsd](contents.xsd "contents.xsd") [contents.xsd.html](apidocs/org/apache/streams/rss/FeedDetails.html "javadoc") | + +## Components + +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| RssStreamProvider [RssStreamProvider.html](apidocs/org/apache/streams/rss/provider/RssStreamProvider.html "javadoc") | [RssStreamConfiguration.json](RssStreamConfiguration.json "RssStreamConfiguration.json") [RssStreamConfiguration.html](apidocs/org/apache/streams/rss/RssStreamConfiguration.html "javadoc") | [rss.conf](rss.conf "rss.conf") | + http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-rss/src/test/resources/rss.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-rss/src/test/resources/rss.conf b/streams-contrib/streams-provider-rss/src/test/resources/rss.conf new file mode 100644 index 0000000..06851b9 --- /dev/null +++ b/streams-contrib/streams-provider-rss/src/test/resources/rss.conf @@ -0,0 +1,15 @@ +feeds = [ + { + url = "http://feeds.feedburner.com/Techcrunch"; + pollIntervalMillis = 300000 + }, + { + url = "http://rss.slashdot.org/Slashdot/slashdot"; + pollIntervalMillis = 240000 + + }, + { + url = "http://www.engadget.com/rss.xml"; + pollIntervalMillis = 60000 + } +] http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-sysomos/README.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-sysomos/README.md b/streams-contrib/streams-provider-sysomos/README.md index 9b25f55..9697590 100644 --- a/streams-contrib/streams-provider-sysomos/README.md +++ b/streams-contrib/streams-provider-sysomos/README.md @@ -1,19 +1,8 @@ -streams-provider-sysomos -========================== +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- -Purpose +org.apache.streams:streams-provider-sysomos +=========================================== - Module connects to sysomos API, collects events, converts to activity, and passes each activity downstream. - -Example configuration - - sysomos { - heartbeatIds = [ - HBID - ] - apiBatchSize = 500 - apiKey = KEY - minDelayMs = 10000 - scheduledDelayMs = 120000 - maxBatchSize = 10000 - } \ No newline at end of file +[README.md](src/site/index.md "README") http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-sysomos/src/main/resources/sysomos.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-sysomos/src/main/resources/sysomos.conf b/streams-contrib/streams-provider-sysomos/src/main/resources/sysomos.conf new file mode 100644 index 0000000..3ee1b4e --- /dev/null +++ b/streams-contrib/streams-provider-sysomos/src/main/resources/sysomos.conf @@ -0,0 +1,10 @@ +sysomos { + heartbeatIds = [ + HBID + ] + apiBatchSize = 500 + apiKey = KEY + minDelayMs = 10000 + scheduledDelayMs = 120000 + maxBatchSize = 10000 +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md b/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md index 4005717..b25b546 100644 --- a/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md @@ -7,9 +7,23 @@ streams-provider-sysomos streams-provider-sysomos contains schema definitions, providers, conversions, and utility classes. -##Schemas +## Data Types -[Sysomos.json](com/sysomos/Sysomos.json "Sysomos.json") +| Schema | +|--------| +| [Sysomos.json](com/sysomos/Sysomos.json "Sysomos.json") [Sysomos.json.html](apidocs/com/sysomos/Sysomos.html "javadoc") | +| [Sysomos.xsd](com/sysomos/sysomos.xsd "Sysomos.xsd") [Sysomos.xsd.html](apidocs/com/sysomos/BeatApi.html "javadoc") | + +## Configuration + +| Schema | +|--------| +| [SysomosConfiguration.json](com/sysomos/SysomosConfiguration.json "SysomosConfiguration.json") [SysomosConfiguration.html](apidocs/com/sysomos/SysomosConfiguration.html "javadoc") | + +## Components + +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| SysomosProvider [SysomosProvider.html](apidocs/org/apache/streams/sysomos/SysomosProvider.html "javadoc") | [SysomosConfiguration.json](com/sysomos/SysomosConfiguration.json "SysomosConfiguration.json") [SysomosConfiguration.html](apidocs/com/sysomos/SysomosConfiguration.html "javadoc") | [sysomos.conf](sysomos.conf "sysomos.conf") | -[Sysomos.xsd](com/sysomos/sysomos.xsd "Sysomos.xsd") http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-twitter/README.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/README.md b/streams-contrib/streams-provider-twitter/README.md index 0e44ea3..bbb93da 100644 --- a/streams-contrib/streams-provider-twitter/README.md +++ b/streams-contrib/streams-provider-twitter/README.md @@ -1,38 +1,8 @@ -streams-provider-twitter -===================== +Apache Streams (incubating) +Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +-------------------------------------------------------------------------------- -Connects to the twitter streaming API, collects events, and passes each message downstream. +org.apache.streams:streams-provider-twitter +=========================================== -Example userstream configuration: - - "twitter": { - â â host = "api.twitter.com" - â â endpoint = "userstream" - â â oauth { - consumerKey = "" - consumerSecret = "" - accessToken = "" - accessTokenSecret = "" - } - } - -Example gardenhose configuration: - - "twitter": { - â â host = "api.twitter.com" - â â endpoint = "sample" - â â oauth { - consumerKey = "" - consumerSecret = "" - accessToken = "" - accessTokenSecret = "" - } - track [ - apache - ] - follow [ - TheASF - ] - - } - +[README.md](src/site/index.md "README") http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-twitter/src/main/jsonschema/com/twitter/UserstreamEvent.json ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/src/main/jsonschema/com/twitter/UserstreamEvent.json b/streams-contrib/streams-provider-twitter/src/main/jsonschema/com/twitter/UserstreamEvent.json index 1fa6df7..23f8365 100644 --- a/streams-contrib/streams-provider-twitter/src/main/jsonschema/com/twitter/UserstreamEvent.json +++ b/streams-contrib/streams-provider-twitter/src/main/jsonschema/com/twitter/UserstreamEvent.json @@ -7,6 +7,7 @@ "type": "object", "javaType" : "org.apache.streams.twitter.pojo.UserstreamEvent", "javaInterfaces": ["java.io.Serializable"], + "description": "", "properties": { "created_at": { "type": "string", http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-twitter/src/main/resources/followers.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/src/main/resources/followers.conf b/streams-contrib/streams-provider-twitter/src/main/resources/followers.conf new file mode 100644 index 0000000..6ca5376 --- /dev/null +++ b/streams-contrib/streams-provider-twitter/src/main/resources/followers.conf @@ -0,0 +1,14 @@ +# Apache Streams (incubating) +# Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +twitter { + endpoint = followers + oauth { + consumerKey = "" + consumerSecret = "" + accessToken = "" + accessTokenSecret = "" + } + info = [ + TheASF + ] +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-twitter/src/main/resources/friends.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/src/main/resources/friends.conf b/streams-contrib/streams-provider-twitter/src/main/resources/friends.conf new file mode 100644 index 0000000..cc638d7 --- /dev/null +++ b/streams-contrib/streams-provider-twitter/src/main/resources/friends.conf @@ -0,0 +1,14 @@ +# Apache Streams (incubating) +# Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +twitter { + endpoint = friends + oauth { + consumerKey = "" + consumerSecret = "" + accessToken = "" + accessTokenSecret = "" + } + info = [ + TheASF + ] +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-twitter/src/main/resources/sample.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/src/main/resources/sample.conf b/streams-contrib/streams-provider-twitter/src/main/resources/sample.conf new file mode 100644 index 0000000..a6e6588 --- /dev/null +++ b/streams-contrib/streams-provider-twitter/src/main/resources/sample.conf @@ -0,0 +1,17 @@ +# Apache Streams (incubating) +# Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +twitter { + endpoint = sample + oauth { + consumerKey = "" + consumerSecret = "" + accessToken = "" + accessTokenSecret = "" + } + track = [ + apache + ] + follow = [ + TheASF + ] +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-twitter/src/main/resources/userinfo.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/src/main/resources/userinfo.conf b/streams-contrib/streams-provider-twitter/src/main/resources/userinfo.conf new file mode 100644 index 0000000..74197c1 --- /dev/null +++ b/streams-contrib/streams-provider-twitter/src/main/resources/userinfo.conf @@ -0,0 +1,14 @@ +# Apache Streams (incubating) +# Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +twitter { + endpoint = userstream + oauth { + consumerKey = "" + consumerSecret = "" + accessToken = "" + accessTokenSecret = "" + } + info = [ + TheASF + ] +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-twitter/src/main/resources/userstream.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/src/main/resources/userstream.conf b/streams-contrib/streams-provider-twitter/src/main/resources/userstream.conf new file mode 100644 index 0000000..1fb19ef --- /dev/null +++ b/streams-contrib/streams-provider-twitter/src/main/resources/userstream.conf @@ -0,0 +1,11 @@ +# Apache Streams (incubating) +# Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 +twitter { + endpoint = userstream + oauth { + consumerKey = "" + consumerSecret = "" + accessToken = "" + accessTokenSecret = "" + } +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-contrib/streams-provider-twitter/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/src/site/markdown/index.md b/streams-contrib/streams-provider-twitter/src/site/markdown/index.md index ddc7df1..b55fc9c 100644 --- a/streams-contrib/streams-provider-twitter/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-twitter/src/site/markdown/index.md @@ -2,21 +2,34 @@ Apache Streams (incubating) Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 -------------------------------------------------------------------------------- -streams-provider-twitter -============== +org.apache.streams:streams-provider-twitter +=========================================== streams-provider-twitter contains schema definitions, providers, conversions, and utility classes. -##Schemas +## Data Types -[Tweet.json](com/twitter/tweet.json "Tweet.json") +| Schema | +|--------| +| [Tweet.json](com/twitter/tweet.json "Tweet.json") [Tweet.html](apidocs/org/apache/streams/twitter/pojo/Tweet.html "javadoc") | +| [Retweet.json](com/twitter/Retweet.json "Retweet.json") [Retweet.html](apidocs/org/apache/streams/twitter/pojo/Retweet.html "javadoc") | +| [User.json](com/twitter/User.json "User.json") [User.html](apidocs/org/apache/streams/twitter/pojo/User.html "javadoc") | +| [Delete.json](com/twitter/Delete.json "Delete.json") [Delete.html](apidocs/org/apache/streams/twitter/pojo/Delete.html "javadoc") | +| [UserstreamEvent.json](com/twitter/UserstreamEvent.json "UserstreamEvent.json") [UserstreamEvent.html](apidocs/org/apache/streams/twitter/pojo/UserstreamEvent.html "javadoc") | +| [FriendList.json](com/twitter/FriendList.json "FriendList.json") [FriendList.html](apidocs/org/apache/streams/twitter/pojo/FriendList.html "javadoc") | -[Retweet.json](com/twitter/Retweet.json "Retweet.json") +## Configuration -[User.json](com/twitter/User.json "User.json") +| Schema | +|--------| +| [TwitterConfiguration.json](com/twitter/tweet.json "TwitterConfiguration.json") [TwitterConfiguration.html](apidocs/org/apache/streams/twitter/TwitterConfiguration.html "javadoc") | -[Delete.json](com/twitter/Delete.json "Delete.json") - -[UserstreamEvent.json](com/twitter/UserstreamEvent.json "UserstreamEvent.json") +## Components +| Class | Configuration | Example Configuration(s) | +|-------|---------------|--------------------------| +| TwitterUserInformationProvider [TwitterUserInformationProvider.html](apidocs/org/apache/streams/twitter/TwitterUserInformationConfiguration.html "javadoc") | [TwitterUserInformationConfiguration.json](com/twitter/TwitterUserInformationConfiguration.json "TwitterUserInformationConfiguration.json") [TwitterUserInformationConfiguration.html](apidocs/org/apache/streams/twitter/pojo/TwitterUserInformationConfiguration.html "javadoc") | [userinfo.conf](userinfo.conf "userinfo.conf") | +| TwitterTimelineProvider [TwitterTimelineProvider.html](apidocs/org/apache/streams/twitter/TwitterTimelineConfiguration.html "javadoc") | [TwitterUserInformationConfiguration.json](com/twitter/TwitterUserInformationConfiguration.json "TwitterUserInformationConfiguration.json") [TwitterUserInformationConfiguration.html](apidocs/org/apache/streams/twitter/pojo/TwitterUserInformationConfiguration.html "javadoc") | [userinfo.conf](userinfo.conf "userinfo.conf") | +| TwitterStreamProvider [TwitterStreamProvider.html](apidocs/org/apache/streams/twitter/TwitterStreamProvider.html "javadoc") | [TwitterStreamConfiguration.json](com/twitter/TwitterStreamConfiguration.json "TwitterStreamConfiguration.json") [TwitterUserInformationConfiguration.html](apidocs/org/apache/streams/twitter/pojo/TwitterStreamConfiguration.html "javadoc") | [sample.conf](sample.conf "sample.conf")<br/>[userstream.conf](userstream.conf "userstream.conf") | +| TwitterFollowingProvider [TwitterFollowingProvider.html](apidocs/org/apache/streams/twitter/TwitterFollowingConfiguration.html "javadoc") | [TwitterFollowingConfiguration.json](com/twitter/TwitterFollowingConfiguration.json "TwitterFollowingConfiguration.json") [TwitterFollowingConfiguration.html](apidocs/org/apache/streams/twitter/pojo/TwitterFollowingConfiguration.html "javadoc") | [friends.conf](friends.conf "friends.conf")<br/>[followers.conf](followers.conf "followers.conf") | http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-osgi-components/activity-subscriber/src/site/resources/readme.txt ---------------------------------------------------------------------- diff --git a/streams-osgi-components/activity-subscriber/src/site/resources/readme.txt b/streams-osgi-components/activity-subscriber/src/site/resources/readme.txt new file mode 100644 index 0000000..5774586 --- /dev/null +++ b/streams-osgi-components/activity-subscriber/src/site/resources/readme.txt @@ -0,0 +1 @@ +Bundle resources go here http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/25f1ca14/streams-runtimes/streams-runtime-spark/src/main/jsonschema/SparkRuntimeConfiguration.json ---------------------------------------------------------------------- diff --git a/streams-runtimes/streams-runtime-spark/src/main/jsonschema/SparkRuntimeConfiguration.json b/streams-runtimes/streams-runtime-spark/src/main/jsonschema/SparkRuntimeConfiguration.json new file mode 100644 index 0000000..5a9cf69 --- /dev/null +++ b/streams-runtimes/streams-runtime-spark/src/main/jsonschema/SparkRuntimeConfiguration.json @@ -0,0 +1,27 @@ +{ + "$schema": "http://json-schema.org/draft-03/schema";, + "$license": [ + "http://www.apache.org/licenses/LICENSE-2.0"; + ], + "type": "object", + "javaType" : "org.apache.streams.spark.SparkRuntimeConfiguration", + "extends": { + "$ref": "../../../../../streams-config/src/main/jsonschema/StreamsConfiguration.json" + }, + "javaInterfaces": ["java.io.Serializable"], + "properties": { + "inputPath": { + "type": "string", + "description": "Input Path" + }, + "outputPath": { + "type": "string", + "description": "Output Path" + }, + "outputPartitions": { + "type": "integer", + "description": "Partitions", + "default": 0 + } + } +} \ No newline at end of file
