zm-ruby-client 2.2.7 → 3.0.0

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

@@ -10,16 +10,12 @@ module Zm
       end
 
       def all
-        @all || all!
-      end
-
-      def all!
         build_response
       end
+      alias all! all
 
       def clear
         reset_query_params
-        @all.clear
       end
 
       def sections(*entries)
@@ -55,30 +51,42 @@ module Zm
 
         soap_request = SoapElement.account(SoapAccountConstants::GET_ACCOUNT_INFO_REQUEST)
 
-        if @parent.id
-          node_entry = SoapElement.create(SoapConstants::ACCOUNT).add_attribute(SoapConstants::BY, SoapConstants::ID).add_content(@parent.id)
-        else
-          node_entry = SoapElement.create(SoapConstants::ACCOUNT).add_attribute(SoapConstants::BY, SoapConstants::NAME).add_content(@parent.name)
-        end
+        node_entry = if @parent.id
+                       SoapElement.create(SoapConstants::ACCOUNT)
+                                  .add_attribute(SoapConstants::BY, SoapConstants::ID)
+                                  .add_content(@parent.id)
+                     else
+                       SoapElement.create(SoapConstants::ACCOUNT)
+                                  .add_attribute(SoapConstants::BY, SoapConstants::NAME)
+                                  .add_content(@parent.name)
+                     end
 
         soap_request.add_node(node_entry)
 
-        @zimbraMailHost = @parent.sacc.invoke(soap_request).dig(:GetAccountInfoResponse, :_attrs, :zimbraMailHost)
+        @zimbraMailHost = @parent.soap_connector
+                                 .invoke(soap_request)
+                                 .dig(:GetAccountInfoResponse, :_attrs, :zimbraMailHost)
       end
 
       private
 
       def build_response
-        @all = make_query[:GetInfoResponse]
+        make_query[:GetInfoResponse]
       end
 
       def make_query
-        soap_request = SoapElement.account(SoapAccountConstants::GET_INFO_REQUEST).add_attributes(jsns)
-        @parent.sacc.invoke(soap_request)
+        soap_request = SoapElement.account(SoapAccountConstants::GET_INFO_REQUEST)
+                                  .add_attributes(jsns)
+        @parent.soap_connector.invoke(soap_request)
       end
 
       def jsns
-        { rights: @rights.join(','), sections: @sections.join(',') }.reject { |_, v| v.empty? }
+        h = {
+          rights: @rights.join(','),
+          sections: @sections.join(',')
+        }
+        h.compact!
+        h
       end
 
       def reset_query_params

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'zm/client/connector/rest_account'
+require 'zm/client/mailbox/mailbox_item_concern'
+require 'zm/client/connector/rest_connector'
 require 'zm/client/signature'
 require 'zm/client/folder'
 require 'zm/client/mountpoint'
@@ -29,26 +30,47 @@ module Zm
         attr_writer :used, :domain_key
 
         def soap_account_connector
-          @soap_account_connector ||= SoapAccountConnector.create(soap_config)
-        end
-        alias sacc soap_account_connector
+          return @soap_account_connector if defined? @soap_account_connector
 
-        def rest_account_connector
-          @rest_account_connector ||= RestAccountConnector.new
+          @soap_account_connector = SoapAccountConnector.create(soap_config)
         end
 
-        alias rac rest_account_connector
+        def soap_connector
+          return @soap_connector if defined? @soap_connector
+
+          if logged?
+            @soap_connector = soap_account_connector
+          elsif (@id || @name) && @parent&.logged?
+            @soap_connector = @parent.soap_admin_connector.clone
+
+            if @id
+              @soap_connector.context.account(:id, @id)
+            else
+              @soap_connector.context.account(:name, @name)
+            end
+          else
+            raise ZmError, 'SoapConnector not defined'
+          end
+
+          @soap_connector
+        end
 
         def domain_name
-          @domain_name ||= @name.split('@').last
+          return @domain_name if defined? @domain_name
+
+          @domain_name = @name.split('@').last
         end
 
         def infos
-          @infos ||= MailboxInfosCollection.new(self)
+          return @infos if defined? @infos
+
+          @infos = MailboxInfosCollection.new(self)
         end
 
         def prefs
-          @prefs ||= MailboxPrefsCollection.new(self)
+          return @prefs if defined? @prefs
+
+          @prefs = MailboxPrefsCollection.new(self)
         end
 
         def used
@@ -78,8 +100,32 @@ module Zm
         # Authentication
         # #################################################################
 
