zm-ruby-client 3.0.1 → 3.1.0

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

@@ -5,6 +5,9 @@ module Zm
     module Base
       # class for account object jsns initializer
       class BaseJsnsInitializer
+        INTEGER_REGEX = /\A(?:0|-?[1-9]\d*)\z/
+        SETTERS = Hash.new { |h, name| h[name] = :"#{name}=" }
+
         class << self
           def create(parent, json)
             klass.new(parent).tap do |item|
@@ -26,32 +29,34 @@ module Zm
           def formatted_json(json)
             return [] if json[:a].nil?
 
-            json[:a].reject! { |n| n[:n].nil? }
-            json_map = json[:a].map { |n| [n[:n], n[:_content]] }.freeze
-
-            hash_multivalued = json_map.each_with_object({}) do |(k, v), h|
-              h[k] ||= []
-              h[k].push(v)
+            json[:a].each_with_object({}) do |n, h|
+              add_value(h, n[:n], n[:_content]) unless n[:n].nil?
             end
+          end
+
+          def add_value(hash, key, value)
+            current = hash.fetch(key, hash)
 
-            hash_multivalued.transform_values do |v|
-              v.length == 1 ? v.first : v
+            if current.equal?(hash)
+              hash[key] = value
+            elsif current.is_a?(Array)
+              current << value
+            else
+              hash[key] = [current, value]
             end
           end
 
           def valorise(item, k, v)
-            setter_method_name = "#{k}="
-            return unless item.respond_to?(setter_method_name)
+            setter = SETTERS[k]
+            return unless item.respond_to?(setter)
 
-            item.send(setter_method_name, convert_json_string_value(v))
+            item.send(setter, convert_json_string_value(v))
           end
 
           def convert_json_string_value(value)
-            return value unless value.is_a?(String)
-            return 0 if value == '0'
+            return value unless value.is_a?(String) && INTEGER_REGEX.match?(value)
 
-            c = value.to_i
-            c.to_s == value ? c : value
+            value.to_i
           end
         end
       end

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

@@ -2,96 +2,98 @@
 
 module Zm
   module Client
-    class MailboxInfosCollection
-      def initialize(parent)
-        @parent = parent
-        @sections = []
-        @rights = []
-      end
-
-      def all
-        build_response
-      end
-      alias all! all
-
-      def clear
-        reset_query_params
-      end
-
-      def sections(*entries)
-        entries.flatten!
-        @sections += entries
-        self
-      end
-
-      def rights(*entries)
-        entries.flatten!
-        @rights += entries
-        self
-      end
-
-      def read
-        reset_query_params
-        @sections = ['mbox']
-        rep = build_response
-        @parent.id = rep[:id]
-        @parent.used = rep[:used]
-        @parent.public_url = rep[:publicURL]
-        @parent.zimbraCOSId = rep[:cos][:id]
-        @parent.home_url = rep[:rest]
-        rep
-      end
-
-      def zimbraMailHost
-        @zimbraMailHost || zimbraMailHost!
-      end
-
-      def zimbraMailHost!
-        return if @parent.name.nil? && @parent.id.nil?
-
-        soap_request = SoapElement.account(SoapAccountConstants::GET_ACCOUNT_INFO_REQUEST)
-
-        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.soap_connector
-                                 .invoke(soap_request)
-                                 .dig(:GetAccountInfoResponse, :_attrs, :zimbraMailHost)
-      end
-
-      private
-
-      def build_response
-        make_query[:GetInfoResponse]
-      end
-
-      def make_query
-        soap_request = SoapElement.account(SoapAccountConstants::GET_INFO_REQUEST)
-                                  .add_attributes(jsns)
-        @parent.soap_connector.invoke(soap_request)
-      end
-
-      def jsns
-        h = {
-          rights: @rights.join(','),
-          sections: @sections.join(',')
-        }
-        h.compact!
-        h
-      end
-
-      def reset_query_params
-        @sections.clear
-        @rights.clear
+    module Base
+      class MailboxInfosCollection
+        def initialize(parent)
+          @parent = parent
+          @sections = []
+          @rights = []
+        end
+
+        def all
+          build_response
+        end
+        alias all! all
+
+        def clear
+          reset_query_params
+        end
+
+        def sections(*entries)
+          entries.flatten!
+          @sections += entries
+          self
+        end
+
+        def rights(*entries)
+          entries.flatten!
+          @rights += entries
+          self
+        end
+
+        def read
+          reset_query_params
+          @sections = ['mbox']
+          rep = build_response
+          @parent.id = rep[:id]
+          @parent.used = rep[:used]
+          @parent.public_url = rep[:publicURL]
+          @parent.zimbraCOSId = rep[:cos][:id]
+          @parent.home_url = rep[:rest]
+          rep
+        end
+
+        def zimbraMailHost
+          @zimbraMailHost || zimbraMailHost!
+        end
+
+        def zimbraMailHost!
+          return if @parent.name.nil? && @parent.id.nil?
+
+          soap_request = SoapRequest::SoapElement.account(Zm::SoapRequest::SoapAccountConstants::GET_ACCOUNT_INFO_REQUEST)
+
+          node_entry = if @parent.id
+                         SoapRequest::SoapElement.create(SoapRequest::SoapConstants::ACCOUNT)
+                                                 .add_attribute(SoapRequest::SoapConstants::BY, SoapRequest::SoapConstants::ID)
+                                                 .add_content(@parent.id)
+                       else
+                         SoapRequest::SoapElement.create(SoapRequest::SoapConstants::ACCOUNT)
+                                                 .add_attribute(SoapRequest::SoapConstants::BY, SoapRequest::SoapConstants::NAME)
+                                                 .add_content(@parent.name)
+                       end
+
+          soap_request.add_node(node_entry)
+
+          @zimbraMailHost = @parent.soap_connector
+                                   .invoke(soap_request)
+                                   .dig(:GetAccountInfoResponse, :_attrs, :zimbraMailHost)
+        end
+
+        private
+
+        def build_response
+          make_query[:GetInfoResponse]
+        end
+
+        def make_query
+          soap_request = SoapRequest::SoapElement.account(Zm::SoapRequest::SoapAccountConstants::GET_INFO_REQUEST)
+                                                 .add_attributes(jsns)
+          @parent.soap_connector.invoke(soap_request)
+        end
+
+        def jsns
+          h = {
+            rights: @rights.join(','),
+            sections: @sections.join(',')
+          }
+          h.compact!
+          h
+        end
+
+        def reset_query_params
+          @sections.clear
+          @rights.clear
+        end
       end
     end
   end

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

@@ -1,30 +1,12 @@
 # frozen_string_literal: true
 
-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'
-require 'zm/client/search_folder'
-require 'zm/client/share'
-require 'zm/client/tag'
-require 'zm/client/ace'
-require 'zm/client/contact'
-require 'zm/client/appointment'
-require 'zm/client/task'
-require 'zm/client/document'
-require 'zm/client/message'
-require 'zm/client/identity'
-require 'zm/client/upload'
-require 'zm/client/filter_rule'
-require 'zm/client/datasource'
-
 module Zm
   module Client
     module Base
       # Abstract Class for Account and Resource
       class MailboxObject < Object
-        include HasSoapAdminConnector
+        include Zm::Utils::HasSoapAdminConnector
+        extend Zm::Relationship
 
         attr_accessor :home_url, :public_url, :password, :carLicense
         attr_writer :used, :domain_key
@@ -32,7 +14,7 @@ module Zm
         def soap_account_connector
           return @soap_account_connector if defined? @soap_account_connector
 
-          @soap_account_connector = SoapAccountConnector.create(soap_config)
+          @soap_account_connector = Zm::Connector::SoapAccountConnector.create(soap_config)
         end
 
         def soap_connector
@@ -49,7 +31,7 @@ module Zm
               @soap_connector.context.account(:name, @name)
             end
           else
-            raise ZmError, 'SoapConnector not defined'
+            raise Zm::Error::ZmError, 'SoapConnector not defined'
           end
 
           @soap_connector
@@ -61,17 +43,9 @@ module Zm
           @domain_name = @name.split('@').last
         end
 
-        def infos
-          return @infos if defined? @infos
-
-          @infos = MailboxInfosCollection.new(self)
-        end
-
-        def prefs
-          return @prefs if defined? @prefs
-
-          @prefs = MailboxPrefsCollection.new(self)
-        end
+        has_many :aliases, klass: :'Zm::Client::AccountAliasesCollection'
+        has_many :infos, klass: :'Zm::Client::Base::MailboxInfosCollection'
+        has_many :prefs, klass: :'Zm::Client::Base::MailboxPrefsCollection'
 
         def used
           @used || used!
@@ -90,8 +64,8 @@ module Zm
         end
 
         def mailbox_infos
-          soap_request = SoapElement.admin(SoapAdminConstants::GET_MAILBOX_REQUEST)
-          node_mbox = SoapElement.create(SoapConstants::MBOX).add_attribute(SoapConstants::ID, @id)
+          soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::GET_MAILBOX_REQUEST)
+          node_mbox = SoapRequest::SoapElement.create(SoapRequest::SoapConstants::MBOX).add_attribute(SoapRequest::SoapConstants::ID, @id)
           soap_request.add_node(node_mbox)
           sac.invoke(soap_request)[:GetMailboxResponse][:mbox].first
         end
@@ -116,10 +90,10 @@ module Zm
         end
 
         def alive?
-          soap_request = SoapElement.mail(SoapMailConstants::NO_OP_REQUEST)
+          soap_request = SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::NO_OP_REQUEST)
           soap_connector.invoke(soap_request)
           true
-        rescue Zm::Client::SoapError => e
+        rescue Zm::Error::SoapError => e
           logger.warn "Mailbox session token alive ? #{e.message}"
           false
         end
@@ -154,7 +128,7 @@ module Zm
 
         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?
+          raise Zm::Error::ZmError, 'domain key is required to login !' if domain_key.nil?
 
           content, by = account_content_by
 
@@ -163,7 +137,7 @@ module Zm
 
         def account_login_password
           logger.info 'Get Account session token by password access'
-          raise ZmError, 'password is required to login !' if password.nil?
+          raise Zm::Error::ZmError, 'password is required to login !' if password.nil?
 
           content, by = account_content_by
 
@@ -177,13 +151,13 @@ module Zm
         def admin_login
           logger.info 'Get Account session token by Delegate access'
 
-          soap_request = SoapElement.admin(SoapAdminConstants::DELEGATE_AUTH_REQUEST)
-          node_account = SoapElement.create(SoapConstants::ACCOUNT)
+          soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::DELEGATE_AUTH_REQUEST)
+          node_account = SoapRequest::SoapElement.create(SoapRequest::SoapConstants::ACCOUNT)
 
           if recorded?
-            node_account.add_attribute(SoapConstants::BY, SoapConstants::ID).add_content(@id)
+            node_account.add_attribute(SoapRequest::SoapConstants::BY, SoapRequest::SoapConstants::ID).add_content(@id)
           else
-            node_account.add_attribute(SoapConstants::BY, SoapConstants::NAME).add_content(@name)
+            node_account.add_attribute(SoapRequest::SoapConstants::BY, SoapRequest::SoapConstants::NAME).add_content(@name)
           end
 
           soap_request.add_node(node_account)
@@ -194,114 +168,28 @@ module Zm
         # Associations
         # #################################################################
 
-        def messages
-          return @messages if defined? @messages
-
-          @messages = MessagesCollection.new(self)
-        end
-
-        def folders
-          return @folders if defined? @folders
-
-          @folders = FoldersCollection.new(self)
-        end
-
-        def mountpoints
-          return @mountpoints if defined? @mountpoints
-
-          @mountpoints = MountPointsCollection.new(self)
-        end
-
-        def search_folders
-          return @search_folders if defined? @search_folders
-
-          @search_folders = SearchFoldersCollection.new(self)
-        end
-
-        def identities
-          return @identities if defined? @identities
-
-          @identities = IdentitiesCollection.new(self)
-        end
-
-        def shares
-          return @shares if defined? @shares
-
-          @shares = SharesCollection.new(self)
-        end
-
-        def contacts
-          return @contacts if defined? @contacts
-
-          @contacts = ContactsCollection.new(self)
-        end
-
-        def appointments
-          return @appointments if defined? @appointments
-
-          @appointments = AppointmentsCollection.new(self)
-        end
-
-        def tags
-          return @tags if defined? @tags
-
-          @tags = TagsCollection.new(self)
-        end
-
-        def tasks
-          return @tasks if defined? @tasks
-
-          @tasks = TasksCollection.new(self)
-        end
-
-        def aces
-          return @aces if defined? @aces
-
-          @aces = AcesCollection.new(self)
-        end
+        has_many :messages
+        has_many :folders
+        has_many :mount_points
+        alias mountpoints mount_points
+
+        has_many :search_folders
+        has_many :identities
+        has_many :shares
+        has_many :contacts
+        has_many :appointments
+        has_many :tags
+        has_many :tasks
+        has_many :aces
         alias rights aces
 
