jabber_admin 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b04fc09ea946409fccfdb4dd37b085e84418591c8c72f990b0e46c1ddb736e4
-  data.tar.gz: a9a74a6d345ba34ed5e06d81eda5df5140585778b5aae2196cb5263cccba2c1b
+  metadata.gz: f66fd5543a21b130fc4a24d7c6d9d05659e63b956c379f7973028f7902595e81
+  data.tar.gz: a4e3cb834dec2a20f2d093e1588ba24167d06cdb1db2d0ce0722d0c750a39c47
 SHA512:
-  metadata.gz: 326f9d15f3866893a7ec92de4a4475f59848321c8ff9c879eff6fd7d8d46b8cccad5a15a6c167650b3fba532b410837ba57cdc372e56869b35fae49e333def06
-  data.tar.gz: 70733d53fb23eba46c48baf9300cefadb8cfe178e1130b8640dd014f782becc8077a4186a868c8cbed8d255f6d166955f52ae48850483e906bd6247f294ea769
+  metadata.gz: a9b6847f6493eee80e7086ab76a01ab4bf0f29e11fc58451d048ece7954db51bd7c349bf7e572260475ef34982d4a7cdf92fe546105bacf55189ecead923f80e
+  data.tar.gz: 4dd98caa90adb727d1cca90bc4b4c914c6cb744826965819cd54695535a9d729d695b135318adf9a140b06782a9bd3790961b77cae2f3fa9b4aa346765de93a6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 1.0.5
+
+* Added support for the predefined command `get_room_affiliations` (#10)
+* Added the top-level helper `JabberAdmin.room_exist?` to determine whether
+  a room exists or not (#10)
+
 ### 1.0.4
 
 * Added support for the predefined command `destroy_room`

data/README.md

@@ -115,6 +115,7 @@ Here comes a list of all supported predefined commands:
 - [unregister](https://bit.ly/2wwYnDE)
 - [unsubscribe_room](https://bit.ly/2G5zcrj)
 - [destroy_room](https://bit.ly/31CtqxB)
+- [get_room_affiliations](https://bit.ly/3qI9Nyq)
 
 If you want to contribute more, we accept pull requests!
 

data/lib/jabber_admin/commands/get_room_affiliations.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    # Get room affiliations.
+    #
+    # @see https://bit.ly/3qI9Nyq
+    class GetRoomAffiliations
+      # Pass the correct data to the given callable.
+      #
+      # @param callable [Proc, #call] the callable to call
+      # @param room [String] room JID (eg. +room1@conference.localhost+)
+      def self.call(callable, room:)
+        name, service = room.split('@')
+        res = callable.call('get_room_affiliations', check_res_body: false,
+                                                     name: name,
+                                                     service: service)
+
+        res.body ? JSON.parse(res.body) : nil
+      end
+    end
+  end
+end

data/lib/jabber_admin/version.rb

@@ -4,7 +4,7 @@
 module JabberAdmin
   # The version constant of the gem. Increase this value
   # in case of a gem release.
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 
   class << self
     # Returns the version of gem as a string.

data/lib/jabber_admin.rb

@@ -112,6 +112,21 @@ module JabberAdmin
     proc { |*args| ApiCall.send(method, *args) }
   end
 
+  # Determine if a room exists. This is a convenience method for the
+  # +JabberAdmin::Commands::GetRoomAffiliations+ command, which can be used
+  # to reliably determine whether a room exists or not.
+  #
+  # @param room [String] the name of the room to check
+  # @return [Boolean] whether the room exists or not
+  def self.room_exist?(room)
+    get_room_affiliations!(room: room)
+    true
+  rescue JabberAdmin::CommandError => e
+    raise e unless /room does not exist/.match? e.response.body
+
+    false
+  end
+
   # We support all methods if you ask for. This is our dynamic command approach
   # here to support predefined and custom commands in the same namespace.
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jabber_admin
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Henning Vogt
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -260,6 +260,7 @@ files:
 - lib/jabber_admin/commands/create_room.rb
 - lib/jabber_admin/commands/create_room_with_opts.rb
 - lib/jabber_admin/commands/destroy_room.rb
+- lib/jabber_admin/commands/get_room_affiliations.rb
 - lib/jabber_admin/commands/get_vcard.rb
 - lib/jabber_admin/commands/muc_register_nick.rb
 - lib/jabber_admin/commands/register.rb
@@ -298,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Library for the ejabberd RESTful admin API