lita-regexcellent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b683b6842bef7d8c7bc645382bc5045e171d9d2e
+  data.tar.gz: 48098fe940cca746b0f8f120da8266d04fdbdff9
+SHA512:
+  metadata.gz: e60dcff01bb238161b2dd5f35afdd1367e5b13483724add44f195e26845af9e2869faa6d22667e6a490b56accc9a8bbf08e11a25212650b3066511e314f86549
+  data.tar.gz: ef61572ff091fbe6b198880da6342033130583be39d588dc071c14c95010d945cb987f44eb9136df01e8eefde832b368d4d2cf51308a2413c60192fd64a21a0a

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

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eric Yang
+
+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,24 @@
+# lita-regexcellent
+
+Counts the number of Slack messages that matches a regular expression in the current channel. Only compatible with the Slack adapter.
+
+## Installation
+
+1. Add gem to your Lita instance: `gem "lita-regexcellent"`
+2. Set SLACK_TOKEN if not already set: `heroku config:set SLACK_TOKEN=$token`
+
+## Usage
+
+To use, issue the command (where `lita` is your robots name):
+
+```
+lita count /regex/ since:1_week_ago until:now
+=> 12 results found.
+```
+
+`since` and `until` are both optional. They default to the listed values.
+
+## Running tests
+
+1. Make sure Redis is running locally
+2. `rspec spec`

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

@@ -0,0 +1,18 @@
+require "lita"
+require "chronic"
+require "slack-ruby-client"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/regexcellent"
+
+Lita::Handlers::Regexcellent.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)
+
+Slack.configure do |config|
+  config.token = ENV['SLACK_TOKEN']
+end

data/lib/lita/handlers/regexcellent.rb

@@ -0,0 +1,84 @@
+module Lita
+  module Handlers
+    class Regexcellent < Handler
+      Lita.register_handler(self)
+      class InvalidTimeFormatError < StandardError; end
+
+      DEFAULT_RANGE = {
+        since: "1 week ago",
+        until: "now"
+      }
+
+      route(
+        /^count\s+(\S+)(.*)/i,
+        :count,
+        :command => true,
+        :help    => {
+          "count REGEX since:1_week_ago until:now" => "Counts number of regex matches in channel. 'since' and 'until' are optional (defaults shown)"
+        }
+      )
+
+      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
+
+        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}*.")
+        rescue InvalidTimeFormatError
+          response.reply("Couldn't understand `since:#{oldest.tr(" ", "_")} until:#{latest.tr(" ", "_")}`.")
+        end
+      end
+
+      protected
+
+      def fetch_slack_message_history(room_id, oldest, latest)
+        messages = []
+
+        loop do
+          options = {
+            channel: room_id,
+            count: 1000,
+            inclusive: 0,
+            oldest: string_to_timestamp(oldest),
+            latest: string_to_timestamp(latest)
+          }
+          history = slack_client.channels_history(options)
+          messages.push(history.messages).flatten!
+
+          if history.has_more
+            latest = history.messages.last.ts
+          else
+            break
+          end
+        end
+        messages
+      end
+
+      def time_string_for(type, response)
+        raise "unknown time string type" unless %w(since until).include? type
+        options_string = response.matches.last.last
+        return unless options_string && options_string.length > 0
+        time_string = options_string.match(/#{type}:(\S+)/)
+        time_string.captures.first.try(:tr, "_", " ") if time_string
+      end
+
+      def string_to_timestamp(time_string)
+        parsed_string = Chronic.parse(time_string)
+        fail InvalidTimeFormatError unless parsed_string
+
+        # slack API can only handle 6 digits, otherwise it bugs out
+        sprintf("%0.06f", parsed_string.utc.to_f)
+      end
+
+      def slack_client
+        @slack_client ||= ::Slack::Web::Client.new
+      end
+
+    end
+  end
+end

data/lita-regexcellent.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-regexcellent"
+  spec.version       = "0.1.0"
+  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.homepage      = "https://github.com/yangez/lita-regexcellent"
+  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.6"
+  spec.add_runtime_dependency "chronic"
+  spec.add_runtime_dependency "slack-ruby-client"
+
+  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,4 @@
+en:
+  lita:
+    handlers:
+      regexcellent:

data/spec/lita/handlers/count_spec.rb

@@ -0,0 +1,35 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-regexcellent"
+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,171 @@
+--- !ruby/object:Gem::Specification
+name: lita-regexcellent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-29 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: chronic
+  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: slack-ruby-client
+  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: 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: Parse through channel history with regex
+email:
+- eyang232@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lita-regexcellent.rb
+- lib/lita/handlers/regexcellent.rb
+- lita-regexcellent.gemspec
+- locales/en.yml
+- spec/lita/handlers/count_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/yangez/lita-regexcellent
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Parse through channel history with regex
+test_files:
+- spec/lita/handlers/count_spec.rb
+- spec/spec_helper.rb