Refactor ejabberd API integration

app/jobs/xmpp_exchange_contacts_job.rb

@@ -2,21 +2,6 @@ class XmppExchangeContactsJob < ApplicationJob
   queue_as :default
 
   def perform(inviter, invitee)
-    return unless inviter.service_enabled?(:ejabberd) &&
-                  invitee.service_enabled?(:ejabberd) &&
-                  inviter.preferences[:xmpp_exchange_contacts_with_invitees]
-
-    ejabberd = EjabberdApiClient.new
-
-    ejabberd.add_rosteritem({
-      "localuser": invitee.cn, "localhost": invitee.ou,
-      "user": inviter.cn, "host": inviter.ou,
-      "nick": inviter.cn, "group": Setting.ejabberd_buddy_roster, "subs": "both"
-    })
-    ejabberd.add_rosteritem({
-      "localuser": inviter.cn, "localhost": inviter.ou,
-      "user": invitee.cn, "host": invitee.ou,
-      "nick": invitee.cn, "group": Setting.ejabberd_buddy_roster, "subs": "both"
-    })
+    EjabberdManager::ExchangeContacts.call(inviter:, invitee:)
   end
 end

app/jobs/xmpp_send_message_job.rb

@@ -2,7 +2,6 @@ class XmppSendMessageJob < ApplicationJob
   queue_as :default
 
   def perform(payload)
-    ejabberd = EjabberdApiClient.new
-    ejabberd.send_message payload
+    EjabberdManager::SendMessage.call(payload:)
   end
 end

app/jobs/xmpp_set_avatar_job.rb

@@ -1,97 +1,7 @@
-require 'digest'
-require "image_processing/vips"
-
 class XmppSetAvatarJob < ApplicationJob
   queue_as :default
 
   def perform(user:, overwrite: false)
-    return if Rails.env.development?
-    @user = user
-
-    unless overwrite
-      current_avatar = get_current_avatar
-      Rails.logger.info { "User #{user.cn} already has an avatar set" }
-      return if current_avatar.present?
-    end
-
-    Rails.logger.debug { "Setting XMPP avatar for user #{user.cn}" }
-
-    stanzas = build_xep0084_stanzas
-
-    stanzas.each do |stanza|
-      payload = { from: @user.address, to: @user.address, stanza: stanza }
-      res = ejabberd.send_stanza payload
-      raise res.inspect if res.status != 200
-    end
+    EjabberdManager::SetAvatar.call(user:, overwrite:)
   end
-
-  private
-
-    def ejabberd
-      @ejabberd ||= EjabberdApiClient.new
-    end
-
-    def get_current_avatar
-      res = ejabberd.get_vcard2 @user, "PHOTO", "BINVAL"
-
-      if res.status == 200
-        # VCARD PHOTO/BINVAL prop exists
-        res.body
-      elsif res.status == 400
-        # VCARD or PHOTO/BINVAL prop does not exist
-        nil
-      else
-        # Unexpected error, let job fail
-        raise res.inspect
-      end
-    end
-
-    def process_avatar
-      @user.avatar.blob.open do |file|
-        processed = ImageProcessing::Vips
-          .source(file)
-          .resize_to_fill(256, 256)
-          .convert("png")
-          .call
-        processed.read
-      end
-    end
-
-    # See https://xmpp.org/extensions/xep-0084.html
-    def build_xep0084_stanzas
-      img_data    = process_avatar
-      sha1_hash   = Digest::SHA1.hexdigest(img_data)
-      base64_data = Base64.strict_encode64(img_data)
-
-      [
-        """
-<iq type='set' from='#{@user.address}' id='avatar-data-#{rand(101)}'>
-  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
-    <publish node='urn:xmpp:avatar:data'>
-      <item id='#{sha1_hash}'>
-        <data xmlns='urn:xmpp:avatar:data'>#{base64_data}</data>
-      </item>
-    </publish>
-  </pubsub>
-</iq>
-        """.strip,
-        """
-<iq type='set' from='#{@user.address}' id='avatar-metadata-#{rand(101)}'>
-  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
-    <publish node='urn:xmpp:avatar:metadata'>
-      <item id='#{sha1_hash}'>
-        <metadata xmlns='urn:xmpp:avatar:metadata'>
-          <info bytes='#{img_data.size}'
-                id='#{sha1_hash}'
-                height='256'
-                type='image/png'
-                width='256'/>
-        </metadata>
-      </item>
-    </publish>
-  </pubsub>
-</iq>
-        """.strip,
-      ]
-    end
 end

app/jobs/xmpp_set_default_bookmarks_job.rb

@@ -2,25 +2,6 @@ class XmppSetDefaultBookmarksJob < ApplicationJob
   queue_as :default
 
   def perform(user)
-    return unless Setting.xmpp_default_rooms.any?
-    @user = user
-    ejabberd = EjabberdApiClient.new
-    ejabberd.private_set user, storage_content
-  end
-
-  def storage_content
-    bookmarks = ""
-    Setting.xmpp_default_rooms.each do |r|
-      bookmarks << conference_element(
-        jid: r[/<(.+)>/, 1], name: r[/^(.+)\s/, 1], nick: @user.cn,
-        autojoin: Setting.xmpp_autojoin_default_rooms
-      )
-    end
-
-    "<storage xmlns='storage:bookmarks'>#{bookmarks}</storage>"
-  end
-
-  def conference_element(jid:, name:, autojoin: false, nick:)
-    "<conference jid='#{jid}' name='#{name}' autojoin='#{autojoin.to_s}'><nick>#{nick}</nick></conference>"
+    EjabberdManager::SetDefaultBookmarks.call(user:)
   end
 end

app/services/ejabberd_manager/exchange_contacts.rb

@@ -0,0 +1,25 @@
+module EjabberdManager
+  class ExchangeContacts < EjabberdManagerService
+    def initialize(inviter:, invitee:)
+      @inviter = inviter
+      @invitee = invitee
+    end
+
+    def call
+      return unless @inviter.service_enabled?(:ejabberd) &&
+                    @invitee.service_enabled?(:ejabberd) &&
+                    @inviter.preferences[:xmpp_exchange_contacts_with_invitees]
+
+      add_rosteritem({
+        "localuser": @invitee.cn, "localhost": @invitee.ou,
+        "user": @inviter.cn, "host": @inviter.ou,
+        "nick": @inviter.cn, "group": Setting.ejabberd_buddy_roster, "subs": "both"
+      })
+      add_rosteritem({
+        "localuser": @inviter.cn, "localhost": @inviter.ou,
+        "user": @invitee.cn, "host": @invitee.ou,
+        "nick": @invitee.cn, "group": Setting.ejabberd_buddy_roster, "subs": "both"
+      })
+    end
+  end
+end

app/services/ejabberd_manager/get_avatar.rb

@@ -0,0 +1,25 @@
+module EjabberdManager
+  class GetAvatar < EjabberdManagerService
+    def initialize(user:)
+      @user = user
+    end
+
+    def call
+      res = get_vcard2 @user, "PHOTO", "BINVAL"
+
+      if res.status == 200
+        # VCARD PHOTO/BINVAL prop exists
+        img_base64 = JSON.parse(res.body)["content"]
+        ct_res = get_vcard2 @user, "PHOTO", "TYPE"
+        content_type = JSON.parse(ct_res.body)["content"]
+        { content_type:, img_base64: }
+      elsif res.status == 400
+        # VCARD or PHOTO/BINVAL prop does not exist
+        nil
+      else
+        # Unexpected error, let job fail
+        raise res.inspect
+      end
+    end
+  end
+end

app/services/ejabberd_manager/send_message.rb

@@ -0,0 +1,11 @@
+module EjabberdManager
+  class SendMessage < EjabberdManagerService
+    def initialize(payload:)
+      @payload = payload
+    end
+
+    def call
+      send_message @payload
+    end
+  end
+end

app/services/ejabberd_manager/set_avatar.rb

@@ -0,0 +1,80 @@
+require 'digest'
+require "image_processing/vips"
+
+module EjabberdManager
+  class SetAvatar < EjabberdManagerService
+    def initialize(user:, overwrite: false)
+      @user = user
+      @overwrite = overwrite
+    end
+
+    def call
+      unless @overwrite
+        current_avatar = EjabberdManager::GetAvatar.call(user: @user)
+        Rails.logger.info { "User #{user.cn} already has an avatar set" }
+        return if current_avatar.present?
+      end
+
+      Rails.logger.debug { "Setting XMPP avatar for user #{@user.cn}" }
+
+      stanzas = build_xep0084_stanzas
+
+      stanzas.each do |stanza|
+        payload = { from: @user.address, to: @user.address, stanza: stanza }
+        res = send_stanza payload
+        raise res.inspect if res.status != 200
+      end
+    end
+  end
+
+  private
+
+    def process_avatar
+      @user.avatar.blob.open do |file|
+        processed = ImageProcessing::Vips
+          .source(file)
+          .resize_to_fill(256, 256)
+          .convert("png")
+          .call
+        processed.read
+      end
+    end
+
+    # See https://xmpp.org/extensions/xep-0084.html
+    def build_xep0084_stanzas
+      img_data    = process_avatar
+      sha1_hash   = Digest::SHA1.hexdigest(img_data)
+      base64_data = Base64.strict_encode64(img_data)
+
+      [
+        """
+<iq type='set' from='#{@user.address}' id='avatar-data-#{rand(101)}'>
+  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+    <publish node='urn:xmpp:avatar:data'>
+      <item id='#{sha1_hash}'>
+        <data xmlns='urn:xmpp:avatar:data'>#{base64_data}</data>
+      </item>
+    </publish>
+  </pubsub>
+</iq>
+        """.strip,
+        """
+<iq type='set' from='#{@user.address}' id='avatar-metadata-#{rand(101)}'>
+  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
+    <publish node='urn:xmpp:avatar:metadata'>
+      <item id='#{sha1_hash}'>
+        <metadata xmlns='urn:xmpp:avatar:metadata'>
+          <info bytes='#{img_data.size}'
+                id='#{sha1_hash}'
+                height='256'
+                type='image/png'
+                width='256'/>
+        </metadata>
+      </item>
+    </publish>
+  </pubsub>
+</iq>
+        """.strip,
+      ]
+    end
+end

app/services/ejabberd_manager/set_default_bookmarks.rb

@@ -0,0 +1,31 @@
+module EjabberdManager
+  class SetDefaultBookmarks < EjabberdManagerService
+    def initialize(user:)
+      @user = user
+    end
+
+    def call
+      return unless Setting.xmpp_default_rooms.any?
+
+      private_set @user, storage_content
+    end
+
+    private
+
+    def storage_content
+      bookmarks = ""
+      Setting.xmpp_default_rooms.each do |r|
+        bookmarks << conference_element(
+          jid: r[/<(.+)>/, 1], name: r[/^(.+)\s/, 1], nick: @user.cn,
+          autojoin: Setting.xmpp_autojoin_default_rooms
+        )
+      end
+
+      "<storage xmlns='storage:bookmarks'>#{bookmarks}</storage>"
+    end
+
+    def conference_element(jid:, name:, autojoin: false, nick:)
+      "<conference jid='#{jid}' name='#{name}' autojoin='#{autojoin.to_s}'><nick>#{nick}</nick></conference>"
+    end
+  end
+end

app/services/ejabberd_manager_service.rb

@@ -1,11 +1,16 @@
-class EjabberdApiClient
-  def initialize
-    @base_url = Setting.ejabberd_api_url
+class EjabberdManagerService < RestApiService
+  private
+
+  def base_url
+    @base_url ||= Setting.ejabberd_api_url
   end
 
-  def post(endpoint, payload)
-    Faraday.post "#{@base_url}/#{endpoint}", payload.to_json,
-                 "Content-Type" => "application/json"
+  def headers
+    { "Content-Type" => "application/json" }
+  end
+
+  def parse_responses?
+    false
   end
 
   #

app/services/rest_api_service.rb

@@ -13,15 +13,17 @@ class RestApiService < ApplicationService
     "#{base_url}/#{path.gsub(/^\//, '')}"
   end
 
+  def parse_responses?
+    true
+  end
+
   def get(path, params = {})
     res = Faraday.get endpoint_url(path), params, headers
-    # TODO handle unsuccessful responses with no valid JSON body
-    JSON.parse(res.body)
+    parse_responses? ? JSON.parse(res.body) : res
   end
 
   def post(path, payload)
     res = Faraday.post endpoint_url(path), payload.to_json, headers
-    # TODO handle unsuccessful responses with no valid JSON body
-    JSON.parse(res.body)
+    parse_responses? ? JSON.parse(res.body) : res
   end
 end

app/services/user_manager/update_avatar.rb

@@ -8,6 +8,7 @@ module UserManager
       LdapManager::UpdateAvatar.call(user: @user)
 
       if Setting.ejabberd_enabled?
+        return if Rails.env.development?
         XmppSetAvatarJob.perform_later(user: @user)
       end
     end