kibibit / achievibit Goto Github PK

k1b1b0t - bot for reporting on achievements

FEATURE

k1b1b0t will post on Telegram and Slack to notify users on received achievements. This can be used by groups (organizations or individuals) to share notifications on achievements.

Example Scenarios

• an organization with X people, using slack. They can have several bots, posting on R&D statuses (build, tests, etc.). You can have k1b1b0t in a group like that, or a group that is less production oriented and more development oriented.
• a bunch of friendly developers open a group on Slack\Telegram and mock each other on bad achievements, and complimenting on good once?

These are just examples, but you can take our achievibit group on Telegram as an example.

What can k1b1b0t do?

• k1b1b0t can subscribe specific channels\groups to notifications on specific users. It will send a "banner" of achievement unlocked when a user recieves an achievement.
• k1b1b10t can also subscribe a channel\group to a daily summary of users total achievements
• k1b1b0t should be charming and cool. we should try and give him some super powers

Additional Information

I already implemented a basic bot for Telegram. We can use that as a base and integrate it inside our Heroku server.
Telegram Node.js API: https://github.com/yagop/node-telegram-bot-api
Greate Tutorial on Node.js library: https://github.com/hosein2398/node-telegram-bot-api-tutorial
Slack Node.js library for bots: https://www.npmjs.com/package/slackbots

both bots should be using a webhook and not pulling

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Version 2.2.23 of mongodb just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As mongodb is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

This is pretty hard, since I really prefer to get someone to join as an open source collaborator instead of paying someone everytime we need new graphics (we want everything to have the same style)

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

as GitHub requires for their integration page

not sure if we should do milestones yet, but we can when we do this

Will allow us to connect accumulative achievements to milestone assignment and project assignment :-)

google search console + google analytics

FEATURE

need to add robots.txt file + finish optimizing google search console recommendations

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

SEED FOR VERSION 2

FEATURE

achievibit's build system should be pretty basic.

We need the following things:

• a watch system to restart the server on file changes automatically
• maybe a setup function to start a mongodb instance locally (so developers can just start testing their achievements)
• a function to reset the local mongodb achievibit db to start from scratch easily

Should include:

• Nest for server side inside src/server folder
• Jest unit tests
• All the original achievements from V1

So we can start working on other implementations

#currently, let's stick to the simple ones (without saving any treasure (data)).
Try and give a description, a name, and an avatar that references to some pop-culture or geek culture thing. Something that people know, or you want people to know about :-)

Here is my suggestions:

• if the reviewer also committed to the pull request he's reviewing :-) (example: lending a helping hand = some reference to a handjob :-P) - Done
• If every commit inside the pull request passed tests (green status) - Done

or whatever you want :-) just talk to me before to check if it's doable or if you want a reminder on what data we're collecting on each PR

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

API GET ALL REPO\ORGANIZATION\PR ACHIEVEMENTS

FEATURE

This should be pretty similar to #160

we should add a way to get all Repository \ Organization \ Pull Requests related achievements.
Here is what I'm thinking (and why):

• /achievements/:user:/ - get all achievements of a specific user (all repos)
• /achievements/:user:/:repo:/ - get all achievements of a specific repo
• /achievements/:user:/:repo:/:pr_id: - get all achievements of a specific pull request

[NOTICE]: if the user is an organization, get achievements based on organization and not the organization user (for all team members)

This will allow us to add these later for some achievement SWAG:

• get SVG Badge of all achievements of a specific user (all repos) (user bio or personal website \ cv)
• get SVG Badge of all achievements of a specific repo (show on a repo's README.md)
• get SVG Badge of all achievements of a specific pull request [SVG] (added by us in a pull request comment when it is merged)
• get SVG Badge of all achievements of a specific organization (all repos) (for organization swag :-))

RAW paths should be implemented as well since we would be able to use the data itself. in a future kibibit cli for example, we can show achievements when a feature is merged.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Implement user properties: level \ exp \ lives \ penalties and rewards

FEATURE

This should be done after we gain parity with V1

this is what I'm thinking right now, but this is an open discussion.

• each user starts at level 1, with 0 exp, and 3 lives
• you gain experience for each "good" achievement you get (X points)
• you lose a life for each "bad" achievement you get
• when you lose all 3 lives, you get down a level
• every time you max the exp for your current level, you level up
• every time you level up, your lives reset
• some times you can get temporary extra hearts (opened a new project, etc)
• accumulative achievements should get more exp for larger achievements

There is a $5 open bounty on this issue. Add to the bounty at Bountysource.

Currently, on the code review webhooks, there's an event called review_request_removed, but there's not enough data on it to know which reviewer was removed

I email GitHub about it and I'll continue implementing that event once they deal with this issue

ADD HUB-FLOW

DEV-FEATURE

Explanation about HubFlow: http://datasift.github.io/gitflow/IntroducingGitFlow.html
Explanation of the local development process: http://datasift.github.io/gitflow/GitFlowForGitHub.html

The only problem right now is that whoever takes this needs to add support to two-factor authentication to hub-flow's repo

Save Pull Request data to DB for a period

FEATURE

Heroku keeps resetting dynos every now and then and we lose data on PRs that are open for a long time.

We should keep PR data in a table that deletes stale data (PR that haven't been updated for other a month or whatever we agree on :-)), or just finished.

When we get a webhook event from GitHub, we'll fetch the PR data from the database and update it with the new delta

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Webhook Manager Module

FEATURE

This should be the path to get webhooks from different cloud version control platforms. Basically, it's just an orchestrator for the Version Control Engines.

it should:

• load all VCE (aka Version Control Engines)
• on each webhook request, run the VCE identifier (which will return true if the correct engine to use was found)
• on each webhook request, run the VCE translator to translate raw PR data from the cloud version control platform, to PR type achievibit uses
• on each webhook request, update the PR data, and on merge, also call the AchievementsService to grant achievements accordingly.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

a pull request that is merged without a reviewer confirming

DEPENDENCY ACHIEVEMENTS

FEATURE

create two different achievements:

• add dependency achievement
• remove dependency achievement

can also create dev-dependency achievements if you want to (can be a different feature)

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

We want to add the functionality of a typical data fetch to get the latest data

We should use
http://lightningtgc.github.io/material-refresh/

Something that implements material refresh with scroll to refresh on mobile, and a button on web

SUPPORT SSL

FEATURE

Self explanatory. Already implemented on PR #112

There's a problem with repository insertion to users. the DB returns an error and the achievements aren't being given to the user.

Take that into consideration. I'll try and fix this one later today or at the weekend

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

☝️ Greenkeeper’s updated Terms of Service will come into effect on April 6th, 2018.

Version 2.84.0 of request was just published.

This version is covered by your current version range and after updating it in your project the build failed.

request is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

Need to run solution suggested here:
https://stackoverflow.com/q/39492587/1788884

Version 1.16.1 of body-parser just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As body-parser is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

when adding Achievibit to another repo and trying to add Achievibit's url as a webhook, I get to following error:
this doesn't look like a valid URL
it can be fixed by prefixing the url with http://

sorry about this uber-minor nit pick.

alongside the assignee mechanism

Version 3.4.0 of mocha just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As mocha is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

Version 2.2.16 of ngrok just got published.

This version is covered by your current version range and after updating it in your project the build failed.

ngrok is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

achievibit's build system should be pretty basic.

We need the following things:

• a watch system to restart the server on file changes automatically
• maybe a setup function to start a mongodb instance locally (so developers can just start testing their achievements)
• a function to reset the local mongodb achievibit db to start from scratch easily

@ortichon tell me if you're up for one of those.

USER PROFILE TEMPLATE ERROR

BUG

When moving from swig to nunjucks, I forgot to fix some differences between the two syntaxes in the user profile template

some sort of zelda \ pokemon text and setting up timezone and integrations

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

☝️ Greenkeeper’s updated Terms of Service will come into effect on April 6th, 2018.

Version 3.1.1 of nunjucks was just published.

This version is covered by your current version range and after updating it in your project the build failed.

nunjucks is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

this is what I'm thinking right now, but this is an open discussion.

• each user starts at level 1, with 0 exp, and 3 lives
• you gain experience for each "good" achievement you get (X points)
• you lose a life for each "bad" achievement you get
• when you lose all 3 lives, you get down a level
• every time you max the exp for your current level, you level up
• every time you level up, your lives reset
• some times you can get temporary extra hearts (opened a new project, etc)
• accumulative achievements should get more exp for larger achievements

Send updates to clients based on web sockets

FEATURE

For a logged in user:

• open a socket to listen to user events and show an achievement banner when a user gets an achievement
• for future features: remove a heart or add a heart to the user lives, or notify the client on additional trophies and XP

for anonymous users:

• on specific user pages, get updates on that user to refresh the staled data
• same for organizations
• for now, the homepage should not listen to any web sockets for anonymous users

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

oAuth (with future proofing)

FEATURE

We want to implement oAuth in version 2.0 of achievibit.

Basically, this is the functionality we want:

• User can login with GitHub | GitLab | BitBucket using nest+passport

  we can use passport strategies for GitHub, GitLab, & BitBucket
  more strategies can be found here

• User is stored to a separate table that holds authenticated users (which is different than users who got achievements but never logged in)
• User can login with multiple services at the same time. Identifier should be the email address which is unique (at least the primary AFAIK)

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

similar to Optimus Prime, this achievement is given when a pull request id is only made out of at least 2 '6':

So:
id: 6 won't get the achievement

But 66, 666, and so on, will.

please write unit tests for this achievement. Unit tests are located in the test folder and should cover isSequenceOfSixes(number) and getting the achievement. should cover both success and failure scenarios (look at other files for examples)

achievement image names should be camelCase of the achievement name.

Reference

It's a Tenacious D reference to the movie The Pick of Destiny. Usually, the metadata is as follows:

name: the name of the achievement. Usually a quote or word-play on a pop-culture reference
short: additional pop-culture one-liner
description: mainly tells the user why he got the achievement. It should be informative but can also contain fun references :-)

So here, I would suggest the following (to be in line with the Tenacious D references):

name: I'm the devil I love metal

image: https://goo.gl/images/vy384p

short: There's two option I'm suggesting: either the quote of the next line in the song: "Check this riff, it's fucking tasty" or the quote the devil says at the start of the song: "I AM COMPLETE!"

description:

your pull request id (<id_number>) summoned the devil himself!

I hope that code you submitted was a masterpiece, or you're gonna gargle mayonnaise

Thses are only suggestions. If you have a better name, short, or description, go ahead :-)

RECENT ACHIEVEMENTS

FEATURE

For the organization page, I want to add a "Recent Achievements" section that will show the latest 5 or 10 achievements users from that organization got.

Basically, it should receive an organization name as a parameter, and query the database to get that organization data, then, search all the users in that organization for all of their achievements, **sorted by createdOn, and return the 5 or 10 first achievements (last received)

API GET ALL PR ACHIEVEMENTS

FEATURE

we should add a way to get all pull request related achievements.
Here is what I'm thinking (and why):

• /achievements/:repo_owner:/ - get all achievements of a specific owner (all repos)
• /achievements/:repo_owner:/:repo:/ - get all achievements of a specific repo
• /achievements/:repo_owner:/:repo:/:pr_id: - get all achievements of a specific pull request
• /achievements/:repo_owner:/:repo:/:pr_id:/:username:/ - get all achievements of a specific pull request of a specific user

maybe we can have it this way:

