zm-ruby-client 2.2.5 → 2.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f0176570eea5284fb4ce8a121e404869861b0f82cd06138c7cfb8df80d0dfc9
-  data.tar.gz: '084eda0865dbec186aa919ce66cfff5cf99277b60c15946f5847ba45173f7fc5'
+  metadata.gz: fc00d91e324f3525589fe4aff9db5d55036d3d52881cc4e03a4019d4bd9a3f7c
+  data.tar.gz: 4429603c4c08dfa045d06fab04e3f1f73d90355b35ced2ebd5228888e26ef5a6
 SHA512:
-  metadata.gz: 47887d91fc4d748e246f5fbe5e53ed64db3d51b61b3f56bcad44c6aaf38237dcaa82badeb0ff9f0d9035b32c25c83ddd88a450409024eacc225a6f7563e5cfa2
-  data.tar.gz: a2d322c41a879db813e8e523714c0d593db290b6082e42c926140d8676bc989335dfcb146dabe513e1b7e43901b81c8461932380399f99beec7aab61ec176a7b
+  metadata.gz: ac9161207764343feaaa8f90d64a4ea9d179eaedecfcfdbcdebf2b7e906a8a1f3122d269321dc4b96ee441087a33957fa452f01a2c0cb3a089da887e565e7ba0
+  data.tar.gz: 00e61ace101d6fd24ec2c57ff9a2cf5e79bc67d612f711199517dade6c9aae779c25ca628252e1cb5e2cb4bd2b5019f1b7384914292ab3dd2fbb0b124d8e2738

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## Unreleased [3.0.0]
+
+### [3.0.0] 2025-04-14
+
+- [Changed] Move token metadata decoder in token class
+- [Changed] Move logger in ClusterConfig class
+- [Added] Add color in logger
+- [Added] Add NoOpRequest for Mailbox object as alive? method
+- [Changed] Remove @all memorization
+- [Added] Add BatchRequest on Cluster and Account class
+- [Changed] Authorize array and undetermined parameters for add! and remove! methods

data/Gemfile

@@ -1,8 +1,16 @@
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby ">= 2.7"
+ruby ">= 3.1"
 
 gem 'addressable', '2.8.7'
-gem 'faraday', '>= 2.8.1'
+gem 'faraday', '~>2.12'
 gem 'faraday-multipart', '1.0.4'
 gem 'version_sorter', '2.3.0'
+
+group :development do
+  gem "rubocop"
+  gem "solargraph"
+  gem "yard"
+  gem "benchmark-ips"
+end

data/README.md

@@ -19,7 +19,8 @@ gem install zm-ruby-client
 ### Connection:
 
 ```ruby
-admin = Zm::Client::Cluster.new(Zm::Client::ClusterConfig.new('config.json'))
+config = Zm::Client::ClusterConfig.new('config.json')
+admin = Zm::Client::Cluster.new(config)
 admin.login
 ````
 or
@@ -27,7 +28,7 @@ or
 config = Zm::Client::ClusterConfig.new do |cc|
   cc.zimbra_admin_host = 'mail.domain.tld'
   cc.zimbra_admin_scheme = 'https'
-  cc.zimbra_admin_port = 443
+  cc.zimbra_admin_port = 7071
   cc.zimbra_admin_login = 'admin@domain.tld'
   cc.zimbra_admin_password = 'secret'
 end
@@ -53,7 +54,9 @@ account = admin.accounts.find_by name: 'maxime@domain.tld'
 ```ruby
 account = Zm::Client::Account.new(admin) do |acc|
   acc.name = 'maxime@domain.tld'
+  acc.givenName = 'Maxime'
+  acc.sn = 'DÉSÉCOT'
 end
