lita-slack-standup 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 372b83c82f687449d7f5fd37fb3def9854f62c58
-  data.tar.gz: dafa991a290ec6cecf33845d996aae15bf9f596d
+  metadata.gz: 88e73917d16c70d9f71ad82a693d952710200309
+  data.tar.gz: 593553562ef488af54ccedcbc829535c9edb0f1d
 SHA512:
-  metadata.gz: 92c6ea2b8b66cc07d86245e4fc6e74caba356e851011864b462db5e28898fe0879e174709a68a232ad27ef8f51135e1ce8c41e8800cbd92eb5be5f7a383d7e75
-  data.tar.gz: 476920eb200651d8e6f3b42628a800ed2d25c481aed1542e97f47f858ce914fcce59a8562806bf73bd96c2f569f051a05011e891bbf08e5926c0d2790db6d652
+  metadata.gz: 2df34d19c44e6fa3b9005c8954e71454f5818dceedcc335b065353bc9e20e109a620ecc326cb343e33364e381fa152247d196f7c890f92bbb91ee5f8f3ae84ca
+  data.tar.gz: 1426c5fd4cb1302d7ec8d7491ca0e1698bc9b329da552fe1e985d061a65106726c24120fe1795b34c96b98d1aaf6811aa610c7d44a3508420f658520c0556c36

data/README.md

@@ -1,6 +1,6 @@
 # lita-lack-tandup
 
-lita-slack-standup is a gem for Lita (https://www.lita.io/), a chat bot written in ruby.
+lita-slack-standup is a gem for Lita (https://www.lita.io/), a chat bot written in ruby.  
 It handles standup meetings on slack (the sentences are in french for now).
 
 ## Installation
@@ -16,7 +16,6 @@ gem "lita-standup"
 In your lita configuration file (lita_config.rb), add the lines :
 ``` ruby
 Lita.congifure do |config|
-  ## standup
   config.handlers.slack_standup.channel = ENV['STANDUP_CHANNEL']
 end
 ```
@@ -25,16 +24,16 @@ And set the environment variable STANDUP_CHANNEL, with the name of the channel w
 
 ## Test
 
-We used VCR generated by real standups on slack. 
-We had to delete them for privacy reasons.
+We used VCR generated by real standups on slack. We had to delete them for privacy reasons.  
+To rerun the tests and recreate some VCR, you need to bundle the gem into a lita bot.
 
 ## Usage
 
- - !start standup : launches the standup, prints the standups already filled and asks for someone else to report
- - !next standup : skips the current user and asks the next user to do his standup report
- - !standup <some standup report> : saves your standup. If you do it before the start of the standup, you won't be asked to report. The bot will displays your standup in your stead
- - !ignore <some user> : ignores an user for the standups
- - !unignore <some user> : unignores an user
- - !list ignore : list all ignored users
-
+ - !standup start : launches the standup, prints the standups already filled and asks for someone else to report
+ - !standup next : skips the current user and asks the next user to do his standup report
+ - !standup report <some standup report> : saves your standup. If you do it before the start of the standup, you won't be asked to report. The bot will displays your standup in your stead
+ - !standup ignore <some user> : ignores an user for the standups
+ - !standup unignore <some user> : unignores an user
+ - !standup list : list all ignored users
+  
 The standup stops when everyone has done his report or has been skipped.

data/lib/lita/handlers/slack_standup.rb

@@ -5,82 +5,96 @@ module Lita
 
       config :channel
 
-      route(/^start\s*standup?/, :start_standup, command: true, help: {"start standup" => "Lance le standup." })
+      route(/^standup\s*start?/, :standup_start, command: true, help: {"standup start" => "Lance le standup." })
 
-      def start_standup(message=nil)
+      def standup_start(message=nil)
         in_standup.value = 'true'
         setup_redis_objects
         send_message(config.channel, 'Hello <!channel> ! Le standup va commencer : )')
         prewritten_standups_summary
-        next_standup
+        standup_next
       end
 
-      route(/^standup\s*(.*)$/, :standup, command: true, help: {"standup texte" => "Permet d'écrire son standup à l'avance ou pendant le tour d'un autre."})
+      route(/^standup\s*report\s*(.*)$/, :standup_report, command: true, help: {"standup report TEXT" => "Permet d'écrire son standup à l'avance ou pendant le tour d'un autre."})
 
-      def standup(message)
+      def standup_report(message)
         setup_redis_objects
         save_standup message
         message.reply("Ton standup est enregistré. Merci :)")
       end
 
-      route(/^next\s*standup?/, :next_standup, command: true, help: {"next standup" => "Passe à l'utilisateur suivant et considère le standup précédent comme fait."})
+      route(/^standup\s*next?/, :standup_next, command: true, help: {"standup next" => "Passe à l'utilisateur suivant et considère le standup précédent comme fait."})
 
-      def next_standup(message=nil)
-        if in_standup.value == 'true'
-          if standup_members.none? { |user, standup| standup.empty? }
-            end_standup
-          else
-            next_attendee = select_next_standup
-            send_message(config.channel,"Bonjour <@#{next_attendee}> ! C'est à ton tour de parler.") 
-            fill_standup(next_attendee)
-          end
+      def standup_next(message=nil)
+        setup_redis_objects
+        return unless standup_check?
+
+        if standup_members.none? { |user, standup| standup.empty? }
+          standup_end
         else
-          send_message(config.channel,"La commande n'est pas disponible en dehors d'un standup.")
+          next_attendee = select_next_standup
+          send_message(config.channel,"Bonjour <@#{next_attendee}> ! C'est à ton tour de parler.") 
+          fill_standup(next_attendee)
         end
       end
 
       def reminder
+        setup_redis_objects
         standup_members.each do |user, standup|
           send_message("@#{user}","Bonsoir <@#{user}> ! Tu peux donner ton standup pour demain. !standup 3615mavie") if standup.empty?
         end
       end
 
-      route(/^ignore\s*(.*)$/, :ignore, command: true, help: {"ignore nom" => "Retire un utilisateur de la liste des personnes ayant à faire le standup"})
+      route(/^standup*\signore\s*(.*)$/, :standup_ignore, command: true, help: {"standup ignore USER" => "Retire un utilisateur de la liste des personnes ayant à faire le standup"})
 
-      def ignore(message)
+      def standup_ignore(message)
+        setup_redis_objects
         user = message.matches[0][0].gsub('@','')
+        
         unless ignored_members.include? user
           ignored_members << user
           standup_members.delete(user)
         end
+        
         message.reply("<@#{user}> est désormais ignoré jusqu'à nouvel ordre.")
       end
 
-      route(/^unignore\s*(.*)$/, :unignore, command: true, help: {"unignore nom" => "Remet l'utilisateur dans la liste des personnes participant aux standups."})
+      route(/^standup*\sunignore\s*(.*)$/, :standup_unignore, command: true, help: {"standup unignore USER" => "Remet l'utilisateur dans la liste des personnes participant aux standups."})
 
-      def unignore(message)
+      def standup_unignore(message)
+        setup_redis_objects
         user = message.matches[0][0].gsub('@','')
+        
         if ignored_members.include? user
           ignored_members.delete(user)
           standup_members[user] = ''
         end
+        
         message.reply("<@#{user}> est à nouveau inclus dans les standups.")
       end
 
-      route(/^list\s*ignore?/, :list_ignore, command: true, help: {"list ignore" => "Liste les utilisateurs ignorés."})
+      route(/^standup\s*list?/, :standup_list, command: true, help: {"standup list" => "Liste les utilisateurs ignorés."})
 
-      def list_ignore(message)
-        reply = "Utilisateurs ignorés : "
-        ignored_members.each do |user|
-          reply += "#{user}  "
-        end
-        message.reply(reply)
+      def standup_list(message)
+        setup_redis_objects
+        message.reply(
+          ignored_members.inject("Utilisateurs ignorés : ") do |reply, user|
+            reply += "#{user}  "
+          end
+        )
       end
 
       private 
 
+      def standup_check?
+        if in_standup.value != 'true'
+          send_message(config.channel,"La commande n'est pas disponible en dehors d'un standup.")
+        end
+        in_standup.value == 'true'
+      end
+
       def in_standup
-        @in_standup ||= Redis::Value.new('in_standup', redis, marshal: true)
+        @in_standup ||= Redis::Value.new('in_standup', redis)
       end
 
       def ignored_members
@@ -88,8 +102,8 @@ module Lita
       end
 
       def setup_redis_objects
-          update_ids_to_members if ids_to_members.empty?
-          update_standup_members if standup_members.empty?
+        update_ids_to_members if ids_to_members.empty?
+        update_standup_members if standup_members.empty?
       end
 
       def standup_members
@@ -97,10 +111,9 @@ module Lita
       end
 
       def retrieve_channel
-        slack_client.channels_list['channels'].
-          find do |channel| 
-            "##{ channel['name'] }" == config.channel 
-          end
+        slack_client.channels_list['channels'].find do |channel| 
+          "##{ channel['name'] }" == config.channel 
+        end
       end
 
       def fill_standup_members(members_list)
@@ -129,7 +142,7 @@ module Lita
 
       def prewritten_standups_summary
         standup_members.each do |user, standup|
-            display_standup(user, standup) unless standup.empty?
+          display_standup(user, standup) unless standup.empty?
         end
       end
 
@@ -151,14 +164,14 @@ module Lita
         standup_members.select{ |key,value| value.empty? }.first.first
       end
 
-      def end_standup
+      def standup_end
         in_standup.value = 'false'
 
         send_message(config.channel, "Et voilà ! C'est bon pour aujourd'hui. Merci tout le monde :parrot:")
+        
         update_standup_members
         update_ids_to_members
       end
-
     end
     Lita.register_handler(SlackStandup)
   end

data/lita-slack-standup.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-slack-standup"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["Sybil Deboin"]
   spec.email         = ["sybil.deboin@gmail.com"]
   spec.description   = "Standup feature for slack"

data/locales/en.yml

@@ -1,4 +1,4 @@
 en:
   lita:
     handlers:
-      standup:
+     slack_standup:

data/spec/lita/handlers/slack_standup_spec.rb

@@ -40,12 +40,11 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
   end
 
   describe "when standup starts" do
-
     subject do 
-      send_message("!start standup", as: sybil, from: channel)
+      send_message("!standup start", as: sybil, from: channel)
     end
 
-    it "starts standup", vcr: {cassette_name: 'start_standup'} do
+    it "starts standup", vcr: {cassette_name: 'standup_start'} do
       [ "Hello <!channel> ! Le standup va commencer : )",
         "Bonjour <@zaratan> ! C'est à ton tour de parler."
       ].each do |text|
@@ -55,28 +54,28 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
       subject 
     end
 
-    it "annoys people only on working days" do
-      #standup test that it's called on weekday
-    end
-
-    context "with pre-filled reports" do
-      it "displays known reports", vcr: {cassette_name: 'standup_prefilled'} do
-        send_message("!standup My standup report for testing purposes", as: sybil, from: channel)
+    context "with pre-filled report" do
+      before do 
+        send_message("!standup report My standup report for testing purposes", as: sybil, from: channel)
+      end
 
+      it "displays known reports", vcr: {cassette_name: 'standup_one_report_prefilled'} do
 	[ "Hello <!channel> ! Le standup va commencer : )",
 	  "sybil a déjà renseigné son standup : \n My standup report for testing purposes",
 	  "Bonjour <@zaratan> ! C'est à ton tour de parler."
 	].each do |text|
 	  expect_any_instance_of(Slack::Web::Client).to receive(:chat_postMessage).with({:channel=>channel, :text=>text, :as_user=>true})
 	end
-
         subject
       end
-      context "with all reports pre-filled", vcr: {cassette_name: 'standups_all_prefilled'} do
-        it "displays the standups and ends the meeting" do
-          send_message("!standup My standup report for testing purposes", as: sybil, from: channel)   
-          send_message("!standup My standup report for testing purposes", as: zaratan, from: channel)   
+    
+      context "with all reports pre-filled", vcr: {cassette_name: 'standup_all_reports_prefilled'} do
+        before do
+          send_message("!standup report My standup report for testing purposes", as: sybil, from: channel)   
+          send_message("!standup report My standup report for testing purposes", as: zaratan, from: channel)   
+        end
 
+        it "displays the standups and ends the meeting" do
  	  [ "Hello <!channel> ! Le standup va commencer : )",
 	    "zaratan a déjà renseigné son standup : \n My standup report for testing purposes",
 	    "sybil a déjà renseigné son standup : \n My standup report for testing purposes",
@@ -84,85 +83,81 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
 	  ].each do |text|
 	    expect_any_instance_of(Slack::Web::Client).to receive(:chat_postMessage).with({:channel=>channel, :text=>text, :as_user=>true})       
           end
-
           subject
         end
       end
     end
   end
 
-  describe "!standup command", vcr: {cassette_name: 'standup'} do
+  describe "!standup report command", vcr: {cassette_name: 'standup_report'} do
     subject do 
-      send_message("!standup My standup report for testing purposes", as: sybil, from: channel)
+      send_message("!standup report My standup report for testing purposes", as: sybil, from: channel)
     end
 
-    context "when the user reports" do
-      it "saves the report" do
-        subject
-        expect(replies.last).to eq("Ton standup est enregistré. Merci :)")
-      end
+    it "saves the report" do
+      subject
+      expect(replies.last).to eq("Ton standup est enregistré. Merci :)")
     end
   end
 
-  describe "!next standup command" do
+  describe "!standup mext command" do
     subject do
-      send_message("!next standup", as: sybil, from: channel)
+      send_message("!standup next", as: sybil, from: channel)
     end
 
-    context "when its called oustide of standups", vcr: {cassette_name: 'next_standup_refused'} do
+    context "when its called oustide of standups", vcr: {cassette_name: 'standup_next_refused'} do
       it "is not available" do
         expect_any_instance_of(Slack::Web::Client).to receive(:chat_postMessage).with({:channel=>channel, :text=>"La commande n'est pas disponible en dehors d'un standup.", :as_user=>true})
-       
         subject  
       end
     end
 
-    context "when it's called during standup", vcr: {cassette_name: 'next_standup'} do
+    context "when it's called during standup", vcr: {cassette_name: 'standup_next'} do
+      before do 
+        send_message("!standup start", as: sybil, from: channel)
+      end
+        
       it "asks the next user to report" do
-        send_message("!start standup", as: sybil, from: channel)
- 
         expect_any_instance_of(Slack::Web::Client).to receive(:chat_postMessage).with({:channel=>channel, :text=>"Bonjour <@sybil> ! C'est à ton tour de parler.", :as_user=>true})
-       
         subject  
       end
     end
   end
 
-  describe "!ignore user command", vcr: {cassette_name: 'ignore_user'} do
+  describe "!standup ignore user command", vcr: {cassette_name: 'standup_ignore'} do
+
+    before do
+      send_message("!standup start", as: sybil, from: channel)
+    end
 
     subject do 
-      send_message("!ignore sybil", as: sybil, from: channel)
-      send_message("!next standup", as: sybil, from: channel)
+      send_message("!standup ignore sybil", as: sybil, from: channel)
+      send_message("!standup next standup", as: sybil, from: channel)
     end
 
     it "ignores an user" do
-      send_message("!start standup", as: sybil, from: channel)
-
       expect_any_instance_of(Slack::Web::Client).to receive(:chat_postMessage).with({:channel=>channel, :text=>"Et voilà ! C'est bon pour aujourd'hui. Merci tout le monde :parrot:", :as_user=>true})
-
       subject 
       expect(replies.last).to eq("<@sybil> est désormais ignoré jusqu'à nouvel ordre.")
-    
     end
   end
 
-  describe "!unignore user command", vcr: {cassette_name: 'unignore_user'} do
+  describe "!standup unignore user command", vcr: {cassette_name: 'standup_unignore'} do
+
+    before do
+      send_message("!standup start", as: sybil, from: channel)
+      send_message("!standup ignore sybil", as: sybil, from: channel)
+    end
 
     subject do 
-      send_message("!unignore sybil", as: sybil, from: channel)
-      send_message("!next standup", as: sybil, from: channel)
+      send_message("!standup unignore sybil", as: sybil, from: channel)
+      send_message("!standup next", as: sybil, from: channel)
     end
 
     it "unignores an user" do
-      send_message("!start standup", as: sybil, from: channel)
-      send_message("!ignore sybil", as: sybil, from: channel)
-
       expect_any_instance_of(Slack::Web::Client).to receive(:chat_postMessage).with({:channel=>channel, :text=>"Bonjour <@sybil> ! C'est à ton tour de parler.", :as_user=>true})
-
       subject 
       expect(replies.last).to eq("<@sybil> est à nouveau inclus dans les standups.")
-    
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-slack-standup
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sybil Deboin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita