zm-ruby-client 2.2.7 → 3.0.0

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

@@ -17,35 +17,46 @@ module Zm
         emails.delete_if { |email| @all.include?(email) }
         return false if emails.empty?
 
-        @parent.sac.invoke(jsns('addOwners', emails))
+        @parent.sac.invoke(build_add(emails))
 
         @all += emails
         true
       end
 
+      def build_add(emails)
+        jsns('addOwners', emails)
+      end
+
       def remove!(*emails)
         emails.flatten!
         emails.each { |email| Utils.format_email(email) }
         emails.delete_if { |email| !@all.include?(email) }
         return false if emails.empty?
 
-        @parent.sac.invoke(jsns('removeOwners', emails))
+        @parent.sac.invoke(build_remove(emails))
 
         @all -= emails
         true
       end
 
-      private
+      def build_remove(emails)
+        jsns('removeOwners', emails)
+      end
 
       def jsns(op, emails)
         soap_request = SoapElement.account(SoapAccountConstants::DISTRIBUTION_LIST_ACTION_REQUEST)
-        node_dl = SoapElement.create('dl').add_attribute(SoapConstants::BY, SoapConstants::ID).add_content(@parent.id)
+        node_dl = SoapElement.create(SoapConstants::DL)
+                             .add_attribute(SoapConstants::BY, SoapConstants::ID)
+                             .add_content(@parent.id)
         soap_request.add_node(node_dl)
-        node_action = SoapElement.create(SoapConstants::ACTION).add_attributes({ op: op, owner: jsns_owners(emails) })
+        node_action = SoapElement.create(SoapConstants::ACTION)
+                                 .add_attributes({ op: op, owner: jsns_owners(emails) })
         soap_request.add_node(node_action)
         soap_request
       end
 
+      private
+
       def jsns_owners(emails)
         emails.map { |email| { by: :name, type: :usr, _content: email } }
       end

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

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

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

@@ -8,20 +8,26 @@ module Zm
         @child_class = DistributionList
         @builder_class = DistributionListsBuilder
         @search_type = SearchType::DL
-        super(parent)
+        super
       end
 
       def find_by!(hash)
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_DISTRIBUTION_LIST_REQUEST)
-        node_dl = SoapElement.create(SoapConstants::DL).add_attribute(SoapConstants::BY, hash.keys.first).add_content(hash.values.first)
-        soap_request.add_node(node_dl)
-        soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma)
-        entry = sac.invoke(soap_request)[:GetDistributionListResponse][:dl].first
+        entry = sac.invoke(build_find_by(hash))[:GetDistributionListResponse][:dl].first
 
         reset_query_params
         DistributionListJsnsInitializer.create(@parent, entry)
       end
 
+      def build_find_by(hash)
+        soap_request = SoapElement.admin(SoapAdminConstants::GET_DISTRIBUTION_LIST_REQUEST)
+        node_dl = SoapElement.create(SoapConstants::DL)
+                             .add_attribute(SoapConstants::BY, hash.keys.first)
+                             .add_content(hash.values.first)
+        soap_request.add_node(node_dl)
+        soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma)
+        soap_request
+      end
+
       private
 
       def reset_query_params

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

@@ -9,18 +9,24 @@ module Zm
         @parent = parent
       end
 
-      private
-
       def make_query
+        sac.invoke(build_query)
+      end
+
+      def build_query
         soap_request = SoapElement.admin(SoapAdminConstants::GET_DISTRIBUTION_LIST_MEMBERSHIP_REQUEST)
-        node_account = SoapElement.create(SoapConstants::ACCOUNT).add_attribute(SoapConstants::BY, SoapConstants::ID).add_content(@parent.id)
+        node_account = SoapElement.create(SoapConstants::ACCOUNT)
+                                  .add_attribute(SoapConstants::BY, SoapConstants::ID)
+                                  .add_content(@parent.id)
         soap_request.add_node(node_account)
-        sac.invoke(soap_request)
+        soap_request
       end
 
+      private
+
       def build_response
-        @all = make_query.dig(:Body, :GetDistributionListMembershipResponse, :dl) || []
-        @all.map { |json| DlMembership.new(json[:name], json[:id], json[:via]) }
+        collection = make_query.dig(:Body, :GetDistributionListMembershipResponse, :dl) || []
+        collection.map { |json| DlMembership.new(json[:name], json[:id], json[:via]) }
       end
     end
   end

data/lib/zm/client/document/document.rb

@@ -6,6 +6,7 @@ module Zm
     class Document < Base::Object
       include BelongsToFolder
       include BelongsToTag
+      include RequestMethodsMailbox
 
       attr_accessor :id, :uuid, :name, :s, :d, :l, :luuid, :ms, :mdver, :md, :rev, :f, :t, :meta, :ct,
                     :descEnabled, :ver, :leb, :cr, :cd, :acl, :loid, :sf, :tn
@@ -14,10 +15,18 @@ module Zm
         raise NotImplementedError
       end
 
+      def build_create
+        raise NotImplementedError
+      end
+
       def modify!
         raise NotImplementedError
       end
 
+      def build_modify
+        raise NotImplementedError
+      end
+
       def update!(*args)
         raise NotImplementedError
       end
@@ -26,11 +35,8 @@ module Zm
         raise NotImplementedError
       end
 
-      def delete!
-        return false if @id.nil?
-
-        @parent.sacc.invoke(jsns_builder.to_delete)
-        @id = nil
+      def build_rename(*args)
+        raise NotImplementedError
       end
 
       def reload!
@@ -38,14 +44,16 @@ module Zm
       end
 
       def download(dest_file_path)
-        uploader = Upload.new(@parent, RestAccountConnector.new)
-        uploader.download_file( Zm::Client::FolderDefault::ROOT[:path], nil, [Zm::Client::FolderView::DOCUMENT], [@id], dest_file_path)
+        uploader = @parent.build_uploader
+        uploader.download_file(dest_file_path, id, nil)
       end
 
       private
 
       def jsns_builder
-        @jsns_builder ||= DocumentJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = DocumentJsnsBuilder.new(self)
       end
     end
   end

data/lib/zm/client/document/document_jsns_builder.rb

@@ -7,7 +7,7 @@ module Zm
       def to_delete
         attrs = {
           op: :delete,
-          comp: 0,
+          comp: SoapUtils::OFF,
           id: @item.id
         }
 

data/lib/zm/client/document/document_jsns_initializer.rb

@@ -6,35 +6,36 @@ module Zm
     class DocumentJsnsInitializer
       class << self
         def create(parent, json)
-          item = Document.new(parent)
-          update(item, json)
+          Document.new(parent).tap do |item|
+            update(item, json)
+          end
         end
 
         def update(item, json)
-          item.id = json[:id]
-          item.uuid = json[:uuid]
-          item.name = json[:name]
-          item.s = json[:s]
-          item.d = json[:d]
-          item.l = json[:l]
-          item.luuid = json[:luuid]
-          item.ms = json[:ms]
-          item.mdver = json[:mdver]
-          item.md = json[:md]
-          item.rev = json[:rev]
-          item.f = json[:f]
-          item.tn = json[:tn]
-          item.t = json[:t]
-          item.meta = json[:meta]
-          item.ct = json[:ct]
-          item.descEnabled = json[:descEnabled]
-          item.ver = json[:ver]
-          item.leb = json[:leb]
-          item.cr = json[:cr]
-          item.cd = json[:cd]
-          item.acl = json[:acl]
-          item.loid = json[:loid]
-          item.sf = json[:sf]
+          item.id = json.delete(:id)
+          item.uuid = json.delete(:uuid)
+          item.name = json.delete(:name)
+          item.s = json.delete(:s)
+          item.d = json.delete(:d)
+          item.l = json.delete(:l)
+          item.luuid = json.delete(:luuid)
+          item.ms = json.delete(:ms)
+          item.mdver = json.delete(:mdver)
+          item.md = json.delete(:md)
+          item.rev = json.delete(:rev)
+          item.f = json.delete(:f)
+          item.tn = json.delete(:tn)
+          item.t = json.delete(:t)
+          item.meta = json.delete(:meta)
+          item.ct = json.delete(:ct)
+          item.descEnabled = json.delete(:descEnabled)
+          item.ver = json.delete(:ver)
+          item.leb = json.delete(:leb)
+          item.cr = json.delete(:cr)
+          item.cd = json.delete(:cd)
+          item.acl = json.delete(:acl)
+          item.loid = json.delete(:loid)
+          item.sf = json.delete(:sf)
 
           item
         end

data/lib/zm/client/document/documents_builder.rb

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

data/lib/zm/client/document/documents_collection.rb

@@ -7,7 +7,7 @@ module Zm
       DEFAULT_QUERY = 'in:briefcase'
 
       def initialize(parent)
-        super(parent)
+        super
         @child_class = Document
         @builder_class = DocumentsBuilder
         @type = SoapConstants::DOCUMENT

data/lib/zm/client/domain/domain.rb

@@ -5,53 +5,38 @@ module Zm
     # objectClass: zimbraDomain
     class Domain < Base::Object
       include HasSoapAdminConnector
+      include RequestMethodsAdmin
 
       def create!
-        resp = sac.invoke(jsns_builder.to_create)
+        resp = sac.invoke(build_create)
         @id = resp[:CreateDomainResponse][:domain].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 delete!
-        soap_request = SoapElement.admin(SoapAdminConstants::DELETE_DOMAIN_REQUEST).add_attribute(SoapConstants::ID,
-                                                                                                  @id)
-        sac.invoke(soap_request)
-        @id = nil
-      end
-
       def accounts
-        @accounts ||= DomainAccountsCollection.new(self)
+        return @accounts if defined? @accounts
+
+        @accounts = DomainAccountsCollection.new(self)
       end
 
       def distributionlists
-        @distributionlists ||= DomainDistributionListsCollection.new(self)
+        return @distributionlists if defined? @distributionlists
+
+        @distributionlists = DomainDistributionListsCollection.new(self)
       end
       alias distribution_lists distributionlists
 
       def resources
-        @resources ||= DomainResourcesCollection.new(self)
+        return @resources if defined? @resources
+
+        @resources = DomainResourcesCollection.new(self)
       end
 
       def cos
-        return nil if self.zimbraDomainDefaultCOSId.nil?
+        return nil if zimbraDomainDefaultCOSId.nil?
+
+        return @cos if defined? @cos
 
-        @cos ||= @parent.coses.find_by id: self.zimbraDomainDefaultCOSId
+        @cos = @parent.coses.find_by(id: zimbraDomainDefaultCOSId)
       end
 
       def attrs_write
@@ -74,14 +59,10 @@ module Zm
         @DKIMPublicTxt = matches.first.first.strip
       end
 
-      private
-
-      def do_update!(hash)
-        sac.invoke(jsns_builder.to_patch(hash))
-      end
-
       def jsns_builder
-        @jsns_builder ||= DomainJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = DomainJsnsBuilder.new(self)
       end
     end
   end

data/lib/zm/client/domain/domain_accounts_collection.rb

@@ -5,7 +5,7 @@ module Zm
     # Collection Accounts from domain
     class DomainAccountsCollection < AccountsCollection
       def initialize(parent)
-        super(parent)
+        super
         @domain_name = parent.name
       end
     end

data/lib/zm/client/domain/domain_distributionlists_collection.rb

@@ -5,7 +5,7 @@ module Zm
     # Collection Resources
     class DomainDistributionListsCollection < DistributionListsCollection
       def initialize(parent)
-        super(parent)
+        super
         @domain_name = parent.name
       end
     end

data/lib/zm/client/domain/domain_jsns_builder.rb

@@ -9,12 +9,14 @@ module Zm
       end
 
       def to_create
-        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_DOMAIN_REQUEST).add_attribute(SoapConstants::NAME,
-                                                                                                  @item.name)
+        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_DOMAIN_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
@@ -23,8 +25,8 @@ module Zm
       end
 
       def to_update
-        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_DOMAIN_REQUEST).add_attribute(SoapConstants::ID,
-                                                                                                  @item.id)
+        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_DOMAIN_REQUEST)
+                                  .add_attribute(SoapConstants::ID, @item.id)
 
         attrs_only_set_h.each do |key, values|
           values.each do |value|
@@ -37,13 +39,15 @@ module Zm
       end
 
       def to_patch(hash)
-        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_DOMAIN_REQUEST).add_attribute(SoapConstants::ID,
-                                                                                                  @item.id)
+        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_DOMAIN_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
@@ -51,6 +55,11 @@ module Zm
         soap_request
       end
 
+      def to_delete
+        SoapElement.admin(SoapAdminConstants::DELETE_DOMAIN_REQUEST)
+                   .add_attribute(SoapConstants::ID, @item.id)
+      end
+
       def attrs_only_set_h
         selected_attrs = @item.attrs_write.map { |a| Utils.arrow_name_sym(a) }
         attrs_only_set = @item.instance_variables & selected_attrs
@@ -62,7 +71,7 @@ module Zm
           [n, values]
         end
 
-        Hash[arr]
+        arr.to_h
       end
     end
   end

data/lib/zm/client/domain/domain_jsns_initializer.rb

@@ -5,14 +5,10 @@ module Zm
     # class for initialize domain
     class DomainJsnsInitializer < Base::BaseJsnsInitializer
       class << self
-        def create(parent, json)
-          item = Domain.new(parent)
-
-          update(item, json)
-        end
+        def klass = Domain
 
         def update(item, json)
-          item = super(item, json)
+          item = super
 
           item.zimbraGalAccountId = [item.zimbraGalAccountId] if item.zimbraGalAccountId.is_a?(String)
           item.zimbraGalLdapAttrMap = [item.zimbraGalLdapAttrMap] if item.zimbraGalLdapAttrMap.is_a?(String)

data/lib/zm/client/domain/domain_resources_collection.rb

@@ -5,7 +5,7 @@ module Zm
     # Collection Resources from domain
     class DomainResourcesCollection < ResourcesCollection
       def initialize(parent)
-        super(parent)
+        super
         @domain_name = parent.name
       end
     end

data/lib/zm/client/domain/domains_builder.rb

@@ -5,7 +5,7 @@ module Zm
     # Class Builder [Domain]
     class DomainsBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :domain
       end
 

data/lib/zm/client/domain/domains_collection.rb

@@ -8,20 +8,26 @@ module Zm
         @child_class = Domain
         @builder_class = DomainsBuilder
         @search_type = SearchType::DOMAIN
-        super(parent)
+        super
       end
 
       def find_by!(hash)
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_DOMAIN_REQUEST)
-        node_domain = SoapElement.create(SoapConstants::DOMAIN).add_attribute(SoapConstants::BY, hash.keys.first).add_content(hash.values.first)
-        soap_request.add_node(node_domain)
-        soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma)
-        entry = sac.invoke(soap_request)[:GetDomainResponse][:domain].first
+        entry = sac.invoke(build_find_by(hash))[:GetDomainResponse][:domain].first
 
         reset_query_params
         DomainJsnsInitializer.create(@parent, entry)
       end
 
+      def build_find_by(hash)
+        soap_request = SoapElement.admin(SoapAdminConstants::GET_DOMAIN_REQUEST)
+        node_domain = SoapElement.create(SoapConstants::DOMAIN)
+                                 .add_attribute(SoapConstants::BY, hash.keys.first)
+                                 .add_content(hash.values.first)
+        soap_request.add_node(node_domain)
+        soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma)
+        soap_request
+      end
+
       private
 
       def reset_query_params

data/lib/zm/client/filter_rules/filter_rule.rb

@@ -5,15 +5,6 @@ module Zm
     # class account filter rule
     class FilterRule < Base::Object
       attr_accessor :name, :active, :filterTests, :filterActions
-
-      def to_h
-        {
-          name: name,
-          active: active,
-          filterTests: filterTests,
-          filterActions: filterActions
-        }
-      end
     end
   end
 end

data/lib/zm/client/filter_rules/filter_rule_jsns_initializer.rb

@@ -6,15 +6,16 @@ module Zm
     class FilterRuleJsnsInitializer
       class << self
         def create(parent, json)
-          item = FilterRule.new(parent)
-          update(item, json)
+          FilterRule.new(parent).tap do |item|
+            update(item, json)
+          end
         end
 
         def update(item, json)
-          item.name = json[:name]
-          item.active = json[:active]
-          item.filterTests = json[:filterTests]
-          item.filterActions = json[:filterActions]
+          item.name = json.delete(:name)
+          item.active = json.delete(:active)
+          item.filterTests = json.delete(:filterTests)
+          item.filterActions = json.delete(:filterActions)
 
           item
         end

data/lib/zm/client/filter_rules/filter_rules_builder.rb

@@ -5,7 +5,7 @@ module Zm
     # class factory [filter rules]
     class FilterRulesBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :filterRules
       end
 

data/lib/zm/client/filter_rules/filter_rules_collection.rb

@@ -7,25 +7,15 @@ module Zm
       def initialize(parent)
         @child_class = FilterRule
         @builder_class = FilterRulesBuilder
-        super(parent)
+        super
       end
 
-      def save!
-        return false unless defined? @all
-
-        soap_request = SoapElement.mail(SoapMailConstants::MODIFY_FILTER_RULES_REQUEST)
-        node_rules = SoapElement.create(:filterRules).add_attribute(:filterRule, @all.map(&:to_h))
-        soap_request.add_node(node_rules)
-        @parent.sacc.invoke(soap_request)
-
-        true
+      def make_query
+        @parent.soap_connector.invoke(build_query)
       end
 
-      private
-
-      def make_query
-        soap_request = SoapElement.mail(SoapMailConstants::GET_FILTER_RULES_REQUEST)
-        @parent.sacc.invoke(soap_request)
+      def build_query
+        SoapElement.mail(SoapMailConstants::GET_FILTER_RULES_REQUEST)
       end
     end
   end

data/lib/zm/client/filter_rules/outgoing_filter_rules_collection.rb

@@ -7,8 +7,11 @@ module Zm
       private
 
       def make_query
-        soap_request = SoapElement.mail(SoapMailConstants::GET_OUTGOING_FILTER_RULES_REQUEST)
-        @parent.sacc.invoke(soap_request)
+        @parent.soap_connector.invoke(build_query)
+      end
+
+      def build_query
+        SoapElement.mail(SoapMailConstants::GET_OUTGOING_FILTER_RULES_REQUEST)
       end
     end
   end