jabber_admin 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd0bcf59057c6d9ae11137e3f6427177a74aa0969f44abe30aaf5d192b43e693
-  data.tar.gz: b49453ad3ca03bdb7665c487e9547ed5721f28fe7ded316bba9e2af3a6d96745
+  metadata.gz: 36f720390492e75879ab0c6d9fba8af46dcc2eea7f34c4c81a436b1525675c23
+  data.tar.gz: 71ce51f31fba0f18b1030cb673ad64f5f39cf3295be3b411e1738cbbd0ef74b2
 SHA512:
-  metadata.gz: 5c6c483c01e80efbb706cf855f4881b65880b455dd85043baca8620491cdb9b24d521f9f9b4b14344d2b4982778b0bf1d1309ebd990b50ea6743376061ba05b4
-  data.tar.gz: 30a6239b2893a205bbf82552567d3f0fb783072e679ae25e9d948e404e582d518abd9ff8ce49b72ba1025b95f0b35075f536d0473158510e9bb95b22ea22847f
+  metadata.gz: 1fce6a069b79d23ea003edb2eaca0a68bc9972fe364ea8bd938ada2fa46c5d2312c94affb60b6f584c81dc17d7adc7125e5b65a2d11c204afc002520ace996d2
+  data.tar.gz: 98411277a53779fb129b7f2d786fe131a8eeddfa6a8aaea8189d954a2693840908ca8a9575edd583cc311fe4e59dd2612e70a1c682bb28991e0966950392a641

data/.github/workflows/release.yml

@@ -18,19 +18,20 @@ jobs:
     runs-on: ubuntu-22.04
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Install Ruby 2.5
+      - name: Install Ruby 2.7
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5
+          ruby-version: 2.7
           bundler-cache: true
-          rubygems: '3.3.26'
+          rubygems: '3.4.22'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/gem-test
 
@@ -45,3 +46,9 @@ jobs:
 
       - name: Push the release Git commit/tag and package to the registry
         run: make release
+
+      - name: Build and upload application documentation
+        run: api-docs && coverage --docs-only
+        env:
+          WORKFLOW_DISPATCH_TOKEN: '${{ secrets.WORKFLOW_DISPATCH_TOKEN }}'
+          GITHUB_TAG: 'v${{ github.event.inputs.VERSION }}'

data/.github/workflows/test.yml

@@ -18,24 +18,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.5', '2.7']
-        rails: ['5.2']
+        ruby: ['2.7']
+        rails: ['5.2', '6.1', '7.1']
     env:
       BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Install the correct Ruby version
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-          rubygems: '3.3.26'
+          rubygems: '3.4.22'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/gem-test
 
@@ -44,20 +45,3 @@ jobs:
 
       - name: Upload the code coverage report
         run: coverage
-
-  trigger-docs:
-    name: Trigger the documentation upload
-    runs-on: ubuntu-22.04
-    timeout-minutes: 2
-    needs: test
-    if: github.ref == 'refs/heads/master'
-    steps:
-      - name: Prepare the virtual environment
-        uses: hausgold/actions/ci@master
-        with:
-          clone_token: '${{ secrets.CLONE_TOKEN }}'
-          settings: '${{ github.repository }}'
-          target: ci/noop
-
-      - name: Trigger the documentation upload
-        run: workflow documentation

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log/
 /vendor/
 /gemfiles/vendor/
 *.gemfile.lock

data/.rubocop.yml

@@ -12,7 +12,7 @@ AllCops:
   NewCops: enable
   SuggestExtensions: false
   DisplayCopNames: true
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   TargetRailsVersion: 5.2
   Exclude:
     - bin/**/*

data/Appraisals

@@ -3,3 +3,11 @@
 appraise 'rails-5.2' do
   gem 'activesupport', '~> 5.2.0'
 end
+
+appraise 'rails-6.1' do
+  gem 'activesupport', '~> 6.1.0'
+end
+
+appraise 'rails-7.1' do
+  gem 'activesupport', '~> 7.1.0'
+end

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 1.3.1
+
+* Added API docs building to continuous integration (#14)
+
+### 1.3.0
+
+* Moved the development dependencies from the gemspec to the Gemfile (#12)
+* Dropped support for Ruby <2.7 (#13)
+
 ### 1.2.0
 
 * Added support for Gem release automation

data/Dockerfile

@@ -1,8 +1,8 @@
-FROM hausgold/ruby:2.5
+FROM hausgold/ruby:2.7
 MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
 
 # Update system gem
-RUN gem update --system '3.3.26'
+RUN gem update --system '3.4.22'
 
 # Install system packages and the latest bundler
 RUN apt-get update -yqqq && \
@@ -11,7 +11,7 @@ RUN apt-get update -yqqq && \
     ca-certificates \
     bash-completion inotify-tools && \
   echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && /usr/sbin/locale-gen && \
-  gem install bundler -v '~> 2.3.0' --no-document --no-prerelease
+  gem install bundler -v '~> 2.4.22' --no-document --no-prerelease
 
 # Add new web user
 RUN mkdir /app && \

data/Gemfile

@@ -6,3 +6,21 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in jabber_admin.gemspec
 gemspec
+
+# Development dependencies
+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'

data/Makefile

@@ -13,6 +13,7 @@ BASH_RUN_SHELL_FLAGS ?=
 
 # Directories
 VENDOR_DIR ?= vendor/bundle
+GEMFILES_DIR ?= gemfiles
 
 # Host binaries
 AWK ?= awk
@@ -27,6 +28,7 @@ ID ?= id
 MKDIR ?= mkdir
 RM ?= rm
 SORT ?= sort
+TEST ?= test
 XARGS ?= xargs
 
 # Container binaries
@@ -38,6 +40,7 @@ RAKE ?= rake
 RSPEC ?= rspec
 RUBOCOP ?= rubocop
 YARD ?= yard
+RUBY_VERSION := ruby-version
 
 # Files
 GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
@@ -117,7 +120,8 @@ test-style: test-style-ruby
 
 test-style-ruby:
 	# Run the static code analyzer (rubocop)
-	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a)
+	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a \
+		|| ($(TEST) $$($(RUBY_VERSION)) != '2.7' && true))
 
 clean:
 	# Clean the dependencies

data/config/docker/.bashrc

@@ -16,7 +16,9 @@ sudo sed -i 's/autostart=.*/autostart=false/g' /etc/supervisor/conf.d/*
 sudo supervisord >/dev/null 2>&1 &
 
 # Wait for supervisord
-while ! supervisorctl status >/dev/null 2>&1; do sleep 1; done
+while ! (sudo supervisorctl status | grep avahi) >/dev/null 2>&1; do
+  sleep 1
+done
 
 # Boot the mDNS stack
 echo '# Start the mDNS stack'

data/gemfiles/rails_5.2.gemfile

@@ -2,6 +2,22 @@
 
 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/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,23 @@
+# 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", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,23 @@
+# 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", "~> 7.1.0"
+
+gemspec path: "../"

data/jabber_admin.gemspec

@@ -31,25 +31,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5'
-
-  spec.add_dependency 'activesupport', '>= 5.2'
-  spec.add_dependency 'rest-client', '~> 2.1'
-
-  spec.add_development_dependency 'appraisal', '~> 2.4'
-  spec.add_development_dependency 'bundler', '~> 2.3'
-  spec.add_development_dependency 'countless', '~> 1.1'
-  spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'irb', '~> 1.2'
-  spec.add_development_dependency 'railties', '>= 5.2'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rubocop', '~> 1.28'
-  spec.add_development_dependency 'rubocop-rails', '~> 2.14'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
-  spec.add_development_dependency 'simplecov', '>= 0.22'
-  spec.add_development_dependency 'vcr', '~> 6.0'
-  spec.add_development_dependency 'webmock', '~> 3.18'
-  spec.add_development_dependency 'yard', '>= 0.9.28'
-  spec.add_development_dependency 'yard-activesupport-concern', '>= 0.0.1'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.add_runtime_dependency 'activesupport', '>= 5.2'
+  spec.add_runtime_dependency 'rest-client', '~> 2.1'
 end

data/lib/jabber_admin/commands/get_vcard.rb

@@ -70,10 +70,10 @@ module JabberAdmin
         return val[keys.first] if keys.count == 1
 
         # When multiple keys are requested, we assemble a hash
-        keys.map do |key|
+        keys.to_h do |key|
           res_key = key.is_a?(String) ? key.delete_suffix('[]') : key
           [res_key, val[key]]
-        end.to_h
+        end
       end
       # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/AbcSize

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.2.0'
+  VERSION = '1.3.1'
 
   class << self
     # Returns the version of gem as a string.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jabber_admin
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Hermann Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,230 +39,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: countless
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: irb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.18'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.28
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.28
-- !ruby/object:Gem::Dependency
-  name: yard-activesupport-concern
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.1
 description: Library for the ejabberd RESTful admin API
 email:
 - hermann.mayer92@gmail.com
@@ -272,7 +48,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".github/workflows/documentation.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -300,6 +75,8 @@ files:
 - 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
@@ -344,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/documentation.yml

@@ -1,39 +0,0 @@
-name: Build Documentation
-on:
-  repository_dispatch:
-    types: [documentation]
-
-concurrency:
-  group: 'docs'
-
-jobs:
-  docs:
-    name: Build gem documentation
-    runs-on: ubuntu-22.04
-    timeout-minutes: 5
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Install the correct Ruby version
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.5
-          bundler-cache: true
-          rubygems: '3.3.26'
-
-      - name: Prepare the virtual environment
-        uses: hausgold/actions/ci@master
-        with:
-          clone_token: '${{ secrets.CLONE_TOKEN }}'
-          settings: '${{ github.repository }}'
-          target: ci/gem-test
-
-      - name: Build gem documentation
-        run: make docs
-
-      - name: Upload the code coverage report
-        run: coverage
-
-      - name: Add this job to the commit status
-        run: commit-status '${{ job.status }}'
-        if: always()