stealth 1.0.0.pre1 → 1.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a447e930b543fe9125bb09baaaf12f160f5fa715e346fd6b304285f5a31f56f2
-  data.tar.gz: f5ff084dcb475b87ff972458751b16cc05779bed6eebf67f3feb15ba97909d68
+  metadata.gz: 1c9ae069b8bf53745259b83be47c652d625fb4c6f0c897c72dda88aa30696032
+  data.tar.gz: bed60f67d25cf795dff6e469f249c5c527dd008f56df5820502492450d4b8e8d
 SHA512:
-  metadata.gz: ad24b962addcbe10da90dc44a8b0220c7ced906c42a525f45d37f4ee9baad43600b968cae7fdabc2f5a5cad4279718203ec49680a396c6fa8b24429a6f8dc891
-  data.tar.gz: 207b7e854c327ef050a013017da9e284d820f3cac5819af8558ea9b7a86c8f252bef1fb7fe9bd8741fb5119d56be8523ae19930f0403d33f3e7b99e11ba132ab
+  metadata.gz: 012b9b948b15255b2fe2d8ae068e33d41cce1a398429b32df46f5e2fd656ed73374a488e22cbbb997921cc0913c4b9df84ad707e339427777ee3652b94435f8a
+  data.tar.gz: ea5cf2ce7fbe4858d3fba6bc5aa3535150ab32c9955aaa95783fd3e51908655b949093223d2b2a715e47177c321a2e91c18246cf249534e4c817a7714e690343

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stealth (0.10.6)
+    stealth (1.0.0.pre1)
       activesupport (~> 5.2.0)
       multi_json (~> 1.12)
       puma (~> 3.10)
@@ -20,14 +20,14 @@ GEM
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
     diff-lcs (1.3)
-    i18n (1.0.0)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     mock_redis (0.17.3)
     multi_json (1.13.1)
     mustermann (1.0.2)
     oj (3.5.0)
-    puma (3.11.3)
+    puma (3.11.4)
     rack (2.0.4)
     rack-protection (2.0.1)
       rack

data/README.md

