jabber_admin 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31b521fdd1da155402e58b436e83fcb22012648b601f543fd5e885f844fd019e
-  data.tar.gz: 9f14f04eaa52941167b0deaeb3322d1d1e947acf8ed2cc8e16cdc00dabeaa8a4
+  metadata.gz: 8b04fc09ea946409fccfdb4dd37b085e84418591c8c72f990b0e46c1ddb736e4
+  data.tar.gz: a9a74a6d345ba34ed5e06d81eda5df5140585778b5aae2196cb5263cccba2c1b
 SHA512:
-  metadata.gz: 57e645f24f358c679b841cde89b8d8ee9fc978d5497a979ce5e87217f936af0438f9e8a75a1bcb94f9d2f195ea469fdc3be1f55137d8b20c66e5b04e0a61bf9d
-  data.tar.gz: b26205f1387f7b50c2ac30407402017f5ab70aa89d64d34905f6c2ddddb26e3d05fa48b6a49f418eb9716c20ec2ce95327e97155f6ab0be9d2c88ff930a732bf
+  metadata.gz: 326f9d15f3866893a7ec92de4a4475f59848321c8ff9c879eff6fd7d8d46b8cccad5a15a6c167650b3fba532b410837ba57cdc372e56869b35fae49e333def06
+  data.tar.gz: 70733d53fb23eba46c48baf9300cefadb8cfe178e1130b8640dd014f782becc8077a4186a868c8cbed8d255f6d166955f52ae48850483e906bd6247f294ea769

data/.github/workflows/documentation.yml

@@ -0,0 +1,38 @@
+name: Build Documentation
+on:
+  repository_dispatch:
+    types: [documentation]
+
+concurrency:
+  group: 'docs'
+
+jobs:
+  docs:
+    name: Build gem documentation
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+
+      - 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()

data/.github/workflows/test.yml

@@ -0,0 +1,59 @@
+name: Test
+on:
+  push:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 0 * * MON'
+
+concurrency:
+  group: '${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: 'Test the gem (Ruby ${{ matrix.ruby }})'
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Run the gem tests
+        run: make test
+
+      - name: Upload the code coverage report
+        run: coverage
+
+  trigger-docs:
+    name: Trigger the documentation upload
+    runs-on: ubuntu-20.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

@@ -3,7 +3,7 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
+/doc/api/
 /pkg/
 /spec/reports/
 /tmp/

data/.yardopts

@@ -1,4 +1,6 @@
---output-dir=doc/app
+--output-dir=doc/api
+--plugin activesupport-concern
+--markup=rdoc
 -
 README.md
 lib/**/*.rb

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+### 1.0.4
+
+* Added support for the predefined command `destroy_room`
+
+### 1.0.3
+
+* Migrated to Github Actions
+* Migrated to our own coverage reporting
+* Added the code statistics to the test process
+
+### 1.0.2
+
+* Corrected the GNU Make release target
+* Corrected the empty arguments check
+
+### 1.0.1
+
+* Gracefully handle a missing vCard when a vCard field is queried (#7)
+
 ### 1.0.0
 
 * All `JabberAdmin` errors `[UnknownCommandError, CommandError, RequestError]`

data/Makefile

@@ -28,17 +28,23 @@ SORT ?= sort
 BUNDLE ?= bundle
 RAKE ?= rake
 RUBOCOP ?= rubocop
+YARD ?= yard
 
 all:
 	# jabber_admin
 	#
-	# install                  Install the dependencies
-	# test                     Run the whole test suite
-	# test-style               Check the coding styles
-	# clean                    Clean the dependencies
+	# install            Install the dependencies
+	# test               Run the whole test suite
+	# test-style         Check the coding styles
+	# clean              Clean the dependencies
 	#
-	# shell                    Run an interactive shell on the container
-	# shell-irb                Run an interactive IRB shell on the container
+	# docs               Generate the Ruby documentation of the library
+	# stats              Print the code statistics (library and test suite)
+	# notes              Print all the notes from the code
+	# release            Release a new Gem version (maintainers only)
+	#
+	# shell              Run an interactive shell on the container
+	# shell-irb          Run an interactive IRB shell on the container
 	#
 	# supported-commands-list  Generate the supported commands list
 
@@ -62,9 +68,13 @@ install:
 	@$(MKDIR) -p $(VENDOR_DIR)
 	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
 
-test: install
+test: \
+	test-specs \
+	test-style
+
+test-specs:
 	# Run the whole test suite
-	@$(call run-shell,$(BUNDLE) exec $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
 
 test-style: test-style-ruby
 
@@ -84,17 +94,30 @@ endif
 
 distclean: clean clean-containers
 
-shell: install
+shell:
 	# Run an interactive shell on the container
 	@$(call run-shell,$(BASH) -i)
 
-shell-irb: install
+shell-irb:
 	# Run an interactive IRB shell on the container
 	@$(call run-shell,bin/console)
 
+docs:
+	# Build the API documentation
+	@$(call run-shell,$(BUNDLE) exec $(YARD) -q && \
+		$(BUNDLE) exec $(YARD) stats --list-undoc --compact)
+
+notes:
+	# Print the code statistics (library and test suite)
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) notes)
+
+stats:
+	# Print all the notes from the code
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
+
 release:
 	# Release a new gem version
-	@$(RAKE) release
+	@$(BUNDLE) exec $(RAKE) release
 
 supported-commands-list:
 	# Generate the supported commands list

data/README.md

@@ -1,10 +1,10 @@
 ![jabber_admin](doc/assets/project.svg)
 
-[![Build Status](https://travis-ci.com/hausgold/jabber_admin.svg?branch=master)](https://travis-ci.com/hausgold/jabber_admin)
+[![Continuous Integration](https://github.com/hausgold/jabber_admin/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/jabber_admin/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/jabber_admin.svg)](https://badge.fury.io/rb/jabber_admin)
-[![Maintainability](https://api.codeclimate.com/v1/badges/dd51c4668e97771baaba/maintainability)](https://codeclimate.com/repos/5cac8bcb6969c376ed007c70/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/dd51c4668e97771baaba/test_coverage)](https://codeclimate.com/repos/5cac8bcb6969c376ed007c70/test_coverage)
-[![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/jabber_admin)
+[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/jabber_admin/coverage.svg)](https://knowledge.hausgold.de/coverage)
+[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/jabber_admin/ratio.svg)](https://knowledge.hausgold.de/coverage)
+[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/jabber_admin/documentation.svg)](https://www.rubydoc.info/gems/jabber_admin)
 
 jabber_admin is a small library to easily communicate with the [ejabberd
 admin API](https://docs.ejabberd.im/developer/ejabberd-api/admin-api).
@@ -114,6 +114,7 @@ Here comes a list of all supported predefined commands:
 - [subscribe_room](https://bit.ly/2Ke7Zoy)
 - [unregister](https://bit.ly/2wwYnDE)
 - [unsubscribe_room](https://bit.ly/2G5zcrj)
+- [destroy_room](https://bit.ly/31CtqxB)
 
 If you want to contribute more, we accept pull requests!
 

data/Rakefile

@@ -2,7 +2,75 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rails/code_statistics'
+require 'pp'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+# Load some railties tasks
+load 'rails/tasks/statistics.rake'
+load 'rails/tasks/annotations.rake'
+
+# Clear the default statistics directory constant
+#
+# rubocop:disable Style/MutableConstant because we define it
+Object.send(:remove_const, :STATS_DIRECTORIES)
+::STATS_DIRECTORIES = []
+# rubocop:enable Style/MutableConstant
+
+# Monkey patch the Rails +CodeStatistics+ class to support configurable
+# patterns per path. This is reuqired to support top-level only file matches.
+class CodeStatistics
+  DEFAULT_PATTERN = /^(?!\.).*?\.(rb|js|coffee|rake)$/.freeze
+
+  # Pass the possible +pattern+ argument down to the
+  # +calculate_directory_statistics+ method call.
+  def calculate_statistics
+    Hash[@pairs.map do |pair|
+      [pair.first, calculate_directory_statistics(*pair[1..-1])]
+    end]
+  end
+
+  # Match the pattern against the individual file name and the relative file
+  # path. This allows top-level only matches.
+  def calculate_directory_statistics(directory, pattern = DEFAULT_PATTERN)
+    stats = CodeStatisticsCalculator.new
+
+    Dir.foreach(directory) do |file_name|
+      path = "#{directory}/#{file_name}"
+
+      if File.directory?(path) && (/^\./ !~ file_name)
+        stats.add(calculate_directory_statistics(path, pattern))
+      elsif file_name =~ pattern || path =~ pattern
+        stats.add_by_file_path(path)
+      end
+    end
+
+    stats
+  end
+end
+
+# Configure all code statistics directories
+vendors = [
+  [:unshift, 'Top-levels', 'lib', %r{lib(/jabber_admin)?/[^/]+\.rb$}],
+  [:unshift, 'Top-levels specs', 'spec',
+   %r{spec/jabber_admin(_spec\.rb|/[^/]+\.rb$)}],
+
+  [:unshift, 'Commands', 'lib/jabber_admin/commands'],
+  [:unshift, 'Commands specs', 'spec/jabber_admin/commands']
+].reverse
+
+vendors.each do |method, type, dir, pattern|
+  ::STATS_DIRECTORIES.send(method, [type, dir, pattern].compact)
+  ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
+end
+
+# Setup annotations
+ENV['SOURCE_ANNOTATION_DIRECTORIES'] = 'spec,doc'
+
+desc 'Enumerate all annotations'
+task :notes do
+  SourceAnnotationExtractor.enumerate '@?OPTIMIZE|@?FIXME|@?TODO', tag: true
+end

data/jabber_admin.gemspec

@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
   spec.add_development_dependency 'irb', '~> 1.2'
+  spec.add_development_dependency 'railties', '>= 4.2.0', '< 6.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 0.93'
@@ -46,4 +47,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '< 0.18'
   spec.add_development_dependency 'vcr', '~> 6.0'
   spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9.18'
+  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
 end

data/lib/jabber_admin/commands/destroy_room.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    # Destroys a given room (MUC).
+    #
+    # @see https://bit.ly/31CtqxB
+    class DestroyRoom
+      # 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+)
+      # @param host [String] the jabber host (eg. +localhost+)
+      def self.call(callable, room:, host:)
+        name, service = room.split('@')
+        callable.call('destroy_room', name: name, service: service, host: host)
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/get_vcard.rb

@@ -53,15 +53,15 @@ module JabberAdmin
             end
           end
 
-          res = JSON.parse(callable.call(meth, check_res_body: false,
-                                               user: uid,
-                                               host: host,
-                                               **args).body)
-
-          res.is_a?(Hash) ? res['content'] : res
-        rescue JabberAdmin::CommandError => e
+          res = callable.call(meth, check_res_body: false,
+                                    user: uid, host: host, **args)
+          body = (200..299).cover?(res.code) ? JSON.parse(res.body) : nil
+          body.is_a?(Hash) ? body['content'] : body
+        rescue JabberAdmin::Error => e
           # When ejabberd tells us there was no value, it does this the hard way
           next if e.response.body.include? 'error_no_value_found_in_vcard'
+          # Same for the case when there is no vCard at all
+          next if e.response.body.include? 'error_no_vcard_found'
 
           raise e
         end

data/lib/jabber_admin/version.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
+# The gem module.
 module JabberAdmin
   # The version constant of the gem. Increase this value
   # in case of a gem release.
-  VERSION = '1.0.0'
+  VERSION = '1.0.4'
 
   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.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Henning Vogt
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -79,6 +79,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +197,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+- !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:
 - henning.vogt@hausgold.de
@@ -186,11 +234,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/documentation.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -210,6 +259,7 @@ files:
 - lib/jabber_admin/commands/ban_account.rb
 - 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_vcard.rb
 - lib/jabber_admin/commands/muc_register_nick.rb
 - lib/jabber_admin/commands/register.rb
@@ -248,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.21
 signing_key:
 specification_version: 4
 summary: Library for the ejabberd RESTful admin API

data/.travis.yml

@@ -1,18 +0,0 @@
-sudo: false
-env:
-  global:
-    - CC_TEST_REPORTER_ID=05f9944a34899135739ab519c57a179a3f4677999fd832fa87da25d3643702b7
-language: ruby
-rvm:
-  - 2.6
-  - 2.6
-  - 2.5
-before_install: gem install bundler
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT