stealth 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c85085bed89600d8dfcf7741800c99c98333155316e59fb18bbc53e0fc07280
-  data.tar.gz: c34523527fba0de8f35bc7e7de465bc3209ca735fae3acaf3e9fc4f089cb6d31
+  metadata.gz: acde4522ee0154ec5557379bfd1fa928e89771637e4c3dd99880adb624b7c2f7
+  data.tar.gz: f30cc740eb9c40fb90c19cbe35a27cf12ce24209245813d338db25df61ca238a
 SHA512:
-  metadata.gz: cf345a282a3256914fd2c15b8139e5d1fa7b96f6f53591c675b38b6f5d5bf8fc1fd95a9db2d199abe8a4aa691e8641e27824069327ad8467b81269e7404d1cee
-  data.tar.gz: 78bdf64b387ee7294cf51251553479aca0622d687fab25c0b14481775812b7ce59665384f3fd3af7f24eddc12f1f588aaec4ce88af5453a9658547a06f308a3a
+  metadata.gz: 63ad339fe8d1473ab1118eef9279cf66f1a895748fe61ca7671d49ca8de635fe27f9e4f200c1ae05523501f62e135eb4147d3609f9550c920311498a7abfa26c
+  data.tar.gz: cbcc9083bb56acc3d30aedbcc6a853fb71cf5a57b0586e81b586c36d1f186c5bc39cf5acf6d03768c86c486c7a6ff987ca5e151248cf43c34b70b21778c285ef

data/CHANGELOG.md

