socrates 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8a04c124dd3cd0a515b6f101904fd6484138f29
-  data.tar.gz: 58980557833fa80594c337a98208d06645a696a2
+  metadata.gz: 73a8be96fc0b04e14a3137c1ad12ab9a7bcecd88
+  data.tar.gz: 1b55c1e1a2422ce84e3a60d2317b44876862cfbb
 SHA512:
-  metadata.gz: b271fadac73d6cd4f5f41d5971ef266d86e3a2302b25860c043aa0287a09cdc5d426949c21a5de12a7aeb54652aec88b38a2bd98283fc5ff75563e805e9bb527
-  data.tar.gz: 389636e1706c447bc54da299a3409d2990c73085463b56db0154b7967f97079eedcce40570fd8c6ef0f7908283d51e6c75ca5ceb20131f79845ade905ab5ddb2
+  metadata.gz: f4049f03b482773651d22cc6fa3dfb29d055fc1762d35a99b4fb7592fd8c1567240e6d552cb11712988df4e6173d73004ddee39b47470cfad32dd33a88c5f99c
+  data.tar.gz: 1dcaca7bed84ac8fb3219959ecf7fbec8fe5d52c66749842012d7252d64074a521fff2f9a972fcab92cf99e009a3e022f3f7d43bac5ef2c40effde5c6bb51923

data/exe/socrates

@@ -34,7 +34,7 @@ option_parser = OptionParser.new do |parser|
 end
 option_parser.parse!
 
-def run_command(options)
+def run_command(options) # rubocop:disable Metrics/MethodLength
   storage =
     case options[:storage]
       when "redis"
@@ -54,9 +54,15 @@ def run_command(options)
 
   case (adapter = options[:adapter])
     when "console"
-      Socrates::Bots::CLI.new(state_factory: Socrates::SampleStates::StateFactory.new).start
+      adapter = Socrates::Adapters::Console.new
+      adapter.add_user(id: 1, name: "joe", first: "Joe", last: "Smith", email: "joe@example.com")
+      adapter.add_user(id: 2, name: "rachel", first: "Rachel", last: "Doe", email: "rachel@example.com")
+
+      Socrates::Bots::CLI.new(adapter: adapter, state_factory: Socrates::SampleStates::StateFactory.new).start
+
     when "slack"
       Socrates::Bots::Slack.new(state_factory: Socrates::SampleStates::StateFactory.new).start
+
     else
       puts "Unknown adapter '#{adapter}'"
       exit 1

data/lib/socrates/adapters/adapter.rb

@@ -0,0 +1,63 @@
+require "socrates/adapters/stubs"
+
+module Socrates
+  module Adapters
+    module Adapter
+      def client_id_from(_context: nil, _user: nil)
+        raise NotImplementedError
+      end
+
+      def channel_from(_context: nil, _user: nil)
+        raise NotImplementedError
+      end
+
+      def queue_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 queue_direct_message(session, message, recipient)
+        raise ArgumentError, "recipient is required" unless recipient.present?
+        raise ArgumentError, "recipient.if is required" unless recipient.id.present?
+
+        dm_channel = channel_from(user: recipient)
+
+        session.messages[dm_channel] << message
+      end
+
+      def flush_session(session, channel: nil)
+        session.messages.select { |c, _| channel.nil? || channel == c }.each do |c, messages|
+          send_message(c, messages.join("\n\n"))
+          messages.clear
+        end
+      end
+
+      def send_message(_channel, _message)
+        raise NotImplementedError
+      end
+
+      def user_from(_context:)
+        raise NotImplementedError
+      end
+
+      def users_list(*)
+        raise NotImplementedError
+      end
+
+      def lookup_user(_email:)
+        raise NotImplementedError
+      end
+
+      def lookup_email(*)
+        raise NotImplementedError
+      end
+
+      def users_channel(_user)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/socrates/adapters/console.rb

@@ -1,12 +1,13 @@
+require "socrates/adapters/adapter"
 require "socrates/adapters/stubs"
 
 module Socrates
   module Adapters
     class Console
+      include Socrates::Adapters::Adapter
       include StubUserDirectory
 
       CLIENT_ID = "CONSOLE"
-      CHANNEL   = "C1"
 
       def initialize(name: "@socrates")
         super()
@@ -22,41 +23,22 @@ module Socrates
       def channel_from(context: nil, user: nil)
         raise ArgumentError, "Must provide one of :context or :user" if context.nil? && user.nil?
 
-        CHANNEL
-      end
-
-      def send_message(session, message, send_now: false)
-        raise ArgumentError, "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(session, message, recipient)
-        raise ArgumentError, "User is required" unless recipient.present?
-
-        name =
-          if recipient.respond_to?(:name)
-            recipient.name
-          elsif recipient.respond_to?(:id)
-            recipient.id
-          else
-            recipient
-          end
-
-        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
+        if context&.fetch(:channel).present?
+          context[:channel]
+        elsif user.present?
+          display_user(user)
+        else
+          "?"
         end
       end
 
       private
 
-      def _send_message(channel, message) # TODO: Underscored name?
+      def display_user(user)
+        (user&.name || user&.id || user)&.upcase
+      end
+
+      def send_message(channel, message)
         puts "\n#{colorize(channel, "34;1")}: #{message}"
       end
 

data/lib/socrates/adapters/memory.rb

@@ -1,8 +1,10 @@
+require "socrates/adapters/adapter"
 require "socrates/adapters/stubs"
 
 module Socrates
   module Adapters
     class Memory
+      include Socrates::Adapters::Adapter
       include StubUserDirectory
 
       CLIENT_ID = "MEMORY"
@@ -28,28 +30,6 @@ module Socrates
         user.nil? ? CHANNEL : users_channel(user)
       end
 
-      def send_message(session, message, send_now: false)
-        raise ArgumentError, "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(session, message, recipient)
-        raise ArgumentError, "Recipient is required" unless recipient.present?
-
-        im_channel = users_channel(recipient)
-
-        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
-
       #
       # Methods for fetching messages and dms in specs...
       #
@@ -72,7 +52,7 @@ module Socrates
 
       private
 
-      def _send_message(channel, message) # TODO: Underscored name?
+      def send_message(channel, message)
         @history[channel] << message
       end
 

data/lib/socrates/adapters/slack.rb

@@ -1,8 +1,11 @@
 require "active_support/core_ext/object"
+require "socrates/adapters/adapter"
 
 module Socrates
   module Adapters
     class Slack
+      include Socrates::Adapters::Adapter
+
       def initialize(real_time_client)
         @real_time_client = real_time_client
       end
@@ -29,38 +32,6 @@ module Socrates
         raise ArgumentError, "Must provide one of context or user"
       end
 
-      def user_from(context:)
-        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(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(session, message, recipient)
-        raise ArgumentError, "Expected recipient to respond to :id" unless recipient.respond_to?(:id)
-
-        im_channel = lookup_im_channel(recipient)
-
-        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)
         client = @real_time_client.web_client
 
@@ -70,6 +41,15 @@ module Socrates
         end
       end
 
+      def user_from(context:)
+        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
+
       # Note: this triggers a call to the Slack API which makes it ill-suited for use within a loop.
       def lookup_user(email:)
         users_list.members.find { |user| email == user.profile&.email }
@@ -85,7 +65,7 @@ module Socrates
 
       private
 
-      def _send_message(channel, message) # TODO: Underscored name?
+      def send_message(channel, message)
         @real_time_client.message(text: message, channel: channel)
       end
 

data/lib/socrates/bots/cli.rb

@@ -10,8 +10,10 @@ module Socrates
       end
 
       def start
+        context = { channel: "CONSOLE" }
+
         while (input = gets.chomp)
-          @dispatcher.dispatch(input)
+          @dispatcher.dispatch(input, context: context)
         end
       end
     end

data/lib/socrates/core/dispatcher.rb

@@ -46,7 +46,7 @@ module Socrates
         persist_state_data(session.client_id, state_data)
 
         # Send our initial message if one was passed to us.
-        @adapter.send_direct_message(session, message, user) if message.present?
+        @adapter.queue_direct_message(session, message, user) if message.present?
 
         do_dispatch(session, nil)
         true
@@ -172,7 +172,7 @@ module Socrates
         @logger.warn "Error while processing action #{state.data.state_id}/#{state.data.state_action}: #{e.message}"
         @logger.warn e
 
-        @adapter.send_message(session, @error_message, send_now: true)
+        @adapter.queue_message(session, @error_message, send_now: true)
 
         state.data.clear
         state.data.state_id     = nil

data/lib/socrates/core/state.rb

@@ -48,14 +48,14 @@ module Socrates
         return if message.empty?
 
         @logger.info %Q(#{@session.channel} send: "#{format_for_logging(message)}")
-        @adapter.send_message(@session, message, send_now: send_now)
+        @adapter.queue_message(@session, message, send_now: send_now)
       end
 
-      def send_message(to:, message:)
+      def send_message(to:, message:) # TODO: direct_message? send_dm?
         displayable_to = to.respond_to?(:id) ? to.id : to
 
         @logger.info %Q(#{@session.channel} send direct to #{displayable_to}: "#{format_for_logging(message)}")
-        @adapter.send_direct_message(@session, message, to)
+        @adapter.queue_direct_message(@session, message, to)
       end
 
       def transition_to(state_id, action: nil, data: {})

data/lib/socrates/sample_states.rb

@@ -31,6 +31,8 @@ module Socrates
             transition_to :help
           when "age"
             transition_to :ask_for_name
+          when "dms"
+            transition_to :dms
           when "error"
             transition_to :raise_error
           else
@@ -47,6 +49,7 @@ module Socrates
           Thanks for asking! I can do these things for you...
 
             • `age` - Calculate your age from your birth date.
+            • `dms` - Sends a direct messages to two other users.
             • `error` - Start a short error path that raises an error.
             • `help` - Tell you what I can do for you.
 
@@ -167,6 +170,26 @@ module Socrates
       end
     end
 
+    class Dms
+      include Socrates::Core::State
+
+      def ask
+        respond message: "I will send whatever you type to two other users as direct messages."
+      end
+
+      def listen(message)
+        users = @adapter.users_list.members.sample(2)
+
+        users.each do |user|
+          send_message(to: user, message: "Message: #{message}")
+        end
+
+        respond message: "Direct messages sent!"
+
+        end_conversation
+      end
+    end
+
     class RaiseError
       include Socrates::Core::State
 

data/lib/socrates/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socrates
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Christian Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,6 +170,7 @@ files:
 - circle.yml
 - exe/socrates
 - lib/socrates.rb
+- lib/socrates/adapters/adapter.rb
 - lib/socrates/adapters/console.rb
 - lib/socrates/adapters/memory.rb
 - lib/socrates/adapters/slack.rb