+        def token
+          return @token if defined? @token
+
+          @token = (Token.new(soap_account_connector.token) if soap_account_connector.token)
+        end
+
+        def token=(value)
+          @token = Token.new(soap_account_connector.token = value)
+          @soap_connector = soap_account_connector
+        end
+
         def logged?
-          !@token.nil?
+          !token.nil? && !token.expired?
+        end
+
+        def alive?
+          soap_request = SoapElement.mail(SoapMailConstants::NO_OP_REQUEST)
+          soap_connector.invoke(soap_request)
+          true
+        rescue Zm::Client::SoapError => e
+          logger.warn "Mailbox session token alive ? #{e.message}"
+          false
+        end
+
+        def logged_and_alive?
+          logged? && alive?
         end
 
         def domain_key
@@ -97,7 +143,7 @@ module Zm
         end
 
         def account_login
-          sacc.token = nil
+          soap_account_connector.token = nil
 
           if password
             account_login_password
@@ -107,21 +153,21 @@ module Zm
         end
 
         def account_login_preauth(expires = 0)
+          logger.info 'Get Account session token by preauth access'
           raise ZmError, 'domain key is required to login !' if domain_key.nil?
 
           content, by = account_content_by
 
-          @token = sacc.auth_preauth(content, by, expires, domain_key)
-          sacc.context.token(@token)
+          self.token = soap_account_connector.auth_preauth(content, by, expires, domain_key)
         end
 
         def account_login_password
+          logger.info 'Get Account session token by password access'
           raise ZmError, 'password is required to login !' if password.nil?
 
           content, by = account_content_by
 
-          @token = sacc.auth_password(content, by, @password)
-          sacc.context.token(@token)
+          self.token = soap_account_connector.auth_password(content, by, @password)
         end
 
         def account_content_by
@@ -129,7 +175,7 @@ module Zm
         end
 
         def admin_login
-          # @token = sac.delegate_auth(@name)
+          logger.info 'Get Account session token by Delegate access'
 
           soap_request = SoapElement.admin(SoapAdminConstants::DELEGATE_AUTH_REQUEST)
           node_account = SoapElement.create(SoapConstants::ACCOUNT)
@@ -141,89 +187,120 @@ module Zm
           end
 
           soap_request.add_node(node_account)
-          @token = sac.invoke(soap_request)[:DelegateAuthResponse][:authToken].first[:_content]
-          sacc.context.token(@token)
+          self.token = sac.invoke(soap_request)[:DelegateAuthResponse][:authToken].first[:_content]
         end
 
         # #################################################################
         # Associations
         # #################################################################
 
-        def token_metadata
-          @token_metadata ||= TokenMetaData.new(@token)
-        end
-
         def messages
-          @messages ||= MessagesCollection.new(self)
+          return @messages if defined? @messages
+
+          @messages = MessagesCollection.new(self)
         end
 
         def folders
-          @folders ||= FoldersCollection.new(self)
+          return @folders if defined? @folders
+
+          @folders = FoldersCollection.new(self)
         end
 
         def mountpoints
-          @mountpoints ||= MountPointsCollection.new(self)
+          return @mountpoints if defined? @mountpoints
+
+          @mountpoints = MountPointsCollection.new(self)
         end
 
         def search_folders
-          @search_folders ||= SearchFoldersCollection.new(self)
+          return @search_folders if defined? @search_folders
+
+          @search_folders = SearchFoldersCollection.new(self)
         end
 
         def identities
-          @identities ||= IdentitiesCollection.new(self)
+          return @identities if defined? @identities
+
+          @identities = IdentitiesCollection.new(self)
         end
 
         def shares
-          @shares ||= SharesCollection.new(self)
+          return @shares if defined? @shares
+
+          @shares = SharesCollection.new(self)
         end
 
         def contacts
-          @contacts ||= ContactsCollection.new(self)
+          return @contacts if defined? @contacts
+
+          @contacts = ContactsCollection.new(self)
         end
 
         def appointments
-          @appointments ||= AppointmentsCollection.new(self)
+          return @appointments if defined? @appointments
+
+          @appointments = AppointmentsCollection.new(self)
         end
 
         def tags
-          @tags ||= TagsCollection.new(self)
+          return @tags if defined? @tags
+
+          @tags = TagsCollection.new(self)
         end
 
         def tasks
-          @tasks ||= TasksCollection.new(self)
+          return @tasks if defined? @tasks
+
+          @tasks = TasksCollection.new(self)
         end
 
         def aces
-          @aces ||= AcesCollection.new(self)
+          return @aces if defined? @aces
+
+          @aces = AcesCollection.new(self)
         end
         alias rights aces
 
         def signatures
-          @signatures ||= SignaturesCollection.new(self)
+          return @signatures if defined? @signatures
+
+          @signatures = SignaturesCollection.new(self)
         end
 
         def documents
-          @documents ||= DocumentsCollection.new(self)
+          return @documents if defined? @documents
+
+          @documents = DocumentsCollection.new(self)
         end
 
         def memberships
-          @memberships ||= AccountDlsMembershipCollection.new(self)
+          return @memberships if defined? @memberships
+
+          @memberships = AccountDlsMembershipCollection.new(self)
         end
 
         def dls_owner
-          @dls_owner ||= AccountDlsOwnerCollection.new(self)
+          return @dls_owner if defined? @dls_owner
+
+          @dls_owner = AccountDlsOwnerCollection.new(self)
         end
 
         def filter_rules
-          @filter_rules ||= FilterRulesCollection.new(self)
+          return @filter_rules if defined? @filter_rules
+
+          @filter_rules = FilterRulesCollection.new(self)
         end
 
         def outgoing_filter_rules
-          @outgoing_filter_rules ||= OutgoingFilterRulesCollection.new(self)
+          return @outgoing_filter_rules if defined? @outgoing_filter_rules
+
+          @outgoing_filter_rules = OutgoingFilterRulesCollection.new(self)
         end
 
         def data_sources
-          @data_sources ||= DataSourcesCollection.new(self)
+          return @data_sources if defined? @data_sources
+
+          @data_sources = DataSourcesCollection.new(self)
         end
 
         # #################################################################
@@ -241,26 +318,6 @@ module Zm
           @password = new_password
         end
 
-        def rename!(email)
-          soap_request = SoapElement.admin(SoapAdminConstants::RENAME_ACCOUNT_REQUEST)
-          soap_request.add_attributes({ id: @id, newName: email })
-          sac.invoke(soap_request)
-
-          @name = email
-        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 local_transport
           raise Zm::Client::ZmError, 'zimbraMailHost is null' if zimbraMailHost.nil?
 
@@ -272,34 +329,82 @@ module Zm
         end
 
         def is_local_transport?
-          return nil unless zimbraMailTransport
+          return false unless zimbraMailTransport
 
           zimbraMailTransport.start_with?(SoapConstants::LMTP)
         end
 
         def is_external_transport?
-          return nil unless zimbraMailTransport
+          return false unless zimbraMailTransport
 
           zimbraMailTransport.start_with?(SoapConstants::SMTP)
         end
 
         def last_logon
-          @last_logon ||= Time.parse(zimbraLastLogonTimestamp) unless zimbraLastLogonTimestamp.nil?
+          return @last_logon if defined? @last_logon
+
+          @last_logon = Time.parse(zimbraLastLogonTimestamp) unless zimbraLastLogonTimestamp.nil?
         end
 
         # #################################################################
 
-        def uploader
-          @uploader ||= Upload.new(self)
+        def build_uploader
+          tmp_token = soap_connector&.token
+          raise ZmError, 'token have to be set to instance Upload class' unless tmp_token
+
+          Upload.new(rest_url, tmp_token, is_token_admin: soap_connector.is_a?(SoapAdminConnector), **rest_options)
+        end
+
+        def rest_options
+          if soap_config
+            {
+              timeout: soap_config.timeout,
+              verbose: soap_config.logger.debug?
+            }
+          else
+            {}
+          end
+        end
+
+        def rest_url
+          raise ZmError, 'name attribute is requuired for REST Url' unless @name
+
+          if logged?
+            rest_account_url
+          elsif parent_logged?
+            rest_admin_url
+          else
+            raise ZmError, 'impossible to set rest_url'
+          end
+        end
+
+        def rest_admin_url
+          raise ZmError, 'impossible to set rest_admin_url' unless soap_config.zimbra_admin_url
+
+          File.join(soap_config.zimbra_admin_url, 'home', @name)
+        end
+
+        def rest_account_url
+          if soap_config.zimbra_public_url
+            File.join(soap_config.zimbra_public_url, 'home', @name)
+          elsif home_url
+            home_url
+          else
+            raise ZmError, 'impossible to set rest_account_url'
+          end
         end
 
         private
 
         def soap_config
