socrates 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60482548634136856068bd61d2711fe88ee20af8
-  data.tar.gz: 2e00c859ba813a5f05168bdad145a7004bf67f8a
+  metadata.gz: c607c420626916f58b95937ab1494db96777de17
+  data.tar.gz: 7a981c8a829195f334488f2bc061d69d925ae9ad
 SHA512:
-  metadata.gz: 66ca5d145ad372efab8ec383413b1866c0069aac7d3d1f5b26b4f556c306d1e555573d2bf29dc02b0ddbda7bad241932189cdbc0ea142276096c886b62082a65
-  data.tar.gz: 5fdbf998e9f65a84736ec92ef75238949582b02b650f4f167e107060c6a403b7cab0d650599c0271e3141401320ec321baec3d6e411fa39c5650166af4c6b675
+  metadata.gz: 27eda804b512cbedcbdc32e90c3375128cc2fa01e6e1721e9ef57043d18fe2aa2fd510a7d5bf966d912c63074d0db6c91d3a5d2264e9746f79d6c5c0a74b9b83
+  data.tar.gz: ef78d69889110102795189a999d75d8d6dca08c61d8b08bec245c8c1867ba516b1c9e0079aef75936575d905e5be5c4d806f9fe9baf4693f4e65f7bfd79d6e5b

data/README.md

@@ -1,6 +1,6 @@
 # Socrates
 
-Socrates is a micro-framework for building conversational interfaces. It provides straight-forward state management, a clear pattern for modeling the states and conversational flow (transitions), and some helpers.
+Socrates is a micro-framework for building stateful conversational interfaces. It provides straight-forward state management, a clear pattern for modeling the states and conversational flow (transitions), and some helpers.
  
  It's designed for building conversational Slack bots, but is designed in such a way that other adapters could be written. It ships with a Console adapter for testing locally in the terminal as well as a Memory adapter for use in automated tests.
 
@@ -19,7 +19,7 @@ class GetStarted
   include Socrates::Core::State
 
   def listen(message)
-    case message.strip
+    case message.downcase
       when "help"
         transition_to :help
       when "age"
@@ -113,7 +113,7 @@ class CalculateAge
   end
 
   def calculate_age
