lita-wizard 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0713263b1b47aac699bf0284c07c6fae25ec0c64
+  data.tar.gz: 3f292a189e77cdb39200411c52506cd93518d973
+SHA512:
+  metadata.gz: 735eb9a13455a661717c83cc7f45abd4a086c7f970ff7399882d3dbf89717c9e3d197d7a30ca28e5f417f88652c73bacf9a386fc69b0eb1c53166cf299b7ccb9
+  data.tar.gz: 68b19a18b16e2b836882060236b60cf8c06c0f1eee5bd60ab93ba2c4fed758139646194145717b4a7773baa69e8ba76f8e6c64c2499389494418dc72d12444c3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format=documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,51 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+
+Style/Encoding:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  []
+    '%i': []
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': []
+    '%w': []
+    '%W': []
+    '%x': ()
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/GuardClause:
+  MinBodyLength: 1
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.3.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,37 @@
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Cristian Bica
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# lita-wizard
+
+[![Build Status](https://travis-ci.org/cristianbica/lita-wizard.png?branch=master)](https://travis-ci.org/cristianbica/lita-wizard)
+[![Coverage Status](https://coveralls.io/repos/cristianbica/lita-wizard/badge.png)](https://coveralls.io/r/cristianbica/lita-wizard)
+
+A lita extension to build wizards (surveys, standups, etc). You can instruct your chat bot to ask several questions, validate responses.
+
+## Installation
+
+Add lita-wizard to your Lita plugin's gemspec:
+
+``` ruby
+spec.add_runtime_dependency "lita-wizard"
+```
+
+## Usage
+
+Create a subclass of `Lita::Wizard`
+
+``` ruby
+class MyWizard
+
+  # provide the wizard steps
+  step :name, label: "Your name:"
+  step :bio, label: "Tell me something about yourself:", multiline: true
+  step :lang, label: "What's your preferred programming language?", options: %w(ruby php)
+  step :years, label: "For how many years you're a programmer?", validate: /\d+/
+  step :really, label: "Really?", options: %w(yes no), if: ->(wizard) { value_for(:years).to_i > 15 }
+
+  # or you can have dynamic wizard steps
+  
+  def steps
+    # return an array of objects responding to the following methods:
+    # name: a string / symbol
+    # lable: a string
+    # multiline: boolean
+    # (optional) validate: regexp
+    # (optional) options: array
+    # (optional) if: a proc
+  end
+
+  # you can override the following methods to customize the messages
+
+  def initial_message
+    "Great! I'm going to ask you some questions. During this time I cannot take regular commands. " \
+    "You can abort at any time by writing abort"
+  end
+
+  def abort_message
+    "Aborting. Resume your normal operations"
+  end
+
+  def final_message
+    "You're done!"
+  end
+
+  # You can implement the following methods to customize the wizard behaviour.
+  # The wizard has an instance method `meta` which contains some data you
+  # set when starting the wizard
+
+  def start_wizard
+  end
+
+  def abort_wizard
+  end
+
+  def finish_wizard
+  end
+
+end
+```
+
+In your handler call `start_wizard` to initialize the process
+
+
+``` ruby
+route /^some command$/, :a_callback
+
+def a_callback(request)
+  start_wizard(Mywizard, request.message, some_data: 1, other_data: 2)
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/cristianbica/lita-wizard/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-wizard.rb

@@ -0,0 +1,10 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/wizard"
+require "lita/extensions/wizard"
+require "lita/handlers/wizard"
+require "lita/wizard_handler_mixin"

data/lib/lita/extensions/wizard.rb

@@ -0,0 +1,26 @@
+module Lita
+  module Extensions
+    class Wizard
+      def self.call(payload)
+        message = payload[:message]
+        route = payload[:route]
+        robot = payload[:robot]
+
+        # mark message as processed and return next time
+        return true if message.extensions[:processed_by_wizard]
+        message.extensions[:processed_by_wizard] = true
+
+        # if private messages and user has a pending wizard handle the message
+        if message.private_message? && Lita::Wizard.pending_wizard?(message.user.id)
+          handled = Lita::Wizard.handle_message(robot, message)
+          return true if handled
+        end
+
+        # return
+        !(route.extensions[:dummy] == true)
+      end
+
+      Lita.register_hook(:validate_route, self)
+    end
+  end
+end

data/lib/lita/handlers/wizard.rb

@@ -0,0 +1,10 @@
+module Lita
+  module Handlers
+    class Wizard < Handler
+      route(/.*/, nil, dummy: true) do |response|
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita/wizard.rb

@@ -0,0 +1,194 @@
+require 'ostruct'
+
+class Lita::Wizard
+
+  attr_accessor :id, :robot, :message, :user_id, :current_step_index, :values, :meta
+
+  def initialize(robot, message, data = {})
+    @id = data['id'] || SecureRandom.hex(3)
+    @robot = robot
+    @message = message
+    @user_id = message.user.id
+    @current_step_index = (data['current_step_index'] || -1).to_i
+    @values = data['values'] || []
+    @meta = data['meta']
+  end
+
+  def advance
+    self.current_step_index += 1
+    save
+    if final_step?
+      finish_wizard
+      send_message final_message
+      destroy
+    elsif run_current_step?
+      if first_step?
+        start_wizard
+        send_message initial_message
+      end
+      message = step[:label]
+      message = "#{message} (Write done when finished)" if step[:multiline]
+      send_message message
+    else
+      advance
+    end
+  end
+
+  def handle_message
+    if message.body == "abort"
+      send_message abort_message
+      abort_wizard
+      destroy
+    elsif step.nil?
+      send_message "Some error occured. Aborting."
+      destroy
+    elsif message.body == "done" && step[:multiline]
+      save
+      advance
+    elsif valid_response?
+      if step[:multiline]
+        values[current_step_index] ||= ""
+        values[current_step_index] << "\n"
+        values[current_step_index] << message.body
+        values[current_step_index].strip!
+        save
+      else
+        values[current_step_index] = message.body
+        save
+        advance
+      end
+    else
+      send_message @error_message
+    end
+  end
+
+  def save
+    Lita.redis["pending-wizard-#{user_id.downcase}"] = to_json
+  end
+
+  def destroy
+    Lita.redis.del "pending-wizard-#{user_id.downcase}"
+  end
+
+  def to_json
+    MultiJson.dump(as_json)
+  end
+
+  def as_json
+    {
+      'class' => self.class.name,
+      'id' => id,
+      'user_id' => user_id,
+      'current_step_index' => current_step_index,
+      'values' => values,
+      'meta' => meta
+    }
+  end
+
+  def step
+    steps[current_step_index]
+  end
+
+  def steps
+    self.class.steps
+  end
+
+  def run_current_step?
+    step[:if].nil? || instance_eval(&step[:if])
+  end
+
+  def final_step?
+    current_step_index == steps.size
+  end
+
+  def first_step?
+    current_step_index == 0
+  end
+
+  def value_for(step_name)
+    values[step_index(step_name)]
+  end
+
+  def step_index(step_name)
+    steps.index { |step| step.name == step_name }
+  end
+
+  def valid_response?
+    if step[:validate] && !step[:validate].match(message.body)
+      @error_message = 'Invalid format'
+      false
+    elsif step[:options] && !step[:options].include?(message.body)
+      @error_message = "Invalid response. Valid options: #{step[:options].join(', ')}"
+      false
+    else
+      true
+    end
+  end
+
+  def initial_message
+    "Great! I'm going to ask you some questions. During this time I cannot take regular commands. " \
+    "You can abort at any time by writing abort"
+  end
+
+  def abort_message
+    "Aborting. Resume your normal operations"
+  end
+
+  def final_message
+    "You're done!"
+  end
+
+  def start_wizard
+  end
+
+  def abort_wizard
+  end
+
+  def finish_wizard
+  end
+
+  def send_message(body)
+    message.reply body
+  end
+
+  class << self
+
+    def start(robot, message, meta = {})
+      return false if pending_wizard?(message.user.id)
+      wizard = new(robot, message, 'meta' => meta)
+      wizard.advance
+      true
+    end
+
+    def handle_message(robot, message)
+      return false unless pending_wizard?(message.user.id)
+      wizard = restore(robot, message)
+      if wizard
+        wizard.handle_message
+        return true
+      end
+      false
+    end
+
+    def restore(robot, message)
+      data = MultiJson.load(Lita.redis["pending-wizard-#{message.user.id.downcase}"])
+      klass = eval(data['class'])
+      klass.new(robot, message, data)
+    rescue
+      nil
+    end
+
+    def pending_wizard?(user_id)
+      Lita.redis["pending-wizard-#{user_id.downcase}"]
+    end
+
+    def step(name, options = {})
+      steps << OpenStruct.new(options.merge(name: name))
+    end
+
+    def steps
+      @steps ||= []
+    end
+
+  end
+end

data/lib/lita/wizard_handler_mixin.rb

@@ -0,0 +1,11 @@
+module Lita
+  module WizardHandlerMixin
+    def start_wizard(klass, message, meta = {})
+      klass.start(robot, message, meta)
+    end
+  end
+
+  class Handler
+    prepend WizardHandlerMixin
+  end
+end

data/lita-wizard.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-wizard"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Cristian Bica"]
+  spec.email         = ["cristian.bica@gmail.com"]
+  spec.description   = "A lita extension to build wizards"
+  spec.summary       = "A lita extension to build wizards (surveys, standups, etc)"
+  spec.homepage      = "https://github.com/cristianbica/lita-wizard"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "extension" }
+
+  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_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:
+    extensions:
+      wizard:

data/spec/lita/extensions/wizard_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Lita::Extensions::Wizard, lita: true do
+  let(:robot) { Lita::Robot.new(registry) }
+  let(:user) { Lita::User.create(42, name: "User") }
+  let(:room) { Lita::Room.create_or_update("#a", name: "#a") }
+  let(:message) { Lita::Message.new(robot, "test", Lita::Source.new(user: user, room: room, private_message: false)) }
+  let(:route) do
+    Lita::Handler::ChatRouter::Route.new.tap do |route|
+      route.extensions = {}
+    end
+  end
+  let(:payload) do
+    {
+      robot: robot,
+      message: message,
+      route: route
+    }
+  end
+
+  it "should stop if message has already been processed" do
+    message.extensions[:processed_by_wizard] = true
+    expect(message.extensions).to receive(:[]=).never
+    described_class.call(payload)
+  end
+
+  it "should mark the message as processed" do
+    expect(message.extensions).to receive(:[]=).with(:processed_by_wizard, true)
+    described_class.call(payload)
+  end
+
+  it "should check if the message is private" do
+    expect(message).to receive(:private_message?)
+    described_class.call(payload)
+  end
+
+  it "shouldn't check if the user has a pending message if the message is public" do
+    allow(message).to receive(:private_message?).and_return(false)
+    expect(Lita::Wizard).to receive(:pending_wizard?).never
+    described_class.call(payload)
+  end
+
+  it "should check if the user has a pending message" do
+    allow(message).to receive(:private_message?).and_return(true)
+    expect(Lita::Wizard).to receive(:pending_wizard?)
+    described_class.call(payload)
+  end
+
+  it "try to handle the message if private message and has pending wizard" do
+    allow(message).to receive(:private_message?).and_return(true)
+    allow(Lita::Wizard).to receive(:pending_wizard?).and_return(true)
+    expect(Lita::Wizard).to receive(:handle_message)
+    described_class.call(payload)
+  end
+
+  it "should return false if dummy route matched" do
+    route.extensions[:dummy] = true
+    expect(described_class.call(payload)).to be_falsey
+  end
+
+  it "should return true if dummy route didn't match" do
+    expect(described_class.call(payload)).to be_truthy
+  end
+end

data/spec/lita/integration_spec.rb

@@ -0,0 +1,122 @@
+require "spec_helper"
+
+describe Lita::Handlers::Wizard, lita: true, lita_handler: true do
+
+  before do
+    robot.registry.register_hook(:validate_route, Lita::Extensions::Wizard)
+  end
+
+  def store_wizard(data = {})
+    data = data.merge(class: "TestWizard")
+    Lita.redis["pending-wizard-1"] = data.to_json
+  end
+
+  it "should ignore messages if no pending wizard" do
+    send_message("test message", privately: true)
+    expect(replies).to be_empty
+  end
+
+  it "should reply with the initial message if it's the first step" do
+    message = Lita::Message.new(robot, "test", source)
+    TestWizard.start(robot, message)
+    expect(replies.first).to eq("initial message")
+  end
+
+  it "should call the start_wizard method if it's the first step" do
+    message = Lita::Message.new(robot, "test", source)
+    expect_any_instance_of(TestWizard).to receive(:start_wizard)
+    TestWizard.start(robot, message)
+  end
+
+  it "should reply with the first question when started the wizard" do
+    message = Lita::Message.new(robot, "test", source)
+    TestWizard.start(robot, message)
+    expect(replies.last).to eq("step one:")
+  end
+
+
+  it "should accept the answer of the first question" do
+    message = Lita::Message.new(robot, "test", source)
+    TestWizard.start(robot, message)
+    send_message("response", privately: true)
+    expect(replies.last).to match /^step two/
+  end
+
+  it "should accept the answer for a single message question" do
+    store_wizard(current_step_index: 0)
+    send_message("response-one", privately: true)
+    expect(replies.last).to match /^step two/
+  end
+
+  it "should accept the answer for a multiline message question" do
+    store_wizard(current_step_index: 1)
+    send_message("response-two line 1", privately: true)
+    send_message("response-two line 2", privately: true)
+    send_message("done", privately: true)
+    expect(replies.last).to match /^step three/
+  end
+
+  it "should skip question which return false from the if block" do
+    store_wizard(current_step_index: 2)
+    send_message("response-three", privately: true)
+    expect(replies.last).to match /^step five/
+  end
+
+  it "should not accept answer not matching the provided regexp" do
+    store_wizard(current_step_index: 4)
+    send_message("abc", privately: true)
+    expect(replies.last).to match /^Invalid format/
+  end
+
+  it "should accept answer matching the provided regexp" do
+    store_wizard(current_step_index: 4)
+    send_message("123", privately: true)
+    expect(replies.last).to match /^step six/
+  end
+
+  it "should not accept answer not in the options list" do
+    store_wizard(current_step_index: 5)
+    send_message("abc", privately: true)
+    expect(replies.last).to match /^Invalid response/
+  end
+
+  it "should accept answer in the options list" do
+    store_wizard(current_step_index: 5)
+    send_message("one", privately: true)
+    expect(replies.last).to match /^final message/
+  end
+
+  it "should reply with the last message when answering the last question" do
+    store_wizard(current_step_index: 5)
+    send_message("one", privately: true)
+    expect(replies.last).to match /^final message/
+  end
+
+  it "should call the finish_wizard method when answering the last question" do
+    store_wizard(current_step_index: 5)
+    expect_any_instance_of(TestWizard).to receive(:finish_wizard)
+    send_message("one", privately: true)
+  end
+
+  it "should abort the wizard if requested by the user" do
+    store_wizard(current_step_index: 0)
+    send_message("abort", privately: true)
+    puts replies.inspect
+    expect(Lita::Wizard.pending_wizard?("1")).to be_falsey
+  end
+
+  it "should send the abort message when aborting" do
+    store_wizard(current_step_index: 0)
+    send_message("abort", privately: true)
+    expect(replies.last).to match /^abort message/
+  end
+
+  it "should call the abort_wizard method if requested by the user" do
+    store_wizard(current_step_index: 0)
+    expect_any_instance_of(TestWizard).to receive(:abort_wizard)
+    send_message("abort", privately: true)
+  end
+
+
+
+end

data/spec/lita/wizard_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+
+describe Lita::Wizard, lita: true do
+  let(:robot) { Lita::Robot.new(registry) }
+  let(:user) { Lita::User.create(42, name: "User") }
+  let(:room) { Lita::Room.create_or_update("#a", name: "#a") }
+  let(:message) { Lita::Message.new(robot, "test", Lita::Source.new(user: user, room: room, private_message: false)) }
+
+  context "starting a wizard" do
+    after { Lita::Wizard.start(robot, message) }
+    it "should check if a pending wizard exists for that user" do
+      expect(Lita::Wizard).to receive(:pending_wizard?).with("42").and_return(true)
+
+    end
+
+    it "should try to start a new wizard if a pending one exists" do
+      allow(Lita::Wizard).to receive(:pending_wizard?).and_return(true)
+      expect(Lita::Wizard).to receive(:new).never
+    end
+
+    it "should initialize a new wizard class an advance" do
+      mocked_wizard = double
+      expect(mocked_wizard).to receive(:advance)
+      allow(Lita::Wizard).to receive(:pending_wizard?).and_return(false)
+      expect(Lita::Wizard).to receive(:new).and_return(mocked_wizard)
+    end
+  end
+
+  context "handling messages" do
+    after { Lita::Wizard.handle_message(robot, message) }
+
+    it "should handle message if there isn't a pending wizard" do
+      allow(Lita::Wizard).to receive(:pending_wizard?).and_return(false)
+      expect(Lita::Wizard).to receive(:restore).never
+    end
+
+    it "should try to restore the wizard" do
+      allow(Lita::Wizard).to receive(:pending_wizard?).and_return(true)
+      expect(Lita::Wizard).to receive(:restore).once
+    end
+
+    it "should restore the wizard and forward the message to be handled" do
+      allow(Lita::Wizard).to receive(:pending_wizard?).and_return(true)
+      mocked_wizard = double
+      expect(mocked_wizard).to receive(:handle_message)
+      expect(Lita::Wizard).to receive(:restore).and_return(mocked_wizard)
+    end
+  end
+
+  context "restoring wizards" do
+    it "should return nil if there's no saved wizard" do
+      expect(Lita::Wizard.restore(robot, message)).to be_nil
+    end
+
+    it "should return nil if data is malformed" do
+      expect(Lita::Wizard.restore(robot, message)).to be_nil
+    end
+
+    it "should restore the wizard", :focus do
+      data = { class: "TestWizard", arg1: "43" }
+      Lita.redis["pending-wizard-42"] = data.to_json
+      expect(TestWizard).to receive(:new)#.with(robot, message, data)
+      Lita::Wizard.restore(robot, message)
+    end
+  end
+
+  context "checking for a pending wizard" do
+    it "should return true if a pending wizard was saved" do
+      Lita.redis["pending-wizard-42"] = "1"
+      expect(Lita::Wizard.pending_wizard?("42")).to be_truthy
+    end
+
+    it "should return false if no pending wizards saved" do
+      expect(Lita::Wizard.pending_wizard?("42")).to be_falsey
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-wizard"
+require "lita/rspec"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f }
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

data/spec/support/test_wizard.rb

@@ -0,0 +1,38 @@
+class TestWizard < Lita::Wizard
+
+  step :one,
+       label: 'step one:'
+
+  step :two,
+       label: 'step two:',
+       multiline: true
+
+  step :three,
+       label: 'step three:',
+       if: ->(_) { true }
+
+  step :four,
+       label: 'step four:',
+       if: ->(_) { false }
+
+  step :five,
+       label: 'step five:',
+       validate: /\d{3}/
+
+  step :six,
+       label: 'step six:',
+       options: %w(one two)
+
+  def initial_message
+    "initial message"
+  end
+
+  def abort_message
+    "abort message"
+  end
+
+  def final_message
+    "final message"
+  end
+
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: lita-wizard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cristian Bica
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A lita extension to build wizards
+email:
+- cristian.bica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-wizard.rb
+- lib/lita/extensions/wizard.rb
+- lib/lita/handlers/wizard.rb
+- lib/lita/wizard.rb
+- lib/lita/wizard_handler_mixin.rb
+- lita-wizard.gemspec
+- locales/en.yml
+- spec/lita/extensions/wizard_spec.rb
+- spec/lita/integration_spec.rb
+- spec/lita/wizard_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_wizard.rb
+homepage: https://github.com/cristianbica/lita-wizard
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: extension
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A lita extension to build wizards (surveys, standups, etc)
+test_files:
+- spec/lita/extensions/wizard_spec.rb
+- spec/lita/integration_spec.rb
+- spec/lita/wizard_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_wizard.rb
+has_rdoc: