socrates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da36c4903bca86d379dd6bbf2163f325b71fb852
+  data.tar.gz: ebd41affe29ae7b51ae5cfae2f348779b675d968
+SHA512:
+  metadata.gz: de3be228b5f26e6c4c2f33d10125f852f8fee4b2a943c5a7eebcfdba8ce18fd0d66498138c86222d438707f0f752f19b3d4a23da063da97b61ca705e3af20dc2
+  data.tar.gz: 9c5dc64b695f7a767f98461ee984c6bec32cc9bb3ebf8e8e25eeac95f7c70c12e67d8bbae59953e6c1eb1c3cec76b9e19b04f82873a29498651d5f7cc04e9679

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rubocop-https---raw-githubusercontent-com-carbonfive-c5-conventions-master-rubocop-rubocop-yml
+/socrates-*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - https://raw.githubusercontent.com/carbonfive/c5-conventions/master/rubocop/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in socrates.gemspec
+gemspec

data/README.md

@@ -0,0 +1,160 @@
+# 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.
+ 
+ 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.
+
+*Disclaimer: This framework is currently experimental and will change.*
+
+Conceptually, a conversation is a sequence of asking and listening actions. As a conversation progresses, information is gathered and at some point, acted upon by the system.
+
+Conversational state is captured either in memory (development and testing) or in Redis. This too is pluggable so that other storage backends could be used.
+
+Here is a simple example, asking for one's name, birth date, and then responding with the current age.
+
+![Calculate Age](./sample-conversation-console.gif)
+
+```ruby
+class GetStarted
+  include Socrates::Core::State
+
+  def listen(message)
+    case message.strip
+      when "help"
+        transition_to :help
+      when "age"
+        transition_to :ask_for_name
+      else
+        transition_to :no_comprende
+    end
+  end
+end
+
+class Help
+  include Socrates::Core::State
+
+  def ask
+    respond message: <<~MSG
+      Thanks for asking! I can do these things for you...
+
+        • `age` - Calculate your age from your birth date.
+        • `help` - Tell you what I can do for you.
+
+      So, what shall it be?
+    MSG
+    transition_to :get_started, action: :listen
+  end
+end
+
+class NoComprende
+  include Socrates::Core::State
+
+  def ask
+    respond message: "Whoops, I don't know what you mean by that. Try `help` to see my commands."
+    transition_to :get_started
+  end
+end
+
+class AskForName
+  include Socrates::Core::State
+
+  def ask
+    respond message: "First things first, what's your name?"
+  end
+
+  def listen(message)
+    # Transition to the next step while persisting the name for future retrieval.
+    transition_to :ask_for_birth_date, data: { name: message }
+  end
+end
+
+class AskForBirthDate
+  include Socrates::Core::State
+
+  def ask
+    respond message: "Hi #{first_name}! What's your birth date (e.g. MM/DD/YYYY)?"
+  end
+
+  def listen(message)
+    begin
+      birth_date = Date.strptime(message, "%m/%d/%Y")
+    rescue ArgumentError
+      respond message: "Whoops, I didn't understand that. What's your birth date (e.g. MM/DD/YYYY)?"
+      repeat_action
+      return
+    end
+    # Transition to the next step while persisting the birth date for future retrieval.
+    transition_to :calculate_age, data: { birth_date: birth_date }
+  end
+
+  private
+
+  def first_name
+    @data.get(:name).split.first
+  end
+end
+
+class CalculateAge
+  include Socrates::Core::State
+
+  def ask
+    respond message: "Got it #{first_name}! So that makes you #{calculate_age} years old."
+    end_conversation
+  end
+
+  private
+
+  def first_name
+    @data.get(:name).split.first
+  end
+
+  def birth_date
+    @data.get(:birth_date)
+  end
+
+  def calculate_age
+    ((Date.today.to_time - birth_date.to_time) / 31_536_000).floor
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'socrates'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install socrates
+
+## Usage
+
+TODO: Write usage instructions here.
+
+## Core Concepts
+
+* Dispatcher
+* Adapter (Slack, Console, Memory)
+* Storage (Memory, Redis)
+* State
+* Helpers
+
+TODO: Expand descriptions. Include a diagram.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the specs and rubocop. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/carbonfive/socrates.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "socrates"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  post:
+    - bundle exec rubocop

data/exe/socrates

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+File.expand_path("../../lib", __FILE__).tap do |lib|
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
+
+require "socrates"
+require "socrates/sample_states"
+
+puts "Type `help` to see what I can do..."
+
+Socrates::Bots::CLIBot.new(state_factory: Socrates::SampleStates::StateFactory.new).start

data/lib/socrates/adapters/console_adapter.rb

@@ -0,0 +1,34 @@
+class ConsoleAdapter
+  CLIENT_ID = "CONSOLE"
+
+  def initialize(name: "@socrates")
+    @name = name
+  end
+
+  def client_id_from_context(_context)
+    CLIENT_ID
+  end
+
+  def send_message(message, *)
+    puts "\n#{colorize(@name, "32;1")}: #{message}"
+  end
+
+  def send_direct_message(message, user, *)
+    name =
+      if user.respond_to?(:name)
+        user.name
+      elsif user.respond_to?(:id)
+        user.id
+      else
+        user
+      end
+
+    puts "\n[DM] #{colorize(name, "34;1")}: #{message}"
+  end
+
+  private
+
+  def colorize(str, color_code)
+    "\e[#{color_code}m#{str}\e[0m"
+  end
+end

data/lib/socrates/adapters/memory_adapter.rb

@@ -0,0 +1,29 @@
+class MemoryAdapter
+  CLIENT_ID = "MEMORY"
+
+  attr_reader :history, :dms
+
+  def initialize
+    @history = []
+    @dms     = {}
+  end
+
+  def client_id_from_context(_context)
+    CLIENT_ID
+  end
+
+  def send_message(message, *)
+    @history << message
+  end
+
+  def send_direct_message(message, user, *)
+    user = user.id if user.respond_to?(:id)
+
+    @dms[user] = [] unless @dms.key?(user)
+    @dms[user] << message
+  end
+
+  def last_message
+    @history.last
+  end
+end

data/lib/socrates/adapters/slack_adapter.rb

@@ -0,0 +1,33 @@
+class SlackAdapter
+  def initialize(slack_real_time_client)
+    @slack_real_time_client = slack_real_time_client
+  end
+
+  def client_id_from_context(context)
+    context&.user
+  end
+
+  def send_message(message, context:)
+    @slack_real_time_client.message(text: message, channel: context.channel)
+  end
+
+  def send_direct_message(message, user, *)
+    user = user.id if user.respond_to?(:id)
+
+    im_channel = lookup_im_channel(user)
+
+    @slack_real_time_client.message(text: message, channel: im_channel)
+  end
+
+  private
+
+  def lookup_im_channel(user)
+    im = @slack_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.channel.id
+  end
+end

data/lib/socrates/bots/cli_bot.rb

@@ -0,0 +1,20 @@
+module Socrates
+  module Bots
+    class CLIBot
+      def initialize(state_factory:)
+        @adapter    = ConsoleAdapter.new
+        @storage    = Storage::MemoryStorage.new
+        @dispatcher = Core::Dispatcher.new(storage: @storage, adapter: @adapter, state_factory: state_factory)
+      end
+
+      def start
+        # Clear out any remnants from previous runs.
+        @storage.clear(ConsoleAdapter::CLIENT_ID)
+
+        while (input = gets.chomp)
+          @dispatcher.dispatch(message: input)
+        end
+      end
+    end
+  end
+end

data/lib/socrates/bots/slack_bot.rb

@@ -0,0 +1,35 @@
+require "slack-ruby-client"
+
+module Socrates
+  module Bots
+    class SlackBot
+      def initialize(state_factory:)
+        Slack.configure do |config|
+          config.token        = ENV["SLACK_API_TOKEN"]
+          config.logger       = Logger.new(STDOUT)
+          config.logger.level = Logger::INFO
+
+          raise "Missing ENV[SLACK_API_TOKEN]!" unless config.token
+        end
+
+        @slack_client = Slack::RealTime::Client.new
+        @adapter      = SlackAdapter.new(@slack_client)
+        @storage      = Storage::RedisStorage.new
+        @dispatcher   = Core::Dispatcher.new(storage: @storage, adapter: @adapter, state_factory: state_factory)
+      end
+
+      def start
+        @slack_client.on :message do |data|
+          # puts "> #{data}"
+
+          # When first connecting, Slack may resend the last message. Ignore it...
+          next if data.reply_to.present?
+
+          @dispatcher.dispatch(message: data.text, context: data)
+        end
+
+        @slack_client.start!
+      end
+    end
+  end
+end

data/lib/socrates/config.rb

@@ -0,0 +1,19 @@
+module Socrates
+  module Config
+    extend self
+
+    attr_accessor :view_path
+    attr_accessor :error_message
+    attr_accessor :logger
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

data/lib/socrates/core/dispatcher.rb

@@ -0,0 +1,121 @@
+require "hashie"
+
+require "socrates/logger"
+require "socrates/string_helpers"
+require "socrates/storage/storage"
+require "socrates/core/state_data"
+
+module Socrates
+  module Core
+    class Dispatcher
+      def initialize(adapter:, state_factory:, storage: nil)
+        @adapter       = adapter
+        @state_factory = state_factory
+        @storage       = storage || Storage::MemoryStorage.new
+
+        @logger        = Socrates::Config.logger || Socrates::Logger.default
+        @error_message = Socrates::Config.error_message || DEFAULT_ERROR_MESSAGE
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def dispatch(message:, context: {})
+        message = message.strip
+
+        client_id = @adapter.client_id_from_context(context)
+
+        @logger.info %(#{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_snapshot(client_id)
+          state      = instantiate_state(state_data, context)
+
+          args = [state.data.state_action]
+          args << message if state.data.state_action == :listen
+
+          msg = %(#{client_id} processing :#{state.data.state_id} / :#{args.first})
+          msg += %( / message: "#{args.second}") if args.count > 1
+          @logger.debug msg
+
+          begin
+            state.send(*args)
+          rescue => e
+            handle_action_error(e, client_id, state, context)
+            return
+          end
+
+          # Update the persisted state data so we know what to run next time.
+          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})
+
+          persist_snapshot(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
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      DEFAULT_ERROR_MESSAGE = "Sorry, an error occurred. We'll have to start over..."
+
+      def fetch_snapshot(client_id)
+        state_data =
+          if @storage.has_key?(client_id)
+            begin
+              snapshot = @storage.get(client_id)
+              StateData.deserialize(snapshot)
+            rescue => e
+              @logger.warn "Error while fetching snapshot for client id '#{client_id}', resetting state: #{e.message}"
+              @logger.warn e
+            end
+          end
+
+        state_data ||= StateData.new
+
+        # 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
+          state_data.state_id     = @state_factory.default_state
+          state_data.state_action = :listen
+        end
+
+        state_data
+      end
+
+      def persist_snapshot(client_id, state_data)
+        @storage.put(client_id, state_data.serialize)
+      end
+
+      def instantiate_state(state_data, context)
+        @state_factory.build(state_data: state_data, adapter: @adapter, context: context)
+      end
+
+      def done_transitioning?(state)
+        # Stop transitioning if we're waiting for the user to respond (i.e. we're listening).
+        return true if state.data.state_action == :listen
+
+        # Stop transitioning if there's no state to transition to, or the conversation has ended.
+        return true if state.data.state_id.nil? || state.data.state_id == State::END_OF_CONVERSATION
+
+        false
+      end
+
+      def handle_action_error(e, client_id, state, context)
+        @logger.warn "Error while processing action #{state.data.state_id}/#{state.data.state_action}: #{e.message}"
+        @logger.warn e
+
+        @adapter.send_message(@error_message, context: context)
+        state.data.clear
+        state.data.state_id     = nil
+        state.data.state_action = nil
+
+        persist_snapshot(client_id, state.data)
+      end
+    end
+  end
+end

data/lib/socrates/core/state.rb

@@ -0,0 +1,111 @@
+require "hashie"
+require "erb"
+
+module Socrates
+  module Core
+    module State
+      attr_reader :data, :context
+
+      def initialize(data: StateData.new, adapter:, context: nil)
+        @data              = data
+        @adapter           = adapter
+        @context           = context
+        @next_state_id     = nil
+        @next_state_action = nil
+        @logger            = Socrates::Config.logger || Socrates::Logger.default
+      end
+
+      def next_state_id
+        if @next_state_id.nil?
+          state_id_from_classname
+        else
+          @next_state_id
+        end
+      end
+
+      def next_state_action
+        if @next_state_action.nil?
+          next_action(@data.state_action)
+        else
+          @next_state_action
+        end
+      end
+
+      def respond(message: nil, template: nil)
+        if template
+          # TODO: Partials?
+          filename = File.join(Socrates.config.view_path, template)
+          source   = File.read(filename)
+          message  = ERB.new(source, 0, "<>").result(binding)
+        end
+
+        return if message.empty?
+
+        @logger.info %(#{client_id} send: "#{format_for_logging(message)}")
+        @adapter.send_message(message, context: @context)
+      end
+
+      def send_message(to:, message:)
+        @logger.info %(#{client_id} send direct to #{to}: "#{format_for_logging(message)}")
+        @adapter.send_direct_message(message, to, context: @context)
+      end
+
+      def transition_to(state_id, action: nil, data: {})
+        if action.nil?
+          action =
+            if state_id.nil?
+              nil
+            elsif state_id == state_id_from_classname
+              next_action(@data.state_action)
+            else
+              :ask
+            end
+        end
+
+        @next_state_id     = state_id
+        @next_state_action = action
+
+        @data.merge(data)
+      end
+
+      def repeat_action
+        @next_state_id     = @data.state_id
+        @next_state_action = @data.state_action
+      end
+
+      def end_conversation
+        @data.clear
+
+        transition_to END_OF_CONVERSATION, action: END_OF_CONVERSATION
+      end
+
+      def ask
+        # stub implementation, to be overwritten.
+      end
+
+      def listen(_message)
+        # stub implementation, to be overwritten.
+      end
+
+      private
+
+      END_OF_CONVERSATION = :__end__
+
+      def next_action(current_action)
+        (%i[ask listen] - [current_action]).first
+      end
+
+      def client_id
+        @adapter.client_id_from_context(@context)
+      end
+
+      def format_for_logging(message)
+        message.gsub("\n", "\\n")
+      end
+
+      def state_id_from_classname
+        StringHelpers.classname_to_underscore(self.class.to_s.split("::").last).to_sym
+      end
+    end
+  end
+end

data/lib/socrates/core/state_data.rb

@@ -0,0 +1,78 @@
+require "hashie"
+require "json"
+require "set"
+require "yaml"
+
+module Socrates
+  module Core
+    class StateData
+      attr_accessor :state_id, :state_action
+
+      def initialize(state_id: nil, state_action: nil, data: {}, temporary_keys: [])
+        @state_id       = state_id
+        @state_action   = state_action
+        @data           = data
+        @temporary_keys = Set.new(temporary_keys)
+      end
+
+      def keys
+        @data.keys
+      end
+
+      def has_key?(key)
+        @data.has_key?(key)
+      end
+
+      def has_temporary_key?(key)
+        # The !! turns nils into false, which shouldn"t be necessary, but seems to be after the set is loaded from yaml.
+        @temporary_keys.include?(key) == true
+      end
+
+      def get(key, clear: false)
+        value = @data[key]
+
+        if @temporary_keys.include?(key) || clear
+          @temporary_keys.delete(key)
+          @data.delete(key)
+        end
+
+        value
+      end
+
+      def set(key, value)
+        @data[key] = value
+      end
+
+      def set_temporary(key, value)
+        if @data.has_key?(key) && !@temporary_keys.include?(key)
+          raise ArgumentError, "Cannot overrite key '#{key}' with a temporary value."
+        end
+
+        @data[key] = value
+        @temporary_keys << key
+      end
+
+      def merge(other)
+        @data.merge!(other)
+      end
+
+      def clear(key = nil)
+        if key
+          @data.delete(key)
+          @temporary_keys.delete(key)
+        else
+          @data.clear
+          @temporary_keys.clear
+        end
+      end
+
+      def serialize
+        YAML.dump(self)
+      end
+
+      def self.deserialize(string)
+        YAML.load(string)
+      end
+    end
+  end
+end

data/lib/socrates/logger.rb

@@ -0,0 +1,13 @@
+require "logger"
+
+module Socrates
+  class Logger < ::Logger
+    def self.default
+      @logger ||= begin
+        logger       = new(STDOUT)
+        logger.level = Logger::WARN
+        logger
+      end
+    end
+  end
+end

data/lib/socrates/sample_states.rb

@@ -0,0 +1,161 @@
+require "date"
+
+require "socrates/core/state"
+
+module Socrates
+  module SampleStates
+    class StateFactory
+      def default_state
+        :get_started
+      end
+
+      def build(state_data:, adapter:, context: nil)
+        classname = StringHelpers.underscore_to_classname(state_data.state_id)
+
+        Object.const_get("Socrates::SampleStates::#{classname}")
+          .new(data: state_data, adapter: adapter, context: context)
+      end
+    end
+
+    class GetStarted
+      include Socrates::Core::State
+
+      def listen(message)
+        case message.strip
+          when "help"
+            transition_to :help
+          when "age"
+            transition_to :ask_for_name
+          when "error"
+            transition_to :raise_error
+          else
+            transition_to :no_comprende
+        end
+      end
+    end
+
+    class Help
+      include Socrates::Core::State
+
+      def ask
+        respond message: <<~MSG
+          Thanks for asking! I can do these things for you...
+
+            • `age` - Calculate your age from your birth date.
+            • `error` - Start a short error path that raises an error.
+            • `help` - Tell you what I can do for you.
+
+          So, what shall it be?
+        MSG
+
+        transition_to :get_started, action: :listen
+      end
+    end
+
+    class NoComprende
+      include Socrates::Core::State
+
+      def ask
+        respond message: "Whoops, I don't know what you mean by that. Try `help` to see my commands."
+
+        transition_to :get_started
+      end
+    end
+
+    class AskForName
+      include Socrates::Core::State
+
+      def ask
+        respond message: "First things first, what's your name?"
+      end
+
+      def listen(message)
+        transition_to :ask_for_birth_date, data: { name: message }
+      end
+    end
+
+    class AskForBirthDate
+      include Socrates::Core::State
+
+      def ask
+        respond message: "Hi #{first_name}! What's your birth date (e.g. MM/DD/YYYY)?"
+      end
+
+      def listen(message)
+        begin
+          birth_date = Date.strptime(message, "%m/%d/%Y")
+        rescue ArgumentError
+          respond message: "Whoops, I didn't understand that. What's your birth date (e.g. MM/DD/YYYY)?"
+          repeat_action
+          return
+        end
+
+        transition_to :calculate_age, data: { birth_date: birth_date }
+      end
+
+      private
+
+      def first_name
+        @data.get(:name).split.first
+      end
+    end
+
+    class CalculateAge
+      include Socrates::Core::State
+
+      def ask
+        respond message: "Got it #{first_name}! So that makes you #{calculate_age} years old."
+
+        # Example of a :ask => :ask transition.
+        transition_to :end_conversation_1
+      end
+
+      private
+
+      def first_name
+        @data.get(:name).split.first
+      end
+
+      def birth_date
+        @data.get(:birth_date)
+      end
+
+      def calculate_age
+        ((Date.today.to_time - birth_date.to_time) / 31_536_000).floor
+      end
+    end
+
+    class EndConversation1
+      include Socrates::Core::State
+
+      def ask
+        respond message: "That's all for now..."
+
+        # Example of another :ask => :ask transition.
+        transition_to :end_conversation_2
+      end
+    end
+
+    class EndConversation2
+      include Socrates::Core::State
+
+      def ask
+        respond message: "Type `help` to see what else I can do."
+
+        end_conversation
+      end
+    end
+
+    class RaiseError
+      include Socrates::Core::State
+
+      def ask
+        respond message: "I will raise an error regardless of what you enter next..."
+      end
+
+      def listen(_message)
+        raise ArgumentError, "Boom!"
+      end
+    end
+  end
+end

data/lib/socrates/storage/storage.rb

@@ -0,0 +1,50 @@
+require "redis"
+require "json"
+
+module Socrates
+  module Storage
+    class MemoryStorage
+      def initialize
+        @storage = {}
+      end
+
+      def has_key?(key)
+        @storage.has_key? key
+      end
+
+      def clear(key)
+        @storage.delete key
+      end
+
+      def get(key)
+        @storage[key]
+      end
+
+      def put(key, value)
+        @storage[key] = value
+      end
+    end
+
+    class RedisStorage
+      def initialize(url: "redis://localhost")
+        @redis = Redis.new(url: url)
+      end
+
+      def has_key?(key)
+        @redis.exists(key)
+      end
+
+      def clear(key)
+        @redis.del key
+      end
+
+      def get(key)
+        @redis.get(key)
+      end
+
+      def put(key, value)
+        @redis.set(key, value)
+      end
+    end
+  end
+end

data/lib/socrates/string_helpers.rb

@@ -0,0 +1,23 @@
+require "active_support/inflector"
+
+module StringHelpers
+  def self.underscore_to_classname(underscored_symbol)
+    underscored_symbol.to_s.camelize
+  end
+
+  def self.classname_to_underscore(classname)
+    classname.underscore
+  end
+
+  # Lifted from Rails' text helpers.
+  def self.pluralize(count, singular, plural_arg = nil, plural: plural_arg)
+    word =
+      if count == 1 || count =~ /^1(\.0+)?$/
+        singular
+      else
+        plural || singular.pluralize
+      end
+
+    "#{count || 0} #{word}"
+  end
+end

data/lib/socrates/version.rb

@@ -0,0 +1,3 @@
+module Socrates
+  VERSION = "0.1.0"
+end

data/lib/socrates.rb

@@ -0,0 +1,19 @@
+# Socrates
+require "socrates/version"
+require "socrates/config"
+require "socrates/logger"
+require "socrates/string_helpers"
+require "socrates/adapters/console_adapter"
+require "socrates/adapters/memory_adapter"
+require "socrates/adapters/slack_adapter"
+require "socrates/storage/storage"
+require "socrates/core/state_data"
+require "socrates/core/state"
+require "socrates/core/dispatcher"
+
+# Bot implementations
+require "socrates/bots/cli_bot"
+require "socrates/bots/slack_bot"
+
+module Socrates
+end

data/socrates.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "socrates/version"
+
+Gem::Specification.new do |spec|
+  spec.name     = "socrates"
+  spec.version  = Socrates::VERSION
+  spec.license  = "MIT"
+  spec.authors  = ["Christian Nelson"]
+  spec.email    = ["christian@carbonfive.com"]
+
+  spec.summary  = "A microframework for building stateful conversational bots."
+  spec.homepage = "https://github.com/carbonfive/socrates"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "rubocop", "~> 0.48.1"
+
+  spec.add_dependency "activesupport", ">= 5.0.2"
+  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.0"
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: socrates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Nelson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.5
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: 
+email:
+- christian@carbonfive.com
+executables:
+- socrates
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- exe/socrates
+- lib/socrates.rb
+- lib/socrates/adapters/console_adapter.rb
+- lib/socrates/adapters/memory_adapter.rb
+- lib/socrates/adapters/slack_adapter.rb
+- lib/socrates/bots/cli_bot.rb
+- lib/socrates/bots/slack_bot.rb
+- lib/socrates/config.rb
+- lib/socrates/core/dispatcher.rb
+- lib/socrates/core/state.rb
+- lib/socrates/core/state_data.rb
+- lib/socrates/logger.rb
+- lib/socrates/sample_states.rb
+- lib/socrates/storage/storage.rb
+- lib/socrates/string_helpers.rb
+- lib/socrates/version.rb
+- sample-conversation-console.gif
+- socrates.gemspec
+homepage: https://github.com/carbonfive/socrates
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A microframework for building stateful conversational bots.
+test_files: []