lita-hush 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9f0d924e27a9eda4548bd3c77a83516d94edf83
+  data.tar.gz: e5f2ec63674d46da2ffce2e86c07448667f6215a
+SHA512:
+  metadata.gz: 47c678fca712d15a804a344c8fb8c6d3a8cae234eb21f747ced39c62b4d1ed6246f98432c10302a0dced37303b5b4f194cd0eb6cf76ec5abf8fa5544f363f979
+  data.tar.gz: 72cb74b7fdad8b79d594589640c2f7ea966bbfd6dcb1f36833c91bf0de30cf813a60a924812e4ba911bb4ba6e2d47b2235d2ed0814db3824be09f533c12b9af7

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/.rspec

@@ -0,0 +1 @@
+--color --profile 5

data/.rubocop.yml

@@ -0,0 +1,10 @@
+ClassLength:
+  Max: 150
+
+Documentation:
+  Exclude:
+    - lib/lita/handlers/hush.rb
+
+FileName:
+  Exclude:
+    - lib/lita-hush.rb

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,55 @@
+# lita-hush
+
+[![Build Status](https://img.shields.io/travis/esigler/lita-hush/master.svg)](https://travis-ci.org/esigler/lita-hush)
+[![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://tldrlegal.com/license/mit-license)
+[![RubyGems](http://img.shields.io/gem/v/lita-hush.svg)](https://rubygems.org/gems/lita-hush)
+[![Coveralls Coverage](https://img.shields.io/coveralls/esigler/lita-hush/master.svg)](https://coveralls.io/r/esigler/lita-hush)
+[![Code Climate](https://img.shields.io/codeclimate/github/esigler/lita-hush.svg)](https://codeclimate.com/github/esigler/lita-hush)
+[![Gemnasium](https://img.shields.io/gemnasium/esigler/lita-hush.svg)](https://gemnasium.com/esigler/lita-hush)
+
+A room moderation plugin for Lita.
+
+## Installation
+
+Add lita-hush to your Lita instance's Gemfile:
+
+``` ruby
+gem 'lita-hush'
+```
+
+## Configuration
+
+There are no Lita configuration file entries needed.
+
+## Usage
+
+### Example
+
+```
+@alice in quiet_room> Lita room add @alice
+@alice in quiet_room> Lita room moderation on
+@Lita in quiet_room> Room now moderated
+@alice in quiet_room> Peace and quiet!
+@bob in quiet_room> Hello world!
+@Lita PM to @bob> quiet_room is a moderated room
+```
+
+### Adding / Removing Someone
+
+```
+room add @user
+room remove @user
+```
+
+### Moderating / Unmoderating a Room
+
+```
+room moderation on # Automatically adds requestor to approved list
+room moderation off
+```
+
+### Status
+
+```
+room status
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/lib/lita-hush.rb

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

data/lib/lita/handlers/hush.rb

@@ -0,0 +1,129 @@
+module Lita
+  module Handlers
+    class Hush < Handler
+      # NOTE: I don't like using catchall matchers.  Is there a cleaner way?
+      route(
+        /.*/,
+        :ambient,
+        command: false
+      )
+
+      route(
+        /^room\s(add|remove)\s(?<user>.*)$/,
+        :voice,
+        command: true,
+        help: {
+          t('help.voice.syntax') => t('help.voice.desc')
+        }
+      )
+
+      route(
+        /^room\smoderation\s(?<toggle>(on|off))$/,
+        :moderate,
+        command: true,
+        help: {
+          t('help.moderate.syntax') => t('help.moderate.desc')
+        }
+      )
+
+      route(
+        /^room\sstatus$/,
+        :status,
+        command: true,
+        help: {
+          t('help.status.syntax') => t('help.status.desc')
+        }
+      )
+
+      def ambient(response)
+        src = response.message.source
+        return unless room_moderated?(src.room)
+        return if user_has_voice?(src.room, src.user)
+        return if response.message.body == 'room status'
+
+        response.reply_privately(t('ambient.pm', room: src.room_object.name))
+        # NOTE: This is the nuclear option, I'd like to give a ramp up at least?
+        # response.reply("/kick #{robot.mention_format(src.user)}")
+      end
+
+      def moderate(response)
+        src = response.message.source
+
+        action = if response.match_data['toggle'] == 'on'
+                   moderate_room(src.room)
+                   give_voice(src.room, src.user)
+                   'moderated'
+                 else
+                   unmoderate_room(src.room)
+                   'unmoderated'
+                 end
+
+        response.reply(t('moderation.complete', action: action))
+      end
+
+      def status(response)
+        src = response.message.source
+        state = room_moderated?(src.room) ? 'moderated' : 'unmoderated'
+
+        response.reply(t('status.overview', state: state))
+      end
+
+      def voice(response)
+        src = response.message.source
+        user = Lita::User.fuzzy_find(response.match_data['user'])
+        return response.reply(t('error.nouser')) unless user
+
+        action = toggle_voice(src.room, user) ? 'added to' : 'removed from'
+
+        response.reply(t('voice.complete',
+                         user: user.name,
+                         room: src.room_object.name,
+                         action: action))
+      end
+
+      private
+
+      def give_voice(room, user)
+        return if room.nil? || user.nil?
+        redis.sadd("voice_list_#{room}", user.id)
+      end
+
+      def moderate_room(room)
+        return if room.nil?
+        redis.sadd('moderated_rooms', room)
+      end
+
+      def room_moderated?(room)
+        return false if room.nil?
+        redis.sismember('moderated_rooms', room)
+      end
+
+      def take_voice(room, user)
+        return if room.nil? || user.nil?
+        redis.srem("voice_list_#{room}", user.id)
+      end
+
+      def toggle_voice(room, user)
+        if user_has_voice?(room, user)
+          take_voice(room, user)
+          false
+        else
+          give_voice(room, user)
+          true
+        end
+      end
+
+      def unmoderate_room(room)
+        return if room.nil?
+        redis.srem('moderated_rooms', room)
+      end
+
+      def user_has_voice?(room, user)
+        return false if room.nil? || user.nil?
+        redis.sismember("voice_list_#{room}", user.id)
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-hush.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-hush'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Eric Sigler']
+  spec.email         = ['me@esigler.com']
+  spec.description   = 'A room moderation plugin for Lita'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/esigler/lita-hush'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'coveralls'
+  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'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+end

data/locales/en.yml

@@ -0,0 +1,24 @@
+en:
+  lita:
+    handlers:
+      hush:
+        ambient:
+          pm: "%{room} is a moderated room"
+        error:
+          nouser: "That user was not found"
+        help:
+          voice:
+            syntax: room (add|remove) @user
+            desc: "Add or remove <user> to room's moderation list"
+          moderate:
+            syntax: room moderation (on|off)
+            desc: Room participants not on the moderation list will be privately messaged
+          status:
+            syntax: room status
+            desc: Shows current moderation status
+        moderation:
+          complete: Room now %{action}
+        status:
+          overview: "Room is %{state}"
+        voice:
+          complete: "%{user} %{action} %{room} list"

data/spec/lita/handlers/hush_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+def verify_hush(occurred)
+  expect(replies.include?('quiet_room is a moderated room')).to eq(occurred)
+end
+
+describe Lita::Handlers::Hush, lita_handler: true do
+  it { is_expected.to route('anything').to(:ambient) }
+  it { is_expected.to route_command('room add @foo').to(:voice) }
+  it { is_expected.to route_command('room remove @foo').to(:voice) }
+  it { is_expected.to route_command('room status').to(:status) }
+  it { is_expected.to route_command('room moderation on').to(:moderate) }
+  it { is_expected.to route_command('room moderation off').to(:moderate) }
+
+  let(:alice) do
+    Lita::User.create(123, name: 'Alice', mention_name: 'alice')
+  end
+
+  let(:bob) do
+    Lita::User.create(456, name: 'Bob', mention_name: 'bob')
+  end
+
+  let(:quiet_room) do
+    Lita::Room.new(1, name: 'quiet_room')
+  end
+
+  let(:loud_room) do
+    Lita::Room.new(2, name: 'loud_room')
+  end
+
+  before do
+    send_command('room moderation on', as: alice, from: quiet_room)
+  end
+
+  describe '#add' do
+    it 'adds a user to that rooms list' do
+      Lita::User.create(456, name: 'Bob', mention_name: 'bob')
+      send_command('room add bob', as: alice, from: quiet_room)
+      expect(replies.last).to eq('Bob added to quiet_room list')
+    end
+  end
+
+  describe '#ambient' do
+    it 'does nothing in rooms that it is not configured for' do
+      send_message('foo', as: alice, from: loud_room)
+      send_message('foo', as: bob, from: loud_room)
+      verify_hush(false)
+    end
+
+    it 'allows people on a list to speak' do
+      send_message('foo', as: alice, from: quiet_room)
+      verify_hush(false)
+    end
+
+    it 'sends a message to people not on a list when they speak' do
+      send_message('bar', as: bob, from: quiet_room)
+      verify_hush(true)
+    end
+  end
+
+  describe '#remove' do
+    it 'removes a user from that rooms list' do
+      send_command('room remove alice', as: alice, from: quiet_room)
+      expect(replies.last).to eq('Alice removed from quiet_room list')
+    end
+  end
+
+  describe '#status' do
+    it 'describes the current moderation status of the room' do
+      send_command('room status', as: alice, from: quiet_room)
+      expect(replies.last).to eq('Room is moderated')
+      send_command('room status', as: alice, from: loud_room)
+      expect(replies.last).to eq('Room is unmoderated')
+    end
+
+    it 'does not PM if an unapproved user asks in a moderated room' do
+      send_command('room status', as: bob, from: quiet_room)
+      expect(replies.last).to eq('Room is moderated')
+      verify_hush(false)
+    end
+  end
+
+  describe '#unmoderate' do
+    it 'unmoderates a moderated room' do
+      send_command('room moderation off', from: quiet_room)
+      expect(replies.last).to eq('Room now unmoderated')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter '/spec/' }
+
+require 'lita-hush'
+require 'lita/rspec'
+
+Lita.version_3_compatibility_mode = false
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: lita-hush
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Sigler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-14 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: 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: 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: 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
+- !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'
+- !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'
+description: A room moderation plugin for Lita
+email:
+- me@esigler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-hush.rb
+- lib/lita/handlers/hush.rb
+- lita-hush.gemspec
+- locales/en.yml
+- spec/lita/handlers/hush_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/esigler/lita-hush
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A room moderation plugin for Lita
+test_files:
+- spec/lita/handlers/hush_spec.rb
+- spec/spec_helper.rb