jabber_admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4cebb5bfc66b3d12539e9f8c338cc049cfcc92f
+  data.tar.gz: 9fdd9fc1237d6124d2d69a6f7f252c1c6b72fb3e
+SHA512:
+  metadata.gz: d5efa557ffb0608dfdb83b17e8db173feb563c77203d8c29ecf6df868867be1c0d0928da3c9dd69891957fcee90f930b97b25545810625a091b16a19595bd8bc
+  data.tar.gz: 50a2a5e468057f57a8474091788105c1e2dead917bdc8b77cb04996558f43ad9188c6ef0e90fb1a8bc9b55c77e021f313dc71b1aaa9375d099c570bd960c21ee

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=02d696c72627e730a3db553884276acf15672466e32e66a788672d3b167629ca
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+before_install: gem install bundler -v 1.15.1
+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
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jabber_admin.gemspec
+gemspec

data/README.md

@@ -0,0 +1,51 @@
+# JabberAdmin
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/0b3c444d8db8acaaba97/maintainability)](https://codeclimate.com/github/hausgold/jabber_admin/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0b3c444d8db8acaaba97/test_coverage)](https://codeclimate.com/github/hausgold/jabber_admin/test_coverage)
+
+JabberAdmin is a small library to easily communicate with the Ejabberd
+admin API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jabber_admin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jabber_admin
+
+## Usage
+
+``` ruby
+JabberAdmin.restart!
+JabberAdmin.create_room!(name: 'room1', host: '...')
+```
+
+Currently these basic commands are supported:
+
+- ban_account
+- create_room
+- register
+- restart
+- send_direct_invitation
+- subscribe_room
+- unregister
+- unsubscribe_room
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hausgold/jabber_admin.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jabber_admin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jabber_admin.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jabber_admin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jabber_admin"
+  spec.version       = JabberAdmin::VERSION
+  spec.authors       = ["Henning Vogt"]
+  spec.licenses      = ['MIT']
+  spec.email         = ["henning.vogt@hausgold.de"]
+
+  spec.summary       = %q{Library for the Ejabberd RESTful admin API}
+  spec.description   = %q{Library for the Ejabberd RESTful admin API}
+  spec.homepage      = "https://github.com/hausgold/jabber_admin"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+  spec.add_dependency "activesupport", ">= 5"
+
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+end

data/lib/jabber_admin/api_call.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  # Error that will be raised when API call is not successful
+  class ApiError < StandardError; end
+
+  # Handles the communication with the API
+  class ApiCall
+    attr_reader :command, :payload
+
+    def self.perform(command, payload = {})
+      new(command, payload).perform
+    end
+
+    def initialize(command, payload)
+      @command = command
+      @payload = payload
+    end
+
+    def perform
+      raise(ApiError, response.to_s) if response.code != 200
+
+      response
+    end
+
+    private
+
+    def response
+      @res ||= RestClient::Request.execute(
+        method: :post,
+        url: url,
+        user: JabberAdmin.configuration.admin,
+        password: JabberAdmin.configuration.password,
+        payload: payload.to_json
+      )
+    end
+
+    def url
+      "#{JabberAdmin.configuration.api_host}/api/#{@command}"
+    end
+  end
+end

data/lib/jabber_admin/commands/ban_account.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    ##
+    # Ban an account: kick sessions and set random password
+    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#ban-account-ban-an-account-kick-sessions-and-set-random-password
+    class BanAccount
+      # @param [user] The user
+      # @param [host] Server name
+      # @param [reason] Reason for banning user
+      def self.call(user:, host:, reason:)
+        JabberAdmin::ApiCall.perform(
+          'ban_account', user: user, host: host, reason: reason
+        )
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/create_room.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    ##
+    # Create a MUC room name@service in host
+    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#create-room-create-a-muc-room-name-service-in-host
+    class CreateRoom
+      # @param [name] The room name
+      # @param [service] MUC service
+      # @param [host] Server host
+      def self.call(name:, service:, host:)
+        JabberAdmin::ApiCall.perform(
+          'create_room', name: name, service: service, host: host
+        )
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/create_room_with_opts.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    ##
+    # Create a MUC room name@service in host
+    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#create-room-with-opts-create-a-muc-room-name-service-in-host-with-given-options
+    class CreateRoomWithOpts
+      # @param [name] The room name
+      # @param [service] MUC service
+      # @param [host] Server host
+      # @param [options] [{ Name::String, Value::String }] List of options
+      def self.call(name:, service:, host:, options:)
+        JabberAdmin::ApiCall.perform(
+          'create_room_with_opts', name: name,
+                                   service: service,
+                                   host: host,
+                                   options: options
+        )
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/register.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    ##
+    # Register a user
+    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#register-register-a-user
+    class Register
+      # @param [user] The username
+      # @param [host] Local vhost served by ejabberd
+      # @param [password] The password
+      def self.call(user:, host:, password:)
+        JabberAdmin::ApiCall.perform(
+          'register',
+          user: user, host: host, password: password
+        )
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/restart.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    ##
+    # Restart ejabberd gracefully
+    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#restart-restart-ejabberd-gracefully
+    class Restart
+      def self.call
+        JabberAdmin::ApiCall.perform 'restart'
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/send_direct_invitation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    ##
+    # Password and Message can also be: none. Users JIDs are separated with :
+    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#send-direct-invitation-send-a-direct-invitation-to-several-destinations
+    class SendDirectInvitation
+      # @param [name] The room name
+      # @param [service] MUC service
+      # @param [password] Password, or none
+      # @param [reason] The reason text, or none
+      # @param [users] Users JIDs
+      def self.call(name:, service:, password:, reason:, users:)
+        joined_users = users.join(':')
+
+        JabberAdmin::ApiCall.perform(
+          'send_direct_invitation',
+          name: name, service: service, password: password, reason: reason,
+          users: joined_users
+        )
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/subscribe_room.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    ##
+    # Subscribe to a MUC conference
+    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#subscribe-room-subscribe-to-a-muc-conference
+    class SubscribeRoom
+      # @param [user] Full JID, including some resource
+      # @param [nick] A user's nick
+      # @param [room] The room to subscribe
+      # @param [nodes] nodes
+      def self.call(user:, nick:, room:, nodes:)
+        JabberAdmin::ApiCall.perform(
+          'subscribe_room',
+          user: user, nick: nick, room: room, nodes: nodes
+        )
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/unregister.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  module Commands
+    ##
+    # Unregister a user
+    # https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#unregister-unregister-a-user
+    class Unregister
+      # @param [user] The username
+      # @param [host] Local vhost served by ejabberd
+      def self.call(user:, host:)
+        JabberAdmin::ApiCall.perform 'unregister', user: user, host: host
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands/unsubscribe_room.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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
+    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
+      end
+    end
+  end
+end

data/lib/jabber_admin/commands.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jabber_admin/commands/ban_account'
+require 'jabber_admin/commands/create_room'
+require 'jabber_admin/commands/create_room_with_opts'
+require 'jabber_admin/commands/register'
+require 'jabber_admin/commands/restart'
+require 'jabber_admin/commands/send_direct_invitation'
+require 'jabber_admin/commands/subscribe_room'
+require 'jabber_admin/commands/unsubscribe_room'
+require 'jabber_admin/commands/unregister'
+
+##
+# Contains alle commands that are supported
+module JabberAdmin
+  module Commands; end
+end

data/lib/jabber_admin/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  class Configuration
+    attr_accessor :admin, :password, :api_host
+  end
+end

data/lib/jabber_admin/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JabberAdmin
+  VERSION = "0.1.0"
+end

data/lib/jabber_admin.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "active_support/inflector"
+require "rest-client"
+
+require "jabber_admin/configuration"
+require "jabber_admin/commands"
+require "jabber_admin/api_call"
+require "jabber_admin/version"
+
+##
+# Jabber Admin Library
+#
+# allows making API calls to the ejabberd RESTful admin backend
+# All supported commands are available in /lib/jabber_admin/commands/
+#
+# Usage:
+# All commands can be called via JabberAdmin.[method_name]!
+# (Do not forget the bang at the end)
+#
+# @example:
+#   JabberAdmin.register!(user: 'peter', 'host': 'example.com', password: '123')
+#   JabberAdmin.unregister!(user: 'peter', 'host': 'example.com')
+#   JabberAdmin.restart!
+#
+module JabberAdmin
+  class << self
+    attr_writer :configuration
+  end
+
+  # @return [JabberAdmin::Configuration] The global JabberAdmin configuration
+  def self.configuration
+    @configuration ||= JabberAdmin::Configuration.new
+  end
+
+  # Class method to set and change the global configuration
+  #
+  # @example
+  #   JabberAdmin.configure do |config|
+  #     config.api_host = 'xmpp.example.com'
+  #     config.admin = 'admin'
+  #     config.password = 'password'
+  #   end
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.method_missing(method, *args, &block)
+    command = "jabber_admin/commands/#{method[0..-2]}".classify.constantize
+    args.empty? ? command.call : command.call(*args)
+  rescue NameError
+    super
+  end
+
+  def self.respond_to_missing?(method, include_private = false)
+    "jabber_admin/commands/#{method[0..-2]}".classify.constantize && true
+  rescue NameError
+    super
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: jabber_admin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henning Vogt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        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: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: Library for the Ejabberd RESTful admin API
+email:
+- henning.vogt@hausgold.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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
+- lib/jabber_admin/commands/register.rb
+- lib/jabber_admin/commands/restart.rb
+- lib/jabber_admin/commands/send_direct_invitation.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/version.rb
+homepage: https://github.com/hausgold/jabber_admin
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Library for the Ejabberd RESTful admin API
+test_files: []