lita-locker 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2815409ac4a6c9435d8bab8f79c9b5ac777c510c
-  data.tar.gz: 9bd9b6aabf276f58148e05da2b4b82451ba0769c
+  metadata.gz: 05c37515e071dc49fb68a05ccefe0b708ef60bfd
+  data.tar.gz: 4fe6d90d4764be77216f11625c8c377d4a6aaabb
 SHA512:
-  metadata.gz: ba2eb359c367608c8255e387c7393781f60d8872fbb8347d376fd8b6477db9bcc20546befc2ccf90d6a2bf8d4a1ab7effae3883b775313e8e57e3112e2e264e0
-  data.tar.gz: bd74d58ac7ead4d092d194ff2e663fa645a2443019addd9283323a1de16fccdb4acd431ee1106ff40449c5f8588e41c239a89cceadb1a93553d00ef3136d85e4
+  metadata.gz: cb09f15584cd47ecbfbfbc6876fac0792d5708fd6e83012e4b7711578fe211770b9b1ba0ddcba4f62b252c00b421ad02bbf52dd1f25fc5a1d08f50b38136c128
+  data.tar.gz: 534cc1c533df5b591bf9a6f3e0baf8644efb69a3763e0892d931439b9018aa63d6a6f38057b78fe771f17cd50f0c85b2bc74adad65f02452619bd3efb1f074cf

data/lib/lita/handlers/locker.rb

@@ -41,13 +41,27 @@ module Lita
         help: { t('help.steal.syntax') => t('help.steal.desc') }
       )
 
+      route(
+        /^locker\sobserve\s#{LABEL_REGEX}#{COMMENT_REGEX}$/,
+        :observe,
+        command: true,
+        help: { t('help.observe.syntax') => t('help.observe.desc') }
+      )
+
+      route(
+        /^locker\sunobserve\s#{LABEL_REGEX}#{COMMENT_REGEX}$/,
+        :unobserve,
+        command: true,
+        help: { t('help.unobserve.syntax') => t('help.unobserve.desc') }
+      )
+
       def setup_redis(_payload)
         Label.redis = redis
         Resource.redis = redis
       end
 
       def lock(response)
-        name = response.match_data['label']
+        name = response.match_data['label'].rstrip
 
         return response.reply(failed(t('label.does_not_exist', name: name))) unless Label.exists?(name)
         l = Label.new(name)
@@ -59,18 +73,48 @@ module Lita
       end
 
       def unlock(response)
-        name = response.match_data['label']
+        name = response.match_data['label'].rstrip
+
         return response.reply(failed(t('subject.does_not_exist', name: name))) unless Label.exists?(name)
         l = Label.new(name)
         return response.reply(success(t('label.is_unlocked', name: name))) unless l.locked?
+
         response.reply(attempt_unlock(name, response.user))
+
+        return if l.locked?
+        mention_names = l.observers
+                        .map { |observer| observer.mention_name ? "(@#{observer.mention_name})" : '' }
+                        .reject { |mention| mention == '' }
+                        .sort
+                        .join(' ')
+        response.reply(t('label.unlocked_no_queue', name: name, mention: mention_names)) unless mention_names.empty?
       end
 
-      def steal(response)
+      def observe(response)
         name = response.match_data['label']
+        return response.reply(failed(t('label.does_not_exist', name: name))) unless Label.exists?(name)
+        l = Label.new(name)
+        return response.reply(t('observe.already_observing', name: name)) if l.observer?(response.user.id)
+        l.add_observer!(response.user.id)
+        response.reply(t('observe.now_observing', name: name))
+      end
+
+      def unobserve(response)
+        name = response.match_data['label']
+        return response.reply(failed(t('label.does_not_exist', name: name))) unless Label.exists?(name)
+        l = Label.new(name)
+        return response.reply(t('observe.were_not_observing', name: name)) unless l.observer?(response.user.id)
+        l.remove_observer!(response.user.id)
+        response.reply(t('observe.stopped_observing', name: name))
+      end
+
+      def steal(response)
+        name = response.match_data['label'].rstrip
+
         return response.reply(failed(t('subject.does_not_exist', name: name))) unless Label.exists?(name)
         l = Label.new(name)
         return response.reply(t('steal.already_unlocked', label: name)) unless l.locked?
+
         response.reply(attempt_steal(name, response.user))
       end
 

data/lib/lita/handlers/locker_misc.rb

@@ -24,7 +24,7 @@ module Lita
       )
 
       route(
-        /^locker\sdequeue\s#{LABEL_REGEX}$/,
+        /^locker\s(dq|dequeue)\s#{LABEL_REGEX}$/,
         :dequeue,
         command: true,
         help: { t('help.dequeue.syntax') => t('help.dequeue.desc') }

data/lib/locker/label.rb

@@ -11,6 +11,7 @@ module Locker
       value :taken_at
 
       set :membership
+      set :observer_ids
       list :wait_queue
       list :journal
 
@@ -39,7 +40,7 @@ module Locker
 
       def self.delete(key)
         fail 'Unknown label key' unless Label.exists?(key)
-        %w(state, owner_id, membership, wait_queue, journal).each do |item|
+        %w(state, owner_id, membership, wait_queue, journal, observer_ids).each do |item|
           redis.del("label:#{key}:#{item}")
         end
         redis.srem('label-list', Label.normalize(key))
@@ -105,10 +106,28 @@ module Locker
         self.unlock!
       end
 
+      def add_observer!(observer_id)
+        observer_ids.add(observer_id)
+      end
+
+      def remove_observer!(observer_id)
+        observer_ids.delete(observer_id)
+      end
+
+      def observer?(observer_id)
+        observer_ids.member?(observer_id)
+      end
+
       def locked?
         (state == 'locked')
       end
 
+      def observers
+        observer_ids.map do |observer_id|
+          Lita::User.find_by_id(observer_id)
+        end
+      end
+
       def add_resource(resource)
         log("Resource #{resource.id} added")
         resource.labels << id
@@ -153,8 +172,17 @@ module Locker
     def label_ownership(name)
       l = Label.new(name)
       return label_dependencies(name) unless l.locked?
+      queue = []
+      l.wait_queue.each do |u|
+        usr = Lita::User.find_by_id(u)
+        queue.push(usr.name)
+      end
       mention = l.owner.mention_name ? "(@#{l.owner.mention_name})" : ''
-      failed(t('label.owned_lock', name: name, owner_name: l.owner.name, mention: mention, time: l.held_for))
+      failed(t('label.owned_lock', name: name,
+                                   owner_name: l.owner.name,
+                                   mention: mention,
+                                   time: l.held_for,
+                                   queue: queue.join(', ')))
     end
 
     def label_dependencies(name)

data/lita-locker.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-locker'
-  spec.version       = '1.0.1'
+  spec.version       = '1.0.2'
   spec.authors       = ['Eric Sigler']
   spec.email         = ['me@esigler.com']
   spec.description   = '"lock" and "unlock" arbitrary subjects'

data/locales/en.yml

@@ -6,6 +6,11 @@ en:
           stolen: "%{label} stolen from %{old_owner} %{mention}"
           already_unlocked: "%{label} was already unlocked"
           self: Why are you stealing the lock from yourself?
+        observe:
+          now_observing: "Now observing %{name}"
+          already_observing: "You are already observing %{name}"
+          stopped_observing: "You have stopped observing %{name}"
+          were_not_observing: "You were not observing %{name} originally"
         help:
           log:
             syntax: locker log <label>
@@ -19,6 +24,12 @@ en:
           unlock:
             syntax: unlock <subject>
             desc: Make something available to others. Can have # comments afterwards.
+          observe:
+            syntax: locker observe <subject>
+            desc: Get a notification when something becomes available. Can have # comments afterwards
+          unobserve:
+            syntax: locker unobserve <subject>
+            desc: Stop getting notifications when something becomes available. Can have # comments afterwards
           steal:
             syntax: steal <subject>
             desc: Force removal of a reservation. Can have # comments afterwards.
@@ -78,9 +89,10 @@ en:
           log_entry: "%{entry}"
           self_lock: "You already have the lock on %{name}"
           unlock: "%{name} unlocked"
-          owned_lock: "%{name} is locked by %{owner_name} %{mention} (taken %{time}), you have been added to the queue, type 'locker dequeue %{name}' to be removed"
+          owned_lock: "%{name} is locked by %{owner_name} %{mention} (taken %{time}), you have been added to the queue (currently: %{queue}), type 'locker dequeue %{name}' to be removed"
           owned_unlock: "%{name} is locked by %{owner_name} %{mention} (taken %{time})"
           is_unlocked: "%{name} is unlocked"
+          unlocked_no_queue: "%{name} is unlocked and no one is next up %{mention}"
           unable_to_lock: "%{name} unable to be locked"
           lock: "%{name} locked"
           desc: "%{name} is unlocked"

data/spec/lita/handlers/locker_misc_spec.rb

@@ -26,6 +26,11 @@ describe Lita::Handlers::LockerMisc, lita_handler: true do
     is_expected.to route_command('locker log something').to(:log)
   end
 
+  it do
+    is_expected.to route_command('locker dequeue something something').to(:dequeue)
+    is_expected.to route_command('locker dq something something').to(:dequeue)
+  end
+
   let(:alice) do
     Lita::User.create('9001@hipchat', name: 'Alice', mention_name: 'alice')
   end

data/spec/lita/handlers/locker_spec.rb

@@ -22,11 +22,18 @@ describe Lita::Handlers::Locker, lita_handler: true do
       is_expected.to route("(release) #{l} #this is a comment").to(:unlock)
 
       is_expected.to route_command("lock #{l}").to(:lock)
+      is_expected.to route_command("lock #{l} ").to(:lock)
       is_expected.to route_command("lock #{l} #this is a comment").to(:lock)
       is_expected.to route_command("unlock #{l}").to(:unlock)
+      is_expected.to route_command("unlock #{l} ").to(:unlock)
       is_expected.to route_command("unlock #{l} #this is a comment").to(:unlock)
       is_expected.to route_command("steal #{l}").to(:steal)
+      is_expected.to route_command("steal #{l} ").to(:steal)
       is_expected.to route_command("steal #{l} #this is a comment").to(:steal)
+      is_expected.to route_command("locker observe #{l}").to(:observe)
+      is_expected.to route_command("locker observe #{l} #this is a comment").to(:observe)
+      is_expected.to route_command("locker unobserve #{l}").to(:unobserve)
+      is_expected.to route_command("locker unobserve #{l} #this is a comment").to(:unobserve)
     end
   end
 
@@ -58,7 +65,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label create bazbat')
       send_command('locker label add foobar to bazbat')
       send_command('lock bazbat ')
-      expect(replies.last).to eq('bazbat  locked')
+      expect(replies.last).to eq('bazbat locked')
     end
 
     it 'does not enqueue the user that currently has a lock' do
@@ -119,7 +126,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('lock bazbat', as: alice)
       send_command('lock bazbat', as: bob)
       expect(replies.last).to eq('bazbat is locked by Alice (@alice) (taken 1 second ago), you have been ' \
-                                 'added to the queue, type \'locker dequeue bazbat\' to be removed')
+                                 'added to the queue (currently: Bob), type \'locker dequeue bazbat\' to be removed')
     end
 
     it 'shows an error when a label does not exist' do
@@ -148,6 +155,53 @@ describe Lita::Handlers::Locker, lita_handler: true do
       expect(replies.last).to eq('bazbat now locked by Bob (@bob)')
     end
 
+    it 'unlocks a label and alerts observers' do
+      send_command('locker resource create foobar')
+      send_command('locker label create bazbat')
+      send_command('locker label add foobar to bazbat')
+      send_command('locker observe bazbat', as: alice)
+      send_command('lock bazbat', as: bob)
+      send_command('locker observe bazbat', as: charlie)
+      send_command('unlock bazbat # with a comment', as: bob)
+      expect(replies).to include('bazbat is unlocked and no one is next up (@alice) (@charlie)')
+      expect(replies).to include('bazbat unlocked')
+    end
+
+    it 'does not alert observers if there is a queued person' do
+      send_command('locker resource create foobar')
+      send_command('locker label create bazbat')
+      send_command('locker label add foobar to bazbat')
+      send_command('locker observe bazbat', as: alice)
+      send_command('lock bazbat', as: bob)
+      send_command('lock bazbat', as: charlie)
+      send_command('unlock bazbat # with a comment', as: bob)
+      expect(replies).not_to include('bazbat is unlocked and no one is next up (@alice)')
+    end
+
+    it 'unlocks a label and alerts only observers' do
+      send_command('locker resource create foobar')
+      send_command('locker label create bazbat')
+      send_command('locker label add foobar to bazbat')
+      send_command('locker observe bazbat', as: alice)
+      send_command('lock bazbat', as: bob)
+      send_command('locker observe bazbat', as: charlie)
+      send_command('locker unobserve bazbat', as: alice)
+      send_command('unlock bazbat # with a comment', as: bob)
+      expect(replies).to include('bazbat is unlocked and no one is next up (@charlie)')
+      expect(replies).to include('bazbat unlocked')
+    end
+
+    it 'unlocks a label and does not alert anyone if there are no observers' do
+      send_command('locker resource create foobar')
+      send_command('locker label create bazbat')
+      send_command('locker label add foobar to bazbat')
+      send_command('locker observe bazbat', as: alice)
+      send_command('lock bazbat', as: bob)
+      send_command('locker unobserve bazbat', as: alice)
+      send_command('unlock bazbat # with a comment', as: bob)
+      expect(replies.last).to eq('bazbat unlocked')
+    end
+
     it 'does not unlock a label when someone else locked it' do
       send_command('locker resource create foobar')
       send_command('locker label create bazbat')
@@ -215,4 +269,44 @@ describe Lita::Handlers::Locker, lita_handler: true do
       expect(replies.last).to eq('Sorry, that does not exist')
     end
   end
+
+  describe '#observe' do
+    it 'adds a user as observer of a label' do
+      send_command('locker resource create foobar')
+      send_command('locker label create bazbat')
+      send_command('locker label add foobar to bazbat')
+      send_command('locker observe bazbat', as: alice)
+      expect(replies.last).to eq('Now observing bazbat')
+    end
+
+    it 'warns user if already observing label' do
+      send_command('locker resource create foobar')
+      send_command('locker label create bazbat')
+      send_command('locker label add foobar to bazbat')
+      send_command('locker observe bazbat', as: alice)
+      send_command('locker observe bazbat', as: alice)
+      expect(replies.last).to eq('You are already observing bazbat')
+    end
+  end
+
+  describe '#unobserve' do
+    it 'removes user from observer list for a label' do
+      send_command('locker resource create foobar')
+      send_command('locker label create bazbat')
+      send_command('locker label add foobar to bazbat')
+      send_command('locker observe bazbat', as: alice)
+      send_command('locker unobserve bazbat', as: alice)
+      expect(replies.last).to eq('You have stopped observing bazbat')
+    end
+
+    it 'warns user if already not observing label' do
+      send_command('locker resource create foobar')
+      send_command('locker label create bazbat')
+      send_command('locker label add foobar to bazbat')
+      send_command('locker observe bazbat', as: alice)
+      send_command('locker unobserve bazbat', as: alice)
+      send_command('locker unobserve bazbat', as: alice)
+      expect(replies.last).to eq('You were not observing bazbat originally')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-locker
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita