lita-slack-standup 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92392fd935466f60969f50841967b819e95b1ee5
-  data.tar.gz: c3c6aa770535c762d5b7ae0cd0419a29fb38672b
+  metadata.gz: 43edfae543811ccd70d702c6931abe461b45565a
+  data.tar.gz: d69d8432d34ea8835428a379b522e9abe8dad5f2
 SHA512:
-  metadata.gz: d06f9fc78df53f4275dde5dac269991827db87e7987cb48d4c6ba2d6ed0db051eb304c2573d263156c7b5fb96df6837a259ab96c8e7d170c0e064456c9217f10
-  data.tar.gz: 36ae480d2a9a6c3e5b69403292f6a86e5645732f73ec06f2033ac0928132ef37557c4294032e2d1891a63fbff8d495ef0b32e21ebe9d87bbd0098b067b1f0574
+  metadata.gz: cbcb30a8b4d328926eb59d13028c5438430bcc00c549c49f788531cea77bccd8d12a015d3deb611bfc37567005824a2fb848fb0cdd3ccc843ab4b831c90846ff
+  data.tar.gz: 953ac35712b9e6a8811ec273fa4e94b42e97848533d82360f9c4ebc073182c3ce2905c2bcce40c696e44913bd59c55296bcbf0e6ca3a87023c2967c39b0b2516

data/.gitignore

@@ -15,4 +15,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-rspec/fixtures/vcr

data/README.md

@@ -1,7 +1,7 @@
-# lita-lack-tandup
+# lita-slack-standup
 
 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).
+It handles standup meetings on slack (in english or french). 
 
 ## Installation
 
@@ -16,12 +16,10 @@ gem "lita-standup"
 In your lita configuration file (lita_config.rb), add the lines :
 ``` ruby
 Lita.congifure do |config|
-  config.handlers.slack_standup.channel = ENV['STANDUP_CHANNEL']
+  config.handlers.slack_standup.channel = <My standup channel name here>
 end
 ```
 
-And set the environment variable STANDUP_CHANNEL, with the name of the channel where you want to held the standup.
-
 ## Usage
 
  - !standup start : launches the standup, prints the standups already filled and asks for someone else to report

data/lib/lita/handlers/slack_standup.rb

@@ -5,80 +5,77 @@ module Lita
 
       config :channel
 
-      route(/^standup\s*start?/, :standup_start, command: true, help: {"standup start" => "Lance le standup." })
+      def initialize(robot)
+        super
+        setup_redis_objects
+      end
+
+      route(/^standup\s+start$/, :standup_start, command: true, help: {t("help.start_cmd") => t("help.start_description") })
 
       def standup_start(message=nil)
         in_standup.value = 'true'
-        setup_redis_objects
-        send_message(config.channel, 'Hello <!channel> ! Le standup va commencer : )')
+        send_message(config.channel, t("sentence.start"))
         prewritten_standups_summary
         standup_next
       end
 
-      route(/\Astandup\s*report\s*((.|\s)*)\z/, :standup_report, command: true, help: {"standup report TEXT" => "Permet d'écrire son standup à l'avance ou pendant le tour d'un autre."})
+      route(/\Astandup\s+report\s*((.|\s)*)\z/, :standup_report, command: true, help: {t("help.report_cmd") => t("help.report_description")})
 
       def standup_report(message)
-        setup_redis_objects
         save_standup message
-        message.reply("Ton standup est enregistré. Merci :)")
+        message.reply(t("sentence.report"))
       end
 
-      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."})
+      route(/^standup\s+next$/, :standup_next, command: true, help: {t("help.next_cmd") => t("help.next_description")})
 
       def standup_next(message=nil)
-        setup_redis_objects
         return unless standup_check?
 
         if standup_members.none? { |user, standup| standup.empty? }
           standup_end
         else
           next_attendee = select_next_standup
-          send_message(config.channel,"Bonjour <@#{next_attendee}> ! C'est à ton tour de parler.") 
+          send_message(config.channel, t("sentence.next", user: next_attendee)) 
           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 report 3615mavie") if standup.empty?
+          send_message("@#{user}", t("sentence.reminder", user: user)) if standup.empty?
         end
       end
 
-      route(/^standup*\signore\s*(.*)$/, :standup_ignore, command: true, help: {"standup ignore USER" => "Retire un utilisateur de la liste des personnes ayant à faire le standup"})
+      route(/^standup\s+ignore\s*(.*)$/, :standup_ignore, command: true, help: {t("help.ignore_cmd") => t("help.ignore_description")})
 
       def standup_ignore(message)
-        setup_redis_objects
-        user = message.matches[0][0].gsub('@','')
+        user = extract_user(message)
         
         unless ignored_members.include? user
           ignored_members << user
           standup_members.delete(user)
         end
         
-        message.reply("<@#{user}> est désormais ignoré jusqu'à nouvel ordre.")
+        message.reply(t("sentence.ignore", user: user))
       end
 
-      route(/^standup*\sunignore\s*(.*)$/, :standup_unignore, command: true, help: {"standup unignore USER" => "Remet l'utilisateur dans la liste des personnes participant aux standups."})
+      route(/^standup\s+unignore\s*(.*)$/, :standup_unignore, command: true, help: {t("help.unignore_cmd") => t("help.unignore_description")})
 
       def standup_unignore(message)
-        setup_redis_objects
-        user = message.matches[0][0].gsub('@','')
+        user = extract_user(message)
         
         if ignored_members.include? user
           ignored_members.delete(user)
           standup_members[user] = ''
         end
         
-        message.reply("<@#{user}> est à nouveau inclus dans les standups.")
+        message.reply(t("sentence.unignore",user: user))
       end
 
-      route(/^standup\s*list?/, :standup_list, command: true, help: {"standup list" => "Liste les utilisateurs ignorés."})
+      route(/^standup\s+list$/, :standup_list, command: true, help: {t("help.list_cmd") => t("help.list_description")})
 
       def standup_list(message)