@@ -21,6 +21,9 @@ Currently, there are gems for:
 * [Facebook Messenger](https://github.com/hellostealth/stealth-facebook)
 * [Twilio SMS](https://github.com/hellostealth/stealth-twilio)
 
+### Natural Language Processing
+* [AWS Comprehend](https://github.com/hellostealth/stealth-aws-comprehend)
+
 ### Analytics
 * [Mixpanel](https://github.com/hellostealth/stealth-mixpanel)
 

data/VERSION

@@ -1 +1 @@
-1.0.0.pre1
+1.0.0.pre2

data/lib/stealth/base.rb

@@ -22,25 +22,7 @@ module Stealth
     @root ||= File.expand_path(Pathname.new(Dir.pwd))
   end
 
-  def self.reloader
-    @reloader ||= begin
-      if Stealth.env == 'development'
-        ActiveSupport::Dependencies.mechanism = :load
-        ActiveSupport::Dependencies.autoload_paths = Dir["bot/**/*.rb"]
-        # @reloader = ActiveSupport::FileUpdateChecker.new(Dir["bot/**/*.rb"]) do
-        #   puts "YAAASSS"
-        # end
-        # ActiveSupport::Dependencies.autoload_paths = %w[bot/controllers bot/helpers bot/models]
-        # ActiveSupport::Dependencies.autoload_paths = [File.join(Stealth.root, "bot")]
-      end
-    end
-  end
-
   def self.boot
-    if Stealth.env == 'development'
-      ActiveSupport::Dependencies.mechanism = :load
-      ActiveSupport::Dependencies.autoload_paths = Dir["bot/**/*.rb"]
-    end
     load_environment
   end
 
@@ -76,14 +58,15 @@ module Stealth
     require File.join(Stealth.root, 'config', 'boot')
     require_directory("config/initializers")
     # Require explicitly to ensure it loads first
-    require_dependency File.join(Stealth.root, 'bot', 'controllers', 'bot_controller')
+    require File.join(Stealth.root, 'bot', 'controllers', 'bot_controller')
+    require File.join(Stealth.root, 'config', 'flow_map')
     require_directory("bot")
   end
 
   private
 
     def self.require_directory(directory)
-      for_each_file_in(directory) { |file| require_dependency(file) }
+      for_each_file_in(directory) { |file| require_relative(file) }
     end
 
     def self.for_each_file_in(directory, &blk)

data/lib/stealth/cli.rb

@@ -30,6 +30,7 @@ module Stealth
     def generate(generator, name)
       Stealth::Generators::Generate.start([generator, name])
     end
+    map 'g' => 'generate'
 
     desc 'version', 'Prints stealth version'
     long_desc <<-EOS
@@ -51,24 +52,16 @@ module Stealth
     $ > stealth server -p 4500
     EOS
     method_option :port, aliases: '-p', desc: 'The port to run the server on'
-    method_option :server, desc: 'Choose a specific Rack::Handler (webrick, thin, etc)'
-    method_option :rackup, desc: 'A rackup configuration file path to load (config.ru)'
-    method_option :host, desc: 'The host address to bind to'
-    method_option :debug, desc: 'Turn on debug output'
-    method_option :warn, desc: 'Turn on warnings'
-    method_option :daemonize, desc: 'If true, the server will daemonize itself (fork, detach, etc)'
-    method_option :pid, desc: 'Path to write a pid file after daemonize'
-    method_option :environment, desc: 'Path to environment configuration (config/environment.rb)'
-    method_option :code_reloading, desc: 'Code reloading', type: :boolean, default: true
     method_option :help, desc: 'Displays the usage message'
     def server
       if options[:help]
         invoke :help, ['server']
       else
         require 'stealth/commands/server'
-        Stealth::Commands::Server.new(options).start
+        Stealth::Commands::Server.new(port: options.fetch(:port) { 5000 }).start
       end
     end
+    map 's' => 'server'
 
 
     desc 'console', 'Starts a stealth console'
@@ -87,6 +80,7 @@ module Stealth
         Stealth::Commands::Console.new(options).start
       end
     end
+    map 'c' => 'console'
 
 
     desc 'setup', 'Runs setup tasks for a specified service'
@@ -101,16 +95,16 @@ module Stealth
       service_setup_klass.trigger
     end
 
-
-    desc 'clear_sessions', 'Clears all sessions in development'
+    desc 'sessions:clear', 'Clears all sessions in development'
     long_desc <<-EOS
-    `stealth clear_sessions` clears all sessions from Redis in development.
+    `stealth sessions:clear` clears all sessions from Redis in development.
 
-    $ > stealth clear_sessions
+    $ > stealth sessions:clear
     EOS
-    def clear_sessions
+    define_method 'sessions:clear' do
       Stealth.load_environment
-      $redis.flushdb if ENV['STEALTH_ENV'] == 'development'
+      $redis.flushdb if Stealth.env == 'development'
     end
+
   end
 end

data/lib/stealth/commands/server.rb

@@ -7,14 +7,43 @@ require 'stealth/commands/command'
 module Stealth
   module Commands
     class Server < Command
-      def initialize(options)
-        super(options)
-        Stealth.load_environment
+      def initialize(port:)
+        @port = port
+        $stdout.sync = true
       end
 
       def start
-        Rack::Handler::Puma.run(Stealth::Server)
+        # Rack::Handler::Puma.run(Stealth::Server)
+        puts ascii_art
+        exec "foreman start -f Procfile.dev -p #{@port}"
       end
+
+      private
+
+        def ascii_art
+          <<~ART
+                                    --
+                                  -yooy-
+                                -yo`  `oy-
+                              -yo`      `oy-
+                            -hh`          `hh-
+                          -yo`/y:        :y/`oy-
+                        -yo`    /y:    :y/    `oy-
+                      -yo`        /y::y/        `oy-
+                    -yd+           /dd/           +dy-
+                  -yo` :y/       :y/  /y:       /y/ `oy-
+                -yo`     :y/   :y/      /y:   /y/     `oy-
+              -yo`         :yoy/          /yoy:         `oy-
+              -yo`         :yoy/          /yoy:         `oy-
+                -yo`     :y/   :y/      /y:   /y:     `oy-
+                  -yo` :y/       :y/  /y:       /y: `oy-
+                    -yh/           :yy:           /hy-
+
+
+                            Stealth v#{Stealth::VERSION}
+
+          ART
+        end
     end
   end
 end

data/lib/stealth/controller/controller.rb

@@ -80,39 +80,36 @@ module Stealth
       Stealth::Logger.l(topic: "session", message: "User #{current_user_id}: scheduled session step to #{flow}->#{state} in #{delay} seconds")
     end
 
-    def step_to(session: nil, flow: nil, state: nil)
+    def step_to_at(timestamp, session: nil, flow: nil, state: nil)
       flow, state = get_flow_and_state(session: session, flow: flow, state: state)
-      step(flow: flow, state: state)
-    end
 
-    def update_session_to(session: nil, flow: nil, state: nil)
-      flow, state = get_flow_and_state(session: session, flow: flow, state: state)
-      update_session(flow: flow, state: state)
+      unless timestamp.is_a?(DateTime)
+        raise ArgumentError, "Please specify your step_to_at `timestamp` parameter as a DateTime"
+      end
+
+      Stealth::ScheduledReplyJob.perform_at(timestamp, current_service, current_user_id, flow, state)
+      Stealth::Logger.l(topic: "session", message: "User #{current_user_id}: scheduled session step to #{flow}->#{state} at #{timestamp.iso8601}")
     end
 
-    def step_to_next
-      flow, state = get_next_state
+    def step_to(session: nil, flow: nil, state: nil)
+      flow, state = get_flow_and_state(session: session, flow: flow, state: state)
       step(flow: flow, state: state)
     end
 
-    def update_session_to_next
-      flow, state = get_next_state
+    def update_session_to(session: nil, flow: nil, state: nil)
+      flow, state = get_flow_and_state(session: session, flow: flow, state: state)
       update_session(flow: flow, state: state)
     end
 
     private
 
       def update_session(flow:, state:)
-        Stealth::Logger.l(topic: "session", message: "User #{current_user_id}: updating session to #{flow}->#{state}")
-
         @current_session = Stealth::Session.new(user_id: current_user_id)
         @progressed = :updated_session
         @current_session.set(flow: flow, state: state)
       end
 
       def step(flow:, state:)
-        Stealth::Logger.l(topic: "session", message: "User #{current_user_id}: stepping to #{flow}->#{state}")
-
         update_session(flow: flow, state: state)
         @progressed = :stepped
         @flow_controller = nil
@@ -132,30 +129,16 @@ module Stealth
 
         if flow.present?
           if state.blank?
-            flow_klass = [flow, 'flow'].join('_').classify.constantize
-            state = flow_klass.flow_spec.states.keys.first
+            state = FlowMap.flow_spec[flow.to_sym].states.keys.first.to_s
           end
 
-          return flow, state
+          return flow.to_s, state.to_s
         end
 
         if state.present?
-          return current_session.flow_string, state
+          return current_session.flow_string, state.to_s
         end
       end
 
-      def get_next_state
-        current_state_index = current_session.flow.states.index(current_session.state_string.to_sym)
-        next_state = current_session.flow.states[current_state_index + 1]
-        if next_state.nil?
-          raise(
-            Stealth::Errors::InvalidStateTransitions,
-            "The next state after #{current_session.state_string} has not yet been defined"
-          )
-        end
-
-        return current_session.flow_string, next_state
-      end
-
   end
 end

data/lib/stealth/controller/helpers.rb

@@ -27,7 +27,7 @@ module Stealth
 
       included do
         class_attribute :_helpers, default: Module.new
-        class_attribute :helpers_path, default: []
+        class_attribute :helpers_path, default: ["bot/helpers"]
         class_attribute :include_all_helpers, default: true
       end
 
@@ -54,6 +54,9 @@ module Stealth
           # Allow all helpers to be included
           args += all_bot_helpers if args.delete(:all)
 
+          # Add each helper_path to the LOAD_PATH
+          Array(helpers_path).each {|path| $:.unshift(path) }
+
           args.flatten.map! do |arg|
             case arg
             when String, Symbol

data/lib/stealth/flow/base.rb

@@ -11,41 +11,42 @@ module Stealth
     extend ActiveSupport::Concern
 
     class_methods do
-      attr_reader :flow_spec
-
-      def flow(&specification)
-        @flow_spec = Specification.new(&specification)
+      def flow(flow_name, &specification)
+        flow_spec[flow_name.to_sym] = Specification.new(&specification)
       end
     end
 
     included do
-      attr_accessor :flow_state, :user_id
+      class_attribute :flow_spec, default: {}
+
+      attr_accessor :flow, :flow_state, :user_id
 
       def current_state
-        res = spec.states[@flow_state.to_sym] if @flow_state
-        res || spec.initial_state
+        res = self.spec.states[@flow_state.to_sym] if @flow_state
+        res || self.spec.initial_state
       end
 
-      def spec
-        # check the singleton class first
-        class << self
-          return flow_spec if flow_spec
-        end
+      def current_flow
+        @flow || self.class.flow_spec.keys.first
+      end
 
-        self.class.flow_spec
+      def spec
+        self.class.flow_spec[current_flow]
       end
 
       def states
         self.spec.states.keys
       end
 
-      def init_state(state)
-        raise(ArgumentError, 'No state was specified.') if state.blank?
-
+      def init(flow:, state:)
+        new_flow = flow.to_sym
         new_state = state.to_sym
-        unless states.include?(new_state)
-          raise(Stealth::Errors::InvalidStateTransition, "Unknown state '#{state}' for #{self.class.to_s}")
+
+        unless state_exists?(potential_flow: new_flow, potential_state: new_state)
+          raise(Stealth::Errors::InvalidStateTransition, "Unknown state '#{new_state}' for '#{new_flow}' flow")
         end
+
+        @flow = new_flow
         @flow_state = new_state
 
         self
@@ -54,7 +55,15 @@ module Stealth
       private
 
         def flow_and_state
-          [self.class.to_s, current_state].join("->")
+          [current_flow, current_state].join("->")
+        end
+
+        def state_exists?(potential_flow:, potential_state:)
+          if self.class.flow_spec[potential_flow].present?
+            self.class.flow_spec[potential_flow].states.include?(potential_state)
+          else
+            raise(Stealth::Errors::InvalidStateTransition, "Unknown flow '#{potential_flow}'")
+          end
         end
     end
 

data/lib/stealth/generators/builder/Gemfile

@@ -9,3 +9,7 @@ gem 'stealth', '~> 0.10.0'
 
 # Uncomment to enable the Stealth Twilio SMS Driver
 # gem 'stealth-twilio'
+
+group :development do
+  gem 'foreman'
+end

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

@@ -1,10 +1,12 @@
 class BotController < Stealth::Controller
 
+  helper :all
+
   def route
     if current_session.present?
       step_to session: current_session
     else
-      step_to flow: 'Hello', state: 'say_hello'
+      step_to flow: 'hello', state: 'say_hello'
     end
   end
 

data/lib/stealth/generators/builder/{bot/flow_map.rb.tt → config/flow_map.rb}

@@ -1,4 +1,4 @@
-class <%= name.capitalize.underscore.classify %>Flow
+class FlowMap
 
   include Stealth::Flow
 
@@ -10,7 +10,7 @@ class <%= name.capitalize.underscore.classify %>Flow
     state :say_goodbye
   end
 
-  flow :catchall do
+  flow :catch_all do
     state :level1
   end
 

data/lib/stealth/generators/builder/readme.md

@@ -2,8 +2,8 @@
 
 To boot this bot locally, we recommend the following:
 
-1. `gem install foreman`
-2. Start Redis
-3. `foreman start -f Procfile.dev`
+1. `bundle`
+2. Start your local Redis server
+3. `stealth s`
 
-Using `foreman` will start the web server and Sidekiq processes together.
+For more information, please check out the [Stealth documentation](https://hellostealth.org/docs).

data/lib/stealth/generators/builder.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+# frozen_string_literal: true
+
 require 'thor/group'
 
 module Stealth

data/lib/stealth/generators/generate.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+# frozen_string_literal: true
+
 require 'thor/group'
 
 module Stealth

data/lib/stealth/logger.rb

@@ -4,9 +4,45 @@
 module Stealth
   class Logger
 
+    COLORS = ::Hash[
+      black:   30,
+      red:     31,
+      green:   32,
+      yellow:  33,
+      blue:    34,
+      magenta: 35,
+      cyan:    36,
+      gray:    37,
+    ].freeze
+
+    def self.color_code(code)
+      COLORS.fetch(code) { raise(ArgumentError, "Color #{code} not supported.") }
+    end
+
+    def self.colorize(input, color:)
+      "\e[#{color_code(color)}m#{input}\e[0m"
+    end
+
     def self.log(topic:, message:)
       unless ENV['STEALTH_ENV'] == 'test'
-        puts "[#{topic.upcase}] #{message}"
+        puts "#{print_topic(topic)} #{message}"
+      end
+    end
+
+    def self.print_topic(topic)
+      topic_string = "[#{topic}]"
+
+      case topic.to_sym
+      when :session
+        colorize(topic_string, color: :green)
+      when :previous_session
+        colorize(topic_string, color: :yellow)
+      when :facebook, :twilio
+        colorize(topic_string, color: :blue)
+      when :catch_all
+        colorize(topic_string, color: :red)
+      else
+        colorize(topic_string, color: :gray)
       end
     end
 

data/lib/stealth/server.rb

@@ -30,11 +30,6 @@ module Stealth
     end
 
     get_or_post '/incoming/:service' do
-      if Stealth.env == 'development'
-        Stealth::Logger.l(topic: "ARGF", message: "RELOADING")
-        ActiveSupport::Dependencies.clear
-      end
-      
       Stealth::Logger.l(topic: "incoming", message: "Received webhook from #{params[:service]}")
 
       # JSON params need to be parsed and added to the params

data/lib/stealth/session.rb

@@ -31,11 +31,7 @@ module Stealth
     def flow
       return nil if flow_string.blank?
 
-      @flow ||= begin
-        flow_klass = [flow_string, 'flow'].join('_').classify.constantize
-        flow = flow_klass.new.init_state(state_string)
-        flow
-      end
+      @flow ||= FlowMap.new.init(flow: flow_string, state: state_string)
     end
 
     def state
@@ -63,6 +59,8 @@ module Stealth
 
       @flow = nil
       @session = 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)
     end
 

data/spec/controller/callbacks_spec.rb

@@ -143,20 +143,16 @@ class OtherFlowTestersController < BotController
     end
 end
 
-class FlowTesterFlow
+class FlowMap
   include Stealth::Flow
 
-  flow do
+  flow :flow_tester do
     state :my_action
     state :my_action2
     state :my_action3
   end
-end
-
-class OtherFlowTesterFlow
-  include Stealth::Flow
 
-  flow do
+  flow :other_flow_tester do
     state :other_action
     state :other_action2
     state :other_action3