-          return @parent.config if @parent.respond_to?(:config)
-          return @parent.parent.config if @parent.respond_to?(:parent) && @parent.parent.respond_to?(:config)
+          return @soap_config if defined? @soap_config
+          return unless @parent
 
-          nil
+          if @parent.respond_to?(:config)
+            @soap_config = @parent.config
+          elsif @parent.respond_to?(:parent) && @parent.parent.respond_to?(:config)
+            @soap_config = @parent.parent.config
+          end
         end
 
         def parent_logged?

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

@@ -9,16 +9,12 @@ module Zm
       end
 
       def all
-        @all || all!
-      end
-
-      def all!
         build_response
       end
+      alias all! all
 
       def clear
         reset_query_params
-        @all.clear
       end
 
       def preferences(*entries)
@@ -48,18 +44,18 @@ module Zm
         }
 
         soap_request = SoapElement.account(SoapAccountConstants::MODIFY_PREFS_REQUEST).add_attributes(req)
-        @parent.sacc.invoke(soap_request)
+        @parent.soap_connector.invoke(soap_request)
       end
 
       private
 
       def build_response
-        @all = make_query.dig(:GetPrefsResponse, :_attrs)
+        make_query.dig(:GetPrefsResponse, :_attrs)
       end
 
       def make_query
         soap_request = SoapElement.account(SoapAccountConstants::GET_PREFS_REQUEST).add_attributes(jsns)
-        @parent.sacc.invoke(soap_request)
+        @parent.soap_connector.invoke(soap_request)
       end
 
       def jsns

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

@@ -46,12 +46,12 @@ module Zm
         end
 
         def to_h
-          Hash[instance_variables_map]
+          instance_variables_map.to_h
         end
 
         def inspect
           keys_str = to_h.map { |k, v| "#{k}: #{v}" }.join(', ')
-          "#{self.class}:#{format('0x00%x', (object_id << 1))} #{keys_str}"
+          "#{self.class}:#{format('0x00%x', object_id << 1)} #{keys_str}"
         end
 
         def instance_variables_map

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

@@ -11,17 +11,21 @@ module Zm
         end
 
         def ids
-          @json[:Body][json_key][:hit]&.map { |s| s[:id] } || []
+          @json.dig(:Body, json_key, :hit)&.map { |s| s[:id] } || []
         end
 
         private
 
         def json_items
-          @json_items ||= @json[json_key][@json_item_key]
+          return @json_items if defined? @json_items
+
+          @json_items = @json[json_key][@json_item_key]
         end
 
         def json_key
-          @json_key ||= @json.keys.first
+          return @json_key if defined? @json_key
+
+          @json_key = @json.keys.first
         end
       end
     end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
 module Zm
   module Client
     module Base
@@ -27,45 +26,37 @@ module Zm
         end
 
         def all
-          @all || all!
-        end
-
-        def all!
-          @all = build_response
+          build_response
         end
+        alias all! all
 
         def per_page(limit)
           return self if @limit == limit
 
-          @all = nil
           @limit = limit
           self
         end
-
         alias limit per_page
 
         def page(offset)
           return self if @offset == offset
 
-          @all = nil
           @offset = offset
           self
         end
-
         alias offset page
 
         def order(sort_by, sort_ascending = SoapUtils::ON)
           return self if @sort_by == sort_by && @sort_ascending == sort_ascending
 
-          @all = nil
           @sort_by = sort_by
           @sort_ascending = sort_ascending
           self
         end
 
-        def method_missing(method, *args, &block)
+        def method_missing(method, *, &)
           if METHODS_MISSING_LIST.include?(method)
-            build_response.send(method, *args, &block)
+            build_response.send(method, *, &)
           else
             super
           end

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

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-require 'version_sorter'
-
 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, :optionalIn, :flags, :requiredIn, :cardinality, :callback, :immutable, :type, :value, :max,
+                    :min, :since
 
-        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, flags: nil, requiredIn: nil, cardinality: nil, callback: nil,
+                       immutable: nil, type: nil, value: nil, max: nil, min: nil, since: nil)
           @name = name
           @optionalIn = optionalIn.to_s.split(',')
           @flags = flags
@@ -24,18 +23,6 @@ module Zm
           @since = since
         end
 
-        def version_start
-          return @version_start unless @version_start.nil?
-
-          @version_start = if since.nil?
-                             '0.0.0'
-                           else
-                             VersionSorter.sort(since.split(',')).first
-                           end
-
-          @version_start
-        end
-
         def immutable?
           immutable == '1'
         end