akiva 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33bde0e703766c87d931ad9517446531f04c4727
-  data.tar.gz: c1aae2abd0f533fe81ab71329bf31239e24df321
+  metadata.gz: 3b141693c56778ea3c49884ce12a4c4d9eb9d029
+  data.tar.gz: ca1146e56d4efee470fe4f9b8d35302e51860fa1
 SHA512:
-  metadata.gz: c678181b3adf3a343e8e87f5527538b3f6f220225efb952b5f068affa912426a62cd26930a938401e8df2bc8edbecf53ab2479a8b93b41bd3d883fa3f71ca6fc
-  data.tar.gz: 00bbd6ea2c6605c7328294df3a9b090f0bda590d8fc6473ba0ee5db3f8787543dc744f9a27435701cc4802dbe969d2f9ba494778c154880188e1305150daf5b8
+  metadata.gz: ea210219041b617487364ceb0c6dc2578f1e2d1a13720f548158d9469cb5eab8a622c703034f7e02beecdf3257482c7a3a6b40919fc1ccd9fb7589d30d64a90e
+  data.tar.gz: 44c5775d503401d30be0bea714943da61ed0609a2bde759e767e80b80c073cee6119aa60712e35fa3beb914c2ce83effaca70a7241455bd4cd1adc5db70efabd

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle
+
+*;*
+.backups
+.DS_Store
+log/*
+._*
+.__*
+*~
+*.swp
+.rvmrc
+.versions.conf
+.ruby-version
+*.gem
+tmp/*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    akiva (0.1.1)
+      awesome_print (~> 1.2)
+      rack (~> 1.4)
+      ruby-units (~> 1.4)
+      thebigdb (~> 1.3)
+      thor (~> 0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    awesome_print (1.2.0)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (2.6.0)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    listen (2.4.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.1)
+    rb-fchange (0.0.6)
+      ffi
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    ruby-units (1.4.4)
+    safe_yaml (0.9.7)
+    slop (3.4.7)
+    thebigdb (1.4.1)
+      rack (~> 1.4)
+    thor (0.18.1)
+    timers (1.1.0)
+    webmock (1.16.1)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  akiva!
+  guard-rspec (~> 2.3)
+  rake (~> 10.0)
+  rb-fchange (~> 0)
+  rb-fsevent (~> 0)
+  rb-inotify (~> 0)
+  rspec (~> 2.12)
+  webmock (~> 1.9)

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec do
+  watch("spec/spec_helper.rb") { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
+  watch("lib/akiva/question.rb") { "spec" }
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/akiva\.rb$}) { "spec" }
+  watch(%r{^lib/akiva/(.+)\.rb$}) do |m|
+    "spec/lib/akiva/#{m[1]}_spec.rb"
+  end
+end

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2014, Christophe Maximin <christophe@thebigdb.com>
+
+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,131 @@
+Akiva
+=====
+
+Akiva is a simple natural-language-processing, question-answering, artificial intelligence.
+  
+Its main role is to take a question, deconstruct it in order to query the 
+collaborative database of facts [TheBigDB](http://thebigdb.com), and format the answer into something readable for a human.
+
+Akiva is obviously at a very early stage, and your contributions are more than welcome! See the "Contributing" section below for more info.
+
+## Why?
+
+> ** What's the point? Isn't Google's Knowledge graph enough? What about Wolfram|Alpha? **  
+> -- you, right now
+
+STORY TIME!  
+Back in 2005, while bored to death in a college class and daydreaming about how knowledge is structured, I asked myself why there wasn't anywhere I could ask questions in natural language. Because it would be pretty cool if there was.  
+I went back home, prototyped a little program doing just that. It sucked but it kinda worked, so I thought *"well, it isn't that hard, I guess geniuses everywhere are working on that, no need for me to spend more time on it. It surely will be available to everyone soon enough!"*. **Three years** passed: nothing.  
+The year 2009 saw the release of Wolfram|Alpha, which pretty much blew my mind: it was almost perfect. I guessed I just needed to wait a few more years and I can have all my trivial questions answered.  
+Fast forward **five more years**, and I'm sad to see this (as of January 6th, 2014):  
+
+[Google](http://imgur.com/RWjgcoM), [Wolfram|Apha](http://imgur.com/4QOHcN1), [Yahoo!](http://imgur.com/KXYnoqA) and [Bing](http://imgur.com/oOTloSQ) fail to answer the simple question « Is the iPhone 5s heavier than the Galaxy S4? » (click their names to see the results given);  
+Akiva answers "**No (iPhone 5s => 112 grams; Galaxy S4 => 130 grams)**". With only a few lines of code.
+
+With the same few lines, Akiva can accurately smartly all the following questions:  
+
+* « What are the weight, width and height of an iPhone 5s and a Galaxy S4 ? »   
+* « What is the height requirement for Space Mountain ? »  
+
+… and much more.
+ 
+  
+**TL;DR: I truly love Google's Knowledge graph; I'm an eternal fan of Wolfram|Alpha, but I'm tired of waiting for search engines to implement a fully working simple question-answering engine.  
+Still, Akiva is not trying to be a real "*computational* knowledge engine" so it is NOT competing at all with Wolfram|Alpha.**  
+  
+## « It's nothing new!!! »
+
+Maybe. What I, and you probably will, like about Akiva, is the fact that is always improving from two different angles:
+  
+* Akiva is open-source and a free software, so it can answer more and more types of questions with time
+* Akiva's data source is the collaborative [TheBigDB](http://thebigdb.com), which makes it more knowledgable everyday
+
+## Usage
+
+    gem install akiva
+
+You can then ask a question like this: 
+
+    $ akiva ask "What's the weight of an iPhone 5s ?"
+
+    # Will output something like:
+    #   112 grams
+
+Or you can ask a more complex question, like this one:
+
+    $ akiva ask "What are the weight, width and height of an iPhone 5s, a Nexus 5 and a Galaxy S4 ?"
+
+    # Will output something like:
+    #   iPhone 5s => Weight: 112 grams, Width: 58.6 mm, Height: 123.8 mm
+    #   Nexus 5 => Weight: 130 grams, Width: 69.17 mm, Height: 137.84 mm
+    #   Galaxy S4 => Weight: 130 grams, Width: 58.6 mm, Height: 136.6 mm
+
+In order to integrate it within an existing app, you can do something like this:
+    
+    require "akiva"
+    puts Akiva::Question.new("What are the weight, width and height of an iPhone 5s, a Nexus 5 and a Galaxy S4 ?").formatted_response
+
+Tip: If you're thinking about caching the requests made to TheBigDB, you should probably check out [the section "Caching" on its github page](https://github.com/thebigdb/thebigdb-ruby#caching).
+
+## Expanding
+
+Akiva is quite easily expandable. Take for example this completely useless example, where Akiva would tell you what's the first word out of a list you provided. 
+
+    require "akiva"
+    
+    Akiva::Brain.update do
+      add_filter :get_first_word, /\AWhat's the first word of (?<words>.+?)\??\Z/i, formatter: :display_expected_word
+      
+      add_action :get_first_word do |response|
+        response[:first_word] = response[:filter_captures]["words"].split(/ /).first
+      end
+
+      add_formatter :display_expected_word do |response|
+        response[:formatted] = "The word you're looking for is: « #{response[:first_word]} »"
+      end
+    end
+
+    # execution looks like:
+    # Akiva::Question.new("What's the first word of love is stronger than hate?").formatted_response
+    # => "The word you're looking for is: « love »"
+
+For more info, you'll probably want to take a look at the templates for filters in [lib/akiva/core_brain/filters/template.rb](https://github.com/thebigdb/akiva/blob/master/lib/akiva/core_brain/filters/template.rb), actions in [lib/akiva/core_brain/actions/template.rb](https://github.com/thebigdb/akiva/blob/master/lib/akiva/core_brain/actions/template.rb) and formatters in [lib/akiva/core_brain/formatters/template.rb](https://github.com/thebigdb/akiva/blob/master/lib/akiva/core_brain/formatters/template.rb).  
+Also, don't hesitate to look around, see how existing filters/actions/formatters are built.
+
+
+## Contributing
+
+You can run the tests with:
+  
+    $ bundle install
+    $ bundle exec rspec spec/
+
+As you can see, there are lots of types of questions Akiva can't answer yet (see [spec/lib/akiva/core_brain/question_spec.rb](https://github.com/thebigdb/akiva/blob/master/spec/lib/akiva/core_brain/question_spec.rb)). Just take one of them and make it work!
+
+There are no crazy rules to contribute, just write good code, good tests, and send a pull request. It will really appreciated!
+
+## List of question types currently understood
+
+This is a non-exhaustive list of question types Akiva can answer. Just remember that the fact that Akiva actually has the data to answer the question is entirely dependent on what is available in TheBigDB.
+The words in parenthesis are variable.
+
+    What's (the weight) of (an iPhone 5s) ?
+      >>> 112 grams
+      
+    What are (the weight and height) of (an iPhone 5s) ?
+      >>> Weight: 112 grams, Height: 123.8 mm
+      
+    What are (the weight) of (an iPhone 5s and a Galaxy S4) ?
+      >>> iPhone 5s => 112 grams; Galaxy S4 => 130 grams
+      
+    What are (the weight and height) of (an iPhone 5s and a Galaxy S4) ?
+      >>> iPhone 5s => Weight: 112 grams, Height: 123.8 mm
+          Galaxy S4 => Weight: 130 grams, Height: 136.6 mm
+      
+    Is (the iPhone 5s) (heavier) than (the Galaxy S4) ?
+      >>> No (iPhone 5s => 112 grams; Galaxy S4 => 130 grams)
+
+
+## License
+
+This software is distributed under the MIT License. Copyright (c) 2014, Christophe Maximin <christophe@thebigdb.com>

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run tests"
+task :default => [:spec]

data/akiva.gemspec

@@ -0,0 +1,38 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "akiva/version"
+
+Gem::Specification.new do |s|
+  s.name = "akiva"
+  s.version = Akiva::VERSION::STRING
+  s.summary = "Simple natural language processing, question-answering artificial intelligence, based on TheBigDB"
+  s.description = "Akiva is a simple natural language processing, question-answering artificial intelligence. It is a demonstration of how to use the API of TheBigDB (http://thebigbdb.com) to create knowledgable software."
+  s.authors = ["Christophe Maximin"]
+  s.email = "christophe@thebigdb.com"
+  s.homepage = "https://github.com/thebigdb/akiva"
+  s.licenses = ['MIT']
+
+  s.platform = Gem::Platform::RUBY
+
+  s.add_runtime_dependency "rack", "~> 1.4"
+  s.add_runtime_dependency "ruby-units", "~> 1.4"
+  s.add_runtime_dependency "thebigdb", "~> 1.3"
+  s.add_runtime_dependency "thor", "~> 0.18"
+  # s.add_runtime_dependency "numbers_in_words", "~> 0.0", ">= 0.0.1"
+  s.add_runtime_dependency "awesome_print", "~> 1.2"
+
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 2.12"
+  s.add_development_dependency "guard-rspec", "~> 2.3"
+  s.add_development_dependency "rb-inotify", "~> 0"
+  s.add_development_dependency "rb-fsevent", "~> 0"
+  s.add_development_dependency "rb-fchange", "~> 0"
+  s.add_development_dependency "webmock", "~> 1.9"
+
+
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  
+  s.require_paths = ["lib"]
+end

data/lib/akiva.rb

@@ -0,0 +1,11 @@
+require "thebigdb"
+# require "numbers_in_words/duck_punch"
+require "ruby-units"
+
+%w(
+  brain
+  core_brain/loader
+  question
+).each do |file_name|
+  require File.join(File.dirname(__FILE__), "akiva", file_name)
+end

data/lib/akiva/brain.rb

@@ -0,0 +1,47 @@
+module Akiva
+  module Brain
+    @@filters = []
+    @@actions = {}
+    @@formatters = {}
+
+    class << self
+      def update(&block)
+        instance_exec(&block)
+      end
+
+      def empty
+        @@filters = []
+        @@actions = {}
+        @@formatters = {}
+      end
+
+      def add_filter(action_name, regex, options = {})
+        @@filters.unshift({
+          regex: regex,
+          action: action_name
+        }.merge(options))
+      end
+
+      def add_action(action_name, class_instance = nil, &block)
+        @@actions[action_name] = class_instance || block
+      end
+
+      def add_formatter(formatter_name, class_instance = nil, &block)
+        @@formatters[formatter_name] = class_instance || block
+      end
+
+      # readers
+      def filters
+        @@filters
+      end
+
+      def actions
+        @@actions
+      end
+
+      def formatters
+        @@formatters
+      end
+    end
+  end
+end

data/lib/akiva/cli.rb

@@ -0,0 +1,58 @@
+require "thor"
+
+module Akiva
+  class CLI < Thor
+
+    desc "ask QUESTION", "Process a question, and display the answer"
+    # method_option "verbose", type: :boolean, aliases: "-v", desc: "Displays the elements found in the question"
+    # option :verbose, type: :boolean, aliases: "-v"
+    option "verbose", type: :boolean, aliases: "-v", desc: "Displays the requests made to TheBigDB"
+    option "headers", type: :boolean, desc: "Displays headers of the requests made to TheBigDB (depends on --verbose/-v)", default: false
+    option "caller", type: :boolean, desc: "Displays stack trace from which each request made to TheBigDB is made (depends on --verbose/-v)", default: false
+    option "api-host", type: :string, desc: "Host to send requests for TheBigDB", default: "api.thebigdb.com"
+
+    def ask(question)
+      TheBigDB.raise_on_api_status_error = true
+
+      TheBigDB.api_host = options["api-host"]
+
+      if options["verbose"]
+        require "awesome_print"
+        TheBigDB.before_request_execution = lambda do |request|
+          puts "REQUEST DATA SENT:"
+          data_sent = request.data_sent
+          data_sent.delete("headers") unless options["headers"]
+          ap data_sent
+          if options["caller"]
+            puts "CALLED FROM:"
+            puts caller.join("\n")
+          end
+          puts
+        end
+
+        TheBigDB.after_request_execution = lambda do |request|
+          puts "REQUEST DATA RECEIVED:"
+          data_received = request.data_received
+          data_received.delete("headers") unless options["headers"]
+          ap data_received
+          puts
+        end
+      end
+
+      akiva_question = Akiva::Question.new(question)
+      begin
+        if response = akiva_question.formatted_response
+          puts response.gsub("; ", "\n")
+        else
+          puts "Sorry, Akiva can't answer that question for now."
+        end
+      rescue TheBigDB::Request::ApiStatusError
+        puts "Sorry, it looks like TheBigDB is currently unavailable."
+      end
+
+    end
+
+  end
+end
+
+Akiva::CLI.start

data/lib/akiva/core_brain/actions/get_answers_from_subjects_and_properties.rb

@@ -0,0 +1,73 @@
+Akiva::Brain.update do
+
+  add_action :get_answers_from_subjects_and_properties do |response|
+
+    # It's possible we're arriving here with already defined subjects and properties, in that case, skip the default request
+    unless response[:defined_subjects] and response[:defined_properties]
+      regex_matched_subjects = response[:filter_captures]["subjects"]
+      regex_matched_properties = response[:filter_captures]["properties"]
+
+      # First, we try the obvious subject x property, works if there's only one subject and one property
+      search = TheBigDB.search(subject: regex_matched_subjects, property: regex_matched_properties).with(per_page: 1)
+
+      if search["total_results"] == 1
+        statement = search["statements"].first
+        response[:subjects] = [statement["nodes"]["subject"]]
+        response[:properties] = {statement["nodes"]["subject"] => [statement["nodes"]["property"]]}
+        response[:answers] = {statement["nodes"]["subject"] => {statement["nodes"]["property"] => statement["nodes"]["answer"]}}
+
+        next # we're happy with what we have, no need to continue the action.
+      end
+
+      # If we don't have an obvious answer, it may be because we're searching for multiple subjects and/or properties
+      degrouped_subjects = Akiva::Brain::Helpers.degroup_multiple_values(regex_matched_subjects)
+      degrouped_properties = Akiva::Brain::Helpers.degroup_multiple_values(regex_matched_properties)
+
+      if degrouped_subjects.size == 1 and degrouped_properties.size == 1
+        next # sadly we don't have anything to further analyze/search for, so we're exiting the action empty-handed.
+      end
+
+      # Let's make products of elements to be sure we're not missing anything
+      products_mega_groups = []
+      products_mega_groups << [regex_matched_subjects].product(degrouped_properties)
+      products_mega_groups << degrouped_subjects.product([regex_matched_properties])
+      products_mega_groups << degrouped_subjects.product(degrouped_properties)
+      products_mega_groups.uniq!
+    else
+      products_mega_groups = [response[:defined_subjects].product(response[:defined_properties])]
+    end
+
+    products_mega_groups.each do |product_mega_group|
+      statements_compiled = {}
+      statements_found = 0
+
+      product_mega_group.each do |group|
+        search = TheBigDB.search(subject: group[0], property: group[1]).with(per_page: 1)
+        if search["total_results"] == 1
+          statements_found += 1
+          statement = search["statements"].first
+          statements_compiled[group[0]] ||= {}
+          statements_compiled[group[0]][group[1]] = statement["nodes"]["answer"]
+        else
+          break # if one is missing, we exit this each block since we're looking for a perfect product results
+        end
+      end
+
+      if statements_found == product_mega_group.size
+        response[:subjects] = statements_compiled.keys
+        response[:properties] = {}
+        statements_compiled.each_pair do |k, v|
+          response[:properties][k] = v.keys
+        end
+        response[:answers] = statements_compiled
+
+        break # we're happy with what we have, no need to continue mega_groups each-block.
+      end
+    end
+
+
+
+
+  end
+
+end