socrates 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b189f7e8275110163865fd7fdc586ad30d7481c6
-  data.tar.gz: fe7bdee2a73be689015c61a83981eb3fb424b6a9
+  metadata.gz: e8e7d4af57cd2c88ee489aeb393275c9eed7f1ab
+  data.tar.gz: 949fedfa9a56d3c6e4a7fa47f1422769cb096eca
 SHA512:
-  metadata.gz: 238271e59d1a7f141a104092ad4a689882f75e20c85c58a081624a7666174904ecd1d173707449763f811937eb3d85603ca090259fea6be6aca54618228fae1b
-  data.tar.gz: 327d7cc6207e3d4f1b70e3f29c65351bf7ba7a25e477de0a3eef298920b621b256604d1e1aebe94f586cc617468bf233fdb89af3968f6c6069dfc093788e963b
+  metadata.gz: f1b2eccddb347b003af3e85bbdfdc64ad7a9f2600e0fbc98353edf3b5d24d929d98a12a45b4871d7b28353d3647a744bc65be7976d35e7ed930a84d6957f1f82
+  data.tar.gz: 196f7252bf042ca77d2bcbf75bb251cfe27f1cd0a204b4e5e4e2bcc4420b7da64aed944e7946e40196bdb0afc0912297f77d84fa213cf9eaa63593821ceeb5be

data/lib/socrates/adapters/slack.rb

@@ -31,6 +31,15 @@ module Socrates
         raise ArgumentError, "Must provide one of :context or :user"
       end
 
+      def user_from(context:)
+        raise ArgumentError, "Must provide a :context" if context.nil?
+        raise ArgumentError, "Expected :context to respond to :user" unless context.respond_to?(:user)
+
+        client = @real_time_client.web_client
+        info   = client.users_info(user: context.user)
+        info.present? ? info.user : nil
+      end
+
       def send_message(message, channel)
         @real_time_client.message(text: message, channel: channel)
       end

data/lib/socrates/adapters/stubs.rb

@@ -16,11 +16,11 @@ module Socrates
     Profile = Struct.new(:first_name, :last_name, :email)
 
     #
-    # StubUserDirectory provides some simple stub behavior for adding stubbed users and querying against them. This are
-    # to be used by stubbed versions of adapters (like Console, Memory, etc).
+    # StubUserDirectory provides some simple stub behavior for adding stubbed users and querying against them. This is
+    # to be used by the stubbed versions of adapters (like Console and Memory).
     #
     module StubUserDirectory
-      attr_accessor :email, :users
+      attr_accessor :default_user, :users
 
       def initialize
         @users = []
@@ -28,20 +28,26 @@ module Socrates
 
       # rubocop:disable Metrics/ParameterLists
       def add_user(id: nil, name: nil, first: nil, last: nil, email: nil, tz_offset: 0)
-        users << User.new(id, name, tz_offset, Profile.new(first, last, email))
+        User.new(id, name, tz_offset, Profile.new(first, last, email)).tap do |new_user|
+          @users << new_user
+        end
       end
       # rubocop:enable Metrics/ParameterLists
 
+      def user_from(*)
+        @default_user
+      end
+
       def users_list(*)
-        Response.new(users)
+        Response.new(@users)
       end
 
       def lookup_user(email:)
-        users.find { |user| email == user.profile&.email }
+        @users.find { |user| email == user.profile&.email }
       end
 
       def lookup_email(*)
-        email
+        @default_user.profile&.email
       end
     end
   end

data/lib/socrates/bots/slack.rb

@@ -21,20 +21,13 @@ module Socrates
       end
 
       def start
-        reply_to_messages = {}
-
         @slack_client.on :message do |data|
           # puts "> #{data}"
 
-          if data.reply_to.present?
-            # Stash this message away because we may need it later.
-            reply_to_messages[data.channel] = data.text
-          end
+          # Slack sends us messages from ourslves sometimes, this skips them.
+          next if @slack_client.self.id == data.user
 
-          # Only dispatch the message if it does not match a previous reply_to message for the channel.
-          if reply_to_messages[data.channel] != data.text
-            @dispatcher.dispatch(data.text, context: data)
-          end
+          @dispatcher.dispatch(data.text, context: data)
         end
 
         @slack_client.start!

data/lib/socrates/configuration.rb

@@ -1,4 +1,4 @@
-require "active_support/core_ext/time"
+require "active_support/core_ext/numeric/time"
 require "socrates/logger"
 require "socrates/storage/memory"
 

data/lib/socrates/core/dispatcher.rb

@@ -23,23 +23,27 @@ module Socrates
       def dispatch(message, context: {})
         client_id = @adapter.client_id_from(context: context)
         channel   = @adapter.channel_from(context: context)
+        user      = @adapter.user_from(context: context)
 
-        do_dispatch(message, client_id, channel)
+        do_dispatch(message, client_id, channel, user)
       end
 
-      def start_conversation(user, state_id)
+      def start_conversation(user, state_id, message: nil)
         client_id = @adapter.client_id_from(user: user)
         channel   = @adapter.channel_from(user: user)
 
-        return false unless conversation_state(user).nil?
+        # Now, we assume the user of this code does this check on their own...
+        # return false unless conversation_state(user).nil?
 
         # Create state data to match the request.
         state_data = Socrates::Core::StateData.new(state_id: state_id, state_action: :ask)
 
         persist_state_data(client_id, state_data)
 
-        do_dispatch(nil, client_id, channel)
-        true
+        # Send our initial message if one was passed to us.
+        @adapter.send_direct_message(message, user) if message.present?
+
+        do_dispatch(nil, client_id, channel, user)
       end
 
       def conversation_state(user)
@@ -50,7 +54,7 @@ module Socrates
         begin
           snapshot   = @storage.get(client_id)
           state_data = StateData.deserialize(snapshot)
-          state_data = nil if state_data_expired?(state_data)
+          state_data = nil if state_data.expired? || state_data.finished?
         rescue => e
           @logger.warn "Error while fetching state_data for client id '#{client_id}'."
           @logger.warn e
@@ -64,7 +68,7 @@ module Socrates
 
       DEFAULT_ERROR_MESSAGE = "Sorry, an error occurred. We'll have to start over..."
 
-      def do_dispatch(message, client_id, channel)
+      def do_dispatch(message, client_id, channel, user)
         message = message&.strip
 
         @logger.info %Q(#{client_id} recv: "#{message}")
@@ -73,7 +77,7 @@ module Socrates
         # more :ask actions could run, before stopping at a :listen (and waiting for the next input).
         loop do
           state_data = fetch_state_data(client_id)
-          state      = instantiate_state(state_data, channel)
+          state      = instantiate_state(state_data, channel, user)
 
           args = [state.data.state_action]
           args << message if state.data.state_action == :listen
@@ -100,6 +104,8 @@ module Socrates
           # Break from the loop if there's nothing left to do, i.e. no more state transitions.
           break if done_transitioning?(state)
         end
+
+        true
       end
 
       # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
@@ -118,14 +124,14 @@ module Socrates
 
         # 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
+        if state_data.state_id.nil? || state_data.state_id == StateData::END_OF_CONVERSATION
           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?
+        elsif state_data.expired? && @state_factory.expired(state_data).present?
           expired_state, expired_action = @state_factory.expired(state_data)
 
           state_data.state_id     = expired_state
@@ -141,14 +147,8 @@ module Socrates
         @storage.put(client_id, state_data.serialize)
       end
 
-      def state_data_expired?(state_data)
-        return false unless state_data.last_interaction_timestamp.present?
-
-        state_data.elapsed_time > (Socrates.config.expired_timeout || 30.minutes)
-      end
-
-      def instantiate_state(state_data, channel)
-        @state_factory.build(state_data: state_data, adapter: @adapter, channel: channel)
+      def instantiate_state(state_data, channel, user)
+        @state_factory.build(state_data: state_data, adapter: @adapter, channel: channel, user: user)
       end
 
       def done_transitioning?(state)
@@ -156,7 +156,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.
-        state.data.state_id.nil? || state.data.state_id == State::END_OF_CONVERSATION
+        state.data.state_id.nil? || state.data.state_id == StateData::END_OF_CONVERSATION
       end
 
       def handle_action_error(e, client_id, state, channel)

data/lib/socrates/core/state.rb

@@ -11,10 +11,11 @@ module Socrates
     module State
       attr_reader :data, :context
 
-      def initialize(data: StateData.new, adapter:, channel:)
+      def initialize(data: StateData.new, adapter:, channel:, user:)
         @data              = data
         @adapter           = adapter
         @channel           = channel
+        @user              = user
         @next_state_id     = nil
         @next_state_action = nil
         @logger            = Socrates.config.logger || Socrates::Logger.default
@@ -83,7 +84,7 @@ module Socrates
       def end_conversation
         @data.clear
 
-        transition_to END_OF_CONVERSATION, action: END_OF_CONVERSATION
+        transition_to StateData::END_OF_CONVERSATION, action: StateData::END_OF_CONVERSATION
       end
 
       def ask
@@ -96,8 +97,6 @@ module Socrates
 
       private
 
-      END_OF_CONVERSATION = :__end__
-
       def next_action(current_action)
         (%i[ask listen] - [current_action]).first
       end

data/lib/socrates/core/state_data.rb

@@ -1,11 +1,14 @@
 require "hashie"
 require "json"
 require "yaml"
-require "active_support/core_ext/time"
+require "active_support/core_ext/numeric/time"
+require "socrates/configuration"
 
 module Socrates
   module Core
     class StateData
+      END_OF_CONVERSATION = :__end__
+
       attr_accessor :state_id, :state_action, :last_interaction_timestamp
 
       def initialize(state_id: nil, state_action: nil, data: {})
@@ -15,6 +18,16 @@ module Socrates
         @temporary_keys = []
       end
 
+      def finished?
+        @state_id.nil? || @state_id == END_OF_CONVERSATION
+      end
+
+      def expired?
+        return false unless last_interaction_timestamp.present?
+
+        elapsed_time > (Socrates.config.expired_timeout || 30.minutes)
+      end
+
       def elapsed_time
         Time.current - @last_interaction_timestamp
       end

data/lib/socrates/sample_states.rb

@@ -14,11 +14,11 @@ module Socrates
         :expired
       end
 
-      def build(state_data:, adapter:, channel:)
+      def build(state_data:, adapter:, channel:, user:)
         classname = StringHelpers.underscore_to_classname(state_data.state_id)
 
         Object.const_get("Socrates::SampleStates::#{classname}")
-          .new(data: state_data, adapter: adapter, channel: channel)
+          .new(data: state_data, adapter: adapter, channel: channel, user: user)
       end
     end
 

data/lib/socrates/version.rb

@@ -1,3 +1,3 @@
 module Socrates
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socrates
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Christian Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler