lita-ignore-me 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0de664e9ad8e0e3ad3e38725e8201639327f74ef
+  data.tar.gz: d78e8a966ebb3f91b35cd2e8e3173019764a4bf6
+SHA512:
+  metadata.gz: cf977197f5de02dccd91438005eed9e50a809468de673cda11f6a8476f69bf8896501b0875694c4b9b6f2a83b2ddf75dd48abb78574d6d4f4a9420090b00b292
+  data.tar.gz: 3e80a2a69f22568bc6fdc2bcadf7a6d1d907f91d9e138ac91c357a0acfe98602d3f87f9389e8f9f8e3402f34e2bcacbf01c63fe0068c5e82f56702db648c54a5

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015 Thomas C. Taylor
+
+
+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,35 @@
+# lita-ignore-me
+
+*lita-ignore-me* is a Lita extension that allows a user to tell the robot that he or she wishes to be ignored unless addressing the robot directly. This means that routes that are triggered that are not commands are not executed.
+
+## Installation
+
+Add lita-ignore-me to your Lita plugin's gemspec:
+
+``` ruby
+spec.add_runtime_dependency "lita-ignore-me"
+```
+
+## Usage
+
+There is no additional configuration necessary. There are two commands added for a user to manage whether the robot will listen to or ignore that user in the current room: `ignore me` and `listen to me.
+
+Assuming there is some handler that echoes messages that start with 'echo' installed and configured, a conversation might look like this:
+
+```
+Chad: echo I don't like to be echoed.
+Lita: I don't like to be echoed.
+Chad: @Lita: ignore me
+Lita: Okay Chad, I'll ignore you in #channel unless you address me directly.
+Chad: echo I don't like to be echoed.
+Chad: lita help
+Lita: *prints help*
+Chad: @Lita: listen to me
+Lita: Okay Chad, I'm listening.
+Chad: echo I expect to be echoed.
+Lita: I expect to be echoed.
+```
+
+## License
+
+[MIT](https://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-ignore-me.rb

@@ -0,0 +1,9 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/ignore_registry"
+require "lita/extensions/ignore_me"
+require "lita/handlers/ignore_me"

data/lib/lita/extensions/ignore_me.rb

@@ -0,0 +1,14 @@
+module Lita::Extensions
+
+  class IgnoreMe
+    extend Lita::IgnoreRegistry
+
+    def self.call(payload)
+      message = payload.fetch(:message)
+      message.command? or not ignored? message.source
+    end
+
+    Lita.register_hook(:validate_route, IgnoreMe)
+  end
+
+end

data/lib/lita/handlers/ignore_me.rb

@@ -0,0 +1,43 @@
+module Lita
+  module Handlers
+
+    class IgnoreMe < Handler
+      include IgnoreRegistry
+
+      route(/^ignore me$/i, :ignore_me, command: true, help: {
+        "ignore me" => t('ignore_help')
+      })
+
+      route(/^listen to me$/i, :listen_to_me, command: true, help: {
+        "listen to me" => t('listen_help')
+      })
+
+      def ignore_me(response)
+        source = response.message.source
+        name = source.user.name
+
+        if ignored? source
+          response.reply t('already_ignored', name: name, room: source.room)
+        else
+          ignore source
+          response.reply t('ignored', name: name, room: source.room)
+        end
+      end
+
+      def listen_to_me(response)
+        source = response.message.source
+        name = source.user.name
+
+        if ignored? source
+          heed source
+          response.reply t('listening', name: name)
+        else
+          response.reply t('already_listening', name: name)
+        end
+      end
+
+    end
+
+    Lita.register_handler(IgnoreMe)
+  end
+end

data/lib/lita/ignore_registry.rb

@@ -0,0 +1,22 @@
+module Lita
+  module IgnoreRegistry
+
+    def key(source)
+      "ignore_me:#{source.room}"
+    end
+
+    def ignored?(source)
+      Lita.redis.sismember(key(source), source.user.id)
+    end
+
+    def ignore(source)
+      Lita.redis.sadd(key(source), source.user.id)
+    end
+
+    def heed(source)
+      Lita.redis.srem(key(source), source.user.id)
+    end
+
+    private :key
+  end
+end

data/lita-ignore-me.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-ignore-me"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Chad Taylor"]
+  spec.email         = ["taylor.thomas.c@gmail.com"]
+  spec.description   = %q{A Lita extension to ignore a user's non-command messages upon request.}
+  spec.summary       = %q{A Lita extension that allows a user to tell the robot to ignore him or her unless that user addresses the robot directly.}
+  spec.homepage      = "https://github.com/tessellator/lita-ignore-me"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "extension" }
+
+  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.6"
+
+  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"
+end

data/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  lita:
+    handlers:
+      ignore_me:
+        ignore_help: Instructs the robot to ignore you unless you address it directly.
+        listen_help: Instructs the robot to no longer ignore you.
+        ignored: "Okay %{name}, I will ignore you in %{room} unless you address me directly."
+        already_ignored: "I'm already ignoring you in %{room}, %{name}."
+        listening: "Okay %{name}, I'm listening."
+        already_listening: "Don't worry %{name}, I'm not ignoring you! :heart:"

data/spec/lita/extensions/ignore_me_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Echo, lita_handler: true, additional_lita_handlers: Lita::Handlers::IgnoreMe do
+  before :context do
+    @message = "echo Goodbye, moon!"
+    @echo_response = "Goodbye, moon!"
+  end
+
+  before :example do
+    registry.register_hook(:validate_route, Lita::Extensions::IgnoreMe)
+    @bob = Lita::User.create(123, name: "Bob")
+  end
+
+  it "echoes a message from bob" do
+    send_message(@message, as: @bob, from: "#a")
+    expect(replies.first).to eq @echo_response
+  end
+
+  context "bob is ignored in #a" do
+    before do
+      send_command("ignore me", as: @bob, from: "#a")
+    end
+
+    it "ignores bob's message in #a" do
+      send_message(@message, as: @bob, from: "#a")
+      expect(replies.last).not_to eq @echo_message
+    end
+
+    it "does not ignore alice's message in #a" do
+      send_message(@message, as: Lita::User.create(456, name: "alice"), from: "#a")
+      expect(replies.last).to eq @echo_response
+    end
+
+    it "does not ignore bob's message in #b" do
+      send_message(@message, as: @bob, from: "#b")
+      expect(replies.last).to eq @echo_response
+    end
+
+    it "does not ignore bob's command in #a" do
+      send_command(@message, as: @bob, from: "#a")
+      expect(replies.last).to eq @echo_response
+    end
+
+    context "bob turns off ignore in #a" do
+      before do
+        send_command("listen to me", as: @bob, from: "#a")
+      end
+
+      it "does not ignore bob's message in #a" do
+        send_message(@message, as: @bob, from: "#a")
+        expect(replies.last).to eq @echo_response
+      end
+    end
+
+  end
+end

data/spec/lita/handlers/ignore_me_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe Lita::Handlers::IgnoreMe, lita_handler: true do
+  before :example do
+    @bob = Lita::User.create(123, name: "Bob")
+  end
+
+  context "routing" do
+    it { is_expected.to route_command("ignore me").to(:ignore_me) }
+    it { is_expected.to route_command("IGNORE ME").to(:ignore_me) }
+
+    it { is_expected.to route_command("listen to me").to(:listen_to_me) }
+    it { is_expected.to route_command("LISTEN TO ME").to(:listen_to_me) }
+  end
+
+  context "when bob is not being ignored" do
+    it "tells bob it will ignore him upon request" do
+      send_command("ignore me", as: @bob, from: "#a")
+      expect(replies.last).to eq "Okay Bob, I will ignore you in #a unless you address me directly."
+    end
+
+    it "tells bob it is not ignoring him if he requests that the robot listen" do
+      send_command("listen to me", as: @bob, from: "#a")
+      expect(replies.last).to eq "Don't worry Bob, I'm not ignoring you! :heart:"
+    end
+  end
+
+  context "when bob is being ignored in #a" do
+    before :example do
+      send_command("ignore me", as: @bob, from: "#a")
+    end
+
+    it "tells bob he is no longer ignoring him upon request" do
+      send_command("listen to me", as: @bob, from: "#a")
+      expect(replies.last).to eq "Okay Bob, I'm listening."
+    end
+
+    it "tells bob it is already ignoring him if he requests to be ignored" do
+      send_command("ignore me", as: @bob, from: "#a")
+      expect(replies.last).to eq "I'm already ignoring you in #a, Bob."
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "lita-ignore-me"
+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
+
+class Echo < Lita::Handler
+
+  route(/echo\s+(.+)/, :echo)
+
+  def echo(response)
+    response.reply(response.matches)
+  end
+
+end
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: lita-ignore-me
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chad Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !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
+description: A Lita extension to ignore a user's non-command messages upon request.
+email:
+- taylor.thomas.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-ignore-me.rb
+- lib/lita/extensions/ignore_me.rb
+- lib/lita/handlers/ignore_me.rb
+- lib/lita/ignore_registry.rb
+- lita-ignore-me.gemspec
+- locales/en.yml
+- spec/lita/extensions/ignore_me_spec.rb
+- spec/lita/handlers/ignore_me_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tessellator/lita-ignore-me
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: extension
+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.1
+signing_key: 
+specification_version: 4
+summary: A Lita extension that allows a user to tell the robot to ignore him or her
+  unless that user addresses the robot directly.
+test_files:
+- spec/lita/extensions/ignore_me_spec.rb
+- spec/lita/handlers/ignore_me_spec.rb
+- spec/spec_helper.rb