answerific 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6b5905e26045c85b62eadee1a917f7a6f33edb5
+  data.tar.gz: b1721baa87c03b00cf36e614dc50561dc8473a35
+SHA512:
+  metadata.gz: b30eed839c2149e237033351b458427bb56274d970db991977a689232a5cecd55e7ece89d78a8f1cd40c5ce72b8bb60622fb9f7cd159b87e45b8ac3f14359927
+  data.tar.gz: 8b347d026f099cbb41b02b626bd524724edc135b7c61f1fd038b7af1efd93a66c302d1d4107e62b79b2009b90dc86b6f3fa70be826185e9d863de8aeae2053e3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,13 @@
+clearing :on
+
+guard 'rspec', cmd: "bundle exec rspec --format=doc --format=Nc" do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/README.md

@@ -0,0 +1,56 @@
+# Answerific
+
+AI Bot that can answer questions posed in natural language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'answerific'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install answerific
+
+## Usage
+
+    bot = Answerific::Bot.new()
+    bot.answer('what is the composition of Pluto?')
+
+## How it works
+
+Given an input, answerific will
+
+1. Preprocess the input
+2. Detect the type of question
+3. Parse and rearrange the input given the type of question
+4. Extract information from the web for that parsed input
+5. Select and return the best answer
+
+## Roadmap
+
+* Add options at initialization
+* Sentence split on dot: handle abbreviations
+* Return special message when no result found? Or just nil?
+* Better support for wh-words (atm, the bot just gets rid of them)
+* Better support for yes-no questions: answer with definite yes-no instead of statement
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/answerific/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format=d', '--format=Nc']
+end
+
+task :default => :spec
+
+task :console do
+  exec "irb -r answerific -I ./lib"
+end

data/answerific.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'answerific/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "answerific"
+  spec.version       = Answerific::VERSION
+  spec.authors       = ["Justin Domingue"]
+  spec.email         = ["justin.domingue@hotmail.com"]
+
+  spec.summary       = 'Bot that answers natural language questions.'
+  spec.homepage      = 'https://github.com/justindomingue/answerific'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+  spec.add_runtime_dependency "google-search"
+end

data/bin/console

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

data/bin/setup

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

data/lib/answerific.rb

@@ -0,0 +1,166 @@
+require "answerific/version"
+require "google-search"
+
+module Answerific
+  class Bot
+
+    def answer(question)
+      mine(parse(preprocess(question)))
+    end
+
+    # === SELECT RESPONSE ===
+
+    def process_google_results(results, query)
+      candidates = select_responses(results, query)
+      select_best_response(candidates)
+    end
+
+    # Returns a single response from the list of responses
+    # TODO how to select the best? right now, return the first one
+    def select_best_response(responses)
+      responses.sample
+    end
+
+    # Returns the responses from `results` that have a the words in `query`
+    def select_responses(results, query)
+      sentences = results.map { |r| split_at_dot r }.flatten
+      query_words = query.split ' '
+
+      # Select the responses, only keeping the sentence that contain the search query
+      selected = sentences.select do |sentence|
+        query_words.all? { |w| sentence.include? w }  # contains all query words
+      end
+
+      return selected
+    end
+
+    # === EXTRACT INFO ===
+
+    def mine(query)
+      results = []
+
+      Google::Search::Web.new(query: query).each do |r|
+        results << clean_google_result(r.content)
+      end
+
+      process_google_results(results, query)
+    end
+
+    # === PARSE AND REARRANGE === (prepare for search engines)
+
+    def parse(question)
+      type = broad_question_type question
+      parsed = ''
+
+      case type
+      when 'wh'
+        parsed = parse_wh_question question
+      when 'yes-no'
+        parsed = parse_yes_no_question question
+      when 'declarative'
+        parsed = parse_declarative_question question
+      end
+
+      return parsed
+    end
+
+    # TODO consider verb permutations
+    # TODO consider wh-word: where is the sun => the sun is [located]
+    # Parses the wh-question `question` by removing the wh-word and moving the main verb at the end
+    # Assumptions:
+    #   * wh-word is at the beginning
+    #   * main verb follows the wh-word
+    #       (TODO not accurate for which/whose but should be ok for the others)
+    # Example:
+    #   question: 'where is the Kuiper belt'
+    #   returns : 'the Kuiper belt is'
+    def parse_wh_question(question)
+      words = question.split ' '
+      parsed = words[2..-1] << words[1]
+      parsed.join " "
+    end
+
+    # Returns an array of permutations of the main verb in the question without the wh-word
+    # Parses the wh-question `question` by removing the wh-word
+    # Assumptions:
+    #   * wh-word is at the beginning
+    #   * main verb follows the wh-word
+    #       (TODO not accurate for which/whose but should be ok for the others)
+    # Example:
+    #   question: 'where is the Kuiper belt'
+    #   returns : ['is the Kuiper belt',
+    #               'the is Kuiper belt',
+    #               'the Kuiper is belt',
+    #               'the Kuiper belt is']
+    # def parse_wh_question(question)
+
+    # end
+
+    # Returns `question` without the yes-no verb
+    # Example:
+    #   question: 'is pluto closer to the sun than saturn'
+    #   returns : 'pluto closer to the sun than saturn'
+    def parse_yes_no_question(question)
+      words = question.split ' '
+      return words[1..-1].join ' '
+    end
+
+    # Returns `question` without the declarative statement
+    # Example:
+    #   question: 'tell me what is Pluto'
+    #   returns : 'what is Pluto'
+    def parse_declarative_question(question)
+      declarative_expressions = [ 'tell me', 'I want to know' ]
+      return question.gsub(/^#{Regexp.union(*declarative_expressions)}/, '').strip
+    end
+
+    # === DETECT TYPE OF QUESTION ===
+
+    def broad_question_type(question)
+      return 'wh' if is_wh_question question
+      return 'yes-no' if is_yes_no_question question
+      return 'declarative'
+    end
+
+    # Returns true if question starts with a wh-question word
+    def is_wh_question(question)
+      wh_words = %w(who where when why what which how)
+      return /^#{Regexp.union(*wh_words)}/ === question
+    end
+
+    # Returns true if question starts with a yes-no question expression
+    def is_yes_no_question(question)
+      yes_no_words = %w(am are is was were have has do does did can could should may)
+      return /^#{Regexp.union(*yes_no_words)}/ === question
+    end
+
+    # === PREPROCESSING ===
+
+    # Returns cleaned `input`
+    def preprocess(input)
+      clean(input)
+    end
+
+    # Cleans the string `input` by removing non alpha-numeric characters
+    def clean(input)
+      ret = input.downcase
+      ret.gsub(/[^0-9a-z ]/i, '').strip
+    end
+
+    # === OTHER FORMATTING ===
+
+    def clean_google_result(string)
+      string
+      .downcase
+      .gsub(/[^\.]+\.{3,}/, '')                 # remove incomplete sentences
+      .gsub(/<("[^"]*"|'[^']*'|[^'">])*>/, '')  # html tags
+      .gsub(/\w{3} \d{1,2}, \d{4} \.{3} /, '')  # dates (27 Jan, 2015)
+      .gsub("\n",'')                            # new lines
+    end
+
+    def split_at_dot(string)
+      re = /([a-z]{2})[\.\?!] ?/i  # regex to match *aa. where a is any letter
+      string.split(re).each_slice(2).map(&:join)
+    end
+  end
+end

data/lib/answerific/version.rb

@@ -0,0 +1,3 @@
+module Answerific
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: answerific
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Justin Domingue
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- justin.domingue@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- answerific.gemspec
+- bin/console
+- bin/setup
+- lib/answerific.rb
+- lib/answerific/version.rb
+homepage: https://github.com/justindomingue/answerific
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Bot that answers natural language questions.
+test_files: []