lita-irc 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5f6718f839abd60bc28ecfa83cc7fdad901bc39
-  data.tar.gz: cfe790709ff47c4e191e481099bee658e5049abf
+  metadata.gz: 4395b1f99ddbd742dd59d2393d3e396671167cdb
+  data.tar.gz: a3eb5703529d4b9498b0a4ab8d8e0154da14b345
 SHA512:
-  metadata.gz: 12fd0af0616013b03b98f74ed7d490f759e5b4bc55684c604642803cf2f695b2cbc17b2dc18d03be4016d95f4e386bca283208f3475efc6fd9574acf4233f9ef
-  data.tar.gz: b55553fd2aab232ec95a82be7ca433b8bd2c33628a0d375e4c1462e1ad28a97d562528be1b3aee78ce3f3a1bb4b6e8377b78c56b2c42da40f57579912423b948
+  metadata.gz: f0eed00861cc230928a47ff74d087fe6c477a6b577cd6658f1ae66d2bcee0c432b4c825f4ba4baa22da5eca3cba4a7fbf9ad88ca723c3a29118c872ef5f9efc5
+  data.tar.gz: 1bc336e4c560da4740dbc342c06e1206d39182c3955d5c414cbdfb6fad360b6d96287ed4993af4af5abe62528481b6a1372b20d7c4a874fce6777cbaa3df3206

data/README.md

@@ -16,26 +16,23 @@ 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`.
+* `server` (String) - The name of the IRC server Lita should connect to.
+* `channels` (Array<String>) - An array of channels Lita should join upon connection.
 
 ### Optional attributes
 
-* `user` (String) - The username for Lita's IRC account. Default: `"Lita"".
+* `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"`.
+* `log_level` (Symbol) - Sets the log level for Cinch's loggers. By default, Cinch's loggers are disabled. Default: `nil`.
 
-### Lita-specific attributes
+**Note**: `config.robot.name` is used as Lita's IRC nickname. `config.adapters.irc.nick` is ignored.
 
-* `log_level` (Symbol) - Sets the log level for Cinch's loggers. By default, Cinch's loggers are disabled. Default: `nil`.
+### Additional Cinch options
 
-**Note**: `config.robot.name` is used as Lita's IRC nickname. `config.adapter.nick` is ignored.
+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.
 
 ### Example
 
@@ -43,11 +40,14 @@ The attributes listed below are either fundamental to making the bot work, or ha
 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"
+  config.adapters.irc.server = "irc.freenode.net"
+  config.adapters.irc.channels = ["#litabot"]
+  config.adapters.irc.user = "Lita"
+  config.adapters.irc.realname = "Lita"
+  config.adapters.irc.password = "secret"
+  config.adapters.irc.cinch = lambda do |cinch_config|
+    cinch_config.max_reconnect_delay = 123
+  end
 end
 ```
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita/adapters/irc.rb

@@ -6,7 +6,20 @@ require "lita/adapters/irc/cinch_plugin"
 module Lita
   module Adapters
     class IRC < Adapter
-      require_configs :server, :channels
+      # Required attributes
+      config :channels, type: [Array, String], required: true
+      config :server, type: String, required: true
+
+      # Optional attributes
+      config :user, type: String, default: "Lita"
+      config :password, type: String
+      config :realname, type: String, default: "Lita"
+      config :log_level, type: Symbol
+      config :cinch do
+        validate do |value|
+          "must be a callable object" unless value.respond_to?(:call)
+        end
+      end
 
       attr_reader :cinch
 
@@ -58,42 +71,38 @@ module Lita
       private
 
       def channels
-        Array(Lita.config.adapter.channels)
-      end
-
-      def nick
-        Lita.config.robot.name
+        Array(robot.config.adapters.irc.channels)
       end
 
       def configure_cinch
         Lita.logger.debug("Configuring Cinch.")
-        cinch.configure do |config|
-          config.channels = channels
-          config.nick = nick
 
-          Lita.config.adapter.each do |key, value|
-            next if [:channels, :nick].include?(key.to_sym)
+        cinch.configure do |cinch_config|
+          config.cinch.call(cinch_config) if config.cinch
+
+          cinch_config.channels = channels
+          cinch_config.server = config.server
+          cinch_config.nick = robot.config.robot.name
 
-            if config.class::KnownOptions.include?(key)
-              config.send("#{key}=", value)
-            end
-          end
+          cinch_config.user = config.user if config.user
+          cinch_config.password = config.password if config.password
+          cinch_config.realname = config.realname if config.realname
         end
       end
 
       def configure_logging
-        if Lita.config.adapter.log_level
-          cinch.loggers.level = Lita.config.adapter.log_level
+        if config.log_level
+          cinch.loggers.level = config.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 }
+        cinch.configure do |cinch_config|
+          cinch_config.plugins.prefix = nil
+          cinch_config.plugins.plugins = [CinchPlugin]
+          cinch_config.plugins.options[CinchPlugin] = { robot: robot }
         end
       end
     end

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

@@ -24,7 +24,7 @@ module Lita
 
         def on_invite(m)
           user = user_by_nick(m.user.nick)
-          m.channel.join if Lita::Authorization.user_is_admin?(user)
+          m.channel.join if robot.auth.user_is_admin?(user)
         end
 
         private

data/lita-irc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-irc"
-  spec.version       = "1.3.0"
+  spec.version       = "2.0.0"
   spec.authors       = ["Jimmy Cuadra"]
   spec.email         = ["jimmy@jimmycuadra.com"]
   spec.description   = %q{An IRC adapter for Lita.}
@@ -14,12 +14,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "lita", ">= 2.5"
+  spec.add_runtime_dependency "lita", ">= 4.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", ">= 3.0.0.beta2"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
 end

data/spec/lita/adapters/irc/cinch_plugin_spec.rb

@@ -3,7 +3,8 @@ require "spec_helper"
 describe Lita::Adapters::IRC::CinchPlugin do
   subject { described_class.new(cinch) }
 
-  let(:robot) { double("Lita::Robot") }
+  let(:authorization) { instance_double("Lita::Authorization") }
+  let(:robot) { double("Lita::Robot", auth: authorization) }
   let(:cinch) { double("Cinch::Bot").as_null_object }
   let(:user) { double("Lita::User", name: "Carl") }
   let(:message) { double("Lita::Message", command!: nil, source: source) }
@@ -64,9 +65,13 @@ describe Lita::Adapters::IRC::CinchPlugin do
   end
 
   describe "#on_invite" do
+    before do
+      allow(authorization).to receive(:user_is_admin?).and_return(false)
+    end
+
     it "joins the room if the invite came from an admin" do
       allow(subject).to receive(:user_by_nick).and_return(user)
-      allow(Lita::Authorization).to receive(:user_is_admin?).with(user).and_return(true)
+      allow(authorization).to receive(:user_is_admin?).with(user).and_return(true)
       expect(invite_m.channel).to receive(:join)
       subject.on_invite(invite_m)
     end

data/spec/lita/adapters/irc_spec.rb

@@ -1,19 +1,23 @@
 require "spec_helper"
 
 describe Lita::Adapters::IRC, lita: true do
-  let(:robot) { instance_double("Lita::Robot") }
+  let(:robot) { Lita::Robot.new(registry) }
 
   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
+    registry.register_adapter(:irc, described_class)
+
+    registry.configure do |config|
+      config.adapters.irc.server = "irc.example.com"
+      config.adapters.irc.channels = "#lita"
+      config.adapters.irc.user = "litabot"
+      config.adapters.irc.password = "secret"
+      config.adapters.irc.realname = "Lita the Robot"
+      config.adapters.irc.cinch = lambda do |c|
+        c.nick = "NotLita"
+        c.sasl.username = "sasl username"
+      end
     end
   end
 
@@ -21,12 +25,6 @@ describe Lita::Adapters::IRC, lita: true 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")
@@ -35,7 +33,7 @@ describe Lita::Adapters::IRC, lita: true do
       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)
+      expect(config.sasl.username).to eq("sasl username")
     end
   end
 
@@ -44,7 +42,7 @@ describe Lita::Adapters::IRC, lita: true do
   end
 
   it "turns Cinch's logging on if config.adapter.log_level is set" do
-    Lita.config.adapter.log_level = :debug
+    registry.config.adapters.irc.log_level = :debug
     expect(subject.cinch.loggers).not_to be_empty
   end
 

data/spec/spec_helper.rb

@@ -8,3 +8,5 @@ SimpleCov.start { add_filter "/spec/" }
 
 require "lita-irc"
 require "lita/rspec"
+
+Lita.version_3_compatibility_mode = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-irc
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-23 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: cinch
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An IRC adapter for the Lita chat robot.
@@ -157,4 +157,3 @@ test_files:
 - spec/lita/adapters/irc/cinch_plugin_spec.rb
 - spec/lita/adapters/irc_spec.rb
 - spec/spec_helper.rb
-has_rdoc: