lita-irc 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4395b1f99ddbd742dd59d2393d3e396671167cdb
-  data.tar.gz: a3eb5703529d4b9498b0a4ab8d8e0154da14b345
+  metadata.gz: d008c249ad6a0aae3dc19bf9681693c9c6360a80
+  data.tar.gz: 510f7748da4c91ff57c0a73eba7cb36904a84f14
 SHA512:
-  metadata.gz: f0eed00861cc230928a47ff74d087fe6c477a6b577cd6658f1ae66d2bcee0c432b4c825f4ba4baa22da5eca3cba4a7fbf9ad88ca723c3a29118c872ef5f9efc5
-  data.tar.gz: 1bc336e4c560da4740dbc342c06e1206d39182c3955d5c414cbdfb6fad360b6d96287ed4993af4af5abe62528481b6a1372b20d7c4a874fce6777cbaa3df3206
+  metadata.gz: 1ac5471086cb01b57eb79c0a047f0033f58bdbdcafb376c0ff683ca93f5798f3fab19ef3f35f23239a6b5f3198f0a5639accc2e856a55ee6a64d126b884b6e96
+  data.tar.gz: bd2539f901083fbeaa6b7dde60b7a789f4f4143ac4c2c58b49e7351a97126655ccb1e96ca95678feb407306a76dc266f165b07d12ce07f039a382fcaac4d02ad

data/README.md

@@ -28,18 +28,23 @@ gem "lita-irc"
 * `realname` (String) - The "real name" field for Lita's IRC account. Default: `"Lita"`.
 * `log_level` (Symbol) - Sets the log level for Cinch's loggers. By default, Cinch's loggers are disabled. Default: `nil`.
 
-**Note**: `config.robot.name` is used as Lita's IRC nickname. `config.adapters.irc.nick` is ignored.
-
 ### Additional Cinch options
 
 Under the hood, lita-irc uses [Cinch](https://github.com/cinchrb/cinch) for the IRC connection. Cinch has several [configuration options](http://www.rubydoc.info/github/cinchrb/cinch/file/docs/bot_options.md) that you may want to set. To do this, assign a proc/lambda to `config.adapters.irc.cinch`. lita-irc will yield the Cinch configuration object to the proc, so you can configure it as you'd like. Note that for the options listed in the sections above, those values will overwrite anything set in the proc.
 
+**Note**: `config.robot.name` is used as Lita's IRC nickname. The `nick` attribute of the Cinch options is overwritten with this value.
+
+### config.robot.admins
+
+Each IRC user has a unique ID that Lita generates and stores the first time that user is encountered. To populate the `config.robot.admins` attribute, you'll need to use these IDs for each user you want to mark as an administrator. If you're using Lita version 4.1 or greater, you can get a user's ID by sending Lita the command `users find NICKNAME_OF_USER`.
+
 ### Example
 
 ``` ruby
 Lita.configure do |config|
   config.robot.name = "Lita"
   config.robot.adapter = :irc
+  config.robot.admins = ["eed844bf-2df0-4091-943a-7ee05ef36f4a"]
   config.adapters.irc.server = "irc.freenode.net"
   config.adapters.irc.channels = ["#litabot"]
   config.adapters.irc.user = "Lita"

data/lib/lita/adapters/irc.rb

@@ -47,11 +47,9 @@ module Lita
 
       def send_messages(target, strings)
         if target.private_message?
-          user = Cinch::User.new(target.user.name, cinch)
-          strings.each { |s| user.msg(s) }
+          send_messages_to_user(target, strings)
         else
-          channel = Cinch::Channel.new(target.room, cinch)
-          strings.each { |s| channel.msg(s) }
+          send_messages_to_channel(target, strings)
         end
       end
 
@@ -105,6 +103,26 @@ module Lita
           cinch_config.plugins.options[CinchPlugin] = { robot: robot }
         end
       end
+
+      def send_message_to_target(target, string)
+        string_without_action = string.gsub(/^\/me\s+/i, "")
+
+        if string == string_without_action
+          target.msg(string)
+        else
+          target.action(string_without_action)
+        end
+      end
+
+      def send_messages_to_channel(target, strings)
+        channel = Cinch::Channel.new(target.room, cinch)
+        strings.each { |string| send_message_to_target(channel, string) }
+      end
+
+      def send_messages_to_user(target, strings)
+        user = Cinch::User.new(target.user.name, cinch)
+        strings.each { |string| send_message_to_target(user, string) }
+      end
     end
 
     Lita.register_adapter(:irc, IRC)

data/lita-irc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-irc"
-  spec.version       = "2.0.0"
+  spec.version       = "2.0.1"
   spec.authors       = ["Jimmy Cuadra"]
   spec.email         = ["jimmy@jimmycuadra.com"]
   spec.description   = %q{An IRC adapter for Lita.}

data/spec/lita/adapters/irc_spec.rb

@@ -77,6 +77,14 @@ describe Lita::Adapters::IRC, lita: true do
       subject.send_messages(source, ["Hello!", "How are you?"])
     end
 
+    it "sends actions to rooms" do
+      source = instance_double("Lita::Source", room: "#foo", private_message?: false)
+      channel = instance_double("Cinch::Channel")
+      allow(Cinch::Channel).to receive(:new).with("#foo", subject.cinch).and_return(channel)
+      expect(channel).to receive(:action).with("greets you")
+      subject.send_messages(source, ["/me greets you"])
+    end
+
     it "sends messages to users" do
       user = instance_double("Lita::User", name: "Carl")
       source = instance_double("Lita::Source", user: user, private_message?: true)
@@ -86,6 +94,15 @@ describe Lita::Adapters::IRC, lita: true do
       expect(user).to receive(:msg).with("How are you?")
       subject.send_messages(source, ["Hello!", "How are you?"])
     end
+
+    it "sends actions to users" do
+      user = instance_double("Lita::User", name: "Carl")
+      source = instance_double("Lita::Source", user: user, private_message?: true)
+      user = instance_double("Cinch::User")
+      allow(Cinch::User).to receive(:new).with("Carl", subject.cinch).and_return(user)
+      expect(user).to receive(:action).with("greets you")
+      subject.send_messages(source, ["/me greets you"])
+    end
   end
 
   describe "#set_topic" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-irc
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: An IRC adapter for the Lita chat robot.