stealth 0.9.8 → 0.10.0

data/spec/session_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class NewTodoFlow
+  include Stealth::Flow
+
+  flow do
+    state :new
+
+    state :get_due_date
+
+    state :created, fails_to: :new
+
+    state :error
+  end
+end
+
+describe "Stealth::Session" do
+  let(:user_id) { '0xDEADBEEF' }
+
+  it "should raise an error if $redis is not set" do
+    $redis = nil
+
+    expect {
+      Stealth::Session.new(user_id: user_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) }
+
+    it "should have nil flow and state" do
+      expect(session.flow).to be_nil
+      expect(session.state).to be_nil
+    end
+
+    it "should have nil flow_string and state_string" do
+      expect(session.flow_string).to be_nil
+      expect(session.state_string).to be_nil
+    end
+
+    it "should respond to present? and blank?" do
+      expect(session.present?).to be false
+      expect(session.blank?).to be true
+    end
+  end
+
+  describe "with a session" do
+    class MarcoFlow
+      include Stealth::Flow
+
+      flow do
+        state :polo
+      end
+    end
+
+    let(:session) do
+      session = Stealth::Session.new(user_id: user_id)
+      session.set(flow: 'Marco', state: 'polo')
+      session
+    end
+
+    it "should return the flow" do
+      expect(session.flow).to be_a(MarcoFlow)
+    end
+
+    it "should return the state" do
+      expect(session.state).to be_a(Stealth::Flow::State)
+      expect(session.state).to eq :polo
+    end
+
+    it "should return the flow_string" do
+      expect(session.flow_string).to eq "Marco"
+    end
+
+    it "should return the state_string" do
+      expect(session.state_string).to eq "polo"
+    end
+
+    it "should respond to present? and blank?" do
+      expect(session.present?).to be true
+      expect(session.blank?).to be false
+    end
+  end
+
+  describe "incrementing and decrementing" do
+    let(:session) { Stealth::Session.new(user_id: user_id) }
+
+    it "should increment the state" do
+      session.set(flow: 'NewTodo', 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: 'NewTodo', 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: 'NewTodo', 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: 'NewTodo', state: 'created')
+      new_session = session + 5.states
+      expect(new_session.state_string).to eq('error')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,11 +3,14 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 
 require 'stealth'
+require 'mock_redis'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
+$redis = MockRedis.new
+
 RSpec.configure do |config|
 
 end

data/spec/support/sample_messages.rb

@@ -0,0 +1,65 @@
+class SampleMessage
+
+  def initialize(service:)
+    @service = service
+    @base_message = Stealth::ServiceMessage.new(service: @service)
+    @base_message.sender_id = sender_id
+    @base_message.timestamp = timestamp
+    @base_message
+  end
+
+  def message_with_text
+    @base_message.message = message
+    @base_message
+  end
+
+  def message_with_payload
+    @base_message.payload = payload
+    @base_message
+  end
+
+  def message_with_location
+    @base_message.location = location
+    @base_message
+  end
+
+  def message_with_attachments
+    @base_message.attachments = attachments
+    @base_message
+  end
+
+  private
+
+    def sender_id
+      if @service == 'twilio'
+        '+15554561212'
+      else
+        "8b3e0a3c-62f1-401e-8b0f-615c9d256b1f"
+      end
+    end
+
+    def timestamp
+      Time.now
+    end
+
+    def message
+      "Hello World!"
+    end
+
+    def payload
+      "some_payload"
+    end
+
+    def location
+      { lat: '42.323724' , lng: '-83.047543' }
+    end
+
+    def attachments
+      [ { type: 'image', url: 'https://domain.none/image.jpg' } ]
+    end
+
+    def referral
+      {}
+    end
+
+end

data/stealth.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.6'
   s.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
   s.add_development_dependency 'rack-test', '~> 0.7'
+  s.add_development_dependency 'mock_redis', '~> 0.17'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stealth
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.10.0
 platform: ruby
 authors:
 - Mauricio Gomes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2018-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 description: Ruby framework for building conversational bots.
 email: mauricio@edge14.com
 executables:
@@ -159,13 +173,13 @@ files:
 - lib/stealth/commands/console.rb
 - lib/stealth/commands/server.rb
 - lib/stealth/configuration.rb
-- lib/stealth/controller.rb
+- lib/stealth/controller/callbacks.rb
+- lib/stealth/controller/catch_all.rb
+- lib/stealth/controller/controller.rb
 - lib/stealth/dispatcher.rb
 - lib/stealth/errors.rb
 - lib/stealth/flow/base.rb
-- lib/stealth/flow/errors.rb
-- lib/stealth/flow/event.rb
-- lib/stealth/flow/event_collection.rb
+- lib/stealth/flow/core_ext.rb
 - lib/stealth/flow/specification.rb
 - lib/stealth/flow/state.rb
 - lib/stealth/jobs.rb
@@ -182,14 +196,17 @@ files:
 - lib/stealth/session.rb
 - lib/stealth/version.rb
 - spec/configuration_spec.rb
-- spec/flow/custom_transitions_spec.rb
+- spec/controller/callbacks_spec.rb
+- spec/controller/state_transitions_spec.rb
 - spec/flow/flow_spec.rb
-- spec/flow/transition_callbacks_spec.rb
+- spec/flow/state_spec.rb
 - spec/replies/nested_reply_with_erb.yml
-- spec/sample_services_yml/services.yml
-- spec/sample_services_yml/services_with_erb.yml
 - spec/service_reply_spec.rb
+- spec/session_spec.rb
 - spec/spec_helper.rb
+- spec/support/sample_messages.rb
+- spec/support/services.yml
+- spec/support/services_with_erb.yml
 - spec/version_spec.rb
 - stealth.gemspec
 homepage: https://github.com/whoisblackops/stealth
@@ -212,18 +229,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby framework for conversational bots
 test_files:
 - spec/configuration_spec.rb
-- spec/flow/custom_transitions_spec.rb
+- spec/controller/callbacks_spec.rb
+- spec/controller/state_transitions_spec.rb
 - spec/flow/flow_spec.rb
-- spec/flow/transition_callbacks_spec.rb
+- spec/flow/state_spec.rb
 - spec/replies/nested_reply_with_erb.yml
-- spec/sample_services_yml/services.yml
-- spec/sample_services_yml/services_with_erb.yml
 - spec/service_reply_spec.rb
+- spec/session_spec.rb
 - spec/spec_helper.rb
+- spec/support/sample_messages.rb
+- spec/support/services.yml
+- spec/support/services_with_erb.yml
 - spec/version_spec.rb

data/lib/stealth/flow/errors.rb

@@ -1,25 +0,0 @@
-# coding: utf-8
-# frozen_string_literal: true
-
-module Stealth
-  module Flow
-    class Error < StandardError; end
-
-    class TransitionHalted < Error
-
-      attr_reader :halted_because
-
-      def initialize(msg = nil)
-        @halted_because = msg
-        super msg
-      end
-
-    end
-
-    class NoTransitionAllowed < Error; end
-
-    class StealthFlowError < Error; end
-
-    class StealthFlowDefinitionError < Error; end
-  end
-end

data/lib/stealth/flow/event.rb

@@ -1,43 +0,0 @@
-# coding: utf-8
-# frozen_string_literal: true
-
-module Stealth
-  module Flow
-    class Event
-
-      attr_accessor :name, :transitions_to, :meta, :action, :condition
-
-      def initialize(name, transitions_to, condition = nil, meta = {}, &action)
-        @name = name
-        @transitions_to = transitions_to.to_sym
-        @meta = meta
-        @action = action
-        @condition = if condition.nil? || condition.is_a?(Symbol) || condition.respond_to?(:call)
-                       condition
-                     else
-                       raise TypeError, 'condition must be nil, an instance method name symbol or a callable (eg. a proc or lambda)'
-                     end
-      end
-
-      def condition_applicable?(object)
-        if condition
-          if condition.is_a?(Symbol)
-            object.send(condition)
-          else
-            condition.call(object)
-          end
-        else
-          true
-        end
-      end
-
-      def draw(graph, from_state)
-        graph.add_edges(from_state.name.to_s, transitions_to.to_s, meta.merge(:label => to_s))
-      end
-
-      def to_s
-        @name.to_s
-      end
-    end
-  end
-end

