lita-resistance 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e185d4c35a4675f50a74b0dc7cb6bcc1c5904777
-  data.tar.gz: 2722685943a3e76e24046df7b5963487264aa044
+  metadata.gz: 4363c72dc88d6f40ca3ab0d35797401f1c556852
+  data.tar.gz: 7d4cd10706c1e6180c44506a6e47a5b4ae310d4d
 SHA512:
-  metadata.gz: 3aa2752e5bad07a5813181ed3d758d1f0de9b6c1d4417b3163e159af928c8948a8994babb273fca6e1acc7acc4e20277a28d552a8b5a4e049dd2511d69d4fca4
-  data.tar.gz: c89c5153407acdd28053ce8365788aac102d2b66629bba256e38d054c3a631e23377733bf3a63f19af83f2bb24d79641cfe65bfc49488af59cce8b843d778969
+  metadata.gz: 469066210687fa7d82e1a7ba7ede2e51a878a557f83506d04d611b78c02d2f7b8214f7401c1f22630d5314270009565b55facab225ade8cf9bd1010ee1831d5b
+  data.tar.gz: 0d299ad027f0f07813fb61b092dcd88550d8fe0b9b2ea84a6cb4556ed849eed59e575f2f358bfbb323eb032a8a10c4f01565cf0fecfff36dd123dae9c3d848f4

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.org/DeonHua/lita-resistance.svg?branch=master)](https://travis-ci.org/DeonHua/lita-resistance)
 [![Gem Version](https://badge.fury.io/rb/lita-resistance.svg)](https://badge.fury.io/rb/lita-resistance)
+[![Coverage Status](https://coveralls.io/repos/DeonHua/lita-resistance/badge.svg?branch=master&service=github)](https://coveralls.io/github/DeonHua/lita-resistance?branch=master)
+[![Code Climate](https://codeclimate.com/github/DeonHua/lita-resistance/badges/gpa.svg)](https://codeclimate.com/github/DeonHua/lita-resistance)
 
 Plays a game of resistance by assigning roles to users you mention in chat.
 
@@ -15,18 +17,48 @@ gem "lita-resistance"
 
 ## Usage
 
-`lita resistance [users]` - Assigns the roles of spy/resistance to users you mention.
+`lita resistance help` - Provides detailed help (this readme file)
 
-### Examples
+`lita resistance N [users]` - Assigns the roles of spy/resistance to users you mention, with no special characters.
 
-`lita resistance @player1 @player2 @player3 @player4 @player5`
+`lita resistance [CBSAFD] [users]` - Assigns special characters to the users mentioned, the remainder (if any) will receive 'vanilla' spy/resistance roles. 
+
+### Special Characters
+**Note:** The number of special characters chosen for each team must be less than the number of characters on that team. 
+
+The number of spies is always (Players + 2)/3 **rounded down**. 
+
+#### Resistance (Good)
+Commander (**C**) - Knows all spies except Deep Cover.
+
+Body Guard (**B**) - Knows Commander and False Commander.
+
+#### Spies (Bad)
+
+Blind Spy (**S**) - Doesn't know the other spies. The other spies don't know Blind Spy.
+
+Assassin (**A**) - If Resistance successfully completes 3 missions, Assassin can guess Commander. If Assassin is correct, Spies win.
+
+False Commander (**F**) - Appears as Commander to Bodyguard.
+
+Deep Cover (**D**) - Does not appear as spy to Commander. If played with Commander and without Assassin, can take Assassin's role. 
+
+### Examples (No Special Characters)
+
+`lita resistance N @player1 @player2 @player3 @player4 @player5`
 
 You don't need to include the `@` symbol:
 
-`lita resistance player1 player2 player3 player4 player5`
+`lita resistance N player1 player2 player3 player4 player5`
 
 You can also do a combination of both:
 
-`lita resistance @player1 @player2 player3 player4 player5`
+`lita resistance N @player1 @player2 player3 player4 player5`
+
+#### Special Characters
+
+Assigns Assassin and Commander:
+
+`lita resistance CA @player1 @player2 @player3 @player4 @player5`
 
-[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)

data/lib/lita/handlers/resistance.rb

@@ -2,26 +2,56 @@ module Lita
   module Handlers
     class Resistance < Handler
 
-      route(/resistance .+/, :play, command: true, help: {'resistance [users]' => 'Starts a game of resistance with the people you mention.'})
-      def play(response)
-        all_users = response.args.uniq
+      route(/resistance help/, :help, command: true, help: {'resistance help' => 'Provides detailed help with Resistance commands.'})
 
-        if all_users.length < 5
-          response.reply('You need at least 5 players for Resistance.')
-          return
-        elsif all_users.length > 10
-          response.reply('You cannot play a game of Resistance with more than 10 players.')
-          return
-        end
+      route(/resistance [NCBSAFD]+ .+/, :play, command: true, help: {'resistance N|[CBSAFD] [users]' => 'Starts a game of resistance with the people you mention.'})
 
-        # Remove any "@" from usernames
-        all_users.map! {|username|
+      def help (response)
+        response.reply(render_template("help"))
+      end
+
+      # Remove any "@" from usernames
+      def normalize_input! (all_users)
+        all_users.map! do |username|
           if username[0] == '@'
-            username = username[1, username.length-1]
+            username[1, username.length-1]
           else
-            username = username
+            username
           end
-        }
+        end
+      end
+
+      def verify_characters (characters)
+        if characters != characters.uniq
+          raise 'You cannot have more than one of the same character.'
+        end
+
+        if characters.include?('N') && characters.length > 1
+          raise 'You cannot include special characters with N.'
+        end
+
+        # Num of Special Characters on spies doesn't exceed num of spies
+        if !characters.include?('N') && (characters - ['C', 'B']).length > @num_spies
+          raise 'You cannot have more special characters on spies than the number of spies.'
+        end
+      end
+
+      def validate_input (response)
+        input_args = response.args.uniq
+        @characters = input_args[0].split(//)
+        all_users = input_args[1, input_args.length - 1] # User mention_names
+
+        if all_users.length < 5
+          raise 'You need at least 5 players for Resistance.'
+        elsif all_users.length > 10
+          raise 'You cannot play a game of Resistance with more than 10 players.'
+        end
+
+        @num_spies = (all_users.length + 2) / 3
+
+        verify_characters(@characters)
+
+        normalize_input!(all_users)
 
         # Ensure all people are users.
         unknown_users = []
@@ -31,40 +61,89 @@ module Lita
         end
 
         if unknown_users.any?
-          response.reply('The following are not users. Please check your spelling and try again.')
-          unknown_users.each do |user|
-            response.reply(user)
-          end and return
+          raise "The following are not users: @#{unknown_users.join(' @')}"
         end
 
-        gameId = rand(999999)
+        all_users
+      end
 
-        # Form teams
-        spies = all_users.sample((all_users.length+2)/3)
-        resistance = all_users - spies
+      def assign_spies (spies)
+        spy_specials = {}
+        if @characters.include?('D')
+          spy_specials[:deep_cover] = spies.sample
+        end
+
+        if @characters.include?('F')
+          spy_specials[:false_commander] = (spies - spy_specials.values).sample
+        end
+
+        if @characters.include?('B')
+          spy_specials[:blind_spy] = (spies - spy_specials.values).sample
+        end
+
+        if @characters.include?('A')
+          spy_specials[:assassin] = (spies - spy_specials.values).sample
+        end
 
         spies.each do |member|
           user = Lita::User.find_by_mention_name(member)
-          current_user = Source.new(user: user)
-          robot.send_message(current_user,"@#{response.user.mention_name} has started game ID ##{gameId} of Resistance. You are a member of the spies.")
-          other_spies = spies.dup
-          other_spies.delete_at(other_spies.find_index(member))
-          if other_spies.length > 1
-            robot.send_message(current_user, "The other spies are: @#{other_spies.join(' @')}")
-          else
-            robot.send_message(current_user, "The other spy is: @#{other_spies[0]}")
-          end
+          other_spies = spies.dup - [spy_specials[:blind_spy], member] # Don't mention Blind Spy or self
+          robot.send_message(Source.new(user: user),
+                             render_template('spy', { spy_specials: spy_specials,
+                                                      other_spies: other_spies,
+                                                      member: member,
+                                                      starter: @starter,
+                                                      game_id: @game_id }))
+        end
+        spy_specials
+      end
+
+      def assign_resistance (resistance, spies, spy_specials)
+        if @characters.include?('C')
+          commander = resistance.sample
+          commander_visible = spies - [spy_specials[:deep_cover]]
+        end
+
+        if @characters.include?('B')
+          bodyguard = (resistance - [commander]).sample
+          bodyguard_visible = [commander, spy_specials[:false_commander]].shuffle.compact
         end
 
         resistance.each do |member|
           user = Lita::User.find_by_mention_name(member)
-          robot.send_message(Source.new(user: user), "@#{response.user.mention_name} has started game ID ##{gameId} of Resistance. You are a member of the resistance.")
+          robot.send_message(Source.new(user: user),
+                             render_template("resistance", { commander: commander,
+                                                             bodyguard: bodyguard,
+                                                             bodyguard_visible: bodyguard_visible,
+                                                             commander_visible: commander_visible,
+                                                             member: member,
+                                                             starter: @starter,
+                                                             game_id: @game_id,
+                                                             spy_specials: spy_specials }))
+
+        end
+      end
+
+      def play(response)
+        begin
+          all_users = validate_input(response)
+        rescue StandardError => error
+          response.reply(error.to_s) and return
         end
 
-        leader = all_users.sample(1)[0] # Randomly pick a leader for the first round 
-        response.reply("Roles have been assigned to the selected people! This is game ID ##{gameId}. @#{leader} will be leading off the first round.")
+        @game_id = rand(999999)
+        @starter = response.user.mention_name # Person who started the game
+        # Form teams
+        spies = all_users.sample(@num_spies)
+        resistance = all_users - spies
+
+        spy_specials = assign_spies(spies)
+        assign_resistance(resistance, spies, spy_specials)
+
+        leader = all_users.sample # Randomly pick a leader for the first round
+        response.reply("Roles have been assigned to the selected people! This is game ID ##{@game_id}. @#{leader} will be leading off the first round.")
       end
-      
+
       Lita.register_handler(self)
     end
   end

data/lita-resistance.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-resistance"
-  spec.version       = "0.2.2"
+  spec.version       = "1.0.0"
   spec.authors       = ["Deon Hua", "Yu Chen Hou"]
   spec.email         = ["deonhbci@gmail.com", "me@yuchen.io"]
   spec.description   = "Plays a game of resistance by assigning roles to users you mention in chat."

data/spec/lita/handlers/resistance_spec.rb

@@ -1,4 +1,88 @@
 require "spec_helper"
 
 describe Lita::Handlers::Resistance, lita_handler: true do
+  before(:each) do
+    a = Lita::User.create(1, {name: 'a', mention_name: 'a'})
+    b = Lita::User.create(2, {name: 'b', mention_name: 'b'})
+    c = Lita::User.create(3, {name: 'c', mention_name: 'c'})
+    d = Lita::User.create(4, {name: 'd', mention_name: 'd'})
+    e = Lita::User.create(5, {name: 'e', mention_name: 'e'})
+  end
+
+  describe "help" do
+    it "should provide help" do
+      send_command('resistance help')
+      expect(replies.last).to include('Commands:') # First line
+    end
+  end
+
+  describe "with no special characters" do
+    it 'should not start a game with more than 10 players' do
+      f = Lita::User.create(6, {name: 'f', mention_name: 'f'})
+      g = Lita::User.create(7, {name: 'g', mention_name: 'g'})
+      h = Lita::User.create(8, {name: 'h', mention_name: 'h'})
+      i = Lita::User.create(9, {name: 'i', mention_name: 'i'})
+      j = Lita::User.create(10, {name: 'j', mention_name: 'j'})
+      k = Lita::User.create(11, {name: 'k', mention_name: 'k'})
+
+      send_command('resistance N a b c d e f g h i j k')
+      expect(replies.last).to eq('You cannot play a game of Resistance with more than 10 players.')
+    end
+
+    it 'should not start a game with unknown users' do
+      send_command('resistance N a b c d @e f')
+      expect(replies.last).to eq('The following are not users: @f')
+    end
+
+    it 'should start a game with 5 players' do
+      send_command('resistance N a b c d @e')
+      expect(replies.last).to include('Roles have been assigned to the selected people!')
+    end
+
+    it 'should start a game with 7 players' do
+      f = Lita::User.create(6, {name: 'f', mention_name: 'f'})
+      g = Lita::User.create(7, {name: 'g', mention_name: 'g'})
+      send_command('resistance N a b c d e f g')
+      expect(replies.last).to include('Roles have been assigned to the selected people!')
+    end
+
+    it 'should not start a game with less than 5 players' do
+      send_command('resistance N a b c d')
+      expect(replies.last).to eq('You need at least 5 players for Resistance.')
+    end
+
+    it 'should not start a game with 2 Ns' do
+      send_command('resistance NN a b c d @e')
+      expect(replies.last).to eq('You cannot have more than one of the same character.')
+    end
+  end
+
+  describe "with special characters" do
+    it 'should not start a game with multiple of the same character' do
+      send_command('resistance CC a b c d @e')
+      expect(replies.last).to eq('You cannot have more than one of the same character.')
+    end
+
+    it 'should not start a game with a special character and N' do
+      send_command('resistance NC a b c d @e')
+      expect(replies.last).to eq('You cannot include special characters with N.')
+    end
+
+    it 'should not start a game with more special spies than spies' do
+      send_command('resistance ADF a b c d @e')
+      expect(replies.last).to eq('You cannot have more special characters on spies than the number of spies.')
+    end
+
+    it 'should start a game with 5 players' do
+      send_command('resistance BCDF a b c d @e')
+      expect(replies.last).to include('Roles have been assigned to the selected people!')
+    end
+
+    it 'should start a game with 7 players' do
+      f = Lita::User.create(6, {name: 'f', mention_name: 'f'})
+      g = Lita::User.create(7, {name: 'g', mention_name: 'g'})
+      send_command('resistance ABCFS a b c d e f g')
+      expect(replies.last).to include('Roles have been assigned to the selected people!')
+    end
+  end
 end

data/templates/help.erb

@@ -0,0 +1,26 @@
+Commands:
+`lita resistance help` - Provides detailed help
+
+`lita resistance N [users]` - Assigns the roles of spy/resistance to users you mention, with no special characters.
+
+`lita resistance [CBSAFD] [users]` - Assigns special characters to the users mentioned, the remainder (if any) will receive 'vanilla' spy/resistance roles.
+
+Special Characters:
+Note: The number of special characters chosen for each team must be less than the number of characters on that team.
+
+The number of spies is always (Players + 2)/3 rounded down.
+
+Resistance:
+Commander (C) - Knows all spies except Deep Cover.
+
+Body Guard (B) - Knows Commander and False Commander.
+
+Spies:
+
+Blind Spy (S) - Doesn't know the other spies. The other spies don't know Blind Spy.
+
+Assassin (A) - If Resistance successfully completes 3 missions, Assassin can guess Commander. If Assassin is correct, Spies win.
+
+False Commander (F) - Appears as Commander to Bodyguard.
+
+Deep Cover (D) - Does not appear as spy to Commander. If played with Commander and without Assassin, can take Assassin's role.

data/templates/resistance.erb

@@ -0,0 +1,24 @@
+
+<%= @starter %> has started game ID #<%= @game_id %> of Resistance.
+
+<% if @member == @commander %>
+You are the Commander, a member of the Resistance.
+
+<% if @spy_specials[:deep_cover].nil? %>
+The spies are: @<%= @commander_visible.join(' @') %>.
+<% else %>
+The spies, excluding Deep Cover, are: @<%= @commander_visible.join(' @') %>.
+<% end %>
+<% elsif @member == @bodyguard %>
+You are the Bodyguard, a member of the Resistance.
+
+<% if !@commander.nil? && !@spy_specials[:false_commander].nil? %>
+  The Commander and False Commander, in random order, are: @<%= @bodyguard_visible.join(' @')%>.
+<% elsif !@commander.nil? && @spy_specials[:false_commander].nil? %>
+  The Commander is @<%= @bodyguard_visible[0] %>
+<% elsif @commander.nil? && !@spy_specials[:false_commander].nil? %>
+  The False Commander is @<%= @bodyguard_visible[0] %>
+<% end %>
+<% else %>
+You are a regular member of the Resistance.
+<% end %>

data/templates/spy.erb

@@ -0,0 +1,24 @@
+
+<%= @starter %> has started game ID #<%= @game_id %> of Resistance.
+
+<% if @member == @spy_specials[:blind_spy] %>
+You are the Blind Spy, a member of the Spies. Unfortunately, you don't know the other spies, and they don't know you.
+<% else %>
+<% if @member == @spy_specials[:deep_cover] %>
+You are the Deep Cover, a member of the Spies.
+<% elsif @member == @spy_specials[:false_commander] %>
+You are the False Commander, a member of the Spies.
+<% elsif @member == @spy_specials[:assassin] %>
+You are the Assassin, a member of the Spies.
+<% else %>
+You are a regular member of the Spies.
+<% end %>
+
+<% if @other_spies.length == 1 %>
+  The other spy is @<%= @other_spies[0] %>.
+<% elsif @other_spies.length > 1 %>
+  The other spies are @<%= @other_spies.join(' @') %>.
+<% else %>
+  The other spy is invisible to you.
+<% end %>
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-resistance
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Deon Hua
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -144,6 +144,9 @@ files:
 - spec/lita/handlers/resistance_spec.rb
 - spec/spec_helper.rb
 - templates/.gitkeep
+- templates/help.erb
+- templates/resistance.erb
+- templates/spy.erb
 homepage: http://github.com/DeonHua/lita-resistance
 licenses:
 - MIT