socrates 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ec8d3fe2a3292b1dcfcceecb7b7b988a2d16665
-  data.tar.gz: 0e09a7d93302051a5117a44d297fc514818dc73e
+  metadata.gz: f8a04c124dd3cd0a515b6f101904fd6484138f29
+  data.tar.gz: 58980557833fa80594c337a98208d06645a696a2
 SHA512:
-  metadata.gz: 84df3d652f807989b133d0188b9a16e8a45e6b28b6787398888e25329d83531c687d6ae0c397c6ed9e368407eddca13789c895a10382f2573acf45283a67a9f2
-  data.tar.gz: ad9ce7f1a969e776c9885cdc3c27b7bcb8126b80c42bebcf00fb2f0af356cbcd140757bd1a0a5a5e59891754449cab8129aa12c505dba21f8522a4ca3d36651b
+  metadata.gz: b271fadac73d6cd4f5f41d5971ef266d86e3a2302b25860c043aa0287a09cdc5d426949c21a5de12a7aeb54652aec88b38a2bd98283fc5ff75563e805e9bb527
+  data.tar.gz: 389636e1706c447bc54da299a3409d2990c73085463b56db0154b7967f97079eedcce40570fd8c6ef0f7908283d51e6c75ca5ceb20131f79845ade905ab5ddb2

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.4.2

data/lib/socrates/adapters/console.rb

@@ -25,29 +25,41 @@ module Socrates
         CHANNEL
       end
 
-      def send_message(message, channel)
-        raise ArgumentError, "Channel is required" unless channel.present?
+      def send_message(session, message, send_now: false)
+        raise ArgumentError, "Channel is required" unless session.channel.present?
 
-        puts "\n#{colorize(@name, "32;1")}: #{message}"
+        session.messages[session.channel] << message
+        flush_session(session, channel: session.channel) if send_now
       end
 
-      def send_direct_message(message, user)
-        raise ArgumentError, "User is required" unless user.present?
+      def send_direct_message(session, message, recipient)
+        raise ArgumentError, "User is required" unless recipient.present?
 
         name =
-          if user.respond_to?(:name)
-            user.name
-          elsif user.respond_to?(:id)
-            user.id
+          if recipient.respond_to?(:name)
+            recipient.name
+          elsif recipient.respond_to?(:id)
+            recipient.id
           else
-            user
+            recipient
           end
 
-        puts "\n[DM] #{colorize(name, "34;1")}: #{message}"
+        session.messages[name] << message
+      end
+
+      def flush_session(session, channel: nil) # TODO: Dry this up? Session? Included module?
+        session.messages.select { |c, _| channel.nil? || channel == c }.each do |c, messages|
+          _send_message(c, messages.join("\n\n"))
+          messages.clear
+        end
       end
 
       private
 
+      def _send_message(channel, message) # TODO: Underscored name?
+        puts "\n#{colorize(channel, "34;1")}: #{message}"
+      end
+
       def colorize(str, color_code)
         "\e[#{color_code}m#{str}\e[0m"
       end

data/lib/socrates/adapters/memory.rb

@@ -28,16 +28,26 @@ module Socrates
         user.nil? ? CHANNEL : users_channel(user)
       end
 
-      def send_message(message, channel)
-        raise ArgumentError, "Channel is required" unless channel.present?
+      def send_message(session, message, send_now: false)
+        raise ArgumentError, "Channel is required" unless session.channel.present?
 
-        @history[channel] << message
+        session.messages[session.channel] << message
+        flush_session(session, channel: session.channel) if send_now
       end
 
-      def send_direct_message(message, user)
-        raise ArgumentError, "User is required" unless user.present?
+      def send_direct_message(session, message, recipient)
+        raise ArgumentError, "Recipient is required" unless recipient.present?
+
+        im_channel = users_channel(recipient)
+
+        session.messages[im_channel] << message
+      end
 
-        @history[users_channel(user)] << message
+      def flush_session(session, channel: nil) # TODO: Dry this up? Session? Included module?
+        session.messages.select { |c, _| channel.nil? || channel == c }.each do |c, messages|
+          _send_message(c, messages.join("\n\n"))
+          messages.clear
+        end
       end
 
       #
@@ -62,6 +72,10 @@ module Socrates
 
       private
 
+      def _send_message(channel, message) # TODO: Underscored name?
+        @history[channel] << message
+      end
+
       def users_channel(user)
         user.respond_to?(:id) ? user.id : user
       end

data/lib/socrates/adapters/slack.rb

@@ -9,47 +9,56 @@ module Socrates
 
       def client_id_from(context: nil, user: nil)
         unless context.nil?
-          raise ArgumentError, "Expected :context to respond to :user" unless context.respond_to?(:user)
+          raise ArgumentError, "Expected context to respond to :user" unless context.respond_to?(:user)
           return context.user
         end
         unless user.nil?
-          raise ArgumentError, "Expected :user to respond to :id" unless user.respond_to?(:id)
+          raise ArgumentError, "Expected user to respond to :id" unless user.respond_to?(:id)
           return user.id
         end
-        raise ArgumentError, "Must provide one of :context or :user"
+        raise ArgumentError, "Must provide one of context or user"
       end
 
       def channel_from(context: nil, user: nil)
         unless context.nil?
-          raise ArgumentError, "Expected :context to respond to :channel" unless context.respond_to?(:channel)
+          raise ArgumentError, "Expected context to respond to :channel" unless context.respond_to?(:channel)
           return context.channel
         end
-        unless user.nil?
-          # raise ArgumentError, "Expected :user to respond to :id" unless user.respond_to?(:id)
-          return lookup_im_channel(user)
-        end
-        raise ArgumentError, "Must provide one of :context or :user"
+        return lookup_im_channel(user) unless user.nil?
+
+        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)
+        raise ArgumentError, "context cannot be nil" 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)
+      def send_message(session, message, send_now: false)
+        raise ArgumentError, "session is required" unless session.present?
+        raise ArgumentError, "session.channel is required" unless session.channel.present?
+
+        session.messages[session.channel] << message
+        flush_session(session, channel: session.channel) if send_now
       end
 
-      def send_direct_message(message, user)
-        raise ArgumentError, "Expected user to respond to :id" unless user.respond_to?(:id)
+      def send_direct_message(session, message, recipient)
+        raise ArgumentError, "Expected recipient to respond to :id" unless recipient.respond_to?(:id)
 
-        im_channel = lookup_im_channel(user)
+        im_channel = lookup_im_channel(recipient)
 
-        @real_time_client.message(text: message, channel: im_channel)
+        session.messages[im_channel] << message
+      end
+
+      def flush_session(session, channel: nil) # TODO: Dry this up? Session? Included module?
+        session.messages.select { |c, _| channel.nil? || channel == c }.each do |c, messages|
+          _send_message(c, messages.join("\n\n"))
+          messages.clear
+        end
       end
 
       def users_list(include_deleted: false, include_bots: false)
@@ -67,7 +76,7 @@ module Socrates
       end
 
       def lookup_email(context:)
-        raise ArgumentError, "Expected :context to respond to :user" unless context.respond_to?(:user)
+        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)
@@ -76,6 +85,10 @@ module Socrates
 
       private
 
+      def _send_message(channel, message) # TODO: Underscored name?
+        @real_time_client.message(text: message, channel: channel)
+      end
+
       def lookup_im_channel(user)
         im = @real_time_client.ims.values.find { |i| i.user == user }
 

data/lib/socrates/core/dispatcher.rb

@@ -5,6 +5,7 @@ require "socrates/configuration"
 require "socrates/logger"
 require "socrates/string_helpers"
 require "socrates/storage/memory"
+require "socrates/core/session"
 require "socrates/core/state"
 require "socrates/core/state_data"
 
@@ -25,25 +26,30 @@ module Socrates
         channel   = @adapter.channel_from(context: context)
         user      = @adapter.user_from(context: context)
 
-        do_dispatch(message, client_id, channel, user)
+        session = Session.new(client_id: client_id, channel: channel, user: user)
+
+        do_dispatch(session, message)
       end
 
       def start_conversation(user, state_id, message: nil)
         client_id = @adapter.client_id_from(user: user)
         channel   = @adapter.channel_from(user: user)
 
+        session = Session.new(client_id: client_id, channel: channel, user: user)
+
         # 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)
+        persist_state_data(session.client_id, state_data)
 
         # Send our initial message if one was passed to us.
-        @adapter.send_direct_message(message, user) if message.present?
+        @adapter.send_direct_message(session, message, user) if message.present?
 
-        do_dispatch(nil, client_id, channel, user)
+        do_dispatch(session, nil)
+        true
       end
 
       def conversation_state(user)
@@ -55,7 +61,7 @@ module Socrates
           snapshot   = @storage.get(client_id)
           state_data = StateData.deserialize(snapshot)
           state_data = nil if state_data.expired? || state_data.finished?
-        rescue => e
+        rescue StandardError => e
           @logger.warn "Error while fetching state_data for client id '#{client_id}'."
           @logger.warn e
           state_data = nil
@@ -68,28 +74,29 @@ module Socrates
 
       DEFAULT_ERROR_MESSAGE = "Sorry, an error occurred. We'll have to start over..."
 
-      def do_dispatch(message, client_id, channel, user)
+      # rubocop:disable Metrics/AbcSize
+      def do_dispatch(session, message)
         message = message&.strip
 
-        @logger.info %Q(#{client_id} recv: "#{message}")
+        @logger.info %Q(#{session.client_id} recv: "#{message}")
 
         # In many cases, a two actions will run in this loop: :listen => :ask, but it's possible that a chain of 2 or
         # 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, user)
+          state_data = fetch_state_data(session.client_id)
+          state      = instantiate_state(session, state_data)
 
           args = [state.data.state_action]
           args << message if state.data.state_action == :listen
 
-          msg = "#{client_id} processing :#{state.data.state_id} / :#{args.first}"
+          msg = "#{session.client_id} processing :#{state.data.state_id} / :#{args.first}"
           msg += %Q( / message: "#{args.second}") if args.count > 1
           @logger.debug msg
 
           begin
             state.send(*args)
-          rescue => e
-            handle_action_error(e, client_id, state, channel)
+          rescue StandardError => e
+            handle_action_error(e, session, state)
             return
           end
 
@@ -97,15 +104,17 @@ module Socrates
           state.data.state_id     = state.next_state_id
           state.data.state_action = state.next_state_action
 
-          @logger.debug "#{client_id} transition to :#{state.data.state_id} / :#{state.data.state_action}"
+          @logger.debug "#{session.client_id} transition to :#{state.data.state_id} / :#{state.data.state_action}"
 
-          persist_state_data(client_id, state.data)
+          persist_state_data(session.client_id, state.data)
 
           # Break from the loop if there's nothing left to do, i.e. no more state transitions.
           break if done_transitioning?(state)
         end
+        # rubocop:enable Metrics/AbcSize
 
-        true
+        # Flush the session, which contains any not-yet-send messages.
+        @adapter.flush_session(session)
       end
 
       # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
@@ -114,7 +123,7 @@ module Socrates
           begin
             snapshot   = @storage.get(client_id)
             state_data = StateData.deserialize(snapshot)
-          rescue => e
+          rescue StandardError => e
             @logger.warn "Error while fetching state_data for client id '#{client_id}', resetting state: #{e.message}"
             @logger.warn e
           end
@@ -147,8 +156,8 @@ module Socrates
         @storage.put(client_id, state_data.serialize)
       end
 
-      def instantiate_state(state_data, channel, user)
-        @state_factory.build(state_data: state_data, adapter: @adapter, channel: channel, user: user)
+      def instantiate_state(session, state_data)
+        @state_factory.build(state_data: state_data, adapter: @adapter, session: session)
       end
 
       def done_transitioning?(state)
@@ -159,16 +168,17 @@ module Socrates
         state.data.state_id.nil? || state.data.state_id == StateData::END_OF_CONVERSATION
       end
 
-      def handle_action_error(e, client_id, state, channel)
+      def handle_action_error(e, session, state)
         @logger.warn "Error while processing action #{state.data.state_id}/#{state.data.state_action}: #{e.message}"
         @logger.warn e
 
-        @adapter.send_message(@error_message, channel)
+        @adapter.send_message(session, @error_message, send_now: true)
+
         state.data.clear
         state.data.state_id     = nil
         state.data.state_action = nil
 
-        persist_state_data(client_id, state.data)
+        persist_state_data(session.client_id, state.data)
       end
     end
   end

data/lib/socrates/core/session.rb

@@ -0,0 +1,16 @@
+require "socrates/configuration"
+
+module Socrates
+  module Core
+    class Session
+      attr_accessor :client_id, :user, :channel, :messages
+
+      def initialize(client_id: nil, user: nil, channel: nil)
+        @client_id = client_id
+        @user      = user
+        @channel   = channel
+        @messages  = Hash.new { |hash, key| hash[key] = [] }
+      end
+    end
+  end
+end

data/lib/socrates/core/state.rb

@@ -9,13 +9,13 @@ require "socrates/core/state_data"
 module Socrates
   module Core
     module State
-      attr_reader :data, :adapter, :channel, :user
+      attr_reader :data, :adapter, :session, :user
 
-      def initialize(data: StateData.new, adapter:, channel:, user:)
+      def initialize(data: StateData.new, adapter:, session:)
         @data              = data
         @adapter           = adapter
-        @channel           = channel
-        @user              = user
+        @session           = session
+        @user              = session.user
         @next_state_id     = nil
         @next_state_action = nil
         @logger            = Socrates.config.logger || Socrates::Logger.default
@@ -37,7 +37,7 @@ module Socrates
         end
       end
 
-      def respond(message: nil, template: nil)
+      def respond(message: nil, template: nil, send_now: false)
         if template
           # TODO: Partials?
           filename = File.join(Socrates.config.view_path, template)
@@ -47,15 +47,15 @@ module Socrates
 
         return if message.empty?
 
-        @logger.info %Q(#{@channel} send: "#{format_for_logging(message)}")
-        @adapter.send_message(message, @channel)
+        @logger.info %Q(#{@session.channel} send: "#{format_for_logging(message)}")
+        @adapter.send_message(@session, message, send_now: send_now)
       end
 
       def send_message(to:, message:)
         displayable_to = to.respond_to?(:id) ? to.id : to
 
-        @logger.info %Q(#{@channel} send direct to #{displayable_to}: "#{format_for_logging(message)}")
-        @adapter.send_direct_message(message, to)
+        @logger.info %Q(#{@session.channel} send direct to #{displayable_to}: "#{format_for_logging(message)}")
+        @adapter.send_direct_message(@session, message, to)
       end
 
       def transition_to(state_id, action: nil, data: {})

data/lib/socrates/core/state_data.rb

@@ -38,6 +38,10 @@ module Socrates
         @last_interaction_timestamp = Time.current
       end
 
+      def each_key(&block)
+        @data.each_key(&block)
+      end
+
       def keys
         @data.keys
       end

data/lib/socrates/sample_states.rb

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

data/lib/socrates/version.rb

@@ -1,3 +1,3 @@
 module Socrates
-  VERSION = "0.1.15"
+  VERSION = "0.1.16"
 end

data/socrates.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -25,15 +23,15 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.5"
-  spec.add_development_dependency "rspec", "~> 3.5"
-  spec.add_development_dependency "rubocop", "~> 0.49.1"
-  spec.add_development_dependency "timecop", "~> 0.8.1"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.1"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rubocop", "~> 0.50.0"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
 
-  spec.add_dependency "activesupport", ">= 5.0.2"
+  spec.add_dependency "activesupport", ">= 5.1.4"
   spec.add_dependency "celluloid-io", ">= 0.17.3"
-  spec.add_dependency "hashie", ">= 3.5.5"
-  spec.add_dependency "redis", ">= 3.3.3"
-  spec.add_dependency "slack-ruby-client", ">= 0.8.1"
+  spec.add_dependency "hashie", ">= 3.5.6"
+  spec.add_dependency "redis", ">= 4.0.0"
+  spec.add_dependency "slack-ruby-client", ">= 0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socrates
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Christian Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-21 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,84 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.1.4
 - !ruby/object:Gem::Dependency
   name: celluloid-io
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +114,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.5
+        version: 3.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.5
+        version: 3.5.6
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.3
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.3
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.1
 description: 
 email:
 - christian@carbonfive.com
@@ -178,6 +178,7 @@ files:
 - lib/socrates/bots/slack.rb
 - lib/socrates/configuration.rb
 - lib/socrates/core/dispatcher.rb
+- lib/socrates/core/session.rb
 - lib/socrates/core/state.rb
 - lib/socrates/core/state_data.rb
 - lib/socrates/logger.rb
@@ -208,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A micro-framework for building stateful conversational bots.