zm-ruby-client 3.0.1 → 3.1.0

data/lib/zm/client/base/mailbox_prefs_collection.rb

@@ -2,70 +2,72 @@
 
 module Zm
   module Client
-    class MailboxPrefsCollection
-      def initialize(parent)
-        @parent = parent
-        @preferences = []
-      end
+    module Base
+      class MailboxPrefsCollection
+        def initialize(parent)
+          @parent = parent
+          @preferences = []
+        end
 
-      def all
-        build_response
-      end
-      alias all! all
+        def all
+          build_response
+        end
+        alias all! all
 
-      def clear
-        reset_query_params
-      end
+        def clear
+          reset_query_params
+        end
 
-      def preferences(*entries)
-        entries.flatten!
-        @preferences += entries
-        self
-      end
+        def preferences(*entries)
+          entries.flatten!
+          @preferences += entries
+          self
+        end
 
-      def update!(hash)
-        # The JSON version is different:
-        # {
-        #   ModifyPrefsRequest: {
-        #     "_attrs": {
-        #       "prefName1": "prefValue1",
-        #       "prefName2": "prefValue2"
-        #       "+nameOfMulitValuedPref3": "addedPrefValue3",
-        #       "-nameOfMulitValuedPref4": "removedPrefValue4",
-        #       "nameOfMulitValuedPref5": ["prefValue5one","prefValue5two"],
-        #       ...
-        #     },
-        #     _jsns: "urn:zimbraAccount"
-        #   }
-        # }
+        def update!(hash)
+          # The JSON version is different:
+          # {
+          #   ModifyPrefsRequest: {
+          #     "_attrs": {
+          #       "prefName1": "prefValue1",
+          #       "prefName2": "prefValue2"
+          #       "+nameOfMulitValuedPref3": "addedPrefValue3",
+          #       "-nameOfMulitValuedPref4": "removedPrefValue4",
+          #       "nameOfMulitValuedPref5": ["prefValue5one","prefValue5two"],
+          #       ...
+          #     },
+          #     _jsns: "urn:zimbraAccount"
+          #   }
+          # }
 
-        req = {
-          _attrs: hash
-        }
+          req = {
+            _attrs: hash
+          }
 
-        soap_request = SoapElement.account(SoapAccountConstants::MODIFY_PREFS_REQUEST).add_attributes(req)
-        @parent.soap_connector.invoke(soap_request)
-      end
+          soap_request = SoapRequest::SoapElement.account(Zm::SoapRequest::SoapAccountConstants::MODIFY_PREFS_REQUEST).add_attributes(req)
+          @parent.soap_connector.invoke(soap_request)
+        end
 
-      private
+        private
 
-      def build_response
-        make_query.dig(:GetPrefsResponse, :_attrs)
-      end
+        def build_response
+          make_query.dig(:GetPrefsResponse, :_attrs)
+        end
 
-      def make_query
-        soap_request = SoapElement.account(SoapAccountConstants::GET_PREFS_REQUEST).add_attributes(jsns)
-        @parent.soap_connector.invoke(soap_request)
-      end
+        def make_query
+          soap_request = SoapRequest::SoapElement.account(Zm::SoapRequest::SoapAccountConstants::GET_PREFS_REQUEST).add_attributes(jsns)
+          @parent.soap_connector.invoke(soap_request)
+        end
 
-      def jsns
-        return nil if @preferences.empty?
+        def jsns
+          return nil if @preferences.empty?
 
-        { prefs: @preferences.map { |name| { name: name } } }
-      end
+          { prefs: @preferences.map { |name| { name: } } }
+        end
 
-      def reset_query_params
-        @preferences.clear
+        def reset_query_params
+          @preferences.clear
+        end
       end
     end
   end

data/lib/zm/client/base/object.rb

@@ -5,10 +5,11 @@ module Zm
     module Base
       # Abstract Class Provisionning Object
       class Object
-        attr_accessor :parent, :token, :name, :id
+        attr_accessor :parent, :token, :name, :id, :updated
 
         def initialize(parent)
           @parent = parent
+          @updated = false
           yield(self) if block_given?
         end
 
@@ -16,13 +17,19 @@ module Zm
           !@id.nil?
         end
 
+        def updated?
+          @updated
+        end
+
         def save!
           recorded? ? modify! : create!
         end
 
         def clone
           obj = super
-          obj.remove_instance_variable(:@id)
+          obj.remove_instance_variable(:@id) if obj.instance_variable_defined?(:@id)
+          obj.remove_instance_variable(:@jsns_builder) if obj.instance_variable_defined?(:@jsns_builder)
+          obj.remove_dependents_of(self)
           yield(obj) if block_given?
           obj
         end
@@ -59,6 +66,16 @@ module Zm
           keys.delete(:@parent)
           keys.map { |key| [key, instance_variable_get(key)] }
         end
+
+        protected
+
+        def remove_dependents_of(item)
+          instance_variables.each do |key|
+            next if key == :@parent
+
+            remove_instance_variable(key) if instance_variable_get(key).instance_variable_get(:@parent).equal?(item)
+          end
+        end
       end
     end
   end

data/lib/zm/client/base/objects_collection.rb

@@ -5,7 +5,7 @@ module Zm
     module Base
       # Abstract Class Collection
       class ObjectsCollection
-        include Zm::Inspector
+        include Zm::Utils::Inspector
 
         METHODS_MISSING_LIST = %i[select each map length].to_set.freeze
         attr_reader :parent
@@ -17,7 +17,7 @@ module Zm
         end
 
         def find(id)
-          find_by(id: id)
+          find_by(id:)
         end
 
         def first
@@ -46,7 +46,7 @@ module Zm
         end
         alias offset page
 
-        def order(sort_by, sort_ascending = SoapUtils::ON)
+        def order(sort_by, sort_ascending = Zm::Utils::SearchUtils::ON)
           return self if @sort_by == sort_by && @sort_ascending == sort_ascending
 
           @sort_by = sort_by
@@ -88,19 +88,19 @@ module Zm
           # @attrs.compact!
           return nil if @attrs.empty?
 
-          @attrs.join(COMMA)
+          @attrs.join(',')
         end
 
         def reset_query_params
-          @max_result = SoapUtils::MAX_RESULT
+          @max_result = Zm::Utils::SearchUtils::MAX_RESULT
           @limit = nil
           @offset = nil
           @sort_by = nil
-          @sort_ascending = SoapUtils::ON
-          @count_only = SoapUtils::OFF
-          @all_servers = SoapUtils::OFF
-          @refresh = SoapUtils::OFF
-          @apply_cos = SoapUtils::ON
+          @sort_ascending = Zm::Utils::SearchUtils::ON
+          @count_only = Zm::Utils::SearchUtils::OFF
+          @all_servers = Zm::Utils::SearchUtils::OFF
+          @refresh = Zm::Utils::SearchUtils::OFF
+          @apply_cos = Zm::Utils::SearchUtils::ON
         end
       end
     end

data/lib/zm/client/base/zimbra_attribute.rb

@@ -4,119 +4,105 @@ module Zm
   module Client
     module Base
       class ZimbraAttribute
-        attr_reader :name, :optionalIn, :flags, :requiredIn, :cardinality, :callback, :immutable, :type, :value, :max,
-                    :min, :since
+        attr_reader :name, :type, :objects_scope
 
-        def initialize(name: nil, optionalIn: nil, flags: nil, requiredIn: nil, cardinality: nil, callback: nil,
-                       immutable: nil, type: nil, value: nil, max: nil, min: nil, since: nil)
+        def initialize(name: nil, optionalIn: nil, requiredIn: nil, immutable: nil, type: nil, **)
           @name = name
-          @optionalIn = optionalIn.to_s.split(',')
-          @flags = flags
-          @requiredIn = requiredIn.to_s.split(',')
-          @cardinality = cardinality
-          @callback = callback
-          @immutable = immutable
-          @type = type
-          @value = value
-          @max = max
-          @min = min
-          @since = since
+          @type = type && -type
+          @immutable = immutable == '1'
+          @objects_scope = (optionalIn.to_s.split(',') + requiredIn.to_s.split(',')).map!(&:-@).freeze
         end
 
         def immutable?
-          immutable == '1'
-        end
-
-        def objects_scope
-          @objects_scope ||= (optionalIn + requiredIn).freeze
+          @immutable
         end
 
         def is_account_scoped?
-          @is_account_scoped ||= objects_scope.include?('account')
+          objects_scope.include?('account')
         end
 
         def is_aclTarget_scoped?
-          @is_aclTarget_scoped ||= objects_scope.include?('aclTarget')
+          objects_scope.include?('aclTarget')
         end
 
         def is_alias_scoped?
-          @is_alias_scoped ||= objects_scope.include?('alias')
+          objects_scope.include?('alias')
         end
 
         def is_alwaysOnCluster_scoped?
-          @is_alwaysOnCluster_scoped ||= objects_scope.include?('alwaysOnCluster')
+          objects_scope.include?('alwaysOnCluster')
         end
 
         def is_calendarResource_scoped?
-          @is_calendarResource_scoped ||= objects_scope.include?('calendarResource') || objects_scope.include?('account')
+          objects_scope.include?('calendarResource') || objects_scope.include?('account')
         end
 
         def is_cos_scoped?
-          @is_cos_scoped ||= objects_scope.include?('cos')
+          objects_scope.include?('cos')
         end
 
         def is_dataSource_scoped?
-          @is_dataSource_scoped ||= objects_scope.include?('dataSource')
+          objects_scope.include?('dataSource')
         end
 
         def is_distributionList_scoped?
-          @is_distributionList_scoped ||= objects_scope.include?('distributionList')
+          objects_scope.include?('distributionList')
         end
 
         def is_domain_scoped?
-          @is_domain_scoped ||= objects_scope.include?('domain')
+          objects_scope.include?('domain')
         end
 
         def is_globalConfig_scoped?
-          @is_globalConfig_scoped ||= objects_scope.include?('globalConfig')
+          objects_scope.include?('globalConfig')
         end
 
         def is_group_scoped?
-          @is_group_scoped ||= objects_scope.include?('group')
+          objects_scope.include?('group')
         end
 
         def is_groupDynamicUnit_scoped?
-          @is_groupDynamicUnit_scoped ||= objects_scope.include?('groupDynamicUnit')
+          objects_scope.include?('groupDynamicUnit')
         end
 
         def is_groupStaticUnit_scoped?
-          @is_groupStaticUnit_scoped ||= objects_scope.include?('groupStaticUnit')
+          objects_scope.include?('groupStaticUnit')
         end
 
         def is_identity_scoped?
-          @is_identity_scoped ||= objects_scope.include?('identity')
+          objects_scope.include?('identity')
         end
 
         def is_mailRecipient_scoped?
-          @is_mailRecipient_scoped ||= objects_scope.include?('mailRecipient')
+          objects_scope.include?('mailRecipient')
         end
 
         def is_mimeEntry_scoped?
-          @is_mimeEntry_scoped ||= objects_scope.include?('mimeEntry')
+          objects_scope.include?('mimeEntry')
         end
 
         def is_objectEntry_scoped?
-          @is_objectEntry_scoped ||= objects_scope.include?('objectEntry')
+          objects_scope.include?('objectEntry')
         end
 
         def is_server_scoped?
-          @is_server_scoped ||= objects_scope.include?('server')
+          objects_scope.include?('server')
         end
 
         def is_signature_scoped?
-          @is_signature_scoped ||= objects_scope.include?('signature')
+          objects_scope.include?('signature')
         end
 
         def is_ucService_scoped?
-          @is_ucService_scoped ||= objects_scope.include?('ucService')
+          objects_scope.include?('ucService')
         end
 
         def is_xmppComponent_scoped?
-          @is_xmppComponent_scoped ||= objects_scope.include?('xmppComponent')
+          objects_scope.include?('xmppComponent')
         end
 
         def is_zimletEntry_scoped?
-          @is_zimletEntry_scoped ||= objects_scope.include?('zimletEntry')
+          objects_scope.include?('zimletEntry')
         end
       end
     end

data/lib/zm/client/base/zimbra_attributes_collection.rb

@@ -1,30 +1,44 @@
 # frozen_string_literal: true
 
-require 'zm/client/base/zimbra_attribute'
 require 'csv'
 
 module Zm
   module Client
     module Base
       class ZimbraAttributesCollection
-        include MissingMethodStaticCollection
+        include Zm::Utils::MissingMethodStaticCollection
 
-        attr_reader :all_versioned
+        MUTEX = Mutex.new
+        CSV_OPTIONS = {
+          headers: true, skip_blanks: true, strip: true, header_converters: ->(header) { header.to_sym }
+        }.freeze
+
+        class << self
+          def shared(parent)
+            path = File.expand_path(parent.config.zimbra_attributes_path)
+            MUTEX.synchronize { shared_instances[path] ||= new(parent).tap(&:set_methods) }
+          end
+
+          def load_attributes(path)
+            CSV.open(path, **CSV_OPTIONS).map do |attr|
+              attr_h = attr.to_h
+              attr_h.compact!
+              ZimbraAttribute.new(**attr_h)
+            end.freeze
+          end
+
+          private
+
+          def shared_instances
+            @shared_instances ||= {}
+          end
+        end
+
+        attr_reader :path
 
         def initialize(parent)
-          @parent = parent
-
-          @all = CSV.open(
-            File.expand_path(@parent.config.zimbra_attributes_path),
-            headers: true,
-            skip_blanks: true,
-            strip: true,
-            header_converters: lambda { |header| header.to_sym }
-          ).map do |attr|
-            attr_h = attr.to_h
-            attr_h.compact!
-            ZimbraAttribute.new(**attr_h)
-          end.freeze
+          @path = File.expand_path(parent.config.zimbra_attributes_path)
+          @all = self.class.load_attributes(@path)
         end
 
         def set_methods
@@ -53,7 +67,7 @@ module Zm
         end
 
         def all_cos_attr_types_h
-          @all_cos_attr_types_h ||= all_cos_attrs.map { |attr| [attr.name, attr.type] }.to_h.freeze
+          @all_cos_attr_types_h ||= all_cos_attrs.to_h { |attr| [attr.name, attr.type] }.freeze
         end
 
         def set_cos_methods
@@ -77,7 +91,7 @@ module Zm
         end
 
         def all_server_attr_types_h
-          @all_server_attr_types_h ||= all_server_attrs.map { |attr| [attr.name, attr.type] }.to_h.freeze
+          @all_server_attr_types_h ||= all_server_attrs.to_h { |attr| [attr.name, attr.type] }.freeze
         end
 
         def set_server_methods
@@ -101,7 +115,7 @@ module Zm
         end
 
         def all_domain_attr_types_h
-          @all_domain_attr_types_h ||= all_domain_attrs.map { |attr| [attr.name, attr.type] }.to_h.freeze
+          @all_domain_attr_types_h ||= all_domain_attrs.to_h { |attr| [attr.name, attr.type] }.freeze
         end
 
         def set_domain_methods
@@ -125,7 +139,7 @@ module Zm
         end
 
         def all_account_attr_types_h
-          @all_account_attr_types_h ||= all_account_attrs.map { |attr| [attr.name, attr.type] }.to_h.freeze
+          @all_account_attr_types_h ||= all_account_attrs.to_h { |attr| [attr.name, attr.type] }.freeze
         end
 
         def set_account_methods
@@ -151,9 +165,9 @@ module Zm
         end
 
         def all_distributionlist_attrs_types_h
-          @all_distributionlist_attrs_types_h ||= all_distributionlist_attrs.map do |attr|
-                                                         [attr.name, attr.type]
-                                                       end.to_h.freeze
+          @all_distributionlist_attrs_types_h ||= all_distributionlist_attrs.to_h do |attr|
+            [attr.name, attr.type]
+          end.freeze
         end
 
         def set_distributionlist_methods
@@ -177,7 +191,7 @@ module Zm
         end
 
         def all_resource_attrs_types_h
-          @all_resource_attrs_types_h ||= all_resource_attrs.map { |attr| [attr.name, attr.type] }.to_h.freeze
+          @all_resource_attrs_types_h ||= all_resource_attrs.to_h { |attr| [attr.name, attr.type] }.freeze
         end
 
         def set_resource_methods

data/lib/zm/client/{cluster/batch_request.rb → batch_request.rb}

@@ -25,7 +25,7 @@ module Zm
       private
 
       def build(onerror)
-        soap_request = SoapElement.new(SoapConstants::BATCH_REQUEST, SoapConstants::NAMESPACE_STR)
+        soap_request = SoapRequest::SoapElement.new(SoapRequest::SoapConstants::BATCH_REQUEST, SoapRequest::SoapConstants::NAMESPACE_STR)
         soap_request.add_attribute(:onerror, onerror)
 
         @requests.each_with_index do |request, index|

data/lib/zm/client/cluster/cluster.rb

@@ -1,21 +1,13 @@
 # frozen_string_literal: true
 
-require 'zm/client/connector/soap_admin'
-require 'zm/client/connector/soap_account'
-require 'zm/client/common'
-require 'zm/client/account'
-require 'zm/client/resource'
-require 'zm/client/distributionlist'
-require 'zm/client/domain'
-require 'zm/client/server'
-require 'zm/client/cos'
-require 'zm/client/license'
-require 'zm/client/cluster/batch_request'
-
 module Zm
   module Client
     # class admin connection
     class Cluster
+      extend Zm::Relationship
+
+      COUNT_OBJECT_TYPES = %i[userAccount account alias dl domain cos server calresource internalUserAccount].freeze
+
       attr_reader :soap_admin_connector, :config, :zimbra_attributes, :type, :version, :release, :buildDate, :host,
                   :majorversion, :minorversion, :microversion
 
