lita-poll 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a511e94ce5c62bb96ceeb489ca3fcafe84c327d6
+  data.tar.gz: 304e9b757437ca92237a4589bb2090a146687508
+SHA512:
+  metadata.gz: 05caa1b67b770a5b0aa074d7be02a98f9c7dab2db87ab740c082577c0236e31860ddd642a1c601af0d2672ea8c86a472db65df51745f783222e0c9fa41042d9b
+  data.tar.gz: d14b14a7d66890fb64bf00d3d7d2f807ef958d419aea69cca6937e8b9afc7121720f2279c1fb117667a70ef1411bde9ed27d0b8ac74de73f78f02df4d9aabada

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/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Michael Chua
+
+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,14 @@
+# lita-poll
+
+Plugin that enables polling functionality for a lita bot.
+
+## Installation
+
+Add lita-poll to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-poll"
+```
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita/handlers/poll.rb

@@ -0,0 +1,51 @@
+require "json"
+require "digest/sha1"
+
+class Poll
+  ID_LEN = 3
+  ID_REGEXP = "(\\w{#{ID_LEN}})"
+  def initialize(topic, id=nil, options=nil, votes=nil)
+    @topic = topic
+    @id = id.nil? ? Digest::SHA1.hexdigest(topic).slice(0, ID_LEN) : id
+    @options = options.nil? ? [] : options
+    @votes = votes.nil? ? {} : votes
+  end
+
+  def topic
+    return @topic
+  end
+
+  def id
+    return @id
+  end
+
+  def options
+    return @options
+  end
+
+  def votes
+    return @votes
+  end
+
+  def set_option(opt)
+    @options.push(opt)
+  end
+
+  def valid_vote(optNum)
+    optNum-1 < @options.length
+  end
+
+  def vote(user, optNum)
+    @votes[user.id] = optNum
+  end
+
+  def to_json(*args)
+  {
+    "id" => @id, "topic" => @topic, "options" => @options, "votes" => @votes
+  }.to_json(*args)
+  end
+
+  def self.json_create(o)
+    new(o["topic"], o["id"], o["options"], o["votes"])
+  end
+end

data/lib/lita/handlers/pollHandler.rb

@@ -0,0 +1,151 @@
+require "json"
+require "lita/handlers/poll"
+
+module Lita
+  module Handlers
+    class PollHandler < Handler
+      route /^poll list$/, :list, help: {
+        t("help.list.usage") => t("help.list.description")
+      }
+      def list(response)
+        ids = redis.keys('*')
+        if ids.empty?
+          response.reply(t("replies.list.no_polls"))
+        else
+          response.reply(t("replies.list.header"))
+          redis.keys('*').each do |id|
+            poll = Poll.json_create(JSON.parse(redis.get(id)))
+            response.reply(t("replies.list.poll", poll_id: poll.id, poll_topic: poll.topic))
+          end
+        end
+      end
+
+      route /^poll clear$/, :clear, help: {
+        t("help.clear.usage") => t("help.clear.description")
+      }, restrict_to: "poll_admins"
+      def clear(response)
+        redis.flushdb
+        response.reply(t("replies.clear.success"))
+      end
+
+      route /^poll make (.+)$/, :make, help: {
+        t("help.make.usage") => t("help.make.description")
+      }, restrict_to: "poll_admins"
+      def make(response)
+        made = Poll.new(response.matches.pop[0])
+        redis.set(made.id, made.to_json)
+        response.reply(t("replies.make.success", poll_id: made.id, poll_topic: made.topic))
+      end
+
+      route Regexp.new("^poll option #{Poll::ID_REGEXP} (.+)$"), :option, help: {
+        t("help.option.usage") => t("help.option.description")
+      }
+      def option(response)
+        args = response.matches.pop
+        id = args[0]
+        poll = redis.get(id)
+        option = args[1]
+        if poll.nil?
+          response.reply(t("replies.general.poll_not_found", id: id))
+        else
+          poll = Poll.json_create(JSON.parse(poll))
+          poll.set_option(option)
+          redis.set(poll.id, poll.to_json)
+          response.reply(t("replies.option.success", option: option, poll_id: poll.id))
+        end
+      end
+
+      route Regexp.new("poll info #{Poll::ID_REGEXP}$"), :info, help: {
+        t("help.info.usage") => t("help.info.description")
+      }
+      def info(response)
+        args = response.matches.pop
+        id = args[0]
+        poll = redis.get(id)
+        if poll.nil?
+          response.reply(t("replies.general.poll_not_found", id: id))
+        else
+          poll = Poll.json_create(JSON.parse(poll))
+          idx = 0
+          response.reply(t("replies.info.header", poll_topic: poll.topic))
+          every(1) do |timer|
+            if idx >= poll.options.length
+              timer.stop
+            else
+              option = poll.options[idx]
+              idx += 1
+              response.reply(t("replies.info.option", idx: idx, option: option))
+            end
+          end
+        end
+      end
+
+      route Regexp.new("^poll vote #{Poll::ID_REGEXP} (\\d+)$"), :vote, help: {
+        t("help.vote.usage") => t("help.vote.description")
+      }
+      def vote(response)
+        args = response.matches.pop
+        id = args[0]
+        optNum = args[1].to_i
+        poll = redis.get(id)
+        if poll.nil?
+          response.reply(t("replies.general.poll_not_found", id: id))
+        else
+          poll = Poll.json_create(JSON.parse(poll))
+          if poll.valid_vote(optNum)
+            poll.vote(response.user, optNum)
+            redis.set(poll.id, poll.to_json)
+            response.reply_privately(t(
+              "replies.vote.success", option: poll.options[optNum-1]
+            ))
+          else
+            response.reply_privately(t("replies.vote.not_found"))
+          end
+        end
+      end
+
+      route Regexp.new("^poll tally #{Poll::ID_REGEXP}$"), :tally, help: {
+        t("help.tally.usage") => t("help.tally.description")
+      }
+      def tally(response)
+        args = response.matches.pop
+        id = args[0]
+        poll = redis.get(id)
+        if poll.nil?
+          response.reply(t("replies.general.poll_not_found", id: id))
+        else
+          tally = []
+          poll = Poll.json_create(JSON.parse(poll))
+          poll.votes.each do |user, vote|
+            vote = vote-1
+            tally[vote] = tally[vote] ? tally[vote]+1 : 1
+          end
+
+          idx = 0
+          response.reply(t("replies.tally.header"))
+          every(1) do |timer|
+            if idx >= poll.options.length
+              timer.stop
+            else
+              option = poll.options[idx]
+              response.reply(t(
+                "replies.tally.option", option: option, votes: tally[idx] ? tally[idx] : 0
+              ))
+              idx += 1
+            end
+          end
+        end
+      end
+
+      route Regexp.new("^poll complete #{Poll::ID_REGEXP}$"), :complete, help: {
+        t("help.complete.usage") => t("help.complete.description")
+      }, restrict_to: "poll_admins"
+      def complete(response)
+        redis.del(response.matches.pop[0])
+        response.reply(t("replies.complete.success"))
+      end
+    end
+
+    Lita.register_handler(PollHandler)
+  end
+end

data/lib/lita-poll.rb

@@ -0,0 +1,7 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/pollHandler"

data/lita-poll.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-poll"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Michael Chua"]
+  spec.email         = ["chua.mbt@gmail.com"]
+  spec.summary       = %q{Plugin that enables polling functionality for a lita bot.}
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+  spec.homepage      = "https://github.com/chua-mbt/lita-poll"
+
+  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", ">= 3.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

@@ -0,0 +1,53 @@
+en:
+  lita:
+    handlers:
+      poll_handler:
+        help:
+          list:
+            usage: "poll list"
+            description: "List existing polls"
+          clear:
+            usage: "poll clear"
+            description: "Clear existing polls"
+          make:
+            usage: "poll make [topic]"
+            description: "Create a new poll on [topic]"
+          option:
+            usage: "poll option [pollId] [option]"
+            description: "Add [option] to poll with [pollId]"
+          info:
+            usage: "poll info [pollId]"
+            description: "Shows information on poll with [pollId]"
+          vote:
+            usage: "poll vote [pollId] [optNum]"
+            description: "Vote for [optNum] on poll with [pollId]"
+          tally:
+            usage: "poll tally [pollId]"
+            description: "Tally poll with [pollId]"
+          complete:
+            usage: "poll complete [pollId]"
+            description: "End poll with [pollId]"
+        replies:
+          general:
+            poll_not_found: "Poll with id '%{id}' not found."
+          list:
+            no_polls: "No polls currently exist."
+            header: "Active polls:"
+            poll: "%{poll_id} : %{poll_topic}"
+          clear:
+            success: "All polls cleared."
+          make:
+            success: "Poll on '%{poll_topic}' created with id '%{poll_id}'."
+          option:
+            success: "New option '%{option}' for poll '%{poll_id}'!"
+          info:
+            header: "Topic: %{poll_topic}"
+            option: "%{idx} : %{option}"
+          vote:
+            not_found: "Selected option does not exist for specified poll."
+            success: "Vote for '%{option}' registered."
+          tally:
+            header: "Tallied votes:"
+            option: "%{option} : %{votes}"
+          complete:
+            success: "Poll removed."

data/spec/lita/handlers/poll_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Lita::Handlers::Poll, lita_handler: true do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "lita-poll"
+require "lita/rspec"

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: lita-poll
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Chua
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !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: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- chua.mbt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-poll.rb
+- lib/lita/handlers/poll.rb
+- lib/lita/handlers/pollHandler.rb
+- lita-poll.gemspec
+- locales/en.yml
+- spec/lita/handlers/poll_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chua-mbt/lita-poll
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Plugin that enables polling functionality for a lita bot.
+test_files:
+- spec/lita/handlers/poll_spec.rb
+- spec/spec_helper.rb