• /achievements/:repo_owner:/ - get all achievements of a specific owner (all repos) [SVG] (user bio or personal website \ cv)
• /achievements/:repo_owner:/:repo:/ - get all achievements of a specific repo [SVG] (show on a repo's README.md)
• /achievements/:repo_owner:/:repo:/:pr_id: - get all achievements of a specific pull request [SVG] (show in a pull request comment)
• /achievements/:repo_owner:/:repo:/:pr_id:/:username:/ - get all achievements of a specific pull request of a specific user [SVG] (show in user site)
• /raw/achievements/:repo_owner:/ - get all achievements of a specific owner (all repos) [SVG] (user bio or personal website \ cv)
• /raw/achievements/:repo_owner:/:repo:/ - get all achievements of a specific repo [JSON]
• /raw/achievements/:repo_owner:/:repo:/:pr_id: - get all achievements of a specific pull request [JSON]
• /raw/achievements/:repo_owner:/:repo:/:pr_id:/:username:/ - get all achievements of a specific pull request of a specific user [JSON]

RAW paths can be used for the data itself. in a future kibibit cli for example, we can show achievements when a feature is merged.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

IMPLEMENT GIT FLOW

FEATURE

create a develop branch and start moving the new animations into the application itself to start preparing for an eye candy launch to the github marketplace

IMPLEMENT GIT FLOW

FEATURE

create a develop branch and start moving the new animations into the application itself to start preparing for an eye candy launch to the github marketplace

I'm hoping to finish the kibibit-cli to enforce some git flow rules in an easy way (instead of saying lots of rules in the CONTRIBUTING.MD file about git flow, we'll simply ask users to use the cli which will be installed with this repo)

Basically this will help us keep changelogs and update with release versions

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

a pull request is fixing a bug /major issue

i think we can use handy from happy tree friends
https://superawesomevectors.com/wp-content/uploads/2018/02/handy-happy-tree-friends-vector-800x566.jpg

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

It gives the achievement even if you only have 1 commit without anything in it. Makes it really easy to achieve,

Should consider making it for at least 2 commits in a PR maybe,

Not sure if this is a bug, but wanted to communicate this issue.

here are all the events that we can listen to.

They're pretty much the same as GitHub. We need to check if we can support the same events achieibit already listens to.

Some design points

Here's what we need

• a way to map GitHub's, GitLab's and BitBucket's data into an achievibit data type (for unity)
• a way to map GitHub's, GitLab's and BitBucket's event names into achievibit events
• a way to map the location of the data in each system. for example, GitHub event names are placed in headers.x-github-event while GitLab event names are placed in headers.x-gitlab-event
• a function that gets achievibit's event name and data and saves the new data to the accumulative data

Suggestions:

Interfaces

• WebhookEvent - enum of all the events achievibit supports
• WebhookData - a data structure that unifies GitHub, GitLab, and BitBucket webhook data structures to a single achievibit interface

Decorators

• @WebhookMapper(lodashSelector: string) - takes a specific path inside the request object to map to the correct parameter. this allows the event and data parameter to be mapped to the correct paths

Pipes

• WebhookEventPipe(engine: string) - gets the data from the @WebhookMapper decorator, and transforms that data to achievibit's data, based on the given engine

Example

should work something like this:

  handleWebhooksEvents(
    @WebhookMapper('headers.x-github-event', new WebhookEventPipe('GitHub')) event: WebhookEvent,
   @WebhookMapper('body', new WebhookEventPipe('GitHub')) eventData: WebhookData) {
    // this function will use the achievibit data interface instead of the original one
  }

you can also create a class that inherits the custom decorators for specific engines:

  handleGitHubWebhooksEvents(@GitHubEvent() event: WebhookEvent, @GitHubData() eventData: WebhookData) {
    // this function will use the achievibit data interface instead of the original one
  }

then, based on the provider, the post endpoint will select which WebhookEvents handler to use (implemented inside the engine itself)

This should cover all the basics and minimize breakage on code change in the future

@ortichon @dunaevsky - After I'll create a testing framework, you can write some of the tests if you like.

If the testing framework will be straightforward enough, it shouldn't be that hard :-)

for github integrations that are in the marketplace, you can add a name to your webhook instead of the default "web" one.

This will allow us to delete integration easier (no need for the webhook id) and more.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

BUG OR FEATURE NAME

FEATURE || BUG (keep only relevant sub-header)

describe your bug \ feature

try and add details as needed. think that someone else needs to understand what you want without being inside your head

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

Your Greenkeeper Bot 🌴