lita-responder 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b5393b3ef99690d9cc8cb7f77c37a32831a9515
+  data.tar.gz: 5aad397e73508a108b4f93e03c1d16a0181a736b
+SHA512:
+  metadata.gz: 2bac99b2efeed808b788f36ec5b1a96e55674adbd543a35b650c6b022a2a0348edb486e7db0719990c68b6f247cf16e7a34e88cb4580282625cd291ec269d03b
+  data.tar.gz: 388a34659184a5b7dda1296afd1cdd129018ff3e48fb73820250f51c7cc7c0c1aa66b68e51cd56e241df4437d7a6f120646a7c150f5a6d4415f72a5edd2ab895

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/*.sublime-workspace

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Roy Hadrianoro
+
+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,68 @@
+# lita-responder
+
+[![Build Status](https://travis-ci.org/Maysora/lita-responder.png?branch=master)](https://travis-ci.org/Maysora/lita-responder)
+[![Code Climate](https://codeclimate.com/github/Maysora/lita-responder.png)](https://codeclimate.com/github/Maysora/lita-responder)
+[![Coverage Status](https://coveralls.io/repos/Maysora/lita-responder/badge.png?branch=master)](https://coveralls.io/r/Maysora/lita-responder?branch=master)
+
+**lita-responder** is a handler for [Lita](https://www.lita.io/) that responds to most command messages using stored key-value and optionally cleverbot
+
+## Installation
+
+Add lita-responder to your Lita instance's Gemfile at the end after all other handlers:
+
+``` ruby
+gem "lita-responder"
+```
+
+## Configuration
+
+* `cleverbot` - set true to enable cleverbot responds to undefined messages, otherwise lita-responder will ignore them
+```ruby
+Lita.configure do |config|
+  config.handlers.responder.cleverbot = true
+end
+```
+
+## Usage
+
+### Add key-value (group: admin, responder_admins)
+
+```
+lita, responder add REGEXP_KEY -> VALUE
+```
+
+example:
+
+```
+lita, responder add (web)?site.*boci(\s*studio)?(\s+.*)?\?$ -> http://www.bocistudio.com
+```
+
+will return `http://www.bocistudio.com` to any commands not used by other handlers which match the regexp (eg: `lita, site boci?`)
+
+### Delete key-value (group: admin, responder_admins)
+
+```
+lita, responder delete REGEXP_KEY
+```
+
+### List key-value (group: admin, responder_admins)
+
+```
+lita, responder list
+```
+
+### Remove all key-value (group: admin)
+
+```
+lita, responder reset
+```
+
+## TODO
+
+- allow multiple values for single key, value selected randomly
+- allow room specific key-value
+- I18n
+
+## 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/lita-responder.rb

@@ -0,0 +1,8 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require 'cleverbot'
+require "lita/handlers/responder"

data/lib/lita/handlers/responder.rb

@@ -0,0 +1,85 @@
+module Lita
+  module Handlers
+    class Responder < Handler
+      def self.default_config(config)
+        config.cleverbot = false
+      end
+
+      route %r{^responder add\s+(.+)\s+->\s+(.+)\s*$}i,
+        :add_responder, command: true, restrict_to: [:admins, :responder_admins],
+        help: {'lita-responder' => 'see https://github.com/Maysora/lita-responder'}
+
+      route %r{^responder (destroy|delete|remove)\s+(.+)\s*$}i,
+        :remove_responder, command: true, restrict_to: [:admins, :responder_admins]
+
+      route %r{^responder list$}i,
+        :list_responder, command: true, restrict_to: [:admins, :responder_admins]
+
+      route %r{^responder reset$}i,
+        :reset_responder, command: true, restrict_to: [:admins]
+
+      route %r{^(.+)$}, :ask_responder, command: true, exclusive: true
+
+      def add_responder(response)
+        question = response.matches[0][0]
+        answer = response.matches[0][1]
+
+        update_answer question, answer
+
+        response.reply_with_mention "I have added '#{answer}' to '#{question}'"
+      end
+
+      def remove_responder(response)
+        question = response.matches[0][1]
+
+        if redis.exists("lita-responder:#{question.downcase}")
+          redis.del("lita-responder:#{question.downcase}")
+        end
+        response.reply_with_mention "I have removed '#{question}'"
+      end
+
+      def list_responder(response)
+        if !questions.empty?
+          response.reply_with_mention '- ' + questions.map{|q| q.sub('lita-responder:', '') }.join("\n- ")
+        else
+          response.reply_with_mention 'I don\'t have any key-value stored'
+        end
+      end
+
+      def reset_responder(response)
+        count = questions.empty? ? 0 : redis.del(questions)
+        response.reply_with_mention "#{count} key(s) removed"
+      end
+
+      def ask_responder(response)
+        question = response.matches[0][0]
+        answer = get_answer(question)
+        if !answer && config.cleverbot
+          bots = robot.instance_variable_get('@cleverbots') || {}
+          bot = bots[response.user.mention_name] ||= Cleverbot::Client.new
+          answer = bot.write question
+          robot.instance_variable_set('@cleverbots', bots)
+        end
+        response.reply_with_mention answer if answer
+      end
+
+      private
+
+      def questions
+        @questions ||= redis.keys('lita-responder:*')
+      end
+
+      def get_answer(question)
+        question = questions.detect { |q| Regexp.new(q.sub('lita-responder:', ''), 'i') =~ question }
+        return nil unless question
+        redis.get(question)
+      end
+
+      def update_answer(question, answer)
+        redis.set "lita-responder:#{question.downcase}", answer
+      end
+    end
+
+    Lita.register_handler(Responder)
+  end
+end

data/lita-responder.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-responder"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Roy Hadrianoro"]
+  spec.email         = ["dev@maysora.com"]
+  spec.description   = %q{A Lita handler for responding using saved key-value or optionally using cleverbot}
+  spec.summary       = %q{A Lita handler for responding using saved key-value or optionally using cleverbot}
+  spec.homepage      = "https://github.com/Maysora/lita-responder"
+  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", ">= 3.3"
+  spec.add_runtime_dependency "lita-exclusive-route"
+  spec.add_runtime_dependency "cleverbot"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/lita-responder.sublime-project

@@ -0,0 +1,9 @@
+{
+  "folders":
+  [
+  {
+    "path": ".",
+    "file_exclude_patterns": ["*.sublime-project", "*.sublime-workspace", ".gitignore", ".gitkeep", ".keep", "Gemfile", ".tags", ".tags_sorted_by_file", ".gemtags"]
+  }
+  ]
+}

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      responder:

data/spec/lita/handlers/responder_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Lita::Handlers::Responder, lita_handler: true do
+  it { routes_command('responder add aya hirano -> cute').to(:add_responder) }
+  it { routes_command('responder destroy aya hirano').to(:remove_responder) }
+  it { routes_command('responder delete aya hirano').to(:remove_responder) }
+  it { routes_command('responder remove aya hirano').to(:remove_responder) }
+  it { routes_command('responder list').to(:list_responder) }
+  it { routes_command('responder reset').to(:reset_responder) }
+  it { routes_command('aya hirano for life!').to(:ask_responder) }
+  it { doesnt_route('responder list').to(:ask_responder) }
+
+  before do
+    allow(Lita::Authorization).to receive(:user_in_group?).with(user, :responder_admins).and_return(false)
+    allow(Lita::Authorization).to receive(:user_in_group?).with(user, :admins).and_return(false)
+  end
+
+  it 'config.cleverbot default to false' do
+    expect(Lita.config.handlers.responder.cleverbot).to be false
+  end
+
+  it 'disallow responder add' do
+    send_command('responder add aya hirano -> cute')
+    expect(replies.last).to be_nil
+  end
+
+  it 'disallow responder reset' do
+    send_command('responder reset')
+    expect(replies.last).to be_nil
+  end
+
+  context 'responder_admins user' do
+    before do
+      allow(Lita::Authorization).to receive(:user_in_group?).with(user, :responder_admins).and_return(true)
+    end
+
+    it 'allow responder add' do
+      send_command('responder add aya hirano -> cute')
+      expect(replies.first).to match(/^I have added/) # use first because exclusive extension not applied here
+      send_command('responder delete aya hirano')
+      expect(replies.last).to match(/^I have removed/)
+    end
+
+    it 'allow responder list' do
+      send_command('responder add aya hirano -> cute')
+      send_command('responder list')
+      expect(replies.last).to match(/aya hirano/)
+    end
+
+    it 'disallow responder reset' do
+      send_command('responder reset')
+      expect(replies.last).to be_nil
+    end
+  end
+
+  context 'admins user' do
+    before do
+      allow(Lita::Authorization).to receive(:user_in_group?).with(user, :admins).and_return(true)
+    end
+
+    it 'allow responder add' do
+      send_command('responder add aya hirano -> cute')
+      expect(replies.first).to match(/^I have added/)
+      send_command('responder remove aya hirano')
+      expect(replies.last).to match(/^I have removed/)
+    end
+
+    it 'allow responder reset' do
+      send_command('responder reset')
+      expect(replies.last).to match(/removed$/)
+
+      send_command('responder list')
+      expect(replies.last).to match(/I don't have any/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-responder"
+require "lita/rspec"

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: lita-responder
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Roy Hadrianoro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: lita-exclusive-route
+  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'
+- !ruby/object:Gem::Dependency
+  name: cleverbot
+  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'
+- !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: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !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'
+description: A Lita handler for responding using saved key-value or optionally using
+  cleverbot
+email:
+- dev@maysora.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-responder.rb
+- lib/lita/handlers/responder.rb
+- lita-responder.gemspec
+- lita-responder.sublime-project
+- locales/en.yml
+- spec/lita/handlers/responder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Maysora/lita-responder
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Lita handler for responding using saved key-value or optionally using cleverbot
+test_files:
+- spec/lita/handlers/responder_spec.rb
+- spec/spec_helper.rb