cinch-cooldown 1.0.0 → 1.0.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -1,5 +1,9 @@
 # Cinch::Cooldown
 
+[![Gem Version](https://badge.fury.io/rb/cinch-cooldown.png)](http://badge.fury.io/rb/cinch-cooldown)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-cooldown.png)](https://gemnasium.com/bhaberer/cinch-cooldown)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-cooldown.png?branch=master)](https://travis-ci.org/bhaberer/cinch-cooldown)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-cooldown/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-cooldown?branch=master)
 [![Code Climate](https://codeclimate.com/github/bhaberer/cinch-cooldown.png)](https://codeclimate.com/github/bhaberer/cinch-cooldown)
 
 This library is used to add a global cooldown so that users are prevented from spamming the

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/cinch-cooldown.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cinch-cooldown/version'
+require 'cinch/cooldown/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "cinch-cooldown"
@@ -17,5 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency('time-lord', '>= 1.0.1')
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'cinch-test'
+
+  gem.add_dependency    'time-lord',      '~> 1.0.1'
+  gem.add_dependency    'cinch',          '~> 2.0.5'
 end

data/lib/{cinch-cooldown.rb → cinch/cooldown.rb}

@@ -1,4 +1,4 @@
-require 'cinch-cooldown/version'
+require 'cinch/cooldown/version'
 require 'time-lord'
 
 module Cinch
@@ -7,10 +7,6 @@ module Cinch
       def enforce_cooldown
         hook(:pre, :for => [:match], :method => lambda {|m| cooldown_finished?(m)})
       end
-
-      def reset_cooldown
-         # TODO
-      end
     end
 
     def cooldown_finished?(m)
@@ -18,7 +14,7 @@ module Cinch
       return true unless shared[:cooldown] && shared[:cooldown][:config]
       synchronize(:cooldown) do
         # return if we don't have a channel (i.e. user is pming the bot)
-        return false if m.channel.nil?
+        return true if m.channel.nil?
 
         channel = m.channel.name
         user    = m.user.nick
@@ -41,9 +37,9 @@ module Cinch
     def configuration_broken?(channel)
       # return if the config doesn't smell right for this channel
       return true unless shared[:cooldown][:config].key?(channel) &&
-                         shared[:cooldown][:config][channel].key?(:global) &&
-                         shared[:cooldown][:config][channel].key?(:user)
-
+                         config_for(channel).key?(:global) &&
+                         config_for(channel).key?(:user)
+      false
     end
 
     def first_run?(channel, user)
@@ -70,6 +66,7 @@ module Cinch
           return true
         end
       end
+      return false
     end
 
     def cooldown_message(channel, user)
@@ -89,23 +86,35 @@ module Cinch
     end
 
     def cooldown_channel_expire_time(channel)
-      shared[:cooldown][channel][:global] + shared[:cooldown][:config][channel][:global]
+      global_cooldown_for(channel) + config_for(channel)[:global]
     end
 
     def cooldown_user_expire_time(channel, user)
-      shared[:cooldown][channel][user] + shared[:cooldown][:config][channel][:user]
+      user_cooldown_for(channel, user) + config_for(channel)[:user]
     end
 
     def user_cooldown_finished?(channel, user)
-      cooldown  = shared[:cooldown][:config][channel][:user]
-      elapsed   = Time.now - shared[:cooldown][channel][user]
-      return cooldown < elapsed
+      cooldown  = config_for(channel)[:user]
+      elapsed   = Time.now - user_cooldown_for(channel, user)
+      return cooldown <= elapsed
     end
 
     def channel_cooldown_finished?(channel)
-      cooldown  = shared[:cooldown][:config][channel][:global]
-      elapsed   = Time.now - shared[:cooldown][channel][:global]
-      return cooldown < elapsed
+      cooldown  = config_for(channel)[:global]
+      elapsed   = Time.now - global_cooldown_for(channel)
+      return cooldown <= elapsed
+    end
+
+    def config_for(chan)
+      shared[:cooldown][:config][chan]
+    end
+
+    def global_cooldown_for(chan)
+      shared[:cooldown][chan][:global] ||= Time.now
+    end
+
+    def user_cooldown_for(chan, nick)
+      shared[:cooldown][chan][nick] || Time.now
     end
   end
 end

data/lib/{cinch-cooldown → cinch/cooldown}/version.rb

@@ -1,5 +1,5 @@
 module Cinch
   module Cooldown
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/spec/cinch-cooldown_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+class MyPlugin
+  include Cinch::Plugin
+
+  enforce_cooldown
+
+  match /thing/
+  def execute(m)
+    m.reply 'OMG'
+  end
+end
+
+def bot_for_cooldowns(global = 10, user = 0)
+  @bot = Cinch::Test::MockBot.new do
+           configure do |c|
+             c.nick = 'testbot'
+             c.server = nil
+             c.channels = ['foo']
+             c.reconnect = false
+             c.plugins.plugins = [MyPlugin]
+             c.shared[:cooldown] = { :config => { '#foo' => { :global => global, :user => user } } }
+           end
+         end
+end
+
+describe Cinch::Cooldown do
+  include Cinch::Test
+
+  it 'should not trigger cooldowns on private messages' do
+    @bot = bot_for_cooldowns(10)
+    get_replies(make_message(@bot, "!thing"))
+    get_replies(make_message(@bot, "!thing")).first.text.
+      should match "OMG"
+  end
+
+  it 'should allow plugins to mandate a global cooldown between responses in channel' do
+    @bot = bot_for_cooldowns(10)
+    get_replies(make_message(@bot, "!thing", channel: '#foo'))
+    get_replies(make_message(@bot, "!thing", channel: '#foo')).first.text.
+      should match(/Sorry, you'll have to wait \d+ seconds from now before I can talk/)
+  end
+
+  it 'should allow plugins allow responses after the global cooldown' do
+    @bot = bot_for_cooldowns(5)
+    get_replies(make_message(@bot, "!thing", channel: '#foo'))
+    sleep 5
+    get_replies(make_message(@bot, "!thing", channel: '#foo')).first.text.
+      should == 'OMG'
+  end
+
+  it 'should allow plugins to mandate a minimum time between responses in channel' do
+    @bot = bot_for_cooldowns(5, 10)
+    get_replies(make_message(@bot, "!thing", channel: '#foo'))
+    sleep 6
+    get_replies(make_message(@bot, "!thing", channel: '#foo')).first.text.
+      should match(/Sorry, you'll have to wait \d+ seconds from now before you can use/)
+  end
+
+  it 'should allow plugins to mandate a minimum time between responses in channel' do
+    @bot = bot_for_cooldowns(5, 10)
+    get_replies(make_message(@bot, "!thing", channel: '#foo'))
+    sleep 10
+    get_replies(make_message(@bot, "!thing", channel: '#foo')).first.text.
+      should == 'OMG'
+  end
+
+  it 'should not trigger if the config for the current channel does not exist' do
+    @bot = bot_for_cooldowns(5, 10)
+    get_replies(make_message(@bot, "!thing", channel: '#bar'))
+    get_replies(make_message(@bot, "!thing", channel: '#bar')).first.text.
+      should == 'OMG'
+  end
+
+  it 'should trigger for other users if the global cooldown is not finished' do
+    @bot = bot_for_cooldowns(10, 20)
+    get_replies(make_message(@bot, "!thing", channel: '#foo', nick: 'test1')).first.text.
+      should == 'OMG'
+    get_replies(make_message(@bot, "!thing", channel: '#foo', nick: 'test2')).first.text.
+      should_not == 'OMG'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'cinch/cooldown'
+require 'cinch/test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-cooldown
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,78 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-24 00:00:00.000000000 Z
+date: 2013-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: time-lord
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cinch-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: time-lord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
@@ -24,9 +88,25 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
 description: This gem allows you to set a shared timer across plugins that are configured
   to respect it.
 email:
@@ -36,13 +116,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - cinch-cooldown.gemspec
-- lib/cinch-cooldown.rb
-- lib/cinch-cooldown/version.rb
+- lib/cinch/cooldown.rb
+- lib/cinch/cooldown/version.rb
+- spec/cinch-cooldown_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-cooldown
 licenses: []
 post_install_message: 
@@ -67,4 +150,7 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Global Cooldown tracker for Cinch Plugins
-test_files: []
+test_files:
+- spec/cinch-cooldown_spec.rb
+- spec/spec_helper.rb
+has_rdoc: