lita 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 413787eadeaaa5e58440f591d404423c90e7b95d
-  data.tar.gz: 4114e0ac515a2068a361e4f6fdfcd0103ed27e8a
+  metadata.gz: 04046c9229b2303b99d39582d60790888db1e611
+  data.tar.gz: 0060005dadcb7608aa33051ed9571455463c3698
 SHA512:
-  metadata.gz: 58c0d8117141c1809f73422a581bc7a11693eca37f02234abddb913fc70ce631a5026320a4fdfc09f1ec772eb0501301c656fcf750d7a35a23e85415b7ce8d8d
-  data.tar.gz: bfb5bc4df0cc27e9d242e30beca7e6ae7683f3655dc29dc7ed575fde39c40e62a0a6b3b84746c826fdf5b48e65e5b1de3ac09fe9bc5ba19eb6e48d4bd23ad108
+  metadata.gz: 80caca833d509b65a8015de4f3e5845fc5c0c485f4b02b4d9ce70f3beb351f8cbc05b0bdbcac474be0e3248e53915e459e6f30068becbdb701bbe73ba7df295e
+  data.tar.gz: 2c5d02ce8eed3c643dd9e0ef43b0467443ea5382686d36c785d9ebbf319ed0b4583c4d92ae1bec0036d49993c28a464aaf4aa3ae6cec1f55b6005bea1e7821b6

data/.travis.yml

@@ -4,3 +4,7 @@ rvm:
 script: bundle exec rake
 before_install:
   - gem update --system
+notifications:
+  webhooks:
+    urls:
+      - https://lita-freenode.herokuapp.com/travis

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing to Lita
+
+## Issues
+
+Found a bug in Lita? Open an issue on [GitHub Issues](https://github.com/jimmycuadra/lita/issues). For general questions, feedback, and discussion, please visit [Google Groups](http://groups.google.com/group/litaio) or the `#lita.io` channel on the [Freenode IRC network](https://webchat.freenode.net/).
+
+## Pull requests
+
+Ready to submit a pull request? Great! Contributions are most welcome. To get your contributions accepted, make sure:
+
+* All the tests pass. Run `rspec`.
+* No code quality warnings are generated by [Cane](https://github.com/square/cane). Run `cane`.
+* Any new code paths you've added are covered by tests.
+* Any new classes or methods you've added have API documentation compatible with [YARD](http://yardoc.org/). If you've significantly changed the behavior of an existing class or method, you should also update any existing API documentation.

data/README.md

@@ -1,6 +1,7 @@
 # Lita
 
-[![Build Status](https://travis-ci.org/jimmycuadra/lita.png)](https://travis-ci.org/jimmycuadra/lita)
+[![Gem Version](https://badge.fury.io/rb/lita.png)](http://badge.fury.io/rb/lita)
+[![Build Status](https://travis-ci.org/jimmycuadra/lita.png?branch=master)](https://travis-ci.org/jimmycuadra/lita)
 [![Code Climate](https://codeclimate.com/github/jimmycuadra/lita.png)](https://codeclimate.com/github/jimmycuadra/lita)
 [![Coverage Status](https://coveralls.io/repos/jimmycuadra/lita/badge.png)](https://coveralls.io/r/jimmycuadra/lita)
 
@@ -21,6 +22,7 @@ Automate your business and have fun with your very own robot companion.
 * Group-based authorization
 * Configurable logging
 * Generators for creating new plugins
+* Built-in process daemonization
 
 ## Why?
 
@@ -210,7 +212,9 @@ route /^echo\s+(.+)/, to: :echo, command: true, restrict_to: [:testers, :committ
 Each method that is called by a route takes one argument, a `Lita::Response` object. This object has the following useful methods:
 
 * `reply` - Sends one or more string messages back to the source of the original message, either a private message or a chat room.
+* `reply_privately` - Sends one or more string messages back to the user who sent the original message, whether it initated in a private message or a chat room.
 * `matches` - An array of regular expression matches obtained by calling `body_of_message.scan(route_regex)`.
+* `match_data` - A `MatchData` object obtained by calling `route_regex.match(body_of_message)`.
 * `args` - The user's message as an array of strings, as it would be parsed by `Shellwords.split`. For example, if the message was "Lita: auth add joe committers", calling `args` would return `["add", "joe", "committers"]`. ("auth" is considered the command and so is not included in the arguments.) This is very handy for commands that take arguments in a way similar to how a UNIX shell would work.
 * `message` - A `Lita::Message` object for the incoming message.
 * `user` - A `Lita::User` object for the user who sent the message.
@@ -416,9 +420,25 @@ 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
+## Available plugins
 
-You can chat with an instance of Lita on the Freenode IRC network in the channel `#litabot`. The bot's name is also *Litabot*.
+* [Adapters](https://github.com/jimmycuadra/lita/wiki/Adapters)
+* [Handlers](https://github.com/jimmycuadra/lita/wiki/Handlers)
+
+If you release a Lita plugin of your own, be sure to add it to one of the above lists!
+
+## Questions, feedback, and discussion
+
+* [Google Group](http://groups.google.com/group/litaio)
+* [IRC](https://webchat.freenode.net/) (`#lita.io` on the Freenode network)
+
+## Bug reports
+
+* [GitHub Issues](https://github.com/jimmycuadra/lita/issues)
+
+## Contributing
+
+See the [contribution guide](https://github.com/jimmycuadra/lita/blob/master/CONTRIBUTING.md).
 
 ## History
 

data/lib/lita.rb

@@ -10,9 +10,6 @@ require "rack"
 require "redis-namespace"
 require "thin"
 
-require "lita/version"
-require "lita/config"
-
 # The main namespace for Lita. Provides a global registry of adapters and
 # handlers, as well as global configuration, logger, and Redis store.
 module Lita
@@ -93,6 +90,8 @@ module Lita
   end
 end
 
+require "lita/version"
+require "lita/config"
 require "lita/util"
 require "lita/logger"
 require "lita/user"

data/lib/lita/handler.rb

@@ -51,13 +51,15 @@ module Lita
       # @param message [Lita::Message] The incoming message.
       # @return [void]
       def dispatch(robot, message)
-        routes.select { |r| route_applies?(r, message, robot) }.each do |route|
+        routes.each do |route|
+          next unless route_applies?(route, message, robot)
+
           log_dispatch(route)
 
           begin
             new(robot).public_send(
               route.method_name,
-              build_response(message, route)
+              Response.new(message, route.pattern)
             )
           rescue Exception => e
             log_dispatch_error(e)
@@ -95,11 +97,6 @@ module Lita
 
       private
 
-      # Builds a response object for an incoming message.
-      def build_response(message, route)
-        Response.new(message, matches: message.match(route.pattern))
-      end
-
       # Determines whether or not an incoming messages should trigger a route.
       def route_applies?(route, message, robot)
         # Message must be a command if the route requires a command

data/lib/lita/handlers/help.rb

@@ -17,7 +17,7 @@ Lists help information for terms or commands that begin with COMMAND.
       def help(response)
         output = build_help(response)
         output = filter_help(output, response)
-        response.reply output.join("\n")
+        response.reply_privately output.join("\n")
       end
 
       private

data/lib/lita/message.rb

@@ -68,5 +68,13 @@ module Lita
     def reply(*strings)
       @robot.send_messages(source, *strings)
     end
+
+    # Replies by sending the given strings back to the user who sent the
+    # message directly, even if the message was sent in a room.
+    # @param strings [String, Array<String>] The strings to send back.
+    # @return [void]
+    def reply_privately(*strings)
+      @robot.send_messages(Source.new(source.user), *strings)
+    end
   end
 end

data/lib/lita/response.rb

@@ -8,23 +8,47 @@ module Lita
     # @return [Lita::Message] The message.
     attr_accessor :message
 
-    # An array of matches from running the message against the route pattern.
-    # @return [Array<String>, Array<Array<String>>] The array of matches.
-    attr_accessor :matches
+    # The pattern the incoming message matched.
+    # @return [Regexp] The pattern.
+    attr_accessor :pattern
 
     # @!method args
     #   @see Lita::Message#args
     # @!method reply
     #   @see Lita::Message#reply
+    # @!method reply_privately
+    #   @see Lita::Message#reply_privately
     # @!method user
     #   @see Lita::Message#user
-    def_delegators :message, :args, :reply, :user, :command?
+    def_delegators :message, :args, :reply, :reply_privately, :user, :command?
 
     # @param message [Lita::Message] The incoming message.
-    # @param matches [Array<String>, Array<Array<String>>] The Regexp matches.
-    def initialize(message, matches: nil)
-      self.message = message
-      self.matches = matches
+    # @param matches [Regexp] The pattern the incoming message matched.
+    def initialize(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      self.message = args[0]
+      self.pattern = args[1]
+
+      if options[:matches]
+        Lita.logger.warn <<-WARNING.chomp
+Passing a "matches" option to Response's constructor is deprecated. \
+Use Response.new(message, pattern) instead.
+        WARNING
+        @matches = options[:matches]
+      end
+    end
+
+    # An array of matches from scanning the message against the route pattern.
+    # @return [Array<String>, Array<Array<String>>] The array of matches.
+    def matches
+      @matches ||= message.match(pattern)
+    end
+
+    # A +MatchData+ object from running the pattern against the message body.
+    # @return [MatchData] The +MatchData+.
+    def match_data
+      @match_data ||= pattern.match(message.body) if pattern
     end
   end
 end

data/lib/lita/version.rb

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

data/spec/lita/message_spec.rb

@@ -71,4 +71,19 @@ describe Lita::Message do
       subject.reply("foo", "bar")
     end
   end
+
+  describe "#reply_privately" do
+    it "sends strings directly to the source user" do
+      subject = described_class.new(
+        robot,
+        "Hello",
+        Lita::Source.new("Carl", "#room")
+      )
+      expect(robot).to receive(:send_messages) do |source, *strings|
+        expect(source.room).to be_nil
+        expect(strings).to eq(["foo", "bar"])
+      end
+      subject.reply_privately("foo", "bar")
+    end
+  end
 end

data/spec/lita/response_spec.rb

@@ -1,9 +1,10 @@
 require "spec_helper"
 
 describe Lita::Response do
-  subject { described_class.new(message) }
+  subject { described_class.new(message, pattern) }
 
   let(:message) { double("Lita::Message").as_null_object }
+  let(:pattern) { double("Regexp").as_null_object }
 
   [:args, :reply, :user, :command?].each do |method|
     it "delegates :#{method} to #message" do
@@ -11,4 +12,11 @@ describe Lita::Response do
       subject.public_send(method)
     end
   end
+
+  it "supports the deprecated Response.new(message, matches: matches) API" do
+    matches = ["foo"]
+    expect(Lita.logger).to receive(:warn)
+    subject = described_class.new(message, matches: matches)
+    expect(subject.matches).to eq(matches)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -202,6 +202,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md