lita-debug-queue 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07d3467b72d42050bc85638eb4efcc6b237e6122
-  data.tar.gz: 3a9914697cdc2065ae953673ab7db7ab93433888
+  metadata.gz: 0a2e7ac111f8ab2cc860f5a352ef7c3465c63cdd
+  data.tar.gz: 32d4111430293f16a405becfdfd73088d8299ec7
 SHA512:
-  metadata.gz: acbbbbd4a746c67c08950c69fe0fd41a92d0a55114737c41fe39cd9e3150b32aacd28dcf8b77183a3368d16050eae19ceab5cc7e4fc907b22c592a990d9eacb9
-  data.tar.gz: fdc199e5e42b1757eada62cd1d6e3a23aefaecc77ff33f4b4d1ec3c089e7f235820b01f6ff0016c40b84d51a6a8e97dfa19cf4c0aa2c4f2f141cc17042cf01d7
+  metadata.gz: 344e268f20bfe2ea95479bc41d3dff57a53cf3cb631da42599db1c8be175e554aafc6cd876dd2d5e72a9a579b53fa04dc3e8fb55a46137990ddd421b9ce85f57
+  data.tar.gz: 50a448fca9c44c970f2b340806007e1919a21331f6a66c1cb1b2052173fc58115198b4668b88990217b908f72098965c1091a2432ab36752d2dc298594a104af

data/NEWS.md

@@ -1,5 +1,11 @@
 ## News
 
+### 0.1.2 (2015-08-31)
+
+* Add docstrings for built-in Lita help.
+* Fix inconsistency in the way the room is determined.
+* Fix student not being notified on instructor "debug next".
+
 ### 0.1.1 (2015-08-28)
 
 * Quick workaround for issue #44 in lita-slack.

data/lib/lita/handlers/debug_queue.rb

@@ -3,33 +3,37 @@ module Lita
     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 me$/, :add, command: true,
+        help: { 'debug me' => 'Put your name in the queue for debugging help.' })
+      route(/^debug nvm$/, :cancel, command: true,
+        help: { 'debug nvm' => 'Remove your name from the queue for debugging help.' })
+      route(/^debug queue$/, :show, command: true,
+        help: { 'debug queue' => 'Show the current queue for your class.' })
+      route(/^debug count$/, :count, command: true,
+        help: { 'debug count' => 'Count the number of people waiting for help.' })
       route(/^debug next$/, :next, command: true, restrict_to: [:instructors],
-        help: { })
+        help: { 'debug next' => 'Notify the next student to be helped.' })
       route(/^debug drop\s+(.+)$/, :drop, command: true, restrict_to: [:instructors],
-        help: { })
+        help: { 'debug drop NAME' => 'Remove the student with NAME from the queue.' })
       route(/^debug clear$/, :clear, command: true, restrict_to: [:instructors],
-        help: { })
+        help: { 'debug clear' => 'Empty the queue.' })
 
       def add(response)
         return unless check_room!(response)
         student = response.user.mention_name
-        if room_queue.include?(student)
+        if @room.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.")
+          @room.add(student)
+          response.reply("#{student}: Help is coming soon.")
         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 })
+        if @room.include?(student)
+          @room.remove(student)
           response.reply("#{student}: Glad you figured it out! :)")
         else
           response.reply("#{student}: You know you're not in the queue, right?")
@@ -38,48 +42,49 @@ module Lita
 
       def show(response)
         return unless check_room!(response)
-        response.reply("Queue for #{@room} => #{room_queue}")
+        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}")
+        response.reply("Hackers seeking fresh eyes: #{@room.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.")
+        return unless check_room!(response)
+        if @room.count.zero?
+          response.reply("The queue is empty. Sounds like you could use a break. :)")
+        else
+          student = @room.next
+          robot.send_message(student, "@#{student}: You're up. Let's debug :allthethings:!")
+          response.reply("#{student} is up next and has been notified.")
+        end
       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.")
+        return unless check_room!(response)
+        student = response.args[1]
+        if @room.include?(student)
+          @room.remove(student)
+          response.reply("#{student} has been removed from the queue.")
+        else
+          response.reply("#{student} is not in the queue for #{@room}!")
+        end
       end
 
       def clear(response)
-        @room = config.classrooms[response.user.mention_name]
-        redis.del(@room)
+        return unless check_room!(response)
+        @room.clear!
         response.reply("Sounds like time for :beer: and ping pong!")
       end
 
       private
+
       def check_room!(response)
-        # KLUDGE: The following is a gross hack as the current room_object is incorrect.
-        # See lita-slack Issue #44
-        @room = Lita::Room.find_by_id(response.message.source.room).name
+        @room = RoomFinder.for(config.classrooms, response, redis)
         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)

data/lib/lita/handlers/room_finder.rb

@@ -0,0 +1,23 @@
+module Lita
+  module Handlers
+    class RoomFinder
+      def self.for(rooms, response, redis)
+        sender = response.user.mention_name
+        room = response.message.source.room_object
+        if rooms.has_key?(sender)
+          name = rooms[sender]
+          RoomQueue.new(name, redis)
+        elsif room
+          name = self.get_room_name(room)
+          RoomQueue.new(name, redis)
+        end
+      end
+
+      # KLUDGE: The following is a hack as the current room_object is incorrect. (lita-slack issue #44)
+      def self.get_room_name(room)
+        # KLUDGE: And this conditional is a hack since the test rooms are mocked.
+        room.id == room.name ? room.name : Lita::Room.find_by_id(room.id).name(room)
+      end
+    end
+  end
+end

data/lib/lita/handlers/room_queue.rb

@@ -0,0 +1,41 @@
+module Lita
+  module Handlers
+    class RoomQueue
+      def initialize(name, redis)
+        @name = name
+        @redis = redis
+      end
+
+      def queue
+        data = @redis.get(@name)
+        data ? MultiJson.load(data) : []
+      end
+
+      def count
+        self.queue.length
+      end
+
+      def include?(student)
+        self.queue.include?(student)
+      end
+
+      def add(student)
+        @redis.set(@name, self.queue.push(student))
+      end
+
+      def remove(student)
+        @redis.set(@name, self.queue.reject { |x| x == student })
+      end
+
+      def next
+        student = self.queue.pop
+        @redis.set(@name, self.queue.reject { |x| x == student })
+        student
+      end
+
+      def clear!
+        @redis.del(@name)
+      end
+    end
+  end
+end

data/lib/lita-debug-queue.rb

@@ -4,6 +4,8 @@ Lita.load_locales Dir[File.expand_path(
   File.join("..", "..", "locales", "*.yml"), __FILE__
 )]
 
+require "lita/handlers/room_finder"
+require "lita/handlers/room_queue"
 require "lita/handlers/debug_queue"
 
 Lita::Handlers::DebugQueue.template_root File.expand_path(

data/lita-debug-queue.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-debug-queue"
-  spec.version       = "0.1.1"
+  spec.version       = "0.1.2"
   spec.authors       = ["Brit Butler"]
   spec.email         = ["brit@kingcons.io"]
   spec.description   = "Queue tracking of users who need debugging help with per-channel management"

data/spec/lita/handlers/help_queue_spec.rb

@@ -5,6 +5,13 @@ describe Lita::Handlers::DebugQueue, lita_handler: true do
   let(:brit)   { Lita::User.create(789, mention_name: "brit") }
   let(:dylan)  { Lita::User.create(123, mention_name: "dylan") }
   let(:rails)  { Lita::Room.new("rails") }
+  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
 
   ## Routes
   it { is_expected.to route_command("debug me").to(:add) }
@@ -15,40 +22,39 @@ describe Lita::Handlers::DebugQueue, lita_handler: true do
   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
+  context "a general user" do
     let(:ocaml)  { Lita::Room.new("ocaml") }
 
-    it "doesn't allow students to send messages outside the class channel" do
+    it "can't 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
+    it "can 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.")
+      expect(replies.last).to start_with("dylan: Help is ")
     end
 
-    it "doesn't allow students to queue themselves twice" do
+    it "can't 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
+    it "can 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
+    it "can't 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
+    it "can 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")
@@ -66,17 +72,13 @@ describe Lita::Handlers::DebugQueue, lita_handler: true do
     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)
+  context "an instructor" do
+    it "doesn't need to say messages in channel since their classroom is known" do
+      send_command("debug count", as: brit)
+      expect(replies.last).to start_with("Hackers seeking fresh eyes: 0")
     end
 
-    ## Instructor Commands
-    it "allows instructors to notify the next student and pop them from the queue" do
+    it "can 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.")
@@ -84,7 +86,7 @@ describe Lita::Handlers::DebugQueue, lita_handler: true do
       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
+    it "can 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.")
@@ -92,7 +94,7 @@ describe Lita::Handlers::DebugQueue, lita_handler: true do
       expect(replies.last).to start_with("Hackers seeking fresh eyes: 0")
     end
 
-    it "allows instructors to clear the queue completely" do
+    it "can 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-debug-queue
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Brit Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -109,6 +109,8 @@ files:
 - Rakefile
 - lib/lita-debug-queue.rb
 - lib/lita/handlers/debug_queue.rb
+- lib/lita/handlers/room_finder.rb
+- lib/lita/handlers/room_queue.rb
 - lita-debug-queue.gemspec
 - locales/en.yml
 - spec/lita/handlers/help_queue_spec.rb