lita 3.0.4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72bfc92024ae2bb828d19ddaa51b6234465522d8
-  data.tar.gz: 6849ff7eb590365266e4fa89c8f17a5c4c075e52
+  metadata.gz: b317185fd4bf51c66e01de3aef18547d27d154ef
+  data.tar.gz: 0ee25a799c8b033fb82e0e58fe3654ebaf974eea
 SHA512:
-  metadata.gz: bd119e2dfff11a6e2bdaafe556c03fd8ab9ce2d89f760474a96588dde7c0bc6316f6fd37de78df4fc9a1bd40ce4f7ea9208cb682d3ea65bead748f843d0f44c3
-  data.tar.gz: 3d3b9be32bca1ed13a2dcf9b4ad3b85df51530532f4e1e89fd10749fd7b7a56bd4cda1fda1a461125c953b11ede6d864159d33325c9281fad5a3d155704171ac
+  metadata.gz: 23c70beb7798a316f725225c17a0b75f8e0fdd2d104e9d9f4c611ae6c423300810adb1c1a9805629287a0db1d27b60071779bd4bf7ecebfbef302a3fde3623f3
+  data.tar.gz: 0498b930d44e0057058a25df985b8117d97de953f76ed89c414c7902482f889db1333b4376665aab01409f60fbcc55ae6fb3159594432cbfac0944b4bd8c9168

data/README.md

@@ -13,13 +13,13 @@ Automate your business and have fun with your very own robot companion.
 
 ## Documentation
 
-Please visit [lita.io](http://www.lita.io/) for comprehensive documentation.
+Please visit [lita.io](https://www.lita.io/) for comprehensive documentation.
 
 ## Plugins
 
-A list of all publicly available Lita plugins is available on the [lita.io plugins page](http://www.lita.io/plugins).
+A list of all publicly available Lita plugins is available on the [lita.io plugins page](https://www.lita.io/plugins).
 
-The plugins page automatically updates daily with information from RubyGems. See [publishing](http://www.lita.io/plugin-authoring#publishing) for more information.
+The plugins page automatically updates daily with information from RubyGems. See [publishing](https://www.lita.io/plugin-authoring#publishing) for more information.
 
 ## Contributing
 

data/lib/lita/adapter.rb

@@ -94,6 +94,16 @@ module Lita
       end
     end
 
+    # Formats a name for "mentioning" a user in a group chat. Override this
+    # method in child classes to customize the mention format for the chat
+    # service.
+    # @param name [String] The name to format as a mention name.
+    # @return [String] The formatted mention name.
+    # @since 3.1.0
+    def mention_format(name)
+      "#{name}:"
+    end
+
     # @see .translate
     def translate(*args)
       self.class.translate(*args)

data/lib/lita/message.rb

@@ -81,5 +81,14 @@ module Lita
       private_source.private_message!
       @robot.send_messages(private_source, *strings)
     end
+
+    # Replies by sending the given strings back to the source of the message.
+    # Each message is prefixed with the user's mention name.
+    # @param strings [String, Array<String>] The strings to send back.
+    # @return [void]
+    # @since 3.1.0
+    def reply_with_mention(*strings)
+      @robot.send_messages_with_mention(source, *strings)
+    end
   end
 end

data/lib/lita/response.rb

@@ -18,9 +18,12 @@ module Lita
     #   @see Lita::Message#reply
     # @!method reply_privately
     #   @see Lita::Message#reply_privately
+    # @!method reply_with_mention
+    #   @see Lita::Message#reply_with_mention
     # @!method user
     #   @see Lita::Message#user
-    def_delegators :message, :args, :reply, :reply_privately, :user, :command?
+    def_delegators :message, :args, :reply, :reply_privately,
+      :reply_with_mention, :user, :command?
 
     # @param message [Lita::Message] The incoming message.
     # @param pattern [Regexp] The pattern the incoming message matched.

data/lib/lita/robot.rb

@@ -76,6 +76,26 @@ module Lita
     end
     alias_method :send_message, :send_messages
 
+    # Sends one or more messages to a user or room. If sending to a room,
+    # prefixes each message with the user's mention name.
+    # @param target [Lita::Source] The user or room to send to. If the Source
+    #   has a room, it will choose the room. Otherwise, it will send to the
+    #   user.
+    # @param strings [String, Array<String>] One or more strings to send.
+    # @return [void]
+    # @since 3.1.0
+    def send_messages_with_mention(target, *strings)
+      return send_messages(target, *strings) if target.private_message?
+
+      mention_name = target.user.mention_name
+      prefixed_strings = strings.map do |s|
+        "#{@adapter.mention_format(mention_name).strip} #{s}"
+      end
+
+      send_messages(target, *prefixed_strings)
+    end
+    alias_method :send_message_with_mention, :send_messages_with_mention
+
     # Sets the topic for a chat room.
     # @param target [Lita::Source] A source object specifying the room.
     # @param topic [String] The new topic message to set.

data/lib/lita/user.rb

@@ -99,6 +99,13 @@ module Lita
       ensure_name_metadata_set
     end
 
+    # The name used to "mention" the user in a group chat.
+    # @return [String] The user's mention name.
+    # @since 3.1.0
+    def mention_name
+      metadata["mention_name"] || name
+    end
+
     # Saves the user record to Redis, overwriting an previous data for the
     # current ID and user name.
     # @return [void]

data/lib/lita/version.rb

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

data/spec/lita/adapter_spec.rb

@@ -42,4 +42,10 @@ describe Lita::Adapter do
       end.to raise_error(RuntimeError)
     end
   end
+
+  describe "#mention_format" do
+    it "formats the provided name for mentioning the user" do
+      expect(subject.mention_format("carl")).to eq("carl:")
+    end
+  end
 end

data/spec/lita/message_spec.rb

@@ -5,8 +5,10 @@ describe Lita::Message do
     instance_double("Lita::Robot", name: "Lita", mention_name: "LitaBot", alias: ".")
   end
 
+  let(:source) { instance_double("Lita::Source") }
+
   subject do
-    described_class.new(robot, "Hello", "Carl")
+    described_class.new(robot, "Hello", source)
   end
 
   it "has a body" do
@@ -14,17 +16,17 @@ describe Lita::Message do
   end
 
   it "has a source" do
-    expect(subject.source).to eq("Carl")
+    expect(subject.source).to eq(source)
   end
 
   describe "#args" do
     it "returns an array of the 2nd through nth word in the message" do
-      subject = described_class.new(robot, "args foo bar", "Carl")
+      subject = described_class.new(robot, "args foo bar", source)
       expect(subject.args).to eq(%w(foo bar))
     end
 
     it "escapes messages that have mismatched quotes" do
-      subject = described_class.new(robot, "args it's working", "Carl")
+      subject = described_class.new(robot, "args it's working", source)
       expect(subject.args).to eq(%w(it's working))
     end
   end
@@ -41,7 +43,7 @@ describe Lita::Message do
       subject = described_class.new(
         robot,
         "#{robot.mention_name}: hello",
-        "Carl"
+        source
       )
       expect(subject).to be_a_command
     end
@@ -50,7 +52,7 @@ describe Lita::Message do
       subject = described_class.new(
         robot,
         "#{robot.mention_name.upcase}: hello",
-        "Carl"
+        source
       )
       expect(subject).to be_a_command
     end
@@ -59,7 +61,7 @@ describe Lita::Message do
       subject = described_class.new(
         robot,
         "#{robot.alias}hello",
-        "Carl"
+        source
       )
       expect(subject).to be_a_command
     end
@@ -78,7 +80,7 @@ describe Lita::Message do
 
   describe "#reply" do
     it "sends strings back to the source through the robot" do
-      expect(robot).to receive(:send_messages).with("Carl", "foo", "bar")
+      expect(robot).to receive(:send_messages).with(source, "foo", "bar")
       subject.reply("foo", "bar")
     end
   end
@@ -97,4 +99,11 @@ describe Lita::Message do
       subject.reply_privately("foo", "bar")
     end
   end
+
+  describe "#reply_with_mention" do
+    it "prefixes strings with a user mention and sends them back to the source" do
+      expect(robot).to receive(:send_messages_with_mention).with(source, "foo", "bar")
+      subject.reply_with_mention("foo", "bar")
+    end
+  end
 end

data/spec/lita/response_spec.rb

@@ -5,7 +5,7 @@ describe Lita::Response do
 
   let(:message) { instance_double("Lita::Message").as_null_object }
 
-  [:args, :reply, :user, :command?].each do |method|
+  [:args, :reply, :reply_privately, :reply_with_mention, :user, :command?].each do |method|
     it "delegates :#{method} to #message" do
       expect(message).to receive(method)
       subject.public_send(method)

data/spec/lita/robot_spec.rb

@@ -99,6 +99,45 @@ describe Lita::Robot do
     end
   end
 
+  describe "#send_message_with_mention" do
+    let(:user) { instance_double("Lita::User", mention_name: "carl") }
+    let(:source) { instance_double("Lita::Source", private_message?: false, user: user) }
+
+    it "calls #send_message with the strings, prefixed with the user's mention name" do
+      allow_any_instance_of(Lita::Adapters::Shell).to receive(:mention_format).with(
+        "carl"
+      ).and_return("carl:")
+      expect_any_instance_of(Lita::Adapters::Shell).to receive(:send_messages).with(
+        source,
+        ["carl: foo", "carl: bar"]
+      )
+
+      subject.send_messages_with_mention(source, "foo", "bar")
+    end
+
+    it "strips whitespace from both sides of the formatted mention name" do
+      allow_any_instance_of(Lita::Adapters::Shell).to receive(:mention_format).with(
+        "carl"
+      ).and_return("   carl:   ")
+      expect_any_instance_of(Lita::Adapters::Shell).to receive(:send_messages).with(
+        source,
+        ["carl: foo", "carl: bar"]
+      )
+
+      subject.send_messages_with_mention(source, "foo", "bar")
+    end
+
+    it "calls #send_message directly if the original message was sent privately" do
+      allow(source).to receive(:private_message?).and_return(true)
+      expect_any_instance_of(Lita::Adapters::Shell).to receive(:send_messages).with(
+        source,
+        %w(foo bar)
+      )
+
+      subject.send_messages_with_mention(source, "foo", "bar")
+    end
+  end
+
   describe "#set_topic" do
     let(:source) { instance_double("Lita::Source") }
 

data/spec/lita/user_spec.rb

@@ -96,6 +96,18 @@ describe Lita::User, lita: true do
     end
   end
 
+  describe "#mention_name" do
+    it "returns the user's mention name from metadata" do
+      subject = described_class.new(1, name: "Carl", mention_name: "carlthepug")
+      expect(subject.mention_name).to eq("carlthepug")
+    end
+
+    it "returns the user's name if there is no mention name in the metadata" do
+      subject = described_class.new(1, name: "Carl")
+      expect(subject.mention_name).to eq("Carl")
+    end
+  end
+
   describe "#save" do
     subject { described_class.new(1, name: "Carl", mention_name: "carlthepug") }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler