jabber_admin 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9456a35e8ad22426e8e27ddbd157c614fd92533324c280c3bb11fd235dac31c5
-  data.tar.gz: 05c3750afd3f862405206eab6a8b25398be58617601831c4d5140e79a381e225
+  metadata.gz: 6fa0d27d4b8c2a0a59245d30cde035edc63b28e470d015d33b00ef966f28de4d
+  data.tar.gz: 14799e6fdadf03f199e1e80832f9b471843a3d4e9c994043ade9cb20e64ba314
 SHA512:
-  metadata.gz: 55b2d011af88ecd7e0d26825de7aae04e95f58b85c341de30f290a8462afe001773263ad60fbf7c0a7cdd22a62853b638dcd31f432e2a5c0cac92a6aeb4c63b5
-  data.tar.gz: 1059978f0ac40003853bcab9861b1de4f31248184687bacdb8988da5882f2f5636fc614c485caae23cc2538591391c98e8764de80a41b328e01c0a9300feb5ec
+  metadata.gz: c719550407ca39da92b3b6c6ac08b0c38e5f3aa57c92128ea9f6f29170fc2cec6ebb10a9abea605d09587fa9f2f21c1b3f9c9a897e8572fd4823e32bb3d664a2
+  data.tar.gz: e6ce78a3ccc5504266bb2c10b7180d7f4b8d679069b658a6a0340e7708afed11b81cb311c113eab5bfc43e176803f7a516e5e9f451f4b7f0b91240e35e3306f5

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 1.5.1 (17 January 2025)
+
+* Added the logger dependency (#17)
+
+### 1.5.0 (12 January 2025)
+
+* Switched to Zeitwerk as autoloader (#16)
+
 ### 1.4.0 (3 January 2025)
 
 * Raised minimum supported Ruby/Rails version to 2.7/6.1 (#15)

data/jabber_admin.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 6.1'
   spec.add_dependency 'rest-client', '~> 2.1'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
 end

data/lib/jabber_admin/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module JabberAdmin
   # The version of the +jabber_admin+ gem
-  VERSION = '1.4.0'
+  VERSION = '1.5.1'
 
   class << self
     # Returns the version of gem as a string.

data/lib/jabber_admin.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
+require 'zeitwerk'
+require 'logger'
 require 'active_support/inflector'
 require 'json'
 require 'pathname'
 require 'rest-client'
 
-require 'jabber_admin/exceptions'
-require 'jabber_admin/configuration'
-require 'jabber_admin/commands'
-require 'jabber_admin/api_call'
-require 'jabber_admin/version'
-
 # jabber_admin
 #
 # This gem allows making API calls to the ejabberd RESTful admin backend.  We
@@ -53,96 +49,116 @@ require 'jabber_admin/version'
 # @example Delete a user from the XMPP service, in fire and forget manner
 #   JabberAdmin.unregister user: 'peter@example.com'
 module JabberAdmin
+  # Configure the relative gem code base location
+  root_path = Pathname.new("#{__dir__}/jabber_admin")
+
+  # Setup a Zeitwerk autoloader instance and configure it
+  loader = Zeitwerk::Loader.for_gem
+
+  # Do not auto load some parts of the gem
+  loader.ignore(root_path.join('errors.rb'))
+
+  # Finish the auto loader configuration
+  loader.setup
+
+  # Load standalone code
+  require 'jabber_admin/version'
+  require 'jabber_admin/errors'
+
+  # Make sure to eager load all constants
+  loader.eager_load
+
   class << self
     attr_writer :configuration
-  end
 
-  # A simple getter to the global JabberAdmin configuration structure.
-  #
-  # @return [JabberAdmin::Configuration] the global JabberAdmin configuration
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+    # A simple getter to the global JabberAdmin configuration structure.
+    #
+    # @return [JabberAdmin::Configuration] the global JabberAdmin configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
-  # Class method to set and change the global configuration. This is just a
-  # tapped variant of the +.configuration+ method.
-  #
-  # @yield [configuration]
-  # @yieldparam [JabberAdmin::Configuration] configuration
-  def self.configure
-    yield(configuration)
-  end
+    # Class method to set and change the global configuration. This is just a
+    # tapped variant of the +.configuration+ method.
+    #
+    # @yield [configuration]
+    # @yieldparam [JabberAdmin::Configuration] configuration
+    def configure
+      yield(configuration)
+    end
 
-  # Allow an easy to use DSL on the +JabberAdmin+ module. We support predefined
-  # (known) commands and unknown ones in bang and non-bang variants. This
-  # allows maximum flexibility to the user. The bang versions perform the
-  # response checks and raise in case of issues. The non-bang versions skip
-  # this checks. For unknown commands the +JabberAdmin::ApiCall+ is directly
-  # utilized with the method name as command. (Without the trailling bang, when
-  # it is present)
-  #
-  # @param method [Symbol, String, #to_s] the name of the command to run
-  # @param args [Array<Mixed>] all additional API call payload
-  # @param kwargs [Hash{Symbol => Mixed}] all additional API call payload
-  # @return [RestClient::Response] the actual response of the command
-  def self.method_missing(method, *args, **kwargs)
-    predefined_command(method).call(
-      predefined_callable(method), *args, **kwargs
-    )
-  rescue NameError
-    predefined_callable(method).call(method.to_s.chomp('!'), *args, **kwargs)
-  end
+    # Allow an easy to use DSL on the +JabberAdmin+ module. We support
+    # predefined (known) commands and unknown ones in bang and non-bang
+    # variants. This allows maximum flexibility to the user. The bang versions
+    # perform the response checks and raise in case of issues. The non-bang
+    # versions skip this checks. For unknown commands the
+    # +JabberAdmin::ApiCall+ is directly utilized with the method name as
+    # command. (Without the trailling bang, when it is present)
+    #
+    # @param method [Symbol, String, #to_s] the name of the command to run
+    # @param args [Array<Mixed>] all additional API call payload
+    # @param kwargs [Hash{Symbol => Mixed}] all additional API call payload
+    # @return [RestClient::Response] the actual response of the command
+    def method_missing(method, *args, **kwargs)
+      predefined_command(method).call(
+        predefined_callable(method), *args, **kwargs
+      )
+    rescue NameError
+      predefined_callable(method).call(method.to_s.chomp('!'), *args, **kwargs)
+    end
 
-  # Try to find the given name as a predefined command. When there is no such
-  # predefined command, we raise a +NameError+.
-  #
-  # @param name [Symbol, String, #to_s] the command name to lookup
-  # @return [Class] the predefined command class constant
-  def self.predefined_command(name)
-    # Remove bangs and build the camel case variant
-    "JabberAdmin::Commands::#{name.to_s.chomp('!').camelize}".constantize
-  end
+    # Try to find the given name as a predefined command. When there is no such
+    # predefined command, we raise a +NameError+.
+    #
+    # @param name [Symbol, String, #to_s] the command name to lookup
+    # @return [Class] the predefined command class constant
+    def predefined_command(name)
+      # Remove bangs and build the camel case variant
+      "JabberAdmin::Commands::#{name.to_s.chomp('!').camelize}".constantize
+    end
 
-  # Generate a matching API call wrapper for the given command name. When we
-  # have to deal with a bang version, we pass the bang down to the API call
-  # instance. Otherwise we just run the regular +#perform+ method on the API
-  # call instance.
-  #
-  # @param name [Symbol, String, #to_s] the command name to match
-  # @return [Proc] the API call wrapper
-  def self.predefined_callable(name)
-    method = name.to_s.end_with?('!') ? 'perform!' : 'perform'
-    proc do |*args, **kwargs|
-      if kwargs.empty?
-        ApiCall.send(method, *args)
-      else
-        ApiCall.send(method, *args, **kwargs)
+    # Generate a matching API call wrapper for the given command name. When we
+    # have to deal with a bang version, we pass the bang down to the API call
+    # instance. Otherwise we just run the regular +#perform+ method on the API
+    # call instance.
+    #
+    # @param name [Symbol, String, #to_s] the command name to match
+    # @return [Proc] the API call wrapper
+    def predefined_callable(name)
+      method = name.to_s.end_with?('!') ? 'perform!' : 'perform'
+      proc do |*args, **kwargs|
+        if kwargs.empty?
+          ApiCall.send(method, *args)
+        else
+          ApiCall.send(method, *args, **kwargs)
+        end
       end
     end
-  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
+    # 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 room_exist?(room)
+      get_room_affiliations!(room: room)
+      true
+    rescue JabberAdmin::CommandError => e
+      raise e unless /room does not exist/.match? e.response.body
 
-  # 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.
-  #
-  # @param method [String] the method to lookup
-  # @param include_private [Boolean] allow the lookup of private methods
-  # @return [Boolean] always +true+
-  def self.respond_to_missing?(_method, _include_private = false)
-    true
+      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.
+    #
+    # @param method [String] the method to lookup
+    # @param include_private [Boolean] allow the lookup of private methods
+    # @return [Boolean] always +true+
+    def respond_to_missing?(_method, _include_private = false)
+      true
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jabber_admin
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Hermann Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-03 00:00:00.000000000 Z
+date: 2025-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: Library for the ejabberd RESTful admin API
 email:
 - hermann.mayer92@gmail.com
@@ -79,7 +93,6 @@ files:
 - jabber_admin.gemspec
 - lib/jabber_admin.rb
 - lib/jabber_admin/api_call.rb
-- lib/jabber_admin/commands.rb
 - lib/jabber_admin/commands/ban_account.rb
 - lib/jabber_admin/commands/create_room.rb
 - lib/jabber_admin/commands/create_room_with_opts.rb
@@ -101,7 +114,7 @@ files:
 - lib/jabber_admin/commands/unregister.rb
 - lib/jabber_admin/commands/unsubscribe_room.rb
 - lib/jabber_admin/configuration.rb
-- lib/jabber_admin/exceptions.rb
+- lib/jabber_admin/errors.rb
 - lib/jabber_admin/version.rb
 homepage: 
 licenses:

data/lib/jabber_admin/commands.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module JabberAdmin
-  # Contains all predefined commands that are supported.
-  module Commands; end
-end
-
-# Require all commands from the commands subfolder
-Dir[Pathname.new(__dir__).join('commands', '**', '*.rb')].sort.each do |file|
-  require file
-end