wilco 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4abe85f8ee956fb31c5921eb690491c6c334d8db
+  data.tar.gz: 6ece65e0205e83fe3d2182576230ac35324a6f63
+SHA512:
+  metadata.gz: 182f7f6608020497e9bb13c06c21afcbaa39047924db36df33ab8b8e7be902364fdced52eadb1e9af1e82650188cef6e5622a42d65a5aa86954da27daa2ae709
+  data.tar.gz: 8b0cd3723a398f49dbe718327c9e67e6ba8dd68e41903b72a2fe603449e2d6770db6cec53bed00d0ae3dc0be72d126fdcd40c00ac905d84aeae342d5f75ce91c

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+AllCops:
+  TargetRubyVersion: 2.3
+
+  # Don't check binstubs or gemfile
+  Exclude:
+    - 'bin/**/*'
+    - 'Gemfile'
+
+# Don't restrict length of modules/files
+Metrics/ModuleLength:
+  Enabled: false
+
+# Allow braces for blocks that mainly return a value, including RSpec lets and
+# subjects
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+
+# Don't require a class comment
+Style/Documentation:
+  Enabled: false
+
+# Always use double-quoted string literals
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Require trailing commas for multiline arrays/hashes
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+ruby '2.3.1'
+
+gemspec
+
+gem 'rspec'
+gem 'pry'
+gem 'highline'
+
+gem 'rack'
+gem 'puma'
+gem 'facebook-messenger'
+gem 'redis'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Josh Justice
+
+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/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -t 5:5 -p ${PORT:-3000} -e ${RACK_ENV:-development}

data/README.md

