lita-answers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 297fd6da8e062c56e013e86abcf600af325cd041
+  data.tar.gz: 0b6ce0b9f3a766f6a59398673ef77bcdbea102c7
+SHA512:
+  metadata.gz: e8b47b804c391ed7c9b147c6735fd56680bc81df436b0b7b22ea396de812c1c708b193fb7365f7479eec7daaf1ce23ee05bacc256843d0dbe94b32dc6de0d4cf
+  data.tar.gz: 782ed8d1cc103f0ba5611002820615640369bf546a54d3637a7c1d35fe41ee0783e9a9ce0e057fd46ae10716c43495d10e91e3e60010245759492687f46b56a4

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset
+dump.rdb
+lita_config.rb

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Sergey Alekseev
+
+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,25 @@
+# lita-answers
+
+A Lita handler for a question answering (QA) system. Allows you to use CRUD operations.  
+More functionality is coming soon...  
+
+## Installation
+
+Add lita-answers to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-answers"
+```
+
+## Usage
+
+You could perform simple CRUD operations: 
+*CREATE* `remember 'question?' with 'answer.'`   
+*READ* `all questions`  
+*READ* `answer 'question?'`  
+*UPDATE* `change 'question?' to 'new answer.'`  
+*DELETE* `forget 'question?'`  
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/knowledgebase.rb

@@ -0,0 +1,39 @@
+class Knowledgebase
+  REDIS_KEY = 'knowledgebase'
+
+  class << self
+    def all
+      redis.hkeys(REDIS_KEY)
+    end
+
+    def create(question, answer)
+      redis.hset(REDIS_KEY, question, answer)
+    end
+
+    def read(question)
+      redis.hget(REDIS_KEY, question)
+    end
+
+    def update(question, answer)
+      redis.hset(REDIS_KEY, question, answer)
+    end
+
+    def destroy(question)
+      redis.hdel(REDIS_KEY, question)
+    end
+
+    def exists?(question)
+      redis.hexists(REDIS_KEY, question)
+    end
+
+    def redis
+      @redis ||= Redis::Namespace.new(redis_namespace, redis: Lita.redis)
+    end
+
+    private
+
+      def redis_namespace
+        ENV['env'] == 'test' ? 'handlers:answers:test' : 'handlers:answers'
+      end
+  end
+end

data/lib/lita-answers.rb

@@ -0,0 +1,2 @@
+require 'lita/handlers/answers'
+require 'knowledgebase'

data/lib/lita/handlers/answers.rb

@@ -0,0 +1,90 @@
+require 'lita'
+
+module Lita
+  module Handlers
+    class Answers < Handler
+      TEXT = /[\w\s\,\.\-–]+/
+      QUESTION = /(?:'|")(#{TEXT.source}\?)(?:'|")/
+      ANSWER = /(?:'|")(#{TEXT.source}\.?)(?:'|")/
+
+      route(/^all\squestions$/i, :index, command: true, help: {
+        "all questions" => "You could ask me the following questions:\n1) ...\n2) ..."
+      })
+
+      route(/^remember\s#{QUESTION.source}\swith\s#{ANSWER.source}$/i, :create, command: true, help: {
+        "remember 'question?' with 'answer.'" => "The answer for 'question' is 'answer'."
+      })
+
+      route(/^answer\s#{QUESTION.source}$/i, :show, command: true, help: {
+        "answer 'question?'" => "answer."
+      })
+
+      route(/^change\s#{QUESTION.source}\sto\s#{ANSWER.source}$/i, :update, command: true, help: {
+        "change 'question?' to 'new answer.'" => "The new answer for 'question' is 'new answer'."
+      })
+
+      route(/^forget\s#{QUESTION.source}$/i, :destroy, command: true, help: {
+        "forget 'question?'" => "Forgot 'question?'"
+      })
+
+      def index(response)
+        questions = Knowledgebase.all
+        if questions.any?
+          reply = "You could ask me the following questions:"
+          questions.map.with_index do |question, index|
+            reply << "\n#{index+1}) #{question}"
+          end
+        else
+          reply = "There are no questions yet! " \
+                  "Use REMEMBER 'question?' WITH 'answer.' syntax for creating questions!\n" \
+                  "For more info see: help remember."
+        end
+        response.reply(reply)
+      end
+
+      def create(response)
+        question, answer = response.matches.first
+        if Knowledgebase.exists?(question)
+          answer = Knowledgebase.read(question)
+          reply = "Use CHANGE 'question?' TO 'new answer.' syntax for existing questions! " \
+                  "For more info see: help change.\n" \
+                  "The answer for '#{question}' is still '#{answer}'"
+        else
+          Knowledgebase.create(question, answer)
+          reply = "The answer for '#{question}' is '#{answer}'"
+        end
+        response.reply(reply)
+      end
+
+      def show(response)
+        question = response.matches.first
+        reply = Knowledgebase.read(question) || 'There is no such a question! Use ALL QUESTIONS command.'
+        response.reply(reply)
+      end
+
+      def update(response)
+        question, new_answer = response.matches.first
+        if Knowledgebase.exists?(question)
+          Knowledgebase.update(question, new_answer)
+          reply = "The new answer for '#{question}' is '#{new_answer}'."
+        else
+          reply = 'There is no such a question! Use ALL QUESTIONS command.'
+        end
+        response.reply(reply)
+      end
+
+      def destroy(response)
+        question = response.matches.first[0]
+        if Knowledgebase.exists?(question)
+          Knowledgebase.destroy(question)
+          reply = "Forgot '#{question}'"
+        else
+          reply = 'There is no such a question! Use ALL QUESTIONS command.'
+        end
+        response.reply(reply)
+      end
+    end
+
+    Lita.register_handler(Answers)
+  end
+end

data/lita-answers.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-answers"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sergey Alekseev"]
+  spec.email         = ["sergey.alekseev.minsk@gmail.com"]
+  spec.description   = "A Lita handler for a question answering (QA) system. Allows you to use CRUD operations." \
+                       "More functionality is coming soon..."
+  spec.summary       = %q{A Lita handler for a question answering (QA) system}
+  spec.homepage      = "https://github.com/sergey-alekseev/lita-answers"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", "~> 2.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency 'pry'
+end

data/spec/knowledgebase_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Knowledgebase do
+  include_context 'variables'
+
+  subject { Knowledgebase }
+  before { subject.create(question, answer) }
+
+  describe '.all' do
+    it 'returns all questions' do
+      expect(subject.all).to eq([question])
+    end
+  end
+
+  describe '.create(question, answer)' do
+    it 'sets the key to question and the value to answer' do
+      subject.create(question, answer)
+      expect(subject.read(question)).to eq(answer)
+    end
+  end
+
+  describe '.read(question)' do
+    it 'returns the answer for the question' do
+      expect(subject.read(question)).to eq(answer)
+    end
+  end
+
+  describe '.update(question, answer)' do
+    it 'updates the answer for the question' do
+      subject.create(question, answer)
+      subject.update(question, new_answer)
+      expect(subject.read(question)).to eq(new_answer)
+    end
+  end
+
+  describe '.destroy(question)' do
+    it 'destroys question' do
+      subject.create(question, answer)
+      subject.destroy(question)
+      expect(subject.read(question)).to be_nil
+    end
+  end
+
+  describe '.exists?(question)' do
+    it 'returns true if question exists' do
+      expect(subject.exists?(question)).to be_true
+    end
+
+    it "returns false if question does not exist" do
+      subject.destroy(question)
+      expect(subject.exists?(question)).to be_false
+    end
+  end
+end

data/spec/lita/handlers/answers_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Lita::Handlers::Answers, lita_handler: true do
+  include_context 'variables'
+
+  describe 'routes' do
+    it { routes_command("remember 'question?' with 'answer.'").to :create }
+    it { routes_command("change 'question?' to 'answer.'").to :update }
+    it { routes_command("answer 'question?'").to :show }
+    it { routes_command("forget 'question?'").to :destroy }
+    it { routes_command("all questions").to :index }
+  end
+
+  describe 'commands' do
+    before { send_command "remember '#{question}' with '#{answer}'" }
+
+    describe '#create' do
+      it 'remembers the question with an answer' do
+        expect(replies.last).to eq("The answer for '#{question}' is '#{answer}'")
+      end
+
+      it "doesn't remember the existing question" do
+        send_command "remember '#{question}' with 'abrakadabra'"
+        expect(replies.last).to eq("Use CHANGE 'question?' TO 'new answer.' syntax for existing questions! " \
+                                   "For more info see: help change.\n" \
+                                   "The answer for '#{question}' is still '#{answer}'")
+      end
+    end
+
+    describe '#index' do
+      it 'displays all questions' do
+        send_command 'all questions'
+        expect(replies.last).to eq "You could ask me the following questions:\n" \
+                                   "1) #{question}"
+      end
+
+      context 'no questions' do
+        it 'displays help explanation' do
+          send_command "forget '#{question}'"
+          send_command 'all questions'
+          expect(replies.last).to eq("There are no questions yet! " \
+                                     "Use REMEMBER 'question?' WITH 'answer.' syntax for creating questions!\n" \
+                                     "For more info see: help remember.")
+        end
+      end
+    end
+
+    describe '#show' do
+      it 'answers the question' do
+        send_command "answer '#{question}'"
+        expect(replies.last).to eq(answer)
+      end
+
+      it_behaves_like 'absent question', "answer 'abrakadabra?'"
+    end
+
+    describe '#destroy' do
+      it 'forgets the question' do
+        send_command "forget '#{question}'"
+        expect(replies.last).to eq("Forgot '#{question}'")
+      end
+
+      it_behaves_like 'absent question', "forget 'abrakadabra?'"
+    end
+
+    describe '#update' do
+      it 'changes the answer for the question' do
+        send_command "change '#{question}' to '#{new_answer}'"
+        expect(replies.last).to eq("The new answer for '#{question}' is '#{new_answer}'.")
+      end
+
+      it_behaves_like 'absent question', "change 'abrakadabra?' to 'abrakadabra'"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter '/spec/' }
+
+require 'lita-answers'
+require 'lita/rspec'
+Dir["#{Dir.pwd}/spec/support/**/*.rb"].each { |f| require f }
+
+ENV['env'] = 'test'

data/spec/support/contexts/variables.rb

@@ -0,0 +1,5 @@
+shared_context 'variables' do
+  let(:question) { 'What is the w3c?' }
+  let(:answer) { 'The World Wide Web Consortium is the main international standards organization for the World Wide Web.' }
+  let(:new_answer) { 'The World Wide Web Consortium' }
+end

data/spec/support/examples/absent_question.rb

@@ -0,0 +1,6 @@
+shared_examples 'absent question' do |command|
+  it 'says that there is no such a question' do
+    send_command command
+    expect(replies.last).to eq("There is no such a question! Use ALL QUESTIONS command.")
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: lita-answers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Alekseev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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: pry
+  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'
+description: A Lita handler for a question answering (QA) system. Allows you to use
+  CRUD operations.More functionality is coming soon...
+email:
+- sergey.alekseev.minsk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/knowledgebase.rb
+- lib/lita-answers.rb
+- lib/lita/handlers/answers.rb
+- lita-answers.gemspec
+- spec/knowledgebase_spec.rb
+- spec/lita/handlers/answers_spec.rb
+- spec/spec_helper.rb
+- spec/support/contexts/variables.rb
+- spec/support/examples/absent_question.rb
+homepage: https://github.com/sergey-alekseev/lita-answers
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A Lita handler for a question answering (QA) system
+test_files:
+- spec/knowledgebase_spec.rb
+- spec/lita/handlers/answers_spec.rb
+- spec/spec_helper.rb
+- spec/support/contexts/variables.rb
+- spec/support/examples/absent_question.rb