├── .gitignore ├── LICENSE ├── Procfile ├── README.md ├── bot.js ├── config.js.example ├── index.js ├── package.json └── web.js /.gitignore: -------------------------------------------------------------------------------- 1 | config.js -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | web: node index.js -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # google_sheet_reader_bot 2 | Telegram bot to get data from Google Sheet, checks the very first column for time (in hours) and returns rows where time matches 3 | 4 | ## steps to use 5 | 6 | ### 1. Create Google Sheet with the data. The very first column is treated as a key for the start time of event. You may have multiple rows with the same key, all of them they will be displayed then. 7 | | Start Time | Where | Description | Author | 8 | | ---------- | --------------- | ---------------- | -----| 9 | | 9 | red room | first talk description |John Doe| 10 | | 10 | red room | talk about javascript |Jack Black| 11 | | 11 | red room | some marketing talk bs |William White| 12 | | 9 | green room | some keynote talk |John Baker| 13 | | 10 | green room | networking and coffee |Bob Will| 14 | | 11 | green room | some use case for node.js |Diana White| 15 | 16 | #### 2. Publish this Google sheet (File - Publish To Web - OK) 17 | #### 3. (for heroku) Create a new app on heroku (say, "myapp-bot-app") 18 | #### 3. (for cloud9) Create account on [c9.io](Cloud9), create `Node.js` workspace and run the command `git clone git@github.com:emirn/google_sheet_reader_bot.git` 19 | #### 4. Register telegram bot (send **/newbot** commmand to register bot with [https://telegram.me/BotFather](@BotFather) in Telegram) and copy token for newly created bot. 20 | #### 5. Copy `config.js.example` into `config.js` 21 | #### 6. Fill values in `config.js` to set: 22 | 23 | module.exports = { 24 | 'TelegramProductionURL': 'https://myapp-bot-app.herokuapp.com/', // your heroku app do not forget trailing "/" !! 25 | 'TelegramToken': '', // Telegram token you got from @BotFather 26 | 'googleSheetKey': '', // the key of the google sheet (should be public!), extract key from the google sheet doc publich url 27 | "confTimeZone": "Europe/Berlin" // time zone of the conference so the bot could output events for the current time in the form like "Europe/Berlin", see http://momentjs.com/timezone/ 28 | } 29 | #### 7. Install required packages using `npm install` command in the console 30 | #### 8 (for heroku). Push the code to heroku using commands `git add .`, `git commit -m "initial version"` and then finally `git push` 31 | #### 9 (for cloud9). Simply run the bot on the workspace using the command `node .`. IMPORTANT: cloud9 is mostly for development purposes, if you want to run the bot as product then consider running on Heroku too. 32 | #### Congrats! Now you may send the command like `10` to the bot and it will send you all events which are taking place at `10` o'clock according to the spreadsheet. 33 | You may change the spreadsheet and the bot will take new data form the spreadheet online. 34 | 35 | #### How it works for enduser: 36 | - add the bot to the Telegram using the link `https://telegram.me/yourbot` where `yourbot` will be replaced with your actual bot name 37 | - send 'Hi' to the bot to show events taking place at the current time (in the timeone defined by config.confTimeZone) 38 | - or send the time in a form of 12 for 12 PM, 14:43 for 2.43 PM etc. 39 | - the bot will list all events taking place at time entered 40 | -------------------------------------------------------------------------------- /bot.js: -------------------------------------------------------------------------------- 1 | // Created by Evgenii Mironichev, Copyright 2016, 2 | // based on this awesome tutorial: https://mvalipour.github.io/node.js/2015/11/10/build-telegram-bot-nodejs-heroku/ 3 | 4 | var config = require('./config'); // rename config.js.example into config.js and set keys and tokens inside it 5 | 6 | var Bot = require('node-telegram-bot-api'); 7 | var bot; 8 | 9 | if(process.env.NODE_ENV === 'production') { 10 | bot = new Bot(config.TelegramToken); 11 | bot.setWebHook(config.TelegramProductionURL + bot.token); 12 | } 13 | else { 14 | bot = new Bot(config.TelegramToken, { polling: true }); 15 | } 16 | 17 | //var Bot = require('node-telegram-bot-api'), 18 | // bot = new Bot(config.TelegramToken, { polling: true }); 19 | 20 | console.log('secon-bot server started...'); 21 | 22 | // Make sure it is public or set to Anyone with link can view 23 | // "od6" is the fist worksheet in the spreadsheet 24 | var url = "https://spreadsheets.google.com/feeds/list/" + config.googleSheetKey + "/od6/public/values?alt=json"; 25 | 26 | var moment = require('moment-timezone'); 27 | 28 | bot.onText(/(.+)$/, function (msg, match) { 29 | // keywords are anything typed in 30 | var keywords = match[1]; 31 | var request = require("request"); 32 | 33 | // send request to retrieve the spreadsheet as the JSON 34 | request(url, function (error, response, body) { 35 | if (error || response.statusCode != 200) { 36 | console.log('Error: '+error); // Show the error 37 | console.log('Status code: ' + response.statusCode); // Show the error 38 | return; 39 | } 40 | 41 | var parsed = JSON.parse(body); 42 | var targetTime = NaN; 43 | if (!isNaN(keywords)) // isNaN returns false if the value is number 44 | { 45 | try{ 46 | targetTime = parseInt(keywords, 10); 47 | } 48 | catch(e){ 49 | targetTime = NaN; 50 | } 51 | } 52 | 53 | if (isNaN(targetTime)) 54 | targetTime = -1; 55 | 56 | var formattedAnswer = ""; 57 | 58 | // debug purposes: echo from id: 59 | // formattedAnswer += "\nMsg.from.id=" + msg.from.id + "\n"; 60 | 61 | var currentHours = parseInt(moment().tz(config.confTimeZone).format('HH'),10); 62 | var currentMinutes = parseInt(moment().tz(config.confTimeZone).format('mm'),10); 63 | // console.log("Current hours: " + currentHours); 64 | var currentAnswer = ""; 65 | 66 | var itemsFound = 0; 67 | // sending answers 68 | parsed.feed.entry.forEach(function(item){ 69 | // get the time(in hours) from the very first column 70 | var itemTime = NaN; 71 | var itemTitle = item.title.$t 72 | try{ 73 | itemTime = parseInt(itemTitle, 10); 74 | } 75 | catch(e) 76 | { 77 | itemTime = NaN; 78 | } 79 | 80 | if ( 81 | (!isNaN(itemTime) && itemTime == targetTime) || 82 | (isNaN(itemTime) && itemTitle.toLowerCase().trim() == keywords.toLowerCase().trim()) 83 | ) 84 | { 85 | // add the line break if not the first answer 86 | if (itemsFound==0) 87 | formattedAnswer += "At " + targetTime + " these talks will take place:\n\n"; 88 | else 89 | formattedAnswer += "\n\n"; 90 | 91 | itemsFound++; 92 | formattedAnswer += '\u27a1' + item.content.$t; // add item content, '\u27a1' is the arrow emoji 93 | } 94 | else if (currentHours == itemTime) // else collect items for the current hour 95 | { 96 | if (currentAnswer == '') 97 | currentAnswer == 'Starting from ' + currentHours + " h the following talks are goinf:\n\n"; 98 | else 99 | currentAnswer += "\n\n"; 100 | 101 | currentAnswer += '\u27a1' + item.content.$t; // get item content, '\u27a1' is the arrow emoji 102 | } 103 | 104 | // else doing nothing 105 | }); 106 | 107 | // if no items were found for the given time 108 | if (itemsFound == 0) 109 | { 110 | if (targetTime<0 || targetTime>24) 111 | formattedAnswer = "Enter the time to show talks or write 'Hi'.\n\n"; 112 | else 113 | formattedAnswer = "Can't find events for the given time ( " + targetTime+ " ч)"; 114 | 115 | // output current answer 116 | if (currentAnswer != '') 117 | { 118 | formattedAnswer += "Hi! As of " + currentHours + ":" + currentMinutes + " " + config.confTimeZone+ " these talks are going:\n"; 119 | formattedAnswer += currentAnswer; 120 | } 121 | } 122 | 123 | // send message telegram finally 124 | bot.sendMessage(msg.chat.id, formattedAnswer).then(function () { 125 | // reply sent! 126 | }); 127 | 128 | }); 129 | 130 | }); 131 | 132 | module.exports = bot; 133 | -------------------------------------------------------------------------------- /config.js.example: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | 'TelegramProductionURL': 'https://YOUR-PRODUCTION-URL/', // do not forget trailing "/" !! 3 | 'TelegramToken': '', // Telegram token 4 | 'googleSheetKey': '', // the key of the google sheet (should be public!), extract key from the google sheet doc publich url 5 | "confTimeZone": "Europe/Berlin" // time zone of the conference in the form like "Europe/Berlin", see http://momentjs.com/timezone/ 6 | } -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var bot = require('./bot'); 2 | require('./web')(bot); -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "google-sheet-bot", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "author": "", 10 | "license": "ISC", 11 | "dependencies": { 12 | "request": "^2.72.0", 13 | "body-parser": "^1.15.0", 14 | "express": "^4.13.4", 15 | "moment-timezone": "^0.5.2", 16 | "node-telegram-bot-api": "^0.21.1" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /web.js: -------------------------------------------------------------------------------- 1 | var express = require('express'); 2 | var packageInfo = require('./package.json'); 3 | var bodyParser = require('body-parser'); 4 | 5 | var app = express(); 6 | app.use(bodyParser.json()); 7 | 8 | app.get('/', function (req, res) { 9 | res.json({ version: packageInfo.version }); 10 | }); 11 | 12 | var server = app.listen(process.env.PORT, function () { 13 | var host = server.address().address; 14 | var port = server.address().port; 15 | 16 | console.log('Web server started at http://%s:%s', host, port); 17 | }); 18 | 19 | module.exports = function (bot) { 20 | app.post('/' + bot.token, function (req, res) { 21 | bot.processUpdate(req.body); 22 | res.sendStatus(200); 23 | }); 24 | }; --------------------------------------------------------------------------------