@@ -0,0 +1,38 @@
+# Wilco
+
+A Ruby conversation engine for powering natural-language conversations, for example in chatbots.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wilco'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wilco
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bundle install` 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/[USERNAME]/wilco.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+task default: :spec

data/bin/chat

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'sample'
+require 'highline'
+
+bot = Sample::Chatbot.new
+cli = HighLine.new
+
+class FakeStore
+  def initialize
+    @hash = {}
+  end
+
+  def set(key, value)
+    @hash[key] = value
+  end
+
+  def get(key)
+    @hash[key]
+  end
+end
+store = FakeStore.new
+
+message = cli.ask(bot.greet)
+until message == ""
+  response = nil
+  # store and load data to simulate server
+  Sample::Chatbot.persisted(store, "sender_id") do |bot2|
+    response = bot2.respond_to_message(message)
+  end
+
+  message = cli.ask(response)
+end
+puts bot.goodbye

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wilco"
+
+# 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

data/bot.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require "facebook/messenger"
+require "redis"
+require_relative "lib/sample"
+
+include Facebook::Messenger
+
+Facebook::Messenger.configure do |config|
+  config.access_token = ENV["FACEBOOK_ACCESS_TOKEN"]
+  config.app_secret   = ENV["FACEBOOK_APP_SECRET"]
+  config.verify_token = ENV["FACEBOOK_VERIFY_TOKEN"]
+end
+
+Facebook::Messenger::Thread.set(
+  setting_type: "greeting",
+  greeting: { text: Sample::Chatbot.new.greet }
+)
+
+Facebook::Messenger::Subscriptions.subscribe
+
+redis = Redis.new
+
+Bot.on :message do |message|
+  request = message.text
+
+  response = nil
+  Sample::Chatbot.persisted(redis, message.sender["id"]) do |chatbot|
+    response = chatbot.respond_to_message(request)
+  end
+
+  Bot.deliver(
+    recipient: message.sender,
+    message: { text: response }
+  )
+end

data/config.ru

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require "facebook/messenger"
+require_relative "bot"
+
+run Facebook::Messenger::Server

data/lib/wilco.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require "wilco/version"
+require "wilco/chatbot"
+require "wilco/command"
+require "wilco/parser"

data/lib/wilco/chatbot.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require "pry"
+require "yaml"
+
+module Wilco
+  class Chatbot
+    def self.persisted(store, id)
+      bot = new.load_from(store, id)
+      yield(bot)
+      bot.save_to(store, id)
+    end
+
+    def initialize(options = {})
+      @commands = options.fetch(:commands)
+      @messages = options.fetch(:messages)
+      @parser = options.fetch(:parser, Parser.new)
+    end
+
+    def greet
+      "#{t(:greeting)} #{t(:command_prompt)} #{t(:suggestions)}"
+    end
+
+    def goodbye
+      t(:valediction)
+    end
+
+    def respond_to_message(message)
+      if current_command
+        identify_param(message)
+      else
+        identify_command(message)
+      end
+    end
+
+    def save_to(store, id)
+      serialized_command = YAML.dump(current_command)
+      store.set(serialization_key(id), serialized_command)
+    end
+
+    def load_from(store, id)
+      serialized_command = store.get(serialization_key(id))
+      @current_command = YAML.load(serialized_command) if serialized_command
+      self
+    end
+
+    private
+
+    attr_reader :commands, :messages, :current_command, :parser
+
+    def t(key)
+      messages[key]
+    end
+
+    def serialization_key(id)
+      "intent_chatbot_#{id}"
+    end
+
+    def identify_command(message)
+      if (@current_command = command_for(message))
+        respond_to_current_command_state
+      else
+        did_not_understand_command
+      end
+    end
+
+    def did_not_understand_command
+      "#{t(:did_not_understand)} #{t(:command_prompt)} #{t(:suggestions)}"
+    end
+
+    def did_not_understand_param
+      "#{t(:did_not_understand)} " \
+      "#{current_command.request_first_missing_param}"
+    end
+
+    def identify_param(message)
+      if current_command.extract_param(message)
+        respond_to_current_command_state
+      elsif (param_name = current_command.find_param_to_switch_to(message))
+        current_command.request_param(param_name)
+      else
+        did_not_understand_param
+      end
+    end
+
+    def respond_to_current_command_state
+      if current_command.missing_params?
+        current_command.request_first_missing_param
+      else
+        response = current_command.execute
+        @current_command = nil
+        "#{response} #{t(:next_command_prompt)}"
+      end
+    end
+
+    def command_for(message)
+      command = command_instances.max_by { |c| c.likelihood(message) }
+      command.parse_message(message) if command.likelihood(message).positive?
+    end
+
+    def command_instances
+      @command_instances ||= commands.map { |command_class|
+        command_class.new(parser)
+      }
+    end
+  end
+end

data/lib/wilco/command.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+module Wilco
+  class Command
+    def initialize(parser)
+      @parser = parser
+    end
+
+    def likelihood(message)
+      @likelihood = parser.command_likelihood(tokens, message)
+    end
+
+    def parse_message(message)
+      @param_values = parser.extract_params(tokens, message)
+      self
+    end
+
+    def missing_params?
+      !first_missing_param.nil?
+    end
+
+    def request_param(new_param)
+      @current_param = new_param
+      switch_param_message
+    end
+
+    def request_first_missing_param
+      @current_param = first_missing_param
+      missing_param_message
+    end
+
+    def extract_param(message)
+      param = params[current_param] # TODO: rename to param name
+      new_param_values = parser.extract_params([param], message)
+      param_values.merge!(new_param_values) if new_param_values[param[:name]]
+    end
+
+    def find_param_to_switch_to(message)
+      parser.find_param_name(tokens, message)
+    end
+
+    def execute
+      confirmation_message
+    end
+
+    private
+
+    attr_reader :parser, :param_values, :current_param
+
+    def first_missing_param
+      param_values.keys.find { |key| param_values[key].nil? }
+    end
+  end
+end

data/lib/wilco/parser.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+require "pry"
+
+module Wilco
+  class Parser
+    def command_likelihood(tokens, message)
+      words = tokenize_message(message)
+      static_tokens(tokens).count do |token|
+        match_static_token_in_message(token, words)
+      end
+    end
+
+    def extract_params(tokens, message)
+      params = {}
+      words = tokenize_message(message)
+      param_tokens(tokens).each do |token|
+        params[token[:name]] = extract_param_from_message(token, words)
+      end
+      params
+    end
+
+    def find_param_name(tokens, message)
+      words = tokenize_message(message)
+      token = param_tokens(tokens).find { |t|
+        extract_param_name_from_message(t, words)
+      }
+      token[:name] if token
+    end
+
+    private
+
+    attr_accessor :params
+
+    def static_tokens(tokens)
+      tokens.select { |t| t.is_a?(Array) }
+    end
+
+    def param_tokens(tokens)
+      tokens.select { |t| t.is_a?(Hash) }
+    end
+
+    def tokenize_message(message)
+      simplify_string(message.strip).split(/\s+/)
+    end
+
+    def simplify_string(string)
+      string.downcase.gsub(/[^\w\s]+/, "")
+    end
+
+    def match_static_token_in_message(token, words)
+      token.each do |token_option|
+        return words if words.include?(token_option)
+      end
+      false
+    end
+
+    def extract_param_from_message(token, words)
+      value = token[:values].find { |synonyms|
+        words_include_a_synonym?(words, synonyms)
+      }
+      value[0] if value
+    end
+
+    def extract_param_name_from_message(token, words)
+      words.include?(token[:name].to_s) # TODO: store as a string originally
+    end
+
+    def words_include_a_synonym?(words, synonyms)
+      synonyms.any? { |synonym| words.include?(simplify_string(synonym)) }
+    end
+
+    def set_param(token, value)
+      params[token[:name]] = value
+    end
+  end
+end

data/lib/wilco/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Wilco
+  VERSION = "0.1.0"
+end

data/wilco.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "wilco/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "wilco"
+  spec.version       = Wilco::VERSION
+  spec.authors       = ["Josh Justice"]
+  spec.email         = ["me@codingitwrong.com"]
+
+  spec.summary       = "A Ruby conversation engine"
+  spec.homepage      = "https://github.com/CodingItWrong/wilco"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(sample|spec)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: wilco
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Justice
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 
+email:
+- me@codingitwrong.com
+executables:
+- chat
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- Procfile
+- README.md
+- Rakefile
+- bin/chat
+- bin/console
+- bot.rb
+- config.ru
+- lib/.gitkeep
+- lib/wilco.rb
+- lib/wilco/chatbot.rb
+- lib/wilco/command.rb
+- lib/wilco/parser.rb
+- lib/wilco/version.rb
+- wilco.gemspec
+homepage: https://github.com/CodingItWrong/wilco
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby conversation engine
+test_files: []