It's not possible to close issue

About

@ghman_bot is a Telegram bot to work with Github notifications. Bot can notify you on new notification, user can view new unread notifications, put comments by replying to Telegram messages, mark notifications as read, close tickets, merge PRs, etc. To start working you don't need to create GitHub auth tokens manually, the bot is configured as GitHub application and it redirects user to GitHub OAuth page to request permissions on first interraction.

Usage

To start using the bot, just start talking with @ghman_bot via Telegram, the bot will ask you to authorize via Github using OAuth2, on Github OAuth page you will be asked to grant access to your notifications. After authorization you may start to use Telegram commands:

/notifications - to list all unread threads, you can click any thread to see new (unread) messages in the ticket or PR. When you reply to Telegram message with a thread (from /notifications) you're posting a comment to thread source (issue or PR), so you're responding to a message right in Telegram bot.

Contributing

If you're interested in contributing, you need to have an account in Zerocracy and read this document: https://github.com/g4s8/ghman/blob/master/CONTRIBUTING.md

If want to submit a bug read this and this.

To propose some changes you need to be assigned as a performer (DEV role) to some ticket. Then you have:

Fork the repo, clone it locally
Switch to branch for your issue, write a code, make sure it's building with mvn clean install -Pqulice command
Submit a pull request, check that CI passed, fix errors if not passed
Wait for code review, fix or discuss reviewer comments
Wait for architect to merge (architect may ask additional changes)
After merge to master ask issue author to close the ticket

Git guidelines:

start all commit message with tiket number, e.g.: #1 - some message (to avoid issues with comment char, check this answer: https://stackoverflow.com/a/14931661/1723695)
try to describe shortly your changes in commit message, long description should be provided in PR body
name your branches starting with ticket number, e.g. 1-some-bug branch for #1 ticket
use merge, not rebase when merging changes from master to local branch
one commit per change, don't rebase all commits into single one for PR
avoid push --force where possible, it can be used in rare cases, e.g. if you pushed binary file by mistake, then you can remove it with push --force or if you mistyped ticket number or message, you can fix it with push --force

To build and run tests locally you need >=jdk-8 and >=maven-3.*

	* @todo #7:30min Replace this static method with an inner class that
	* implements/extends JsonObject (depending on what is possible to do)
	* and that is responsible of doing what is done here. Do not forget about
	* unit test.

	* @todo #11:30mins Patterns in callback queries chains are distributed in
	* multiple classes: for example, pattern for close issue is given here and in
	* TkCloseIssue. Find a way to avoid this by maybe having string pattern
	* representation here and passing Matcher to telegram takes (TkCloseIssue) or
	* by having one class implementing Fork and containing both the current code
	* of TkCloseIssue and the creation of the FkCallbackQuery.

	* @todo #11:30mins 1) find a way to avoid using static method Integer.parseInt()
	* 2) there too much method chaining in Issue.Smart() instance creation. It's
	* hard to read and not very good in term of OO practice: we depend here on
	* many objects and we want to promote loose coupling usually. Find a way to
	* avoid it.

	* @todo #18:30min This class represents details about a user stored in
	* the database. Callers of PgUser.telegram relies on the datastructure
	* defined here and must know how it is structured to exploit the
	* information. Instead, extract interface from it and use it
	* everywhere it is needed instead of exposing this data. One
	* implementation is maybe based on Chat and another would be based on
	* a pg request for example. Add unit tests for both when it's done.

	* @todo #43:30min Introduce a meaningful abstraction for this. The
	* current implementation in the secondary constructor should reside in its
	* own class and there should be a Fake implementation for use in the tests.
	* Do not forget to correct unit test accordingly.

	* @todo #2:30mins Fix the ClassDataAbstractionCouplingCheck & PMD rule
	* exclusions in BotApp class

	* @todo #35:30min Implement Unit tests for this class
	* using junit, cactoos-matchers and fake class (no mocks).

	* @todo #1:30min Create new library with different data sources,
	* move this class and other DataSource implementations and add it
	* as dependency.

	* @todo #1:30min Move this class to g4s8/teletakes library:
	* submit PR, merge it and update dependency then.

	* @todo #2:30min Implement Unit tests for FbUnauthorized class
	* use JUNIT and cactoos-matchers wrapper.

	* @todo #9:30min Test for `Notification.UnreadThreads` should be
	* implemented after https://github.com/g4s8/teletakes/issues/14 is
	* resolved. Please, while implementing try to avoid using mocked objects,
	* use fake implementations instead.

	* @todo #1:30min Refactor this class:
	* extract additional classes for takes and pass, move
	* actual logic to these classes, keep only composition structure
	* in TkApp.

	* @todo #1:30min Refactor environment usage like APP_HOST, GH_CLIENT,
	* GH_SECRET, etc, in this class
	* and telegram classes, find a way to better configure these variables.

	* @todo #7:30min Continue implement this integration test: add cases for all
	* methods of {@link com.g4s8.ghman.data.PgUser} class. Do not forget about
	* all possible exceptions.

	* @todo #4:30min Implement unit tests for TkGitHubAuthorization. Refer
	* to takes framework Unit testing guide @ https://github.com/yegor256/takes#unit-testing

	@todo #8:30min Increase code coverage by
	writing unit tests. All coverage ratio minimums are
	supposed to be greater than 0.60. Classes missed count
	maximum is 8. When this goal is achieved ask ARC
	whether these minimums are enough.

	* @todo #26:30 In case `Sync.sync` throws an exception, this class should log
	* it instead of failing the whole synchronization process. Some thought must
	* be taken to apply the same principle to instances of `Sync` in case they do
	* multiple tasks.

	* @todo #9:30 Continue implement notifications for user when new messages
	* (unread github notification) arrive. To do that we need to monitor
	* unread notifications by constantly checking `threads` table for unread
	* threads. Schedule java thread (or any other synchronization process) to
	* periodically call `PgThreads#unread()` to retrieve unread messages and
	* use `Notification.UnreadThreads()` to send them.

	* @todo #41:30min Extract into a separate object the behaviour of creating the redirect URI
	* and test that exact complete string of the redirect uri is correct. After that unit test
	* for FkGitHubAuthRedirection can be replaced with integration one.

	* @todo #2:30min Implement Unit tests for TkThread class
	* * use JUNIT and cactoos-matchers wrapper.

	* @todo #1:30min Refactor this class:
	* move actual logic to separate takes and keep only
	* composition structure in this class.

	@todo #1:30min Configure qulice plugin and test coverage.
	Don't forget to exclude Cactoos compat classes,
	we need to remove them after Takes fixes.

	* @todo #4:30min replace those static loggers with something more OO
	* (Related with
	* https://www.yegor256.com/2019/03/19/logging-without-static-logger.html)

	* @todo #4:30min Implement unit tests for PsUserById.
	* Refer to takes framework Unit testing guide @ https://github.com/yegor256/takes#unit-testing

	* @todo #4:30min Replace the call to static method String.format
	* with the use of cactoos' text.Formatted class in all files.

	* @todo #2:30min Fix the ClassDataAbstractionCouplingCheck rule exclusion
	* in TkThread class. This class is too complex.

	* @todo #1:30min Extract interfaces and implement unit tests
	* with fake objects and integration tests with embedded postgres.

	* @todo #9:30min Now this class send only github subject title as
	* notification. Please aks ARC what exactly we want to send to user and
	* create a class to extract and format this information from `JsonObject`
	* (github subject) accordingly.

	* @todo #7:30min Create integration test: check all methods of this class and
	* do not forget about all possible exceptions.

g4s8 / ghman Goto Github PK

ghman's Introduction

About

Usage

Contributing

ghman's People

Contributors

Stargazers

Watchers

Forkers

ghman's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs

	* @todo #7:30min Find a way to get rid of static field and method of this
	* class. Note that this class is JUnit 5 Extension and is used to prepare
	* database to integration tests. See
	* https://junit.org/junit5/docs/current/user-guide/#extensions-registration-declarative

	* @todo #29:30min Instantiate this class and pass it to `TkSync`
	* (currently in `TkApp`) so that the behaviour of this class is
	* executed every 10 minutes when Heroku ntofify the app. Note
	* that this involves sharing the instance of BotSimple between
	* `TkApp` and `BotApp`.