zm-ruby-client 2.2.7 → 3.0.0

data/lib/zm/client/cos/cos_jsns_builder.rb

@@ -15,7 +15,9 @@ module Zm
 
         attrs_only_set_h.each do |key, values|
           values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
+            node_attr = SoapElement.create(SoapConstants::A)
+                                   .add_attribute(SoapConstants::N, key)
+                                   .add_content(value)
             soap_request.add_node(node_attr)
           end
         end
@@ -25,12 +27,15 @@ module Zm
 
       def to_update
         soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_COS_REQUEST)
-        node_cos = SoapElement.create(SoapConstants::ID).add_content(@item.id)
+        node_cos = SoapElement.create(SoapConstants::ID)
+                              .add_content(@item.id)
         soap_request.add_node(node_cos)
 
         attrs_only_set_h.each do |key, values|
           values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
+            node_attr = SoapElement.create(SoapConstants::A)
+                                   .add_attribute(SoapConstants::N, key)
+                                   .add_content(value)
             soap_request.add_node(node_attr)
           end
         end
@@ -40,13 +45,16 @@ module Zm
 
       def to_patch(hash)
         soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_COS_REQUEST)
-        node_cos = SoapElement.create(SoapConstants::ID).add_content(@item.id)
+        node_cos = SoapElement.create(SoapConstants::ID)
+                              .add_content(@item.id)
         soap_request.add_node(node_cos)
 
         hash.each do |key, values|
           values = [values] unless values.is_a?(Array)
           values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
+            node_attr = SoapElement.create(SoapConstants::A)
+                                   .add_attribute(SoapConstants::N, key)
+                                   .add_content(value)
             soap_request.add_node(node_attr)
           end
         end
@@ -56,12 +64,17 @@ module Zm
 
       def to_copy(new_name)
         soap_request = SoapElement.admin(SoapAdminConstants::COPY_COS_REQUEST)
-        node_name = SoapElement.create(SoapConstants::NAME).add_content(new_name)
+        node_name = SoapElement.create(SoapConstants::NAME)
+                               .add_content(new_name)
 
         if @item.id
-          node_cos = SoapElement.create(SoapConstants::COS).add_attribute(SoapConstants::BY, SoapConstants::ID).add_content(@item.id)
+          node_cos = SoapElement.create(SoapConstants::COS)
+                                .add_attribute(SoapConstants::BY, SoapConstants::ID)
+                                .add_content(@item.id)
         elsif @item.name
-          node_cos = SoapElement.create(SoapConstants::COS).add_attribute(SoapConstants::BY, SoapConstants::NAME).add_content(@item.name)
+          node_cos = SoapElement.create(SoapConstants::COS)
+                                .add_attribute(SoapConstants::BY, SoapConstants::NAME)
+                                .add_content(@item.name)
         else
           raise Zm::Client::ZmError, 'id or name attributes are required to clone cos'
         end
@@ -88,7 +101,7 @@ module Zm
           [n, values]
         end
 
-        Hash[arr]
+        arr.to_h
       end
     end
   end

data/lib/zm/client/cos/cos_jsns_initializer.rb

@@ -5,14 +5,10 @@ module Zm
     # class for initialize cos
     class CosJsnsInitializer < Base::BaseJsnsInitializer
       class << self
-        def create(parent, json)
-          item = Cos.new(parent)
-
-          update(item, json)
-        end
+        def klass = Cos
 
         def update(item, json)
-          item = super(item, json)
+          item = super
 
           case item.zimbraMailHostPool
           when String

data/lib/zm/client/cos/cos_servers_collection.rb

@@ -9,14 +9,11 @@ module Zm
       end
 
       def all
-        @all || all!
-      end
-
-      def all!
-        @all = @parent.zimbraMailHostPool.map do |server_id|
+        @parent.zimbraMailHostPool.map do |server_id|
           servers_collection.find_by(id: server_id)
         end
       end
+      alias all! all
 
       def add!(*servers)
         servers.flatten!
@@ -55,7 +52,9 @@ module Zm
       end
 
       def servers_collection
-        @servers_collection ||= ServersCollection.new(@parent)
+        return @servers_collection if defined? @servers_collection
+
+        @servers_collection = ServersCollection.new(@parent)
       end
     end
   end

data/lib/zm/client/cos/coses_builder.rb

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

data/lib/zm/client/cos/coses_collection.rb

@@ -8,12 +8,14 @@ module Zm
         @child_class = Cos
         @builder_class = CosesBuilder
         @search_type = SearchType::COS
-        super(parent)
+        super
       end
 
       def find_by!(hash)
         soap_request = SoapElement.admin(SoapAdminConstants::GET_COS_REQUEST)
-        node_cos = SoapElement.create(SoapConstants::COS).add_attribute(SoapConstants::BY, hash.keys.first).add_content(hash.values.first)
+        node_cos = SoapElement.create(SoapConstants::COS)
+                              .add_attribute(SoapConstants::BY, hash.keys.first)
+                              .add_content(hash.values.first)
         soap_request.add_node(node_cos)
         soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma)
         entry = sac.invoke(soap_request)[:GetCosResponse][:cos].first
@@ -22,8 +24,8 @@ module Zm
         CosJsnsInitializer.create(@parent, entry)
       end
 
-      def clone!(new_name, &block)
-        cos = Cos.new(parent, &block)
+      def clone!(new_name, &)
+        cos = Cos.new(parent, &)
         cos.clone!(new_name)
       end
 

data/lib/zm/client/datasource/datasource.rb

@@ -4,18 +4,20 @@ module Zm
   module Client
     # class account data source
     class DataSource < Base::Object
-      TYPES = %i[cal caldav yab gal imap pop3 rss unknown]
-
-      attr_accessor :a, :cconnectionType, :cdefaultSignature, :cemailAddress, :cfailingSince, 
-                    :cforwardReplySignature, :cfromDisplay, :chost, :cid, :cimportClass, :cimportOnly, 
-                    :cisEnabled, :cl, :clientId, :clientSecret, :cname, :connectionType, :cpassword, 
-                    :cpollingInterval, :cport, :crefreshToken, :crefreshTokenUrl, :creplyToAddress, 
-                    :creplyToDisplay, :csmtpAuthRequired, :csmtpConnectionType, :csmtpEnabled, :csmtpHost, 
-                    :csmtpPassword, :csmtpPort, :csmtpUsername, :cuseAddressForForwardReply, :cusername, 
-                    :defaultSignature, :emailAddress, :failingSince, :forwardReplySignature, :fromDisplay, 
-                    :host, :id, :importClass, :importOnly, :isEnabled, :l, :lastError, :leaveOnServer, :name, 
-                    :oauthToken, :password, :pollingInterval, :port, :refreshToken, :refreshTokenUrl, 
-                    :replyToAddress, :replyToDisplay, :smtpAuthRequired, :smtpConnectionType, :smtpEnabled, 
+      include RequestMethodsMailbox
+
+      TYPES = %i[cal caldav yab gal imap pop3 rss unknown].freeze
+
+      attr_accessor :a, :cconnectionType, :cdefaultSignature, :cemailAddress, :cfailingSince,
+                    :cforwardReplySignature, :cfromDisplay, :chost, :cid, :cimportClass, :cimportOnly,
+                    :cisEnabled, :cl, :clientId, :clientSecret, :cname, :connectionType, :cpassword,
+                    :cpollingInterval, :cport, :crefreshToken, :crefreshTokenUrl, :creplyToAddress,
+                    :creplyToDisplay, :csmtpAuthRequired, :csmtpConnectionType, :csmtpEnabled, :csmtpHost,
+                    :csmtpPassword, :csmtpPort, :csmtpUsername, :cuseAddressForForwardReply, :cusername,
+                    :defaultSignature, :emailAddress, :failingSince, :forwardReplySignature, :fromDisplay,
+                    :host, :id, :importClass, :importOnly, :isEnabled, :l, :lastError, :leaveOnServer, :name,
+                    :oauthToken, :password, :pollingInterval, :port, :refreshToken, :refreshTokenUrl,
+                    :replyToAddress, :replyToDisplay, :smtpAuthRequired, :smtpConnectionType, :smtpEnabled,
                     :smtpHost, :smtpPassword, :smtpPort, :smtpUsername, :test, :useAddressForForwardReply, :username,
                     :type
 
@@ -28,42 +30,33 @@ module Zm
         raise NotImplementedError
       end
 
-      def modify!
+      def build_create
         raise NotImplementedError
       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
+      def modify!
+        raise NotImplementedError
       end
 
-      def rename!(new_name)
+      def build_modify
         raise NotImplementedError
       end
 
-      def delete!
-        return false if @id.nil?
+      def rename!(*args)
+        raise NotImplementedError
+      end
 
-        @parent.sacc.invoke(jsns_builder.to_delete)
-        @id = nil
+      def build_rename(*args)
+        raise NotImplementedError
       end
 
       private
 
-      def do_update!(hash)
-        @parent.sacc.invoke(jsns_builder.to_patch(hash))
-      end
-
       def jsns_builder
-        @jsns_builder ||= DataSourceJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = DataSourceJsnsBuilder.new(self)
       end
     end
   end
-end
+end

data/lib/zm/client/datasource/datasource_jsns_builder.rb

@@ -13,7 +13,7 @@ module Zm
           id: @item.id
         }.merge(hash)
 
-        attrs.reject! { |_, v| v.nil? }
+        attrs.compact!
 
         soap_request = SoapElement.mail(SoapMailConstants::MODIFY_DATA_SOURCE_REQUEST)
         node_action = SoapElement.create(@item.type).add_attributes(attrs)

data/lib/zm/client/datasource/datasource_jsns_initializer.rb

@@ -6,17 +6,16 @@ module Zm
     class DataSourceJsnsInitializer
       class << self
         def create(parent, data_source_type, json)
-          item = DataSource.new(parent, data_source_type)
-          update(item, json)
+          DataSource.new(parent, data_source_type).tap do |item|
+            update(item, json)
+          end
         end
 
         def update(item, json)
           json.each do |k, v|
-            setter_method = "#{k}=".to_sym
+            setter_method = :"#{k}="
 
-            if item.respond_to?(setter_method)
-              item.send(setter_method, v)
-            end
+            item.send(setter_method, v) if item.respond_to?(setter_method)
           end
 
           item

data/lib/zm/client/datasource/datasources_builder.rb

@@ -7,22 +7,19 @@ module Zm
       def make
         return [] if json_items.nil?
 
-        ds = []
-        json_items.each do |data_source_type, entries|
-          next unless DataSource::TYPES.include?(data_source_type)
-
-          entries.each do |entry|
-            ds << DataSourceJsnsInitializer.create(@parent, data_source_type, entry)
+        json_items.slice(*DataSource::TYPES).flat_map do |data_source_type, entries|
+          entries.map do |entry|
+            DataSourceJsnsInitializer.create(@parent, data_source_type, entry)
           end
         end
-
-        ds
       end
 
       private
 
       def json_items
-        @json_items ||= @json[json_key]
+        return @json_items if defined? @json_items
+
+        @json_items = @json[json_key]
       end
     end
   end

data/lib/zm/client/datasource/datasources_collection.rb

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

data/lib/zm/client/distributionlist/distributionlist.rb

@@ -10,59 +10,43 @@ module Zm
     # objectClass: zimbraDistributionList
     class DistributionList < Base::Object
       include HasSoapAdminConnector
+      include RequestMethodsAdmin
 
       def aliases
-        @aliases ||= DistributionListAliasesCollection.new(self)
+        return @aliases if defined? @aliases
+
+        @aliases = DistributionListAliasesCollection.new(self)
       end
 
       def members
-        @members ||= DistributionListMembersCollection.new(self)
+        return @members if defined? @members
+
+        @members = DistributionListMembersCollection.new(self)
       end
 
       def owners
-        @owners ||= DistributionListOwnersCollection.new(self)
+        return @owners if defined? @owners
+
+        @owners = DistributionListOwnersCollection.new(self)
       end
 
       def memberships
-        @memberships ||= DlsMembershipCollection.new(self)
+        return @memberships if defined? @memberships
+
+        @memberships = DlsMembershipCollection.new(self)
       end
 
       def aces
-        @aces ||= DistributionListAcesCollection.new(self)
+        return @aces if defined? @aces
+
+        @aces = DistributionListAcesCollection.new(self)
       end
 
       def create!
-        resp = sac.invoke(jsns_builder.to_create)
+        resp = sac.invoke(build_create)
         @id = resp[:CreateDistributionListResponse][:dl].first[:id]
       end
 
-      def modify!
-        sac.invoke(jsns_builder.to_update)
-        true
-      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(jsns_builder.to_rename(new_name))
-        @name = new_name
-      end
-
-      def delete!
-        sac.invoke(jsns_builder.to_delete)
-        @id = nil
-      end
-
       def local_transport
         raise Zm::Client::ZmError, 'zimbraMailHost is null' if zimbraMailHost.nil?
 
