0.01
No commit activity in last 3 years
No release in over 3 years
This gem allows you to set a shared timer across plugins that are configured to respect it.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 0.1, >= 0.1.1
~> 12.3.3
~> 3

Runtime

~> 2
~> 1.0, >= 1.0.1
 Project Readme

Note: As of v1.2.0 the config changed to use symbols for the channel names, please be aware.

Cinch::Cooldown

Gem Version Dependency Status Build Status Code Climate Test Coverage Issue Count

This library is used to add a global cooldown so that users are prevented from spamming the channel.

Installation

Add this line to your application's Gemfile:

gem 'cinch-cooldown'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cinch-cooldown

Usage

Configuration Steps:

  1. You need to add the configuration to your bot in the config block. You will need to add config info for every channel the bot is in that you want a cooldown. The :global is how many seconds the bot will wait before listening to a command that prints something to the channel, while the :user directive is how long it will wait per user. Currently the gem is simple and assumes that the user timer will be greater than the global timer.

    c.shared[:cooldown] = { :config => { bottest: { global: 10, user: 20 } } }

  2. If you are using this with my plugins, things should just work. However if you want to use this with your own plugins, you need to add a 'require cinch/cooldown' to the top of said plugin, and an enforce_cooldown to the plugin after the include Cinch::Plugin line.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request