lita-group-mention 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97fbc674c3408e504bec402d173c811da7d3309d
+  data.tar.gz: 200da6b42de94d5b7f94c42a3606f152eff89f5c
+SHA512:
+  metadata.gz: 18851940178cd49ba2f38e57553a28f8800727c3ce12ca00aafef4580d180b9a7ddcd2393a2b5349ab39b8ad2ebe496036f7130c3be101504c091c31db68b56a
+  data.tar.gz: eaff5ea8a29843bf1ad62cdb194e1544884b2a32277ec04137986d520a0abf45915e326a3c1ff2147b6d55514a34bccd61add20e65b8eae73a84a557e57e8b81

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/*
+*.sw*

data/.rubocop.yml

@@ -0,0 +1,8 @@
+ClassLength:
+  Max: 120
+
+FileName:
+  Enabled: false
+
+LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,11 @@
+cache:
+- bundler
+language: ruby
+rvm:
+  - 2.2.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server
+sudo: false

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Ben House
+
+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,44 @@
+# lita-group-mention
+
+[![Build Status](https://travis-ci.org/bhouse/lita-group-mention.svg?branch=master)](https://travis-ci.org/bhouse/lita-group-mention)
+[![Coverage Status](https://coveralls.io/repos/bhouse/lita-group-mention/badge.svg?branch=master)](https://coveralls.io/r/bhouse/lita-group-mention?branch=master)
+
+## Installation
+
+Add lita-group-mention to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-group-mention"
+```
+
+## Usage
+
+This plugin will monitor messages for mentions of groups, and expand the group
+to mention a list of each user in that group. Groups are stored in redis, and
+configured with commands.
+
+```shell
+Larry: Lita group mention add moe to ops
+Lita: Added @moe to ops
+Larry: Lita group mention add curly to dev
+Lita: Added @curly to dev
+Larry: Good morning @ops and @dev
+Lita: cc @moe, @curly
+```
+
+```shell
+Larry: Lita group mention show groups
+Lita: ops: moe
+      dev: curly
+Larry: Lita group mention remove group ops
+Lita: Removed the ops group
+Larry: group mention show user curly
+Lita: curly: dev
+Larry: group mention show user moe
+Lita: moe:
+```
+
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'bump/tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = true
+end
+
+task default: [:rubocop, :spec]

data/lib/lita-group-mention.rb

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

data/lib/lita/handlers/group_mention.rb

@@ -0,0 +1,143 @@
+module Lita
+  # Lita Handler module
+  module Handlers
+    # GroupMention handler class
+    class GroupMention < Handler
+      route(/@(\w+)+/, :group_mention)
+      route(
+        /^group\s+mention\s+add\s+@?(?<user>\w+)\s+to\s+@?(?<group>\w+)/,
+        :add_member,
+        command: true,
+        help: {
+          t('help.add_user_key') => t('help.add_user_value')
+        }
+      )
+      route(
+        /^group\s+mention\s+remove\s+@?(?<user>\w+)\s+from\s+@?(?<group>\w+)/,
+        :remove_member,
+        command: true,
+        help: {
+          t('help.remove_user_key') => t('help.remove_user_value')
+        }
+      )
+      route(
+        /^group\s+mention\s+remove\s+group\s+@?(?<group>\w+)/,
+        :remove_group,
+        command: true,
+        help: {
+          t('help.remove_group_key') => t('help.remove_group_value')
+        }
+      )
+      route(
+        /^group\s+mention\s+show\s+groups$/,
+        :show_groups,
+        command: true,
+        help: {
+          t('help.show_groups_key') => t('help.show_groups_value')
+        }
+      )
+      route(
+        /^group\s+mention\s+show\s+group\s+@?(?<group>\w+)/,
+        :show_group,
+        command: true,
+        help: {
+          t('help.show_group_key') => t('help.show_group_value')
+        }
+      )
+      route(
+        /^group\s+mention\s+show\s+user\s+@?(?<user>\w+)/,
+        :show_user,
+        command: true,
+        help: {
+          t('help.show_user_key') => t('help.show_user_value')
+        }
+      )
+
+      def group_mention(response) # rubocop:disable AbcSize
+        return if response.message.body =~ /group\s+mention/
+        groups = response.matches.flatten
+
+        groups.each do |g|
+          groups.delete(g) unless redis_groups.keys.include?(g)
+        end
+        return if groups.empty?
+
+        response.reply(t('mention.cc') + union_members(groups))
+      end
+
+      def add_member(response)
+        group = response.match_data['group']
+        user = response.match_data['user']
+        redis.sadd("user:#{user}", group)
+        redis.sadd("group:#{group}", user)
+        response.reply(t('add_member', user: user, group: group))
+      end
+
+      def remove_member(response)
+        group = response.match_data['group']
+        user = response.match_data['user']
+        redis.srem("user:#{user}", group)
+        redis.srem("group:#{group}", user)
+        response.reply(t('remove_member', user: user, group: group))
+      end
+
+      def remove_group(response)
+        group = response.match_data['group']
+        members = redis.smembers("group:#{group}")
+        members.each do |user|
+          redis.srem("user:#{user}", group)
+        end
+
+        redis.del("group:#{group}")
+        response.reply(t('remove_group', group: group))
+      end
+
+      def show_groups(response)
+        group_list = []
+        redis_groups.each do |group, members|
+          group_list << "#{group}: #{members.join(', ')}"
+        end
+        response.reply(group_list.join("\n"))
+      end
+
+      def show_group(response)
+        group = response.match_data['group']
+
+        unless redis_groups.key?(group)
+          response.reply(t('group_does_not_exist', group: group))
+          return
+        end
+
+        members = redis_groups[group]
+        formatted_group = "#{group}: #{members.join(', ')}"
+        response.reply(formatted_group)
+      end
+
+      def show_user(response)
+        user = response.match_data['user']
+        response.reply("#{user}: #{get_user_memberships(user).join(', ')}")
+      end
+
+      private
+
+      def redis_groups
+        @groups ||= {}
+        redis.keys('group:*').each do |group|
+          @groups[group.split(':')[-1]] = redis.smembers(group)
+        end
+        @groups
+      end
+
+      def get_user_memberships(user)
+        redis.smembers("user:#{user}")
+      end
+
+      def union_members(groups)
+        groups = groups.map { |g| "group:#{g}" }
+        redis.sunion(groups).sort.map { |m| "@#{m}" }.join(', ')
+      end
+    end
+
+    Lita.register_handler(GroupMention)
+  end
+end

data/lita-group-mention.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-group-mention'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Ben House']
+  spec.email         = ['ben@benhouse.io']
+  spec.description   = %w(cc a list of users when a group is @mentioned)
+  spec.summary       = %w(add users to a group, @mention the group, and the plugin will cc each user)
+  spec.homepage      = 'https://github.com/bhouse/lita-group-mention'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'lita', '>= 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'bump'
+  spec.add_development_dependency 'rubocop'
+end

data/locales/en.yml

@@ -0,0 +1,23 @@
+en:
+  lita:
+    handlers:
+      group_mention:
+        add_member: 'Added @%{user} to %{group}'
+        group_does_not_exist: '%{group} does not exist'
+        help:
+          add_user_key: 'group mention add <user> to <group>'
+          add_user_value: '@mention <user> when <group> is mentioned'
+          remove_group_key: 'group mention remove group <group>'
+          remove_group_value: 'remove the mention group completely'
+          remove_user_key: 'group mention remove <user> from <group>'
+          remove_user_value: 'remove <user> from list of mentions for <group>'
+          show_group_key: 'group mention show group <group>'
+          show_group_value: 'show users for <group>'
+          show_groups_key: 'group mention show groups'
+          show_groups_value: 'show all the groups and their users'
+          show_user_key: 'group mention show user <user>'
+          show_user_value: 'show all the groups <user> is a member of'
+        mention:
+          cc: 'cc '
+        remove_group: 'Removed the %{group} group'
+        remove_member: 'Removed @%{user} from %{group}'

data/spec/lita/handlers/group_mention_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+shared_examples 'commands' do
+  before(:each) do
+    redis_connection.flushdb
+  end
+
+  it 'adds a user to a group' do
+    send_command("group mention add #{command_user} to #{command_group}")
+    expect(replies.last).to eq("Added @#{chat_user} to #{chat_group}")
+    expect(redis.smembers("group:#{chat_group}")).to include(chat_user)
+    expect(redis.smembers("user:#{chat_user}")).to include(chat_group)
+  end
+
+  it 'removes a user from a group' do
+    redis.sadd("group:#{chat_group}", chat_user)
+    redis.sadd("user:#{chat_user}", chat_group)
+
+    send_command("group mention remove #{command_user} from #{command_group}")
+
+    expect(replies.last).to eq(
+      "Removed @#{chat_user} from #{chat_group}"
+    )
+    expect(
+      redis.smembers("group:#{chat_group}")
+    ).not_to include(chat_user)
+    expect(
+      redis.smembers("user:#{chat_user}")
+    ).not_to include(chat_group)
+  end
+
+  it 'removes a group' do
+    redis.sadd("group:#{chat_group}", chat_user)
+    redis.sadd("user:#{chat_user}", chat_group)
+    redis.sadd("user:#{chat_user}", 'foo')
+
+    send_command("group mention remove group #{command_group}")
+
+    expect(replies.last).to eq("Removed the #{chat_group} group")
+    expect(redis.smembers("user:#{chat_user}")).to eq(['foo'])
+    expect(redis.smembers("group:#{chat_group}")).to be_empty
+  end
+
+  it 'shows all the groups' do
+    redis.sadd("group:#{chat_group}", chat_user)
+
+    send_command('group mention show groups')
+    expect(replies.last).to eq("#{chat_group}: #{chat_user}")
+  end
+
+  it 'show that a group does not exist' do
+    send_command('group mention show group baz')
+    expect(replies.last).to eq('baz does not exist')
+  end
+
+  it 'shows a specific group' do
+    redis.sadd("group:#{chat_group}", chat_user)
+
+    send_command("group mention show group #{command_group}")
+    expect(replies.last).to eq("#{chat_group}: #{chat_user}")
+  end
+
+  it 'shows the groups a user is a member of' do
+    redis.sadd("user:#{chat_user}", chat_group)
+
+    send_command("group mention show user #{command_user}")
+    expect(replies.last).to eq("#{chat_user}: #{chat_group}")
+  end
+end
+
+describe Lita::Handlers::GroupMention, lita_handler: true do
+  before(:each) do
+    redis_connection.flushdb
+  end
+
+  after do
+    redis_connection.flushdb
+  end
+
+  let(:redis_namespace) { 'lita.test:handlers:group_mention' }
+  let(:redis_connection) do
+    Redis::Namespace.new(redis_namespace, redis: Redis.new)
+  end
+
+  context 'commands sent without @ mentions' do
+    include_examples 'commands' do
+      let(:redis) { redis_connection }
+      let(:chat_user) { 'test_user1' }
+      let(:chat_group) { 'test_group1' }
+      let(:command_user) { chat_user }
+      let(:command_group) { chat_group }
+    end
+  end
+
+  context 'commands sent with @ mentions' do
+    include_examples 'commands' do
+      let(:redis) { redis_connection }
+      let(:chat_user) { 'test_user1' }
+      let(:chat_group) { 'test_group1' }
+      let(:command_user) { '@' + chat_user }
+      let(:command_group) { '@' + chat_group }
+    end
+  end
+
+  context 'sending a message with a group mention' do
+    it 'expands the group mention to mention a list of users' do
+      redis_connection.sadd('group:group1', 'user1')
+      redis_connection.sadd('group:group1', 'user2')
+
+      send_message('Hello @group1')
+
+      expect(replies.last).to eq('cc @user1, @user2')
+    end
+  end
+
+  context 'sending a message with multiple group mentions' do
+    it 'expands all groups and joins their members in the mention' do
+      %w(10 11 12).each do |n|
+        redis_connection.sadd('group:group1', "user#{n}")
+      end
+      redis_connection.sadd('group:group2', 'user20')
+      redis_connection.sadd('group:group2', 'user21')
+      redis_connection.sadd('group:group2', 'user10')
+
+      send_message('Hello @group1 and @group2')
+
+      expect(replies.last).to eq(
+        'cc @user10, @user11, @user12, @user20, @user21'
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter '/spec/' }
+
+require 'lita-group-mention'
+require 'lita/rspec'
+
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: lita-group-mention
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben House
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: 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
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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: bump
+  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: rubocop
+  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'
+description: '["cc", "a", "list", "of", "users", "when", "a", "group", "is", "@mentioned"]'
+email:
+- ben@benhouse.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-group-mention.rb
+- lib/lita/handlers/group_mention.rb
+- lita-group-mention.gemspec
+- locales/en.yml
+- spec/lita/handlers/group_mention_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bhouse/lita-group-mention
+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.2.2
+signing_key: 
+specification_version: 4
+summary: '["add", "users", "to", "a", "group,", "@mention", "the", "group,", "and",
+  "the", "plugin", "will", "cc", "each", "user"]'
+test_files:
+- spec/lita/handlers/group_mention_spec.rb
+- spec/spec_helper.rb