Stages, sometimes also called wizards or conversations, are a simple way to add a bit of life to your bot. They allow you to send input and wait for feedback before proceeding. For example, say your bot was being used to register a user for a service. You could ask questions like "What is your full name?" or "Would you have expected the Spanish Inquisition?" and receive responses.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
Stages are composed of steps which are created either with [Stage#on][Tourmaline::Stage#on(step,initial,&)] or with the Step annotation. If a step is tagged with
initial: true it will be the first step in the series. If no step is tagged with
initial: true you will have to manually transition to the step you want to start with by using [Stage#transition][Stage#transition(event)].
The main caviat, and it's a small one, is that you must either transition or exit from a step. If you don't your program will be stuck in a sort of limbo.
Here is an example of a simple transition:
@[Step(:name, initial: true)] def ask_name(client) send_message(self.chat_id, "What is your name?") self.await_response do |ctx| self.context.name = ctx.text self.transition :age end end @[Step(:age)] def ask_age(client) send_message(self.chat_id, "How about your age?") self.await_response do |ctx| self.context.age = ctx.age self.exit end end
For a more example of Stage use, see examples/stage_bot.cr.