@@ -74,13 +58,13 @@ module Zm
       end
 
       def local_transport?
-        return nil unless zimbraMailTransport
+        return false unless zimbraMailTransport
 
         zimbraMailTransport.start_with?(SoapConstants::LMTP)
       end
 
       def external_transport?
-        return nil unless zimbraMailTransport
+        return false unless zimbraMailTransport
 
         zimbraMailTransport.start_with?(SoapConstants::SMTP)
       end
@@ -101,14 +85,10 @@ module Zm
         @parent.zimbra_attributes.all_distributionlist_attrs_writable_names
       end
 
-      private
-
-      def do_update!(hash)
-        sac.invoke(jsns_builder.to_patch(hash))
-      end
-
       def jsns_builder
-        @jsns_builder ||= DistributionListJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = DistributionListJsnsBuilder.new(self)
       end
     end
   end

data/lib/zm/client/distributionlist/distributionlist_aliases_collection.rb

@@ -15,25 +15,33 @@ module Zm
       def add!(email)
         return false if @all.include?(Utils.format_email(email))
 
-        soap_request = SoapElement.admin(SoapAdminConstants::ADD_DISTRIBUTION_LIST_ALIAS_REQUEST)
-        soap_request.add_attributes({ id: @parent.id, alias: email })
-        @parent.sac.invoke(soap_request)
+        @parent.sac.invoke(build_add(email))
 
         @all.push(email)
         true
       end
 
+      def build_add(email)
+        soap_request = SoapElement.admin(SoapAdminConstants::ADD_DISTRIBUTION_LIST_ALIAS_REQUEST)
+        soap_request.add_attributes({ id: @parent.id, alias: email })
+        soap_request
+      end
+
       def remove!(email)
         return false unless @all.include?(Utils.format_email(email))
 
-        soap_request = SoapElement.admin(SoapAdminConstants::REMOVE_DISTRIBUTION_LIST_ALIAS_REQUEST)
-        soap_request.add_attributes({ id: @parent.id, alias: email })
-        @parent.sac.invoke(soap_request)
+        @parent.sac.invoke(build_remove(email))
 
         @all.delete(email)
         true
       end
 
+      def build_remove(email)
+        soap_request = SoapElement.admin(SoapAdminConstants::REMOVE_DISTRIBUTION_LIST_ALIAS_REQUEST)
+        soap_request.add_attributes({ id: @parent.id, alias: email })
+        soap_request
+      end
+
       private
 
       def build_aliases

data/lib/zm/client/distributionlist/distributionlist_jsns_builder.rb

@@ -9,13 +9,14 @@ module Zm
       end
 
       def to_create
-        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_DISTRIBUTION_LIST_REQUEST).add_attribute(
-          SoapConstants::NAME, @item.name
-        )
+        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_DISTRIBUTION_LIST_REQUEST)
+                                  .add_attribute(SoapConstants::NAME, @item.name)
 
         attrs_only_set_h.each do |key, values|
           values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
+            node_attr = SoapElement.create(SoapConstants::A)
+                                   .add_attribute(SoapConstants::N, key)
+                                   .add_content(value)
             soap_request.add_node(node_attr)
           end
         end
@@ -24,13 +25,14 @@ module Zm
       end
 
       def to_update
-        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_DISTRIBUTION_LIST_REQUEST).add_attribute(
-          SoapConstants::ID, @item.id
-        )
+        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_DISTRIBUTION_LIST_REQUEST)
+                                  .add_attribute(SoapConstants::ID, @item.id)
 
         attrs_only_set_h.each do |key, values|
           values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
+            node_attr = SoapElement.create(SoapConstants::A)
+                                   .add_attribute(SoapConstants::N, key)
+                                   .add_content(value)
             soap_request.add_node(node_attr)
           end
         end
@@ -39,14 +41,15 @@ module Zm
       end
 
       def to_patch(hash)
-        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_DISTRIBUTION_LIST_REQUEST).add_attribute(
-          SoapConstants::ID, @item.id
-        )
+        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_DISTRIBUTION_LIST_REQUEST)
+                                  .add_attribute(SoapConstants::ID, @item.id)
 
         hash.each do |key, values|
           values = [values] unless values.is_a?(Array)
           values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
+            node_attr = SoapElement.create(SoapConstants::A)
+                                   .add_attribute(SoapConstants::N, key)
+                                   .add_content(value)
             soap_request.add_node(node_attr)
           end
         end
@@ -55,12 +58,13 @@ module Zm
       end
 
       def to_delete
-        SoapElement.admin(SoapAdminConstants::DELETE_DISTRIBUTION_LIST_REQUEST).add_attribute(SoapConstants::ID,
-                                                                                              @item.id)
+        SoapElement.admin(SoapAdminConstants::DELETE_DISTRIBUTION_LIST_REQUEST)
+                   .add_attribute(SoapConstants::ID, @item.id)
       end
 
       def to_rename(new_name)
-        SoapElement.admin(SoapAdminConstants::RENAME_DISTRIBUTION_LIST_REQUEST).add_attributes({ id: @item.id, newName: new_name })
+        SoapElement.admin(SoapAdminConstants::RENAME_DISTRIBUTION_LIST_REQUEST)
+                   .add_attributes({ id: @item.id, newName: new_name })
       end
 
       def attrs_only_set_h
@@ -74,7 +78,7 @@ module Zm
           [n, values]
         end
 
-        Hash[arr]
+        arr.to_h
       end
     end
   end

data/lib/zm/client/distributionlist/distributionlist_jsns_initializer.rb

@@ -5,19 +5,10 @@ module Zm
     # class for initialize distribution list
     class DistributionListJsnsInitializer < Base::BaseJsnsInitializer
       class << self
-        def create(parent, json)
-          item = DistributionList.new(parent)
-
-          update(item, json)
-        end
+        def klass = DistributionList
 
         def update(item, json)
-          item.id = json[:id]
-          item.name = json[:name]
-
-          formatted_json(json).each do |k, v|
-            valorise(item, k, v)
-          end
+          super
 
           unless item.zimbraMailForwardingAddress.is_a?(Array)
             item.zimbraMailForwardingAddress = [item.zimbraMailForwardingAddress]

data/lib/zm/client/distributionlist/distributionlist_members_collection.rb

@@ -16,32 +16,40 @@ module Zm
         emails.delete_if { |email| @all.include?(email) }
         return false if emails.empty?
 
-        soap_request = SoapElement.admin(SoapAdminConstants::ADD_DISTRIBUTION_LIST_MEMBER_REQUEST)
-        soap_request.add_attribute('id', @parent.id)
-        node_dlm = SoapElement.create('dlm')
-        node_dlm.add_content(emails)
-        soap_request.add_node(node_dlm)
-        @parent.sac.invoke(soap_request)
+        @parent.sac.invoke(build_add(emails))
 
         @all += emails
         true
       end
 
+      def build_add(emails)
+        soap_request = SoapElement.admin(SoapAdminConstants::ADD_DISTRIBUTION_LIST_MEMBER_REQUEST)
+        soap_request.add_attribute(SoapConstants::ID, @parent.id)
+        node_dlm = SoapElement.create(SoapConstants::DLM)
+        node_dlm.add_content(emails)
+        soap_request.add_node(node_dlm)
+        soap_request
+      end
+
       def remove!(emails)
         emails.each { |email| Utils.format_email(email) }
         emails.delete_if { |email| !@all.include?(email) }
         return false if emails.empty?
 
-        soap_request = SoapElement.admin(SoapAdminConstants::REMOVE_DISTRIBUTION_LIST_MEMBER_REQUEST)
-        soap_request.add_attribute('id', @parent.id)
-        node_dlm = SoapElement.create('dlm')
-        node_dlm.add_content(emails)
-        soap_request.add_node(node_dlm)
-        @parent.sac.invoke(soap_request)
+        @parent.sac.invoke(build_remove(emails))
 
         @all -= emails
         true
       end
+
+      def build_remove(emails)
+        soap_request = SoapElement.admin(SoapAdminConstants::REMOVE_DISTRIBUTION_LIST_MEMBER_REQUEST)
+        soap_request.add_attribute(SoapConstants::ID, @parent.id)
+        node_dlm = SoapElement.create(SoapConstants::DLM)
+        node_dlm.add_content(emails)
+        soap_request.add_node(node_dlm)
+        soap_request
+      end
     end
   end
 end