-        setup_redis_objects
-        message.reply(
-          ignored_members.inject("Utilisateurs ignorés : ") do |reply, user|
+        message.reply(ignored_members.inject(t("sentence.list")) do |reply, user|
             reply += "#{user}  "
           end
         )
@@ -86,9 +83,13 @@ module Lita
 
       private 
 
+      def extract_user(message)
+        message.matches[0][0].gsub('@','')
+      end
+
       def standup_check?
         if in_standup.value != 'true'
-          send_message(config.channel,"La commande n'est pas disponible en dehors d'un standup.")
+          send_message(config.channel, t("sentence.next_forbidden"))
         end
         in_standup.value == 'true'
       end
@@ -107,7 +108,7 @@ module Lita
       end
 
       def standup_members
-        @standup_members ||= Redis::HashKey.new('standup_members', redis, marshal: true)
+        @standup_members ||= Redis::HashKey.new('standup_members', redis)
       end
 
       def retrieve_channel
@@ -147,7 +148,7 @@ module Lita
       end
 
       def display_standup(user, standup)
-        send_message(config.channel, "#{user} a déjà renseigné son standup : \n #{standup}")         
+        send_message(config.channel, t("sentence.standup_done",{user: user, standup: standup}))         
       end
 
       def save_standup(message)
@@ -157,7 +158,7 @@ module Lita
       end
 
       def fill_standup(member)
-        standup_members[member] = 'Standup fait en live.'
+        standup_members[member] = t("sentence.standup_fill")
       end
 
       def select_next_standup
@@ -167,7 +168,7 @@ module Lita
       def standup_end
         in_standup.value = 'false'
 
-        send_message(config.channel, "Et voilà ! C'est bon pour aujourd'hui. Merci tout le monde :parrot:")
+        send_message(config.channel,t("sentence.end_standup"))
         
         update_standup_members
         update_ids_to_members

data/lita-slack-standup.gemspec

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

data/locales/en.yml

@@ -1,4 +1,29 @@
 en:
   lita:
     handlers:
-     slack_standup:
+      slack_standup:
+        help:
+          start_cmd: standup start
+          start_description: Launches the standup, prints the standups already filled and asks for someone else to report
+          report_cmd: standup report TEXTE
+          report_description: 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
+          next_cmd: standup next
+          next_description: Skips the current user and asks the next user to do his standup report
+          ignore_cmd: standup ignore USER
+          ignore_description: Ignores an user for the standups
+          unignore_cmd: standup unignore USER
+          unignore_description: Unignores an user
+          list_cmd: standup list
+          list_description: List all ignored users
+        sentence:
+          start: "Hello <!channel> ! The standup is starting :)"
+          report: "your standup is saved. Thanks :)"
+          next: "Good morning <@%{user}> ! It's your turn."
+          ignore: "<@%{user}> is now ignored."
+          reminder: "Good evening <@%{user}> ! You can write your standup for tomorrow !standup report hashtagmylife"
+          unignore: "<@%{user}> is now an attendee of the standups"
+          list: "Ignored users : "
+          next_forbidden: "The command is unavailable outside standups."
+          standup_done: "%{user} has already filled his standup: \n %{standup}"
+          standup_fill: "Standup done in live."
+          end_standup: "That's it ! It's all good for today. Thanks everyone :)"

data/locales/fr.yml

@@ -0,0 +1,29 @@
+fr:
+  lita:
+    handlers:
+      slack_standup:
+        help:
+          start_cmd: standup start
+          start_description: Lance le standup
+          report_cmd: standup report TEXTE
+          report_description: Permet d'écrire son standup à l'avance ou pendant le tour d'un autre
+          next_cmd: standup next
+          next_description: Passe à l'utilisateur suivant et considère le standup précédent comme fait
+          ignore_cmd: standup ignore USER
+          ignore_description: Retire un utilisateur de la liste des personnes ayant à faire le standup
+          unignore_cmd: standup unignore USER
+          unignore_description: Remet l'utilisateur dans la liste des personnes participant aux standups
+          list_cmd: standup list
+          list_description: Liste les utilisateurs ignorés
+        sentence:
+          start: "Hello <!channel> ! Le standup va commencer :)"
+          report: "Ton standup est enregistré. Merci :)"
+          next: "Bonjour <@%{user}> ! C'est à ton tour de parler."
+          ignore: "<@%{user}> est désormais ignoré jusqu'à nouvel ordre."
+          reminder: "Bonsoir <@%{user}> ! Tu peux donner ton standup pour demain. !standup report 3615mavie"
+          unignore: "<@%{user}> est à nouveau inclus dans les standups."
+          list: "Utilisateurs ignorés : "
+          next_forbidden: "La commande n'est pas disponible en dehors d'un standup."
+          standup_done: "%{user} a déjà renseigné son standup : \n %{standup}"
+          standup_fill: "Standup fait en live."
+          end_standup: "Et voilà ! C'est bon pour aujourd'hui. Merci tout le monde :)"

data/spec/lita/handlers/slack_standup_spec.rb

@@ -1,14 +1,48 @@
 require "spec_helper"
 
 describe Lita::Handlers::SlackStandup, lita_handler: true do
-
   let(:channel) { "#jambot-test" }
   let(:robot_name) { "jambot-test" }
   let(:sybil) { Lita::User.create(1000, name: "sybil") }
   let(:zaratan) { Lita::User.create(1001, name: "zaratan") }
+  let(:header) { 
+    {'Accept'=>'application/json; charset=utf-8', 
+    'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 
+    'Content-Type'=>'application/x-www-form-urlencoded', 
+    'User-Agent'=>'Slack Ruby Client/0.6.0'} 
+  }
 
   let(:registry) do
     reg = Lita::Registry.new
+  
+    stub_request(:post, "https://slack.com/api/users.list").
+      with(:headers => header).
+      to_return(:status => 200, :body => '{"ok": true,"members":[{"id":"A","name":"sybil"}, {"id":"B","name":"zaratan"}]}', :headers => {})
+
+    stub_request(:post, "https://slack.com/api/channels.list").
+      with(:headers => header).
+      to_return(:status => 200, :body => '{"ok":true,"channels":[{"id":"C","name":"jambot-test","members":["B","A"],"num_members":2}]}', :headers => {})
+    
+    stub_request(:post, "https://slack.com/api/chat.postMessage").
+      with(:body => {"as_user"=>"true", "channel"=>"#jambot-test", "text"=>"Hello <!channel> ! Le standup va commencer :)", "token"=>nil},:headers => header).
+      to_return(:status => 200, :body => '{"ok": true,"channel": "C","message": "Hello <!channel> ! Le standup va commencer :)"}', :headers => {})
+  
+    stub_request(:post, "https://slack.com/api/chat.postMessage").
+      with(:body => {"as_user"=>"true", "channel"=>"#jambot-test", "text"=>"Bonjour <@zaratan> ! C'est à ton tour de parler.", "token"=>nil},:headers => header).
+      to_return(:status => 200, :body => '{"ok": true,"channel": "C","message": "Bonjour <@zaratan> ! C\'est à ton tour de parler."}', :headers => {})
+
+    stub_request(:post, "https://slack.com/api/chat.postMessage").
+      with(:body => {"as_user"=>"true", "channel"=>"#jambot-test", "text"=>"Bonjour <@sybil> ! C'est à ton tour de parler.", "token"=>nil},:headers => header).
+      to_return(:status => 200, :body => '{"ok": true,"channel": "C","message": "Bonjour <@sybil> ! C\'est à ton tour de parler."}', :headers => {})
+
+    stub_request(:post, "https://slack.com/api/chat.postMessage").
+      with(:body => {"as_user"=>"true", "channel"=>"#jambot-test", "text"=>"Et voilà ! C'est bon pour aujourd'hui. Merci tout le monde :)", "token"=>nil},:headers => header).
+      to_return(:status => 200, :body => '{"ok": true,"channel": "C","message": "Et voilà ! C\'est bon pour aujourd\'hui. Merci tout le monde :)"}', :headers => {})
+ 
+    stub_request(:post, "https://slack.com/api/chat.postMessage").
+      with(:body => {"as_user"=>"true", "channel"=>"#jambot-test", "text"=>"La commande n'est pas disponible en dehors d'un standup.", "token"=>nil},:headers => header).
+      to_return(:status => 200, :body => '{"ok": true,"channel": "C","message": "La commande n\'est pas disponible en dehors d\'un standup."}', :headers => {})
+ 
     reg.register_handler(Lita::Handlers::SlackStandup)
     
     reg.configure do |config|
@@ -26,23 +60,6 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
     standup.send(:standup_members).clear
     standup.send(:ids_to_members).clear
     standup.send(:ignored_members).clear 
-  
-    stub_request(:post, "https://slack.com/api/users.list").
-      with(:body => {"token"=>nil}, :headers => {'Accept'=>'application/json; charset=utf-8', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Slack Ruby Client/0.6.0'}).
-      to_return(:status => 200, :body => '{"ok": true,"members":[
-              {"id":"A","team_id":"AT","name":"sybil"}, {"id":"B","team_id":"BT","name":"zaratan"}]}', :headers => {})
-
-    stub_request(:post, "https://slack.com/api/channels.list").
-      with(:body => {"token"=>nil},:headers => {'Accept'=>'application/json; charset=utf-8', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Slack Ruby Client/0.6.0'}).
-      to_return(:status => 200, :body => '{"ok":true,"channels":[{"id":"C","name":"jambot-test","is_channel":true,"members":["B","A"],"num_members":2}]}', :headers => {})
-    
-    stub_request(:post, "https://slack.com/api/chat.postMessage").
-      with(:body => {"as_user"=>"true", "channel"=>"#jambot-test", "text"=>"Hello <!channel> ! Le standup va commencer : )", "token"=>nil},:headers => {'Accept'=>'application/json; charset=utf-8', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Slack Ruby Client/0.6.0'}).
-      to_return(:status => 200, :body => '{"ok": true,"channel": "C","message": "Hello <!channel> ! Le standup va commencer : )"}', :headers => {})
-  
-    stub_request(:post, "https://slack.com/api/chat.postMessage").
-      with(:body => {"as_user"=>"true", "channel"=>"#jambot-test", "text"=>"Bonjour <@zaratan> ! C'est à ton tour de parler.", "token"=>nil},:headers => {'Accept'=>'application/json; charset=utf-8', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Slack Ruby Client/0.6.0'}).
-      to_return(:status => 200, :body => '{"ok": true,"channel": "C","message": "Bonjour <@zaratan> ! C\'est à ton tour de parler."}', :headers => {})
   end
   
   
@@ -51,11 +68,10 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
       send_message("!standup start", as: sybil, from: channel)
     end
 
-    it { is_expected.to route("!standup start") }  
+    it { is_expected.to route("!standup start") }
     
     it "starts standup" do
-
-      [ "Hello <!channel> ! Le standup va commencer : )",
+      [ "Hello <!channel> ! Le standup va commencer :)",
         "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})
@@ -70,7 +86,7 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
       end
 
       it "displays known reports" do
-        [ "Hello <!channel> ! Le standup va commencer : )",
+        [ "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|
@@ -86,10 +102,10 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
         end
 
         it "displays the standups and ends the meeting" do
-          [ "Hello <!channel> ! Le standup va commencer : )",
+          [ "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",
-            "Et voilà ! C'est bon pour aujourd'hui. Merci tout le monde :parrot:"
+            "Et voilà ! C'est bon pour aujourd'hui. Merci tout le monde :)"
           ].each do |text|
             expect_any_instance_of(Slack::Web::Client).to receive(:chat_postMessage).with({:channel=>channel, :text=>text, :as_user=>true})       
           end
@@ -104,17 +120,21 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
       send_message("!standup report My standup report for testing purposes", as: sybil, from: channel)
     end
 
+    it { is_expected.to route("!standup report") }
+
     it "saves the report" do
       subject
       expect(replies.last).to eq("Ton standup est enregistré. Merci :)")
     end
   end
 
-  describe "!standup mext command" do
+  describe "!standup next command" do
     subject do
       send_message("!standup next", as: sybil, from: channel)
     end
 
+    it { is_expected.to route("!standup next") }
+
     context "when its called oustide of standups" 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})
@@ -135,25 +155,25 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
   end
 
   describe "!standup ignore user command" do
-
     before do
       send_message("!standup start", as: sybil, from: channel)
     end
 
     subject do 
       send_message("!standup ignore sybil", as: sybil, from: channel)
-      send_message("!standup next standup", as: sybil, from: channel)
+      send_message("!standup next", as: sybil, from: channel)
     end
 
+    it { is_expected.to route("!standup ignore") }
+
     it "ignores an user" do
-      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})
+      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 :)", :as_user=>true})
       subject 
       expect(replies.last).to eq("<@sybil> est désormais ignoré jusqu'à nouvel ordre.")
     end
   end
 
   describe "!standup unignore user command" do
-
     before do
       send_message("!standup start", as: sybil, from: channel)
       send_message("!standup ignore sybil", as: sybil, from: channel)
@@ -164,6 +184,8 @@ describe Lita::Handlers::SlackStandup, lita_handler: true do
       send_message("!standup next", as: sybil, from: channel)
     end
 
+    it { is_expected.to route("!standup unignore") }
+
     it "unignores an user" do
       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 

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+ENV['LANG']="fr"
 require "lita-slack-standup"
 require "lita/rspec"
 require "webmock/rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-slack-standup
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Sybil Deboin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -139,6 +139,7 @@ files:
 - lib/slack_client.rb
 - lita-slack-standup.gemspec
 - locales/en.yml
+- locales/fr.yml
 - spec/lita/handlers/slack_standup_spec.rb
 - spec/spec_helper.rb
 - templates/.gitkeep