lita-hipchat 2.1.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3caf3e5aa475e362c0df849d97d9fb9aa6e357e9
-  data.tar.gz: ed234aaa8462ea9ef2879be9a107df398d5a90f0
+  metadata.gz: 8ad7f231798e72ad24098c645a8fb7eeeba583f3
+  data.tar.gz: c39205b24b33b1e0274fab0575d97a873ecebffa
 SHA512:
-  metadata.gz: a31c0c64b0d43365ad850eb21e7b2a98b9a65ad333495c3147259e2e27742dade106900a91a4b33fcf44c5a119a9bd9d31c38c9cf564daf53aebe2fd30bfe370
-  data.tar.gz: 04616bc35f867a8116d81f27c36920493cac185b011fee812343c1cd0cf63c5c1766da88fffac25c9eb7f7f0bdf20aa8ff32119e2a1f3a8938942dfb1688a23b
+  metadata.gz: d461fa2c0b10cfeccea84474ba310f11130ef29b0578de1861af6290ffed2be679a6476c3bf09b214638cc107d28e24f99766ff8d4487d3c165dcbd1e4a47753
+  data.tar.gz: b1cf4ae4f3d3e5a92c043dc149c72193973fb04e792db88889ee5c6b867fcf013a7ead3dd11e1948069c74bd8160d4661e236b18605eaad022a2f5a4edcf5fd6

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.0.0
+  - 2.0
+  - 2.1
+  - 2.2
 script: bundle exec rspec
 before_install:
   - gem update --system

data/README.md

@@ -27,7 +27,7 @@ Values for all of the following attributes can be found on the "XMPP/Jabber info
 
 * `server` (String) - The HipChat Server address. Override this with the full domain of your server if using a private HipChat Server installation. Default: `"chat.hipchat.com"`
 * `debug` (Boolean) - If `true`, turns on the underlying Jabber library's (xmpp4r) logger, which is fairly verbose. Default: `false`.
-* `rooms` (Symbol, Array<String>) - An array of room JIDs that Lita should join upon connection. Can also be the symbol `:all`, which will cause Lita to discover and join all rooms. Default: `nil` (no rooms).
+* **DEPRECATED** - `rooms` (Symbol, Array<String>) - An array of room JIDs that Lita should join upon connection. Can also be the symbol `:all`, which will cause Lita to discover and join all rooms. Default: `nil` (no rooms).
 * `muc_domain` (String) - The XMPP Multi-User Chat domain to use. Default: `"conf.hipchat.com"`.
 * `ignore_unknown_users` (Boolean) - Messages generated through HipChat's API which don't come from a real user account will be ignored by the robot. With the default setting of false, Lita will emit a warning but the message will be dispatched to any registered handlers as usual. Default: `false`.
 
@@ -55,6 +55,10 @@ end
 `:joined` - When the robot joins a room. Payload: `:room`: The String room ID that was joined.
 `:parted` - When the robot parts from a room. Payload: `:room`: The String room ID that was parted from.
 
+## Managing rooms
+
+To make Lita join or part from rooms, use the [built-in `join` and `part` commands](http://docs.lita.io/getting-started/usage/#managing-rooms). For backwards compatibility, the `rooms` configuration attribute will be supported until lita-hipchat 4.0, but you should remove it and begin using the new command instead. If the configuration attribute is set, lita-hipchat will honor its value and join those rooms instead of the ones persisted to Redis from using the new commands.
+
 ## License
 
 [MIT](http://opensource.org/licenses/MIT)

data/lib/lita-hipchat.rb

@@ -1 +1,7 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
 require "lita/adapters/hipchat"

data/lib/lita/adapters/hipchat.rb

@@ -41,7 +41,7 @@ module Lita
       def run
         connector.connect
         robot.trigger(:connected)
-        rooms.each { |r| join(r) }
+        join_persisted_rooms
         sleep
       rescue Interrupt
         shut_down
@@ -67,18 +67,35 @@ module Lita
 
       private
 
-      def rooms
-        if config.rooms == :all
-          connector.list_rooms(muc_domain)
-        else
-          Array(config.rooms)
-        end
+      def join_all_rooms?
+        config.rooms == :all
+      end
+
+      def join_persisted_rooms
+        rooms.each { |room| join(room) }
       end
 
       def muc_domain
         config.muc_domain.dup
       end
 
+      def rooms_configured?
+        config.rooms.respond_to?(:empty?) && !config.rooms.empty?
+      end
+
+      def rooms
+        if join_all_rooms? || rooms_configured?
+          log.warn(t("config.rooms.deprecated"))
+
+          if config.rooms == :all
+            connector.list_rooms(muc_domain)
+          else
+            Array(config.rooms)
+          end
+        else
+          robot.persisted_rooms
+        end
+      end
     end
 
     Lita.register_adapter(:hipchat, HipChat)

data/lib/lita/adapters/hipchat/connector.rb

@@ -111,6 +111,7 @@ module Lita
         def client_connect
           Lita.logger.info("Connecting to HipChat.")
           client.connect(@server)
+          sleep 0.0001 until client.is_connected?
           Lita.logger.debug("Authenticating with HipChat.")
           client.auth(@password)
         end

data/lita-hipchat.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-hipchat"
-  spec.version       = "2.1.3"
+  spec.version       = "3.0.0"
   spec.authors       = ["Jimmy Cuadra"]
   spec.email         = ["jimmy@jimmycuadra.com"]
   spec.description   = %q{A HipChat adapter for Lita.}
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "lita", ">= 4.0"
+  spec.add_runtime_dependency "lita", ">= 4.4.3"
   spec.add_runtime_dependency "xmpp4r", ">= 0.5.6"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  lita:
+    adapters:
+      hipchat:
+        config:
+          rooms:
+            deprecated: >-
+              config.rooms is deprecated and will be removed in lita-hipchat 4.0.
+              Use the built-in `join` and `part` commands to manage rooms instead.

data/spec/lita/adapters/hipchat/connector_spec.rb

@@ -10,6 +10,7 @@ describe Lita::Adapters::HipChat::Connector, lita: true do
     allow(client).to receive(:connect)
     allow(client).to receive(:send)
     allow(client).to receive(:on_exception)
+    allow(client).to receive(:is_connected?).and_return(true)
     client
   end
 

data/spec/lita/adapters/hipchat_spec.rb

@@ -7,6 +7,8 @@ describe Lita::Adapters::HipChat, lita: true do
     registry.configure do |config|
       config.adapters.hipchat.jid = "jid"
       config.adapters.hipchat.password = "secret"
+      config.adapters.hipchat.muc_domain = domain
+      config.adapters.hipchat.rooms = rooms
     end
 
     allow(described_class::Connector).to receive(:new).and_return(connector)
@@ -17,6 +19,7 @@ describe Lita::Adapters::HipChat, lita: true do
   let(:robot) { Lita::Robot.new(registry) }
   let(:connector) { instance_double("Lita::Adapters::HipChat::Connector") }
   let(:domain) { "conf.hipchat.com" }
+  let(:rooms) { %w(room_1, room_2) }
 
   it "registers with Lita" do
     expect(Lita.adapters[:hipchat]).to eql(described_class)
@@ -51,8 +54,6 @@ describe Lita::Adapters::HipChat, lita: true do
   end
 
   describe "#run" do
-    let(:rooms) { ["room_1_id", "room_2_id"] }
-
     before do
       allow(subject.connector).to receive(:connect)
       allow(robot).to receive(:trigger)
@@ -68,30 +69,67 @@ describe Lita::Adapters::HipChat, lita: true do
 
     context "with a custom domain" do
       let(:domain) { "foo.bar.com" }
+
       it "joins rooms with a custom muc_domain" do
-        registry.config.adapters.hipchat.muc_domain = domain
-        allow(subject).to receive(:rooms).and_return(rooms)
         expect(subject.connector).to receive(:join).with(domain, anything)
+
         subject.run
       end
     end
 
-    it "joins all rooms when config.rooms is :all" do
-      registry.config.adapters.hipchat.rooms = :all
-      allow(subject.connector).to receive(:list_rooms).with(domain).and_return(rooms)
-      rooms.each do |room|
-        expect(subject).to receive(:join).with(room)
+    context "when config.rooms is :all" do
+      before do
+        allow(subject.connector).to receive(:list_rooms).and_return(%w(room_1 room_2))
+        allow(subject.connector).to receive(:join)
+      end
+
+      let(:rooms) { :all }
+
+      it "logs a deprecation warning" do
+        expect(Lita.logger).to receive(:warn) do |msg|
+          expect(msg).to include("config.rooms is deprecated")
+        end
+
+        subject.run
+      end
+
+      it "joins all rooms" do
+        %w(room_1 room_2).each do |room|
+          expect(subject.connector).to receive(:join).with(domain, room)
+        end
+
+        subject.run
+      end
+    end
+
+    context "when config.rooms contains individual room IDs" do
+      let(:rooms) { ["room_1_only"] }
+
+      it "logs a deprecation warning" do
+        expect(Lita.logger).to receive(:warn) do |msg|
+          expect(msg).to include("config.rooms is deprecated")
+        end
+
+        subject.run
+      end
+
+      it "joins the specified rooms" do
+        expect(subject.connector).to receive(:join).with(domain, "room_1_only")
+
+        subject.run
       end
-      subject.run
     end
 
-    it "joins rooms specified by config.rooms" do
-      custom_rooms = rooms
-      registry.config.adapters.hipchat.rooms = custom_rooms
-      rooms.each do |room|
-        expect(subject).to receive(:join).with(room)
+    context "when config.rooms is empty" do
+      before { allow(robot).to receive(:persisted_rooms).and_return(%w(persisted_room_1)) }
+
+      let(:rooms) { [] }
+
+      it "joins rooms persisted in robot.persisted_rooms" do
+        expect(subject.connector).to receive(:join).with(domain, "persisted_room_1")
+
+        subject.run
       end
-      subject.run
     end
 
     it "sleeps the main thread" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-hipchat
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-07 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.4.3
 - !ruby/object:Gem::Dependency
   name: xmpp4r
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,7 @@ files:
 - lib/lita/adapters/hipchat/callback.rb
 - lib/lita/adapters/hipchat/connector.rb
 - lita-hipchat.gemspec
+- locales/en.yml
 - spec/lita/adapters/hipchat/callback_spec.rb
 - spec/lita/adapters/hipchat/connector_spec.rb
 - spec/lita/adapters/hipchat_spec.rb
@@ -160,3 +161,4 @@ test_files:
 - spec/lita/adapters/hipchat/connector_spec.rb
 - spec/lita/adapters/hipchat_spec.rb
 - spec/spec_helper.rb
+has_rdoc: