stealth 1.0.4 → 1.1.0.rc1

data/lib/stealth/controller/replies.rb

@@ -16,15 +16,15 @@ module Stealth
           yaml_reply, preprocessor = action_replies
 
           service_reply = Stealth::ServiceReply.new(
-            recipient_id: current_user_id,
+            recipient_id: current_session_id,
             yaml_reply: yaml_reply,
             preprocessor: preprocessor,
             context: binding
           )
 
-          for reply in service_reply.replies do
+          service_reply.replies.each_with_index do |reply, i|
             handler = reply_handler.new(
-              recipient_id: current_user_id,
+              recipient_id: current_session_id,
               reply: reply
             )
 
@@ -35,7 +35,18 @@ module Stealth
             # If this was a 'delay' type of reply, we insert the delay
             if reply.reply_type == 'delay'
               begin
-                sleep_duration = Float(reply["duration"])
+                if reply['duration'] == 'dynamic'
+                  m = Stealth.config.dynamic_delay_muliplier
+                  duration = dynamic_delay(
+                    service_replies: service_reply.replies,
+                    position: i
+                  )
+
+                  sleep_duration = Stealth.config.dynamic_delay_muliplier * duration
+                else
+                  sleep_duration = Float(reply['duration'])
+                end
+
                 sleep(sleep_duration)
               rescue ArgumentError, TypeError
                 raise(ArgumentError, 'Invalid duration specified. Duration must be a float')
@@ -68,25 +79,55 @@ module Stealth
             current_session.flow_string.underscore.pluralize
           end
 
-          def action_replies
-            reply_dir = [*self._replies_path, replies_folder]
-            reply_filename = "#{current_session.state_string}.yml"
-            reply_file_path = File.join(*reply_dir, reply_filename)
+          def reply_dir
+            [*self._replies_path, replies_folder]
+          end
+
+          def base_reply_filename
+            "#{current_session.state_string}.yml"
+          end
+
+          def reply_filenames
+            service_filename = [base_reply_filename, current_service].join('+')
+
+            # Service-specific filenames take precedance (returned first)
+            [service_filename, base_reply_filename]
+          end
+
+          def find_reply_and_preprocessor
             selected_preprocessor = :none
+            reply_file_path = File.join(*reply_dir, base_reply_filename)
+            service_reply_path = File.join(*reply_dir, reply_filenames.first)
+
+            # Check if the service_filename exists
+            # If so, we can skip checking for a preprocessor
+            if File.exist?(service_reply_path)
+              return service_reply_path, selected_preprocessor
+            end
 
+            # Cycles through possible preprocessor and variant combinations
+            # Early returns for performance
             for preprocessor in self.class._preprocessors do
-              selected_filepath = File.join(*reply_dir, [reply_filename, preprocessor.to_s].join('.'))
-              if File.exists?(selected_filepath)
-                reply_file_path = selected_filepath
-                selected_preprocessor = preprocessor
-                break
+              for reply_filename in reply_filenames do
+                selected_filepath = File.join(*reply_dir, [reply_filename, preprocessor.to_s].join('.'))
+                if File.exist?(selected_filepath)
+                  reply_file_path = selected_filepath
+                  selected_preprocessor = preprocessor
+                  return reply_file_path, selected_preprocessor
+                end
               end
             end
 
+            return reply_file_path, selected_preprocessor
+          end
+
+          def action_replies
+            reply_file_path, selected_preprocessor = find_reply_and_preprocessor
+
             begin
               file_contents = File.read(reply_file_path)
             rescue Errno::ENOENT
-              raise(Stealth::Errors::ReplyNotFound, "Could not find a reply in #{reply_file_path}")
+              raise(Stealth::Errors::ReplyNotFound, "Could not find a reply in #{reply_dir}")
             end
 
             return file_contents, selected_preprocessor

data/lib/stealth/flow/base.rb

@@ -12,7 +12,7 @@ module Stealth
 
     class_methods do
       def flow(flow_name, &specification)
-        flow_spec[flow_name.to_sym] = Specification.new(&specification)
+        flow_spec[flow_name.to_sym] = Specification.new(flow_name, &specification)
       end
     end
 

data/lib/stealth/flow/specification.rb

@@ -4,10 +4,12 @@
 module Stealth
   module Flow
     class Specification
+      attr_reader :flow_name
       attr_accessor :states, :initial_state
 
-      def initialize(&specification)
+      def initialize(flow_name, &specification)
         @states = Hash.new
+        @flow_name = flow_name
         instance_eval(&specification)
       end
 
@@ -17,16 +19,36 @@ module Stealth
 
       private
 
-        def state(name, fails_to: nil)
-          fail_state = nil
-          if fails_to.present?
-            fail_state = Stealth::Flow::State.new(fails_to, self)
-          end
+        def state(name, fails_to: nil, redirects_to: nil)
+          fail_state = get_fail_or_redirect_state(fails_to)
+          redirect_state = get_fail_or_redirect_state(redirects_to)
+
+          new_state = Stealth::Flow::State.new(
+            name: name,
+            spec: self,
+            fails_to: fail_state,
+            redirects_to: redirect_state
+          )
 
-          new_state = Stealth::Flow::State.new(name, self, fail_state)
           @initial_state = new_state if @states.empty?
           @states[name.to_sym] = new_state
-          @scoped_state = new_state
+        end
+
+        def get_fail_or_redirect_state(specified_state)
+          if specified_state.present?
+            session = Stealth::Session.new
+
+            if Stealth::Session.is_a_session_string?(specified_state)
+              session.session = specified_state
+            else
+              session.session = Stealth::Session.canonical_session_slug(
+                flow: flow_name,
+                state: specified_state
+              )
+            end
+
+            return session
+          end
         end
 
     end

data/lib/stealth/flow/state.rb

@@ -8,14 +8,19 @@ module Stealth
       include Comparable
 
       attr_accessor :name
-      attr_reader :spec, :fails_to
+      attr_reader :spec, :fails_to, :redirects_to
 
-      def initialize(name, spec, fails_to = nil)
-        if fails_to.present? && !fails_to.is_a?(Stealth::Flow::State)
-          raise(ArgumentError, 'fails_to state should be a Stealth::Flow::State')
+      def initialize(name:, spec:, fails_to: nil, redirects_to: nil)
+        if fails_to.present? && !fails_to.is_a?(Stealth::Session)
+          raise(ArgumentError, 'fails_to state should be a Stealth::Session')
         end
 
-        @name, @spec, @fails_to = name, spec, fails_to
+        if redirects_to.present? && !redirects_to.is_a?(Stealth::Session)
+          raise(ArgumentError, 'redirects_to state should be a Stealth::Session')
+        end
+
+        @name, @spec = name, spec
+        @fails_to, @redirects_to = fails_to, redirects_to
       end
 
       def <=>(other_state)

data/lib/stealth/generators/builder/Gemfile

@@ -1,6 +1,9 @@
 source 'https://rubygems.org'
 
 gem 'stealth', '~> 1.0'
+
+gem 'railties', '~> 5.2'
+gem 'activerecord', '~> 5.2'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3'
 

data/lib/stealth/generators/builder/Procfile.dev

@@ -1,2 +1,2 @@
 web: bundle exec puma -C config/puma.rb
-sidekiq: bundle exec sidekiq -C config/sidekiq.yml -q webhooks -q default -r ./config/boot.rb
+sidekiq: bundle exec sidekiq -C config/sidekiq.yml -q stealth_webhooks -q stealth_replies -r ./config/boot.rb

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

@@ -3,19 +3,16 @@ class CatchAllsController < BotController
   def level1
     send_replies
 
-    if previous_session_specifies_fails_to?
-      step_to flow: previous_session.flow_string, state: previous_state.to_s
+    if fail_session.present?
+      step_to session: fail_session
     else
       step_to session: previous_session - 2.states
     end
   end
 
 private
-   def previous_session_specifies_fails_to?
-     previous_state.present?
-   end
 
-   def previous_state
+   def fail_session
      previous_session.flow.current_state.fails_to
    end
 

data/lib/stealth/generators/builder/config/services.yml

@@ -8,17 +8,16 @@ default: &default
   #   setup:
   #     greeting: # Greetings are broken up by locale
   #       - locale: default
-  #         text: "Welcome to the Stealth bot 🤖"
+  #         text: "Welcome to my Facebook Bot."
+  #     get_started:
+  #       payload: new_user
   #     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: "+4155330000"
+  #       - locale: default
+  #         composer_input_disabled: false
+  #         call_to_actions:
+  #         - type: payload
+  #           text: Some Button
+  #           payload: some_button
   #
   # ===========================================
   # ======== Example SMS Service Setup ========

data/lib/stealth/generators/generate/flow/controllers/controller.tt

@@ -2,25 +2,6 @@ class <%= name.classify.pluralize %>Controller < BotController
 
   def ask_example
     send_replies
-    update_session_to_next
-  end
-
-  def get_example
-    if current_message.message == 'Yes'
-      step_to state: 'say_yes_example'
-    elsif current_message.message == 'No'
-      step_to state: 'say_no_example'
-    end
-  end
-
-  def say_yes_example
-    send_replies
-    update_session_to state: 'ask_example'
-  end
-
-  def say_no_example
-    send_replies
-    update_session_to state: 'ask_example'
   end
 
 end

data/lib/stealth/generators/generate/flow/helpers/helper.tt

@@ -1,2 +1,3 @@
-module <%= name.capitalize.underscore.camelize %>Helper < BotHelper
+module <%= name.capitalize.underscore.camelize %>Helper
+
 end

data/lib/stealth/generators/generate.rb

@@ -21,23 +21,16 @@ module Stealth
 
       def create_replies
         # Sample Ask Reply
-        template('replies/ask_reply.tt', "bot/replies/#{name.pluralize}/ask_example.yml")
-        # Sample Say Replies
-        template('replies/say_yes_reply.tt', "bot/replies/#{name.pluralize}/say_yes_example.yml")
-        template('replies/say_no_reply.tt', "bot/replies/#{name.pluralize}/say_no_example.yml")
+        template('replies/ask_example.tt', "bot/replies/#{name.pluralize}/ask_example.yml.erb")
       end
 
       def create_helper
         template('helpers/helper.tt', "bot/helpers/#{name}_helper.rb")
       end
 
-      def create_model
-        template('models/model.tt', "bot/models/#{name}.rb")
-      end
-
       def edit_flow_map
         inject_into_file "config/flow_map.rb", after: "include Stealth::Flow\n" do
-          "\n\tflow :#{name} do\n\t\tstate :ask_example\n\t\tstate :get_example\n\t\tstate :say_yes_example\n\t\tstate :say_no_example\n\tend\n\n"
+          "\n\tflow :#{name} do\n\t\tstate :ask_example\n\tend\n"
         end
       end
 

data/lib/stealth/migrations/tasks.rb

@@ -17,6 +17,8 @@ module Stealth
         end
 
         def load_tasks
+          return unless defined?(ActiveRecord)
+
           configure
 
           Configurator.environments_config do |proxy|

data/lib/stealth/scheduled_reply.rb

@@ -4,7 +4,7 @@
 module Stealth
 
   class ScheduledReplyJob < Stealth::Jobs
-    sidekiq_options queue: :webhooks, retry: false
+    sidekiq_options queue: :stealth_replies, retry: false
 
     def perform(service, user_id, flow, state)
       service_message = ServiceMessage.new(service: service)

data/lib/stealth/server.rb

@@ -45,6 +45,8 @@ module Stealth
       )
 
       dispatcher.coordinate
+
+      status 202
     end
 
   end

data/lib/stealth/services/jobs/handle_message_job.rb

@@ -5,7 +5,7 @@ module Stealth
   module Services
 
     class HandleMessageJob < Stealth::Jobs
-      sidekiq_options queue: :webhooks, retry: false
+      sidekiq_options queue: :stealth_webhooks, retry: false
 
       def perform(service, params, headers)
         dispatcher = Stealth::Dispatcher.new(

data/lib/stealth/session.rb

@@ -9,15 +9,18 @@ module Stealth
     attr_reader :flow, :state, :user_id, :previous
     attr_accessor :session
 
-    def initialize(user_id:, previous: false)
+    def initialize(user_id: nil, previous: false)
       @user_id = user_id
       @previous = previous
 
-      unless defined?($redis) && $redis.present?
-        raise(Stealth::Errors::RedisNotConfigured, "Please make sure REDIS_URL is configured before using sessions")
+      if user_id.present?
+        unless defined?($redis) && $redis.present?
+          raise(Stealth::Errors::RedisNotConfigured, "Please make sure REDIS_URL is configured before using sessions")
+        end
+
+        get
       end
 
-      get
       self
     end
 
@@ -47,10 +50,14 @@ module Stealth
     end
 
     def get
-      if previous?
-        @session ||= $redis.get(previous_session_key(user_id: user_id))
-      else
-        @session ||= $redis.get(user_id)
+      prev_key = previous_session_key(user_id: user_id)
+
+      @session ||= begin
+        if sessions_expire?
+          previous? ? getex(prev_key) : getex(user_id)
+        else
+          previous? ? $redis.get(prev_key) : $redis.get(user_id)
+        end
       end
     end
 
@@ -58,10 +65,15 @@ module Stealth
       store_current_to_previous(flow: flow, state: state)
 
       @flow = nil
-      @session = canonical_session_slug(flow: flow, state: state)
+      @session = self.class.canonical_session_slug(flow: flow, state: state)
 
       Stealth::Logger.l(topic: "session", message: "User #{user_id}: setting session to #{flow}->#{state}")
-      $redis.set(user_id, session)
+
+      if sessions_expire?
+        $redis.setex(user_id, Stealth.config.session_ttl, session)
+      else
+        $redis.set(user_id, session)
+      end
     end
 
     def present?
@@ -82,7 +94,7 @@ module Stealth
 
       new_state = self.state + steps
       new_session = Stealth::Session.new(user_id: self.user_id)
-      new_session.session = canonical_session_slug(flow: self.flow_string, state: new_state)
+      new_session.session = self.class.canonical_session_slug(flow: self.flow_string, state: new_state)
 
       new_session
     end
@@ -97,18 +109,23 @@ module Stealth
       end
     end
 
-    private
+    def self.is_a_session_string?(string)
+      session_regex = /(.+)(#{SLUG_SEPARATOR})(.+)/
+      !!string.match(session_regex)
+    end
 
-      def canonical_session_slug(flow:, state:)
-        [flow, state].join(SLUG_SEPARATOR)
-      end
+    def self.canonical_session_slug(flow:, state:)
+      [flow, state].join(SLUG_SEPARATOR)
+    end
+
+    private
 
       def previous_session_key(user_id:)
         [user_id, 'previous'].join('-')
       end
 
       def store_current_to_previous(flow:, state:)
-        new_session = canonical_session_slug(flow: flow, state: state)
+        new_session = self.class.canonical_session_slug(flow: flow, state: state)
 
         # Prevent previous_session from becoming current_session
         if new_session == session
@@ -119,5 +136,16 @@ module Stealth
         end
       end
 
+      def sessions_expire?
+        Stealth.config.session_ttl > 0
+      end
+
+      def getex(key)
+        $redis.multi do
+          $redis.expire(key, Stealth.config.session_ttl)
+          $redis.get(key)
+        end
+      end
+
   end
 end

data/spec/controller/catch_all_spec.rb

@@ -62,12 +62,14 @@ describe "Stealth::Controller::CatchAll" do
     end
 
     it "should step_to catch_all->level1 when a StandardError is raised" do
+      controller.current_session.session = Stealth::Session.canonical_session_slug(flow: 'vader', state: 'my_action')
       controller.action(action: :my_action)
       expect(controller.current_session.flow_string).to eq("catch_all")
       expect(controller.current_session.state_string).to eq("level1")
     end
 
     it "should step_to catch_all->level1 when an action doesn't progress the flow" do
+      controller.current_session.session = Stealth::Session.canonical_session_slug(flow: 'vader', state: 'my_action2')
       controller.action(action: :my_action2)
       expect(controller.current_session.flow_string).to eq("catch_all")
       expect(controller.current_session.state_string).to eq("level1")
@@ -98,4 +100,3 @@ describe "Stealth::Controller::CatchAll" do
     end
   end
 end
-