lita-karma 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa005d01f58fb03aa07984d4441b9caa058d9598
-  data.tar.gz: 041ea5301d6b8190b847497e59489d58b860979d
+  metadata.gz: 6582ca790003f6b94e624a9b7d8fd81103ca5261
+  data.tar.gz: 7017b65d8c0a75a412fe15856771f5889c24729d
 SHA512:
-  metadata.gz: 14d8b05cf3a25c8bba3e6fd010d089915ac93982993497ccf34575a929c0dc580be77e74f7570db9d93521c416873df1db77c27d06347627dc320437cd5d25db
-  data.tar.gz: b0683a98f70347a1e16ddd58cab5d7c0b64d0d862bcb7e6db60a30468fddb4228b9fad9f9f9269c3afd509f4ef8e77c622bcfa9efd75edd8a0f50da3d1787afb
+  metadata.gz: ddc01d87d46b225edd96e5b899db22f8f21b420aba0d402a2bea691cf7dc031465a471235d808e7102e5e5dda647f6c302320383b5248cf82d498bceac53f806
+  data.tar.gz: 95020fb1b2c6fbfe7f83a089230af1bad2ed966470af53c08e72bc58724a5685f1a43baef08b3263faccf615be12ed6855e620bd7f24c987cae0bd87f659326b

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rspec
+before_install:
+  - gem update --system

data/README.md

@@ -1,5 +1,9 @@
 # lita-karma
 
+[![Build Status](https://travis-ci.org/jimmycuadra/lita-karma.png)](https://travis-ci.org/jimmycuadra/lita-karma)
+[![Code Climate](https://codeclimate.com/github/jimmycuadra/lita-karma.png)](https://codeclimate.com/github/jimmycuadra/lita-karma)
+[![Coverage Status](https://coveralls.io/repos/jimmycuadra/lita-karma/badge.png)](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
@@ -10,6 +14,16 @@ Add lita-karma to your Lita instance's Gemfile:
 gem "lita-karma"
 ```
 
+## Configuration
+
+lita-karma has one option, the cooldown, which 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. The default is 300 (5 minutes). Set it to `nil` to disable rate limiting.
+
+```
+Lita.configure do |config|
+  config.handlers.karma.cooldown = 600
+end
+```
+
 ## Usage
 
 Lita will add a karma point whenever it hears a term upvoted:
@@ -32,6 +46,12 @@ term~~
 
 To list the top scoring terms:
 
+```
+Lita: karma best
+```
+
+or simply:
+
 ```
 Lita: karma
 ```
@@ -58,7 +78,7 @@ bar++
 Lita: foo += bar
 > bar has been linked to foo.
 foo~~
-> foo: 2
+> foo: 2 (1), linked to: bar: 1
 bar~~
 > bar: 1
 Lita: foo -= bar
@@ -67,6 +87,8 @@ 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.
+
 ## License
 
 [MIT](http://opensource.org/licenses/MIT)

data/lib/lita/handlers/karma.rb

@@ -6,9 +6,12 @@ module Lita
       route %r{([^\s]{2,})\+\+}, to: :increment
       route %r{([^\s]{2,})\-\-}, to: :decrement
       route %r{([^\s]{2,})~~}, to: :check
-      route %r{karma}, to: :list, command: true
-      route %r{([^\s]{2,})\s*\+=\s*([^\s]{2,})}, to: :link, command: true
-      route %r{([^\s]{2,})\s*-=\s*([^\s]{2,})}, to: :unlink, command: true
+      route %r{^karma\s+worst}, to: :list_worst, command: true
+      route %r{^karma\s+best}, to: :list_best, command: true
+      route %r{^karma\s+modified}, to: :modified, command: true
+      route %r{^karma\s*$}, to: :list_best, command: true
+      route %r{^([^\s]{2,})\s*\+=\s*([^\s]{2,})}, to: :link, command: true
+      route %r{^([^\s]{2,})\s*-=\s*([^\s]{2,})}, to: :unlink, command: true
 
       def increment(matches)
         modify(matches, 1)
@@ -23,39 +26,31 @@ module Lita
 
         matches.each do |match|
           term = match[0]
-          score = redis.zscore("terms", term).to_i
+          own_score = score = redis.zscore("terms", term).to_i
+          links = []
           redis.smembers("links:#{term}").each do |link|
-            score += redis.zscore("terms", link).to_i
+            link_score = redis.zscore("terms", link).to_i
+            links << "#{link}: #{link_score}"
+            score += link_score
           end
-          output << "#{term}: #{score}"
+
+          string = "#{term}: #{score}"
+          unless links.empty?
+            string << " (#{own_score}), linked to: "
+            string << links.join(", ")
+          end
+          output << string
         end
 
         reply *output
       end
 
-      def list(matches)
-        redis_command = case args.first
-        when "worst"
-          :zrange
-        else
-          :zrevrange
-        end
-
-        n = (args[1] || 5).to_i - 1
-
-        terms_scores = redis.public_send(
-          redis_command, "terms", 0, n, with_scores: true
-        )
-
-        output = terms_scores.each_with_index.map do |term_score, index|
-          "#{index + 1}. #{term_score[0]} (#{term_score[1].to_i})"
-        end.join("\n")
+      def list_best(matches)
+        list(:zrevrange)
+      end
 
-        if output.length == 0
-          reply "There are no terms being tracked yet."
-        else
-          reply output
-        end
+      def list_worst(matches)
+        list(:zrange)
       end
 
       def link(matches)
@@ -82,21 +77,69 @@ module Lita
         end
       end
 
+      def modified(matches)
+        term = args[1]
+
+        if term.nil? || term.strip.empty?
+          reply "Format: #{robot.name}: karma modified TERM"
+          return
+        end
+
+        user_ids = redis.smembers("modified:#{term}")
+
+        if user_ids.empty?
+          reply "#{term} has never been modified."
+        else
+          reply user_ids.map { |id| User.find_by_id(id).name }.join(", ")
+        end
+      end
+
       private
 
       def modify(matches, delta)
-        output = []
-
         matches.each do |match|
           term = match[0]
-          score = redis.zincrby("terms", delta, term).to_i
-          output << "#{term}: #{score}"
+
+          ttl = redis.ttl("cooldown:#{user.id}:#{term}")
+          if ttl >= 0
+            cooldown_message =
+              "You cannot modify #{term} for another #{ttl} second"
+            cooldown_message << (ttl == 1 ? "." : "s.")
+            reply cooldown_message
+          else
+            redis.zincrby("terms", delta, term)
+            redis.sadd("modified:#{term}", user.id)
+            cooldown = Lita.config.handlers.karma.cooldown
+            if cooldown
+              redis.setex("cooldown:#{user.id}:#{term}", cooldown.to_i, 1)
+            end
+          end
         end
 
-        reply *output
+        check(matches)
+      end
+
+      def list(redis_command)
+        n = (args[1] || 5).to_i - 1
+
+        terms_scores = redis.public_send(
+          redis_command, "terms", 0, n, with_scores: true
+        )
+
+        output = terms_scores.each_with_index.map do |term_score, index|
+          "#{index + 1}. #{term_score[0]} (#{term_score[1].to_i})"
+        end.join("\n")
+
+        if output.length == 0
+          reply "There are no terms being tracked yet."
+        else
+          reply output
+        end
       end
     end
 
+    Lita.config.handlers.karma = Config.new
+    Lita.config.handlers.karma.cooldown = 300
     Lita.register_handler(Karma)
   end
 end

data/lita-karma.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-karma"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["Jimmy Cuadra"]
   spec.email         = ["jimmy@jimmycuadra.com"]
   spec.description   = %q{A Lita handler for tracking karma points for arbitrary terms.}
@@ -13,9 +13,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "lita", "~> 0.0.1"
+  spec.add_runtime_dependency "lita", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", ">= 2.14.0rc1"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
 end

data/spec/lita/handlers/karma_spec.rb

@@ -1,166 +1,188 @@
 require "spec_helper"
 
-describe Lita::Handlers::Karma, lita_handler: true do
+describe Lita::Handlers::Karma, lita: true do
+  before { Lita.config.handlers.karma.cooldown = nil }
+
   it { routes("foo++").to(:increment) }
   it { routes("foo--").to(:decrement) }
   it { routes("foo~~").to(:check) }
-  it { routes("#{robot.name}: karma").to(:list) }
+  it { routes("#{robot.name}: karma best").to(:list_best) }
+  it { routes("#{robot.name}: karma worst").to(:list_worst) }
+  it { routes("#{robot.name}: karma modified").to(:modified) }
+  it { routes("#{robot.name}: karma").to(:list_best) }
   it { routes("#{robot.name}: foo += bar").to(:link) }
   it { routes("#{robot.name}: foo -= bar").to(:unlink) }
 
-  let(:source) { an_instance_of(Lita::Source) }
-
   describe "#increment" do
     it "increases the term's score by one and says the new score" do
-      expect(robot).to receive(:send_messages).with(source, "foo: 1")
+      expect_reply("foo: 1")
       send_test_message("foo++")
     end
 
     it "matches multiple terms in one message" do
-      expect(robot).to receive(:send_messages).with(source, "foo: 1", "bar: 1")
+      expect_replies("foo: 1", "bar: 1")
       send_test_message("foo++ bar++")
     end
 
     it "doesn't start from zero if the term already has a positive score" do
-      allow(robot).to receive(:send_messages)
       send_test_message("foo++")
-      expect(robot).to receive(:send_messages).with(source, "foo: 2")
+      expect_reply("foo: 2")
+      send_test_message("foo++")
+    end
+
+    it "replies with a warning if term increment is on cooldown" do
+      Lita.config.handlers.karma.cooldown = 10
+      send_test_message("foo++")
+      expect_reply(/cannot modify foo/)
       send_test_message("foo++")
     end
   end
 
   describe "#decrement" do
     it "decreases the term's score by one and says the new score" do
-      expect(robot).to receive(:send_messages).with(source, "foo: -1")
+      expect_reply("foo: -1")
       send_test_message("foo--")
     end
 
     it "matches multiple terms in one message" do
-      expect(robot).to receive(:send_messages).with(
-        source,
-        "foo: -1",
-        "bar: -1"
-      )
+      expect_replies("foo: -1", "bar: -1")
       send_test_message("foo-- bar--")
     end
 
     it "doesn't start from zero if the term already has a positive score" do
-      allow(robot).to receive(:send_messages)
       send_test_message("foo++")
-      expect(robot).to receive(:send_messages).with(source, "foo: 0")
+      expect_reply("foo: 0")
+      send_test_message("foo--")
+    end
+
+    it "replies with a warning if term increment is on cooldown" do
+      Lita.config.handlers.karma.cooldown = 10
+      send_test_message("foo--")
+      expect_reply(/cannot modify foo/)
       send_test_message("foo--")
     end
   end
 
   describe "#check" do
     it "says the term's current score" do
-      expect(robot).to receive(:send_messages).with(source, "foo: 0")
+      expect_reply("foo: 0")
       send_test_message("foo~~")
     end
 
     it "matches multiple terms in one message" do
-      expect(robot).to receive(:send_messages).with(
-        source,
-        "foo: 0",
-        "bar: 0"
-      )
+      expect_replies("foo: 0", "bar: 0")
       send_test_message("foo~~ bar~~")
     end
   end
 
   describe "#list" do
-    before do
-      allow(robot).to receive(:send_messages)
-      send_test_message(
-        "one++ one++ one++ two++ two++ three++ four++ four-- five--"
-      )
+    it "replies with a warning if there are no terms" do
+      expect_reply(/no terms being tracked/)
+      send_test_message("#{robot.name}: karma")
     end
 
-    it "lists the top 5 terms by default" do
-      expect(robot).to receive(:send_messages).with source, <<-MSG.chomp
+    context "with modified terms" do
+      before do
+        send_test_message(
+          "one++ one++ one++ two++ two++ three++ four++ four-- five--"
+        )
+      end
+
+      it "lists the top 5 terms by default" do
+        expect_reply <<-MSG.chomp
 1. one (3)
 2. two (2)
 3. three (1)
 4. four (0)
 5. five (-1)
 MSG
-      send_test_message("#{robot.name}: karma")
-    end
+        send_test_message("#{robot.name}: karma")
+      end
 
-    it 'lists the bottom 5 terms when passed "worst"' do
-      expect(robot).to receive(:send_messages).with source, <<-MSG.chomp
+      it 'lists the bottom 5 terms when passed "worst"' do
+        expect_reply <<-MSG.chomp
 1. five (-1)
 2. four (0)
 3. three (1)
 4. two (2)
 5. one (3)
 MSG
-      send_test_message("#{robot.name}: karma worst")
-    end
+        send_test_message("#{robot.name}: karma worst")
+      end
 
-    it "limits the list to the count passed as the second argument" do
-      expect(robot).to receive(:send_messages).with source, <<-MSG.chomp
+      it "limits the list to the count passed as the second argument" do
+        expect_reply <<-MSG.chomp
 1. one (3)
 2. two (2)
 MSG
-      send_test_message("#{robot.name}: karma best 2")
+        send_test_message("#{robot.name}: karma best 2")
+      end
     end
   end
 
   describe "#link" do
     it "says that it's linked term 2 to term 1" do
-      expect(robot).to receive(:send_messages).with(
-        source,
-        "bar has been linked to foo."
-      )
+      expect_reply("bar has been linked to foo.")
       send_test_message("#{robot.name}: foo += bar")
     end
 
     it "says that term 2 was already linked to term 1 if it was" do
-      allow(robot).to receive(:send_messages)
       send_test_message("#{robot.name}: foo += bar")
-      expect(robot).to receive(:send_messages).with(
-        source,
-        "bar is already linked to foo."
-      )
+      expect_reply("bar is already linked to foo.")
       send_test_message("#{robot.name}: foo += bar")
     end
 
     it "causes term 1's score to be modified by term 2's" do
-      allow(robot).to receive(:send_messages)
-      send_test_message("foo++ bar++")
+      send_test_message("foo++ bar++ baz++")
       send_test_message("#{robot.name}: foo += bar")
-      expect(robot).to receive(:send_messages).with(source, "foo: 2")
+      send_test_message("#{robot.name}: foo += baz")
+      expect_reply("foo: 3 (1), linked to: baz: 1, bar: 1")
       send_test_message("foo~~")
     end
   end
 
   describe "#unlink" do
     it "says that it's unlinked term 2 from term 1" do
-      allow(robot).to receive(:send_messages)
       send_test_message("#{robot.name}: foo += bar")
-      expect(robot).to receive(:send_messages).with(
-        source,
-        "bar has been unlinked from foo."
-      )
+      expect_reply("bar has been unlinked from foo.")
       send_test_message("#{robot.name}: foo -= bar")
     end
 
     it "says that term 2 was not linked to term 1 if it wasn't" do
-      expect(robot).to receive(:send_messages).with(
-        source,
-        "bar is not linked to foo."
-      )
+      expect_reply("bar is not linked to foo.")
       send_test_message("#{robot.name}: foo -= bar")
     end
 
     it "causes term 1's score to stop being modified by term 2's" do
-      allow(robot).to receive(:send_messages)
       send_test_message("foo++ bar++")
       send_test_message("#{robot.name}: foo += bar")
       send_test_message("#{robot.name}: foo -= bar")
-      expect(robot).to receive(:send_messages).with(source, "foo: 1")
+      expect_reply("foo: 1")
       send_test_message("foo~~")
     end
   end
+
+  describe "#modified" do
+    it "replies with the required format if a term is not provided" do
+      expect_reply(/^Format:/)
+      send_test_message("#{robot.name}: karma modified")
+    end
+
+    it "replies with the required format if the term is an empty string" do
+      expect_reply(/^Format:/)
+      send_test_message("#{robot.name}: karma modified '   '")
+    end
+
+    it "replies with a message if the term hasn't been modified" do
+      expect_reply(/never been modified/)
+      send_test_message("#{robot.name}: karma modified foo")
+    end
+
+    it "lists users who have modified the given term" do
+      allow(Lita::User).to receive(:find_by_id).and_return(user)
+      send_test_message("foo++")
+      expect_reply(user.name)
+      send_test_message("#{robot.name}: karma modified foo")
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,10 @@
-require "lita-karma"
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
 
+require "lita-karma"
 require "lita/rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-karma
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-15 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 2.14.0rc1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Lita handler for tracking karma points for arbitrary terms.
 email:
 - jimmy@jimmycuadra.com
@@ -74,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile