├── .gitignore ├── index.js ├── .npmignore ├── twitter_config ├── test └── spec │ ├── properties.json │ └── TwitterITSpec.js ├── package.json ├── twitter.txt ├── Makefile ├── README.md ├── lib └── Twitter.js └── LICENCE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | module.exports = require('./lib/Twitter'); 2 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | target 2 | reports 3 | test 4 | .idea 5 | .git 6 | .npmignore 7 | Makefile 8 | twitter.txt 9 | *.iml 10 | *.ipr 11 | -------------------------------------------------------------------------------- /twitter_config: -------------------------------------------------------------------------------- 1 | { 2 | "consumerKey": "XXX", 3 | "consumerSecret": "XXX", 4 | "accessToken": "XXX", 5 | "accessTokenSecret": "XXX", 6 | "callBackUrl": "XXX" 7 | } -------------------------------------------------------------------------------- /test/spec/properties.json: -------------------------------------------------------------------------------- 1 | { 2 | "consumerKey": "{consumerKey}", 3 | "consumerSecret": "{consumerSecret}", 4 | "accessToken": "{accessToken}", 5 | "accessTokenSecret": "{accessTokenSecret}", 6 | "callBackUrl": "{callBackUrl}" 7 | } 8 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name":"twitter-node-client", 3 | "description":"Twitter JS Client", 4 | "version":"0.0.6", 5 | "directories" : { "lib": "./lib" }, 6 | "dependencies":{ 7 | "qs": "5.2.0", 8 | "oauth": "*" 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /twitter.txt: -------------------------------------------------------------------------------- 1 | http://code.google.com/p/oauth/source/browse/code/javascript/oauth.js?r=1136 2 | http://moonlitscript.com/post.cfm/how-to-use-oauth-and-twitter-in-your-node-js-expressjs-app/ 3 | http://blog.joeandrieu.com/2012/01/30/the-worlds-simplest-autotweeter-in-node-js/ 4 | https://dev.twitter.com/docs/auth/oauth/single-user-with-examples 5 | https://github.com/ciaranj/node-oauth/blob/master/examples/express-gdata/server.js 6 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | 2 | MOCHA_OPTS= 3 | REPORTER = dot 4 | 5 | check: test 6 | 7 | test: test-unit 8 | 9 | spec: test-spec 10 | 11 | test-spec: 12 | @NODE_ENV=test jasmine-node test/spec --junitreport --forceexit 13 | 14 | test-unit: 15 | @NODE_ENV=test mocha test/spec \ 16 | --reporter $(REPORTER) \ 17 | $(MOCHA_OPTS) 18 | 19 | test-cov: lib-cov 20 | @RPSLP_COV=1 $(MAKE) test REPORTER=html-cov > coverage.html 21 | 22 | lib-cov: 23 | @jscoverage lib lib-cov 24 | 25 | benchmark: 26 | @./support/bench 27 | 28 | clean: 29 | rm -f coverage.html 30 | rm -fr lib-cov 31 | 32 | .PHONY: test test-unit test-acceptance benchmark clean 33 | -------------------------------------------------------------------------------- /test/spec/TwitterITSpec.js: -------------------------------------------------------------------------------- 1 | var Twitter = require('../../lib/twitter').Twitter; 2 | var fs = require('fs'); 3 | 4 | describe('Twitter', function () { 5 | var twitter; 6 | var config; 7 | var error = function (err, response, body) { 8 | console.log('ERROR [%s]', err); 9 | done(); 10 | }; 11 | 12 | beforeEach(function (done) { 13 | config = JSON.parse(fs.readFileSync('./test/spec/properties.json', encoding="ascii")); 14 | twitter = new Twitter(config); 15 | expect(twitter).toBeDefined(); 16 | expect(twitter.oauth).toBeDefined(); 17 | done(); 18 | }); 19 | 20 | it('should get request token', function (done) { 21 | twitter.getOAuthRequestToken(function (oauth) { 22 | done(); 23 | }); 24 | }); 25 | 26 | it('should get timeline for a user', function (done) { 27 | var params = { screen_name: 'BoyCook', count: '10'}; 28 | twitter.getUserTimeline(params, error, 29 | function (data) { 30 | expect(JSON.parse(data).length).toEqual(10); 31 | done(); 32 | } 33 | ); 34 | }); 35 | 36 | it('should get home timeline', function (done) { 37 | var params = { count: '10'}; 38 | twitter.getHomeTimeline(params, error, 39 | function (data) { 40 | expect(JSON.parse(data).length).toEqual(10); 41 | done(); 42 | } 43 | ); 44 | }); 45 | 46 | it('should get favorites', function (done) { 47 | var params = { count: '10'}; 48 | twitter.getFavorites(params, error, 49 | function (data) { 50 | expect(JSON.parse(data).length).toEqual(10); 51 | done(); 52 | } 53 | ); 54 | }); 55 | 56 | it('should get mentions timeline', function (done) { 57 | var params = { count: '10'}; 58 | twitter.getMentionsTimeline(params, error, 59 | function (data) { 60 | expect(JSON.parse(data).length).toEqual(10); 61 | done(); 62 | } 63 | ); 64 | }); 65 | 66 | it('should get re tweets', function (done) { 67 | var params = { count: '10'}; 68 | twitter.getReTweetsOfMe(params, error, 69 | function (data) { 70 | expect(JSON.parse(data).length).toEqual(0); 71 | done(); 72 | } 73 | ); 74 | }); 75 | 76 | it('should get tweet by id', function (done) { 77 | var data = { id: '292964063091236860'}; 78 | var params = { id: '292964063091236864'}; 79 | twitter.getTweet(params, error, 80 | function (tweet) { 81 | tweet = JSON.parse(tweet); 82 | expect(tweet.id_str).toEqual(params.id); 83 | // expect(tweet.id).toEqual(data.id); 84 | done(); 85 | } 86 | ); 87 | }); 88 | }); 89 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://travis-ci.org/BoyCook/TwitterJSClient.png?branch=master)](https://travis-ci.org/BoyCook/TwitterJSClient) 2 | [![Coverage Status](https://coveralls.io/repos/BoyCook/TwitterJSClient/badge.png)](https://coveralls.io/r/BoyCook/TwitterJSClient) 3 | [![Dependency Status](https://gemnasium.com/BoyCook/TwitterJSClient.png)](https://gemnasium.com/BoyCook/TwitterJSClient) 4 | [![NPM](https://nodei.co/npm/twitter-node-client.png?downloads=true)](https://nodei.co/npm/twitter-node-client) 5 | 6 | ## Description 7 | A Twitter Node Module to authenticate and interact with the Twitter REST API from NodeJS. 8 | 9 | ## Installation 10 | ``` 11 | npm install twitter-node-client 12 | ``` 13 | ```javascript 14 | var Twitter = require('twitter-node-client').Twitter; 15 | ``` 16 | ## Usage 17 | You need to create a [Twitter app](https://dev.twitter.com/apps) to use the API. 18 | 19 | ```javascript 20 | //Callback functions 21 | var error = function (err, response, body) { 22 | console.log('ERROR [%s]', err); 23 | }; 24 | var success = function (data) { 25 | console.log('Data [%s]', data); 26 | }; 27 | 28 | var Twitter = require('twitter-node-client').Twitter; 29 | 30 | //Get this data from your twitter apps dashboard 31 | { 32 | "consumerKey": "XXX", 33 | "consumerSecret": "XXX", 34 | "accessToken": "XXX", 35 | "accessTokenSecret": "XXX", 36 | "callBackUrl": "XXX" 37 | } 38 | 39 | // make a directory in the root folder of your project called data 40 | // copy the node_modules/twitter-node-client/twitter_config file over into data/twitter_config` 41 | // Open `data/twitter_config` and supply your applications `consumerKey`, 'consumerSecret', 'accessToken', 'accessTokenSecret', 'callBackUrl' to the appropriate fields in your data/twitter_config file 42 | 43 | var twitter = new Twitter(); 44 | 45 | //Example calls 46 | 47 | twitter.getUserTimeline({ screen_name: 'BoyCook', count: '10'}, error, success); 48 | 49 | twitter.getMentionsTimeline({ count: '10'}, error, success); 50 | 51 | twitter.getHomeTimeline({ count: '10'}, error, success); 52 | 53 | twitter.getReTweetsOfMe({ count: '10'}, error, success); 54 | 55 | twitter.getTweet({ id: '1111111111'}, error, success); 56 | 57 | 58 | // 59 | // Get 10 tweets containing the hashtag haiku 60 | // 61 | 62 | twitter.getSearch({'q':'#haiku','count': 10}, error, success); 63 | 64 | // 65 | // Get 10 popular tweets with a positive attitude about a movie that is not scary 66 | // 67 | 68 | twitter.getSearch({'q':' movie -scary :) since:2013-12-27', 'count': 10, 'result\_type':'popular'}, error, success); 69 | ``` 70 | 71 | Twitter has a comprehensive [REST api](https://dev.twitter.com/rest/public) if you need to use something that doesn't have a wrapper function in the library call it directly : 72 | ```javascript 73 | twitter.getCustomApiCall('/statuses/lookup.json',{ id: '412312323'}, error, success); 74 | twitter.postCustomApiCall('/direct_messages/new.json',{user_id: '1234', 'text':'This is easy.'}, error, success); 75 | ``` 76 | To get the list of expected parameters and results, check [https://dev.twitter.com/rest/public](https://dev.twitter.com/rest/public) 77 | 78 | ## Functions 79 | 80 | ##### Search Tweets. [Docs](https://dev.twitter.com/rest/reference/get/search/tweets) 81 | To learn how to use Twitter Search effectively read [Using the Twitter Search API](https://dev.twitter.com/rest/public/search) 82 | ```javascript 83 | twitter.getSearch(parameters, errorCallback, successCallback); 84 | ``` 85 |   86 | 87 | ##### Update user's status (Tweet). [Docs](https://dev.twitter.com/rest/reference/post/statuses/update) 88 | ```javascript 89 | twitter.postTweet(parameters, errorCallback, successCallback); 90 | ``` 91 |   92 | 93 | ##### Follow another user by user\_id or screen_name(handle). [Docs](https://dev.twitter.com/rest/reference/post/friendships/create) 94 | ```javascript 95 | twitter.postCreateFriendship(parameters, errorCallback, successCallback); 96 | ``` 97 | 98 |   99 | 100 | ##### Get a user's timeline[Docs](https://dev.twitter.com/rest/reference/get/statuses/user_timeline) 101 | ```javascript 102 | twitter.getUserTimeline(parameters, errorCallback, successCallback); 103 | ``` 104 |   105 | 106 | ##### Get the latest 20 recent mentions for the authenticating user. [Docs](https://dev.twitter.com/rest/reference/get/statuses/mentions_timeline) 107 | ```javascript 108 | twitter.getMentionsTimeline(parameters, errorCallback, successCallback); 109 | ``` 110 |   111 | 112 | ##### Get the latest tweets and retweets by the authenticating users and the ones they follow. [Docs](https://dev.twitter.com/rest/reference/get/statuses/home_timeline) 113 | ```javascript 114 | twitter.getHomeTimeline(parameters, errorCallback, successCallback); 115 | ``` 116 |   117 | 118 | ##### Get latest retweets of authenticated user. [Docs](https://dev.twitter.com/rest/reference/get/statuses/retweets_of_me) 119 | ```javascript 120 | twitter.getReTweetsOfMe(parameters, errorCallback, successCallback); 121 | ``` 122 |   123 | 124 | ##### Get a tweet by id. [Docs](https://dev.twitter.com/rest/reference/get/statuses/show/) 125 | ```javascript 126 | twitter.getTweet(parameters, errorCallback, successCallback); 127 | ``` 128 |   129 | 130 | ##### Get information about a user by user\_id or handle (screen_name). [Docs](https://dev.twitter.com/rest/reference/get/users/show) 131 | ```javascript 132 | twitter.getUser(parameters, errorCallback, successCallback); 133 | ``` 134 |   135 | 136 | ##### Get a cursored collection of the followers of a user\_id or a handle (screen_name). [Docs](https://dev.twitter.com/rest/reference/get/followers/list) 137 | ```javascript 138 | twitter.getFollowersList(parameters, errorCallback, successCallback); 139 | ``` 140 |   141 | 142 | ##### Get a cursored collection of the followers' *ids* of a user\_id or a handle (screen_name). [Docs](https://dev.twitter.com/rest/reference/get/followers/ids) 143 | ```javascript 144 | twitter.getFollowersIds(parameters, errorCallback, successCallbackok); 145 | ``` 146 |   147 | 148 | ##### Upload media (images) to Twitter. [Docs](https://dev.twitter.com/rest/reference/post/media/upload) 149 | ```javascript 150 | twitter.postMedia(parameters, errorCallback, successCallback); 151 | ``` 152 | 153 | ## Tests 154 | 155 | There is a test file `TwitterITSpec.js` that does a basic integration tests of the client. 156 | It uses a properties file `test/spec/properties.json` to inject in the OAuth properties. 157 | These will need to be updated with your own details before the tests will run 158 | 159 | ## Running tests 160 | 161 | make test 162 | -------------------------------------------------------------------------------- /lib/Twitter.js: -------------------------------------------------------------------------------- 1 | /* 2 | Twitter client app 3 | */ 4 | 5 | var DEBUG = (process.env.DEBUG !== undefined); 6 | 7 | var OAuth = require('oauth').OAuth; 8 | var qs = require('qs'); 9 | 10 | function Twitter() { 11 | var configPath = "data/twitter_config"; 12 | try { 13 | var config = process.env; 14 | 15 | this.consumerKey = config.twitterConsumerKey; 16 | this.consumerSecret = config.twitterConsumerSecret; 17 | this.accessToken = config.twitterAccessToken; 18 | this.accessTokenSecret = config.twitterAccessTokenSecret; 19 | this.callBackUrl = config.twitterCallBackUrl; 20 | this.baseUrl = 'https://api.twitter.com/1.1'; 21 | this.oauth = new OAuth( 22 | 'https://api.twitter.com/oauth/request_token', 23 | 'https://api.twitter.com/oauth/access_token', 24 | this.consumerKey, 25 | this.consumerSecret, 26 | '1.0', 27 | this.callBackUrl, 28 | 'HMAC-SHA1' 29 | ); 30 | } catch (err) { 31 | //console.log(err) 32 | console.log("no 'data/twitter_config' file, continuing without..."); 33 | } 34 | } 35 | 36 | Twitter.prototype.getOAuthRequestToken = function (next) { 37 | this.oauth.getOAuthRequestToken(function (error, oauth_token, oauth_token_secret, results) { 38 | if (error) { 39 | if (DEBUG) console.log('ERROR: ' + error); 40 | next(); 41 | } 42 | else { 43 | var oauth = {}; 44 | oauth.token = oauth_token; 45 | oauth.token_secret = oauth_token_secret; 46 | if (DEBUG) console.log('oauth.token: ' + oauth.token); 47 | if (DEBUG) console.log('oauth.token_secret: ' + oauth.token_secret); 48 | next(oauth); 49 | } 50 | }); 51 | }; 52 | 53 | Twitter.prototype.getOAuthAccessToken = function (oauth, next) { 54 | this.oauth.getOAuthAccessToken(oauth.token, oauth.token_secret, oauth.verifier, 55 | function (error, oauth_access_token, oauth_access_token_secret, results) { 56 | if (error) { 57 | if (DEBUG) console.log('ERROR: ' + error); 58 | next(); 59 | } else { 60 | oauth.access_token = oauth_access_token; 61 | oauth.access_token_secret = oauth_access_token_secret; 62 | 63 | if (DEBUG) console.log('oauth.token: ' + oauth.token); 64 | if (DEBUG) console.log('oauth.token_secret: ' + oauth.token_secret); 65 | if (DEBUG) console.log('oauth.access_token: ' + oauth.access_token); 66 | if (DEBUG) console.log('oauth.access_token_secret: ' + oauth.access_token_secret); 67 | next(oauth); 68 | } 69 | } 70 | ); 71 | }; 72 | 73 | Twitter.prototype.postMedia = function (params, error, success) { 74 | var url = 'https://upload.twitter.com/1.1/media/upload.json'; 75 | this.doPost(url, params, error, success); 76 | }; 77 | 78 | Twitter.prototype.postTweet = function (params, error, success) { 79 | var path = '/statuses/update.json'; 80 | var url = this.baseUrl + path; 81 | this.doPost(url, params, error, success); 82 | }; 83 | 84 | Twitter.prototype.postFavoritesCreate = function (params, error, success) { 85 | var path = '/favorites/create.json'; 86 | var url = this.baseUrl + path; 87 | this.doPost(url, params, error, success); 88 | }; 89 | 90 | Twitter.prototype.postCreateFriendship = function (params, error, success) { 91 | var path = '/friendships/create.json'; 92 | var url = this.baseUrl + path; 93 | this.doPost(url, params, error, success); 94 | }; 95 | 96 | Twitter.prototype.getUserTimeline = function (params, error, success) { 97 | var path = '/statuses/user_timeline.json' + this.buildQS(params); 98 | var url = this.baseUrl + path; 99 | this.doRequest(url, error, success); 100 | }; 101 | 102 | Twitter.prototype.getMentionsTimeline = function (params, error, success) { 103 | var path = '/statuses/mentions_timeline.json' + this.buildQS(params); 104 | var url = this.baseUrl + path; 105 | this.doRequest(url, error, success); 106 | }; 107 | 108 | Twitter.prototype.getHomeTimeline = function (params, error, success) { 109 | var path = '/statuses/home_timeline.json' + this.buildQS(params); 110 | var url = this.baseUrl + path; 111 | this.doRequest(url, error, success); 112 | }; 113 | 114 | Twitter.prototype.getFavorites = function (params, error, success) { 115 | var path = '/favorites/list.json' + this.buildQS(params); 116 | var url = this.baseUrl + path; 117 | this.doRequest(url, error, success); 118 | }; 119 | 120 | Twitter.prototype.getReTweetsOfMe = function (params, error, success) { 121 | var path = '/statuses/retweets_of_me.json' + this.buildQS(params); 122 | var url = this.baseUrl + path; 123 | this.doRequest(url, error, success); 124 | }; 125 | 126 | Twitter.prototype.getTweet = function (params, error, success) { 127 | var path = '/statuses/show.json' + this.buildQS(params); 128 | var url = this.baseUrl + path; 129 | this.doRequest(url, error, success); 130 | }; 131 | 132 | Twitter.prototype.getSearch = function (params, error, success) { 133 | var encodedQuery = encodeURIComponent(params.q); 134 | delete params.q; 135 | var path = '/search/tweets.json?q=' + encodedQuery +'&'+ qs.stringify(params); 136 | var url = this.baseUrl + path; 137 | this.doRequest(url, error, success); 138 | }; 139 | 140 | //molina code 141 | Twitter.prototype.getUser = function (params, error, success) { 142 | var path = '/users/show.json' + this.buildQS(params); 143 | var url = this.baseUrl + path; 144 | this.doRequest(url, error, success); 145 | }; 146 | 147 | Twitter.prototype.getFollowersList = function (params, error, success) { 148 | var path = '/followers/list.json' + this.buildQS(params); 149 | var url = this.baseUrl + path; 150 | this.doRequest(url, error, success); 151 | }; 152 | 153 | Twitter.prototype.getFollowersIds = function (params, error, success) { 154 | var path = '/followers/ids.json' + this.buildQS(params); 155 | var url = this.baseUrl + path; 156 | this.doRequest(url, error, success); 157 | }; 158 | 159 | Twitter.prototype.getCustomApiCall = function (url, params, error, success) { 160 | var path = url + this.buildQS(params); 161 | var url = this.baseUrl + path; 162 | this.doRequest(url, error, success); 163 | }; 164 | 165 | Twitter.prototype.postCustomApiCall = function (url, params, error, success) { 166 | var path = url + this.buildQS(params); 167 | var url = this.baseUrl + path; 168 | this.doPost(url, params, error, success); 169 | }; 170 | 171 | Twitter.prototype.doRequest = function (url, error, success) { 172 | // Fix the mismatch between OAuth's RFC3986's and Javascript's beliefs in what is right and wrong ;) 173 | // From https://github.com/ttezel/twit/blob/master/lib/oarequest.js 174 | url = url.replace(/\!/g, "%21") 175 | .replace(/\'/g, "%27") 176 | .replace(/\(/g, "%28") 177 | .replace(/\)/g, "%29") 178 | .replace(/\*/g, "%2A"); 179 | 180 | this.oauth.get(url, this.accessToken, this.accessTokenSecret, function (err, body, response) { 181 | if (DEBUG) console.log('URL [%s]', url); 182 | if (!err && response.statusCode == 200) { 183 | limits = { 184 | "x-rate-limit-limit": response.headers['x-rate-limit-limit'], 185 | "x-rate-limit-remaining": response.headers['x-rate-limit-remaining'], 186 | "x-rate-limit-reset": response.headers['x-rate-limit-reset'], 187 | }; 188 | success(body, limits); 189 | } else { 190 | error(err, response, body); 191 | } 192 | }); 193 | }; 194 | Twitter.prototype.retweet = function(id, error, success){ 195 | var url = this.baseUrl + '/statuses/retweet/'+id+'.json'; 196 | this.doPost(url, {}, error, success); 197 | } 198 | 199 | Twitter.prototype.unretweet = function(id, error, success){ 200 | var url = this.baseUrl + '/statuses/unretweet/'+id+'.json'; 201 | this.doPost(url, {}, error, success); 202 | } 203 | Twitter.prototype.doPost = function (url, post_body, error, success) { 204 | // Fix the mismatch between OAuth's RFC3986's and Javascript's beliefs in what is right and wrong ;) 205 | // From https://github.com/ttezel/twit/blob/master/lib/oarequest.js 206 | url = url.replace(/\!/g, "%21") 207 | .replace(/\'/g, "%27") 208 | .replace(/\(/g, "%28") 209 | .replace(/\)/g, "%29") 210 | .replace(/\*/g, "%2A"); 211 | //(url, oauth_token, oauth_token_secret, post_body, post_content_type, callback 212 | this.oauth.post(url, this.accessToken, this.accessTokenSecret, post_body, "application/x-www-form-urlencoded", function (err, body, response) { 213 | if (DEBUG) console.log('URL [%s]', url); 214 | if (!err && response.statusCode == 200) { 215 | success(body); 216 | } else { 217 | error(err, response, body); 218 | } 219 | }); 220 | }; 221 | 222 | Twitter.prototype.buildQS = function (params) { 223 | if (params && Object.keys(params).length > 0) { 224 | return '?' + qs.stringify(params); 225 | } 226 | return ''; 227 | }; 228 | 229 | if (!(typeof exports === 'undefined')) { 230 | exports.Twitter = Twitter; 231 | } 232 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {{description}} 294 | Copyright (C) {{year}} {{fullname}} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------