cinch-cooldown 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cinch-cooldown.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Haberer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Cinch::Cooldown
+
+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
+
+Coming Soon. :)
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cinch-cooldown.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cinch-cooldown/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cinch-cooldown"
+  gem.version       = Cinch::Cooldown::VERSION
+  gem.authors       = ["Brian Haberer"]
+  gem.email         = ["bhaberer@gmail.com"]
+  gem.description   = %q{This gem allows you to set a shared timer across plugins that are configured to respect it.}
+  gem.summary       = %q{Global Cooldown tracker for Cinch Plugins}
+  gem.homepage      = "https://github.com/bhaberer/cinch-cooldown"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'cinch-toolbox'
+end

data/lib/cinch-cooldown.rb

@@ -0,0 +1,83 @@
+require 'cinch-cooldown/version'
+require 'cinch-toolbox'
+
+module Cinch
+  module Plugin
+    module ClassMethods
+      def enforce_cooldown
+        hook(:pre, :for => [:match], :method => lambda {|m| cooldown_finished?(m)})
+      end
+
+      def reset_cooldown(m)
+         # TODO
+      end
+    end
+
+    def cooldown_finished?(m)
+      return true unless shared[:cooldown] && shared[:cooldown][:config]
+      synchronize(:cooldown) do
+        return true if m.channel.nil?
+
+        channel = m.channel.name
+        nick = m.user.nick
+
+        return true unless shared[:cooldown][:config][channel]
+
+        unless shared[:cooldown].key?(channel)
+          shared[:cooldown][channel] = { 'global' => Time.now, nick => Time.now }
+          return true
+        end
+
+        if channel_cooldown_finished?(channel)
+          # Global cd is up, check per user
+          if shared[:cooldown][channel].key?(nick)
+            # User's in the config, check time
+            if user_cooldown_finished?(channel, nick)
+              shared[:cooldown][channel]['global'] = Time.now
+              shared[:cooldown][channel][nick] = Time.now
+              return true
+            end
+          else
+            # User's not used bot before
+            shared[:cooldown][channel][nick] = Time.now
+            shared[:cooldown][channel]['global'] = Time.now
+            return true
+          end
+        end
+
+        message = "Sorry, you'll have to wait "
+        unless channel_cooldown_finished?(channel)
+          message << "#{Cinch::Toolbox.time_format(channel_time_remaining(channel))} before I can talk in the channel again, and "
+        end
+        message << "#{Cinch::Toolbox.time_format(user_time_remaining(channel, nick))} before your nick can use any commands."
+
+        m.user.notice message
+        return false
+      end
+    end
+
+    def user_cooldown_finished?(chan, user)
+      shared[:cooldown][:config][chan]['user']   < user_time_elapsed(chan, user)
+    end
+
+    def channel_cooldown_finished?(chan)
+      shared[:cooldown][:config][chan]['global'] < channel_time_elapsed(chan)
+    end
+
+    def channel_time_remaining(chan)
+      shared[:cooldown][:config][chan]['global'] - channel_time_elapsed(chan)
+    end
+
+    def user_time_remaining(chan, user)
+      shared[:cooldown][:config][chan]['user'] - user_time_elapsed(chan, user)
+    end
+
+    def channel_time_elapsed(chan)
+      (Time.now - shared[:cooldown][chan]['global']).floor
+    end
+
+    def user_time_elapsed(chan, user)
+      (Time.now - shared[:cooldown][chan][user]).floor
+    end
+  end
+end

data/lib/cinch-cooldown/version.rb

@@ -0,0 +1,5 @@
+module Cinch
+  module Cooldown
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: cinch-cooldown
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Haberer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch-toolbox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem allows you to set a shared timer across plugins that are configured
+  to respect it.
+email:
+- bhaberer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cinch-cooldown.gemspec
+- lib/cinch-cooldown.rb
+- lib/cinch-cooldown/version.rb
+homepage: https://github.com/bhaberer/cinch-cooldown
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Global Cooldown tracker for Cinch Plugins
+test_files: []