socrates 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aa5675086ee96c3c8a47ae71f43f3eeb834432c
-  data.tar.gz: 4ac0a6948f1b1c46a0adbba2fe82525016e452b2
+  metadata.gz: 18f251a1edba1096bdb4e8e1e93a2f9662100da0
+  data.tar.gz: e24c7497b5ac98e6d9b0c53830ede79a9dbcbee6
 SHA512:
-  metadata.gz: ef7c44bf3192f787974b132c2b6291c82bc8c864a219727d6bb5e54c89393946379dd6b0dd8b674608d90e35a8b61541afc75a5d8b026708c16427d53d2e0995
-  data.tar.gz: fd2a4d81d1ffeb91abf02f0dd48d72a619da2b2cdf64d8c932bb1ff315897039509abc1c858c8407f607215c0439155e1a28f760f4136146366ee4a392d36b78
+  metadata.gz: ddf938c670c619986a693c7f52e9a0d35304a6757f25a7031f013d55ecdb1cbcc13c75144ba4ea286664e478a127605e6b208fd210d2416e06a6062f27e84442
+  data.tar.gz: 24d70a3a10cc50f47f829f15a7c51ee96f2699ad4c1c4551800a67f66e1513f86b7d1b1749acc7a019671180be2607e6da21914a710ba1e104ab0bb6378f3ef7

data/lib/socrates/adapters/console_adapter.rb

@@ -1,34 +1,53 @@
-class ConsoleAdapter
-  CLIENT_ID = "CONSOLE"
+module Socrates
+  module Adapters
+    class ConsoleAdapter
+      CLIENT_ID = "CONSOLE"
 
-  def initialize(name: "@socrates")
-    @name = name
-  end
+      attr_accessor :email, :users
 
-  def client_id_from_context(_context)
-    CLIENT_ID
-  end
+      def initialize(name: "@socrates")
+        @name  = name
+        @users = []
+      end
 
-  def send_message(message, *)
-    puts "\n#{colorize(@name, "32;1")}: #{message}"
-  end
+      def client_id_from_context(_context)
+        CLIENT_ID
+      end
 
-  def send_direct_message(message, user, *)
-    name =
-      if user.respond_to?(:name)
-        user.name
-      elsif user.respond_to?(:id)
-        user.id
-      else
-        user
+      def send_message(message, *)
+        puts "\n#{colorize(@name, "32;1")}: #{message}"
       end
 
-    puts "\n[DM] #{colorize(name, "34;1")}: #{message}"
-  end
+      def send_direct_message(message, user, *)
+        name =
+          if user.respond_to?(:name)
+            user.name
+          elsif user.respond_to?(:id)
+            user.id
+          else
+            user
+          end
 
-  private
+        puts "\n[DM] #{colorize(name, "34;1")}: #{message}"
+      end
 
-  def colorize(str, color_code)
-    "\e[#{color_code}m#{str}\e[0m"
+      def add_user(id: nil, name: nil, first: nil, last: nil, email: nil)
+        users << User.new(id, name, Profile.new(first, last, email))
+      end
+
+      def users_list
+        Response.new(users)
+      end
+
+      def lookup_email(*)
+        email
+      end
+
+      private
+
+      def colorize(str, color_code)
+        "\e[#{color_code}m#{str}\e[0m"
+      end
+    end
   end
 end

data/lib/socrates/adapters/memory_adapter.rb

@@ -1,29 +1,46 @@
-class MemoryAdapter
-  CLIENT_ID = "MEMORY"
+module Socrates
+  module Adapters
+    class MemoryAdapter
+      CLIENT_ID = "MEMORY"
 
-  attr_reader :history, :dms
+      attr_reader :history, :dms
+      attr_accessor :email, :users
 
-  def initialize
-    @history = []
-    @dms     = {}
-  end
+      def initialize
+        @history = []
+        @dms     = Hash.new { |hash, key| hash[key] = [] }
+        @users   = []
+      end
 
-  def client_id_from_context(_context)
-    CLIENT_ID
-  end
+      def client_id_from_context(_context)
+        CLIENT_ID
+      end
 
-  def send_message(message, *)
-    @history << message
-  end
+      def send_message(message, *)
+        @history << message
+      end
 
-  def send_direct_message(message, user, *)
-    user = user.id if user.respond_to?(:id)
+      def send_direct_message(message, user, *)
+        user = user.id if user.respond_to?(:id)
 
-    @dms[user] = [] unless @dms.key?(user)
-    @dms[user] << message
-  end
+        @dms[user] << message
+      end
+
+      def last_message
+        @history.last
+      end
+
+      def add_user(id: nil, name: nil, first: nil, last: nil, email: nil)
+        users << User.new(id, name, Profile.new(first, last, email))
+      end
+
+      def users_list
+        Response.new(users)
+      end
 
-  def last_message
-    @history.last
+      def lookup_email(*)
+        email
+      end
+    end
   end
 end

data/lib/socrates/adapters/slack_adapter.rb

@@ -1,33 +1,47 @@
-class SlackAdapter
-  def initialize(slack_real_time_client)
-    @slack_real_time_client = slack_real_time_client
-  end
+module Socrates
+  module Adapters
+    class SlackAdapter
+      def initialize(slack_real_time_client)
+        @slack_real_time_client = slack_real_time_client
+      end
 
-  def client_id_from_context(context)
-    context&.user
-  end
+      def client_id_from_context(context)
+        context&.user
+      end
 
-  def send_message(message, context:)
-    @slack_real_time_client.message(text: message, channel: context.channel)
-  end
+      def send_message(message, context:)
+        @slack_real_time_client.message(text: message, channel: context.channel)
+      end
 
-  def send_direct_message(message, user, *)
-    user = user.id if user.respond_to?(:id)
+      def send_direct_message(message, user, *)
+        user = user.id if user.respond_to?(:id)
 
-    im_channel = lookup_im_channel(user)
+        im_channel = lookup_im_channel(user)
 
-    @slack_real_time_client.message(text: message, channel: im_channel)
-  end
+        @slack_real_time_client.message(text: message, channel: im_channel)
+      end
+
+      def users_list
+        client = @slack_real_time_client.web_client
+        client.users_list
+      end
+
+      def lookup_email(context:)
+        client = @slack_real_time_client.web_client
+        client.users_info(user: context.user)
+      end
 
-  private
+      private
 
-  def lookup_im_channel(user)
-    im = @slack_real_time_client.ims.values.find { |i| i.user == user }
+      def lookup_im_channel(user)
+        im = @slack_real_time_client.ims.values.find { |i| i.user == user }
 
-    return im if im.present?
+        return im if im.present?
 
-    # Start a new conversation with this user.
-    response = @slack_real_time_client.web_client.im_open(user: user.id)
-    response.channel.id
+        # Start a new conversation with this user.
+        response = @slack_real_time_client.web_client.im_open(user: user.id)
+        response.channel.id
+      end
+    end
   end
 end

data/lib/socrates/adapters/stubs.rb

@@ -0,0 +1,7 @@
+module Socrates
+  module Adapters
+    Response = Struct.new(:members)
+    User     = Struct.new(:id, :name, :profile)
+    Profile  = Struct.new(:first_name, :last_name, :email)
+  end
+end

data/lib/socrates/bots/cli_bot.rb

@@ -1,15 +1,12 @@
 module Socrates
   module Bots
     class CLIBot
-      def initialize(state_factory:)
-        @adapter    = ConsoleAdapter.new
+      def initialize(adapter:, state_factory:)
+        @adapter    = adapter || Adapters::ConsoleAdapter.new
         @dispatcher = Core::Dispatcher.new(adapter: @adapter, state_factory: state_factory)
       end
 
       def start
-        # Clear out any remnants from previous runs.
-        @storage.clear(ConsoleAdapter::CLIENT_ID)
-
         while (input = gets.chomp)
           @dispatcher.dispatch(message: input)
         end

data/lib/socrates/bots/slack_bot.rb

@@ -13,7 +13,7 @@ module Socrates
         end
 
         @slack_client = Slack::RealTime::Client.new
-        @adapter      = SlackAdapter.new(@slack_client)
+        @adapter      = Adapters::SlackAdapter.new(@slack_client)
         @dispatcher   = Core::Dispatcher.new(adapter: @adapter, state_factory: state_factory)
       end
 

data/lib/socrates/config.rb

@@ -5,6 +5,7 @@ module Socrates
     attr_accessor :view_path
     attr_accessor :storage
     attr_accessor :error_message
+    attr_accessor :expired_timeout # seconds
     attr_accessor :logger
   end
 

data/lib/socrates/core/dispatcher.rb

@@ -63,34 +63,51 @@ module Socrates
 
       DEFAULT_ERROR_MESSAGE = "Sorry, an error occurred. We'll have to start over..."
 
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def fetch_snapshot(client_id)
-        state_data =
-          if @storage.has_key?(client_id)
-            begin
-              snapshot = @storage.get(client_id)
-              StateData.deserialize(snapshot)
-            rescue => e
-              @logger.warn "Error while fetching snapshot for client id '#{client_id}', resetting state: #{e.message}"
-              @logger.warn e
-            end
+        if @storage.has_key?(client_id)
+          begin
+            snapshot   = @storage.get(client_id)
+            state_data = StateData.deserialize(snapshot)
+          rescue => e
+            @logger.warn "Error while fetching snapshot for client id '#{client_id}', resetting state: #{e.message}"
+            @logger.warn e
           end
+        end
 
         state_data ||= StateData.new
 
         # If the current state is nil or END_OF_CONVERSATION, set it to the default state, which is typically a state
         # that waits for an initial command or input from the user (e.g. help, start, etc).
         if state_data.state_id.nil? || state_data.state_id == State::END_OF_CONVERSATION
-          state_data.state_id     = @state_factory.default_state
-          state_data.state_action = :listen
+          default_state, default_action = @state_factory.default
+
+          state_data.state_id     = default_state
+          state_data.state_action = default_action || :listen
+
+        # Check to see if the last interation was too long ago.
+        elsif state_data_expired?(state_data) && @state_factory.expired(state_data).present?
+          expired_state, expired_action = @state_factory.expired(state_data)
+
+          state_data.state_id     = expired_state
+          state_data.state_action = expired_action || :ask
         end
 
         state_data
       end
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       def persist_snapshot(client_id, state_data)
+        state_data.reset_elapsed_time
         @storage.put(client_id, state_data.serialize)
       end
 
+      def state_data_expired?(state_data)
+        return unless state_data.timestamp.present?
+
+        state_data.elapsed_time > (Config.expired_timeout || 30.minutes)
+      end
+
       def instantiate_state(state_data, context)
         @state_factory.build(state_data: state_data, adapter: @adapter, context: context)
       end
@@ -100,9 +117,7 @@ module Socrates
         return true if state.data.state_action == :listen
 
         # Stop transitioning if there's no state to transition to, or the conversation has ended.
-        return true if state.data.state_id.nil? || state.data.state_id == State::END_OF_CONVERSATION
-
-        false
+        state.data.state_id.nil? || state.data.state_id == State::END_OF_CONVERSATION
       end
 
       def handle_action_error(e, client_id, state, context)

data/lib/socrates/core/state_data.rb

@@ -6,15 +6,24 @@ require "yaml"
 module Socrates
   module Core
     class StateData
-      attr_accessor :state_id, :state_action
+      attr_accessor :state_id, :state_action, :timestamp
 
       def initialize(state_id: nil, state_action: nil, data: {}, temporary_keys: [])
         @state_id       = state_id
         @state_action   = state_action
+        @timestamp      = Time.current
         @data           = data
         @temporary_keys = Set.new(temporary_keys)
       end
 
+      def elapsed_time
+        Time.current - @timestamp
+      end
+
+      def reset_elapsed_time
+        @timestamp = Time.current
+      end
+
       def keys
         @data.keys
       end

data/lib/socrates/sample_states.rb

@@ -5,10 +5,14 @@ require "socrates/core/state"
 module Socrates
   module SampleStates
     class StateFactory
-      def default_state
+      def default
         :get_started
       end
 
+      def expired(*)
+        :expired
+      end
+
       def build(state_data:, adapter:, context: nil)
         classname = StringHelpers.underscore_to_classname(state_data.state_id)
 
@@ -21,7 +25,7 @@ module Socrates
       include Socrates::Core::State
 
       def listen(message)
-        case message.strip
+        case message.downcase
           when "help"
             transition_to :help
           when "age"
@@ -62,6 +66,16 @@ module Socrates
       end
     end
 
+    class Expired
+      include Socrates::Core::State
+
+      def ask
+        respond message: "I've forgotten what we're talking about, let's start over."
+
+        transition_to :help
+      end
+    end
+
     class AskForName
       include Socrates::Core::State
 

data/lib/socrates/version.rb

@@ -1,3 +1,3 @@
 module Socrates
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/socrates.rb

@@ -6,6 +6,7 @@ require "socrates/string_helpers"
 require "socrates/adapters/console_adapter"
 require "socrates/adapters/memory_adapter"
 require "socrates/adapters/slack_adapter"
+require "socrates/adapters/stubs"
 require "socrates/storage/storage"
 require "socrates/core/state_data"
 require "socrates/core/state"

data/socrates.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "rubocop", "~> 0.48.1"
+  spec.add_development_dependency "timecop", "~> 0.8.1"
 
   spec.add_dependency "activesupport", ">= 5.0.2"
   spec.add_dependency "celluloid-io", ">= 0.17.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socrates
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Christian Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +173,7 @@ files:
 - lib/socrates/adapters/console_adapter.rb
 - lib/socrates/adapters/memory_adapter.rb
 - lib/socrates/adapters/slack_adapter.rb
+- lib/socrates/adapters/stubs.rb
 - lib/socrates/bots/cli_bot.rb
 - lib/socrates/bots/slack_bot.rb
 - lib/socrates/config.rb