stealth 0.9.1

data/spec/flow/custom_transitions_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "custom transitions" do
+
+  class FetchTodosFlow
+    include Stealth::Flow
+
+    flow do
+      state :todays_todos do
+        event :fetch_tomorrows_todos, :transitions_to => :tomorrows_todos
+        event :fetch_yesterdays_todos, :transitions_to => :yesterdays_todos
+      end
+
+      state :tomorrows_todos do
+        event :view_todo, :transitions_to => :show
+        event :edit_todo, :transitions_to => :edit
+      end
+
+      state :tomorrows_todos do
+        event :view_todo, :transitions_to => :show
+        event :edit_todo, :transitions_to => :edit
+      end
+
+      state :show
+
+      state :edit do
+        event :save_todo, :transitions_to => :show
+        event :error_in_input, :transitions_to => :error
+      end
+
+      state :error
+    end
+
+    def view_todo(todo_id)
+      unless todo_id > 0
+        halt('ID is not valid.')
+      end
+
+      :the_todo
+    end
+
+    def edit_todo(todo_id)
+      unless todo_id > 0
+        halt('ID is not valid.')
+      end
+
+      :edit_todo_view
+    end
+
+    def save_todo(params)
+      if params.nil?
+        halt!('Invalid todo params specified.')
+      end
+
+      :todo_saved
+    end
+  end
+
+  let(:flow) { FetchTodosFlow.new }
+
+  it "should transition via custom transition methods" do
+    flow.fetch_tomorrows_todos!
+    expect(flow.view_todo!(1)).to eq :the_todo
+    expect(flow.current_state).to eq :show
+  end
+
+  it "should follow multiple custom transitions" do
+    flow.fetch_tomorrows_todos!
+    expect(flow.edit_todo!(1)).to eq :edit_todo_view
+    expect(flow.current_state).to eq :edit
+
+    expect(flow.save_todo!({ task: 'test' })).to eq :todo_saved
+    expect(flow.current_state).to eq :show
+  end
+
+  describe "halting transitions" do
+    it "should halt the transition when halt() is called" do
+      flow.fetch_tomorrows_todos!
+      flow.view_todo!(-1)
+      expect(flow.current_state).to eq :tomorrows_todos
+      expect(flow.halted_because).to eq "ID is not valid."
+    end
+
+    it "should halt the transition when halt!() is called and raise Stealth::Flow::TransitionHalted" do
+      flow.fetch_tomorrows_todos!
+      flow.edit_todo!(1)
+      expect(flow.current_state).to eq :edit
+
+      expect {
+        flow.save_todo!(nil)
+      }.to raise_error(Stealth::Flow::TransitionHalted)
+
+      expect(flow.halted_because).to eq "Invalid todo params specified."
+    end
+  end
+
+end

data/spec/flow/flow_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Stealth::Flow do
+
+  class NewTodoFlow
+    include Stealth::Flow
+
+    flow do
+      state :new do
+        event :submit_todo, :transitions_to => :get_due_date
+        event :error_in_input, :transitions_to => :error
+      end
+
+      state :get_due_date do
+        event :submit_due_date, :transitions_to => :created
+      end
+
+      state :created
+
+      state :error do
+        event :submit_todo, :transitions_to => :get_due_date
+        event :error_in_input, :transitions_to => :error
+      end
+    end
+  end
+
+  let(:flow) { NewTodoFlow.new }
+
+  describe "state transitions" do
+    it "should start out in the 'new' state" do
+      expect(flow.current_state).to eq :new
+    end
+
+    it "should transition into the 'get_due_date' state after submit" do
+      flow.submit_todo!
+      expect(flow.current_state).to eq :get_due_date
+    end
+
+    it "should transition into the 'error' state after error_in_input" do
+      flow.error_in_input!
+      expect(flow.current_state).to eq :error
+    end
+
+    it "should transition through multiple states" do
+      flow.submit_todo!
+      flow.submit_due_date!
+      expect(flow.current_state).to eq :created
+    end
+
+    it "should remain in the error state" do
+      flow.error_in_input!
+      expect(flow.current_state).to eq :error
+      flow.error_in_input!
+      expect(flow.current_state).to eq :error
+    end
+
+    it "should be false when checking the possibility of a non-valid transition" do
+      expect(flow.can_submit_due_date?).to be false
+    end
+
+    it "should be false when checking the possibility of a valid transition" do
+      flow.submit_todo!
+      expect(flow.can_submit_due_date?).to be true
+    end
+  end
+
+  describe "accessing states" do
+    it "should start out in the 'new' state" do
+      expect(flow.new?).to be true
+    end
+
+    it "should support comparing states" do
+      first_state = NewTodoFlow.flow_spec.states[:new]
+      last_state = NewTodoFlow.flow_spec.states[:error]
+      expect(first_state < last_state).to be true
+      expect(last_state > first_state).to be true
+    end
+
+    it "should allow every state to be fetched for the class" do
+      expect(NewTodoFlow.flow_spec.states.length).to eq 4
+      expect(NewTodoFlow.flow_spec.states.keys).to eq([:new, :get_due_date, :created, :error])
+    end
+
+    it "should return the states in an array for a given flow instance" do
+      expect(flow.states).to eq [:new, :get_due_date, :created, :error]
+    end
+  end
+
+end

