jabber_admin 1.3.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea376d0db09cde039d2ce7dee6c11dec9a45ebf450470fba0b1b5a6ba322bc4
-  data.tar.gz: c7c4dc264ebcdc35316825dde83aaba4ff3846c732e3ae2f25b1cf090f389dfa
+  metadata.gz: 8c4af608b6ed7038365c714cb8ffea5270ccb1138fb7f739d448f53be85e1c99
+  data.tar.gz: 0f6a0f5d8d0d43781e3dde3451151e44f0e1acbab6419c25963912d8ca884946
 SHA512:
-  metadata.gz: 415fe8c34fa49cc70e2d24625e5f20e0b5f1388b5c2199f7e2d31f906872c905217d398e59756f4a7d9ae94336152312363d62cd0fc350e080824ed8b584c82b
-  data.tar.gz: 96fb1bbad1c8d0162ad50a768ab62b7317095f4db6e226827f4e4cfcdb718fce306822919b684961687eb09edccda56c739709c9a801dec7dfc5903d08f07eeb
+  metadata.gz: 516a0761b8f1e98e1eb33047826885beb1e75930cee6c555e2cfb76488f77efdff238aca93a96f140af0cc2e5d043fab7c4c4b6d556b02a4e700c052741dcce8
+  data.tar.gz: ef4cc3eaa6d182bf92387f1a995b8ea45c14b77e7a46f1234dc5ae21110cb4f468e2ddec4eb36954075646de929745010fd209b315b8d22aa971b0590c753de5

data/.github/workflows/test.yml

@@ -18,8 +18,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7']
-        rails: ['5.2', '6.1', '7.1']
+        ruby: ['2.7', '3.0']
+        rails: ['6.1', '7.1']
     env:
       BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:

data/.rubocop.yml

@@ -13,7 +13,7 @@ AllCops:
   SuggestExtensions: false
   DisplayCopNames: true
   TargetRubyVersion: 2.7
-  TargetRailsVersion: 5.2
+  TargetRailsVersion: 6.1
   Exclude:
     - bin/**/*
     - vendor/**/*

data/.yardopts

@@ -4,3 +4,4 @@
 -
 README.md
 doc/examples/**/*.rb
+doc/*.md

data/Appraisals

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-appraise 'rails-5.2' do
-  gem 'activesupport', '~> 5.2.0'
-end
-
 appraise 'rails-6.1' do
   gem 'activesupport', '~> 6.1.0'
 end

data/CHANGELOG.md

@@ -2,32 +2,40 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
-### 1.3.4
+### 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)
+
+### 1.3.4 (15 August 2024)
 
 * Just a retag of 1.3.1
 
-### 1.3.3
+### 1.3.3 (15 August 2024)
 
 * Just a retag of 1.3.1
 
-### 1.3.2
+### 1.3.2 (9 August 2024)
 
 * Just a retag of 1.3.1
 
-### 1.3.1
+### 1.3.1 (9 August 2024)
 
 * Added API docs building to continuous integration (#14)
 
-### 1.3.0
+### 1.3.0 (8 July 2024)
 
 * Moved the development dependencies from the gemspec to the Gemfile (#12)
 * Dropped support for Ruby <2.7 (#13)
 
-### 1.2.0
+### 1.2.0 (24 February 2023)
 
 * Added support for Gem release automation
 
-### 1.1.0
+### 1.1.0 (18 January 2023)
 
 * Bundler >= 2.3 is from now on required as minimal version (#11)
 * Dropped support for Ruby < 2.5 (#11)
@@ -35,32 +43,32 @@
 * Updated all development/runtime gems to their latest
   Ruby 2.5 compatible version (#11)
 
-### 1.0.5
+### 1.0.5 (20 January 2022)
 
 * 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
+### 1.0.4 (11 November 2021)
 
 * Added support for the predefined command `destroy_room`
 
-### 1.0.3
+### 1.0.3 (15 October 2021)
 
 * Migrated to Github Actions
 * Migrated to our own coverage reporting
 * Added the code statistics to the test process
 
-### 1.0.2
+### 1.0.2 (12 May 2021)
 
 * Corrected the GNU Make release target
 * Corrected the empty arguments check
 
-### 1.0.1
+### 1.0.1 (13 October 2020)
 
 * Gracefully handle a missing vCard when a vCard field is queried (#7)
 
-### 1.0.0
+### 1.0.0 (13 October 2020)
 
 * All `JabberAdmin` errors `[UnknownCommandError, CommandError, RequestError]`
   now ship the response object correctly (was always set to `nil` previously)
@@ -71,7 +79,7 @@
 * Dropped support for Ruby <2.5 (#6)
 * Added some versioning helpers (eg. `JabberAdmin.version`)
 
-### 0.2.0
+### 0.2.0 (14 May 2018)
 
 * [BC] The configuration has changed
   * `api_host` => `url`, we require now the full base URL of the REST API, this
@@ -94,7 +102,7 @@
 * The testcases were rewritten and tested with VCR against a real ejabberd
   server (18.01)
 
-### 0.1.4
+### 0.1.4 (23 January 2018)
 
 * Added support for predefined commands
   * ban_account

data/Gemfile

@@ -13,7 +13,7 @@ gem 'bundler', '~> 2.3'
 gem 'countless', '~> 1.1'
 gem 'guard-rspec', '~> 4.7'
 gem 'irb', '~> 1.2'
-gem 'railties', '>= 5.2'
+gem 'railties', '>= 6.1'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.12'
 gem 'rubocop', '~> 1.28'

data/gemfiles/rails_6.1.gemfile

@@ -7,7 +7,7 @@ gem "bundler", "~> 2.3"
 gem "countless", "~> 1.1"
 gem "guard-rspec", "~> 4.7"
 gem "irb", "~> 1.2"
-gem "railties", ">= 5.2"
+gem "railties", ">= 6.1"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.12"
 gem "rubocop", "~> 1.28"

data/gemfiles/rails_7.1.gemfile

@@ -7,7 +7,7 @@ gem "bundler", "~> 2.3"
 gem "countless", "~> 1.1"
 gem "guard-rspec", "~> 4.7"
 gem "irb", "~> 1.2"
-gem "railties", ">= 5.2"
+gem "railties", ">= 6.1"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.12"
 gem "rubocop", "~> 1.28"

data/jabber_admin.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7'
 
-  spec.add_runtime_dependency 'activesupport', '>= 5.2'
-  spec.add_runtime_dependency 'rest-client', '~> 2.1'
+  spec.add_dependency 'activesupport', '>= 6.1'
+  spec.add_dependency 'rest-client', '~> 2.1'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
 end

data/lib/jabber_admin/api_call.rb

@@ -108,25 +108,25 @@ module JabberAdmin
     # code which accepts the same arguments as the instance initialize method.
     # (+#new+)
     #
-    # @param command [String] the command to execute
-    # @param payload [Hash] the request payload, empty by default
+    # @param args [Array<Mixed>] the initializer arguments
+    # @param kwargs [Hash{Symbol => Mixed}] the initializer arguments
     # @return [RestClient::Response] the API call response
-    def self.perform(*args)
-      new(*args).perform
+    def self.perform(*args, **kwargs)
+      new(*args, **kwargs).perform
     end
 
     # A simple class level shortcut of the +perform!+ method. This is just DSL
     # code which accepts the same arguments as the instance initialize method.
     # (+#new+)
     #
-    # @param command [String] the command to execute
-    # @param payload [Hash] the request payload, empty by default
+    # @param args [Array<Mixed>] the initializer arguments
+    # @param kwargs [Hash{Symbol => Mixed}] the initializer arguments
     # @return [RestClient::Response] the API call response
     #
     # @raise JabberAdmin::ApiError
     # @raise JabberAdmin::CommandError
-    def self.perform!(*args)
-      new(*args).perform!
+    def self.perform!(*args, **kwargs)
+      new(*args, **kwargs).perform!
     end
   end
 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.3.4'
+  VERSION = '1.5.0'
 
   class << self
     # Returns the version of gem as a string.

data/lib/jabber_admin.rb

@@ -1,16 +1,11 @@
 # frozen_string_literal: true
 
+require 'zeitwerk'
 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,87 +48,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 all additional payload to pass down to the API call
-  # @return [RestClient::Response] the actual response of the command
-  def self.method_missing(method, *args)
-    predefined_command(method).call(predefined_callable(method), *args)
-  rescue NameError
-    predefined_callable(method).call(method.to_s.chomp('!'), *args)
-  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 { |*args| ApiCall.send(method, *args) }
-  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 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
 
-  # 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
+
+      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 self.respond_to_missing?(_method, _include_private = false)
-    true
+    # 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.3.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Hermann Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -74,13 +88,11 @@ files:
 - config/docker/.inputrc
 - doc/assets/project.svg
 - docker-compose.yml
-- gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.1.gemfile
 - 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
@@ -102,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/gemfiles/rails_5.2.gemfile

@@ -1,23 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal", "~> 2.4"
-gem "bundler", "~> 2.3"
-gem "countless", "~> 1.1"
-gem "guard-rspec", "~> 4.7"
-gem "irb", "~> 1.2"
-gem "railties", ">= 5.2"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.12"
-gem "rubocop", "~> 1.28"
-gem "rubocop-rails", "~> 2.14"
-gem "rubocop-rspec", "~> 2.10"
-gem "simplecov", ">= 0.22"
-gem "vcr", "~> 6.0"
-gem "webmock", "~> 3.18"
-gem "yard", ">= 0.9.28"
-gem "yard-activesupport-concern", ">= 0.0.1"
-gem "activesupport", "~> 5.2.0"
-
-gemspec path: "../"

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