├── data └── .keep ├── README.md ├── api └── index.js ├── test ├── api.js └── sqlite.js ├── package.json ├── LICENSE ├── .gitignore └── DESCRIPTION.md /data/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # surveys 2 | Telegram bot for creating personal surveys 3 | -------------------------------------------------------------------------------- /api/index.js: -------------------------------------------------------------------------------- 1 | const express = require('express') 2 | const bodyParser = require('express') 3 | 4 | const app = express() 5 | const start = new Date().getTime() 6 | 7 | app.use(bodyParser.urlencoded()) 8 | 9 | app.get('/', (req, res) => { 10 | res.json({ 11 | uptime: new Date().getTime() - start, 12 | }) 13 | }) 14 | 15 | module.exports = app -------------------------------------------------------------------------------- /test/api.js: -------------------------------------------------------------------------------- 1 | process.env.NODE_ENV = 'test' 2 | 3 | const chai = require('chai') 4 | const chaiHTTP = require('chai-http') 5 | const api = require('../api') 6 | 7 | chai.use(chaiHTTP) 8 | 9 | const { expect, request } = chai 10 | 11 | describe('API', () => { 12 | it('GET / should return uptime', (done) => { 13 | request(api).get('/').end((e, res) => { 14 | expect(e).to.be.null 15 | expect(res).to.have.status(200) 16 | expect(res.body).to.be.a('object') 17 | expect(res.body).to.include.all.keys('uptime') 18 | expect(res.body.uptime).to.be.a('number') 19 | done() 20 | }) 21 | }) 22 | }) -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "surveys", 3 | "version": "1.0.0", 4 | "description": "Telegram bot for creating personal surveys", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "mocha test" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/border-radius/surveys.git" 12 | }, 13 | "keywords": [], 14 | "author": "", 15 | "license": "ISC", 16 | "bugs": { 17 | "url": "https://github.com/border-radius/surveys/issues" 18 | }, 19 | "homepage": "https://github.com/border-radius/surveys#readme", 20 | "dependencies": { 21 | "body-parser": "^1.19.0", 22 | "express": "^4.17.1", 23 | "sqlite3": "github:border-radius/node-sqlite3" 24 | }, 25 | "devDependencies": { 26 | "chai": "^4.3.4", 27 | "chai-http": "^4.3.0", 28 | "mocha": "^9.0.1" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Vadim 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 all 13 | 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 THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /test/sqlite.js: -------------------------------------------------------------------------------- 1 | process.env.NODE_ENV = 'test' 2 | 3 | const fs = require('fs') 4 | const path = require('path') 5 | const chai = require('chai') 6 | const sqlite = require('sqlite3') 7 | 8 | const { expect } = chai 9 | const dbPath = path.join(__dirname, '../data/test.db') 10 | 11 | describe('SQLite', () => { 12 | const db = new sqlite.Database(dbPath) 13 | 14 | it('should use sqlite with returning support', (done) => { 15 | 16 | db.serialize(() => { 17 | db.run('CREATE TABLE IF NOT EXISTS test (id INTEGER PRIMARY KEY, value TEXT)', (e) => { 18 | if (e) { 19 | return done(e) 20 | } 21 | 22 | db.get('INSERT INTO test (value) VALUES (?) RETURNING *', ['test string'], (e, row) => { 23 | if (e) { 24 | return done(e) 25 | } 26 | 27 | expect(row).to.be.a('object') 28 | expect(row).to.have.property('id', 1) 29 | expect(row).to.have.property('value', 'test string') 30 | done() 31 | }) 32 | }) 33 | }) 34 | }) 35 | 36 | after((done) => { 37 | fs.unlinkSync(dbPath) 38 | db.close(() => done()) 39 | }) 40 | }) -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | # SQLite data 107 | data/* 108 | !data/.keep -------------------------------------------------------------------------------- /DESCRIPTION.md: -------------------------------------------------------------------------------- 1 | # Шкалы обратной связи 2 | 3 | ## Структура данных 4 | 5 | ### Пользователи: id, id телеграм аккаунта, fullname из телеграма, секрет, дата создания, обновления и удаления 6 | 7 | Существующие пользователи считаются администраторами, могут назначать других пользователей администраторами, создавать новых клиентов, создавать шаблоны опросника и заполнять вопросы и ответы на него, создавать прохождение опросников клиентами. 8 | 9 | ### Клиенты: id, ФИО, дата создания, обновления и удаления 10 | 11 | Пока клиентов будет создавать только администратор через чат-бота 12 | 13 | ### Шаблоны опросов: id опросника, готовность опросника, название опросника, дата создания, обновления и удаления 14 | ### Шаблоны вопросов: id вопроса, id опросника, тип вопроса, текст вопроса, дата создания, обновления и удаления 15 | ### Шаблоны ответов: id ответа, id вопроса, текст ответа, дата создания, обновления и удаления 16 | 17 | Пока будет только один тип вопроса `range10`: диапазон от 1 до 10. К нему будут относиться два варианта ответа: с меньшим id ответ на 1, в большим id ответ на 10 18 | 19 | ### Прохождение опросника: id опросника, id клиента, секрет, дата прохождения, дата создания, обновления и удаления 20 | ### Ответы на опросник: id прохождения опросника, id вопроса, id ответа, дата создания, обновления и удаления 21 | 22 | Для создания прохождения опросника администратор должен будет выбрать опросник и клиента. Бот вернет ссылку с секретом: только по этой ссылке можно будет пройти опроcник единожды. 23 | 24 | ## Бот 25 | 26 | Telegram-бот будет реагировать на следующие команды: 27 | 28 | ### /start 29 | 30 | Возвращает id телеграм пользователя, этот id можно будет переслать другому человеку, чтобы он сделал тебя администратором в боте. 31 | Бот так же указывает, является ли текущий пользователь администратором. 32 | 33 | ### /promote id 34 | 35 | Создает нового пользователя с таким id телеграм аккаунта и случайным секретом. Это делает этого пользователя администратором. 36 | 37 | ### /clients 38 | 39 | Возвращает список клиентов с ссылкой для создания прохождения опроса вида `/survey_add_ID` (ID - id клиента) и кнопку для создания нового клиента. Кнопка отправляет команду `/clients_add` 40 | 41 | ### /clients_add 42 | 43 | Спрашивает у адмнистратора ФИО нового клиента. При получении ответа на это сообщение, создает нового клиента с таким ФИО и уведомляет об этом ответным сообщением. 44 | 45 | ### /templates 46 | 47 | Возвращает список шаблонов опросов и кнопку для создания нового шаблона. Кнопка отправляет команду `/templates_add` 48 | 49 | ### /templates_add 50 | 51 | Спрашивает у администратора название нового опросника. 52 | При получении ответа, создает новый шаблон опросника с таким названием и спрашивает текст первого вопроса. 53 | При получении ответа, создает новый шаблон вопроса с указанным текстом и типом `range10`, в ответ спрашивает первый вариант ответа на этот вопрос (эквивалент ответу 1). 54 | При получении ответа сохраняет шаблон ответа и спрашивает второй вариант ответа на этот вопрос (эквивалент ответу 10). 55 | При получении ответа сохраняет шаблон ответа и спрашивает текст следующего вопроса. У этого сообщения есть кнопка "Завершить опросник", которая отправляет команду `/templates_finish_ID` с ID шаблона опросника. 56 | 57 | ### /templates_finish_ID (ID - id шаблона опросника) 58 | 59 | Обновляет готовность шаблона опросника, позволяя ему отображаться в списке шаблонов опросника. 60 | 61 | ### /survey_add_ID (ID - id клиента) 62 | 63 | Возвращает список шаблонов опросников, у каждого ссылка на создание нового прохождения вида `/survey_add_ID1_ID2` (ID1 - клиент, ID2 - шаблон опросника). 64 | 65 | ### /survey_add_ID1_ID2 (ID1 - id клиента, ID2 - id шаблона опросника) 66 | 67 | Создает новое прохождение опросника и возвращает ссылку него вида: http://localhost:6632/survey/SECRET (SECRET - секрет прохождения опросника). 68 | 69 | Так же у бота в подвале имеются кнопки: Клиенты (отправляет `/clients`), Опроcники (отправляет `/templates`), Экспорт (отправляет `/export_SECRET` с секретом текущего пользователя). 70 | 71 | ## Web-интерфейс 72 | 73 | ### GET / 74 | 75 | Возвращает json формата: 76 | 77 | ```json 78 | { 79 | "uptime": 123 80 | } 81 | ``` 82 | 83 | Где `123` - аптайм сервиса в мс. 84 | 85 | ### GET /survey/SECRET 86 | 87 | Находит прохождение опросника и если оно не пройдено (нет даты прохождения), показывает форму с прохождением: название опросника, список вопросов и варианты ответов на него. Для вопросов типа `range10` выводится и по бокам у него выводятся первый и второй вариант ответа (первым - с меньшим id). Внизу кнопка "Отправить ответы", отправляющая форму POST-запросом на текущий URI. 88 | 89 | ### POST /survey/SECRET 90 | 91 | Если прохождение опросника еще не пройдено (нет даты прохождения), то сохраняет все ответы на него и обновляет прохождение опросника, устанавливая ему дату прохождения). Рисует задизейбленную форму как в GET-варианте, но с уже проставленными ответами. Над формой надпись: "Спасибо за прохождение опроса. Ваши ответы сохранены.". Рассылает всем администраторам уведомление о том, что такой-то клиент (ФИО) прошел опросник по такому-то шаблону (название шаблона опросника). 92 | 93 | ### GET /export/SECRET 94 | 95 | Если администратор с таким секретом существует, то отправляет всем администраторам сообщение о том, что такой-то администратор заказал экспорт прохождений. 96 | После этого генерирует скачиваемый csv из всех пройденных опросников, отсортированных по клиентам и дате завершения прохождений опросников с такими столбцами: ФИО клиента, название шаблона опросника, дата прохождения, текст вопроса, ответ. --------------------------------------------------------------------------------