lita-debug-queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eaf323f4fe47b1aeb6cc87e98a4dc1cfd64a22a3
+  data.tar.gz: ebed6e0928f033f06802ee945d664cedeabeb63e
+SHA512:
+  metadata.gz: 3411f4a18feb9f082080bc3f7a87e59bdb8bec8a271309be6bcc09283864b0bbff001669b9c143a71a0bcc1284972a105b8eddc0e71e3b0bc613cf11995b07c4
+  data.tar.gz: 5f96eef0287d91c3933e32128ad499c267559bd445499cc2e33feae7ca02129dc0f58edce6acb9702bc0fcca543523db5cd1cab313b33d43a372f18db8aee539

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,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015, Brit Butler
+
+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,22 @@
+# lita-debug-queue
+
+Queue tracking of users who need debugging help with per-channel management.
+
+## Installation
+
+Add lita-debug-queue to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-debug-queue"
+```
+
+## Configuration
+
+lita-debug-queue expects two things to be present for correct operation:
+
+1. An `:instructors` authorization group containing admin users.
+2. A `classrooms` config option containing a Hash that maps instructor mention names to classroom channels.
+
+## Usage
+
+**TODO**

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-debug-queue.rb

@@ -0,0 +1,12 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/debug_queue"
+
+Lita::Handlers::DebugQueue.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lib/lita/handlers/debug_queue.rb

@@ -0,0 +1,85 @@
+module Lita
+  module Handlers
+    class DebugQueue < Handler
+      config :classrooms # A mapping from instructor names to classroom channels.
+
+      route(/^debug me$/, :add, command: true, help: { })
+      route(/^debug nvm$/, :cancel, command: true, help: { })
+      route(/^debug queue$/, :show, command: true, help: { })
+      route(/^debug count$/, :count, command: true, help: { })
+      route(/^debug next$/, :next, command: true, restrict_to: [:instructors],
+        help: { })
+      route(/^debug drop\s+(.+)$/, :drop, command: true, restrict_to: [:instructors],
+        help: { })
+      route(/^debug clear$/, :clear, command: true, restrict_to: [:instructors],
+        help: { })
+
+      def add(response)
+        return unless check_room!(response)
+        student = response.user.mention_name
+        if room_queue.include?(student)
+          response.reply("#{student}: Easy there killer. You're already on the list.")
+        else
+          redis.set(@room, room_queue.push(student))
+          response.reply("#{student}: Help is on the way.")
+        end
+      end
+
+      def cancel(response)
+        return unless check_room!(response)
+        student = response.user.mention_name
+        if room_queue.include?(student)
+          redis.set(@room, room_queue.reject{ |x| x == student })
+          response.reply("#{student}: Glad you figured it out! :)")
+        else
+          response.reply("#{student}: You know you're not in the queue, right?")
+        end
+      end
+
+      def show(response)
+        return unless check_room!(response)
+        response.reply("Queue for #{@room} => #{room_queue}")
+      end
+
+      def count(response)
+        return unless check_room!(response)
+        response.reply("Hackers seeking fresh eyes: #{room_queue.count}")
+      end
+
+      def next(response)
+        @room = config.classrooms[response.user.mention_name]
+        student = room_queue.pop
+        redis.set(@room, room_queue.reject { |x| x == student })
+        robot.send_message(response.user, "@#{student}: You're up! Let's debug :allthethings:")
+        response.reply("#{student} is up next and has been notified.")
+      end
+
+      def drop(response)
+        @room = config.classrooms[response.user.mention_name]
+        student = response.matches[0][0] # TODO: We could be safer here.
+        redis.set(@room, room_queue.reject { |x| x == student })
+        response.reply("#{student} has been removed from the queue.")
+      end
+
+      def clear(response)
+        @room = config.classrooms[response.user.mention_name]
+        redis.del(@room)
+        response.reply("Sounds like time for :beer: and ping pong!")
+      end
+
+      private
+      def check_room!(response)
+        @room = response.message.source.room
+        response.reply_privately("You must be in the class channel to send this message.") unless @room
+        @room
+      end
+
+      def room_queue
+        room = redis.get(@room)
+        room ? MultiJson.load(room) : []
+      end
+    end
+
+    Lita.register_handler(DebugQueue)
+  end
+end

data/lita-debug-queue.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-debug-queue"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Brit Butler"]
+  spec.email         = ["brit@kingcons.io"]
+  spec.description   = "Queue tracking of users who need debugging help with per-channel management"
+  spec.summary       = "A Lita handler for requesting debugging help"
+  spec.homepage      = "https://github.com/kingcons/lita-debug-queue"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  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", ">= 4.5"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      help_queue:

data/spec/lita/handlers/help_queue_spec.rb

@@ -0,0 +1,104 @@
+require "spec_helper"
+
+describe Lita::Handlers::DebugQueue, lita_handler: true do
+  let(:vedika) { Lita::User.create(456, mention_name: "vedika") }
+  let(:brit)   { Lita::User.create(789, mention_name: "brit") }
+  let(:dylan)  { Lita::User.create(123, mention_name: "dylan") }
+  let(:rails)  { Lita::Room.new("rails") }
+
+  ## Routes
+  it { is_expected.to route_command("debug me").to(:add) }
+  it { is_expected.to route_command("debug nvm").to(:cancel) }
+  it { is_expected.to route_command("debug queue").to(:show) }
+  it { is_expected.to route_command("debug count").to(:count) }
+  it { is_expected.to route_command("debug next").with_authorization_for(:instructors).to(:next) }
+  it { is_expected.to route_command("debug drop phteven").with_authorization_for(:instructors).to(:drop) }
+  it { is_expected.to route_command("debug clear").with_authorization_for(:instructors).to(:clear) }
+
+  ## General Commands
+  context "user commands" do
+    let(:ocaml)  { Lita::Room.new("ocaml") }
+
+    it "doesn't allow students to send messages outside the class channel" do
+      ["debug me", "debug nvm", "debug queue", "debug count"].each do |cmd|
+        send_command(cmd, as: dylan)
+        expect(replies.last).to start_with("You must be in the class channel")
+      end
+    end
+
+    it "allows students to queue themselves for help" do
+      send_command("debug me", as: dylan, from: rails)
+      expect(replies.last).to start_with("dylan: Help is on the way.")
+    end
+
+    it "doesn't allow students to queue themselves twice" do
+      send_command("debug me", as: dylan, from: rails)
+      send_command("debug me", as: dylan, from: rails)
+      expect(replies.last).to start_with("dylan: Easy there killer. You're already on the list.")
+    end
+
+    it "allows students to remove themselves if they figure it out" do
+      send_command("debug me", as: dylan, from: rails)
+      send_command("debug nvm", as: dylan, from: rails)
+      expect(replies.last).to start_with("dylan: Glad you figured it out! :)")
+    end
+
+    it "doesn't allow students to remove themselves if they aren't in the queue" do
+      send_command("debug nvm", as: dylan, from: rails)
+      expect(replies.last).to start_with("dylan: You know you're not in the queue, right?")
+    end
+
+    it "allows students to get an up to date count of people in that room's queue" do
+      send_command("debug me", as: vedika, from: rails)
+      send_command("debug count", from: rails)
+      expect(replies.last).to start_with("Hackers seeking fresh eyes: 1")
+
+      send_command("debug count", from: ocaml)
+      expect(replies.last).to start_with("Hackers seeking fresh eyes: 0")
+
+      send_command("debug me", as: dylan, from: rails)
+      send_command("debug count", from: rails)
+      expect(replies.last).to start_with("Hackers seeking fresh eyes: 2")
+
+      send_command("debug nvm", as: vedika, from: rails)
+      send_command("debug count", from: rails)
+      expect(replies.last).to start_with("Hackers seeking fresh eyes: 1")
+    end
+  end
+
+  context "instructor commands" do
+    before(:each) do
+      registry.config.handlers.debug_queue.classrooms = {
+        'brit' => 'rails'
+      }
+      @auth = Lita::Authorization.new(registry.config)
+      @auth.add_user_to_group!(brit, :instructors)
+    end
+
+    ## Instructor Commands
+    it "allows instructors to notify the next student and pop them from the queue" do
+      send_command("debug me", as: vedika, from: rails)
+      send_command("debug next", as: brit)
+      expect(replies.last).to start_with("vedika is up next and has been notified.")
+      send_command("debug count", from: rails)
+      expect(replies.last).to start_with("Hackers seeking fresh eyes: 0")
+    end
+
+    it "allows instructors to remove a student from the queue by name" do
+      send_command("debug me", as: dylan, from: rails)
+      send_command("debug drop dylan", as: brit)
+      expect(replies.last).to start_with("dylan has been removed from the queue.")
+      send_command("debug count", from: rails)
+      expect(replies.last).to start_with("Hackers seeking fresh eyes: 0")
+    end
+
+    it "allows instructors to clear the queue completely" do
+      send_command("debug me", as: vedika, from: rails)
+      send_command("debug me", as: dylan, from: rails)
+      send_command("debug clear", as: brit)
+      expect(replies.last).to start_with("Sounds like time for :beer: and ping pong!")
+      send_command("debug count", from: rails)
+      expect(replies.last).to start_with("Hackers seeking fresh eyes: 0")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-debug-queue"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: lita-debug-queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brit Butler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !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: pry-byebug
+  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: 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: rack-test
+  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: Queue tracking of users who need debugging help with per-channel management
+email:
+- brit@kingcons.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-debug-queue.rb
+- lib/lita/handlers/debug_queue.rb
+- lita-debug-queue.gemspec
+- locales/en.yml
+- spec/lita/handlers/help_queue_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/kingcons/lita-debug-queue
+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: A Lita handler for requesting debugging help
+test_files:
+- spec/lita/handlers/help_queue_spec.rb
+- spec/spec_helper.rb
+has_rdoc: