lita 4.4.2 → 4.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a7e995f4c250faf7cb4ccb24fe606d338c26073
-  data.tar.gz: df5d314c0cc71b6c99810df59453f47c12c82227
+  metadata.gz: 60f8a5c4baff97cb21c6bda0e37416b919747443
+  data.tar.gz: 2ecdd16eb4c246c566178a31f4cfc277e0794282
 SHA512:
-  metadata.gz: df5cd5d29b7f262896e4c295eea4b9207020b389d8942f62992c950076dfd96b03e1bd0ae8a86522a7e5d4d0615eaf32a4d0cd98b4c4e63a8f8dda85f0576b8d
-  data.tar.gz: 68618e0d9c07a25439a15da5f2a8cf4ec00bc58698bf58cd708da1efc3e5023e1dd559b2f9c69b7cd2ae89736422601fa42572b4e6b68afc7772dd60255b4a12
+  metadata.gz: 1f9d6e452648e187da436d3b9fbb248ff90243abc47ac671340df664f42b4c12c7d7fb832f169583cb485dd4adb44b554a79f4751f6ba011b6be6ed22fdc35d0
+  data.tar.gz: 55d2096400b2dca088b16b40f07ae0888ed30ec98ad9dc6e873c5a2b7a23132b7b16c8649a3b61c49a1a0a6c9009c830bc0e7b5ce6f7c589aeef37c0b105eb57

data/lib/lita/adapter.rb

@@ -82,7 +82,7 @@ module Lita
     # @!method roster(room)
     # Get a list of users that are online in the given room.
     # @param room [Lita::Room] The room to return a roster for.
-    # @return [Array<Lita::Roster>] An array of users.
+    # @return [Array<Lita::User>] An array of users.
     # @abstract This should be implemented by the adapter.
     # @since 4.4.0
 

data/lib/lita/robot.rb

@@ -80,21 +80,40 @@ module Lita
     end
 
     # Makes the robot join a room with the specified ID.
-    # @param room_id [String] The ID of the room.
+    # @param room [Room, String] The room to join, as a {Lita::Room} object or a string identifier.
     # @return [void]
     # @since 3.0.0
-    def join(room_id)
-      Lita.redis.sadd("persisted_rooms", room_id)
-      adapter.join(room_id)
+    def join(room)
+      room_object = find_room(room)
+
+      if room_object
+        Lita.redis.sadd("persisted_rooms", room_object.id)
+        adapter.join(room_object.id)
+      else
+        adapter.join(room)
+      end
     end
 
     # Makes the robot part from the room with the specified ID.
-    # @param room_id [String] The ID of the room.
+    # @param room [Room, String] The room to leave, as a {Lita::Room} object or a string identifier.
     # @return [void]
     # @since 3.0.0
-    def part(room_id)
-      Lita.redis.srem("persisted_rooms", room_id)
-      adapter.part(room_id)
+    def part(room)
+      room_object = find_room(room)
+
+      if room_object
+        Lita.redis.srem("persisted_rooms", room_object.id)
+        adapter.part(room_object.id)
+      else
+        adapter.part(room)
+      end
+    end
+
+    # A list of room IDs the robot should join on boot.
+    # @return [Array<String>] An array of room IDs.
+    # @since 4.4.2
+    def persisted_rooms
+      Lita.redis.smembers("persisted_rooms").sort
     end
 
     # Sends one or more messages to a user or room.
@@ -162,11 +181,6 @@ module Lita
       end
     end
 
-    # A list of room IDs the robot should join.
-    def persisted_rooms
-      Lita.redis.smembers("persisted_rooms").sort
-    end
-
     private
 
     # Loads and caches the adapter on first access.
@@ -174,6 +188,16 @@ module Lita
       @adapter ||= load_adapter
     end
 
+    # Ensure the argument is a Lita::Room.
+    def find_room(room_or_identifier)
+      case room_or_identifier
+      when Room
+        room_or_identifier
+      else
+        Room.fuzzy_find(room_or_identifier)
+      end
+    end
+
     # Loads the selected adapter.
     def load_adapter
       adapter_name = config.robot.adapter

data/lib/lita/version.rb

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

data/spec/lita/robot_spec.rb

@@ -128,15 +128,34 @@ describe Lita::Robot, lita: true do
       allow_any_instance_of(Lita::Adapters::Shell).to receive(:join)
     end
 
-    it "delegates to the adapter" do
-      expect_any_instance_of(Lita::Adapters::Shell).to receive(:join).with("#lita.io")
-      subject.join("#lita.io")
+    context "when a Room object exists" do
+      let!(:room) { Lita::Room.create_or_update(1, name: "#lita.io") }
+
+      it "passes the room ID to the adapter when a string argument is provided" do
+        expect_any_instance_of(Lita::Adapters::Shell).to receive(:join).with("1")
+
+        subject.join("#lita.io")
+      end
+
+      it "passes the room ID to the adapter when a Room argument is provided" do
+        expect_any_instance_of(Lita::Adapters::Shell).to receive(:join).with("1")
+
+        subject.join(room)
+      end
+
+      it "adds the room ID to the persisted list" do
+        subject.join("#lita.io")
+
+        expect(subject.persisted_rooms).to include("1")
+      end
     end
 
-    it "adds the room ID to the persisted list" do
-      subject.join("#lita.io")
+    context "when no Room object exists" do
+      it "delegates to the adapter with the raw argument" do
+        expect_any_instance_of(Lita::Adapters::Shell).to receive(:join).with("#lita.io")
 
-      expect(Lita.redis.smembers("persisted_rooms")).to include("#lita.io")
+        subject.join("#lita.io")
+      end
     end
   end
 
@@ -146,17 +165,36 @@ describe Lita::Robot, lita: true do
       allow_any_instance_of(Lita::Adapters::Shell).to receive(:part)
     end
 
-    it "delegates to the adapter" do
-      expect_any_instance_of(Lita::Adapters::Shell).to receive(:part).with("#lita.io")
-      subject.part("#lita.io")
-    end
+    context "when a Room object exists" do
+      let!(:room) { Lita::Room.create_or_update(1, name: "#lita.io") }
+
+      it "passes the room ID to the adapter when a string argument is provided" do
+        expect_any_instance_of(Lita::Adapters::Shell).to receive(:part).with("1")
+
+        subject.part("#lita.io")
+      end
+
+      it "passes the room ID to the adapter when a Room argument is provided" do
+        expect_any_instance_of(Lita::Adapters::Shell).to receive(:part).with("1")
+
+        subject.part(room)
+      end
+
+      it "removes the room ID from the persisted list" do
+        subject.join("#lita.io")
+
+        subject.part("#lita.io")
 
-    it "removes the room ID from the persisted list" do
-      subject.join("#lita.io")
+        expect(subject.persisted_rooms).not_to include("1")
+      end
+    end
 
-      subject.part("#lita.io")
+    context "when no Room object exists" do
+      it "delegates to the adapter with the raw argument" do
+        expect_any_instance_of(Lita::Adapters::Shell).to receive(:part).with("#lita.io")
 
-      expect(Lita.redis.smembers("persisted_rooms")).not_to include("#lita.io")
+        subject.part("#lita.io")
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.4.3
 platform: ruby
 authors:
 - Jimmy Cuadra