socrates 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73a8be96fc0b04e14a3137c1ad12ab9a7bcecd88
-  data.tar.gz: 1b55c1e1a2422ce84e3a60d2317b44876862cfbb
+  metadata.gz: 67a86f6c23427a17a1271fc44b51b656b7e3e8c6
+  data.tar.gz: 331e7f16f68d78ca66490fc985861418cc891bf0
 SHA512:
-  metadata.gz: f4049f03b482773651d22cc6fa3dfb29d055fc1762d35a99b4fb7592fd8c1567240e6d552cb11712988df4e6173d73004ddee39b47470cfad32dd33a88c5f99c
-  data.tar.gz: 1dcaca7bed84ac8fb3219959ecf7fbec8fe5d52c66749842012d7252d64074a521fff2f9a972fcab92cf99e009a3e022f3f7d43bac5ef2c40effde5c6bb51923
+  metadata.gz: c8445176b8a001cbe6957e23f9e4f4909f376439d9cc0aa045a5f23ecfbeccd850331c1f31313f8a12987222ab8f70900d2bf0a2fd472b6b62b0c0c63a0aeee2
+  data.tar.gz: ff3aeced1731694a2fe660658c83c24f2e21db08755531a64639046e66ab39ad2190c0796d27af612547a5793646ce0345f0441fb15c4d2070437f911c8b0907

data/.gitignore

@@ -12,3 +12,4 @@
 
 # rspec failure tracking
 .rspec_status
+SCRATCH.md

data/README.md

@@ -153,11 +153,12 @@ restarting the bot. Use the `-d` flag for debugging log information.
 
 ## Core Concepts
 
-* Dispatcher
-* Adapter (Slack, Console, Memory)
-* Storage (Memory, Redis)
-* State
-* Helpers
+* Dispatcher - Kicks off conversations, responds to input, and provides general state managements.
+* Session - Buffers messages to channels, until flushed by an Adapter.
+* Adapter (Slack, Console, Memory) - Captures service specific functionality.
+* Storage (Memory, Redis) - Handles persisting conversational state.
+* State - Represents a state of a conversation, provides helpers for state implementations.
+* Helpers - Simple helpers.
 
 TODO: Expand descriptions. Include a diagram.
 

data/lib/socrates/adapters/adapter.rb

@@ -3,11 +3,16 @@ require "socrates/adapters/stubs"
 module Socrates
   module Adapters
     module Adapter
-      def client_id_from(_context: nil, _user: nil)
+      # Many of the methods in the Adapter module serve as an interface for Adapter implementations to
+      # implement. We want to serve as an example, even if we don't provide implementations here. Therefor,
+      # we're disabling this cop to avoid its warnings.
+      # rubocop:disable Lint/UnusedMethodArgument
+
+      def client_id_from(context: nil, user: nil)
         raise NotImplementedError
       end
 
-      def channel_from(_context: nil, _user: nil)
+      def channel_from(context: nil, user: nil)
         raise NotImplementedError
       end
 
@@ -21,7 +26,7 @@ module Socrates
 
       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?
+        raise ArgumentError, "recipient.id is required" unless recipient.id.present?
 
         dm_channel = channel_from(user: recipient)
 
@@ -35,29 +40,27 @@ module Socrates
         end
       end
 
-      def send_message(_channel, _message)
+      def send_message(channel, message)
         raise NotImplementedError
       end
 
-      def user_from(_context:)
+      def users(include_deleted: false, include_bots: false)
         raise NotImplementedError
       end
 
-      def users_list(*)
+      def user_from(context:)
         raise NotImplementedError
       end
 
-      def lookup_user(_email:)
-        raise NotImplementedError
+      def lookup_user(email:)
+        users.members.find { |user| email == user.profile&.email }
       end
 
       def lookup_email(*)
         raise NotImplementedError
       end
 
-      def users_channel(_user)
-        raise NotImplementedError
-      end
+      # rubocop:enable Lint/UnusedMethodArgument
     end
   end
 end

data/lib/socrates/adapters/slack.rb

@@ -27,18 +27,18 @@ module Socrates
           raise ArgumentError, "Expected context to respond to :channel" unless context.respond_to?(:channel)
           return context.channel
         end
-        return lookup_im_channel(user) unless user.nil?
+        return lookup_dm_channel(user) unless user.nil?
 
         raise ArgumentError, "Must provide one of context or user"
       end
 
-      def users_list(include_deleted: false, include_bots: false)
+      def users(include_deleted: false, include_bots: false)
         client = @real_time_client.web_client
 
-        client.users_list.tap do |response|
+        client.users_list.tap { |response|
           response.members.reject!(&:deleted?) unless include_deleted
           response.members.reject!(&:is_bot?) unless include_bots
-        end
+        }.members
       end
 
       def user_from(context:)
@@ -50,11 +50,6 @@ module Socrates
         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 }
-      end
-
       def lookup_email(context:)
         raise ArgumentError, "Expected context to respond to :user" unless context.respond_to?(:user)
 
@@ -69,7 +64,7 @@ module Socrates
         @real_time_client.message(text: message, channel: channel)
       end
 
-      def lookup_im_channel(user)
+      def lookup_dm_channel(user)
         im = @real_time_client.ims.values.find { |i| i.user == user }
 
         return im if im.present?

data/lib/socrates/adapters/stubs.rb

@@ -1,10 +1,8 @@
 module Socrates
   module Adapters
     #
-    # Response, User, Profile are POROs that represent keys concepts that exist in Slack (or other chat systems).
+    # User, Profile are POROs that represent keys concepts that exist in Slack (or other chat systems).
     #
-    Response = Struct.new(:members)
-
     User = Struct.new(:id, :name, :tz_offset, :profile) do
       def real_name
         return "" if profile.nil?
@@ -20,7 +18,7 @@ module Socrates
     # to be used by the stubbed versions of adapters (like Console and Memory).
     #
     module StubUserDirectory
-      attr_accessor :default_user, :users
+      attr_accessor :default_user
 
       def initialize
         @users = []
@@ -34,16 +32,12 @@ module Socrates
       end
       # rubocop:enable Metrics/ParameterLists
 
-      def user_from(*)
-        @default_user
+      def users(*)
+        @users
       end
 
-      def users_list(*)
-        Response.new(@users)
-      end
-
-      def lookup_user(email:)
-        @users.find { |user| email == user.profile&.email }
+      def user_from(*)
+        @default_user
       end
 
       def lookup_email(*)

data/lib/socrates/core/state.rb

@@ -51,7 +51,7 @@ module Socrates
         @adapter.queue_message(@session, message, send_now: send_now)
       end
 
-      def send_message(to:, message:) # TODO: direct_message? send_dm?
+      def send_message(to:, message:)
         displayable_to = to.respond_to?(:id) ? to.id : to
 
         @logger.info %Q(#{@session.channel} send direct to #{displayable_to}: "#{format_for_logging(message)}")

data/lib/socrates/sample_states.rb

@@ -178,7 +178,7 @@ module Socrates
       end
 
       def listen(message)
-        users = @adapter.users_list.members.sample(2)
+        users = @adapter.users.sample(2)
 
         users.each do |user|
           send_message(to: user, message: "Message: #{message}")

data/lib/socrates/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socrates
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Christian Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler