zm-ruby-client 2.2.7 → 3.0.0

data/lib/zm/client/search_folder/search_folder_jsns_initializer.rb

@@ -6,28 +6,29 @@ module Zm
     class SearchFolderJsnsInitializer
       class << self
         def create(parent, json)
-          item = SearchFolder.new(parent)
-          update(item, json)
+          SearchFolder.new(parent).tap do |item|
+            update(item, json)
+          end
         end
 
         def update(item, json)
-          item.id = json[:id].to_i
-          item.name = json[:name]
+          item.id = json.delete(:id)
+          item.name = json.delete(:name)
 
-          item.uuid = json[:uuid]
-          item.deletable = json[:deletable]
-          item.absFolderPath = json[:absFolderPath]
-          item.l = json[:l].to_i
-          item.luuid = json[:luuid]
-          item.color = json[:color]
-          item.rgb = json[:rgb]
-          item.rev = json[:rev]
-          item.ms = json[:ms]
-          item.webOfflineSyncDays = json[:webOfflineSyncDays]
-          item.activesyncdisabled = json[:activesyncdisabled]
-          item.query = json[:query]
-          item.sortBy = json[:sortBy]
-          item.types = json[:types]
+          item.uuid = json.delete(:uuid)
+          item.deletable = json.delete(:deletable)
+          item.absFolderPath = json.delete(:absFolderPath)
+          item.l = json.delete(:l)
+          item.luuid = json.delete(:luuid)
+          item.color = json.delete(:color)
+          item.rgb = json.delete(:rgb)
+          item.rev = json.delete(:rev)
+          item.ms = json.delete(:ms)
+          item.webOfflineSyncDays = json.delete(:webOfflineSyncDays)
+          item.activesyncdisabled = json.delete(:activesyncdisabled)
+          item.query = json.delete(:query)
+          item.sortBy = json.delete(:sortBy)
+          item.types = json.delete(:types)
 
           item
         end

data/lib/zm/client/search_folder/search_folders_builder.rb

@@ -5,7 +5,7 @@ module Zm
     # class factory [Search folders]
     class SearchFoldersBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :search
       end
 

data/lib/zm/client/search_folder/search_folders_collection.rb

@@ -7,14 +7,15 @@ module Zm
       def initialize(parent)
         @child_class = SearchFolder
         @builder_class = SearchFoldersBuilder
-        super(parent)
+        super
       end
 
-      private
-
       def make_query
-        soap_request = SoapElement.mail(SoapMailConstants::GET_SEARCH_FOLDER_REQUEST)
-        @parent.sacc.invoke(soap_request)
+        @parent.soap_connector.invoke(build_query)
+      end
+
+      def build_query
+        SoapElement.mail(SoapMailConstants::GET_SEARCH_FOLDER_REQUEST)
       end
     end
   end

data/lib/zm/client/server/server.rb

@@ -10,15 +10,21 @@ module Zm
       include HasSoapAdminConnector
 
       def mta_queues
-        @mta_queues ||= MtaQueuesCollection.new(self)
+        return @mta_queues if defined? @mta_queues
+
+        @mta_queues = MtaQueuesCollection.new(self)
       end
 
       def backups
-        @backups ||= BackupsCollection.new(self)
+        return @backups if defined? @backups
+
+        @backups = BackupsCollection.new(self)
       end
 
       def accounts
-        @accounts ||= ServerAccountsCollection.new(self)
+        return @accounts if defined? @accounts
+
+        @accounts = ServerAccountsCollection.new(self)
       end
 
       def update!(hash)

data/lib/zm/client/server/server_accounts_collection.rb

@@ -6,13 +6,15 @@ module Zm
     class ServerAccountsCollection < AccountsCollection
       def initialize(parent)
         @target_server_id = parent.id
-        super(parent)
+        super
       end
 
       private
 
       def ldap_filter
-        @ldap_filter ||= LdapFilter.new("(zimbraMailHost=#{@parent.name})")
+        return @ldap_filter if defined? @ldap_filter
+
+        @ldap_filter = LdapFilter.new("(zimbraMailHost=#{@parent.name})")
       end
     end
   end

data/lib/zm/client/server/server_jsns_initializer.rb

@@ -5,11 +5,7 @@ module Zm
     # class for initialize account
     class ServerJsnsInitializer < Base::BaseJsnsInitializer
       class << self
-        def create(parent, json)
-          item = Server.new(parent)
-
-          update(item, json)
-        end
+        def klass = Server
       end
     end
   end

data/lib/zm/client/server/servers_builder.rb

@@ -5,7 +5,7 @@ module Zm
     # class factory [servers]
     class ServersBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :server
       end
 

data/lib/zm/client/server/servers_collection.rb

@@ -9,31 +9,39 @@ module Zm
         @child_class = Server
         @builder_class = ServersBuilder
         @service = nil
-        super(parent)
+        super
       end
 
       def find_by!(hash)
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_SERVER_REQUEST)
-        node_server = SoapElement.create(SoapConstants::SERVER).add_attribute(SoapConstants::BY, hash.keys.first).add_content(hash.values.first)
-        soap_request.add_node(node_server)
-        soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma) unless @attrs.nil?
-        entry = sac.invoke(soap_request)[:GetServerResponse][:server].first
+        entry = sac.invoke(build_find_by(hash))[:GetServerResponse][:server].first
 
         reset_query_params
         ServerJsnsInitializer.create(@parent, entry)
       end
 
+      def build_find_by(hash)
+        soap_request = SoapElement.admin(SoapAdminConstants::GET_SERVER_REQUEST)
+        node_server = SoapElement.create(SoapConstants::SERVER)
+                                 .add_attribute(SoapConstants::BY, hash.keys.first)
+                                 .add_content(hash.values.first)
+        soap_request.add_node(node_server)
+        soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma) unless @attrs.nil?
+        soap_request
+      end
+
       def where(service)
         @service = service
         self
       end
 
-      private
-
       def make_query
+        sac.invoke(build_query)
+      end
+
+      def build_query
         soap_request = SoapElement.admin(SoapAdminConstants::GET_ALL_SERVERS_REQUEST)
         soap_request.add_attribute(SoapConstants::SERVICE, @service) unless @service.nil?
-        sac.invoke(soap_request)
+        soap_request
       end
     end
   end

data/lib/zm/client/share/share.rb

@@ -4,11 +4,13 @@ module Zm
   module Client
     # class for account share
     class Share < Base::Object
-      attr_accessor :ownerId, :ownerEmail, :ownerName, :folderId, :folderUuid, :folderPath, :view, :rights,
-                    :granteeType, :granteeId, :granteeName, :mid
+      attr_accessor :ownerId, :ownerEmail, :ownerName, :folderId, :folderUuid, :folderPath,
+                    :view, :rights, :granteeType, :granteeId, :granteeName, :mid
 
       def mountpoints
-        @mountpoints ||= ShareMountPointsCollection.new(self)
+        return @mountpoints if defined? @mountpoints
+
+        @mountpoints = ShareMountPointsCollection.new(self)
       end
     end
   end

data/lib/zm/client/share/share_jsns_initializer.rb

@@ -6,23 +6,24 @@ module Zm
     class ShareJsnsInitializer
       class << self
         def create(parent, json)
-          item = Share.new(parent)
-          update(item, json)
+          Share.new(parent).tap do |item|
+            update(item, json)
+          end
         end
 
         def update(item, json)
-          item.ownerId = json[:ownerId]
-          item.ownerEmail = json[:ownerEmail]
-          item.ownerName = json[:ownerName]
-          item.folderId = json[:folderId]
-          item.folderUuid = json[:folderUuid]
-          item.folderPath = json[:folderPath]
-          item.view = json[:view]
-          item.rights = json[:rights]
-          item.granteeType = json[:granteeType]
-          item.granteeId = json[:granteeId]
-          item.granteeName = json[:granteeName]
-          item.mid = json[:mid]
+          item.ownerId = json.delete(:ownerId)
+          item.ownerEmail = json.delete(:ownerEmail)
+          item.ownerName = json.delete(:ownerName)
+          item.folderId = json.delete(:folderId)
+          item.folderUuid = json.delete(:folderUuid)
+          item.folderPath = json.delete(:folderPath)
+          item.view = json.delete(:view)
+          item.rights = json.delete(:rights)
+          item.granteeType = json.delete(:granteeType)
+          item.granteeId = json.delete(:granteeId)
+          item.granteeName = json.delete(:granteeName)
+          item.mid = json.delete(:mid)
 
           item
         end

data/lib/zm/client/share/share_mountpoints_collection.rb

@@ -10,7 +10,7 @@ module Zm
 
       def new
         MountPoint.new(@share.parent) do |mp|
-          mp.l = FolderDefault::ROOT[:id]
+          mp.l = FolderDefault::ROOT.id
           mp.name = default_mountpoint_name
           mp.zid = @share.ownerId
           mp.rid = @share.folderId
@@ -19,12 +19,9 @@ module Zm
       end
 
       def all
-        @all || all!
-      end
-
-      def all!
-        @all = @share.parent.mountpoints.all.select { |mp| mp.zid == @share.ownerId && mp.rid == @share.folderId }
+        @share.parent.mountpoints.all.select { |mp| mp.zid == @share.ownerId && mp.rid == @share.folderId }
       end
+      alias all! all
 
       private
 

data/lib/zm/client/share/shares_builder.rb

@@ -5,7 +5,7 @@ module Zm
     # class factory [shares]
     class ShareBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :share
       end
 

data/lib/zm/client/share/shares_collection.rb

@@ -21,14 +21,17 @@ module Zm
       end
 
       def share_response
-        soap_request = SoapElement.account(SoapAccountConstants::GET_SHARE_INFO_REQUEST).add_attributes({ includeSelf: 0 })
+        soap_request = SoapElement.account(SoapAccountConstants::GET_SHARE_INFO_REQUEST)
+                                  .add_attributes({ includeSelf: SoapUtils::OFF })
 
         unless @owner_name.nil?
-          node_owner = SoapElement.create('owner').add_attributes({ by: :name }).add_content(@owner_name)
+          node_owner = SoapElement.create('owner')
+                                  .add_attributes({ by: :name })
+                                  .add_content(@owner_name)
           soap_request.add_node(node_owner)
         end
 
-        @parent.sacc.invoke(soap_request)
+        @parent.soap_connector.invoke(soap_request)
       end
 
       def share_builder

data/lib/zm/client/signature/signature.rb

@@ -4,36 +4,19 @@ module Zm
   module Client
     # class account signature
     class Signature < Base::Object
+      include RequestMethodsMailbox
+
       attr_accessor :id, :name, :txt, :html
 
       def create!
-        rep = @parent.sacc.invoke(jsns_builder.to_jsns)
+        rep = @parent.soap_connector.invoke(build_create)
         @id = rep[:CreateSignatureResponse][:signature].first[:id]
       end
 
-      def modify!
-        @parent.sacc.invoke(jsns_builder.to_update)
-        true
-      end
-
       def update!(*args)
         raise NotImplementedError
       end
 
-      def rename!(new_name)
-        return if new_name == @name
-
-        @parent.sacc.invoke(jsns_builder.to_rename(new_name))
-        @name = new_name
-      end
-
-      def delete!
-        return false if @id.nil?
-
-        @parent.sacc.invoke(jsns_builder.to_delete)
-        @id = nil
-      end
-
       def type
         return ContentType::HTML unless html.nil?
 
@@ -55,7 +38,9 @@ module Zm
       private
 
       def jsns_builder
-        @jsns_builder ||= SignatureJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = SignatureJsnsBuilder.new(self)
       end
     end
   end

data/lib/zm/client/signature/signature_jsns_builder.rb

@@ -10,20 +10,24 @@ module Zm
 
       def to_jsns
         soap_request = SoapElement.account(SoapAccountConstants::CREATE_SIGNATURE_REQUEST)
