javarushcommunity / javarush-telegrambot Goto Github PK

JavaRush Telegram bot from the community to the community. All the process of software development of this bot is described in series of posts

Home Page: https://t.me/javarush_community_bot

License: Apache License 2.0

Java 99.01% Dockerfile 0.47% Shell 0.52%

telegram-bot javarush springboot mvp flyway

javarush-telegrambot's Introduction

Javarush Telegram Bot

JavaRush Telegram bot from community for community. Written by developers, who learned in Javarush.

Idea

The main idea is to show how to create real application, which can be used by someone else. There are set of posts, which are describing step by step guidelines of how it was created.

MVP Scope

As a user, I want to subscribe on group of posts and get notification via telegram-bot every time, when new post, related to group subscriptions, has come.

How it works

Based on MVP Scope, we can specify next behaviours (here and after Telegram User, which is using JavaRush Telgegram bot will call User):

User can subscribe on group of posts
User can view list of group subscriptions on which user subscribes
User can unsubscribe from group of posts
User can set an inactive bot and do not receive notifications
User can restart getting notifications

Find new posts workflow

The workflow of finding new posts and send them to subscribers can be viewed here:

Deployment

Deployment process as easy as possible: Required software:

terminal for running bash scripts
docker
docker-compose

to deploy application, switch to needed branch and run bash script:

$ bash start.sh ${bot_username} ${bot_token}

That's all.

Local development

For local development and testing, use docker-compose-test.yml. Run command:

docker-compose -f docker-compose-test.yml up

Next step, is to run SpringBoot app with configured Edit Configuration in which two env vars are provided:

bot.token=${BOT_TOKEN};bot.username=${BOT_USERNAME}

And add VM Options:

-Dspring.profiles.active=test

With these configurations - run SpringBoot main method.

Technological stack

SpringBoot as a skeleton framework
Spring Scheduler as a task manager
MySQL database as a database for saving user and subscription info
Flyway database migration tool
Telegram-bot SpringBoot starter
Spring Data starter
Unirest - lib for working with REST calls

Code of Conduct

Please, follow Code of Conduct page.

License

This project is Apache License 2.0 - see the LICENSE file for details

Contributions

Feel free to suggest new features via github issue. Note, that new features must be approved before start implement it to avoid the situation, when the time was spent, but the changes wouldn't added to the project.

javarush-telegrambot's People

Contributors

Stargazers

Watchers

javarush-telegrambot's Issues

[FEATURE]

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[BUG]

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

Go to '...'
Click on '....'
Scroll down to '....'
See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]
Browser [e.g. chrome, safari]
Version [e.g. 22]

Smartphone (please complete the following information):

Device: [e.g. iPhone6]
OS: [e.g. iOS8.1]
Browser [e.g. stock browser, safari]
Version [e.g. 22]

Additional context
Add any other context about the problem here.

[FEATURE] JRTB-5: As a user, I want to add the group to the subscription

As a user, I want to add the group to the subscription

Acceptance criteria:

/addGroupSub command added
tests for it created

[IMPROVEMENT]

** Describe your idea of the improvement **

[FEATURE] JRTB-1: Add repository layer

Add repository layer to the project.

Acceptance Criteria:

Flyway added
Schema for database added
Spring Data added
Entities added
H2 database for testing purposes added
integration tests for with h2 added

[FEATURE]

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[FEATURE] JRTB-3: Implement Command pattern for telegrambot

Implement Command pattern for telegram bot.

Acceptance criteria:

/start stub command added

[FEATURE] JRTB-2: add telegram bot to the project

Create stub telegram-bot for the project.

Acceptance criteria:

stub answer via telegram-bot added to the project

[FEATURE] JRTB-10: As an administrator, I want to see bot statistics

As an administrator, I want to see bot statistics.

Acceptance Criteria:

the ability to work with statistics only for administrators added
statistics by active users added
statistics by active group subscriptions added

[FEATURE] TB-13: implement deployment process via docker

Implement deployment process using docker image.

Acceptance criteria:

dockerfile added to the project.
deployment process with providing environment variables is added to the project.

[FEATURE]

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[FEATURE] JRTB-8: As a User, I want to set inactive using bot

As a User, I want to set inactive subscriptions

Acceptance criteria:

/stop command added

[FEATURE] JRTB-7: As a User, I want to remove group subscription from my subscriptions

As a User, I want to remove group subscription from my subscriptions

Acceptance criteria:

/removeGroupSub added

[FEATURE] JRTB-9: As a User, I want to start working with bot OR set active if I used it before

As a User, I want to start working with bot OR set active if I used it before

Acceptance criteria:

/start command added

[FEATURE] JRTB-0: create Sketelon Spring boot project

Create skeleton Spring boot project for JRTB.

Acceptance criteria:

Spring boot project created.

[BUG] last migration does not work

Describe the bug
The last migration (V00004_change_chat_Id_type_to_Long.sql) does not work.

To Reproduce
Steps to reproduce the behavior:
run migrations locally and check it in flyway schema table.

Expected, that this migration would be executed.

[FEATURE] JRTB-13: implement deployment process

Implement deployment process using docker image.

Acceptance criteria:

dockerfile added to the project.
deployment process with providing environment variables is added to the project.

[FEATURE] JRTB-12: Implement scheduling for sending notification about new articles

Description
The scheduling process for finding new articles for an active subscription must be followed by this workflow:

Acceptance Criteria:

find new articles workflow implemented as expected

[FEATURE] JRTB-11: As a user, I want to see documentation for this telegram bot

As a user, I want to see the documentation for this telegram bot.

Acceptance criteria:

/help command added

[FEATURE] JRTB-4: As a user, I want to get new articles no later than 20 minutes since the article was created

As a user, I want to get new articles no later than 20 minutes since the article was created.
For it, needs to be implemented Spring Scheduler.

Every 15 minutes the newly created service will :

find all active subscriptions(subscription, which linked to the active user)
find all new articles for active subscriptions
send new articles for users

Acceptance criteria:

Spring scheduler added to the project with task every 15 minutes
Logic for getting new articles added

The scheduling process for finding new articles for an active subscription must be followed by this workflow:

[QUESTION] JavaRushTelegramBotAplicationTests.java

Привет! Подскажи такой момент. Делал все по порядку, как в статьях на JavaRush, но на STEP-5, после заливки на GitHub билд отказывался собираться, проблема была в файле JavaRushTelegramBotAplicationTests.java. Проглядел твой репозиторий и не увидел там его, хотя изначально помню, что мы его пушили. Нужен ли он вообще?

[FEATURE] Implement deployment process

Imlement deployment process with using Docker.

Acceptance criteria:
*docker file added to the project
*deplyment process with providing environment variables is added to the project

[FEATURE] JRTB-6: As a user, I want to see list of my group subscriptions

As a user, I want to see list of my group subscriptions

Acceptance criteria:

/listGroupSub command added

javarushcommunity / javarush-telegrambot Goto Github PK

javarush-telegrambot's Introduction

Javarush Telegram Bot

Idea

MVP Scope

How it works

Find new posts workflow

Deployment

Local development

Technological stack

Code of Conduct

License

Contributions

javarush-telegrambot's People

Contributors

Stargazers

Watchers

Forkers

javarush-telegrambot's Issues

Recommend Projects

Recommend Topics

Recommend Org