lita-standups 1.0.0

data/lib/lita/standups/models/standup_session.rb

@@ -0,0 +1,64 @@
+module Lita
+  module Standups
+    module Models
+      class StandupSession < Ohm::Model
+
+        include Ohm::Callbacks
+        include Ohm::Timestamps
+        include Ohm::DataTypes
+
+        attribute :status
+        attribute :room
+        attribute :counts, Type::Hash
+        attribute :recipients, Type::Array
+        attribute :results_sent, Type::Boolean
+
+        reference :standup, Standup
+        reference :standup_schedule, StandupSchedule
+        collection :standup_responses, StandupResponse, :standup_session
+
+        index :status
+        index :results_sent
+
+        def before_create
+          self.status = 'pending'
+          self.results_sent = false
+        end
+
+        %w(pending running completed).each do |status_name|
+          define_method("#{status_name}!") do
+            self.status = status_name
+          end
+        end
+
+        def update_status
+          self.counts = { 'total' => 0, 'finished' => 0 }
+          standup_responses.each do |r|
+            counts[r.status] = counts[r.status].to_i + 1
+            counts['total'] = counts['total'] + 1
+            counts['finished'] = counts['finished'] + 1 if r.finished?
+          end
+          completed! if counts['total'] == counts['finished']
+          save
+        end
+
+        def report_message
+          standup_responses.map(&:report_message).join("\n")
+        end
+
+        def summary
+          "ID: #{id} - standup #{standup.name} ran on #{created_at.strftime('%c')}"
+        end
+
+        def description
+          messages = ["ID: #{id}"]
+          messages << "Standup: #{standup.name}"
+          messages << "Date: #{created_at.strftime('%c')}"
+          messages << "Total recipients: #{counts['total']}"
+          messages << "Total finished: #{counts['finished']}"
+          messages.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/lita/standups/models.rb

@@ -0,0 +1,12 @@
+module Lita
+  module Standups
+    module Models
+      extend ActiveSupport::Autoload
+
+      autoload :Standup
+      autoload :StandupResponse
+      autoload :StandupSchedule
+      autoload :StandupSession
+    end
+  end
+end

data/lib/lita/standups/wizards/create_standup.rb

@@ -0,0 +1,31 @@
+module Lita
+  module Standups
+    module Wizards
+      class CreateStandup < Lita::Wizard
+
+        step :name,
+             label: 'Please give it a name:'
+
+        step :questions,
+             label: 'Enter the standup questions below:',
+             multiline: true
+
+        def finish_wizard
+          @standup = Models::Standup.create(
+            name: value_for(:name),
+            questions: value_for(:questions).to_s.split("\n").map(&:strip).map(&:presence).compact
+          )
+        end
+
+        def final_message
+          [
+            "You're done! Below is the summary of your standup:",
+            ">>>",
+            @standup.description
+          ].join("\n")
+        end
+
+      end
+    end
+  end
+end

data/lib/lita/standups/wizards/run_standup.rb

@@ -0,0 +1,56 @@
+module Lita
+  module Standups
+    module Wizards
+      class RunStandup < Lita::Wizard
+
+        def response
+          @response ||= Models::StandupResponse[meta['response_id']]
+        end
+
+        def session
+          response.standup_session
+        end
+
+        def standup
+          session.standup
+        end
+
+        def steps
+          @steps ||= standup.questions.map.with_index(1) do |question, index|
+            OpenStruct.new(
+              name: "q#{index}",
+              label: question,
+              multiline: true
+            )
+          end
+        end
+
+        def start_wizard
+          response.running!
+          response.save
+        end
+
+        def abort_wizard
+          response.aborted!
+          response.save
+        end
+
+        def finish_wizard
+          response.completed!
+          response.answers = values
+          response.save
+        end
+
+        def initial_message
+          "Hey. I'm running the '#{standup.name}' standup. Please answer the following questions " \
+            "in the next #{Lita::Standups::Manager::EXPIRATION_TIME} seconds"
+        end
+
+        def final_message
+          "You're done. Thanks"
+        end
+
+      end
+    end
+  end
+end

data/lib/lita/standups/wizards/schedule_standup.rb

@@ -0,0 +1,53 @@
+module Lita
+  module Standups
+    module Wizards
+      class ScheduleStandup < Lita::Wizard
+
+        step :repeat,
+             label: 'How often? (daily, weekly)',
+             options: %w(daily weekly)
+
+        step :day_of_week,
+             label: 'What day of week? (monday ... sunday)',
+             options: %w(monday tuesday wednesday thursday friday saturday sunday),
+             if: ->(wizard) { value_for(:repeat) == 'weekly' }
+
+        step :time,
+             label: 'At what time? (ex 9am)',
+             validate: /^([1-9]|1[0-2]|0[1-9])?(:[0-5][0-9])?\s?([aApP][mM])?$/
+
+        step :recipients,
+             label: 'Enter the standup members: ',
+             multiline: true
+
+        step :channel,
+             label: 'On what channel do you want to post the results to?'
+
+        def finish_wizard
+          @schedule = Models::StandupSchedule.create(
+            standup: standup,
+            repeat: value_for(:repeat),
+            day_of_week: value_for(:day_of_week),
+            time: value_for(:time),
+            recipients: value_for(:recipients).to_s.gsub("@", "").split(/[\s,\n]/m).map(&:strip).map(&:presence).compact,
+            channel: value_for(:channel)
+          )
+          robot.schedule_standup(@schedule)
+        end
+
+        def final_message
+          [
+            "You're done! Below is the summary of your scheduled standup:",
+            ">>>",
+            @schedule.description
+          ].join("\n")
+        end
+
+        def standup
+          @standup ||= Models::Standup[meta['standup_id']]
+        end
+
+      end
+    end
+  end
+end

data/lib/lita/standups/wizards.rb

@@ -0,0 +1,11 @@
+module Lita
+  module Standups
+    module Wizards
+      extend ActiveSupport::Autoload
+
+      autoload :CreateStandup
+      autoload :RunStandup
+      autoload :ScheduleStandup
+    end
+  end
+end

data/lib/lita-standups.rb

@@ -0,0 +1,27 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+module Lita
+  module Standups
+  end
+end
+
+require "lita-wizard"
+require "rufus-scheduler"
+require "ohm"
+require "ohm/contrib"
+require "active_support/all"
+
+require "lita/handlers/standups"
+require "lita/standups/wizards"
+require "lita/standups/models"
+require "lita/standups/manager"
+require "lita/standups/mixins/robot"
+
+Lita::Handlers::Standups.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lita-standups.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-standups'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Cristian Bica']
+  spec.email         = ['cristian.bica@gmail.com']
+  spec.description   = 'Lita standups'
+  spec.summary       = 'Lita standups'
+  spec.homepage      = 'https://github.com/cristianbica/lita-standups'
+  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.7'
+  spec.add_runtime_dependency 'lita-wizard'
+  spec.add_runtime_dependency 'rufus-scheduler'
+  spec.add_runtime_dependency 'ohm'
+  spec.add_runtime_dependency 'ohm-contrib'
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+end

data/locales/en.yml

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

data/spec/lita/handlers/standups_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Lita::Handlers::Standups, lita_handler: true do
+
+  it { is_expected.to route_command("list standups").to(:list_standups) }
+  it { is_expected.to route_command("create standup").to(:create_standup) }
+  it { is_expected.to route_command("show standup 42").to(:show_standup) }
+  it { is_expected.to route_command("delete standup 42").to(:delete_standup) }
+  it { is_expected.to route_command("schedule standup 42").to(:create_standups_schedule) }
+  it { is_expected.to route_command("unschedule standup 42").to(:delete_standups_schedule) }
+  it { is_expected.to route_command("list standups schedules").to(:show_standups_schedule) }
+  it { is_expected.to route_command("show standup schedule 42").to(:show_standup_schedule) }
+  it { is_expected.to route_command("run standup 42 with x,y").to(:run_standup) }
+  it { is_expected.to route_command("list standup sessions").to(:list_standup_sessions) }
+  it { is_expected.to route_command("show standup session 42").to(:show_standup_session) }
+
+end

data/spec/lita/integration_spec.rb

@@ -0,0 +1,191 @@
+require "spec_helper"
+
+describe Lita::Handlers::Standups, lita_handler: true, additional_lita_handlers: Lita::Handlers::Wizard do
+  include Lita::Standups::Fixtures
+
+  before do
+    Lita::User.create(2, name: "User2")
+    Lita::User.create(3, name: "User3")
+    create_standups(3)
+    create_standup_schedules(3)
+    create_standup_runs(3)
+    robot.registry.register_hook(:validate_route, Lita::Extensions::Wizard)
+  end
+
+  after do
+    cleanup_data
+  end
+
+  context "managing standups" do
+
+    it "should list standups" do
+      send_command("list standups")
+      expect(replies.last).to match(/found: 3/)
+      expect(replies.last).to match(/ID: 1/)
+    end
+
+    it "should start the create standup wizard" do
+      expect_any_instance_of(described_class).to \
+        receive(:start_wizard).with(Lita::Standups::Wizards::CreateStandup, anything)
+      send_command("create standup")
+    end
+
+    it "should create a standup" do
+      expect do
+        send_command("create standup")
+        send_message("test-name", privately: true)
+        send_message("q1", privately: true)
+        send_message("q2", privately: true)
+        send_message("done", privately: true)
+      end.to change { Lita::Standups::Models::Standup.all.count }.by(1)
+    end
+
+    it "should show the details of a standup" do
+      send_command("show standup 1")
+      expect(replies.last).to match(/ID: 1/)
+      expect(replies.last).to match(/Name:/)
+    end
+
+    it "should show an error message when trying to get the details of an inexisting standup" do
+      send_command("show standup 100")
+      expect(replies.last).to match(/I couldn't find a standup/)
+    end
+
+    it "should delete a standup" do
+      expect do
+        send_command("delete standup 1")
+      end.to change { Lita::Standups::Models::Standup.all.count }.by(-1)
+      expect(replies.last).to match(/Standup with ID 1 has been deleted/)
+    end
+
+    it "should show an error message when trying to delete an inexisting standup" do
+      expect do
+        send_command("delete standup 100")
+      end.not_to change { Lita::Standups::Models::Standup.all.count }
+      expect(replies.last).to match(/I couldn't find a standup/)
+    end
+  end
+
+  context "managing standups schedules" do
+    it "should start the wizard when trying to schedule a standup" do
+      expect_any_instance_of(described_class).to \
+        receive(:start_wizard).with(Lita::Standups::Wizards::ScheduleStandup, anything, { "standup_id" => "1" })
+      send_command("schedule standup 1")
+    end
+
+    it "should show an error message when trying to schedule an inexisting standup" do
+      expect do
+        send_command("schedule standup 100")
+      end.not_to change { Lita::Standups::Models::StandupSchedule.all.count }
+      expect(replies.last).to match(/I couldn't find a standup/)
+    end
+
+    it "should schedule a daily standup" do
+      expect do
+        send_command("schedule standup 1")
+        send_message("daily", privately: true)
+        send_message("12:42pm", privately: true)
+        send_message("user", privately: true)
+        send_message("done", privately: true)
+        send_message("#a", privately: true)
+      end.to change { Lita::Standups::Models::StandupSchedule.all.count }.by(1)
+      expect(replies.last).to match(/You're done!/)
+    end
+
+    it "should schedule a weekly standup" do
+      expect do
+        send_command("schedule standup 1")
+        send_message("weekly", privately: true)
+        send_message("tuesday", privately: true)
+        send_message("12:42pm", privately: true)
+        send_message("user", privately: true)
+        send_message("done", privately: true)
+        send_message("#a", privately: true)
+      end.to change { Lita::Standups::Models::StandupSchedule.all.count }.by(1)
+      expect(replies.last).to match(/You're done!/)
+    end
+
+    it "should delete a standup schedule" do
+      expect do
+        send_command("unschedule standup 1")
+      end.to change { Lita::Standups::Models::StandupSchedule.all.count }.by(-1)
+      expect(replies.last).to match(/Schedule with ID 1 has been deleted/)
+    end
+
+    it "should show an error message when trying to delete an inexisting standup schedule" do
+      expect do
+        send_command("unschedule standup 100")
+      end.not_to change { Lita::Standups::Models::StandupSchedule.all.count }
+      expect(replies.last).to match(/I couldn't find a scheduled standup/)
+    end
+
+    it "should list all standup schedules" do
+      send_command("list standups schedules")
+      expect(replies.last).to match(/Scheduled standups found: 3/)
+    end
+
+    it "should show details of a standup schedule" do
+      send_command("show standup schedule 1")
+      expect(replies.last).to match(/Here are the details/)
+      expect(replies.last).to match(/ID: 1/)
+    end
+
+    it "should show an error message when trying to get the details of an inexisting standup schedule" do
+      send_command("show standup schedule 100")
+      expect(replies.last).to match(/I couldn't find a scheduled standup/)
+    end
+  end
+
+  context "running standups" do
+    it "should ask the robot to run a standup" do
+      expect(robot).to receive(:run_standup).with("1", %w(user), anything)
+      send_command("run standup 1 with user")
+    end
+
+    it "should show an error message when trying to run an inexisting standup schedule" do
+      send_command("run standup 100 with user")
+      expect(replies.last).to match(/I couldn't find a standup/)
+    end
+
+    it "should run a standup" do
+      expect do
+        send_command("run standup 1 with 1")
+        send_message("a1", privately: true)
+        send_message("done", privately: true)
+        send_message("a2", privately: true)
+        send_message("done", privately: true)
+        send_message("a3", privately: true)
+        send_message("done", privately: true)
+      end.to change { Lita::Standups::Models::StandupSession.all.count }.by(1)
+    end
+
+    it "should be able to abort a running standup" do
+      send_command("run standup 1 with 1")
+      send_message("a1", privately: true)
+      send_message("done", privately: true)
+      send_message("abort", privately: true)
+      expect(replies.last).to match(/Aborting/)
+    end
+
+    it "should list all standup sessions" do
+      send_command("list standup sessions")
+      expect(replies.last).to match(/Sessions found: 3. Here they are/)
+    end
+
+    it "should show the details of a standup sessions" do
+      send_command("show standup session 1")
+      expect(replies.last).to match(/Here are the standup session details/)
+      expect(replies.last).to match(/ID: 1/)
+    end
+
+    it "should show an error message when trying to show an inexisting standup session" do
+      send_command("show standup session 100")
+      expect(replies.last).to match(/I couldn't find a standup session/)
+    end
+
+
+  end
+
+
+
+end

data/spec/lita/standups/manager_spec.rb

@@ -0,0 +1,92 @@
+require "spec_helper"
+
+describe Lita::Standups::Manager do
+  include Lita::Standups::Fixtures
+
+  let(:robot) { Lita::Robot.new }
+
+  before do
+    Lita::User.create(2, name: "User2")
+    Lita::User.create(3, name: "User3")
+    create_standups(3)
+    create_standup_schedules(3)
+    create_standup_runs(2)
+  end
+
+  after do
+    cleanup_data
+  end
+
+  context "class methods" do
+    it "should create a session and call run on a new manager instance when running a standup" do
+      expect_any_instance_of(described_class).to receive(:run)
+      expect do
+        described_class.run(robot: robot, standup_id: "1", recipients: %w(user1), room: "#a")
+      end.to change { Lita::Standups::Models::StandupSession.all.count }.by(1)
+    end
+
+    it "should create a session and call run on a new manager instance when running a standup schedule" do
+      expect_any_instance_of(described_class).to receive(:run)
+      expect do
+        described_class.run_schedule(robot: robot, schedule_id: "1")
+      end.to change { Lita::Standups::Models::StandupSession.all.count }.by(1)
+    end
+
+    it "should mark expired reponses as expired" do
+      responses = [Lita::Standups::Models::StandupResponse[1], Lita::Standups::Models::StandupResponse[2]]
+      responses[0].created_at = Time.now - 100_000
+      allow(Lita::Standups::Models::StandupResponse).to receive_message_chain(:find, :union).and_return(responses)
+      expect(responses[0]).to receive(:expired!)
+      expect(responses[0]).to receive(:save)
+      expect(Lita::Wizard).to receive(:cancel_wizard)
+      expect(robot).to receive(:send_message)
+      described_class.abort_expired_standups(robot: robot)
+    end
+
+    it "should post results on completed sessions" do
+      allow(Lita::Standups::Models::StandupSession).to receive(:find).and_return(["dummy"])
+      expect_any_instance_of(described_class).to receive(:post_results)
+      described_class.complete_finished_standups(robot: robot)
+    end
+  end
+
+  context "instance methods" do
+    context "running a session" do
+      it "should create a responses for each user" do
+        allow(Lita::Standups::Wizards::RunStandup).to receive(:start)
+        expect do
+          described_class.run(robot: robot, standup_id: "1", recipients: %w(1 2), room: "#a")
+        end.to change { Lita::Standups::Models::StandupResponse.all.count }.by(2)
+      end
+
+      it "should start the run wizard" do
+        expect(Lita::Standups::Wizards::RunStandup).to receive(:start)
+        described_class.run(robot: robot, standup_id: "1", recipients: %w(1), room: "#a")
+      end
+    end
+
+    context "posting results" do
+      it "should send a message" do
+        session = Lita::Standups::Models::StandupSession[1]
+        expect(robot).to receive(:send_message)
+        described_class.new(robot: robot, session: session).post_results
+      end
+
+      it "should set the results_sent flag on the session" do
+        session = Lita::Standups::Models::StandupSession[1]
+        allow(robot).to receive(:send_message)
+        expect do
+          described_class.new(robot: robot, session: session).post_results
+        end.to change { Lita::Standups::Models::StandupSession[1].results_sent }.to(true)
+      end
+
+      it "sholdn't post anything if already posted" do
+        session = Lita::Standups::Models::StandupSession[1]
+        session.results_sent = true
+        session.save
+        expect(robot).to receive(:send_message).never
+        described_class.new(robot: robot, session: session).post_results
+      end
+    end
+  end
+end