stealth 2.0.0.beta4 → 2.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7c4304b177d264b2f7179e5bad5c8bf509421a386f0d9ec66d4c7c53c4c1972
-  data.tar.gz: fdcd30455510aef62945bce7716e06559c3b2eb0105b4199ba5c8c99e201b60f
+  metadata.gz: 24ba7ba55d264e21395db7b9166ecf96064c2c0d8c8bc51d09dd274ecaf5fd34
+  data.tar.gz: c42254f819550577f249fddb13266cfa6bc8e2f27760994e3efdf7798447ecdd
 SHA512:
-  metadata.gz: d0aa0623fcc9978fd62a31fbe863fa1e143427431f125e144f97967cf9792ba37f0779e3fae826647eccc3726633fbb61ff7ae2c2b9f82580a3d890ca92c3174
-  data.tar.gz: a64cfaa6e32319b28dc2bebe0ad6626c0c8e482de0ac13bbcf0f46c5b73cc71121d06535ed91ed6e11afe65bcc5859cc7bb4076494715755f0468227a86ca077
+  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,7 @@ jobs:
           destination: test-results
   ruby_2_7:
     docker:
-      - image: circleci/ruby:2.7-node-browsers
+      - image: cimg/ruby:2.7
         environment:
           STEALTH_ENV: test
 
@@ -110,7 +110,61 @@ jobs:
 
   ruby_3_0:
     docker:
-      - image: circleci/ruby:3.0-node-browsers
+      - 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
 
@@ -169,3 +223,4 @@ workflows:
       - ruby_2_6
       - ruby_2_7
       - ruby_3_0
+      - ruby_3_1

data/CHANGELOG.md

@@ -53,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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stealth (2.0.0.beta4)
+    stealth (2.0.0.beta5)
       activesupport (~> 6.0)
       multi_json (~> 1.12)
       puma (>= 4.2, < 6.0)
@@ -12,13 +12,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.6)
+    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.9)
+    concurrent-ruby (1.1.10)
     connection_pool (2.2.5)
     diff-lcs (1.3)
     i18n (1.10.0)

data/VERSION

@@ -1 +1 @@
-2.0.0.beta4
+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

@@ -72,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?

data/lib/stealth/errors.rb

@@ -60,5 +60,8 @@ module Stealth
     class ReservedHomophoneUsed < Errors
     end
 
+    class Halted < Errors
+    end
+
   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>

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/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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stealth
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0.beta5
 platform: ruby
 authors:
 - Mauricio Gomes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-05 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -327,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby framework for conversational bots