-        def signatures
-          return @signatures if defined? @signatures
-
-          @signatures = SignaturesCollection.new(self)
-        end
-
-        def documents
-          return @documents if defined? @documents
-
-          @documents = DocumentsCollection.new(self)
-        end
-
-        def memberships
-          return @memberships if defined? @memberships
-
-          @memberships = AccountDlsMembershipCollection.new(self)
-        end
-
-        def dls_owner
-          return @dls_owner if defined? @dls_owner
-
-          @dls_owner = AccountDlsOwnerCollection.new(self)
-        end
-
-        def filter_rules
-          return @filter_rules if defined? @filter_rules
-
-          @filter_rules = FilterRulesCollection.new(self)
-        end
-
-        def outgoing_filter_rules
-          return @outgoing_filter_rules if defined? @outgoing_filter_rules
-
-          @outgoing_filter_rules = OutgoingFilterRulesCollection.new(self)
-        end
-
-        def data_sources
-          return @data_sources if defined? @data_sources
-
-          @data_sources = DataSourcesCollection.new(self)
-        end
+        has_many :signatures
+        has_many :documents
+        has_many :memberships, klass: :'Zm::Client::AccountDlsMembershipCollection'
+        has_many :dls_owner, klass: :'Zm::Client::AccountDlsOwnerCollection'
+        has_many :filter_rules
+        has_many :outgoing_filter_rules
+        has_many :data_sources
 
         # #################################################################
         # SOAP Actions
@@ -311,7 +199,7 @@ module Zm
           new_password ||= @password
           return false if new_password.nil?
 
-          soap_request = SoapElement.admin(SoapAdminConstants::SET_PASSWORD_REQUEST)
+          soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::SET_PASSWORD_REQUEST)
           soap_request.add_attributes({ id: @id, newPassword: new_password })
           sac.invoke(soap_request)
 
@@ -319,7 +207,7 @@ module Zm
         end
 
         def local_transport
-          raise Zm::Client::ZmError, 'zimbraMailHost is null' if zimbraMailHost.nil?
+          raise Zm::Error::ZmError, 'zimbraMailHost is null' if zimbraMailHost.nil?
 
           "lmtp:#{zimbraMailHost}:7025"
         end
@@ -331,13 +219,13 @@ module Zm
         def is_local_transport?
           return false unless zimbraMailTransport
 
-          zimbraMailTransport.start_with?(SoapConstants::LMTP)
+          zimbraMailTransport.start_with?(SoapRequest::SoapConstants::LMTP)
         end
 
         def is_external_transport?
           return false unless zimbraMailTransport
 
-          zimbraMailTransport.start_with?(SoapConstants::SMTP)
+          zimbraMailTransport.start_with?(SoapRequest::SoapConstants::SMTP)
         end
 
         def last_logon
@@ -350,16 +238,17 @@ module Zm
 
         def build_uploader
           tmp_token = soap_connector&.token
-          raise ZmError, 'token have to be set to instance Upload class' unless tmp_token
+          raise Zm::Error::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)
+          Upload.new(rest_url, tmp_token, is_token_admin: soap_connector.is_a?(Zm::Connector::SoapAdminConnector), **rest_options)
         end
 
         def rest_options
           if soap_config
             {
               timeout: soap_config.timeout,
-              verbose: soap_config.logger.debug?
+              verbose: soap_config.logger.debug?,
+              ssl_options: soap_config.ssl_options
             }
           else
             {}
@@ -367,19 +256,19 @@ module Zm
         end
 
         def rest_url
-          raise ZmError, 'name attribute is requuired for REST Url' unless @name
+          raise Zm::Error::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'
+            raise Zm::Error::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
+          raise Zm::Error::ZmError, 'impossible to set rest_admin_url' unless soap_config.zimbra_admin_url
 
           File.join(soap_config.zimbra_admin_url, 'home', @name)
         end
@@ -390,7 +279,7 @@ module Zm
           elsif home_url
             home_url
           else
-            raise ZmError, 'impossible to set rest_account_url'
+            raise Zm::Error::ZmError, 'impossible to set rest_account_url'
           end
         end