lita 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08671280114ef4f96291a7b7f296e7b616f40647
-  data.tar.gz: dc0372bef9351ea61ae833568d07302f586896fa
+  metadata.gz: 73a99962e90c5ed2aa41e8d8a728abdd0a707051
+  data.tar.gz: 1b9026e1e1d32e693d67d13a40fe1fa412982930
 SHA512:
-  metadata.gz: e6c6c3f23fa4657320607973ef740765863539a1b5fe4fb281c92b8bddd8c6f6285be942b691b04ab9f0a0f1ea54a8aafbb81615bf88bfc79df4d02c4fa4bf4e
-  data.tar.gz: b655f0ff87524fb958f83398ffa5adae67b955eca3b281c3eab915dbda71517e034d2016fb05ed3f3685dc68f5497ce02c2a97fbd9c29ba6e09793154d0863e8
+  metadata.gz: 5abc300962d3cdfbe95a1d2882acc8c79cdd4b259819badc7d396ca8b2a83aed37176a4c8c92721926810706bb3cd9a27cbf4d3cf2613aa3f166d53e5420e34b
+  data.tar.gz: b48afb57c7cb94f560ebb4ff0a7a88ba390759720020c8085868d6a748e541c338317bbb0837902183f61a95c1a4ca9e7c50677ce3478511bee80204bc97723a

data/README.md

@@ -27,8 +27,8 @@ Lita draws much inspiration from GitHub's fantastic [Hubot](http://hubot.github.
 
 * It's written in Ruby.
 * It exposes the full power of Redis rather than using it to serialize JSON.
-* Is easy to develop and test plugins for with the provied [RSpec](https://github.com/rspec/rspec) extras. Lita strongly encourages thorough testing of plugins.
-* It uses uses the Ruby ecosystem's standard tools (RubyGems and Bundler) for plugin installation and loading.
+* It's easy to develop and test plugins for with the provied [RSpec](https://github.com/rspec/rspec) extras. Lita strongly encourages thorough testing of plugins.
+* It uses the Ruby ecosystem's standard tools (RubyGems and Bundler) for plugin installation and loading.
 * It's thoroughly documented.
 
 ## Is it any good?
@@ -115,6 +115,14 @@ Lita: auth remove joe committers
 
 The first command adds a user whose ID or name is "joe" to the authorization group "committers." If the group doesn't yet exist, it is created. The second command removes joe from the group. Handlers can specify that a route (a method that matches an incoming message) requires that the user sending the message be in a certain authorization group. See the section on writing handlers for more details.
 
+To list all the authorization groups and the names of the users in them, send Lita this command:
+
+```
+Lita: auth list
+```
+
+You can optionally suffix the command with the name of a group if you're only interested in the memebers of one group.
+
 ## Online help
 
 Message Lita `help` for a list of commands it knows about. You can also message it `help FOO` to list only commands beginning with FOO.
@@ -208,6 +216,8 @@ Additionally, handlers have access to these top-level methods:
 * `redis` - A `Redis::Namespace` object which provides each handler with its own isolated Redis store, suitable for many data persistence and manipulation tasks.
 * `http` - A `Faraday::Connection` object for making HTTP requests. Takes an optional hash of options and optional block which are passed on to [Faraday](https://github.com/lostisland/faraday).
 
+If a handler method crashes, the backtrace will be output to Lita's log with the `:error` level, but it will not crash the robot itself.
+
 ### HTTP routes
 
 In addition to chat routes, handlers can also define HTTP routes for the built-in web server. This is done with the class-level `http` method. `http` returns a `Lita::HTTPRoute` object, which has methods for the most common HTTP methods. These methods take two arguments: the path for the route, and the name of the method that it will invoke as a symbol. The callback method takes two arguments: a `Rack::Request` and a `Rack::Response`. For example:
@@ -382,11 +392,12 @@ There are a few things worth mentioning when deploying an instance of Lita to He
 
 1. Your Procfile should contain one process: `web: bundle exec lita`.
 
-1. To use the Redis To Go add-on, configure Lita's redis connection like this:
+1. To use the Redis To Go add-on and the HTTP port set by Heroku, configure Lita like this:
 
     ``` ruby
     Lita.configure do |config|
       config.redis.url = ENV["REDISTOGO_URL"]
+      config.http.port = ENV["PORT"]
     end
     ```
 
@@ -396,6 +407,10 @@ There are a few things worth mentioning when deploying an instance of Lita to He
 
 Complete documentation for all of Lita's classes and methods can be found at [rdoc.info](http://rdoc.info/gems/lita/frames).
 
+## Try it out
+
+You can chat with an instance of Lita on the Freenode IRC network in the channel `#litabot`. The bot's name is also *Litabot*.
+
 ## History
 
 For a history of releases, see the [Releases](https://github.com/jimmycuadra/lita/releases) page.

data/lib/lita/authorization.rb

@@ -41,6 +41,23 @@ module Lita
         Array(Lita.config.robot.admins).include?(user.id)
       end
 
+      # Returns a list of all authorization groups.
+      # @return [Array<Symbol>] The names of all authorization groups.
+      def groups
+        redis.keys("*").map(&:to_sym)
+      end
+
+      # Returns a hash of authorization group names and the users in them.
+      # @return [Hash] A map of +Symbol+ group names to +Lita::User+ objects.
+      def groups_with_users
+        groups.inject({}) do |list, group|
+          list[group] = redis.smembers(group).map do |user_id|
+            User.find_by_id(user_id)
+          end
+          list
+        end
+      end
+
       private
 
       # Ensures that group names are stored consistently in Redis.

data/lib/lita/handler.rb

@@ -56,10 +56,18 @@ module Lita
             Lita.logger.debug <<-LOG.chomp
 Dispatching message to #{self}##{route.method_name}.
 LOG
-            new(robot).public_send(route.method_name, Response.new(
-              message,
-              matches: message.match(route.pattern)
-            ))
+            begin
+              new(robot).public_send(route.method_name, Response.new(
+                message,
+                matches: message.match(route.pattern)
+              ))
+            rescue Exception => e
+              Lita.logger.error <<-ERROR.chomp
+#{name} crashed. The exception was:
+#{e.message}
+#{e.backtrace.join("\n")}
+ERROR
+            end
           end
         end
       end

data/lib/lita/handlers/authorization.rb

@@ -8,6 +8,12 @@ module Lita
       route(/^auth\s+remove/, :remove, command: true, help: {
         "auth remove USER GROUP" => "Remove USER from authorization group GROUP. Requires admin privileges."
       })
+      route(/^auth\s+list/, :list, command: true, help: {
+        "auth list [GROUP]" => <<-HELP
+List authorization groups and the users in them. If GROUP is supplied, only \
+lists that group."
+HELP
+      })
 
       # Adds a user to an authorization group.
       # @param response [Lita::Response] The response object.
@@ -45,8 +51,40 @@ module Lita
         end
       end
 
+      # Lists all authorization groups (or only the specified group) and the
+      # names of their members.
+      # @param response [Lita::Response] The response object.
+      # @return [void]
+      def list(response)
+        requested_group = response.args[1]
+        output = get_groups_list(requested_group)
+        if output.empty?
+          if requested_group
+            response.reply(
+              "There is no authorization group named #{requested_group}."
+            )
+          else
+            response.reply("There are no authorization groups yet.")
+          end
+        else
+          response.reply(output.join("\n"))
+        end
+      end
+
       private
 
+      def get_groups_list(requested_group)
+        groups_with_users = Lita::Authorization.groups_with_users
+        if requested_group
+          requested_group = requested_group.downcase.strip.to_sym
+          groups_with_users.select! { |group, _| group == requested_group }
+        end
+        groups_with_users.map do |group, users|
+          user_names = users.map { |u| u.name }.join(", ")
+          "#{group}: #{user_names}"
+        end
+      end
+
       # Validates that incoming messages have the right format and a valid user.
       # Also assigns the user and group to instance variables for the main
       # methods to use later.

data/lib/lita/rspec.rb

@@ -1,5 +1,7 @@
 begin
   require "rspec"
+  require "rspec/expectations"
+  require "rspec/mocks"
 rescue LoadError
   abort "Lita::RSpec requires both RSpec::Mocks and RSpec::Expectations."
 end

data/lib/lita/version.rb

@@ -1,4 +1,4 @@
 module Lita
   # The current version of Lita.
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lita.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "thor", "~> 0.18.1"
 
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", ">= 2.14.0rc1"
+  spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "pry"

data/spec/lita/authorization_spec.rb

@@ -73,4 +73,42 @@ describe Lita::Authorization, lita: true do
       expect(described_class.user_is_admin?(user)).to be_false
     end
   end
+
+  describe ".groups" do
+    before do
+      %i{foo bar baz}.each do |group|
+        described_class.add_user_to_group(requesting_user, user, group)
+      end
+    end
+
+    it "returns a list of all authorization groups" do
+      expect(described_class.groups).to match_array(%i{foo bar baz})
+    end
+  end
+
+  describe ".groups_with_users" do
+    before do
+      %i{foo bar baz}.each do |group|
+        described_class.add_user_to_group(requesting_user, user, group)
+        described_class.add_user_to_group(
+          requesting_user,
+          requesting_user,
+          group
+        )
+      end
+      allow(Lita::User).to receive(:find_by_id).with("1").and_return(
+        requesting_user
+      )
+      allow(Lita::User).to receive(:find_by_id).with("2").and_return(user)
+    end
+
+    it "returns a hash of all authorization groups and their members" do
+      groups = %i{foo bar baz}
+      groups_with_users = described_class.groups_with_users
+      expect(groups_with_users.keys).to match_array(groups)
+      groups.each do |group|
+        expect(groups_with_users[group]).to match_array([user, requesting_user])
+      end
+    end
+  end
 end

data/spec/lita/handler_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Lita::Handler do
+describe Lita::Handler, lita: true do
   let(:robot) { double("Lita::Robot", name: "Lita") }
   let(:user) { double("Lita::User") }
 
@@ -15,6 +15,7 @@ describe Lita::Handler do
       route(/\w{3}/, :foo)
       route(/\w{4}/, :blah, command: true)
       route(/secret/, :secret, restrict_to: :admins)
+      route(/danger/, :danger)
 
       http.get "web", :web
 
@@ -30,6 +31,10 @@ describe Lita::Handler do
       def web(request, response)
       end
 
+      def danger(response)
+        raise "The developer of this handler's got a bug in their code!"
+      end
+
       def self.name
         "Lita::Handlers::Test"
       end
@@ -85,6 +90,14 @@ describe Lita::Handler do
       expect_any_instance_of(handler_class).not_to receive(:secret)
       handler_class.dispatch(robot, message)
     end
+
+    it "logs exceptions but doesn't crash the bot" do
+      allow(message).to receive(:body).and_return("#{robot.name}: danger")
+      expect(Lita.logger).to receive(:error).with(
+        %r{Lita::Handlers::Test crashed}
+      )
+      expect { handler_class.dispatch(robot, message) }.not_to raise_error
+    end
   end
 
   describe ".namespace" do

data/spec/lita/handlers/authorization_spec.rb

@@ -13,6 +13,8 @@ describe Lita::Handlers::Authorization, lita_handler: true do
   it { routes_command("auth add foo@bar.com baz").to(:add) }
   it { routes_command("auth remove foo bar").to(:remove) }
   it { routes_command("auth remove foo@bar.com baz").to(:remove) }
+  it { routes_command("auth list").to(:list) }
+  it { routes_command("auth list foo").to(:list) }
 
   describe "#add" do
     it "replies with the proper format if the require commands are missing" do
@@ -73,4 +75,44 @@ describe Lita::Handlers::Authorization, lita_handler: true do
       expect(replies.last).to match(/Only administrators can remove/)
     end
   end
+
+  describe "#list" do
+    context "when there are populated groups" do
+      let(:groups) { %i{foo bar} }
+      let(:user1) { Lita::User.create(3, name: "Bongo") }
+      let(:user2) { Lita::User.create(4, name: "Carl") }
+
+      before do
+        groups.each do |group|
+          Lita::Authorization.add_user_to_group(user, user1, group)
+          Lita::Authorization.add_user_to_group(user, user2, group)
+        end
+      end
+
+      it "lists all authorization groups and their members" do
+        send_command("auth list")
+        groups.each do |group|
+          expect(replies.last).to include(
+            "#{group}: #{user1.name}, #{user2.name}"
+          )
+        end
+      end
+
+      it "lists only the requested group" do
+        send_command("auth list foo")
+        expect(replies.last).to include("foo")
+        expect(replies.last).not_to include("bar")
+      end
+    end
+
+    it "replies that there are no groups" do
+      send_command("auth list")
+      expect(replies.last).to include("no authorization groups yet")
+    end
+
+    it "replies that the specified group doesn't exist" do
+      send_command("auth list nothing")
+      expect(replies.last).to include("no authorization group named nothing")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-06 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,16 +126,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.0rc1
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.0rc1
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement