lita-queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33fd47f0ec810e138b6c4ad01136929edb6c54ac
+  data.tar.gz: bbff179f4261205af069b78e88ddbc7fd946ab87
+SHA512:
+  metadata.gz: a4dd70f59ae79592e5d0a03b2d1c8b8c514493f16952ea7ceb5ee38a2399d4550208ba492758ef3b2ca21d24973883da63747b8b52e67814a66d12a13f216180
+  data.tar.gz: 6a21b6e05bceb50fb4bf3f6fc675a6337dc7f10a5814e59f73aac45ea7574ead51b76268bd60d42d8150573b71d8b5ebb5b0a9c54402668afc8ab4389704fa5b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+We follow [Keep a Changelog](http://keepachangelog.com/) format.
+
+## 0.1.0 - 2015-06-14
+### Added
+- Initial plugin import with support for the following commands:
+  * lita queue
+  * lita queue me
+  * lita unqueue me
+  * lita queue next?
+  * lita queue next!
+- RSpec, Travis CI and Coveralls support

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gabriel Mazetto
+
+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,29 @@
+# lita-queue
+
+[![Build Status](https://travis-ci.org/brodock/lita-queue.svg?branch=master)](https://travis-ci.org/brodock/lita-queue)
+[![Coverage Status](https://coveralls.io/repos/brodock/lita-queue/badge.svg?branch=master)](https://coveralls.io/r/brodock/lita-queue)
+
+Lita handler to manage people queue per channel
+
+## Installation
+
+Add lita-queue to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-queue"
+```
+
+## Usage
+
+Manage a queue of users for any channel.
+
+The following commands are available:
+* lita queue
+* lita queue me
+* lita unqueue me
+* lita queue next?
+* lita queue next!
+
+The following commands will be available in a further version:
+* lita queue rotate!
+* lita queue = [<new_queue,comma_separated>]

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

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

data/lib/lita/handlers/queue.rb

@@ -0,0 +1,110 @@
+module Lita
+  module Handlers
+    class Queue < Handler
+
+      route(/^queue$/, :queue_list, command: :true)
+      route(/^queue me$/, :queue_me, command: :true)
+      route(/^unqueue me$/, :unqueue_me, command: :true)
+      route(/^queue next\?$/, :queue_list_next, command: :true)
+      route(/^queue next!$/, :queue_change_to_next, command: :true)
+      #route(/^queue rotate!$/, :queue_rotate, command: :true)
+      #route(/^queue = \[([^\]]*)\]\s*$$/, :queue_recreate, command: :true)
+
+      # API
+
+      def fetch_queue(room)
+        serialized = redis.get(room)
+
+        if serialized
+          JSON.parse(serialized)
+        else
+          []
+        end
+      end
+
+      def store_queue(room, queue)
+        redis.set room, queue.to_json
+      end
+
+      # Commands
+
+      def queue_list(response)
+        room = room_for(response)
+        queue = fetch_queue(room)
+
+        response.reply display_queue(queue, room)
+      end
+
+      def queue_me(response)
+        room = room_for(response)
+        queue = fetch_queue(room)
+        me = response.user.mention_name
+
+        if queue.include? me
+          response.reply "You are already on queue!"
+        else
+          queue << me
+          store_queue(room, queue)
+          response.reply "#{me} have been added to queue."
+        end
+      end
+
+      def unqueue_me(response)
+        room = room_for(response)
+        queue = fetch_queue(room)
+        me = response.user.mention_name
+
+        if queue.include? me
+          queue.delete(me)
+          store_queue(room, queue)
+          response.reply "#{me} have been removed from queue."
+        else
+          response.reply "You are not on queue!"
+        end
+      end
+
+      def queue_list_next(response)
+        room = room_for(response)
+        queue = fetch_queue(room)
+
+        if queue.empty?
+          response.reply "Queue is empty"
+        elsif queue.size == 1
+          response.reply "#{queue.first} is the last one on queue."
+        else
+          response.reply "#{queue[1]} will be the next!"
+        end
+      end
+
+      def queue_change_to_next(response)
+        room = room_for(response)
+        queue = fetch_queue(room)
+
+        unless queue.empty?
+          removed = queue.shift
+          store_queue(room, queue)
+          response.reply "#{removed} have been removed from queue"
+          response.reply "#{queue.first} is the next. Go ahead!" unless queue.empty?
+        end
+
+        response.reply display_queue(queue, room)
+      end
+
+      private
+
+      def room_for(response)
+        response.message.source.room || '--global--'
+      end
+
+      def display_queue(queue, room)
+        if queue.empty?
+          "Queue is empty"
+        else
+          "Queue for #{room}: #{queue}"
+        end
+      end
+    end
+
+    Lita.register_handler(Queue)
+  end
+end

data/lita-queue.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-queue"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Gabriel Mazetto"]
+  spec.email         = ["brodock@gmail.com"]
+  spec.description   = "Lita plugin to manage channel specific queue"
+  spec.summary       = "Lita plugin to manage channel specific queue"
+  spec.homepage      = "https://github.com/brodock/lita-queue"
+  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.3"
+
+  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"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      queue:

data/spec/lita/handlers/queue_spec.rb

@@ -0,0 +1,130 @@
+require "spec_helper"
+
+describe Lita::Handlers::Queue, lita_handler: true do
+
+  user1 = Lita::User.create(100, name: 'User 1')
+  user2 = Lita::User.create(101, name: 'User 2')
+
+  # Routes
+  it { is_expected.to route_command("queue").to(:queue_list) }
+  it { is_expected.to route_command("queue me").to(:queue_me) }
+  it { is_expected.to route_command("unqueue me").to(:unqueue_me) }
+  it { is_expected.to route_command("queue next?").to(:queue_list_next) }
+  it { is_expected.to route_command("queue next!").to(:queue_change_to_next) }
+  #it { is_expected.to route_command("queue rotate!").to(:queue_rotate) }
+  #it { is_expected.to route_command("queue = [something,here]").to(:queue_recreate) }
+
+  let(:channel) { source.room || '--global--' }
+
+  # Commands
+  describe "#queue_list" do
+    context "when queue is empty" do
+      before { subject.store_queue(channel, []) }
+      it "replies with an empty queue message" do
+        send_command("queue")
+        expect(replies.last).to include("Queue is empty")
+      end
+    end
+
+    context "when queue has elements" do
+      before { subject.store_queue(channel, [user1.mention_name, user2.mention_name]) }
+
+      it "replies with a list of queue users" do
+        send_command("queue")
+        expect(replies.last).to include(user1.mention_name, user2.mention_name)
+      end
+    end
+  end
+
+  describe "#queue_me" do
+    context "when I'm already queued" do
+      before { subject.store_queue(channel, [user.mention_name]) }
+      it "replies with an error message" do
+        send_command("queue me")
+        expect(replies.last).to include("already on queue")
+      end
+    end
+
+    context "when I'm not on queue" do
+      it "replies with a confirmation message" do
+        send_command("queue me")
+        expect(replies.last).to include("#{user.name} have been added to queue")
+        expect(subject.fetch_queue(channel)).to include(user.mention_name)
+      end
+    end
+  end
+
+  describe "#unqueue_me" do
+    context "when I'm already queued" do
+      before { subject.store_queue(channel, [user.mention_name]) }
+      it "replies with a confirmation and remove from queue" do
+        send_command("unqueue me")
+        expect(replies.last).to include("#{user.name} have been removed from queue")
+        expect(subject.fetch_queue(channel)).not_to include(user.mention_name)
+      end
+    end
+
+    context "when I'm not on queue" do
+      before { subject.store_queue(channel, []) }
+      it "replies with an error message" do
+        send_command("unqueue me")
+        expect(replies.last).to include("not on queue!")
+      end
+    end
+  end
+
+  describe "#queue_list_next" do
+    context "when queue is empty" do
+      it "replies with an error message" do
+        send_command("queue next?")
+        expect(replies.last).to include("Queue is empty")
+      end
+    end
+
+    context "when queue has only one element" do
+      before { subject.store_queue(channel, [user1.mention_name]) }
+      it "replies listing current user on queue and warning that's the last one" do
+        send_command("queue next?")
+        expect(replies.last).to include(user1.mention_name)
+        expect(replies.last).to include("is the last one on queue")
+      end
+    end
+
+    context "when queue has more than one elements" do
+      before { subject.store_queue(channel, [user1.mention_name, user2.mention_name]) }
+      it "replies listing the next one on the queue" do
+        send_command("queue next?")
+        expect(replies.last).to include(user2.mention_name)
+      end
+    end
+  end
+
+  describe "#queue_change_to_next" do
+    context "when queue is empty" do
+      it "replies with an error message" do
+        send_command("queue next!")
+        expect(replies.last).to include("Queue is empty")
+      end
+    end
+
+    context "when queue has elements" do
+      it "remove the first element and replies with current queue" do
+        subject.store_queue(channel, [user1.mention_name, user2.mention_name])
+
+        send_command("queue next!")
+        expect(replies.first).to include("#{user1.mention_name} have been removed from queue")
+        expect(replies[1]).to include("#{user2.mention_name} is the next")
+        expect(replies.last).to include(user2.mention_name)
+        expect(replies.last).not_to include(user1.mention_name)
+      end
+
+      it "replies with a notification message when removing the last element from queue" do
+        subject.store_queue(channel, [user2.mention_name])
+
+        send_command("queue next!")
+        expect(replies.first).to include("#{user2.mention_name} have been removed from queue")
+        expect(replies.last).to include("Queue is empty")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-queue"
+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,173 @@
+--- !ruby/object:Gem::Specification
+name: lita-queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Mazetto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !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
+- !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'
+description: Lita plugin to manage channel specific queue
+email:
+- brodock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-queue.rb
+- lib/lita/handlers/queue.rb
+- lita-queue.gemspec
+- locales/en.yml
+- spec/lita/handlers/queue_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/brodock/lita-queue
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Lita plugin to manage channel specific queue
+test_files:
+- spec/lita/handlers/queue_spec.rb
+- spec/spec_helper.rb