lita-regexcellent 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b683b6842bef7d8c7bc645382bc5045e171d9d2e
-  data.tar.gz: 48098fe940cca746b0f8f120da8266d04fdbdff9
+  metadata.gz: 78dae87531be14359f26b8838bf2260e8af630b8
+  data.tar.gz: 2c2ec53083d467762f99af4d7f8d3740e86c6f36
 SHA512:
-  metadata.gz: e60dcff01bb238161b2dd5f35afdd1367e5b13483724add44f195e26845af9e2869faa6d22667e6a490b56accc9a8bbf08e11a25212650b3066511e314f86549
-  data.tar.gz: ef61572ff091fbe6b198880da6342033130583be39d588dc071c14c95010d945cb987f44eb9136df01e8eefde832b368d4d2cf51308a2413c60192fd64a21a0a
+  metadata.gz: bc396ae6248ab04ae2262b712bc40930cfafd73a1d51026a827f3e688f19d3f529e1c859c749dc5b43f49badbb9bec1ab5ae203ea6c6a10815a6f92beedc8b25
+  data.tar.gz: bb3d7c923cde3bbdc724aaf28532e0c9d9f9ccaf2c7285cbb9bef7288bea76c97579903a94dc4af83eca5311da5a8961c5a894d957aad64b4886c3e9c51e699d

data/README.md

@@ -13,10 +13,12 @@ To use, issue the command (where `lita` is your robots name):
 
 ```
 lita count /regex/ since:1_week_ago until:now
-=> 12 results found.
+=> Found 12 results for /regex/ since 1 week ago until now.
 ```
 
-`since` and `until` are both optional. They default to the listed values.
+`since` and `until` are both optional and default to the listed values.
+
+The search will also skip over previous queries (`lita count /regex/`) and previous bot responses (`Found 12 results for...`).
 
 ## Running tests
 

data/lib/lita/handlers/regexcellent.rb

@@ -8,6 +8,10 @@ module Lita
         since: "1 week ago",
         until: "now"
       }
+      MESSAGES = {
+        found: "Found %{count} results for */%{regex_string}/* since *%{oldest}* until *%{latest}*.",
+        invalid_time_format: "Couldn't understand `since:%{oldest} until:%{latest}`."
+      }
 
       route(
         /^count\s+(\S+)(.*)/i,
@@ -19,19 +23,25 @@ module Lita
       )
 
       def count(response)
-        oldest = time_string_for('since', response) || DEFAULT_RANGE[:since]
-        latest = time_string_for('until', response) || DEFAULT_RANGE[:until]
-
-        regex_string = response.matches.first.first.tr('/', '')
-        regex = Regexp.new regex_string
+        data = {
+          oldest: time_string_for('since', response) || DEFAULT_RANGE[:since],
+          latest: time_string_for('until', response) || DEFAULT_RANGE[:until],
+          regex_string: response.matches.first.first.tr('/', '')
+        }
 
         begin
-          messages = fetch_slack_message_history(response.room.id, oldest, latest)
-          count = messages.count{ |message| message.text.match regex }
-          response.reply("Found #{count} results for */#{regex_string}/* since *#{oldest}* until *#{latest}*.")
+          messages = fetch_slack_message_history(response.room.id, data[:oldest], data[:latest])
+          regex = Regexp.new data[:regex_string]
+          reply = MESSAGES[:found] % data.merge({
+            count: count_messages(messages, regex)
+          })
         rescue InvalidTimeFormatError
-          response.reply("Couldn't understand `since:#{oldest.tr(" ", "_")} until:#{latest.tr(" ", "_")}`.")
+          reply = MESSAGES[:invalid_time_format] % {
+            oldest: data[:oldest].tr(" ", "_"),
+            latest: data[:latest].tr(" ", "_")
+          }
         end
+        response.reply(reply)
       end
 
       protected
@@ -59,6 +69,14 @@ module Lita
         messages
       end
 
+      def count_messages(messages, regex)
+        messages.count do |message|
+          next if message.user == robot_user_id # skip messages from self
+          next if message.text.match(/^@?#{robot.mention_name}\scount.*/i) # skip `bot count` queries
+          message.text.match regex
+        end
+      end
+
       def time_string_for(type, response)
         raise "unknown time string type" unless %w(since until).include? type
         options_string = response.matches.last.last
@@ -75,6 +93,13 @@ module Lita
         sprintf("%0.06f", parsed_string.utc.to_f)
       end
 
+      # couldn't find a direct way to get robot user id (e.g. robot.user_id)
+      # so instead we use the method that `lita users find [name]` uses:
+      # https://github.com/litaio/lita-default-handlers/blob/master/lib/lita/handlers/users.rb
+      def robot_user_id
+        robot_id = User.fuzzy_find(robot.mention_name).id
+      end
+
       def slack_client
         @slack_client ||= ::Slack::Web::Client.new
       end

data/lita-regexcellent.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-regexcellent"
-  spec.version       = "0.1.0"
+  spec.version       = "0.1.1"
   spec.authors       = ["Eric Yang"]
   spec.email         = ["eyang232@gmail.com"]
-  spec.description   = "Parse through channel history with regex"
-  spec.summary       = "Parse through channel history with regex"
+  spec.description   = "Search and parse through Slack channel history with regex"
+  spec.summary       = "Search and parse through Slack channel history with regex"
   spec.homepage      = "https://github.com/yangez/lita-regexcellent"
   spec.license       = "MIT"
   spec.metadata      = { "lita_plugin_type" => "handler" }

data/spec/lita/handlers/regexcellent_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+RSpec.describe Lita::Handlers::Regexcellent, :lita_handler => true do
+  let(:robot) { Lita::Robot.new(registry) }
+
+  let(:robot_id) { "STUBBED_ID" }
+  let(:message_stub) { Struct.new(:text, :user) }
+
+  subject { described_class.new(robot) }
+
+  describe "#count" do
+    let(:room) { double(Lita::Room, id: 1)}
+    let(:messages) { [] }
+
+
+    before do
+      allow_any_instance_of(described_class).to receive(:fetch_slack_message_history).and_return(messages)
+      allow_any_instance_of(Lita::Response).to receive(:room).and_return(room)
+      allow_any_instance_of(described_class).to receive(:robot_user_id).and_return(robot_id)
+    end
+
+    it { is_expected.to route("@lita count regex") }
+    it { is_expected.to route("lita count regex") }
+    it { is_expected.to route("lita count regex since:yesterday until:today") }
+
+    it "responds with a count" do
+      send_message("Lita count regex")
+      expect(replies.last).to match /Found 0 results for \*\/regex\/\* since \*1 week ago\* until \*now\*\./
+    end
+
+    context "when there are messages from itself" do
+      let(:self_message) { message_stub.new("hi world", robot_id) }
+      let(:valid_message) { message_stub.new("hi world", "REGULAR_USER_ID") }
+      let(:messages) { [self_message, valid_message] }
+
+      it "does not count self messages" do
+        send_message("Lita count world")
+        expect(replies.last).to match /^Found 1 result.*/
+      end
+    end
+
+    context "when there are existing messages querying the bot" do
+      let(:query_message) { message_stub.new("lita count so cool", "REGULAR_USER_ID") }
+      let(:query_message2) { message_stub.new("@lita count so cool", "REGULAR_USER_ID") }
+      let(:valid_message) { message_stub.new("so cool indeed", "REGULAR_USER_ID") }
+      let(:messages) { [query_message, query_message2, valid_message] }
+
+      it "does not count querying messages" do
+        send_message("Lita count cool")
+        expect(replies.last).to match /^Found 1 result.*/
+      end
+    end
+
+    context "when regex is formatted as /regex/" do
+      it "responds with a count" do
+        send_message("lita count /regex/")
+        expect(replies.last).to match /Found 0 results for \*\/regex\/\* since \*1 week ago\* until \*now\*\./
+      end
+    end
+  end
+
+  describe "#fetch_slack_message_history" do
+    it "will be tested"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-regexcellent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eric Yang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-29 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: Parse through channel history with regex
+description: Search and parse through Slack channel history with regex
 email:
 - eyang232@gmail.com
 executables: []
@@ -138,7 +138,7 @@ files:
 - lib/lita/handlers/regexcellent.rb
 - lita-regexcellent.gemspec
 - locales/en.yml
-- spec/lita/handlers/count_spec.rb
+- spec/lita/handlers/regexcellent_spec.rb
 - spec/spec_helper.rb
 - templates/.gitkeep
 homepage: https://github.com/yangez/lita-regexcellent
@@ -165,7 +165,7 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: Parse through channel history with regex
+summary: Search and parse through Slack channel history with regex
 test_files:
-- spec/lita/handlers/count_spec.rb
+- spec/lita/handlers/regexcellent_spec.rb
 - spec/spec_helper.rb

data/spec/lita/handlers/count_spec.rb

@@ -1,35 +0,0 @@
-require "spec_helper"
-
-RSpec.describe Lita::Handlers::Regexcellent, :lita_handler => true do
-  let(:robot) { Lita::Robot.new(registry) }
-
-
-  subject { described_class.new(robot) }
-
-  describe "#count" do
-    let(:room) { double(Lita::Room, id: 1)}
-    before do
-      allow_any_instance_of(described_class).to receive(:fetch_slack_message_history).and_return([])
-      allow_any_instance_of(Lita::Response).to receive(:room).and_return(room)
-    end
-
-    it { is_expected.to route("Lita count regex") }
-    it { is_expected.to route("Lita count regex since:yesterday until:today") }
-
-    it "responds with a count" do
-      send_message("Lita count regex")
-      expect(replies.last).to match /Found 0 results for \*\/regex\/\* since \*1 week ago\* until \*now\*\./
-    end
-
-    context "when regex is formatted as /regex/" do
-      it "responds with a count" do
-        send_message("Lita count /regex/")
-        expect(replies.last).to match /Found 0 results for \*\/regex\/\* since \*1 week ago\* until \*now\*\./
-      end
-    end
-  end
-
-  describe "#fetch_slack_message_history" do
-    it "will be tested"
-  end
-end