-account.zimbraMailQuota = 0
+
 account.save
 ```

data/VERSION

@@ -1 +1 @@
-2.2.5
+2.2.7

data/lib/zm/client/ace/aces_collection.rb

@@ -51,6 +51,7 @@ module Zm
       end
 
       def where(*rights)
+        rights.flatten!
         @rights += rights
         @rights.uniq!
         self

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

@@ -34,6 +34,7 @@ module Zm
         end
 
         def folders(*folders)
+          folders.flatten!
           folders.select! { |folder| folder.is_a?(Zm::Client::Folder) }
           return self if folders.empty?
 
@@ -42,6 +43,7 @@ module Zm
         end
 
         def folder_ids(*folder_ids)
+          folder_ids.flatten!
           folder_ids.uniq!
           return self if @folder_ids == folder_ids
 

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

@@ -23,11 +23,13 @@ module Zm
       end
 
       def sections(*entries)
+        entries.flatten!
         @sections += entries
         self
       end
 
       def rights(*entries)
+        entries.flatten!
         @rights += entries
         self
       end

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

@@ -22,6 +22,7 @@ module Zm
       end
 
       def preferences(*entries)
+        entries.flatten!
         @preferences += entries
         self
       end

data/lib/zm/client/connector/rest_account.rb

@@ -28,36 +28,38 @@ module Zm
         @cookies = cookies
       end
 
-      def download(download_url, dest_file_path)
+      def read(download_url)
         url, path = split_url(download_url)
 
-        conn = Faraday.new(**http_options(url)) do |faraday|
-          faraday.response :logger, nil, { headers: true, bodies: true, errors: true } if @verbose
-        end
+        conn = conn_get(url)
 
-        response = nil
+        data = +''
 
-        File.open(dest_file_path, 'wb') do |f|
-          response = conn.get(path) do |request|
-            request.options.on_data = Proc.new do |chunk, _, _|
-              f.write chunk
-            end
+        response = conn.get(path) do |request|
+          request.options.on_data = Proc.new do |chunk, _, _|
+            data.concat(chunk)
           end
         end
 
         if response.status >= 400
-          File.unlink(dest_file_path) if File.exist?(dest_file_path)
           raise RestError, "Download failure: #{response.body} (status=#{response.status})"
         end
+
+        data
+      end
+
+      def download(download_url, dest_file_path)
+        url, path = split_url(download_url)
+
+        conn = conn_get(url)
+
+        write_downloaded_file(dest_file_path, conn, path)
       end
 
       def upload(upload_url, src_file_path)
         url, path = split_url(upload_url)
 
-        conn = Faraday.new(**http_options(url)) do |faraday|
-          faraday.request :multipart
-          faraday.response :logger, nil, { headers: true, bodies: true, errors: true } if @verbose
-        end
+        conn = conn_multipart(url)
 
         payload = { file: Faraday::Multipart::FilePart.new(src_file_path, nil) }
         response = conn.post(path, payload)
@@ -76,6 +78,38 @@ module Zm
 
       private
 
+      def conn_get(url)
+        Faraday.new(**http_options(url)) do |faraday|
+          faraday.response :logger, nil, { headers: true, bodies: true, errors: true } if @verbose
+        end
+      end
+
+      def conn_multipart(url)
+        Faraday.new(**http_options(url)) do |faraday|
+          faraday.request :multipart
+          faraday.response :logger, nil, { headers: true, bodies: true, errors: true } if @verbose
+        end
+      end
+
+      def write_downloaded_file(dest_file_path, conn, path)
+        response = nil
+
+        File.open(dest_file_path, 'wb') do |f|
+          response = conn.get(path) do |request|
+            request.options.on_data = Proc.new do |chunk, _, _|
+              f.write chunk
+            end
+          end
+        end
+
+        if response.status >= 400
+          File.unlink(dest_file_path) if File.exist?(dest_file_path)
+          raise RestError, "Download failure: #{response.body} (status=#{response.status})"
+        end
+
+        response
+      end
+
       def split_url(url)
         uri = URI(url)
         url = "#{uri.scheme}://#{uri.host}:#{uri.port}"

data/lib/zm/client/connector/soap_base.rb

@@ -72,13 +72,11 @@ module Zm
       def do_request(body, error_handler = SoapError)
         response = http_client.post(@soap_path, body)
 
-        soapbody = JSON.parse(response.body, symbolize_names: true)
-
         if response.status >= 400
-          raise(error_handler, soapbody)
+          raise(error_handler, response.body)
         end
 
-        soapbody
+        JSON.parse(response.body, symbolize_names: true)
       end
 
       def envelope(soap_element)

data/lib/zm/client/connector/soap_error.rb

@@ -9,10 +9,30 @@ module Zm
       attr_reader :reason, :code
 
       def initialize(soapbody)
-        @reason = soapbody[:Body][:Fault][:Reason][:Text]
-        @code = soapbody[:Body][:Fault][:Detail][:Error][:Code]
+        if soapbody.start_with?('{')
+          init_from_json(soapbody)
+        elsif soapbody.start_with?('<')
+          init_from_xml(soapbody)
+        end
+
         super "[#{@code}] [#{@reason}]"
       end
+
+      private
+
+      def init_from_json(soapbody)
+        json = JSON.parse(soapbody, symbolize_names: true)
+        @reason = json[:Body][:Fault][:Reason][:Text]
+        @code = json[:Body][:Fault][:Detail][:Error][:Code]
+      end
+
+      def init_from_xml(soapbody)
+        code_match = soapbody.match(%r{<Code>(.*?)</Code>})
+        @code = code_match[1]
+
+        text_match = soapbody.match(%r{<soap:Reason>.*?<soap:Text>(.*?)</soap:Text>}m)
+        @reason = text_match[1]
+      end
     end
 
     class AuthError < SoapError

data/lib/zm/client/contact/contact.rb

@@ -10,7 +10,14 @@ module Zm
       GROUP_PATTERN = 'group'
 
       attr_accessor :anniversary, :assistantPhone, :birthday, :callbackPhone, :carPhone, :company, :companyPhone,
-                    :custom1, :department, :email, :email2, :email3, :email4, :email5, :email6, :email7, :firstName, :fullName, :homeCity, :homeCountry, :homeFax, :homePhone, :homePostalCode, :homeState, :homeStreet, :homeURL, :imAddress1, :imAddress2, :imAddress3, :imAddress4, :imAddress5, :jobTitle, :lastName, :maidenName, :middleName, :mobilePhone, :namePrefix, :nameSuffix, :nickname, :notes, :otherCity, :otherCountry, :otherFax, :otherPhone, :otherPostalCode, :otherState, :otherStreet, :otherURL, :pager, :workCity, :workCountry, :workFax, :workPhone, :workPostalCode, :workState, :workStreet, :workURL, :image, :id, :name, :l, :type, :tn, :shared_account_id, :shared_folder_account_id
+                    :custom1, :department, :email, :email2, :email3, :email4, :email5, :email6, :email7, :firstName,
+                    :fullName, :homeCity, :homeCountry, :homeFax, :homePhone, :homePostalCode, :homeState, :homeStreet,
+                    :homeURL, :imAddress1, :imAddress2, :imAddress3, :imAddress4, :imAddress5, :jobTitle, :lastName,
+                    :maidenName, :middleName, :mobilePhone, :namePrefix, :nameSuffix, :nickname, :notes, :otherCity,
+                    :otherCountry, :otherFax, :otherPhone, :otherPostalCode, :otherState, :otherStreet, :otherURL,
+                    :pager, :workCity, :workCountry, :workFax, :workPhone, :workPostalCode, :workState, :workStreet,
+                    :workURL, :image, :id, :name, :l, :type, :tn, :shared_account_id, :shared_folder_account_id,
+                    :fileAs
 
       def initialize(parent)
         @l = FolderDefault::CONTACTS[:id]

data/lib/zm/client/contact/group_contact_jsns_builder.rb

@@ -7,11 +7,13 @@ module Zm
       EXCLUDE_INSTANCE_VARIABLE_KEYS = %i[@id @name @parent @l @type @tn @jsns_builder].freeze
 
       def to_jsns
-        {
+        jsns = {
           cn: {
             a: instance_variables_array.map(&Utils::A_NODE_PROC),
             l: @item.folder_id || Zm::Client::FolderDefault::CONTACTS[:id],
-            m: members_node
+            m: @item.members.all.map do |m|
+              { type: m.type, value: m.value }
+            end
           }
         }
 
@@ -23,7 +25,9 @@ module Zm
           cn: {
             a: instance_variables_array.map(&Utils::A_NODE_PROC),
             id: @item.id,
-            m: members_node
+            m: @item.members.all.reject(&:current?).map do |m|
+              { type: m.type, value: m.value, op: m.op }
+            end
           }
         }
 
@@ -31,7 +35,7 @@ module Zm
       end
 
       def to_patch(hash)
-        {
+        jsns = {
           cn: {
             id: @item.id,
             a: hash.map(&Utils::A_ARRAY_PROC).flatten(1).map(&Utils::A_NODE_PROC)
@@ -43,14 +47,8 @@ module Zm
 
       alias to_create to_jsns
 
-      def members_node
-        @item.members.all.reject(&:current?).map do |m|
-          { type: m.type, value: m.value, op: m.op }
-        end
-      end
-
       def instance_variables_array
-        [[:nickname, @item.name], [:fullname, @item.name], [:fileAs, "8:#{@item.name}"], %i[type group]]
+        [[:nickname, @item.name], [:fullName, @item.name], [:fileAs, "8:#{@item.name}"], %i[type group]]
       end
     end
   end

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

@@ -19,6 +19,7 @@ module Zm
       end
 
       def add!(*servers)
+        servers.flatten!
         server_ids = server_ids(servers)
         server_ids.delete_if { |id| @parent.zimbraMailHostPool.include?(id) }
         return false if server_ids.empty?
@@ -31,6 +32,7 @@ module Zm
       end
 
       def remove!(*servers)
+        servers.flatten!
         server_ids = server_ids(servers)
         server_ids.delete_if { |id| !@parent.zimbraMailHostPool.include?(id) }
         return false if server_ids.empty?

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

@@ -12,6 +12,7 @@ module Zm
       end
 
       def add!(*emails)
+        emails.flatten!
         emails.each { |email| Utils.format_email(email) }
         emails.delete_if { |email| @all.include?(email) }
         return false if emails.empty?
@@ -23,6 +24,7 @@ module Zm
       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?

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

@@ -23,7 +23,7 @@ module Zm
           item.md = json[:md]
           item.rev = json[:rev]
           item.f = json[:f]
-          item.tn = json[:tn].to_s.split(',')
+          item.tn = json[:tn]
           item.t = json[:t]
           item.meta = json[:meta]
           item.ct = json[:ct]

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

@@ -5,6 +5,15 @@ 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_rules_builder.rb

@@ -12,7 +12,10 @@ module Zm
       def make
         return [] if json_items.nil?
 
-        json_items.first[:filterRule].map do |entry|
+        rules = json_items.first[:filterRule]
+        return [] if rules.nil?
+
+        rules.map do |entry|
           FilterRuleJsnsInitializer.create(@parent, entry)
         end
       end

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

@@ -10,6 +10,17 @@ module Zm
         super(parent)
       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
+      end
+
       private
 
       def make_query

data/lib/zm/client/message/message.rb

@@ -7,18 +7,33 @@ module Zm
       include BelongsToFolder
       include BelongsToTag
 
-      attr_accessor :id, :d, :l, :f, :su, :fr, :autoSendTime, :mid, :idnt, :tn, :subject
-      attr_reader :recipients, :attachments, :body
+      attr_accessor :id, :d, :l, :f, :su, :fr, :autoSendTime, :mid, :idnt, :tn, :subject, :s
+
+      alias size s
 
       def initialize(parent)
         @parent = parent
         @subject = ''
 
+        yield(self) if block_given?
+      end
+
+      def recipients
+        return @recipients if defined? @recipients
+
         @recipients = Recipients.new
-        @body = Body.new
+      end
+
+      def attachments
+        return @attachments if defined? @attachments
+
         @attachments = AttachmentsCollection.new
+      end
 
-        yield(self) if block_given?
+      def body
+        return @body if defined? @body
+
+        @body = Body.new
       end
 
       def download(dest_file_path, fmt = 'eml')
@@ -26,6 +41,11 @@ module Zm
         uploader.download_file( Zm::Client::FolderDefault::ROOT[:path], fmt, [Zm::Client::FolderView::MESSAGE], [@id], dest_file_path)
       end
 
+      def read(fmt = 'eml')
+        uploader = Upload.new(@parent, RestAccountConnector.new)
+        uploader.read_file( Zm::Client::FolderDefault::ROOT[:path], fmt, [Zm::Client::FolderView::MESSAGE], [@id])
+      end
+
       def date
         @date ||= Time.at(d.to_i / 1000)
       end
@@ -42,8 +62,23 @@ module Zm
         raise NotImplementedError
       end
 
-      def update!(*args)
-        raise NotImplementedError
+      def update!(l: nil, rgb: nil, color: nil, f: nil, tn: nil)
+        attrs = {
+          op: :update,
+          id: @id,
+          l: l,
+          rgb: rgb,
+          color: color,
+          f: f,
+          tn: tn
+        }
+
+        attrs.delete_if { |_, v| v.nil? }
+
+        soap_request = SoapElement.mail(SoapMailConstants::MSG_ACTION_REQUEST)
+        node_action = SoapElement.create(SoapConstants::ACTION).add_attributes(attrs)
+        soap_request.add_node(node_action)
+        @parent.sacc.invoke(soap_request)
       end
 
       def rename!(*args)

data/lib/zm/client/message/message_jsns_initializer.rb

@@ -20,7 +20,8 @@ module Zm
           item.mid  = json[:mid]
           item.idnt = json[:idnt]
           item.f = json[:f]
-          item.tn = json[:tn].to_s.split(',')
+          item.tn = json[:tn]
+          item.s = json[:s]
 
           json[:e].each do |e|
             recipient = Recipient.new(e[:t], e[:a], e[:p])

data/lib/zm/client/message/messages_collection.rb

@@ -23,6 +23,20 @@ module Zm
         end
       end
 
+      def delete_all(ids)
+        attrs = {
+          op: :delete,
+          id: ids.join(',')
+        }
+
+        attrs.delete_if { |_, v| v.nil? }
+
+        soap_request = SoapElement.mail(SoapMailConstants::MSG_ACTION_REQUEST)
+        node_action = SoapElement.create(SoapConstants::ACTION).add_attributes(attrs)
+        soap_request.add_node(node_action)
+        @parent.sacc.invoke(soap_request)
+      end
+
       private
 
       def build_options

data/lib/zm/client/tag/account_object_tags_collection.rb

@@ -13,10 +13,11 @@ module Zm
         end
 
         def all!
-          @all = @parent.tn
+          @all = @parent.tn.split(',')
         end
 
         def add!(*new_tags)
+          new_tags.flatten!
           Utils.map_format(new_tags, String, :name)
           return false if new_tags.delete_if { |tag_name| all.include?(tag_name) }.empty?
 
@@ -35,6 +36,7 @@ module Zm
         end
 
         def remove!(*tag_names)
+          tag_names.flatten!
           Utils.map_format(tag_names, String, :name)
           return false if tag_names.delete_if { |tag_name| !all.include?(tag_name) }.empty?
 

data/lib/zm/client/upload/upload.rb

@@ -26,6 +26,10 @@ module Zm
         @rac.download(download_file_url(folder_path, fmt, types, ids), dest_file_path)
       end
 
+      def read_file(folder_path, fmt, types, ids)
+        @rac.read(download_file_url(folder_path, fmt, types, ids))
+      end
+
       def download_folder(id, fmt, dest_file_path)
         @rac.download(download_folder_url(id, fmt), dest_file_path)
       end

data/lib/zm/modules/common/zimbra-attrs.csv

@@ -733,4 +733,6 @@ zimbraPrefDefaultCalendarId,"account,cos,calendarResource",,,single,,,cstring,,,
 zimbraRecoveryAccountCodeValidity,"account,cos,calendarResource",,,single,,,cstring,,,,
 zimbraResetPasswordRecoveryCodeExpiry,"account,cos,calendarResource",,,single,,,cstring,,,,
 zimbraShowClientTOS,"account,domain,cos,calendarResource",,,single,,,cstring,,,,
-zimbraDistributionListSendShareMessageToNewMembers,distributionList,,,single,,,boolean,,,,
+zimbraDistributionListSendShareMessageToNewMembers,distributionList,,,single,,,boolean,,,,
+zimbraServiceEnabled,,,server,multi,,,cstring,,,,
+zimbraVirtualHostname,domain,,,single,,,cstring,,,,

data/zm-ruby-client.gemspec

@@ -29,4 +29,4 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday', '>= 2.8.1'
   s.add_dependency 'faraday-multipart', '1.0.4'
   s.add_dependency "bundler", ">= 1.15.0"
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zm-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.2.7
 platform: ruby
 authors:
 - Maxime Désécot
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-20 00:00:00.000000000 Z
+date: 2025-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -87,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -340,7 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: zm-ruby-client