jabber_admin 0.1.4 → 0.2.0

data/lib/jabber_admin/commands/unsubscribe_room.rb

@@ -2,14 +2,17 @@
 
 module JabberAdmin
   module Commands
-    ##
-    # Subscribe to a MUC conference
-    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#unsubscribe-room-unsubscribe-from-a-muc-conference
+    # Subscribe to a MUC conference, via the mucsub feature.
+    #
+    # @see https://bit.ly/2G5zcrj
     class UnsubscribeRoom
-      # @param [user] Full JID, including some resource
-      # @param [room] The room to subscribe
-      def self.call(user:, room:)
-        JabberAdmin::ApiCall.perform 'unsubscribe_room', user: user, room: room
+      # Pass the correct data to the given callable.
+      #
+      # @param callable [Proc, #call] the callable to call
+      # @param user [String] user JID w/ resource (eg. +tom@localhost/dummy+)
+      # @param room [String] room JID (eg. +room1@conference.localhost+)
+      def self.call(callable, user:, room:)
+        callable.call('unsubscribe_room', user: user, room: room)
       end
     end
   end

data/lib/jabber_admin/configuration.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
 module JabberAdmin
+  # A JabberAdmin configuration definition. It is directly accessible via
+  # +JabberAdmin.configuration+ or
+  # +JabberAdmin.configure(&block(configuration))+ in a tapped variant.
+  #
+  # See the +JabberAdmin+ documentation for further details.
   class Configuration
-    attr_accessor :admin, :password, :api_host
+    attr_accessor :username, :password, :url
   end
 end

data/lib/jabber_admin/exceptions.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  # The base exception which all other exceptions inherit. In case you want to
+  # use our error handling with the bang variants, you can rescue all
+  # exceptions like this:
+  #
+  #   begin
+  #     JabberAdmin.COMMAND!
+  #   rescue JabberAdmin::Error => err
+  #     # Do your error handling here
+  #   end
+  class Error < StandardError
+    attr_accessor :response
+
+    # Create a new exception.
+    #
+    # @param msg [String] the excpetion message
+    # @param response [RestClient::Response] the response when available
+    def initialize(msg, response = nil)
+      @response = response
+      super(msg)
+    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
+  # simply means the response code from ejabberd was not 200 OK.
+  class RequestError < Error; end
+
+  # This exception is raised when the response from the ejabberd REST API
+  # indicated that the status of the command was not successful. In this case
+  # the response body includes a one (1). In case everything was fine, it
+  # includes a zero (0).
+  class CommandError < Error; end
+
+  # This exception is raised when we send an unknown command to the REST API.
+  # It will respond with a 404 status code in this case.
+  class UnknownCommandError < Error; end
+end

data/lib/jabber_admin/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module JabberAdmin
-  VERSION = "0.1.4"
+  # The version constant of the gem. Increase this value
+  # in case of a gem release.
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,49 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: jabber_admin
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Henning Vogt
+- Hermann Mayer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 4.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 4.2.5
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.5
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.5
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +87,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -100,18 +129,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Library for the ejabberd RESTful admin API
 email:
 - henning.vogt@hausgold.de
+- hermann.mayer@hausgold.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
 - ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -119,6 +183,7 @@ files:
 - doc/assets/logo.png
 - doc/assets/project.png
 - doc/assets/project.xcf
+- docker-compose.yml
 - jabber_admin.gemspec
 - lib/jabber_admin.rb
 - lib/jabber_admin/api_call.rb
@@ -126,17 +191,21 @@ 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/muc_register_nick.rb
 - lib/jabber_admin/commands/register.rb
 - lib/jabber_admin/commands/registered_users.rb
 - lib/jabber_admin/commands/restart.rb
 - lib/jabber_admin/commands/send_direct_invitation.rb
 - lib/jabber_admin/commands/send_stanza.rb
+- lib/jabber_admin/commands/send_stanza_c2s.rb
+- lib/jabber_admin/commands/set_nickname.rb
+- lib/jabber_admin/commands/set_presence.rb
 - lib/jabber_admin/commands/set_room_affiliation.rb
 - lib/jabber_admin/commands/subscribe_room.rb
 - lib/jabber_admin/commands/unregister.rb
 - lib/jabber_admin/commands/unsubscribe_room.rb
 - lib/jabber_admin/configuration.rb
-- lib/jabber_admin/initializer.rb
+- lib/jabber_admin/exceptions.rb
 - lib/jabber_admin/version.rb
 homepage: https://github.com/hausgold/jabber_admin
 licenses:
@@ -159,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Library for the ejabberd RESTful admin API

data/lib/jabber_admin/initializer.rb

@@ -1,6 +0,0 @@
-# Fix pluralization of commands
-ActiveSupport::Inflector.inflections do |inflect|
-    inflect.irregular 'create_room_with_opts', 'create_room_with_opts'
-    inflect.irregular 'registered_users', 'registered_users'
-end
-