@@ -23,10 +15,9 @@ module Zm
         @config = config
         @version = config.zimbra_version
 
-        @zimbra_attributes = Base::ZimbraAttributesCollection.new(self)
-        @zimbra_attributes.set_methods
+        @zimbra_attributes = Base::ZimbraAttributesCollection.shared(self)
 
-        @soap_admin_connector = SoapAdminConnector.create(@config)
+        @soap_admin_connector = Zm::Connector::SoapAdminConnector.create(@config)
       end
 
       def has_admin_credentials?
@@ -50,9 +41,9 @@ module Zm
 
         @soap_admin_connector.token = nil if logged?
 
-        soap_request = SoapElement.admin(SoapAdminConstants::AUTH_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::AUTH_REQUEST)
         soap_request.add_attributes(name: @config.zimbra_admin_login, password: @config.zimbra_admin_password)
-        soap_resp = @soap_admin_connector.invoke(soap_request, Zm::Client::AuthError)
+        soap_resp = @soap_admin_connector.invoke(soap_request, Zm::Error::AuthError)
         soap_resp_token = soap_resp[:AuthResponse][:authToken].first[:_content]
         self.token = soap_resp_token
       end
@@ -62,10 +53,10 @@ module Zm
       end
 
       def alive?
-        soap_request = SoapElement.admin(SoapAdminConstants::NO_OP_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::NO_OP_REQUEST)
         @soap_admin_connector.invoke(soap_request)
         true
-      rescue Zm::Client::SoapError => e
+      rescue Zm::Error::SoapError => e
         logger.error "Admin session token alive ? #{e.message}"
         false
       end
@@ -78,48 +69,19 @@ module Zm
         return @license if defined? @license
 
         @license = LicensesCollection.new(self).find
-      rescue Zm::Client::SoapError => e
+      rescue Zm::Error::SoapError => e
         logger.error "Get License info #{e.message}"
         nil
       end
 
-      def domains
-        return @domains if defined? @domains
-
-        @domains = DomainsCollection.new self
-      end
-
-      def accounts
-        return @accounts if defined? @accounts
-
-        @accounts = AccountsCollection.new self
-      end
-
-      def resources
-        return @resources if defined? @resources
-
-        @resources = ResourcesCollection.new self
-      end
-
-      def servers
-        return @servers if defined? @servers
-
-        @servers = ServersCollection.new self
-      end
-
-      def coses
-        return @coses if defined? @coses
-
-        @coses = CosesCollection.new self
-      end
-
-      def distributionlists
-        return @distributionlists if defined? @distributionlists
-
-        @distributionlists = DistributionListsCollection.new self
-      end
+      has_many :domains
+      has_many :accounts
+      has_many :resources
+      has_many :servers
+      has_many :coses
+      has_many :distribution_lists
 
-      alias distribution_lists distributionlists
+      alias distributionlists distribution_lists
 
       def domain_key(domain_name)
         if logged?
@@ -130,9 +92,10 @@ module Zm
       end
 
       def count_object(type)
-        raise ZmError, 'Unknown object type' unless Zm::Client::CountTypes::ALL.include?(type)
+        type = type.to_sym if type.is_a?(String)
+        raise Zm::Error::ZmError, 'Unknown object type' unless COUNT_OBJECT_TYPES.include?(type)
 
-        soap_request = SoapElement.admin(SoapAdminConstants::COUNT_OBJECTS_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::COUNT_OBJECTS_REQUEST)
         soap_request.add_attribute('type', type)
         soap_resp = @soap_admin_connector.invoke(soap_request)
         soap_resp[:CountObjectsResponse][:num]
@@ -142,17 +105,17 @@ module Zm
         jsns = {
           query: "(mail=#{email})",
           types: 'accounts,distributionlists,aliases,resources',
-          countOnly: SoapUtils::ON
+          countOnly: Zm::Utils::SearchUtils::ON
         }
 
-        soap_request = SoapElement.admin(SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
         soap_request.add_attributes(jsns)
         soap_resp = @soap_admin_connector.invoke(soap_request)
         !soap_resp[:SearchDirectoryResponse][:num].zero?
       end
 
       def infos!
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_VERSION_INFO_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::GET_VERSION_INFO_REQUEST)
         soap_response = @soap_admin_connector.invoke(soap_request)
 
         json = soap_response[:GetVersionInfoResponse][:info].first