-        node_signature = SoapElement.create(SoapConstants::SIGNATURE).add_attributes({ name: @signature.name })
+        node_signature = SoapElement.create(SoapConstants::SIGNATURE)
+                                    .add_attributes({ name: @signature.name })
         soap_request.add_node(node_signature)
-        node_content = SoapElement.create(SoapConstants::CONTENT).add_attribute(SoapConstants::TYPE,
-                                                                   @signature.type).add_content(@signature.content)
+        node_content = SoapElement.create(SoapConstants::CONTENT)
+                                  .add_attribute(SoapConstants::TYPE, @signature.type)
+                                  .add_content(@signature.content)
         node_signature.add_node(node_content)
         soap_request
       end
 
       def to_update
         soap_request = SoapElement.account(SoapAccountConstants::MODIFY_SIGNATURE_REQUEST)
-        node_signature = SoapElement.create(SoapConstants::SIGNATURE).add_attributes({ name: @signature.name, id: @signature.id })
+        node_signature = SoapElement.create(SoapConstants::SIGNATURE)
+                                    .add_attributes({ name: @signature.name, id: @signature.id })
         soap_request.add_node(node_signature)
-        node_content = SoapElement.create(SoapConstants::CONTENT).add_attribute(SoapConstants::TYPE,
-                                                                   @signature.type).add_content(@signature.content)
+        node_content = SoapElement.create(SoapConstants::CONTENT)
+                                  .add_attribute(SoapConstants::TYPE, @signature.type)
+                                  .add_content(@signature.content)
         node_signature.add_node(node_content)
         soap_request
       end
@@ -42,7 +46,8 @@ module Zm
 
       def to_delete
         soap_request = SoapElement.account(SoapAccountConstants::DELETE_SIGNATURE_REQUEST)
-        node_signature = SoapElement.create(SoapConstants::SIGNATURE).add_attribute(SoapConstants::ID, @signature.id)
+        node_signature = SoapElement.create(SoapConstants::SIGNATURE)
+                                    .add_attribute(SoapConstants::ID, @signature.id)
         soap_request.add_node(node_signature)
         soap_request
       end

data/lib/zm/client/signature/signature_jsns_initializer.rb

@@ -6,13 +6,14 @@ module Zm
     class SignatureJsnsInitializer
       class << self
         def create(parent, json)
-          item = Signature.new(parent)
-          update(item, json)
+          Signature.new(parent).tap do |item|
+            update(item, json)
+          end
         end
 
         def update(item, json)
-          item.id = json[:id]
-          item.name = json[:name]
+          item.id = json.delete(:id)
+          item.name = json.delete(:name)
 
           content = json[:content].is_a?(Array) ? json[:content] : [json[:content]]
 

data/lib/zm/client/signature/signatures_builder.rb

@@ -5,7 +5,7 @@ module Zm
     # class factory [signatures]
     class SignaturesBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :signature
       end
 

data/lib/zm/client/signature/signatures_collection.rb

@@ -7,14 +7,15 @@ module Zm
       def initialize(parent)
         @child_class = Signature
         @builder_class = SignaturesBuilder
-        super(parent)
+        super
       end
 
-      private
-
       def make_query
-        soap_request = SoapElement.account(SoapAccountConstants::GET_SIGNATURES_REQUEST)
-        @parent.sacc.invoke(soap_request)
+        @parent.soap_connector.invoke(build_query)
+      end
+
+      def build_query
+        SoapElement.account(SoapAccountConstants::GET_SIGNATURES_REQUEST)
       end
     end
   end

data/lib/zm/client/soap_request/request_methods_admin.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module RequestMethodsAdmin
+      def delete!
+        sac.invoke(build_delete)
+        @id = nil
+      end
+
+      def build_delete
+        jsns_builder.to_delete
+      end
+
+      def modify!
+        sac.invoke(build_modify)
+        true
+      end
+
+      def build_modify
+        jsns_builder.to_update
+      end
+
+      def build_create
+        jsns_builder.to_create
+      end
+
+      def update!(hash)
+        return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
+
+        do_update!(hash)
+
+        hash.each do |key, value|
+          update_attribute(key, value)
+        end
+
+        true
+      end
+
+      def rename!(new_name)
+        sac.invoke(build_rename(new_name))
+        @name = new_name
+      end
+
+      def build_rename(new_name)
+        jsns_builder.to_rename(new_name)
+      end
+
+      private
+
+      def do_update!(hash)
+        sac.invoke(jsns_builder.to_patch(hash))
+      end
+    end
+  end
+end

data/lib/zm/client/soap_request/request_methods_mailbox.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module RequestMethodsMailbox
+      def build_create
+        jsns_builder.to_jsns
+      end
+
+      def modify!
+        @parent.soap_connector.invoke(build_modify)
+        true
+      end
+
+      def build_modify
+        jsns_builder.to_update
+      end
+
+      def update!(hash)
+        return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
+
+        do_update!(hash)
+
+        hash.each do |key, value|
+          update_attribute(key, value)
+        end
+
+        true
+      end
+
+      def rename!(new_name)
+        return false if new_name == @name
+
+        @parent.soap_connector.invoke(build_rename(new_name))
+        @name = new_name
+      end
+
+      def build_rename(new_name)
+        jsns_builder.to_rename(new_name)
+      end
+
+      def delete!
+        return false if id.nil?
+
+        @parent.soap_connector.invoke(build_delete)
+        # remove_instance_variable(:id)
+      end
+
+      def build_delete
+        jsns_builder.to_delete
+      end
+
+      private
+
+      def do_update!(hash)
+        @parent.soap_connector.invoke(jsns_builder.to_patch(hash))
+      end
+    end
+  end
+end

data/lib/zm/client/soap_request/soap_constants.rb

@@ -6,6 +6,7 @@ module Zm
       BY = 'by'
       ID = 'id'
       NAME = 'name'
+      EXPIRES = 'expires'
       A = 'a'
       N = 'n'
       TRUE = 'TRUE'
@@ -20,6 +21,7 @@ module Zm
       SERVER = 'server'
       COS = 'cos'
       DL = 'dl'
+      DLM = 'dlm'
       DOMAIN = 'domain'
       CAL_RESOURCE = 'calresource'
 
@@ -35,6 +37,7 @@ module Zm
       CONTENT = 'content'
 
       APPOINTMENT = 'appointment'
+      CONTACT = 'contact'
       DOCUMENT = 'document'
       MESSAGE = 'message'
       TAG = 'tag'
@@ -50,6 +53,10 @@ module Zm
       SMTP = 'smtp'
 
       TEXT_CALENDAR = 'text/calendar'
+      CSV = 'csv'
+
+      NAMESPACE_STR = 'urn:zimbra'
+      BATCH_REQUEST = 'BatchRequest'
     end
   end
 end

data/lib/zm/client/soap_request/soap_context.rb

@@ -9,6 +9,7 @@ module Zm
         @token = nil
         @user_agent = 'zmsoap'
         @target_server = nil
+        @account = nil
       end
 
       def token(str)
@@ -26,12 +27,20 @@ module Zm
         self
       end
 
+      def account(by, value)
+        @account = { by: by, _content: value }
+        self
+      end
+
       def to_hash
-        {
+        h = {
           authToken: @token,
           userAgent: { name: @user_agent },
+          account: @account,
           targetServer: @target_server
-        }.delete_if { |_, v| v.nil? }
+        }
+        h.compact!
+        h
       end
     end
   end

data/lib/zm/client/soap_request.rb

@@ -6,3 +6,6 @@ require 'zm/client/soap_request/account_soap_constants'
 require 'zm/client/soap_request/mail_soap_constants'
 require 'zm/client/soap_request/soap_constants'
 require 'zm/client/soap_request/soap_element'
+
+require 'zm/client/soap_request/request_methods_admin'
+require 'zm/client/soap_request/request_methods_mailbox'