stealth 1.1.5 → 2.0.0.beta3

data/spec/service_reply_spec.rb

@@ -1,7 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "Stealth::ServiceReply" do
 

data/spec/session_spec.rb

@@ -1,7 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 class FlowMap
   include Stealth::Flow
@@ -19,20 +18,20 @@ class FlowMap
 end
 
 describe "Stealth::Session" do
-  let(:user_id) { '0xDEADBEEF' }
+  let(:id) { '0xDEADBEEF' }
 
   it "should raise an error if $redis is not set" do
     $redis = nil
 
     expect {
-      Stealth::Session.new(user_id: user_id)
+      Stealth::Session.new(id: id)
     }.to raise_error(Stealth::Errors::RedisNotConfigured)
 
     $redis = MockRedis.new
   end
 
   describe "without a session" do
-    let(:session) { Stealth::Session.new(user_id: user_id) }
+    let(:session) { Stealth::Session.new(id: id) }
 
     it "should have nil flow and state" do
       expect(session.flow).to be_nil
@@ -52,8 +51,8 @@ describe "Stealth::Session" do
 
   describe "with a session" do
     let(:session) do
-      session = Stealth::Session.new(user_id: user_id)
-      session.set(flow: 'marco', state: 'polo')
+      session = Stealth::Session.new(id: id)
+      session.set_session(new_flow: 'marco', new_state: 'polo')
       session
     end
 
@@ -81,33 +80,71 @@ describe "Stealth::Session" do
   end
 
   describe "incrementing and decrementing" do
-    let(:session) { Stealth::Session.new(user_id: user_id) }
+    let(:session) { Stealth::Session.new(id: id) }
 
     it "should increment the state" do
-      session.set(flow: 'new_todo', state: 'get_due_date')
+      session.set_session(new_flow: 'new_todo', new_state: 'get_due_date')
       new_session = session + 1.state
       expect(new_session.state_string).to eq('created')
     end
 
     it "should decrement the state" do
-      session.set(flow: 'new_todo', state: 'error')
+      session.set_session(new_flow: 'new_todo', new_state: 'error')
       new_session = session - 2.states
       expect(new_session.state_string).to eq('get_due_date')
     end
 
     it "should return the first state if the decrement is out of bounds" do
-      session.set(flow: 'new_todo', state: 'get_due_date')
+      session.set_session(new_flow: 'new_todo', new_state: 'get_due_date')
       new_session = session - 5.states
       expect(new_session.state_string).to eq('new')
     end
 
     it "should return the last state if the increment is out of bounds" do
-      session.set(flow: 'new_todo', state: 'created')
+      session.set_session(new_flow: 'new_todo', new_state: 'created')
       new_session = session + 5.states
       expect(new_session.state_string).to eq('error')
     end
   end
 
+  describe "==" do
+    let(:session) {
+      _session = Stealth::Session.new(id: id, type: :primary)
+      _session.set_session(new_flow: 'hello', new_state: 'say_hola')
+      _session
+    }
+
+    it "should return false if the session ids do not" do
+      other_session = Stealth::Session.new(id: 'xyz123', type: :primary)
+      other_session.set_session(new_flow: 'hello', new_state: 'say_hola')
+      expect(session == other_session).to be false
+    end
+
+    it "should return false if the states do not" do
+      other_session = Stealth::Session.new(id: id, type: :primary)
+      other_session.set_session(new_flow: 'hello', new_state: 'say_hola2')
+      expect(session == other_session).to be false
+    end
+
+    it "should return false if flows do not match" do
+      other_session = Stealth::Session.new(id: id, type: :primary)
+      other_session.set_session(new_flow: 'hello2', new_state: 'say_hola')
+      expect(session == other_session).to be false
+    end
+
+    it 'should return false if the session type does not match' do
+      other_session = Stealth::Session.new(id: id, type: :back_to)
+      other_session.set_session(new_flow: 'hello', new_state: 'say_hola')
+      expect(session == other_session).to be false
+    end
+
+    it 'should return true if the session id, flow, state, and session types match' do
+      other_session = Stealth::Session.new(id: id, type: :primary)
+      other_session.set_session(new_flow: 'hello', new_state: 'say_hola')
+      expect(session == other_session).to be true
+    end
+  end
+
   describe "self.is_a_session_string?" do
     it "should return false for state strings" do
       session_string = 'say_hello'
@@ -124,4 +161,206 @@ describe "Stealth::Session" do
       expect(Stealth::Session.is_a_session_string?(session_string)).to be true
     end
   end
+
+  describe "self.canonical_session_slug" do
+    it "should generate a canonical session slug given a flow and state as symbols" do
+      expect(
+        Stealth::Session.canonical_session_slug(flow: :hello, state: :say_hello)
+      ).to eq 'hello->say_hello'
+    end
+
+    it "should generate a canonical session slug given a flow and state as strings" do
+      expect(
+        Stealth::Session.canonical_session_slug(flow: 'hello', state: 'say_hello')
+      ).to eq 'hello->say_hello'
+    end
+  end
+
+  describe "self.flow_and_state_from_session_slug" do
+    it "should return the flow and string as a hash with symbolized keys" do
+      slug = 'hello->say_hello'
+      expect(
+        Stealth::Session.flow_and_state_from_session_slug(slug: slug)
+      ).to eq({ flow: 'hello', state: 'say_hello' })
+    end
+
+    it "should not raise if slug is nil" do
+      slug = nil
+      expect(
+        Stealth::Session.flow_and_state_from_session_slug(slug: slug)
+      ).to eq({ flow: nil, state: nil })
+    end
+  end
+
+  describe "setting sessions" do
+    let(:session) { Stealth::Session.new(id: id) }
+    let(:previous_session) { Stealth::Session.new(id: id, type: :previous) }
+    let(:back_to_session) { Stealth::Session.new(id: id, type: :back_to) }
+
+    before(:each) do
+      $redis.del(id)
+      $redis.del([id, 'previous'].join('-'))
+      $redis.del([id, 'back_to'].join('-'))
+    end
+
+    it "should store the new session" do
+      session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect($redis.get(id)).to eq 'marco->polo'
+    end
+
+    it "should store the current_session to previous_session" do
+      $redis.set(id, 'new_todo->new')
+      $redis.set([id, 'previous'].join('-'), 'new_todo->error')
+      session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect(previous_session.get_session).to eq 'new_todo->new'
+    end
+
+    it "should not update previous_session if it matches current_session" do
+      $redis.set(id, 'marco->polo')
+      $redis.set([id, 'previous'].join('-'), 'new_todo->new')
+      session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect(previous_session.get_session).to eq 'new_todo->new'
+    end
+
+    it "should set an expiration for current_session if session_ttl is specified" do
+      Stealth.config.session_ttl = 500
+      session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect($redis.ttl(id)).to be > 0
+      Stealth.config.session_ttl = 0
+    end
+
+    it "should set an expiration for previous_session if session_ttl is specified" do
+      Stealth.config.session_ttl = 500
+      $redis.set(id, 'new_todo->new')
+      session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect($redis.ttl([id, 'previous'].join('-'))).to be > 0
+      Stealth.config.session_ttl = 0
+    end
+
+    it "should NOT set an expiration if session_ttl is not specified" do
+      Stealth.config.session_ttl = 0
+      session.set_session(new_flow: 'new_todo', new_state: 'get_due_date')
+      expect($redis.ttl(id)).to eq -1 # Does not expire
+    end
+
+    it "should set the session for back_to" do
+      back_to_session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect($redis.get([id, 'back_to'].join('-'))).to eq 'marco->polo'
+    end
+
+    it "should set an expiration for back_to if session_ttl is specified" do
+      Stealth.config.session_ttl = 500
+      back_to_session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect($redis.ttl([id, 'back_to'].join('-'))).to be > 0
+      Stealth.config.session_ttl = 0
+    end
+  end
+
+  describe "getting sessions" do
+    let(:session) { Stealth::Session.new(id: id) }
+    let(:previous_session) { Stealth::Session.new(id: id, type: :previous) }
+    let(:back_to_session) { Stealth::Session.new(id: id, type: :back_to) }
+
+    before(:each) do
+      $redis.del(id)
+      $redis.del([id, 'previous'].join('-'))
+      $redis.del([id, 'back_to'].join('-'))
+    end
+
+    it "should return the stored current_session" do
+      session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect(session.get_session).to eq 'marco->polo'
+    end
+
+    it "should return the stored previous_session if previous is requested" do
+      $redis.set(id, 'new_todo->new')
+      session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect(previous_session.get_session).to eq 'new_todo->new'
+    end
+
+    it "should update the expiration of current_session if session_ttl is set" do
+      Stealth.config.session_ttl = 50
+      session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect($redis.ttl(id)).to be_between(0, 50).inclusive
+
+      Stealth.config.session_ttl = 500
+      session.session = nil # reset memoization
+      session.get_session
+      expect($redis.ttl(id)).to be > 100
+
+      Stealth.config.session_ttl = 0
+    end
+
+    it "should return the stored back_to_session" do
+      back_to_session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect(back_to_session.get_session).to eq 'marco->polo'
+    end
+
+    it "should update the expiration of back_to_session if session_ttl is set" do
+      Stealth.config.session_ttl = 50
+      back_to_session.set_session(new_flow: 'marco', new_state: 'polo')
+      expect($redis.ttl([id, 'back_to'].join('-'))).to be_between(0, 50).inclusive
+
+      Stealth.config.session_ttl = 500
+      back_to_session.session = nil # reset memoization
+      back_to_session.get_session
+      expect($redis.ttl([id, 'back_to'].join('-'))).to be > 100
+
+      Stealth.config.session_ttl = 0
+    end
+  end
+
+  describe "clearing sessions" do
+    let(:session) { Stealth::Session.new(id: id) }
+    let(:previous_session) { Stealth::Session.new(id: id, type: :previous) }
+    let(:back_to_session) { Stealth::Session.new(id: id, type: :back_to) }
+
+    before(:each) do
+      session.send(:persist_key, key: session.session_key, value: '1')
+      previous_session.send(:persist_key, key: previous_session.session_key, value: '1')
+      back_to_session.send(:persist_key, key: back_to_session.session_key, value: '1')
+    end
+
+    it "should remove a default session from Redis" do
+      expect($redis.get(session.session_key)).to eq '1'
+      session.clear_session
+      expect($redis.get(session.session_key)).to be_nil
+    end
+
+    it "should remove a previous session from Redis" do
+      expect($redis.get(previous_session.session_key)).to eq '1'
+      previous_session.clear_session
+      expect($redis.get(previous_session.session_key)).to be_nil
+    end
+
+    it "should remove a back_to session from Redis" do
+      expect($redis.get(back_to_session.session_key)).to eq '1'
+      back_to_session.clear_session
+      expect($redis.get(back_to_session.session_key)).to be_nil
+    end
+  end
+
+  describe "self.slugify" do
+    it "should return a session slug given a flow and state" do
+      expect(Stealth::Session.slugify(flow: 'hello', state: 'world')).to eq 'hello->world'
+    end
+
+    it "should raise an ArgumentError if flow is blank" do
+      expect {
+        Stealth::Session.slugify(flow: '', state: 'world')
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should raise an ArgumentError if state is blank" do
+      expect {
+        Stealth::Session.slugify(flow: 'hello', state: nil)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should raise an ArgumentError if flow and state are blank" do
+      expect {
+        Stealth::Session.slugify(flow: nil, state: nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 
 require 'stealth'
+require 'sidekiq/testing'
 require 'mock_redis'
 
 # Requires supporting files with custom matchers and macros, etc,
@@ -13,7 +14,27 @@ require 'mock_redis'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 $redis = MockRedis.new
+$services_yml = File.read(File.join(File.dirname(__FILE__), 'support', 'services.yml'))
 
 RSpec.configure do |config|
   ENV['STEALTH_ENV'] = 'test'
+
+  config.before(:each) do |example|
+    Sidekiq::Testing.fake!
+
+    Stealth.load_services_config!($services_yml)
+  end
+
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+
+    expectations.on_potential_false_positives = :nothing
+  end
 end

data/spec/support/controllers/vaders_controller.rb

@@ -0,0 +1,24 @@
+class VadersController < Stealth::Controller
+  def my_action
+    raise "oops"
+  end
+
+  def my_action2
+
+  end
+
+  def my_action3
+    do_nothing
+  end
+
+  def action_with_unrecognized_msg
+    handle_message(
+      'hello' => proc { puts "Hello world!" },
+      'bye' => proc { puts "Goodbye world!" }
+    )
+  end
+
+  def action_with_unrecognized_match
+    match = get_match(['hello', 'bye'])
+  end
+end

data/spec/support/nlp_clients/dialogflow.rb

@@ -0,0 +1,9 @@
+module Stealth
+  module Nlp
+    module Dialogflow
+      class Client < Stealth::Nlp::Client
+
+      end
+    end
+  end
+end

data/spec/support/nlp_clients/luis.rb

@@ -0,0 +1,9 @@
+module Stealth
+  module Nlp
+    module Luis
+      class Client < Stealth::Nlp::Client
+
+      end
+    end
+  end
+end

data/spec/support/nlp_results/luis_result.rb

@@ -0,0 +1,163 @@
+module TestNlpResult
+  class Luis < Stealth::Nlp::Result
+
+    ENTITY_MAP = {
+      'money' => :currency, 'number' => :number, 'email' => :email,
+      'percentage' => :percentage, 'Calendar.Duration' => :duration,
+      'geographyV2' => :geo, 'age' => :age, 'phonenumber' => :phone,
+      'ordinalV2' => :ordinal, 'url' => :url, 'dimension' => :dimension,
+      'temperature' => :temp, 'keyPhrase' => :key_phrase, 'name' => :name,
+      'datetimeV2' => :datetime
+    }
+
+    attr_reader :result, :intent
+
+    def initialize(intent:, entity: :single_number_entity)
+      @result = test_responses[entity]
+      @intent = intent
+    end
+
+    def parsed_result
+      @result
+    end
+
+    def intent_score
+      rand
+    end
+
+    def raw_entities
+      @result.dig('prediction', 'entities')
+    end
+
+    def entities
+      return {} if raw_entities.blank?
+      _entities = {}
+
+      raw_entities.each do |type, values|
+        if ENTITY_MAP[type]
+          _entities[ENTITY_MAP[type]] = values
+        else
+          # A custom entity
+          _entities[type.to_sym] = values
+        end
+      end
+
+      _entities
+    end
+
+    def sentiment
+      %i(positive neutral negative).sample
+    end
+
+    def sentiment_score
+      rand
+    end
+
+    def present?
+      parsed_result.present?
+    end
+
+    private
+
+    def test_responses
+      {
+        single_number_entity: {
+          "query" => "My score was 78",
+          "prediction" => {
+            "topIntent" => "None",
+            "intents" => {
+              "None" => {
+                "score" => 0.170594558
+              }
+            },
+            "entities" => {
+              "keyPhrase" => [
+                "score"
+              ],
+              "number" => [
+                78
+              ]
+            },
+            "sentiment" => {
+              "label" => "neutral",
+              "score" => 0.5
+            }
+          }
+        },
+
+        double_number_entity: {
+          "query" => "Their scores were 89 and 97, respectively",
+          "prediction" => {
+            "topIntent" => "None",
+            "intents" => {
+              "None" => {
+                "score" => 0.5280223
+              }
+            },
+            "entities" => {
+              "keyPhrase" => [
+                "scores"
+              ],
+              "number" => [
+                89,
+                97
+              ]
+            },
+            "sentiment" => {
+              "label" => "negative",
+              "score" => 0.309174955
+            }
+          }
+        },
+
+        triple_number_entity: {
+          "query" => "Their scores were 89, 65, and 97, respectively",
+          "prediction" => {
+            "topIntent" => "None",
+            "intents" => {
+              "None" => {
+                "score" => 0.6703843
+              }
+            },
+            "entities" => {
+              "keyPhrase" => [
+                "scores"
+              ],
+              "number" => [
+                89,
+                65,
+                97
+              ]
+            },
+            "sentiment" => {
+              "label" => "negative",
+              "score" => 0.309174955
+            }
+          }
+        },
+
+        custom_entity: {
+          "query" => "call me right away",
+          "prediction" => {
+            "topIntent" => "now",
+            "intents" => {
+              "now" => {
+                "score" => 0.781227
+              }
+            },
+            "entities" => {
+              "asap" => [
+                ["right away"]
+              ]
+            },
+            "sentiment" => {
+              "label" => "neutral",
+              "score" => 0.5
+            }
+          }
+        }
+      }
+    end
+
+  end
+end

data/spec/version_spec.rb

@@ -1,7 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "Stealth::Version" do
 

data/stealth.gemspec

@@ -13,16 +13,16 @@ Gem::Specification.new do |s|
   s.email = 'mauricio@edge14.com'
 
   s.add_dependency 'sinatra', '~> 2.0'
-  s.add_dependency 'puma', '~> 3.10'
-  s.add_dependency 'thor', '~> 0.20'
+  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', '~> 5.0'
-  s.add_dependency 'activesupport', '~> 5.2'
+  s.add_dependency 'sidekiq', '~> 6.0'
+  s.add_dependency 'activesupport', '~> 6.0'
 
-  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rspec', '~> 3.9'
   s.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
   s.add_development_dependency 'rack-test', '~> 1.1'
-  s.add_development_dependency 'mock_redis', '~> 0.17'
+  s.add_development_dependency 'mock_redis', '~> 0.22'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")