lita-manners 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e186ba9e2768f2f88c3be46b7f6176492138a44e
+  data.tar.gz: 6c99d6352b176406fdeb0e5d1128e7b556736d6f
+SHA512:
+  metadata.gz: 2db175c4b4884d708d92907c4db1a3a284e82d7356c2fe72ebccd543c97c2067e9fd88e3d6318b7943d0ef42356fcefe5ae7163b0f8a2f8886fda3ca5ad7b4d2
+  data.tar.gz: d8219b4c9b5e72712cbe63ece026eb9b2d2d68c1f24d398bcf5c62ea31e92ef1470c21e9480df4a610dbbde0768866b7fa67905cd3f45264191cfe9133235509

data/.gitignore

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

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.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Neil Ang
+
+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,70 @@
+# lita-manners
+
+[![Build Status](https://travis-ci.org/neilang/lita-manners.png?branch=master)](https://travis-ci.org/neilang/lita-manners)
+[![Coverage Status](https://coveralls.io/repos/neilang/lita-manners/badge.png)](https://coveralls.io/r/neilang/lita-manners)
+
+Makes Lita politely respond to simple hello/goodbye/thank you/sorry commands and mentions.
+
+## Installation
+
+Add lita-manners to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-manners"
+```
+
+## Configuration
+
+There is no configuration.
+
+## Usage
+
+Give Lita basic manners to answer questions.
+
+Saying hello...
+
+```
+# Mentions
+You: Hello Lita
+Lita: Hello You
+
+# Commands
+You: @lita hi!
+Lita: hi You
+```
+
+Saying goodbye...
+
+```
+# Mentions
+You: Goodbye Lita
+Lita: Goodbye You
+
+# Commands
+You: @lita bye!
+Lita: bye You
+```
+
+Saying you're welcome...
+
+```
+# Mentions
+You: Thank you Lita
+Lita: You're welcome You
+
+# Commands
+You: @lita thanks
+Lita: You're welcome You
+```
+
+Accepting an apology...
+
+```
+# Mentions
+You: Sorry Lita
+Lita: Apology accepted You
+
+# Commands
+You: @lita I'm sorry
+Lita: Apology accepted You
+```

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-manners.rb

@@ -0,0 +1,12 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/manners"
+
+Lita::Handlers::Manners.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lib/lita/handlers/manners.rb

@@ -0,0 +1,48 @@
+module Lita
+  module Handlers
+    class Manners < Handler
+      route(/^(hi|hello|hey|howdy|bye|goodbye)!*$/i, :echo_command, command: true)
+      route(/^(hi|hello|hey|howdy|bye|goodbye)\s+@?(.+)$/i, :echo_message, command: false)
+      route(/^(thanks|thank\s?you|cheers)!*$/i, :thank_you_command, command: true)
+      route(/^(thanks|thank\s?you|cheers)\s+@?(.+)$/i, :thank_you_message, command: false)
+      route(/^(i'm |i am )?sorry!*$/i, :sorry_command, command: true)
+      route(/^(i'm |i am )?sorry\s+@?(.+)$/i, :sorry_message, command: false)
+
+      def echo_command(response, message = nil)
+        echo = message || response.matches[0][0]
+        response.reply "#{echo} #{response.user.name}"
+      end
+
+      def echo_message(response)
+        message = response.matches[0][0]
+        echo_command(response, message) if addressed_to_robot?(response)
+      end
+
+      def thank_you_command(response)
+        response.reply "You're welcome #{response.user.name}"
+      end
+
+      def thank_you_message(response)
+        thank_you_command(response) if addressed_to_robot?(response)
+      end
+
+      def sorry_command(response)
+        response.reply "Apology accepted #{response.user.name}"
+      end
+
+      def sorry_message(response)
+         sorry_command(response) if addressed_to_robot?(response)
+      end
+
+      private
+
+      def addressed_to_robot?(response)
+        address = response.matches[0][1].downcase
+        bot_name = robot.mention_name.downcase
+        address.downcase == bot_name
+      end
+    end
+
+    Lita.register_handler(Manners)
+  end
+end

data/lita-manners.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-manners"
+  spec.version       = "0.1.0"
+  spec.authors       = ["neilang"]
+  spec.email         = ["neilang@gmail.com"]
+  spec.description   = "Makes Lita politely respond to simple hello/goodbye/thank you commands and mentions"
+  spec.summary       = "Makes Lita politely respond to simple hello/goodbye/thank you commands and mentions"
+  spec.homepage      = "https://github.com/neilang/lita-manners"
+  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", ">= 4.4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/locales/en.yml

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

data/spec/lita/handlers/manners_spec.rb

@@ -0,0 +1,161 @@
+require "spec_helper"
+
+describe Lita::Handlers::Manners, lita_handler: true do
+  let(:user) { Lita::User.create(1, name: 'You') }
+
+  describe 'echo commands' do
+    it { is_expected.to route_command('hello').to(:echo_command) }
+    it { is_expected.to route_command('hi').to(:echo_command) }
+    it { is_expected.to route_command('hey').to(:echo_command) }
+    it { is_expected.to route_command('howdy').to(:echo_command) }
+    it { is_expected.to route_command('goodbye').to(:echo_command) }
+    it { is_expected.to route_command('bye').to(:echo_command) }
+
+    it { is_expected.to route_command('hello!').to(:echo_command) }
+    it { is_expected.to route_command('hi!').to(:echo_command) }
+    it { is_expected.to route_command('hey!').to(:echo_command) }
+    it { is_expected.to route_command('howdy!').to(:echo_command) }
+    it { is_expected.to route_command('goodbye!').to(:echo_command) }
+    it { is_expected.to route_command('bye!').to(:echo_command) }
+
+    it 'replies with the user name' do
+      send_command('Hello', as: user)
+      expect(replies.last).to eq 'Hello You'
+    end
+
+    it 'replies without punctuation' do
+      send_command('Hello!', as: user)
+      expect(replies.last).to eq 'Hello You'
+    end
+  end
+
+  describe 'echo messages' do
+    it { is_expected.to route('hello lita').to(:echo_message) }
+    it { is_expected.to route('hi lita').to(:echo_message) }
+    it { is_expected.to route('hey lita').to(:echo_message) }
+    it { is_expected.to route('howdy lita').to(:echo_message) }
+    it { is_expected.to route('goodbye lita').to(:echo_message) }
+    it { is_expected.to route('bye lita').to(:echo_message) }
+
+    it { is_expected.to route('hello @lita').to(:echo_message) }
+    it { is_expected.to route('hi @lita').to(:echo_message) }
+    it { is_expected.to route('hey @lita').to(:echo_message) }
+    it { is_expected.to route('howdy @lita').to(:echo_message) }
+    it { is_expected.to route('goodbye @lita').to(:echo_message) }
+    it { is_expected.to route('bye @lita').to(:echo_message) }
+
+    it 'replies to Hello lita' do
+      send_message('Hello lita', as: user)
+      expect(replies.last).to eq 'Hello You'
+    end
+
+    it 'replies to Hello @lita' do
+      send_message('Hello @lita', as: user)
+      expect(replies.last).to eq 'Hello You'
+    end
+
+    it 'replies to Hello LITA' do
+      send_message('Hello LITA', as: user)
+      expect(replies.last).to eq 'Hello You'
+    end
+
+    it 'replies only to mentions' do
+      send_message('Hello @someone', as: user)
+      expect(replies.last).to eq nil
+    end
+  end
+
+  describe 'thank you command' do
+    it { is_expected.to route_command('thank you').to(:thank_you_command) }
+    it { is_expected.to route_command('thankyou').to(:thank_you_command) }
+    it { is_expected.to route_command('thanks').to(:thank_you_command) }
+    it { is_expected.to route_command('cheers').to(:thank_you_command) }
+
+    it { is_expected.to route_command('thank you!').to(:thank_you_command) }
+    it { is_expected.to route_command('thankyou!').to(:thank_you_command) }
+    it { is_expected.to route_command('thanks!').to(:thank_you_command) }
+    it { is_expected.to route_command('cheers!').to(:thank_you_command) }
+
+    it 'replies with the user name' do
+      send_command('thank you', as: user)
+      expect(replies.last).to eq 'You\'re welcome You'
+    end
+  end
+
+  describe 'thank you message' do
+    it { is_expected.to route('thank you lita').to(:thank_you_message) }
+    it { is_expected.to route('thankyou lita').to(:thank_you_message) }
+    it { is_expected.to route('thanks lita').to(:thank_you_message) }
+    it { is_expected.to route('cheers lita').to(:thank_you_message) }
+
+    it { is_expected.to route('thank you @lita').to(:thank_you_message) }
+    it { is_expected.to route('thankyou @lita').to(:thank_you_message) }
+    it { is_expected.to route('thanks @lita').to(:thank_you_message) }
+    it { is_expected.to route('cheers @lita').to(:thank_you_message) }
+
+    it 'replies to thank you lita' do
+      send_message('thank you lita', as: user)
+      expect(replies.last).to eq 'You\'re welcome You'
+    end
+
+    it 'replies to thank you @lita' do
+      send_message('thank you @lita', as: user)
+      expect(replies.last).to eq 'You\'re welcome You'
+    end
+
+    it 'replies to thank you LITA' do
+      send_message('thank you LITA', as: user)
+      expect(replies.last).to eq 'You\'re welcome You'
+    end
+
+    it 'replies only to mentions' do
+      send_message('thank you @someone', as: user)
+      expect(replies.last).to eq nil
+    end
+  end
+
+  describe "sorry command" do
+    it { is_expected.to route_command('sorry').to(:sorry_command) }
+    it { is_expected.to route_command('I am sorry').to(:sorry_command) }
+    it { is_expected.to route_command('I\'m sorry').to(:sorry_command) }
+
+    it { is_expected.to route_command('sorry!').to(:sorry_command) }
+    it { is_expected.to route_command('I am sorry!').to(:sorry_command) }
+    it { is_expected.to route_command('I\'m sorry!').to(:sorry_command) }
+
+    it 'replies with the user name' do
+      send_command('sorry', as: user)
+      expect(replies.last).to eq 'Apology accepted You'
+    end
+  end
+
+  describe "sorry message" do
+    it { is_expected.to route('sorry lita').to(:sorry_message) }
+    it { is_expected.to route('I am sorry lita').to(:sorry_message) }
+    it { is_expected.to route('I\'m sorry lita').to(:sorry_message) }
+
+    it { is_expected.to route('sorry @lita').to(:sorry_message) }
+    it { is_expected.to route('I am sorry @lita').to(:sorry_message) }
+    it { is_expected.to route('I\'m sorry @lita').to(:sorry_message) }
+
+    it 'replies to sorry lita' do
+      send_message('sorry lita', as: user)
+      expect(replies.last).to eq 'Apology accepted You'
+    end
+
+    it 'replies to sorry @lita' do
+      send_message('sorry @lita', as: user)
+      expect(replies.last).to eq 'Apology accepted You'
+    end
+
+    it 'replies to sorry LITA' do
+      send_message('sorry LITA', as: user)
+      expect(replies.last).to eq 'Apology accepted You'
+    end
+
+    it 'replies only to mentions' do
+      send_message('sorry @someone', as: user)
+      expect(replies.last).to eq nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-manners"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: lita-manners
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- neilang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !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: pry-byebug
+  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: 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: rack-test
+  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: Makes Lita politely respond to simple hello/goodbye/thank you commands
+  and mentions
+email:
+- neilang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/lita-manners.rb
+- lib/lita/handlers/manners.rb
+- lita-manners.gemspec
+- locales/en.yml
+- spec/lita/handlers/manners_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/neilang/lita-manners
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Makes Lita politely respond to simple hello/goodbye/thank you commands and
+  mentions
+test_files:
+- spec/lita/handlers/manners_spec.rb
+- spec/spec_helper.rb