lita-ignore-me 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+services:
+  - redis-server
+sudo: false
+cache: bundler

data/README.md

@@ -1,6 +1,10 @@
 # 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.
+[![RubyGems](https://img.shields.io/gem/v/lita-ignore-me.svg)](https://rubygems.org/gems/lita-ignore-me)
+[![Build Status](https://img.shields.io/travis/tessellator/lita-ignore-me/master.svg)](https://travis-ci.org/tessellator/lita-ignore-me)
+[![Code Climate](https://img.shields.io/codeclimate/github/tessellator/lita-ignore-me.svg)](https://codeclimate.com/github/tessellator/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
 
@@ -12,7 +16,7 @@ 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.
+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:
 
@@ -20,16 +24,18 @@ Assuming there is some handler that echoes messages that start with 'echo' insta
 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.
+Lita: Okay Chad, I'll ignore you in #room 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.
+Lita: Okay Chad, I'm listening to you in #room.
 Chad: echo I expect to be echoed.
 Lita: I expect to be echoed.
 ```
 
+You can also request that the robot ignore you or listen to you in a different room by specifying the room name (e.g., `ignore me in #some-room`). In the case of Slack, this allows you to send a message to the robot directly, without the need to clutter the target room with extra messages.
+
 ## License
 
 [MIT](https://opensource.org/licenses/MIT)

data/lib/lita/handlers/ignore_me.rb

@@ -8,34 +8,80 @@ module Lita
         "ignore me" => t('ignore_help')
       })
 
+      route(/^ignore me in (.+)$/i, :ignore_me_in_room, command: true, help: {
+        "ignore me in #room" => t('ignore_help_with_room')
+      })
+
       route(/^listen to me$/i, :listen_to_me, command: true, help: {
         "listen to me" => t('listen_help')
       })
 
+      route(/^listen to me in (.+)$/i, :listen_to_me_in_room, command: true, help: {
+        "listen to me in #room" => t('listen_help_with_room')
+      })
+
+      def find_room(response)
+        Lita::Room.fuzzy_find(response.matches[0][0])
+      end
+
       def ignore_me(response)
-        source = response.message.source
+        ignore_source(response, response.message.source)
+      end
+
+      def ignore_me_in_room(response)
+        room = find_room(response)
+        user = response.message.source.user
+
+        if room.nil?
+          response.reply t('sorry_no_room', name: user.name)
+        else
+          source = Lita::Source.new(user: user, room: room)
+          ignore_source(response, source)
+        end
+      end
+
+      def ignore_source(response, source)
         name = source.user.name
+        room = source.room_object.name
 
         if ignored? source
-          response.reply t('already_ignored', name: name, room: source.room)
+          response.reply t('already_ignored', name: name, room: room)
         else
           ignore source
-          response.reply t('ignored', name: name, room: source.room)
+          response.reply t('ignored', name: name, room: room)
         end
       end
 
       def listen_to_me(response)
-        source = response.message.source
+        listen_to_source(response, response.message.source)
+      end
+
+      def listen_to_me_in_room(response)
+        room = find_room(response)
+        user = response.message.source.user
+
+        if room.nil?
+          response.reply t('sorry_no_room', name: user.name)
+        else
+          source = Lita::Source.new(user: user, room: room)
+          listen_to_source(response, source)
+        end
+      end
+
+      def listen_to_source(response, source)
         name = source.user.name
+        room = source.room_object.name
 
         if ignored? source
           heed source
-          response.reply t('listening', name: name)
+          response.reply t('listening', name: name, room: room)
         else
-          response.reply t('already_listening', name: name)
+          response.reply t('already_listening', name: name, room: room)
         end
       end
 
+      private :find_room, :ignore_source, :listen_to_source
+
     end
 
     Lita.register_handler(IgnoreMe)

data/lita-ignore-me.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-ignore-me"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.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.}
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "lita", ">= 4.6"
+  spec.add_runtime_dependency "lita", "~> 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "pry-byebug"

data/locales/en.yml

@@ -2,9 +2,12 @@ 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.
+        ignore_help: Instructs the robot to ignore you in the current room unless you address it directly.
+        ignore_help_with_room: Instructs the robot to ignore you in the specified room unless you address it directly.
+        listen_help: Instructs the robot to no longer ignore you in the current room.
+        listen_help_with_room: Instructs the robot to no longer ignore you in the specified room.
         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:"
+        listening: "Okay %{name}, I'm listening to you in %{room}."
+        already_listening: "Don't worry %{name}, I'm not ignoring you in %{room}! :heart:"
+        sorry_no_room: "I'm sorry %{name}, I'm afraid I can't do that. That room doesn't exist."

data/spec/lita/extensions/ignore_me_spec.rb

@@ -9,48 +9,90 @@ describe Echo, lita_handler: true, additional_lita_handlers: Lita::Handlers::Ign
   before :example do
     registry.register_hook(:validate_route, Lita::Extensions::IgnoreMe)
     @bob = Lita::User.create(123, name: "Bob")
+    @room_a = Lita::Room.create_or_update("#room-a", name: "#a")
+    @room_b = Lita::Room.create_or_update("#room-b", name: "#b")
   end
 
   it "echoes a message from bob" do
-    send_message(@message, as: @bob, from: "#a")
+    send_message(@message, as: @bob, from: @room_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")
+      send_command("ignore me", as: @bob, from: @room_a)
     end
 
     it "ignores bob's message in #a" do
-      send_message(@message, as: @bob, from: "#a")
+      send_message(@message, as: @bob, from: @room_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")
+      send_message(@message, as: Lita::User.create(456, name: "alice"), from: @room_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")
+      send_message(@message, as: @bob, from: @room_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")
+      send_command(@message, as: @bob, from: @room_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")
+        send_command("listen to me", as: @bob, from: @room_a)
       end
 
       it "does not ignore bob's message in #a" do
-        send_message(@message, as: @bob, from: "#a")
+        send_message(@message, as: @bob, from: @room_a)
         expect(replies.last).to eq @echo_response
       end
     end
 
   end
+
+  context "bob requests to be ignored in #b from #a" do
+
+    before :example do
+      send_command("ignore me in #b", as: @bob, from: @room_a)
+    end
+
+    it "does not ignore bob in #a" do
+      send_message(@message, as: @bob, from: @room_a)
+      expect(replies.last).to eq @echo_response
+    end
+
+    it "ignores bob in #b" do
+      send_message(@message, as: @bob, from: @room_b)
+      expect(replies.last).not_to eq @echo_response
+    end
+
+  end
+
+  context "bob requests to be listened to in #b from #a" do
+
+    before :example do
+      send_command("ignore me", as: @bob, from: @room_a)
+      send_command("ignore me", as: @bob, from: @room_b)
+
+      send_command("listen to me in #b", as: @bob, from: @room_a)
+    end
+
+    it "continues to ignore bob in #a" do
+      send_message(@message, as: @bob, from: @room_a)
+      expect(replies.last).not_to eq @echo_response
+    end
+
+    it "listens to bob in #b" do
+      send_message(@message, as: @bob, from: @room_b)
+      expect(replies.last).to eq @echo_response
+    end
+
+  end
+
 end

data/spec/lita/handlers/ignore_me_spec.rb

@@ -3,40 +3,59 @@ require "spec_helper"
 describe Lita::Handlers::IgnoreMe, lita_handler: true do
   before :example do
     @bob = Lita::User.create(123, name: "Bob")
+    @room_a = Lita::Room.create_or_update("#room-a", name: "#a")
+    @room_b = Lita::Room.create_or_update("#room-b", name: "#b")
   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("ignore me in #some-room").to(:ignore_me_in_room) }
 
     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) }
+    it { is_expected.to route_command("listen to me in #some-room").to(:listen_to_me_in_room) }
   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")
+      send_command("ignore me", as: @bob, from: @room_a)
       expect(replies.last).to eq "Okay Bob, I will ignore you in #a unless you address me directly."
     end
 
+    it "tells bob it will ignore him when he asks to be ignored in a different room" do
+      send_command("ignore me in #b", as: @bob, from: @room_a)
+      expect(replies.last).to eq "Okay Bob, I will ignore you in #b unless you address me directly."
+    end
+
+    it "tells bob it cannot find a non-existent room when he requests to be ignored" do
+      send_command("ignore me in #non-room", as: @bob, from: @room_a)
+      expect(replies.last).to eq "I'm sorry Bob, I'm afraid I can't do that. That room doesn't exist."
+    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:"
+      send_command("listen to me", as: @bob, from: @room_a)
+      expect(replies.last).to eq "Don't worry Bob, I'm not ignoring you in #a! :heart:"
+    end
+
+    it "tells bob it cannot find a non-existent room when he requests the robot listen" do
+      send_command("listen to me in #non-existent", as: @bob, from: @room_a)
+      expect(replies.last).to eq "I'm sorry Bob, I'm afraid I can't do that. That room doesn't exist."
     end
   end
 
   context "when bob is being ignored in #a" do
     before :example do
-      send_command("ignore me", as: @bob, from: "#a")
+      send_command("ignore me", as: @bob, from: @room_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."
+      send_command("listen to me", as: @bob, from: @room_a)
+      expect(replies.last).to eq "Okay Bob, I'm listening to you in #a."
     end
 
     it "tells bob it is already ignoring him if he requests to be ignored" do
-      send_command("ignore me", as: @bob, from: "#a")
+      send_command("ignore me", as: @bob, from: @room_a)
       expect(replies.last).to eq "I'm already ignoring you in #a, Bob."
     end
   end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lita-ignore-me
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chad Taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2016-05-18 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'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -136,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Lita extension that allows a user to tell the robot to ignore him or her