data/lib/stealth/flow/event_collection.rb

@@ -1,41 +0,0 @@
-# coding: utf-8
-# frozen_string_literal: true
-
-module Stealth
-  module Flow
-    class EventCollection < Hash
-
-      def [](name)
-        super name.to_sym # Normalize to symbol
-      end
-
-      def push(name, event)
-        key = name.to_sym
-        self[key] ||= []
-        self[key] << event
-      end
-
-      def flat
-        self.values.flatten.uniq do |event|
-          [:name, :transitions_to, :meta, :action].map { |m| event.send(m) }
-        end
-      end
-
-      def include?(name_or_obj)
-        case name_or_obj
-        when Event
-          flat.include? name_or_obj
-        else
-          !(self[name_or_obj].nil?)
-        end
-      end
-
-      def first_applicable(name, object_context)
-        (self[name] || []).detect do |event|
-          event.condition_applicable?(object_context) && event
-        end
-      end
-
-    end
-  end
-end

data/spec/flow/custom_transitions_spec.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe "custom transitions" do
-
-  class FetchTodosFlow
-    include Stealth::Flow
-
-    flow do
-      state :todays_todos do
-        event :fetch_tomorrows_todos, :transitions_to => :tomorrows_todos
-        event :fetch_yesterdays_todos, :transitions_to => :yesterdays_todos
-      end
-
-      state :tomorrows_todos do
-        event :view_todo, :transitions_to => :show
-        event :edit_todo, :transitions_to => :edit
-      end
-
-      state :tomorrows_todos do
-        event :view_todo, :transitions_to => :show
-        event :edit_todo, :transitions_to => :edit
-      end
-
-      state :show
-
-      state :edit do
-        event :save_todo, :transitions_to => :show
-        event :error_in_input, :transitions_to => :error
-      end
-
-      state :error
-    end
-
-    def view_todo(todo_id)
-      unless todo_id > 0
-        halt('ID is not valid.')
-      end
-
-      :the_todo
-    end
-
-    def edit_todo(todo_id)
-      unless todo_id > 0
-        halt('ID is not valid.')
-      end
-
-      :edit_todo_view
-    end
-
-    def save_todo(params)
-      if params.nil?
-        halt!('Invalid todo params specified.')
-      end
-
-      :todo_saved
-    end
-  end
-
-  let(:flow) { FetchTodosFlow.new }
-
-  it "should transition via custom transition methods" do
-    flow.fetch_tomorrows_todos!
-    expect(flow.view_todo!(1)).to eq :the_todo
-    expect(flow.current_state).to eq :show
-  end
-
-  it "should follow multiple custom transitions" do
-    flow.fetch_tomorrows_todos!
-    expect(flow.edit_todo!(1)).to eq :edit_todo_view
-    expect(flow.current_state).to eq :edit
-
-    expect(flow.save_todo!({ task: 'test' })).to eq :todo_saved
-    expect(flow.current_state).to eq :show
-  end
-
-  describe "halting transitions" do
-    it "should halt the transition when halt() is called" do
-      flow.fetch_tomorrows_todos!
-      flow.view_todo!(-1)
-      expect(flow.current_state).to eq :tomorrows_todos
-      expect(flow.halted_because).to eq "ID is not valid."
-    end
-
-    it "should halt the transition when halt!() is called and raise Stealth::Flow::TransitionHalted" do
-      flow.fetch_tomorrows_todos!
-      flow.edit_todo!(1)
-      expect(flow.current_state).to eq :edit
-
-      expect {
-        flow.save_todo!(nil)
-      }.to raise_error(Stealth::Flow::TransitionHalted)
-
-      expect(flow.halted_because).to eq "Invalid todo params specified."
-    end
-  end
-
-end