lita-irc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 267b171c8564fa0e0eb11cc880178646e4f3c3e2
+  data.tar.gz: 538ee8f00c2c55061e1d7f9ba0d357f9f4cc9c0b
+SHA512:
+  metadata.gz: c319385fdec8f1ba1f1383957e5a7d71a430e3dcbc2288eed733f8f45b94e43ebc0898ae8b3829144130364bf1256ada4e18eea7c4cebc2f80ca5f54ae1b52cf
+  data.tar.gz: 7b64d29931dde2ee721e96d2fd17c15c32dfbe3c46553888c850812bc770beac683ee423dbe0676a05bd1fc94dec9ad15826ef1a06f05a3a069ba660f9807a0b

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+lita_config.rb

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rspec
+before_install:
+  - gem update --system

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,56 @@
+# lita-irc
+
+[![Build Status](https://travis-ci.org/jimmycuadra/lita-irc.png)](https://travis-ci.org/jimmycuadra/lita-irc)
+[![Code Climate](https://codeclimate.com/github/jimmycuadra/lita-irc.png)](https://codeclimate.com/github/jimmycuadra/lita-irc)
+[![Coverage Status](https://coveralls.io/repos/jimmycuadra/lita-irc/badge.png)](https://coveralls.io/r/jimmycuadra/lita-irc)
+
+**lita-irc** is an adapter for [Lita](https://github.com/jimmycuadra/lita) that allows you to use the robot with IRC.
+
+## Installation
+
+Add lita-irc to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-irc"
+```
+
+## Configuration
+
+All attributes set on `config.adapter` will be passed on to the underlying [Cinch](https://github.com/cinchrb/cinch) robot. The documentation for [Cinch's options](http://rubydoc.info/github/cinchrb/cinch/file/docs/bot_options.md) detail all of them.
+
+The attributes listed below are either fundamental to making the bot work, or have defaults provided by Lita that take precedence over Cinch's defaults.
+
+### Required attributes
+
+* `server` (String) - The name of the IRC server Lita should connect to. Default: `nil`.
+* `channels` (Array<String>) - An array of channels Lita should join upon connection. Default: `nil`.
+
+### Optional attributes
+
+* `user` (String) - The username for Lita's IRC account. Default: `"Lita"".
+* `password` (String) - The password for Lita's IRC account. Default: `nil`.
+* `realname` (String) - The "real name" field for Lita's IRC account. Default: `"Lita"`.
+
+### Lita-specific attributes
+
+* `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.adapter.nick` is ignored.
+
+### Example
+
+``` ruby
+Lita.configure do |config|
+  config.robot.name = "Lita"
+  config.robot.adapter = :irc
+  config.adapter.server = "irc.freenode.net"
+  config.adapter.channels = ["#litabot"]
+  config.adapter.user = "Lita"
+  config.adapter.realname = "Lita"
+  config.adapter.password = "secret"
+end
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/lita/adapters/irc/cinch_plugin.rb

@@ -0,0 +1,55 @@
+require "securerandom"
+
+module Lita
+  module Adapters
+    class IRC < Adapter
+      class CinchPlugin
+        include Cinch::Plugin
+
+        match /.*/
+
+        def execute(m)
+          body = get_body(m)
+          source = get_source(m)
+          message = Message.new(robot, body, source)
+          message.command! unless source.room
+          dispatch(message)
+        end
+
+        private
+
+        def dispatch(message)
+          channel_text = " in #{message.source.room}" if message.source.room
+          Lita.logger.debug(<<-MSG.chomp
+Dispatching message to Lita from #{message.source.user.name}#{channel_text}.
+MSG
+          )
+          robot.receive(message)
+        end
+
+        def get_body(m)
+          if m.action?
+            m.action_message
+          else
+            m.message
+          end
+        end
+
+        def get_source(m)
+          user = user_by_nick(m.user.nick)
+          channel = m.channel ? m.channel.name : nil
+          Source.new(user, channel)
+        end
+
+        def robot
+          config[:robot]
+        end
+
+        def user_by_nick(nick)
+          Lita.logger.debug("Looking up user with nick: #{nick}.")
+          User.find_by_name(nick) || User.create(SecureRandom.uuid, name: nick)
+        end
+      end
+    end
+  end
+end

data/lib/lita/adapters/irc.rb

@@ -0,0 +1,87 @@
+require "cinch"
+
+require "lita"
+require "lita/adapters/irc/cinch_plugin"
+
+module Lita
+  module Adapters
+    class IRC < Adapter
+      require_configs :server, :channels
+
+      attr_reader :cinch
+
+      def initialize(robot)
+        super
+
+        @cinch = Cinch::Bot.new
+        normalize_config
+        configure_cinch
+        configure_logging
+        register_plugin
+      end
+
+      def run
+        Lita.logger.info("Connecting to IRC.")
+        cinch.start
+      end
+
+      def send_messages(target, strings)
+        if target.room
+          channel = Cinch::Channel.new(target.room, cinch)
+          strings.each { |s| channel.msg(s) }
+        else
+          user = Cinch::User.new(target.user.name, cinch)
+          strings.each { |s| user.msg(s) }
+        end
+      end
+
+      def set_topic(target, topic)
+        room = target.room
+        channel = Cinch::Channel.new(target.room, cinch)
+        Lita.logger.debug("Setting topic for channel #{room}: #{topic}")
+        channel.topic = topic
+      end
+
+      def shut_down
+        Lita.logger.info("Disconnecting from IRC.")
+        cinch.quit
+      end
+
+      private
+
+      def normalize_config
+        Lita.config.adapter.channels = Array(Lita.config.adapter.channels)
+        Lita.config.adapter.nick = Lita.config.robot.name
+      end
+
+      def configure_cinch
+        Lita.logger.debug("Configuring Cinch.")
+        cinch.configure do |config|
+          Lita.config.adapter.each do |key, value|
+            if config.class::KnownOptions.include?(key)
+              config.send("#{key}=", value)
+            end
+          end
+        end
+      end
+
+      def configure_logging
+        if Lita.config.adapter.log_level
+          cinch.loggers.level = Lita.config.adapter.log_level
+        else
+          cinch.loggers.clear
+        end
+      end
+
+      def register_plugin
+        cinch.configure do |config|
+          config.plugins.prefix = nil
+          config.plugins.plugins = [CinchPlugin]
+          config.plugins.options[CinchPlugin] = { robot: robot }
+        end
+      end
+    end
+
+    Lita.register_adapter(:irc, IRC)
+  end
+end

data/lib/lita-irc.rb

@@ -0,0 +1 @@
+require "lita/adapters/irc"

data/lita-irc.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-irc"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Jimmy Cuadra"]
+  spec.email         = ["jimmy@jimmycuadra.com"]
+  spec.description   = %q{An IRC adapter for Lita.}
+  spec.summary       = %q{An IRC adapter for the Lita chat robot.}
+  spec.homepage      = "https://github.com/jimmycuadra/lita-irc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", "~> 2.0"
+  spec.add_runtime_dependency "cinch", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14.0.rc1"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/spec/lita/adapters/cinch_plugin_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe Lita::Adapters::IRC::CinchPlugin do
+  subject { described_class.new(cinch) }
+
+  let(:robot) { double("Lita::Robot") }
+  let(:cinch) { double("Cinch::Bot").as_null_object }
+  let(:user) { double("Lita::User", name: "Carl") }
+  let(:message) { double("Lita::Message", command!: nil, source: source) }
+  let(:source) { double("Lita::Source", room: "#channel", user: user) }
+  let(:m) do
+    double(
+      "Cinch::Message",
+      action_message: "foo",
+      message: "bar",
+      action?: false
+    ).as_null_object
+  end
+
+  before do
+    allow(subject).to receive(:config).and_return(
+      double("Hash", :[] => robot)
+    )
+    allow(Lita::Source).to receive(:new).and_return(source)
+  end
+
+  describe "#execute" do
+    it "dispatches regular messages to the robot" do
+      allow(Lita::Message).to receive(:new).with(
+        robot,
+        "bar",
+        source
+      ).and_return(message)
+      expect(robot).to receive(:receive).with(message)
+      subject.execute(m)
+    end
+
+    it "dispatches action messages to the robot" do
+      allow(m).to receive(:action?).and_return(true)
+      allow(Lita::Message).to receive(:new).with(
+        robot,
+        "foo",
+        source
+      ).and_return(message)
+      expect(robot).to receive(:receive).with(message)
+      subject.execute(m)
+    end
+
+    it "marks private messages as commands" do
+      allow(source).to receive(:room).and_return(nil)
+      allow(Lita::Message).to receive(:new).with(
+        robot,
+        "bar",
+        source
+      ).and_return(message)
+      allow(robot).to receive(:receive)
+      expect(message).to receive(:command!)
+      subject.execute(m)
+    end
+  end
+end

data/spec/lita/adapters/irc_spec.rb

@@ -0,0 +1,106 @@
+require "spec_helper"
+
+describe Lita::Adapters::IRC, lita: true do
+  let(:robot) { double("Lita::Robot") }
+
+  subject { described_class.new(robot) }
+
+  before do
+    Lita.configure do |config|
+      config.adapter.server = "irc.example.com"
+      config.adapter.channels = "#lita"
+      config.adapter.user = "litabot"
+      config.adapter.password = "secret"
+      config.adapter.realname = "Lita the Robot"
+      config.adapter.nick = "NotLita"
+      config.adapter.max_reconnect_delay = 123
+    end
+  end
+
+  it "registers with Lita" do
+    expect(Lita.adapters[:irc]).to eql(described_class)
+  end
+
+  it "requires a server and channels" do
+    Lita.clear_config
+    expect(Lita.logger).to receive(:fatal).with(/server, channels/)
+    expect { subject }.to raise_error(SystemExit)
+  end
+
+  it "configures Cinch" do
+    subject.cinch.config.tap do |config|
+      expect(config.nick).to eq("Lita")
+      expect(config.server).to eq("irc.example.com")
+      expect(config.channels).to eq(["#lita"])
+      expect(config.user).to eq("litabot")
+      expect(config.password).to eq("secret")
+      expect(config.realname).to eq("Lita the Robot")
+      expect(config.max_reconnect_delay).to eq(123)
+    end
+  end
+
+  it "registers a plugin with Cinch" do
+    expect(subject.cinch.config.plugins.plugins).to include(
+      described_class::CinchPlugin
+    )
+  end
+
+  it "turns Cinch's logging on if config.adapter.log_level is set" do
+    Lita.config.adapter.log_level = :debug
+    expect(subject.cinch.loggers).not_to be_empty
+  end
+
+  describe "#run" do
+    it "connects to IRC" do
+      expect(subject.cinch).to receive(:start)
+      subject.run
+    end
+  end
+
+  describe "#send_messages" do
+    it "sends messages to rooms" do
+      source = double("Lita::Source", room: "#foo")
+      channel = double("Cinch::Channel")
+      allow(Cinch::Channel).to receive(:new).with(
+        "#foo",
+        subject.cinch
+      ).and_return(channel)
+      expect(channel).to receive(:msg).with("Hello!")
+      expect(channel).to receive(:msg).with("How are you?")
+      subject.send_messages(source, ["Hello!", "How are you?"])
+    end
+
+    it "sends messages to users" do
+      user = double("Lita::User", name: "Carl")
+      source = double("Lita::Source", room: nil, user: user)
+      user = double("Cinch::User")
+      allow(Cinch::User).to receive(:new).with(
+        "Carl",
+        subject.cinch
+      ).and_return(user)
+      expect(user).to receive(:msg).with("Hello!")
+      expect(user).to receive(:msg).with("How are you?")
+      subject.send_messages(source, ["Hello!", "How are you?"])
+    end
+  end
+
+  describe "#set_topic" do
+    it "sets a new topic for the room" do
+      source = double("Lita::Source", room: "#foo")
+      channel = double("Cinch::Channel")
+      expect(Cinch::Channel).to receive(:new).with(
+        "#foo",
+        subject.cinch
+      ).and_return(channel)
+      expect(channel).to receive(:topic=).with("Topic")
+      subject.set_topic(source, "Topic")
+    end
+  end
+
+  describe "#shut_down" do
+    it "disconnects from IRC" do
+      expect(subject.cinch).to receive(:quit)
+      subject.shut_down
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-irc"
+require "lita/rspec"

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: lita-irc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jimmy Cuadra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0.rc1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An IRC adapter for Lita.
+email:
+- jimmy@jimmycuadra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-irc.rb
+- lib/lita/adapters/irc.rb
+- lib/lita/adapters/irc/cinch_plugin.rb
+- lita-irc.gemspec
+- spec/lita/adapters/cinch_plugin_spec.rb
+- spec/lita/adapters/irc_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jimmycuadra/lita-irc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: An IRC adapter for the Lita chat robot.
+test_files:
+- spec/lita/adapters/cinch_plugin_spec.rb
+- spec/lita/adapters/irc_spec.rb
+- spec/spec_helper.rb
+has_rdoc: