lita-karma 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa005d01f58fb03aa07984d4441b9caa058d9598
+  data.tar.gz: 041ea5301d6b8190b847497e59489d58b860979d
+SHA512:
+  metadata.gz: 14d8b05cf3a25c8bba3e6fd010d089915ac93982993497ccf34575a929c0dc580be77e74f7570db9d93521c416873df1db77c27d06347627dc320437cd5d25db
+  data.tar.gz: b0683a98f70347a1e16ddd58cab5d7c0b64d0d862bcb7e6db60a30468fddb4228b9fad9f9f9269c3afd509f4ef8e77c622bcfa9efd75edd8a0f50da3d1787afb

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,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# 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"
+```
+
+## Usage
+
+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~~
+```
+
+To list the top scoring terms:
+
+```
+Lita: karma
+```
+
+To list the worst scoring terms:
+
+```
+Lita: karma worst
+```
+
+These commands will list 5 terms by default. To specify a number, pass a second argument to the karma command:
+
+```
+Lita: karma best 10
+```
+
+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
+bar~~
+> bar: 1
+Lita: foo -= bar
+> bar has been unlinked from foo.
+foo~~
+> foo: 1
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

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

data/lib/lita-karma.rb

@@ -0,0 +1 @@
+require "lita/handlers/karma"

data/lib/lita/handlers/karma.rb

@@ -0,0 +1,102 @@
+require "lita"
+
+module Lita
+  module Handlers
+    class Karma < Handler
+      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
+
+      def increment(matches)
+        modify(matches, 1)
+      end
+
+      def decrement(matches)
+        modify(matches, -1)
+      end
+
+      def check(matches)
+        output = []
+
+        matches.each do |match|
+          term = match[0]
+          score = redis.zscore("terms", term).to_i
+          redis.smembers("links:#{term}").each do |link|
+            score += redis.zscore("terms", link).to_i
+          end
+          output << "#{term}: #{score}"
+        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")
+
+        if output.length == 0
+          reply "There are no terms being tracked yet."
+        else
+          reply output
+        end
+      end
+
+      def link(matches)
+        matches.each do |match|
+          term1, term2 = match
+
+          if redis.sadd("links:#{term1}", term2)
+            reply "#{term2} has been linked to #{term1}."
+          else
+            reply "#{term2} is already linked to #{term1}."
+          end
+        end
+      end
+
+      def unlink(matches)
+        matches.each do |match|
+          term1, term2 = match
+
+          if redis.srem("links:#{term1}", term2)
+            reply "#{term2} has been unlinked from #{term1}."
+          else
+            reply "#{term2} is not linked to #{term1}."
+          end
+        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}"
+        end
+
+        reply *output
+      end
+    end
+
+    Lita.register_handler(Karma)
+  end
+end

data/lita-karma.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-karma"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jimmy Cuadra"]
+  spec.email         = ["jimmy@jimmycuadra.com"]
+  spec.description   = %q{A Lita handler for tracking karma points for arbitrary terms.}
+  spec.summary       = %q{A Lita handler for tracking karma points for arbitrary terms.}
+  spec.homepage      = "https://github.com/jimmycuadra/lita-karma"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", "~> 0.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14.0rc1"
+end

data/spec/lita/handlers/karma_spec.rb

@@ -0,0 +1,166 @@
+require "spec_helper"
+
+describe Lita::Handlers::Karma, lita_handler: true do
+  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}: 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")
+      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")
+      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")
+      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")
+      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"
+      )
+      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")
+      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")
+      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"
+      )
+      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--"
+      )
+    end
+
+    it "lists the top 5 terms by default" do
+      expect(robot).to receive(:send_messages).with source, <<-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
+
+    it 'lists the bottom 5 terms when passed "worst"' do
+      expect(robot).to receive(:send_messages).with source, <<-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
+
+    it "limits the list to the count passed as the second argument" do
+      expect(robot).to receive(:send_messages).with source, <<-MSG.chomp
+1. one (3)
+2. two (2)
+MSG
+      send_test_message("#{robot.name}: karma best 2")
+    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."
+      )
+      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."
+      )
+      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("#{robot.name}: foo += bar")
+      expect(robot).to receive(:send_messages).with(source, "foo: 2")
+      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."
+      )
+      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."
+      )
+      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")
+      send_test_message("foo~~")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "lita-karma"
+
+require "lita/rspec"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: lita-karma
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jimmy Cuadra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0rc1
+description: A Lita handler for tracking karma points for arbitrary terms.
+email:
+- jimmy@jimmycuadra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-karma.rb
+- lib/lita/handlers/karma.rb
+- lita-karma.gemspec
+- spec/lita/handlers/karma_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jimmycuadra/lita-karma
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Lita handler for tracking karma points for arbitrary terms.
+test_files:
+- spec/lita/handlers/karma_spec.rb
+- spec/spec_helper.rb
+has_rdoc: