├── .gitignore
├── LICENCE
├── README.md
├── config.sample.json
├── index.html
├── package.json
├── screenshot.png
├── stream-geo.js
├── stream-hashtags.js
└── stream-sample.js


/.gitignore:
--------------------------------------------------------------------------------
 1 | # Logs
 2 | logs
 3 | *.log
 4 | 
 5 | # Runtime data
 6 | pids
 7 | *.pid
 8 | *.seed
 9 | 
10 | # Directory for instrumented libs generated by jscoverage/JSCover
11 | lib-cov
12 | 
13 | # Coverage directory used by tools like istanbul
14 | coverage
15 | 
16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
17 | .grunt
18 | 
19 | # Compiled binary addons (http://nodejs.org/api/addons.html)
20 | build/Release
21 | 
22 | # Dependency directory
23 | # Deployed apps should consider commenting this line out:
24 | # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
25 | node_modules
26 | 
27 | # Config files
28 | config.json
29 | 
30 | #DS_Store files
31 | .DS_Store
32 | 
33 | .sass-cache
34 | 
35 | npm-debug.log
36 | 
37 | manifest.yml
38 | 


--------------------------------------------------------------------------------
/LICENCE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2014 Twitter Inc.
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | twitter-streaming-demos-node
 2 | ==========
 3 | 
 4 | Basic demos demonstrating Twitter streaming APIs.
 5 | 
 6 | 
 7 | Installing and Running
 8 | ----
 9 | 
10 | Install [Node.js](http://nodejs.org/).
11 | 
12 | Clone GitHub repo:
13 | 
14 | ```
15 | git clone https://github.com/twitterdev/twitter-streaming-demos-node
16 | ```
17 | 
18 | Create a [Twitter application](https://apps.twitter.com).
19 | 
20 | Create a `config.json` file using `config.sample.json` as a template. Fill in your Twitter App API keys.
21 | 
22 | 
23 | Install node module dependencies:
24 | 
25 | ```
26 | npm install
27 | ```
28 | 
29 | Run 1% sample demo:
30 | 
31 | ```
32 | node stream-sample.js
33 | ```
34 | Run trending #hashtag demo:
35 | 
36 | ```
37 | node stream-hashtags.js
38 | ```
39 | Run geo demo:
40 | 
41 | ```
42 | node stream-geo.js
43 | ```
44 | Run client-side streaming demo:
45 | 
46 | ```
47 | Run index.html in a web server environment
48 | ```
49 | Resources
50 | ----
51 | - [Twitter API statuses/sample stream](https://dev.twitter.com/streaming/reference/get/statuses/sample)
52 | - [Twitter API statuses/filter stream](https://dev.twitter.com/streaming/reference/post/statuses/filter)
53 | - [Twitter REST API Rate Limiting](https://dev.twitter.com/rest/public/rate-limiting)
54 | - [PubNub Twitter Stream](http://www.pubnub.com/developers/data-streams/twitter-stream)


--------------------------------------------------------------------------------
/config.sample.json:
--------------------------------------------------------------------------------
1 | {
2 | 	"TWITTER_CONSUMER_KEY": "",
3 | 	"TWITTER_CONSUMER_SECRET": "",
4 | 	"TWITTER_ACCESS_TOKEN": "",
5 | 	"TWITTER_ACCESS_TOKEN_SECRET": ""
6 | }


--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en" ng-app="VideoTweetStream">
 3 |   <head>
 4 |     <meta charset="utf-8">
 5 |     <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
 6 | 
 7 |     <title>PubNub Twitter Stream Demo</title>
 8 | 
 9 |     <link rel='stylesheet' href='https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.2/css/bootstrap.min.css' />
10 | 
11 |     <script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
12 |     <script src="//cdnjs.cloudflare.com/ajax/libs/handlebars.js/3.0.0/handlebars.min.js"></script>
13 |     <script src="//cdnjs.cloudflare.com/ajax/libs/pubnub/3.6.3/pubnub.min.js"></script>
14 |     <script src="//cdnjs.cloudflare.com/ajax/libs/jquery.imagesloaded/3.1.8/imagesloaded.pkgd.min.js"></script>
15 | 
16 |     <script>
17 | 
18 | 			var pubnub = PUBNUB.init({
19 | 				subscribe_key: 'sub-c-78806dd4-42a6-11e4-aed8-02ee2ddab7fe'
20 | 			});
21 | 
22 | 			pubnub.subscribe({
23 | 				channel : 'pubnub-twitter',
24 | 				message : function(tweet){
25 | 
26 | 					$('#tweet-list').prepend('<li class="list-group-item">' + tweet.text + '</li>');
27 | 
28 | 					if($('#tweet-list li').length > 10) {
29 | 						$('#tweet-list li').last().remove();
30 | 					}
31 | 				}
32 | 			});
33 | 
34 |     </script>
35 | 
36 |   </head>
37 |   <body role="document">
38 | 
39 |     <div class="container" role="main" style="margin-top: 20px;">
40 |     	<div class="panel panel-primary">
41 | 			  <div class="panel-heading">PubNub Twitter Stream Demo</div>
42 | 			  <div class="panel-body">
43 | 			  	<p>
44 | 			  	This is a client-side only application.
45 | 			  	It consumes a <a href="https://dev.twitter.com/streaming/reference/post/statuses/filter" target="_blank">statuses/filter</a>
46 | 			  	that is hosted by <a href="http://www.pubnub.com/developers/data-streams/twitter-stream" target="_blank">PubNub</a>.
47 | 			  	</p>
48 | 
49 | 			  	<p>To setup your own hosted Twitter stream see this <a href="https://gist.github.com/stephenlb/36aef15a165d5bad0d82" target="_blank">gist</a>.
50 | 
51 | 			  </div>
52 | 			  <ul id="tweet-list" class="list-group">
53 | 			    <li class="list-group-item">Waiting for Tweets . . .</li>
54 | 			  </ul>
55 | 			</div>
56 |     </div>
57 | 
58 |   </body>
59 | </html>
60 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "TwitterStreamingDemo",
 3 |   "version": "0.0.0",
 4 |   "description": "Basic demos using the Twitter streaming APIs",
 5 |   "main": "stream-sample.js",
 6 |   "dependencies": {
 7 |     "lodash": "^3.3.1",
 8 |     "nconf": "^0.7.1",
 9 |     "twit": "^1.1.20"
10 |   },
11 |   "devDependencies": {},
12 |   "scripts": {
13 |     "test": "echo \"Error: no test specified\" && exit 1"
14 |   },
15 |   "author": "@joncipriano",
16 |   "license": "MIT"
17 | }
18 | 


--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xdevplatform/streaming-demos-node/64a3c7cc742d0d29a8e06121c55fd043eca5ff8a/screenshot.png


--------------------------------------------------------------------------------
/stream-geo.js:
--------------------------------------------------------------------------------
 1 | var nconf = require('nconf');
 2 | var Twit = require('twit');
 3 | var _ = require('lodash');
 4 | 
 5 | nconf.file({ file: 'config.json' }).env();
 6 | 
 7 | var twitter = new Twit({
 8 |   consumer_key: nconf.get('TWITTER_CONSUMER_KEY'),
 9 |   consumer_secret: nconf.get('TWITTER_CONSUMER_SECRET'),
10 |   access_token: nconf.get('TWITTER_ACCESS_TOKEN'),
11 |   access_token_secret: nconf.get('TWITTER_ACCESS_TOKEN_SECRET')
12 | });
13 | 
14 | var locations = {
15 | 	sf: '-122.75,36.8,-121.75,37.8',
16 | 	nyc: '-74,40,-73,41',
17 | 	all: '-180,-90,180,90'
18 | }
19 | 
20 | // attach to filter stream
21 | var tweetStream = twitter.stream('statuses/filter', { locations: locations.sf });
22 | 
23 | // on tweet
24 | tweetStream.on('tweet', function (tweet) {
25 | 
26 |   // check that tweet has geo
27 |   if (tweet.geo) {
28 |     console.log(tweet.geo.coordinates);
29 |   }
30 | 
31 | });
32 | 
33 | 
34 | 


--------------------------------------------------------------------------------
/stream-hashtags.js:
--------------------------------------------------------------------------------
 1 | var nconf = require('nconf');
 2 | var Twit = require('twit');
 3 | var _ = require('lodash');
 4 | 
 5 | nconf.file({ file: 'config.json' }).env();
 6 | 
 7 | var twitter = new Twit({
 8 |   consumer_key: nconf.get('TWITTER_CONSUMER_KEY'),
 9 |   consumer_secret: nconf.get('TWITTER_CONSUMER_SECRET'),
10 |   access_token: nconf.get('TWITTER_ACCESS_TOKEN'),
11 |   access_token_secret: nconf.get('TWITTER_ACCESS_TOKEN_SECRET')
12 | });
13 | 
14 | // get list of trends for a place
15 | twitter.get('trends/place', { id: 1 }, function (err, data, resp) {
16 | 
17 |   // get reference to all trend objects
18 |   var trends = data[0].trends;
19 | 
20 |   // get all trend names
21 |   var trendNames = _.map(trends, function (trend) {
22 |     return trend.name.toLowerCase();
23 |   });
24 | 
25 |   console.log(trendNames);
26 | 
27 |   // attach to stream using trends as track parameters
28 |   var tweetStream = twitter.stream('statuses/filter', { track: trendNames.join(',') });
29 |   
30 |   // on tweet
31 |   tweetStream.on('tweet', function (tweet) {
32 | 
33 |     // loop through all hashtags
34 |     _.each(tweet.entities.hashtags, function (hashtag) {
35 | 
36 |       // is hashtag trending
37 |       var hashStr = '#' + hashtag.text.toLowerCase();
38 |       if (trendNames.indexOf(hashStr) > -1) {
39 |         console.log(hashStr);
40 |       }
41 | 
42 |     });
43 | 
44 |   });
45 | 
46 | });
47 | 
48 | /*
49 | // get all places with available trends
50 | twitter.get('trends/available', function (err, data, resp) {
51 | 
52 |   // log out countries only
53 |   _.each(data, function (place) {
54 |     if (place.placeType.name == 'Country') {
55 |       console.log(place.name, place.woeid);
56 |     };
57 |   });
58 | 
59 | });
60 | */
61 | 
62 | 


--------------------------------------------------------------------------------
/stream-sample.js:
--------------------------------------------------------------------------------
 1 | var nconf = require('nconf');
 2 | var Twit = require('twit');
 3 | var _ = require('lodash');
 4 | 
 5 | nconf.file({ file: 'config.json' }).env();
 6 | 
 7 | var twitter = new Twit({
 8 |   consumer_key: nconf.get('TWITTER_CONSUMER_KEY'),
 9 |   consumer_secret: nconf.get('TWITTER_CONSUMER_SECRET'),
10 |   access_token: nconf.get('TWITTER_ACCESS_TOKEN'),
11 |   access_token_secret: nconf.get('TWITTER_ACCESS_TOKEN_SECRET')
12 | });
13 | 
14 | // attach to filter stream
15 | var tweetStream = twitter.stream('statuses/sample');
16 | 
17 | // on tweet
18 | tweetStream.on('tweet', function (tweet) {
19 |   console.log('---');
20 |   console.log('screen_name:', tweet.user.screen_name);
21 |   console.log('text:', tweet.text);
22 | });
23 | 
24 | 
25 | 


--------------------------------------------------------------------------------