stealth 2.0.0.beta2 → 2.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acde4522ee0154ec5557379bfd1fa928e89771637e4c3dd99880adb624b7c2f7
-  data.tar.gz: f30cc740eb9c40fb90c19cbe35a27cf12ce24209245813d338db25df61ca238a
+  metadata.gz: 24ba7ba55d264e21395db7b9166ecf96064c2c0d8c8bc51d09dd274ecaf5fd34
+  data.tar.gz: c42254f819550577f249fddb13266cfa6bc8e2f27760994e3efdf7798447ecdd
 SHA512:
-  metadata.gz: 63ad339fe8d1473ab1118eef9279cf66f1a895748fe61ca7671d49ca8de635fe27f9e4f200c1ae05523501f62e135eb4147d3609f9550c920311498a7abfa26c
-  data.tar.gz: cbcc9083bb56acc3d30aedbcc6a853fb71cf5a57b0586e81b586c36d1f186c5bc39cf5acf6d03768c86c486c7a6ff987ca5e151248cf43c34b70b21778c285ef
+  metadata.gz: 3f1af77ae1b811b4f53f85df2365fae399efe6caf9db77a801898250dfcdb732e366b06efa1641b255eda53e2a22fff38ca7a8ebd6577d6dcf860509d002c261
+  data.tar.gz: 7146a30ad60302ccc322e6691c6676b6b281dee1625bc1acf674e133b87d371b5cc470c5d3d4eb6d50526d33992a81f424364fbf4b10e23d93910aed815b5864

data/.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2
 jobs:
   ruby_2_6:
     docker:
-      - image: circleci/ruby:2.6-node-browsers
+      - image: cimg/ruby:2.6
         environment:
           STEALTH_ENV: test
 
@@ -56,7 +56,115 @@ jobs:
           destination: test-results
   ruby_2_7:
     docker:
-      - image: circleci/ruby:2.7-node-browsers
+      - image: cimg/ruby:2.7
+        environment:
+          STEALTH_ENV: test
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                --format RspecJunitFormatter \
+                --out /tmp/test-results/rspec.xml \
+                --format progress \
+                -- \
+                $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+  ruby_3_0:
+    docker:
+      - image: cimg/ruby:3.0
+        environment:
+          STEALTH_ENV: test
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                --format RspecJunitFormatter \
+                --out /tmp/test-results/rspec.xml \
+                --format progress \
+                -- \
+                $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+  ruby_3_1:
+    docker:
+      - image: cimg/ruby:3.1
         environment:
           STEALTH_ENV: test
 
@@ -114,3 +222,5 @@ workflows:
     jobs:
       - ruby_2_6
       - ruby_2_7
+      - ruby_3_0
+      - ruby_3_1

data/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Enhancements
 
+* Added support for Ruby 3.0
 * [Controllers] Added support for Dev Jumping. This feature allows developers to jump around flows and states for bot's in development.
 * [NLP] Added base classes for `Stealth::Nlp::Result` and `Stealth::Nlp::Client` to be used by NLP drivers.
 * [Controllers] Scheduled replies no longer call `controller.route` when they run. Instead we `step_to` to the flow and state directly. This ensures the `route` is reserved for incoming messages.
@@ -13,7 +14,8 @@
 * [Logging] `primary_session`, `previous_session`, and `back_to_session` now explicitly logged
 * [Sessions] The session is no longer set on update or stepping witht destination flow and state match the existing session.
 * [Scheduled Replies] The `service_message.target_id` is now set for scheduled replies. NOTE: scheduled replies that are already enqueued will NOT have this set.
-* [Server] Updated to Puma 4.3
+* [Server] Updated to Puma 5.5
+* [Server] Updated to Sidekiq 6.3
 * [Server] Updated to Sinatra 2.1
 * [Sessions] Added `to_s` for sessions to pretty print the slug. Useful when debugging.
 * `send_reples` now supports two additional options for replies:
@@ -40,7 +42,7 @@
 * [Controllers] `normalized_msg` and `homophone_translated_msg` are now memoized for performance.
 * [Errors] `Stealth::Errors::MessageNotRecognized` has been renamed to `Stealth::Errors::UnrecognizedMessage`
 * [Controllers] When `handle_message` or `get_match` raise a `Stealth::Errors::UnrecognizedMessage`, the user is first routed to a new `UnrecognizedMessagesController` to perform NLP. If that controller fails to match, the `catch_all` is run as normal.
-* [Errors] Client errors now call respective BotController actions: `handle_opt_out` and `handle_invalid_session_id`. Each client is responsible for raising `Stealth::Errors::UserOptOut` or `Stealth::Errors::InvalidSessionId` errors.
+* [Errors] Client errors now call respective BotController actions: `handle_opt_out`, `handle_invalid_session_id`, `handle_message_filtered`, `handle_unknown_error`. Each client is responsible for raising `Stealth::Errors::UserOptOut`, `Stealth::Errors::InvalidSessionId`, `Stealth::Errors::MessageFiltered`, `Stealth::Errors::UnknownError` errors, respectively.
 * [Controllers] `handle_message` and `get_match` now detect homophones for alpha ordinals (A-Z)
 * [Controllers] `handle_message` and `get_match` now ignore single and double quotes for alpha-ordinals
 * [CoreExt] Strings now have a `normalize` method for removing padding and quotes
@@ -51,6 +53,9 @@
 * [Controllers] `handle_message` now supports `Regexp` keys.
 * [Configuration] `database.yml` is now parsed with ERB in order to support environment variables. Thanks @malkovro.
 * [Replies] Speech and SSML replies now use `speech` and `ssml` as keys, respectively, instead of `text`
+* [Replies] Voice services (determined by having "voice" in the name) now automatically skip auto-delays.
+* [Controllers] `current_message` now has a `confidence` attribute containing a float with the confidence value of the transcription (from 0 to 1).
+* [Controllers] Added a `halt!` method that can be used with the controller error handlers to stop code execution.
 
 ## Bug Fixes
 

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    stealth (2.0.0.beta2)
+    stealth (2.0.0.beta5)
       activesupport (~> 6.0)
       multi_json (~> 1.12)
-      puma (>= 4.2, < 5.0)
+      puma (>= 4.2, < 6.0)
       sidekiq (~> 6.0)
       sinatra (~> 2.0)
       thor (~> 1.0)
@@ -12,32 +12,32 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activesupport (6.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.7)
-    connection_pool (2.2.3)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.2.5)
     diff-lcs (1.3)
-    i18n (1.8.5)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.2)
+    minitest (5.15.0)
     mock_redis (0.23.0)
     multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
-    nio4r (2.5.4)
+    nio4r (2.5.8)
     oj (3.10.6)
-    puma (4.3.7)
+    puma (5.6.2)
       nio4r (~> 2.0)
     rack (2.2.3)
-    rack-protection (2.1.0)
+    rack-protection (2.2.0)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    redis (4.2.5)
+    redis (4.6.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -53,21 +53,21 @@ GEM
     rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    ruby2_keywords (0.0.2)
-    sidekiq (6.1.2)
+    ruby2_keywords (0.0.5)
+    sidekiq (6.4.1)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
       redis (>= 4.2.0)
-    sinatra (2.1.0)
+    sinatra (2.2.0)
       mustermann (~> 1.0)
       rack (~> 2.2)
-      rack-protection (= 2.1.0)
+      rack-protection (= 2.2.0)
       tilt (~> 2.0)
-    thor (1.0.1)
+    thor (1.2.1)
     tilt (2.0.10)
-    tzinfo (2.0.3)
+    tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -81,4 +81,4 @@ DEPENDENCIES
   stealth!
 
 BUNDLED WITH
-   2.1.4
+   2.2.32

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2020 Mauricio Gomes, Mav Automation Ventures Inc.
+Copyright (c) 2017-2020 Mauricio Gomes
 
 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:
 

data/README.md

@@ -2,7 +2,8 @@
 
 Stealth is a Ruby framework for creating text and voice chatbots. It's design is inspired by Ruby on Rails's philosophy of convention over configuration. It has an MVC architecture with the slight caveat that `views` are aptly named `replies`.
 
-[![CircleCI](https://circleci.com/gh/hellostealth/stealth.svg?style=svg)](https://circleci.com/gh/hellostealth/stealth)
+![CircleCI](https://img.shields.io/circleci/build/github/hellostealth/stealth?style=for-the-badge)
+![Gem (including prereleases)](https://img.shields.io/gem/v/stealth?include_prereleases&style=for-the-badge)
 
 ## Features
 
@@ -37,6 +38,7 @@ Currently, there are gems for:
 * [Alexa Skill](https://github.com/hellostealth/stealth-alexa) (Early alpha)
 
 ### Natural Language Processing
+* [Microsoft LUIS](https://github.com/hellostealth/stealth-luis)
 * [AWS Comprehend](https://github.com/hellostealth/stealth-aws-comprehend)
 
 ### Analytics
@@ -52,4 +54,4 @@ Stealth is versioned using [Semantic Versioning](https://semver.org), but it's m
 
 ## License
 
-"Stealth" and the Stealth logo are Copyright (c) 2020 Mauricio Gomes and Mav Automation Ventures Inc.
+"Stealth" and the Stealth logo are Copyright (c) 2017-2022 MAV Automated Ventures Inc.

data/VERSION

@@ -1 +1 @@
-2.0.0.beta2
+2.0.0.beta5

data/lib/stealth/base.rb

@@ -88,7 +88,7 @@ module Stealth
 
     Thread.current[:configuration] ||= begin
       @semaphore.synchronize do
-        services_config = YAML.load(ERB.new(services_yaml).result)
+        services_config = YAML.safe_load(ERB.new(services_yaml).result, aliases: true)
 
         unless services_config.has_key?(env)
           raise Stealth::Errors::ConfigurationError, "Could not find services.yml configuration for #{env} environment"

data/lib/stealth/controller/controller.rb

@@ -91,6 +91,11 @@ module Stealth
             unless flow_controller.progressed?
               run_catch_all(reason: 'Did not send replies, update session, or step')
             end
+          rescue Stealth::Errors::Halted
+            Stealth::Logger.l(
+              topic: "session",
+              message: "User #{current_session_id}: session halted."
+            )
           rescue StandardError => e
             if e.class == Stealth::Errors::UnrecognizedMessage
               run_unrecognized_message(err: e)
@@ -215,6 +220,10 @@ module Stealth
       @progressed = :do_nothing
     end
 
+    def halt!
+      raise Stealth::Errors::Halted
+    end
+
     private
 
       def update_session(flow:, state:)

data/lib/stealth/controller/replies.rb

@@ -33,10 +33,32 @@ module Stealth
             begin
               send_reply(reply: reply)
             rescue Stealth::Errors::UserOptOut => e
-              user_opt_out_handler(msg: e.message)
+              msg = "User #{current_session_id} opted out. [#{e.message}]"
+              service_error_dispatcher(
+                handler_method: :handle_opt_out,
+                error_msg: msg
+              )
               return
             rescue Stealth::Errors::InvalidSessionID => e
-              invalid_session_id_handler(msg: e.message)
+              msg = "User #{current_session_id} has an invalid session_id. [#{e.message}]"
+              service_error_dispatcher(
+                handler_method: :handle_invalid_session_id,
+                error_msg: msg
+              )
+              return
+            rescue Stealth::Errors::MessageFiltered => e
+              msg = "Message to user #{current_session_id} was filtered. [#{e.message}]"
+              service_error_dispatcher(
+                handler_method: :handle_message_filtered,
+                error_msg: msg
+              )
+              return
+            rescue Stealth::Errors::UnknownServiceError => e
+              msg = "User #{current_session_id} had an unknown error. [#{e.message}]"
+              service_error_dispatcher(
+                handler_method: :handle_unknown_error,
+                error_msg: msg
+              )
               return
             end
 
@@ -50,8 +72,12 @@ module Stealth
 
         private
 
+          def voice_service?
+            current_service.match?(/voice/)
+          end
+
           def send_reply(reply:)
-            if !reply.delay? && Stealth.config.auto_insert_delays
+            if !reply.delay? && Stealth.config.auto_insert_delays && !voice_service?
               # if it's the first reply in the service_reply or the previous reply
               # wasn't a custom delay, then insert a delay
               if @previous_reply.blank? || !@previous_reply.delay?
@@ -211,34 +237,17 @@ module Stealth
             return file_contents, selected_preprocessor
           end
 
-          def user_opt_out_handler(msg:)
-            if self.respond_to?(:handle_opt_out, true)
-              self.send(:handle_opt_out)
-              Stealth::Logger.l(
-                topic: current_service,
-                message: "User #{current_session_id} opted out. [#{msg}]"
-              )
-            else
-              Stealth::Logger.l(
-                topic: :err,
-                message: "User #{current_session_id} unhandled exception due to opt-out."
-              )
-            end
-
-            do_nothing
-          end
-
-          def invalid_session_id_handler(msg:)
-            if self.respond_to?(:handle_invalid_session_id, true)
-              self.send(:handle_invalid_session_id)
+          def service_error_dispatcher(handler_method:, error_msg:)
+            if self.respond_to?(handler_method, true)
               Stealth::Logger.l(
                 topic: current_service,
-                message: "User #{current_session_id} has an invalid session_id. [#{msg}]"
+                message: error_msg
               )
+              self.send(handler_method)
             else
               Stealth::Logger.l(
                 topic: :err,
-                message: "User #{current_session_id} unhandled exception due to invalid session_id."
+                message: "Unhandled service exception for user #{current_session_id}. No error handler for `#{handler_method}` found."
               )
             end
 

data/lib/stealth/errors.rb

@@ -43,14 +43,25 @@ module Stealth
     class FlowDefinitionError < Errors
     end
 
+    # Service errors
     class InvalidSessionID < Errors
     end
 
     class UserOptOut < Errors
     end
 
+    class MessageFiltered < Errors
+    end
+
+    class UnknownServiceError < Errors
+    end
+
+    # Homophone errors
     class ReservedHomophoneUsed < Errors
     end
 
+    class Halted < Errors
+    end
+
   end
 end

data/lib/stealth/generators/builder/bot/controllers/bot_controller.rb

@@ -40,16 +40,28 @@ private
   end
 
   # Automatically called when clients receive an opt-out error from
-  # the platform. You can write your own steps for handling.
+  # the platform. You may write your own steps for handling.
   def handle_opt_out
     do_nothing
   end
 
   # Automatically called when clients receive an invalid session_id error from
   # the platform. For example, attempting to text a landline.
-  # You can write your own steps for handling.
+  # You may write your own steps for handling.
   def handle_invalid_session_id
     do_nothing
   end
 
+  # Automatically called when a transmitted message is filtered/marked as spam.
+  # You may write your own steps for handling.
+  def handle_message_filtered
+    do_nothing
+  end
+
+  # Automatically called when an unknown error is returned by the platform.
+  # You may write your own steps for handling.
+  def handle_unknown_error
+    do_nothing
+  end
+
 end

data/lib/stealth/helpers/redis.rb

@@ -21,9 +21,9 @@ module Stealth
       end
 
       def getex(key, expiration=Stealth.config.session_ttl)
-        $redis.multi do
-          $redis.expire(key, expiration)
-          $redis.get(key)
+        $redis.multi do |pipeline|
+          pipeline.expire(key, expiration)
+          pipeline.get(key)
         end.last
       end
 

data/lib/stealth/logger.rb

@@ -45,7 +45,7 @@ module Stealth
                 :blue
               when :smooch
                 :magenta
-              when :alexa, :voice, :unrecognized_message
+              when :alexa, :voice, :twilio_voice, :unrecognized_message
                 :light_cyan
               when :nlp
                 :cyan

data/lib/stealth/server.rb

@@ -21,7 +21,7 @@ module Stealth
           <body>
             <center>
               <a href='https://hellostealth.org'>
-                <img src='http://assets.blackops.nyc/stealth/logo.svg' height='120' alt='Stealth Logo' aria-label='hellostealth.org' />
+                <img src='https://raw.githubusercontent.com/hellostealth/stealth/master/logo.svg' height='120' alt='Stealth Logo' aria-label='hellostealth.org' />
               </a>
             </center>
           </body>
@@ -44,6 +44,11 @@ module Stealth
         headers: get_helpers_from_request(request)
       )
 
+      headers 'Access-Control-Allow-Origin' => '*',
+              'Access-Control-Allow-Methods' => ['OPTIONS', 'GET', 'POST']
+      # content_type 'audio/mp3'
+      content_type 'application/octet-stream'
+
       dispatcher.coordinate
     end
 

data/lib/stealth/service_message.rb

@@ -6,7 +6,7 @@ module Stealth
 
     attr_accessor :sender_id, :target_id, :timestamp, :service, :message,
                   :location, :attachments, :payload, :referral, :nlp_result,
-                  :catch_all_reason
+                  :catch_all_reason, :confidence
 
     def initialize(service:)
       @service = service

data/logo.svg

@@ -1 +1,28 @@
-<svg viewBox="0 0 92 95.79" xmlns="http://www.w3.org/2000/svg"><g fill="#000a38"><path d="m5.63 92.27a1.69 1.69 0 0 0 1.79 1.15c.88 0 1.49-.38 1.49-1.08 0-.53-.34-.77-1-.94l-2.17-.4c-1.62-.37-2.84-1.23-2.84-3.14 0-2.21 1.8-3.66 4.25-3.66 2.7 0 4.23 1.51 4.53 3.45h-2.82a1.66 1.66 0 0 0 -1.7-1.1c-.82 0-1.38.37-1.38 1s.34.78.92.9l2.16.52c1.89.46 2.93 1.5 2.93 3.25 0 2.31-1.91 3.63-4.32 3.63-2.65 0-4.45-1.3-4.84-3.52z"/><path d="m14.72 84.34h9.73v2.53h-3.45v8.74h-2.87v-8.74h-3.41z"/><path d="m35.88 84.34v2.53h-5.06v1.76h4.62v2.48h-4.62v2h5.06v2.55h-7.88v-11.32z"/><path d="m46.12 84.34 4.21 11.27h-2.94l-.79-2.19h-4l-.78 2.19h-2.82l4.21-11.27zm-2.65 6.66h2.27l-1.14-3.18z"/><path d="m53.62 84.34h2.9v8.72h4.95v2.55h-7.85z"/><path d="m63 84.34h9.72v2.53h-3.4v8.74h-2.9v-8.74h-3.42z"/><path d="m86.33 84.34v11.27h-2.9v-4.46h-4.27v4.46h-2.9v-11.27h2.9v4.27h4.27v-4.27z"/><path d="m92 46-14.84-14.84-1.48-1.48-13.36-13.36-1.48-1.48-14.84-14.84-14.84 14.84-1.48 1.48-13.36 13.36-1.48 1.48-14.84 14.84 16.32 16.32 14.84-14.84 14.84 14.84 14.84-14.84 14.84 14.84zm-31.16-28.19 13.35 13.35-6.67 6.68-6.68 6.68-13.36-13.36 6.68-6.68zm-14.84-14.81 13.36 13.32-6.68 6.68-6.68 6.68-6.68-6.68-6.68-6.68zm-28.19 28.16 13.35-13.35 6.68 6.67 6.68 6.68-13.36 13.36-6.68-6.68zm-1.49 28.2-13.32-13.36 13.32-13.36 6.68 6.68 6.68 6.68zm29.68 0-13.36-13.36 13.36-13.36 13.36 13.36zm23-20 6.68-6.68 13.32 13.32-13.32 13.36-13.36-13.36z"/></g></svg>
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="180px" height="180px" viewBox="0 0 180 180" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>stealth_app_logo</title>
+    <defs>
+        <rect id="path-1" x="0" y="0" width="180" height="180"></rect>
+        <path d="M51.3778558,-2.07572687e-15 L128.622144,2.07572687e-15 C146.487344,-1.20605709e-15 152.965697,1.86013822 159.496947,5.35308895 C166.028197,8.84603967 171.15396,13.9718029 174.646911,20.5030529 C178.139862,27.0343029 180,33.512656 180,51.3778558 L180,128.622144 C180,146.487344 178.139862,152.965697 174.646911,159.496947 C171.15396,166.028197 166.028197,171.15396 159.496947,174.646911 C152.965697,178.139862 146.487344,180 128.622144,180 L51.3778558,180 C33.512656,180 27.0343029,178.139862 20.5030529,174.646911 C13.9718029,171.15396 8.84603967,166.028197 5.35308895,159.496947 C1.86013822,152.965697 8.04038057e-16,146.487344 -1.38381791e-15,128.622144 L1.38381791e-15,51.3778558 C-8.04038057e-16,33.512656 1.86013822,27.0343029 5.35308895,20.5030529 C8.84603967,13.9718029 13.9718029,8.84603967 20.5030529,5.35308895 C27.0343029,1.86013822 33.512656,1.20605709e-15 51.3778558,-2.07572687e-15 Z" id="path-3"></path>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="icon@180">
+            <g id="icon">
+                <mask id="mask-2" fill="white">
+                    <use xlink:href="#path-1"></use>
+                </mask>
+                <g id="Mask"></g>
+                <g id="Rectangle" mask="url(#mask-2)">
+                    <mask id="mask-4" fill="white">
+                        <use xlink:href="#path-3"></use>
+                    </mask>
+                    <use id="Mask" fill="#FFFFFF" xlink:href="#path-3"></use>
+                </g>
+            </g>
+            <g id="logo" transform="translate(24.960938, 18.984375)" fill="#000A38">
+                <path d="M65.0390625,0 L44.0583093,20.9046079 L41.9615065,22.9953504 L23.077556,41.8106246 L20.9807532,43.9013672 L0,64.8073839 L23.077556,87.8027344 L44.0583093,66.8967176 L65.0390625,87.8027344 L86.0198157,66.8967176 L106.999155,87.8027344 L130.078125,64.8073839 L109.098786,43.9013672 L106.999155,41.8106246 L88.1180324,22.9953504 L86.0198157,20.9046079 L65.0390625,0 Z M55.5970873,32.403692 L46.156526,22.9953504 L65.0390625,4.18007626 L83.921599,22.9953504 L74.4810377,32.403692 L65.0390625,41.8106246 L55.5970873,32.403692 Z M67.1372792,43.9013672 L76.5778405,34.4944345 L86.0198157,25.086093 L104.902352,43.9013672 L95.460377,53.3097087 L86.0198157,62.7166414 L67.1372792,43.9013672 Z M34.617748,53.3097087 L25.1771867,43.9013672 L44.0583093,25.086093 L53.5002845,34.4944345 L62.9408458,43.9013672 L44.0583093,62.7166414 L34.617748,53.3097087 Z M88.1180324,64.8073839 L97.5585938,55.3990424 L106.999155,45.9921097 L125.883105,64.8073839 L106.999155,83.6226581 L88.1180324,64.8073839 Z M46.156526,64.8073839 L65.0390625,45.9921097 L83.921599,64.8073839 L65.0390625,83.6226581 L46.156526,64.8073839 Z M4.19501953,64.8073839 L23.077556,45.9921097 L32.5195313,55.3990424 L41.9615065,64.8073839 L23.077556,83.6226581 L4.19501953,64.8073839 Z" id="glyph"></path>
+                <path d="M7.93868906,127.899703 C11.7243984,127.899703 14.7190641,125.865591 14.7190641,122.305894 C14.7190641,119.621995 13.0804734,118.011656 10.1140594,117.305367 L6.72387188,116.514323 C5.81982188,116.316562 5.28304219,115.892789 5.28304219,115.129997 C5.28304219,114.169444 6.15884063,113.604412 7.4584125,113.604412 C8.95574531,113.604412 9.74678906,114.338953 10.1140594,115.299506 L14.5495547,115.299506 C14.0692781,112.304841 11.6678953,109.988213 7.43016094,109.988213 C3.58794844,109.988213 0.762792188,112.220086 0.762792188,115.610273 C0.762792188,118.548436 2.68389844,119.876259 5.22653906,120.441291 L8.56022344,121.14758 C9.66203438,121.401844 10.1988141,121.769114 10.1988141,122.588409 C10.1988141,123.661969 9.23826094,124.255252 7.85393438,124.255252 C6.44135625,124.255252 5.4243,123.661969 5.05702969,122.475403 L0.33901875,122.475403 C0.960553125,125.893842 3.78570938,127.899703 7.93868906,127.899703 Z M28.539987,127.617187 L28.539987,114.169444 L33.9077839,114.169444 L33.9077839,110.270728 L18.6519401,110.270728 L18.6519401,114.169444 L23.9914855,114.169444 L23.9914855,127.617187 L28.539987,127.617187 Z M51.1753975,127.617187 L51.1753975,123.69022 L43.2367084,123.69022 L43.2367084,120.695555 L50.49736,120.695555 L50.49736,116.881594 L43.2367084,116.881594 L43.2367084,114.169444 L51.1753975,114.169444 L51.1753975,110.270728 L38.7729615,110.270728 L38.7729615,127.617187 L51.1753975,127.617187 Z M59.8262845,127.617187 L61.0411017,124.255252 L67.3412001,124.255252 L68.5842689,127.617187 L73.1892736,127.617187 L66.5784079,110.270728 L61.9451517,110.270728 L55.3342861,127.617187 L59.8262845,127.617187 Z M65.9851251,120.526045 L62.4254283,120.526045 L64.2052767,115.638525 L65.9851251,120.526045 Z M90.0048622,127.617187 L90.0048622,123.69022 L82.2356825,123.69022 L82.2356825,110.270728 L77.6871809,110.270728 L77.6871809,127.617187 L90.0048622,127.617187 Z M101.650415,127.617187 L101.650415,114.169444 L107.018212,114.169444 L107.018212,110.270728 L91.7623679,110.270728 L91.7623679,114.169444 L97.1019132,114.169444 L97.1019132,127.617187 L101.650415,127.617187 Z M116.431891,127.617187 L116.431891,120.752058 L123.127511,120.752058 L123.127511,127.617187 L127.676013,127.617187 L127.676013,110.270728 L123.127511,110.270728 L123.127511,116.853342 L116.431891,116.853342 L116.431891,110.270728 L111.883389,110.270728 L111.883389,127.617187 L116.431891,127.617187 Z" id="STEALTH" fill-rule="nonzero"></path>
+            </g>
+        </g>
+    </g>
+</svg>

data/spec/configuration_spec.rb

@@ -6,7 +6,7 @@ describe "Stealth::Configuration" do
 
   describe "accessing via method calling" do
     let(:services_yml) { File.read(File.join(File.dirname(__FILE__), 'support', 'services.yml')) }
-    let(:parsed_config) { YAML.load(ERB.new(services_yml).result)[Stealth.env] }
+    let(:parsed_config) { YAML.safe_load(ERB.new(services_yml).result, aliases: true)[Stealth.env] }
     let(:config) { Stealth.load_services_config!(services_yml) }
 
     it "should return the root node" do

data/spec/controller/catch_all_spec.rb

@@ -115,7 +115,13 @@ describe "Stealth::Controller::CatchAll" do
       end
 
       it "should log the error message" do
-        expect(Stealth::Logger).to receive(:l).with(topic: 'catch_all', message: "[Level 1] for user #{facebook_message.sender_id} OpenStruct\noops\n/stealth/lib/stealth/controller/controller.rb\n/stealth/lib/stealth/controller/catch_all.rb")
+        err_klass = if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
+          "RuntimeError"
+        else
+          "OpenStruct"
+        end
+
+        expect(Stealth::Logger).to receive(:l).with(topic: 'catch_all', message: "[Level 1] for user #{facebook_message.sender_id} #{err_klass}\noops\n/stealth/lib/stealth/controller/controller.rb\n/stealth/lib/stealth/controller/catch_all.rb")
         expect(Stealth::Logger).to receive(:l).with(topic: 'catch_all', message: "CatchAll triggered for user #{facebook_message.sender_id} from within CatchAll; ignoring.")
         controller.run_catch_all(err: e)
       end

data/spec/controller/controller_spec.rb

@@ -42,6 +42,11 @@ describe "Stealth::Controller" do
     def parts_unknown
       step_to flow: :parts, state: :unknown
     end
+
+    def halted
+      halt!
+      step_to state: :other_action2
+    end
   end
 
   class FlowMap
@@ -60,6 +65,7 @@ describe "Stealth::Controller" do
       state :other_action4
       state :broken_action
       state :part_unknown
+      state :halted
       state :deprecated_action, redirects_to: :other_action
       state :deprecated_action2, redirects_to: 'mr_robot->my_action'
     end
@@ -884,6 +890,34 @@ describe "Stealth::Controller" do
         controller.action(action: :parts_unknown)
       end
     end
+
+    describe "halt!" do
+      it "should catch the error and log the sessio halt" do
+        ### It's lame we have to include these two
+        expect(Stealth::Logger).to receive(:l).with(
+          topic: "primary_session",
+          message: "User #{facebook_message.sender_id}: setting session to mr_tron->halted"
+        )
+        expect(Stealth::Logger).to receive(:l).with(
+          topic: "previous_session",
+          message: "User #{facebook_message.sender_id}: setting to parts->unknown"
+        )
+        ###
+
+        expect(Stealth::Logger).to receive(:l).with(
+          topic: "session",
+          message: "User #{facebook_message.sender_id}: session halted."
+        )
+
+        controller.step_to(flow: :mr_tron, state: :halted)
+      end
+
+      it "should NOT continue with the rest of the controller code" do
+        expect_any_instance_of(MrTronsController).to_not receive(:other_action2)
+        expect_any_instance_of(MrTronsController).to_not receive(:step_to).with(state: :other_action2)
+        controller.step_to(flow: :mr_tron, state: :halted)
+      end
+    end
   end
 
 end

data/spec/controller/replies_spec.rb

@@ -632,7 +632,7 @@ describe "Stealth::Controller replies" do
       it "should log the unhandled exception if the controller does not have a handle_opt_out method" do
         expect(Stealth::Logger).to receive(:l).with(
           topic: :err,
-          message: "User #{facebook_message.sender_id} unhandled exception due to opt-out."
+          message: "Unhandled service exception for user #{facebook_message.sender_id}. No error handler for `handle_opt_out` found."
         )
         expect(controller).to receive(:do_nothing)
         controller.say_offer
@@ -659,7 +659,7 @@ describe "Stealth::Controller replies" do
       it "should log the unhandled exception if the controller does not have a handle_invalid_session_id method" do
         expect(Stealth::Logger).to receive(:l).with(
           topic: :err,
-          message: "User #{facebook_message.sender_id} unhandled exception due to invalid session_id."
+          message: "Unhandled service exception for user #{facebook_message.sender_id}. No error handler for `handle_invalid_session_id` found."
         )
         expect(controller).to receive(:do_nothing)
         controller.say_offer
@@ -676,6 +676,60 @@ describe "Stealth::Controller replies" do
       end
     end
 
+    describe "Stealth::Errors::MessageFiltered" do
+      before(:each) do
+        expect(stubbed_client).to receive(:transmit).and_raise(
+          Stealth::Errors::MessageFiltered.new('boom')
+        ).once # Retuns early; doesn't send the remaining replies in the file
+      end
+
+      it "should log the unhandled exception if the controller does not have a handle_message_filtered method" do
+        expect(Stealth::Logger).to receive(:l).with(
+          topic: :err,
+          message: "Unhandled service exception for user #{facebook_message.sender_id}. No error handler for `handle_message_filtered` found."
+        )
+        expect(controller).to receive(:do_nothing)
+        controller.say_offer
+      end
+
+      it "should call handle_message_filtered method" do
+        expect(controller).to receive(:handle_message_filtered)
+        expect(Stealth::Logger).to receive(:l).with(
+          topic: 'facebook',
+          message: "Message to user #{facebook_message.sender_id} was filtered. [boom]"
+        )
+        expect(controller).to receive(:do_nothing)
+        controller.say_offer
+      end
+    end
+
+    describe "Stealth::Errors::UnknownServiceError" do
+      before(:each) do
+        expect(stubbed_client).to receive(:transmit).and_raise(
+          Stealth::Errors::UnknownServiceError.new('boom')
+        ).once # Retuns early; doesn't send the remaining replies in the file
+      end
+
+      it "should log the unhandled exception if the controller does not have a handle_unknown_error method" do
+        expect(Stealth::Logger).to receive(:l).with(
+          topic: :err,
+          message: "Unhandled service exception for user #{facebook_message.sender_id}. No error handler for `handle_unknown_error` found."
+        )
+        expect(controller).to receive(:do_nothing)
+        controller.say_offer
+      end
+
+      it "should call handle_unknown_error method" do
+        expect(controller).to receive(:handle_unknown_error)
+        expect(Stealth::Logger).to receive(:l).with(
+          topic: 'facebook',
+          message: "User #{facebook_message.sender_id} had an unknown error. [boom]"
+        )
+        expect(controller).to receive(:do_nothing)
+        controller.say_offer
+      end
+    end
+
     describe 'an unknown client error' do
       before(:each) do
         allow(stubbed_client).to receive(:transmit).and_raise(

data/stealth.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.email = 'mauricio@edge14.com'
 
   s.add_dependency 'sinatra', '~> 2.0'
-  s.add_dependency 'puma', '>= 4.2', '< 5.0'
+  s.add_dependency 'puma', '>= 4.2', '< 6.0'
   s.add_dependency 'thor', '~> 1.0'
   s.add_dependency 'multi_json', '~> 1.12'
   s.add_dependency 'sidekiq', '~> 6.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stealth
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0.beta5
 platform: ruby
 authors:
 - Mauricio Gomes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -34,7 +34,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -327,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby framework for conversational bots