@@ -49,6 +49,8 @@
 * [Replies] Added support for sub-state replies. `step_to` can now take a `pos` argument that will force any resulting `send_replies` to be sent starting at the `pos` specified. `pos` can also be negative, for example, `-1` will force `send_replies` to send replies starting at (only) the last reply.
 * [Replies] Dynamic delays are automatically sent before each reply. This can be disabled by setting `Stealth.config.auto_insert_delays` to `false`. If a delay is already included, the auto-delay is skipped.
 * [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`
 
 ## Bug Fixes
 
@@ -64,6 +66,7 @@
 * [Sessions] previous_session now respects session_ttl values.
 * [Catch All] Log output from all catch_all logging now includes the session_id so they can be included in log searches.
 * [NLP] Strip out values from single element arrays in the case of custom LUIS List entities.
+* [Config] Attempting to overwrite default config values with `nil` or `false` now correctly sets those config values.
 
 ## Deprecations
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stealth (2.0.0.beta1)
+    stealth (2.0.0.beta2)
       activesupport (~> 6.0)
       multi_json (~> 1.12)
       puma (>= 4.2, < 5.0)
@@ -12,12 +12,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.3)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     concurrent-ruby (1.1.7)
     connection_pool (2.2.3)
     diff-lcs (1.3)
@@ -30,14 +30,14 @@ GEM
       ruby2_keywords (~> 0.0.1)
     nio4r (2.5.4)
     oj (3.10.6)
-    puma (4.3.6)
+    puma (4.3.7)
       nio4r (~> 2.0)
     rack (2.2.3)
     rack-protection (2.1.0)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    redis (4.2.2)
+    redis (4.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -64,11 +64,10 @@ GEM
       rack-protection (= 2.1.0)
       tilt (~> 2.0)
     thor (1.0.1)
-    thread_safe (0.3.6)
     tilt (2.0.10)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    tzinfo (2.0.3)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/VERSION

@@ -1 +1 @@
-2.0.0.beta1
+2.0.0.beta2

data/lib/stealth/base.rb

@@ -63,17 +63,20 @@ module Stealth
   end
 
   def self.set_config_defaults(config)
-    config.dynamic_delay_muliplier ||= 1.0
-    config.session_ttl ||= 0
-    config.lock_autorelease ||= 30
-    config.transcript_logging ||= false
-    config.hot_reload ||= Stealth.env.development?
-    config.eager_load ||= Stealth.env.production?
-    config.autoload_paths ||= Stealth.default_autoload_paths
-    config.autoload_ignore_paths ||= []
-    config.nlp_integration ||= nil
-    config.log_all_nlp_results ||= false
-    config.auto_insert_delays ||= true
+    defaults = {
+      dynamic_delay_muliplier: 1.0,                     # values > 1 increase, values < 1 decrease delay
+      session_ttl: 0,                                   # 0 seconds; don't expire sessions
+      lock_autorelease: 30,                             # 30 seconds
+      transcript_logging: false,                        # show user replies in the logs
+      hot_reload: Stealth.env.development?,             # hot reload bot files on change (dev only)
+      eager_load: Stealth.env.production?,              # eager load bot files for performance (prod only)
+      autoload_paths: Stealth.default_autoload_paths,   # array of autoload paths used in eager and hot reloading
+      autoload_ignore_paths: [],                        # paths to exclude from eager and hot reloading
+      nlp_integration: nil,                             # NLP service to use, defaults to none
+      log_all_nlp_results: false,                       # log NLP service requests; useful for debugging/improving NLP models
+      auto_insert_delays: true                          # automatically insert delays/typing indicators between all replies
+    }
+    defaults.each { |option, default| config.set_default(option, default) }
   end
 
   # Loads the services.yml configuration unless one has already been loaded
@@ -126,8 +129,9 @@ module Stealth
       if ENV['DATABASE_URL'].present?
         ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
       else
+        database_config = File.read(File.join(Stealth.root, 'config', 'database.yml'))
         ActiveRecord::Base.establish_connection(
-          YAML::load_file("config/database.yml")[Stealth.env]
+          YAML.load(ERB.new(database_config).result)[Stealth.env]
         )
       end
     end
@@ -141,15 +145,15 @@ module Stealth
     for_each_file_in(directory) { |file| require_relative(file) }
   end
 
-  private
+private
 
-    def self.for_each_file_in(directory, &blk)
-      directory = directory.to_s.gsub(%r{(\/|\\)}, File::SEPARATOR)
-      directory = Pathname.new(Dir.pwd).join(directory).to_s
-      directory = File.join(directory, '**', '*.rb') unless directory =~ /(\*\*)/
+  def self.for_each_file_in(directory, &blk)
+    directory = directory.to_s.gsub(%r{(\/|\\)}, File::SEPARATOR)
+    directory = Pathname.new(Dir.pwd).join(directory).to_s
+    directory = File.join(directory, '**', '*.rb') unless directory =~ /(\*\*)/
 
-      Dir.glob(directory).sort.each(&blk)
-    end
+    Dir.glob(directory).sort.each(&blk)
+  end
 
 end
 

data/lib/stealth/configuration.rb

@@ -22,6 +22,12 @@ module Stealth
       end
     end
 
+    def set_default(key, default_value)
+      if self[key.to_s] == nil
+        self[key.to_s] = store(default_value)
+      end
+    end
+
     private
 
       def store(value)

data/lib/stealth/controller/replies.rb

@@ -257,8 +257,12 @@ module Stealth
 
           def log_reply(reply)
             message = case reply.reply_type
-                      when 'text', 'speech'
+                      when 'text'
                         reply['text']
+                      when 'speech'
+                        reply['speech']
+                      when 'ssml'
+                        reply['ssml']
                       when 'delay'
                         '<typing indicator>'
                       else

data/lib/stealth/generators/builder/Gemfile

@@ -15,5 +15,5 @@ gem 'sqlite3'
 
 group :development do
   gem 'foreman'
-  gem 'listen', '~> 3.1'
+  gem 'listen', '~> 3.3'
 end

data/lib/stealth/logger.rb

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

data/lib/stealth/services/base_reply_handler.rb

@@ -60,6 +60,14 @@ module Stealth
         reply_format_not_supported(format: 'delay')
       end
 
+      def speech
+        reply_format_not_supported(format: 'speech')
+      end
+
+      def ssml
+        reply_format_not_supported(format: 'ssml')
+      end
+
     end
   end
 end

data/spec/configuration_spec.rb

@@ -57,4 +57,37 @@ describe "Stealth::Configuration" do
     end
   end
 
+  describe "configuring with default values" do
+    let(:config) {
+      Stealth::Configuration.new(
+        { 'a' => nil, 'x' => 0, 'y' => false, 'z' => '' }
+      )
+    }
+
+    it 'should replace a nil value' do
+      config.set_default('a', 99)
+      expect(config.a).to eq 99
+    end
+
+    it 'should NOT replace a zero value' do
+      config.set_default('x', 99)
+      expect(config.x).to eq 0
+    end
+
+    it 'should NOT replace a false value' do
+      config.set_default('y', 99)
+      expect(config.y).to be false
+    end
+
+    it 'should NOT replace a blank string value' do
+      config.set_default('z', 99)
+      expect(config.z).to eq ''
+    end
+
+    it 'should replace a not-set key' do
+      config.set_default('zz', 99)
+      expect(config.zz).to eq 99
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stealth
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Mauricio Gomes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra