responder_bot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe5cb293edddcfa00abc32ec573cb25a8b4f34f5072d9e0997e7cc5fd213781d
+  data.tar.gz: b30614a7b3b6b88b8fe4d5a1a02b3be07bcb67fedf64409c0e30ab8962c4009e
+SHA512:
+  metadata.gz: 40b73583b1aab9c3f7d0b9b1fb585d3e1c621473c428c52e6c66d9cd08ced31bca0aabd03ae65250938ad1c623fbc0ee8a2061248c3965d23a550b1d24bd0bad
+  data.tar.gz: 74bbb17447a8b79e6560c1643776a1e809b96c573f661b84b48a46dc7843048446029f4294828d6f9de697f1b43f3901751044b5e25d184a2914a11ba5bc0466

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    responder_bot (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  responder_bot!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jacob Evan Shreve
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# ResponderBot
+
+A simple framework for defining a text-based interface
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'responder_bot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install responder_bot
+
+## Usage
+
+Check out the examples directory for detailed usage examples. This gem is a bit
+complicated to put the usage inline here.
+
+Here's a simple example to illustrate the idea at it's core.
+
+```ruby
+class SimpleResponder < ResponderBot::Handler
+  handle_response do |reply|
+    reply.quit { "Ok, thanks for playing!" }
+    reply.likert { "I'm glad you feel that way." }
+    reply.yes { "Awesome, thanks." }
+  end
+end
+
+SimpleResponder.new("1").handle_response!
+# => "I'm glad you feel that way."
+
+SimpleResponder.new("Yes!").handle_response!
+# => "Awesome, thanks."
+```
+
+This example is super trivial, but don't worry, it gets better.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/shreve/responder_bot.
+
+I am particularly looking for feedback on
+
+1. Default matchers (`ResponderBot.default_matchers`)
+2. New types of matchers
+
+## License
+
+The gem is available as open source under the terms of
+the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "responder_bot"
+
+# 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/examples/routed_system.rb

@@ -0,0 +1,122 @@
+require 'responder_bot'
+
+#
+# This top-level controller handles all incoming responses
+#
+class ResponseController < ResponderBot::Handler
+  matchers help: Regexp.new('^he?l?p?', 'i'),
+           balance: Regexp.new('^bala?n?c?e?', 'i')
+
+  # Any missing methods here are delegated to `respondable`, which is the only
+  # parameter used to instantiate this class.
+  handle_response do |reply|
+    # Prefer to interact with your respondable before anything else
+    if response_handler.understands_reply?
+      reply.any { response_handler.handle_response! }
+    end
+
+    if user.nil?
+      reply.any do
+        "We don't know who you are. You'll need to create an account before " \
+        'you can use this SMS system.'
+      end
+    end
+
+    reply.help do
+      'This is the SMS help text. Reply BAL to see your balance.'
+    end
+
+    reply.balance do
+      "You have #{user.points} points to spend."
+    end
+
+    # If you want help and balance to always be preferred over your respondable,
+    # just move this matcher to the bottom.
+    if response_handler.understands_reply?
+      reply.any { response_handler.handle_response! }
+    end
+
+    reply.any do
+      "We didn't understand what you said. Reply HELP for more info."
+    end
+  end
+end
+
+#
+# This is your application object you want users to interact with, like a
+# question, support ticket, or order.
+#
+class Respondable
+  belongs_to :user
+
+  def body
+    'SMS Response'
+  end
+
+  def response_handler
+    RespondableResponseHandler.new(self)
+  end
+
+  def status
+    :provided_address
+  end
+
+  def stop_order!
+  end
+
+  def delivery_method=(val)
+    super(val)
+  end
+end
+
+#
+# This is your object-specific handler. It can use the data available in
+# respondable to power it. For example, Respondable can be used as a state
+# machine to power a multi-step wizard.
+# The design inspiration for this gem was an SMS-only reward checkout wizard.
+#
+class RespondableResponseHandler < RespondableBot::Handler
+  matcher exit: Regexp.new('^ex?i?t?', 'i'),
+          x_it: /^[Xx]/
+  handle_response do |reply|
+    reply.any_of(:quit, :exit, :x_it) do
+      stop_order!
+      'Your order has been stopped. You can try again later.'
+    end
+
+    case status
+    when :asked_for_delivery_method
+      read_delivery_method_prompt
+    end
+  end
+
+  # You can use methods to defer large chunks of behavior you don't want inline
+  # inside handle_response
+  def read_delivery_method_prompt(reply)
+    reply
+      .is('A') { respondable.delivery_method = :SMS }
+      .is('B') { respondable.delivery_method = :email }
+      .is('C') { respondable.delivery_method = :mail }
+      .is('D') { respondable.delivery_method = :local_pickup }
+  end
+end
+
+#
+# Now that the classes are defined, let's look at how to use them.
+#
+
+# 1. Find an object to respond to. This usually works well by searching using
+#    the phone number of the incoming SMS
+respondable = Respondable.find_by(phone_number: params[:phone_number])
+
+# 2. Pass the respondable to the main controller
+controller = ResponseController.new(respondable)
+
+# 3. Use the controller to do the cool things your app does and generate a reply
+reply = controller.handle_response!
+
+# 4. Send the reply back to your user, perhaps using TwiML if you use Twilio
+#    (Shout out to Twilio. I love you. Please send me Twilio swag and credits)
+render xml: Twilio::TwiML::Response.new do |t|
+              t.Sms reply
+            end.text

data/lib/responder_bot.rb

@@ -0,0 +1,22 @@
+require 'responder_bot/version'
+
+module ResponderBot
+  def self.default_matchers
+    {
+      quit: Regexp.new('^qu?i?t?', 'i'),
+      exit: Regexp.new('^ex?i?t?', 'i'),
+      yes: Regexp.new('^y', 'i'),
+      no: Regexp.new('^n', 'i'),
+      number: /^[0-9]+/,
+
+      # The likert scale is a psychometric scale often used in surveys /
+      # questionnaires and has a lot of research backing it's effectiveness.
+      # https://en.wikipedia.org/wiki/Likert_scale
+      likert: ->(text) { (1..5).cover?(text.strip[0].to_i) }
+    }
+  end
+end
+
+require 'responder_bot/errors'
+require 'responder_bot/matcher_list'
+require 'responder_bot/handler'

data/lib/responder_bot/errors.rb

@@ -0,0 +1,4 @@
+module ResponderBot
+  class UnmatchedResponse < StandardError
+  end
+end

data/lib/responder_bot/handler.rb

@@ -0,0 +1,65 @@
+module ResponderBot
+  class Handler
+    def self.inherited(child)
+      child.class_eval do
+        class << self
+          attr_accessor :matcher_list, :response_handler
+        end
+        self.matcher_list = MatcherList.new
+      end
+    end
+
+    attr_accessor :respondable, :body
+
+    def initialize(respondable)
+      self.respondable = respondable
+      self.body = if respondable.is_a?(String)
+                    respondable
+                  else
+                    respondable.body
+                  end
+      instance_eval(&self.class.response_handler)
+    end
+
+    def understands_reply?
+      matcher_list.matches?(body)
+    end
+
+    def handle_response!
+      if understands_reply?
+        matcher_list.action_for(body).call
+      else
+        raise ResponderBot::UnmatchedResponse,
+              "No matcher caught input '#{body}'."
+      end
+    end
+
+    def matcher_list
+      self.class.matcher_list
+    end
+
+    def self.handle_response(&block)
+      self.response_handler = block
+    end
+
+    def self.matcher(new_matchers)
+      new_matchers.each_pair do |name, match|
+        matcher_list.define_matcher(name, match)
+      end
+    end
+
+    def method_missing(method_name, *args, &block)
+      if self.class.matcher_list.respond_to?(method_name)
+        self.class.matcher_list.send(method_name, *args, &block)
+      elsif respondable.respond_to?(method_name)
+        respondable.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name)
+      self.class.matcher_list.respond_to?(method_name)
+    end
+  end
+end

data/lib/responder_bot/matcher_list.rb

@@ -0,0 +1,97 @@
+module ResponderBot
+  #
+  # Matcher List
+  #
+  # Contains the list of available named matchers for a given handler as well
+  # as the map from matchers to actions.
+  #
+  # Note: Not all matchers need a name. match, is, exactly, and any all create
+  # anonymous matchers.
+  #
+  class MatcherList
+    attr_accessor :actions, :matchers
+
+    def initialize(use_defaults = true)
+      self.actions = {}
+      self.matchers = if use_defaults
+                        ResponderBot.default_matchers
+                      else
+                        false
+                      end
+    end
+
+    def matches?(text)
+      !action_for(text).nil?
+    end
+
+    # Use any of the named matchers to call this action
+    def any_of(*matcher_names, &action)
+      matcher_names.each do |name|
+        append_action(matchers[name], action)
+      end
+      self
+    end
+
+    # Provide a regex to use one time
+    def match(regex, &action)
+      append_action(regex, action)
+      self
+    end
+
+    # Case-insensitive comparison
+    def is(string, &action)
+      append_action(Regexp.new(string, 'i'), action)
+      self
+    end
+
+    # Case-sensitive comparison
+    def exactly(string, &action)
+      append_action(string, action)
+      self
+    end
+
+    # Always matches
+    def any(&action)
+      append_action(true, action)
+    end
+
+    def define_matcher(matcher_name, matcher)
+      matchers[matcher_name] = matcher
+    end
+
+    def method_missing(method_name, *args, &block)
+      if matchers.key?(method_name)
+        append_action(matchers[method_name], block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, *)
+      matchers.key?(method_name)
+    end
+
+    private
+
+    def append_action(matcher, action)
+      actions[matcher] = action
+    end
+
+    def action_for(text)
+      actions.each_pair do |matcher, action|
+        return action if matcher_matches?(matcher, text)
+      end
+      nil
+    end
+
+    def matcher_matches?(matcher, text)
+      case matcher
+      when TrueClass then true
+      when Regexp then matcher.match?(text)
+      when Proc
+        matcher.arity.zero? ? matcher.call : matcher.call(text)
+      when String then matcher == text
+      end
+    end
+  end
+end

data/lib/responder_bot/version.rb

@@ -0,0 +1,3 @@
+module ResponderBot
+  VERSION = '0.0.1'.freeze
+end

data/responder_bot.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'responder_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'responder_bot'
+  spec.version       = ResponderBot::VERSION
+  spec.authors       = ['Jacob Evan Shreve']
+  spec.email         = ['github@shreve.io']
+
+  spec.summary       = 'A simple framework for defining a text-based interface'
+  spec.description   = 'Use matchers to define a series of commands available' \
+                       ' to an SMS or other chat interface so your users can ' \
+                       'interact with just text.'
+  spec.homepage      = 'https://github.com/shreve/responder_bot'
+  spec.license       = 'MIT'
+
+  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.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: responder_bot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jacob Evan Shreve
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Use matchers to define a series of commands available to an SMS or other
+  chat interface so your users can interact with just text.
+email:
+- github@shreve.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/routed_system.rb
+- lib/responder_bot.rb
+- lib/responder_bot/errors.rb
+- lib/responder_bot/handler.rb
+- lib/responder_bot/matcher_list.rb
+- lib/responder_bot/version.rb
+- responder_bot.gemspec
+homepage: https://github.com/shreve/responder_bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simple framework for defining a text-based interface
+test_files: []