openfire_rest_api 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ff493c42b1fa2f69c09d564ac703702fa22c86f
-  data.tar.gz: d945019c048d502b8bba6e40ceeb1db2c445855b
+  metadata.gz: c1e7166e7597e0db73fb466f68a031e1a5ad0024
+  data.tar.gz: 1e45e87588576e50db7ca5c96b94708199b0c591
 SHA512:
-  metadata.gz: 15b1abc9b605b932818d2d89ac6ce648a2ef1a0af184e506482f45d34157cba35e4d9d6bbc61068795f8b0b04111ddc17a9fc81c81ef57bc32094527ceb57fb2
-  data.tar.gz: eae63c86a6f3b5f0a3a60a28dba79df33541709c18493d054ac4e84eed00d069d451f735730cd820f6da1da5ef2b0c07322b021763256cbc2deff9042fe0d964
+  metadata.gz: 51e5ec14c482737e2c12197be43a4a19dd37329301fe1fb9db29eceeeac9e3b8b04a433105ac78cca1c5778ed532eebec06556316a418003254caceaf6476097
+  data.tar.gz: 653f7d5f2eee848f4eb3219f9eeb796f4df5c7ab6764f576751acd0de8e0e7586ba7f60ed69307c7b2215468f979e3b20f36069c618b65b97e0fc2b44448faba

data/CHANGELOG.md

@@ -9,3 +9,7 @@
 ## v0.2.1
 
 * Added optional filters to get users method
+
+## v1.0.0
+
+* Added methods to manage user roster and chatrooms.

data/lib/openfire/api.rb

@@ -43,84 +43,94 @@ module Openfire
     def get_user_groups(username)
       request = web_request('GET', "/users/#{username}/groups", { }, default_headers)
       body = request[:body]['groupname']
-
       body.is_a?(Array) ? body : [body]
     end
 
     def add_user_to_group(username, groupname)
       request = web_request('POST', "/users/#{username}/groups/#{groupname}", { }, default_headers)
-
       (request[:status_code] == 201)
     end
 
     def add_user_to_groups(username, groupnames)
       payload = { groupname: groupnames }.to_json
-
       request = web_request('POST', "/users/#{username}/groups", payload, default_headers)
-
       (request[:status_code] == 201)
     end
 
     def delete_user_from_group(username, groupname)
       request = web_request('DELETE', "/users/#{username}/groups/#{groupname}", { }, default_headers)
-
       (request[:status_code] == 200)
     end
 
     def delete_user_from_groups(username, groupnames)
       payload = { groupname: groupnames }.to_json
-
       request = web_request('DELETE', "/users/#{username}/groups", payload, default_headers)
-
       (request[:status_code] == 200)
     end
 
     def get_user_roster(username)
-      raise 'not implemented'
+      request = web_request('GET', "/users/#{username}/roster", { }, default_headers)
+      Openfire::UserRoster.new(request[:body])
     end
 
     def create_user_roster(username, roster_data={})
-      raise 'not implemented'
+      request = web_request('POST', "/users/#{username}/roster", roster_data.to_json, default_headers)
+      (request[:status_code] == 201)
     end
 
     def delete_user_roster(username, jid)
-      raise 'not implemented'
+      request = web_request('DELETE', "/users/#{username}/roster/#{jid}", { }, default_headers)
+      (request[:status_code] == 200)
     end
 
     def update_user_roster(username, jid, roster_data={})
-      raise 'not implemented'
+      request = web_request('PUT', "/users/#{username}/roster/#{jid}", roster_data.to_json, default_headers)
+      (request[:status_code] == 200)
     end
 
-    def get_chatrooms
-      raise 'not implemented'
+    def get_chatrooms(filters={})
+      request = web_request('GET', '/chatrooms', filters, default_headers)
+      request[:body]['chatroom'].map { |x| Openfire::ChatRoom.new(x) }
     end
 
     def get_chatroom(room_name)
-      raise 'not implemented'
+      request = web_request('GET', "/chatrooms/#{room_name}", { }, default_headers)
+      Openfire::ChatRoom.new(request[:body])
     end
 
     def get_chatroom_participants(room_name)
-      raise 'not implemented'
+      request = web_request('GET', "/chatrooms/#{room_name}/participants", { }, default_headers)
+      request[:body]
+    end
+
+    def get_chatroom_occupants(room_name)
+      request = web_request('GET', "/chatrooms/#{room_name}/occupants", { }, default_headers)
+      request[:body]
     end
 
     def create_chatroom(room_data={})
-      raise 'not implemented'
+      request = web_request('POST', '/chatrooms', room_data.to_json, default_headers)
+      (request[:status_code] == 201)
     end
 
     def delete_chatroom(room_name)
-      raise 'not implemented'
+      request = web_request('DELETE', "/chatrooms/#{room_name}", { }, default_headers)
+      (request[:status_code] == 200)
     end
 
     def update_chatroom(room_name, room_data={})
-      raise 'not implemented'
+      request = web_request('PUT', "/chatrooms/#{room_name}", room_data.to_json, default_headers)
+      (request[:status_code] == 200)
     end
 
-    def add_user_to_chatroom(room_name, username_or_jid, role)
-      raise 'not implemented'
+    def add_user_to_chatroom(room_name, role, username_or_jid, params={})
+      request = web_request('POST', "/chatrooms/#{room_name}/#{role}/#{username_or_jid}", params, default_headers)
+      (request[:status_code] == 201)
     end
 
-    def delete_user_from_chatroom(room_name, username_or_jid, role)
-      raise 'not implemented'
+    def delete_user_from_chatroom(room_name, role, username_or_jid, params={})
+      request = web_request('DELETE', "/chatrooms/#{room_name}/#{role}/#{username_or_jid}", params, default_headers)
+      (request[:status_code] == 200)
     end
 
     def get_system_properties
@@ -138,7 +148,6 @@ module Openfire
         '@key' => property_name,
         '@value' => value
       }.to_json
-
       request = web_request('POST', '/system/properties', payload, default_headers)
       (request[:status_code] == 201)
     end
@@ -153,7 +162,6 @@ module Openfire
         '@key' => property_name,
         '@value' => value
       }.to_json
-
       request = web_request('PUT', "/system/properties/#{property_name}", payload, default_headers)
       (request[:status_code] == 200)
     end
@@ -191,7 +199,6 @@ module Openfire
     def get_sessions
       request = web_request('GET', '/sessions', { }, default_headers)
       data = request[:body]['session']
-
       if data.is_a?(Array)
         data.map { |x| Openfire::Session.new(x) }
       else
@@ -202,7 +209,6 @@ module Openfire
     def get_user_sessions(username)
       request = web_request('GET', "/sessions/#{username}", { }, default_headers)
       data = request[:body]['session']
-
       if data.is_a?(Array)
         data.map { |x| Openfire::Session.new(x) }
       else
@@ -217,8 +223,8 @@ module Openfire
 
     def send_broadcast_message(message_text)
       payload = { body: message_text }.to_json
-
       request = web_request('POST', '/messages/users', payload, default_headers)
+      (request[:status_code] == 201)
     end
 
     private

data/lib/openfire/chat_room.rb

@@ -0,0 +1,26 @@
+module Openfire
+  class ChatRoom
+    attr_accessor :room_name, :natural_name, :description, :subject, :password,
+      :creation_date, :modification_date, :max_users, :persistent, :publicRoom,
+      :registrationEnabled, :can_anyone_discover_jid, :can_occupants_change_subject,
+      :can_occupants_invite, :can_change_nickname, :log_enabled, :login_restricted_to_nickname,
+      :members_only, :moderated, :broadcast_presence_roles, :owners, :admins, :members,
+      :outcasts, :owner_groups, :admin_groups, :member_groups, :outcast_groups
+
+    def initialize(attributes={})
+      attributes.each do |k,v|
+        self.send("#{to_underscore(k)}=", v)
+      end
+    end
+
+    private
+
+    def to_underscore(val)
+      val.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/lib/openfire/user_roster.rb

@@ -0,0 +1,21 @@
+module Openfire
+  class UserRoster
+    attr_accessor :jid, :nickname, :subscription_type, :groups
+
+    def initialize(attributes={})
+      attributes.each do |k,v|
+        self.send("#{to_underscore(k)}=", v)
+      end
+    end
+
+    private
+
+    def to_underscore(val)
+      val.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/lib/openfire_rest_api.rb

@@ -1,11 +1,13 @@
 require "openfire_rest_api/version"
 
 require 'openfire/api'
+require 'openfire/chat_room'
 require 'openfire/group'
 require 'openfire/session'
 require 'openfire/sessions_count'
 require 'openfire/system_property'
 require 'openfire/user'
+require 'openfire/user_roster'
 
 # external dependencies
 require 'rest-client'

data/lib/openfire_rest_api/version.rb

@@ -1,3 +1,3 @@
 module OpenfireRestApi
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openfire_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Matias Hick
@@ -64,11 +64,13 @@ files:
 - LICENSE.md
 - README.md
 - lib/openfire/api.rb
+- lib/openfire/chat_room.rb
 - lib/openfire/group.rb
 - lib/openfire/session.rb
 - lib/openfire/sessions_count.rb
 - lib/openfire/system_property.rb
 - lib/openfire/user.rb
+- lib/openfire/user_roster.rb
 - lib/openfire_rest_api.rb
 - lib/openfire_rest_api/version.rb
 homepage: https://github.com/unformattmh/openfire_rest_api