Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimmycuadra/lita-karma
A Lita handler for tracking karma points for arbitrary terms.
https://github.com/jimmycuadra/lita-karma
chatops fun lita lita-handler ruby
Last synced: about 2 months ago
JSON representation
A Lita handler for tracking karma points for arbitrary terms.
- Host: GitHub
- URL: https://github.com/jimmycuadra/lita-karma
- Owner: jimmycuadra
- License: mit
- Created: 2013-04-28T10:15:53.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-11-05T08:57:48.000Z (about 4 years ago)
- Last Synced: 2024-09-29T15:15:57.264Z (3 months ago)
- Topics: chatops, fun, lita, lita-handler, ruby
- Language: Ruby
- Size: 153 KB
- Stars: 22
- Watchers: 3
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lita-karma
[](https://travis-ci.org/jimmycuadra/lita-karma)
[](https://codeclimate.com/github/jimmycuadra/lita-karma)
[](https://coveralls.io/r/jimmycuadra/lita-karma)
**lita-karma** is a handler for [Lita](https://github.com/jimmycuadra/lita) that tracks karma points for arbitrary terms. It listens for upvotes and downvotes and keeps a tally of the scores for them in Redis.
## Installation
Add lita-karma to your Lita instance's Gemfile:
``` ruby
gem "lita-karma"
```
## Configuration
### Optional attributes
* **cooldown** (`Integer`, `nil`) - Controls how long a user must wait after modifying a term before they can modify it again. The value should be an integer number of seconds. Set it to `nil` to disable rate limiting. Default: `300` (5 minutes).
* **link_karma_threshold** (`Integer`, `nil`) - Controls how many points a term must have before it can be linked to other terms or before terms can be linked to it. Treated as an absolute value, so it applies to both positive and negative karma. Set it to `nil` to allow all terms to be linked regardless of karma. Default: `10`.
* **term_pattern** (`Regexp`) - Determines what Lita will recognize as a valid term for tracking karma. Default: `/[\[\]\p{Word}\._|\{\}]{2,}/`.
* **term_normalizer** (`#call`) - A custom callable that determines how each term will be normalized before being stored in Redis. The proc should take one argument, the term as matched via regular expression, and return one value, the normalized version of the term. Default: turns the term into a string, downcases it, and strips whitespace off both ends.
### Example
This example configuration sets the cooldown to 10 minutes and changes the term pattern and normalization to allow multi-word terms bounded by `<>` or `:`, as previous versions of lita-karma did by default.
``` ruby
Lita.configure do |config|
config.handlers.karma.cooldown = 600
config.handlers.karma.term_pattern = /[<:][^>:]+[>:]/
config.handlers.karma.term_normalizer = lambda do |term|
term.to_s.downcase.strip.sub(/[<:]([^>:]+)[>:]/, '\1')
end
end
```
## Usage
### Giving Karma
Lita will add a karma point whenever it hears a term upvoted:
```
term++
```
It will subtract a karma point whenever it hears a term downvoted:
```
term--
```
To check the current karma for a term without modifying it:
```
term~~
```
### Listing Karma
To list the top scoring terms:
```
Lita: karma best
```
or simply:
```
Lita: karma
```
To list the worst scoring terms:
```
Lita: karma worst
```
The list commands will list 5 terms by default. To specify a number (no greater than 25), pass a second argument to the karma command:
```
Lita: karma best 10
```
### Linking Terms
You can also link terms together. This adds one term's karma to another's whenever it is displayed. A link is uni-directional and non-destructive. You can unlink terms at any time.
```
foo++
> foo: 1
bar++
> bar: 1
Lita: foo += bar
> bar has been linked to foo.
foo~~
> foo: 2 (1), linked to: bar: 1
bar~~
> bar: 1
Lita: foo -= bar
> bar has been unlinked from foo.
foo~~
> foo: 1
```
When a term is linked, the total karma score is displayed first, followed by the score of the term without its linked terms in parentheses.
### Modification lists
To get a list of the users who have upvoted or downvoted a term:
```
Lita: karma modified foo
> Joe, Amy
```
### Deleting Terms
To permanently delete a term and all its links:
```
Lita: karma delete TERM
```
Note that when deleting a term, the term will be matched exactly as typed, including leading whitespace (the single space after the word "delete" is not counted) and other patterns which would not normally match as a valid term. This can be useful if you decide to change the term pattern or normalization and want to clean up previous data that is no longer valid. Deleting a term requires the user to be a member of the `:karma_admins` authorization group.
## License
[MIT](http://opensource.org/licenses/MIT)