-    ((Date.today.to_time - birth_date.to_time) / 31_536_000).floor
+    ((Date.today.to_time - birth_date.to_time) / 1.year).floor
   end
 end
 ```
@@ -136,7 +136,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here.
+Socrates is intended to be used programmatically from your application.
+
+However, it's easy to see a sample conversation run in either the console or on Slack. 
+
+To see socrates in action in the console:
+
+    $ socrates run
+
+And on Slack:
+    
+    $ SLACK_API_TOKEN=<your token> socrates -a slack run
+    
+Use `-s redis` to store state in Redis instead of memory. The key difference is that state will survive exiting and
+restarting the bot. Use the `-d` flag for debugging log information.
 
 ## Core Concepts
 

data/exe/socrates

@@ -4,9 +4,76 @@ File.expand_path("../../lib", __FILE__).tap do |lib|
   $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 end
 
+require "optparse"
+
 require "socrates"
 require "socrates/sample_states"
 
-puts "Type `help` to see what I can do..."
+options = {
+  adapter: "console",
+  storage: "memory",
+  debug:   false
+}
+
+option_parser = OptionParser.new do |parser|
+  parser.banner = "Usage: socrates [options] run"
+
+  parser.on("-h", "--help", "Show this help message") do
+    puts parser
+    exit
+  end
+  parser.on("-a", "--adapter ADAPTER", "Use the specified Adapter: console (default) or slack") do |value|
+    options[:adapter] = value.downcase
+  end
+  parser.on("-s", "--storage STORAGE", "Use the specified Storage: memory (default) or redis") do |value|
+    options[:storage] = value.downcase
+  end
+  parser.on("-d", "--debug", "Print detailed logging") do
+    options[:debug] = true
+  end
+end
+option_parser.parse!
+
+def run_command(options)
+  storage =
+    case options[:storage]
+      when "redis"
+        Socrates::Storage::RedisStorage.new(url: ENV.fetch("REDIS_URL", "redis://localhost"))
+      else
+        Socrates::Storage::MemoryStorage.new
+    end
+
+  Socrates.configure do |config|
+    config.storage = storage
+
+    if options[:debug]
+      config.logger       = Socrates::Logger.default
+      config.logger.level = Logger::DEBUG
+    end
+  end
 
-Socrates::Bots::CLIBot.new(state_factory: Socrates::SampleStates::StateFactory.new).start
+  case (adapter = options[:adapter])
+    when "console"
+      Socrates::Bots::CLIBot.new(state_factory: Socrates::SampleStates::StateFactory.new).start
+    when "slack"
+      Socrates::Bots::SlackBot.new(state_factory: Socrates::SampleStates::StateFactory.new).start
+    else
+      puts "Unknown adapter '#{adapter}'"
+      exit 1
+  end
+end
+
+command = ARGV.shift
+
+if command.nil?
+  puts option_parser.help
+  exit 1
+end
+
+case command.downcase
+  when "run"
+    run_command(options)
+  else
+    puts "Unknown command '#{command}'"
+    exit 1
+end

data/lib/socrates/adapters/slack_adapter.rb

@@ -1,8 +1,8 @@
 module Socrates
   module Adapters
     class SlackAdapter
-      def initialize(slack_real_time_client)
-        @slack_real_time_client = slack_real_time_client
+      def initialize(real_time_client)
+        @real_time_client = real_time_client
       end
 
       def client_id_from_context(context)
@@ -10,7 +10,7 @@ module Socrates
       end
 
       def send_message(message, context:)
-        @slack_real_time_client.message(text: message, channel: context.channel)
+        @real_time_client.message(text: message, channel: context.channel)
       end
 
       def send_direct_message(message, user, *)
@@ -18,28 +18,28 @@ module Socrates
 
         im_channel = lookup_im_channel(user)
 
-        @slack_real_time_client.message(text: message, channel: im_channel)
+        @real_time_client.message(text: message, channel: im_channel)
       end
 
       def users_list
-        client = @slack_real_time_client.web_client
+        client = @real_time_client.web_client
         client.users_list
       end
 
       def lookup_email(context:)
-        client = @slack_real_time_client.web_client
+        client = @real_time_client.web_client
         client.users_info(user: context.user)
       end
 
       private
 
       def lookup_im_channel(user)
-        im = @slack_real_time_client.ims.values.find { |i| i.user == user }
+        im = @real_time_client.ims.values.find { |i| i.user == user }
 
         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 = @real_time_client.web_client.im_open(user: user.id)
         response.channel.id
       end
     end

data/lib/socrates/bots/cli_bot.rb

@@ -8,7 +8,7 @@ module Socrates
 
       def start
         while (input = gets.chomp)
-          @dispatcher.dispatch(message: input)
+          @dispatcher.dispatch(input)
         end
       end
     end

data/lib/socrates/bots/slack_bot.rb

@@ -24,7 +24,7 @@ module Socrates
           # When first connecting, Slack may resend the last message. Ignore it...
           next if data.reply_to.present?
 
-          @dispatcher.dispatch(message: data.text, context: data)
+          @dispatcher.dispatch(data.text, context: data)
         end
 
         @slack_client.start!

data/lib/socrates/core/dispatcher.rb

@@ -18,7 +18,7 @@ module Socrates
       end
 
       # rubocop:disable Metrics/AbcSize
-      def dispatch(message:, context: {})
+      def dispatch(message, context: {})
         message = message.strip
 
         client_id = @adapter.client_id_from_context(context)

data/lib/socrates/sample_states.rb

@@ -135,7 +135,7 @@ module Socrates
       end
 
       def calculate_age
-        ((Date.today.to_time - birth_date.to_time) / 31_536_000).floor
+        ((Date.today.to_time - birth_date.to_time) / 1.year).floor
       end
     end
 

data/lib/socrates/version.rb

@@ -1,3 +1,3 @@
 module Socrates
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socrates
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Christian Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler