lita-announce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23650169379196bfa169ae3a9cd0f7001ad15afd
+  data.tar.gz: 1be5ebe6151241ddf78f63a47580b22158be9d5b
+SHA512:
+  metadata.gz: 1eb346cffc8598e74d029ccf8a5fc34181d72461957513887cb8a0e430b807cb0755faadc009cc5f314188b2e4c22e042a1719140c8337a4b02f958189eaaf2e
+  data.tar.gz: aa2dc780020dfc97944cf70caad48faabdb2edb1ae7196c3c8add13a76dd41a3854ad74dbebe936dc5adaf6fe1afc84bb3c9102c1e9007ee582339d8864d6c4c

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,16 @@
+# Use Travis's cointainer based infrastructure
+sudo: false
+
+rvm:
+  - 2.3.1
+
+bundler_args: --jobs 7
+
+services:
+  - redis-server
+
+branches:
+  only:
+    - master
+
+script: bundle exec rake

data/Gemfile

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

data/README.md

@@ -0,0 +1,70 @@
+# lita-announce
+
+Quick and easy way to share content with multiple channels.
+
+## Installation
+
+Add lita-announce to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-announce"
+```
+
+## Usage
+
+    @lita announce to <channels> <content>
+    @lita announce to <groups> <content>
+    @lita announce list-groups
+    @lita announce add-group <name> <channels>
+    @lita announce mod-group <name> <channels>
+    @lita announce del-group <name>
+
+### Managing Groups
+
+#### list-groups
+
+    @lita announce list-groups
+    Group1: #channel1, #channel2, #channel3
+    Group2: #channel1, #channel4
+
+#### add-group
+Each group must have a unique name that contains only letters, numbers, and underscores.
+
+    @lita announce add-group devs foo-dev,bar-dev,baz-dev
+
+#### mod-group
+Modify the list of channels in a group. Must provide the full list.
+
+    @lita announce mod-group devs foo-dev,bar-dev,baz-dev,super-dev
+
+#### del-group
+Delete a group.
+
+    @lita announce del-group devs
+
+### Making Announcements
+
+#### Send a message to multiple channels
+
+    @lita announce to general,random Hey everyone! All hands is starting in five minutes! Join us in #all-hands-meeting. :smile:
+
+### Share a message with a pre-configured group of channels
+
+    @lita announce add-group devs foo-dev,bar-dev,baz-dev
+
+    @lita announce to group:devs Don't forget to turn in your TPS reports!
+
+### Share a link with several pre-configured groups of channels
+
+    @lita announce add-group devs foo-dev,bar-dev,baz-dev
+    @lita announce add-group foo-announcements foo-dev,foo-announce,foo-discuss
+
+    @lita announce to group:foo-announcements,group:devs Hey everyone! Thanks for your combined effort to get foo out the door!
+
+And don't worry! Messages will only get send to channels once, even if they are part of multiple groups!
+
+### Share a link with a combination of groups and channels
+
+    @lita announce add-group devs foo-dev,bar-dev,baz-dev
+
+    @lita announce to group:devs,general Hey everyone! Make sure that you get your TPS reports in on time this week.

data/Rakefile

@@ -0,0 +1,13 @@
+require "chefstyle"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new
+
+desc " Run ChefStyle"
+RuboCop::RakeTask.new(:chefstyle) do |task|
+  task.options << "--display-cop-names"
+end
+
+task default: [:spec, :chefstyle]

data/dev/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "lita"
+gem "lita-slack"
+gem "lita-announce", path: "../"

data/dev/lita_config.rb

@@ -0,0 +1,7 @@
+Lita.configure do |config|
+  config.robot.log_level = :debug
+  config.robot.adapter = :slack
+  config.robot.admins = ["1"]
+
+  config.adapters.slack.token = ENV["SLACK_TOKEN"]
+end

data/lib/lita-announce.rb

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

data/lib/lita/handlers/announce.rb

@@ -0,0 +1,188 @@
+#
+# Copyright:: Copyright 2016 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "json"
+require "time"
+
+module Lita
+  module Handlers
+    class Announce < Handler
+
+      config :announcements_to_keep, default: 10
+
+      route(
+        /^announce\s+list-groups/i,
+        :handle_list_groups,
+        command: true,
+        help: {
+          "announce list-groups" => "list-groups",
+        }
+      )
+
+      route(
+        /^announce\s+add-group\s+(.+)/i,
+        :handle_mod_group,
+        command: true,
+        help: {
+          "announce add-group" => "add-group <name> <channels>",
+        }
+      )
+
+      route(
+        /^announce\s+mod-group\s+(.+)/i,
+        :handle_mod_group,
+        command: true,
+        help: {
+          "announce mod-group" => "mod-group <name> <channels>",
+        }
+      )
+
+      route(
+        /^announce\s+del-group\s+(.+)/i,
+        :handle_del_group,
+        command: true,
+        help: {
+          "announce del-group" => "del-group <name>",
+        }
+      )
+
+      route(
+        /^announce\s+to\s+(.+)/i,
+        :handle_announce,
+        command: true,
+        help: {
+          "announce" => "announce to <groups and channels> <message>",
+        }
+      )
+
+      def handle_list_groups(response)
+        results = []
+        redis.scan_each do |key|
+          if key =~ /^group:(\w+)$/
+            channels = JSON.parse(redis.get(key))["channels"]
+            results << "*#{$1}*: #{channels.map { |c| "\##{c}" }.join(", ")}"
+          end
+        end
+        response.reply(results.join("\n"))
+      end
+
+      def handle_mod_group(response)
+        group    = response.args[1]
+        channels = response.args[2]
+
+        unless group =~ /^\w+$/
+          response.reply(":failed: '#{group}' is not a valid name. Please use only letters, numbers, and underscores.")
+          return
+        end
+
+        unless response.args[3].nil?
+          response.reply(":failed: Please provide channels as a comma-separated list with no spaces.")
+          return
+        end
+
+        channel_array = channels.split(",").map { |c| c.gsub(/^\#/, "") }
+
+        all_channels_exist = true
+        channel_array.each do |c|
+          if Lita::Room.fuzzy_find(c).nil?
+            response.reply(":failed: Can not create '#{group}': the \##{c} channel does not exist.")
+            all_channels_exist = false
+          end
+        end
+        return unless all_channels_exist
+
+        redis.set("group:#{group}", { channels: channel_array }.to_json)
+        response.reply(":successful: Announcement group '#{group}' updated! Will send messages to #{channel_array.map { |c| "\##{c}" }.join(", ")}")
+      end
+
+      def handle_del_group(response)
+        group = response.args[1]
+
+        if redis.get("group:#{group}").nil?
+          response.reply(":failed: Can not delete '#{group}': does not exist.")
+          return
+        end
+
+        redis.del("group:#{group}")
+        response.reply(":successful: Announcement group '#{group}' deleted.")
+      end
+
+      def handle_announce(response)
+        channels = parse_channels(response.args[1])
+        message  = response.args[2..-1].join(" ")
+
+        return if channels.nil?
+
+        payload = {
+          author: response.user.name,
+          channels: channels.uniq,
+          text: message,
+          timestamp: DateTime.now.to_time.to_i,
+        }
+
+        save_announcement(payload)
+        make_announcement_to_channels(payload)
+      end
+
+      def parse_channels(targets)
+        channels = []
+        targets.split(",").each do |target|
+          c = parse_target(target)
+
+          if c.nil?
+            response.reply(":failed: Could not send message: the group '#{target}' could not be found.")
+            return nil
+          else
+            channels.concat(c)
+          end
+        end
+        channels
+      end
+
+      def save_announcement(payload)
+        redis.lpush("announcements", payload.to_json)
+        redis.ltrim("announcements", 0, config.announcements_to_keep - 1)
+      end
+
+      def make_announcement_to_channels(payload)
+        payload[:channels].each do |c|
+          channel = Lita::Source.new(room: Lita::Room.fuzzy_find(c))
+          robot.send_message(channel, "#{payload[:text]} - #{payload[:author]}")
+        end
+      end
+
+      def parse_target(target)
+        if target =~ /^group:(\w+)$/
+          group = redis.get(target)
+          return nil if group.nil?
+          JSON.parse(group)["channels"]
+        else
+          [target]
+        end
+      end
+
+      def attachment_for(payload)
+        options = {
+
+        }
+        Lita::Adapters::Slack::Attachment.new(payload[:message], options)
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-announce.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-announce"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Tom Duffield"]
+  spec.email         = ["tom@chef.io"]
+  spec.description   = "Lita plugin to make announcements across multiple channels."
+  spec.summary       = "Lita plugin to make announcements across multiple channels."
+  spec.homepage      = "http://github.com/tduffield/lita-announce"
+  spec.license       = "Apache 2.0"
+  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.7"
+  spec.add_runtime_dependency "json", "~> 2.0.0"
+
+  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:
+      announce:

data/spec/lita/handlers/announce_spec.rb

@@ -0,0 +1,179 @@
+require "spec_helper"
+
+describe Lita::Handlers::Announce, lita_handler: true do
+
+  it { is_expected.to route_command("announce list-groups").to(:handle_list_groups) }
+  it { is_expected.to route_command("announce add-group name channels").to(:handle_mod_group) }
+  it { is_expected.to route_command("announce mod-group name channels").to(:handle_mod_group) }
+  it { is_expected.to route_command("announce del-group name").to(:handle_del_group) }
+  it { is_expected.to route_command("announce to channel message").to(:handle_announce) }
+  it { is_expected.to route_command("announce to group:group1 message").to(:handle_announce) }
+  it { is_expected.to route_command("announce to channel1,channel2 message").to(:handle_announce) }
+  it { is_expected.to route_command("announce to group:group1,group:group2 messae").to(:handle_announce) }
+  it { is_expected.to route_command("announce to group:group1,channel1,group:group2 message").to(:handle_announce) }
+
+  let(:network_group) { %w{abc fox cbs nbc} }
+  let(:premium_group) { %w{hbo showtime cinemax} }
+  let(:my_favorites) { %w{discover hbo science cbs} }
+  let(:all_channels) { [premium_group, network_group, my_favorites].flatten.uniq }
+
+  before do
+    all_channels.each { |c| Lita::Room.create_or_update(c) }
+    allow(robot.chat_service).to receive(:send_attachment) # This is provided by lita-slack
+  end
+
+  describe "list-groups" do
+    before { subject.redis.set("group:network", { channels: network_group }.to_json) }
+
+    it "returns a list of groups" do
+      send_command("announce list-groups")
+      expect(replies.last).to eql("\*network\*: #{network_group.map { |c| "##{c}" }.join(", ")}")
+    end
+  end
+
+  shared_examples_for "group channel modification validation" do
+    it "adds group to redis" do
+      send_command(command)
+      expect(subject.redis.get("group:premium")).to eql({ channels: premium_group }.to_json)
+      expect(replies.last).to eql(":successful: Announcement group 'premium' updated! Will send messages to #{premium_group.map { |c| "##{c}" }.join(", ")}")
+    end
+
+    context "when group name is invalid" do
+      let(:group) { "premium:movies" }
+
+      it "returns an error message" do
+        send_command(command)
+        expect(replies.last).to eql(":failed: '#{group}' is not a valid name. Please use only letters, numbers, and underscores.")
+      end
+    end
+
+    context "when a channel provided does not exist" do
+      let(:channels) { premium_group.push("skinemax").join(",") }
+
+      it "returns an error message" do
+        send_command(command)
+        expect(replies.last).to eql(":failed: Can not create '#{group}': the #skinemax channel does not exist.")
+      end
+    end
+
+    context "when the channel list is formatted incorrectly" do
+      let(:channels) { premium_group.join(" ") }
+
+      it "returns an error message" do
+        send_command(command)
+        expect(replies.last).to eql(":failed: Please provide channels as a comma-separated list with no spaces.")
+      end
+    end
+  end
+
+  describe "add-group" do
+    let(:group) { "premium" }
+    let(:channels) { premium_group.join(",") }
+    let(:command) { "announce add-group #{group} #{channels}" }
+
+    it_behaves_like "group channel modification validation"
+  end
+
+  describe "mod-group" do
+    let(:group) { "premium" }
+    let(:channels) { premium_group.push("starz").join(",") }
+    let(:command) { "announce mod-group #{group} #{channels}" }
+
+    before do
+      subject.redis.set("group:premium", { channels: premium_group }.to_json)
+      Lita::Room.create_or_update("starz")
+    end
+
+    it_behaves_like "group channel modification validation"
+  end
+
+  describe "del-group" do
+    let(:group) { "premium" }
+    let(:command) { "announce del-group #{group}" }
+
+    before { subject.redis.set("group:premium", { channels: premium_group }.to_json) }
+
+    it "deletes group from redis" do
+      send_command(command)
+      expect(subject.redis.get("group:#{group}")).to be_nil
+      expect(replies.last).to eql(":successful: Announcement group '#{group}' deleted.")
+    end
+
+    context "when group does not exist" do
+      let(:group) { "static-only" }
+
+      it "returns error message" do
+        send_command(command)
+        expect(replies.last).to eql(":failed: Can not delete '#{group}': does not exist.")
+      end
+    end
+  end
+
+  describe "making an announcement" do
+    let(:message) { "Everyone just watches Netflix anyways" }
+    let(:command) { "announce to #{targets} #{message}" }
+    let(:payload) do
+      {
+        author: user.name,
+        channels: expected_channels.uniq,
+        text: message,
+        timestamp: DateTime.now.to_time.to_i,
+      }
+    end
+
+    before do
+      subject.redis.set("group:premium", { channels: premium_group }.to_json)
+      subject.redis.set("group:network", { channels: network_group }.to_json)
+      subject.redis.set("group:my_favorites", { channels: my_favorites }.to_json)
+    end
+
+    shared_examples_for "an announcement" do
+      let(:expected_message) { "#{payload[:text]} - #{payload[:author]}" }
+      it "writes the message to redis" do
+        send_command(command)
+        expect(subject.redis.lpop("announcements")).to eql(payload.to_json)
+      end
+
+      it "sends message" do
+        send_command(command)
+        expect(replies.length).to eql(payload[:channels].length)
+        expect(replies.last).to eql(expected_message)
+      end
+    end
+
+    context "to a single channel" do
+      let(:targets) { "cbs" }
+      let(:expected_channels) { %w{cbs} }
+
+      it_behaves_like "an announcement"
+    end
+
+    context "to multiple channels" do
+      let(:targets) { "cbs,hbo" }
+      let(:expected_channels) { %w{cbs hbo} }
+
+      it_behaves_like "an announcement"
+    end
+
+    context "to a single group" do
+      let(:targets) { "group:premium" }
+      let(:expected_channels) { premium_group }
+
+      it_behaves_like "an announcement"
+    end
+
+    context "to multiple groups" do
+      let(:targets) { "group:premium,group:network,group:my_favorites" }
+      let(:expected_channels) { all_channels }
+
+      it_behaves_like "an announcement"
+    end
+
+    context "to a combination of groups and channels" do
+      let(:targets) { "group:premium,fox,cbs" }
+      let(:expected_channels) { premium_group.concat(%w{fox cbs}) }
+
+      it_behaves_like "an announcement"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-announce"
+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,159 @@
+--- !ruby/object:Gem::Specification
+name: lita-announce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Duffield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.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: Lita plugin to make announcements across multiple channels.
+email:
+- tom@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- dev/Gemfile
+- dev/lita_config.rb
+- lib/lita-announce.rb
+- lib/lita/handlers/announce.rb
+- lita-announce.gemspec
+- locales/en.yml
+- spec/lita/handlers/announce_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: http://github.com/tduffield/lita-announce
+licenses:
+- Apache 2.0
+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.8
+signing_key: 
+specification_version: 4
+summary: Lita plugin to make announcements across multiple channels.
+test_files:
+- spec/lita/handlers/announce_spec.rb
+- spec/spec_helper.rb