jabber_admin 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbbc33d130b82b9b8d0021fade4490b783e9fc3bb8bac0f51e03dbfdfa06fcd6
-  data.tar.gz: 414c4bc17fb5e19846c4274f1d04cbae46637d2f78bacf85aad8f48c2c6466de
+  metadata.gz: 7780c8908ad5c57767c7ffc6b73ccd6069047d158a23b2ca134f602a4dd3b41e
+  data.tar.gz: 9cb29334e9306b201990516958116c0e61122ca0e20110d2ab4745217eed5504
 SHA512:
-  metadata.gz: a4d24d94e170a6aba859bf74786eea8d8d91e66fdc23398029bd33e78476bde457502b57e390e1d58d6c317f7c4a961ce7de4076c826ec124154daa12edefa89
-  data.tar.gz: 6a3ad9eec3fe7dd556f4f978006eeab22a9f966b88f3c52abeab7fb9ec18ec6e547acc0bf9d7fd234c911e372f44c55705113a077def1465f092a78b225cc9a4
+  metadata.gz: f600aaaa4728684447546519fe2cca5aff31c56ffce9c80281b36c5ef53b971b4a62bde6aa4f404c37b47bb1a7e133318284fe8743aab984aa30ef9401ab255e
+  data.tar.gz: c0afc0f2ad68411033dd3341b685bc236288bae51134f5190025076c3af8e9a7da60c9a52127c5511d9b0e0ada0f7b17f44348417e300c9e91dd0bf9c7cc2adc

data/.rubocop.yml

@@ -1,3 +1,7 @@
+inherit_from:
+  - https://potpourri.hausgold.de/config/rubocop.yml
+  - https://potpourri.hausgold.de/config/rubocop-gem.yml
+
 plugins:
   - rubocop-rspec
   - rubocop-rails
@@ -5,9 +9,6 @@ plugins:
 Rails:
   Enabled: true
 
-Style/Documentation:
-  Enabled: true
-
 AllCops:
   NewCops: enable
   SuggestExtensions: false
@@ -20,34 +21,3 @@ AllCops:
     - config/**/*
     - build/**/*
     - gemfiles/**/*
-
-Metrics/BlockLength:
-  Exclude:
-    - Rakefile
-    - spec/**/*.rb
-    - '**/*.rake'
-    - '*.gemspec'
-
-# MFA is not yet enabled for our gems yet.
-Gemspec/RequireMFA:
-  Enabled: false
-
-# Document all the things.
-Style/DocumentationMethod:
-  Enabled: true
-  RequireForNonPublicMethods: true
-
-# Because +expect_any_instance_of().to have_received()+ is not
-# supported with the +with(hash_including)+ matchers
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-# Allow deeper nesting because of the predefined/non-predefined -
-# bang/non-bang cases.
-RSpec/NestedGroups:
-  Max: 4
-
-# We stay at 80 characters per line.
-# See: https://rubystyle.guide/#max-line-length
-Layout/LineLength:
-  Max: 80

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 2.2.0 (19 December 2025)
+
+* Migrated to a shared Rubocop configuration for HAUSGOLD gems ([#24](https://github.com/hausgold/jabber_admin/pull/24))
+
 ### 2.1.0 (24 October 2025)
 
 * Added support for Rails 8.1 ([#23](https://github.com/hausgold/jabber_admin/pull/23))

data/Envfile

@@ -1,3 +1,4 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
+RUBOCOP_CACHE_ROOT=/app/tmp

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 HAUSGOLD | talocasa GmbH
+Copyright (c) 2025 HAUSGOLD | talocasa GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/jabber_admin/api_call.rb

@@ -21,14 +21,14 @@ module JabberAdmin
 
     # The resulting URL of the API call. This URL is constructed with the
     # +JabberAdmin.configuration.url+ as base and the command name as the
-    # suffix. The configuration is allowed to end with trailling slash, or not.
+    # suffix. The configuration is allowed to end with trailing slash, or not.
     #
     # @return [String] the API call URL
     def url
       "#{JabberAdmin.configuration.url.strip.chomp('/')}/#{@command}"
     end
 
-    # This method compose the actual request, perfoms it and stores the
+    # This method compose the actual request, performs it and stores the
     # response to the instance.  Additional calls to this method will not
     # repeat the request, but will deliver the response directly.
     #
@@ -50,9 +50,6 @@ module JabberAdmin
     #
     # @raise JabberAdmin::ApiError
     # @raise JabberAdmin::CommandError
-    #
-    # rubocop:disable Metrics/AbcSize -- because its the bundled check logic
-    # rubocop:disable Metrics/MethodLength -- ditto
     def check_response
       # The REST API responds a 404 status code when the command is not known.
       if response.code == 404
@@ -82,8 +79,6 @@ module JabberAdmin
       raise CommandError.new('Command was not successful', response) \
         unless response.body == '0'
     end
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/MethodLength
 
     # Just a simple DSL wrapper for the response method.
     #
@@ -93,7 +88,7 @@ module JabberAdmin
     end
 
     # Just a simple DSL wrapper for the response method. But this variant
-    # perfoms a response check which will raise excpetions when there are
+    # performs a response check which will raise exceptions when there are
     # issues.
     #
     # @raise JabberAdmin::ApiError

data/lib/jabber_admin/commands/get_vcard.rb

@@ -34,9 +34,6 @@ module JabberAdmin
       # rubocop:disable Metrics/MethodLength -- because the ejabberd REST API
       #   is hard to use in complex scenarios, so we have to work
       #   around it
-      # rubocop:disable Metrics/AbcSize -- ditto
-      # rubocop:disable Metrics/CyclomaticComplexity -- ditto
-      # rubocop:disable Metrics/PerceivedComplexity -- ditto
       def self.call(callable, *keys, user:)
         uid, host = user.split('@')
         val = proc do |key|
@@ -77,9 +74,6 @@ module JabberAdmin
         end
       end
       # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
     end
   end
 end

data/lib/jabber_admin/commands/set_presence.rb

@@ -16,7 +16,6 @@ module JabberAdmin
       # @param priority [String] presence priority (eg. +7+)
       #
       # rubocop:disable Metrics/ParameterLists -- because of the mapping
-      # rubocop:disable Metrics/MethodLength -- because of the mapping
       def self.call(callable, user:, type: 'available', show: 'chat',
                     status: '', priority: '7')
         uid, host = user.split('@')
@@ -31,7 +30,7 @@ module JabberAdmin
                       status: status,
                       priority: priority)
       end
-      # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
+      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/jabber_admin/commands/set_vcard.rb

@@ -31,11 +31,6 @@ module JabberAdmin
       # @param sym_args [Hash{Symbol => Mixed}] additional keys/values to
       #   set to the vCard
       # @return [Hash] the vCard details
-      #
-      # rubocop:disable Metrics/MethodLength -- because the ejabberd REST API
-      #   is hard to use in complex scenarios, so we have to work
-      #   around it
-      # rubocop:disable Metrics/AbcSize -- ditto
       def self.call(callable, args = {}, user:, **sym_args)
         args = args.merge(sym_args)
         uid, host = user.split('@')
@@ -62,8 +57,6 @@ module JabberAdmin
         args.each { |key, val| set[key, val] }
         args
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/jabber_admin/errors.rb

@@ -15,7 +15,7 @@ module JabberAdmin
 
     # Create a new exception.
     #
-    # @param msg [String] the excpetion message
+    # @param msg [String] the exception message
     # @param response [RestClient::Response] the response when available
     def initialize(msg, response = nil)
       @response = response
@@ -24,8 +24,8 @@ module JabberAdmin
     end
   end
 
-  # This exception is raised when the request was denied due to premission
-  # issues or a general unavaliability of the command on the REST API. This
+  # This exception is raised when the request was denied due to permission
+  # issues or a general unavailability of the command on the REST API. This
   # simply means the response code from ejabberd was not 200 OK.
   class RequestError < Error; 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 = '2.1.0'
+  VERSION = '2.2.0'
 
   class << self
     # Returns the version of gem as a string.

data/lib/jabber_admin.rb

@@ -93,7 +93,7 @@ module JabberAdmin
     # 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)
+    # command. (Without the trailing 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jabber_admin
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Hermann Mayer