data/spec/flow/transition_callbacks_spec.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "transition callbacks" do
+
+  class KonamiCodeFlow
+    include Stealth::Flow
+
+    attr_reader :code, :before_transition_count, :transition_count
+
+    def initialize
+      @code = []
+      @before_transition_count = 0
+      @transition_count = 0
+    end
+
+    flow do
+      state :up do
+        event :upward, :transitions_to => :up
+        event :downward, :transitions_to => :down
+      end
+
+      state :down do
+        event :downward, :transitions_to => :down
+        event :leftward, :transitions_to => :left
+      end
+
+      state :left do
+        event :rightward, :transitions_to => :right
+      end
+
+      state :right do
+        event :leftward, :transitions_to => :left
+        event :bward, :transitions_to => :b
+      end
+
+      state :a
+
+      state :b do
+        event :award, :transitions_to => :a
+      end
+
+      before_transition do |from, to, triggering_event, *event_args|
+        @before_transition_count += 1
+      end
+
+      after_transition do |from, to, triggering_event, *event_args|
+        @code << to.to_s
+      end
+
+      on_transition {
+        @transition_count += 1
+      }
+    end
+  end
+
+  let(:flow) { KonamiCodeFlow.new }
+
+  before(:each) do
+    flow.upward!
+    flow.upward!
+    flow.downward!
+    flow.downward!
+    flow.leftward!
+    flow.rightward!
+    flow.leftward!
+    flow.rightward!
+    flow.bward!
+    flow.award!
+  end
+
+  it "should have a correct transition count" do
+    expect(flow.transition_count).to eq 10
+  end
+
+  it "should have a correct before_transition count" do
+    expect(flow.before_transition_count).to eq 10
+  end
+
+  it "should have generated the correct code via after_transition" do
+    expect(flow.code).to eq(['up', 'up', 'down', 'down', 'left', 'right', 'left', 'right', 'b', 'a'])
+  end
+
+  describe "on_error callbacks" do
+    class ErrorFlow
+      include Stealth::Flow
+
+      attr_reader :errors
+
+      def initialize
+        @errors = {}
+      end
+
+      flow do
+        state :first do
+          event :advance, :transitions_to => :second do
+            raise "uh oh"
+          end
+        end
+
+        state :second
+
+        on_error do |error, from, to, event, *args|
+          @errors.merge!({
+            error: error.class,
+            from: from,
+            to: to,
+            event: event,
+            args: args
+          })
+        end
+      end
+    end
+
+    let(:error_flow) { ErrorFlow.new }
+
+    it "should not advance to the next state" do
+      error_flow.advance!
+      expect(error_flow.current_state).to eq :first
+    end
+
+    it "should call the on_error block" do
+      error_flow.advance!
+      expect(error_flow.errors).to eq({ error: RuntimeError, from: :first, to: :second, event: :advance, args: [] })
+    end
+  end
+
+  describe "on_entry and on_exit callbacks" do
+    class PostFlow
+      include Stealth::Flow
+
+      attr_reader :email_reviewer, :tweet_link
+
+      def initialize
+        @email_reviewer = false
+        @tweet_link = false
+      end
+
+      flow do
+        state :draft do
+          event :submit_for_review, :transitions_to => :in_review
+
+          on_exit do
+            @email_reviewer = true
+          end
+        end
+
+        state :in_review do
+          event :approve, :transitions_to => :live
+          event :reject, :transitions_to => :draft
+        end
+
+        state :live do
+          on_entry do
+            @tweet_link = true
+          end
+        end
+      end
+    end
+
+    let(:post_flow) { PostFlow.new }
+
+    it "should email the reviewer when flow transitions (on_exit) to in_review" do
+      expect {
+        post_flow.submit_for_review!
+      }.to change(post_flow, :email_reviewer).from(false).to(true)
+    end
+
+    it "should tweet the post link when flow transitions (on_entry) to live" do
+      post_flow.submit_for_review!
+
+      expect {
+        post_flow.approve!
+      }.to change(post_flow, :tweet_link).from(false).to(true)
+    end
+  end
+
+  describe "on_entry and on_exit method-style callbacks" do
+    class ConcisePostFlow
+      include Stealth::Flow
+
+      attr_reader :email_reviewer, :tweet_link
+
+      def initialize
+        @email_reviewer = false
+        @tweet_link = false
+      end
+
+      flow do
+        state :draft do
+          event :submit_for_review, :transitions_to => :in_review
+        end
+
+        state :in_review do
+          event :approve, :transitions_to => :live
+          event :reject, :transitions_to => :draft
+        end
+
+        state :live
+      end
+
+      def on_draft_exit(new_state, event, *args)
+        @email_reviewer = true
+      end
+
+      def on_live_entry(prior_state, event, *args)
+        @tweet_link = true
+      end
+    end
+
+    let(:post_flow) { ConcisePostFlow.new }
+
+    it "should email the reviewer when flow transitions (on_exit) to in_review" do
+      expect {
+        post_flow.submit_for_review!
+      }.to change(post_flow, :email_reviewer).from(false).to(true)
+    end
+
+    it "should tweet the post link when flow transitions (on_entry) to live" do
+      post_flow.submit_for_review!
+
+      expect {
+        post_flow.approve!
+      }.to change(post_flow, :tweet_link).from(false).to(true)
+    end
+  end
+end

data/spec/replies/nested_reply_with_erb.yml

@@ -0,0 +1,16 @@
+- reply_type: text
+  text: "Hi, <%= first_name %>. Welcome to Stealth bot..."
+- reply-type: delay
+  duration: 2
+- reply_type: text
+  text: "We offer users an awesome Ruby framework for building chat bots."
+- reply-type: delay
+  duration: 2
+- reply_type: text
+  text: "What do you think of our bot?"
+  buttons:
+    - text: "Cool"
+      payload: cool
+    - text: "Show me more"
+      payload: more
+

data/spec/sample_services_yml/services.yml

@@ -0,0 +1,31 @@
+default: &default
+  facebook:
+    verify_token: c68823f4-7259-4600-b9f0-382a67260757
+    challenge: pOmQ7iq4ZA1hK6TbO7yrVZCmygVjfIiEIYaIZAlEveOAzY4UKb
+    page_access_token: EAADhbJruBbMBAKY9bnesHh9eM09ZAHjGsCQtNdvuZClZCFtyIXdFdIQI2mV0PJM910Qyn3lNNhZBPZB54zLRhDNmeIkDz9myS25CTy0kFxHjQCXJxz5oeZCD60VWdAZAFxbeDKvF8eF28qDHAI4wkGc3jvVhjFISKmmFRRM6goUeAZDZD
+    setup:
+      greeting: # Greetings are broken up by locale
+        - locale: default
+          text: "Welcome to the Stealth bot 🤖"
+      persistent_menu:
+        - type: payload
+          text: Main Menu
+          payload: main_menu
+        - type: url
+          text: Visit our website
+          url: https://example.com
+        - type: call
+          text: Call us
+          payload: "+17345551234"
+  twilio_sms:
+    account_sid: BC6f4bd46307054c84fdff70badcd9ef5d
+    auth_token: 4af73d27d92cff6391611a9c976725cc
+
+production:
+  <<: *default
+
+development:
+  <<: *default
+
+test:
+  <<: *default

data/spec/sample_services_yml/services_with_erb.yml

@@ -0,0 +1,31 @@
+default: &default
+  facebook:
+    verify_token: <%= ENV['FACEBOOK_VERIFY_TOKEN'] %>
+    challenge: <%= ENV['FACEBOOK_CHALLENGE'] %>
+    page_access_token: <%= ENV['FACEBOOK_PAGE_ACCESS_TOKEN'] %>
+    setup:
+      greeting: # Greetings are broken up by locale
+        - locale: default
+          text: "Welcome to the Stealth bot 🤖"
+      persistent_menu:
+        - type: payload
+          text: Main Menu
+          payload: main_menu
+        - type: url
+          text: Visit our website
+          url: https://example.com
+        - type: call
+          text: Call us
+          payload: "+17345551234"
+  twilio_sms:
+    account_sid: <%= ENV['TWILIO_ACCOUNT_SID'] %>
+    auth_token: <%= ENV['TWILIO_AUTH_TOKEN'] %>
+
+production:
+  <<: *default
+
+development:
+  <<: *default
+
+test:
+  <<: *default

data/spec/service_reply_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Stealth::ServiceReply" do
+
+  describe "nested reply with ERB" do
+    let(:recipient_id) { "8b3e0a3c-62f1-401e-8b0f-615c9d256b1f" }
+    let(:yaml_reply) { File.read(File.join(File.dirname(__FILE__), 'replies', 'nested_reply_with_erb.yml')) }
+
+    it "should load all the replies" do
+      first_name = "Presley"
+
+      service_reply = Stealth::ServiceReply.new(
+        recipient_id: recipient_id,
+        yaml_reply: yaml_reply,
+        context: binding
+      )
+
+      expect(service_reply.replies.size).to eq 5
+    end
+
+    it "should raise Stealth::Errors::UndefinedVariable when local variable is not available" do
+      expect {
+        service_reply = Stealth::ServiceReply.new(
+          recipient_id: recipient_id,
+          yaml_reply: yaml_reply,
+          context: binding
+        )
+      }.to raise_error(Stealth::Errors::UndefinedVariable)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+
+require 'stealth'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+
+end

data/spec/version_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Stealth::Version" do
+
+  let(:version_in_file) { File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip }
+
+  it "should return the current gem version" do
+    expect(Stealth::Version.version).to eq version_in_file
+  end
+
+  it "should return the current gem version via a constant" do
+    expect(Stealth::VERSION).to eq version_in_file
+  end
+end

data/stealth.gemspec

@@ -0,0 +1,30 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+version = File.read(File.join(File.dirname(__FILE__), 'VERSION')).strip
+
+Gem::Specification.new do |s|
+  s.name = 'stealth'
+  s.summary = 'Ruby framework for conversational bots'
+  s.description = 'Ruby framework for building conversational bots.'
+  s.homepage = 'https://github.com/whoisblackops/stealth'
+  s.version = version
+  s.author = 'Mauricio Gomes'
+  s.email = 'mauricio@edge14.com'
+
+  s.add_dependency 'sinatra', '~> 2.0.0'
+  s.add_dependency 'puma', '~> 3.10.0'
+  s.add_dependency 'thor', '~> 0.20'
+  s.add_dependency 'multi_json', '~> 1.12'
+  s.add_dependency 'faraday', '~> 0.13'
+  s.add_dependency 'sidekiq', '~> 5.0'
+  s.add_dependency 'activesupport', '~> 5.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6.0'
+  s.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
+  s.add_development_dependency 'rack-test', '~> 0.7.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end