zm-ruby-client 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c2c32c371d0de77fe4892230e967cbba6afc90e0aae91b82af2e4ef9fbc09c
-  data.tar.gz: e22eb3274715dfe64d2a67c0bbf1df6caf502c51450ae24767f7ed473e041b11
+  metadata.gz: 5accd01f014ba998f54c30e0a2daa825442a12efe17463e398613516b3798f6c
+  data.tar.gz: 2f3b468efbf5bba59b9493c2c3e9e16820e306b6af92bab8f89a9ba623b21eda
 SHA512:
-  metadata.gz: 494f3fd894e55e673bd7e3322718cbe4905caabee6ac5ae92b3968ded15440e8549c4a8240229847005852f1fb99c1ef4e8257ce9e9442b0949032a2578cb715
-  data.tar.gz: 0ef90ae3f7cb2e75f23b05f314e00d46bdcf398e324e9613ecd1729e63b77f7737b125fa27231038cfa9e2b3a6b67617e39b0ac9f23d864cdefdd3d182f1eef7
+  metadata.gz: d17ab24f8f5ef9b0180e1115bcdbe7949aeb0ab139b893597b7ba4f72e0ac611dc67363161b646ff0ead7a726245fadb83c701091b6ac34797aaea74b26db270
+  data.tar.gz: 3bcfdb6d64434deca30bf35587ad6b83b95aa424b6fd7a9d6bc4fa4c85fef44361107e039e00794b28da1aab05b9b89958ea43bb06304299059963b6cdae0121

data/CHANGELOG.md

@@ -1,5 +1,101 @@
 # Changelog
 
+## Released [3.1.0]
+
+### [3.1.0] 2026-07
+
+#### Upgrading from 3.0
+
+- **Ruby 3.3 or newer is required.**
+- **Only `require 'zm-ruby-client'` is supported.** Files were moved and are now autoloaded: requiring internal
+  files (`zm/client/...`) no longer works.
+- **Error classes moved from `Zm::Client` to `Zm::Error`.** The 3.0 names still work in 3.1 but print a deprecation
+  warning on first use and will be removed in 4.0. Update your `rescue` clauses:
+
+  | 3.0 (deprecated) | 3.1 |
+  |---|---|
+  | `Zm::Client::ZmError` | `Zm::Error::ZmError` |
+  | `Zm::Client::SoapError` | `Zm::Error::SoapError` |
+  | `Zm::Client::AuthError` | `Zm::Error::AuthError` |
+  | `Zm::Client::RestError` | `Zm::Error::RestError` |
+
+- **Network failures raise `Zm::Error::ConnectionError`** (a `Zm::Error::ZmError`) instead of Faraday errors
+  (`Faraday::ConnectionFailed`, `Faraday::TimeoutError`, `Faraday::SSLError`). The Faraday error is kept as `cause`.
+- **Low-level classes moved out of `Zm::Client`.** The 3.0 names are deprecated the same way:
+
+  | 3.0 (deprecated) | 3.1 |
+  |---|---|
+  | `Zm::Client::SoapAdminConnector`, `SoapAccountConnector`, `SoapBaseConnector`, `RestConnector` | `Zm::Connector::*` |
+  | `Zm::Client::SoapElement`, `SoapConstants`, `SoapAdminConstants`, `SoapAccountConstants`, `SoapMailConstants` | `Zm::SoapRequest::*` |
+  | `Zm::Client::SoapUtils` | `Zm::Utils::SearchUtils` |
+  | `Zm::Client::Regex`, `ContentType`, `ContentPart` | `Zm::Utils::*` |
+
+- **Renamed without alias:** the top-level `GroupContact` and `DocumentFolder` modules are now
+  `Zm::Client::ModGroupContact` and `Zm::Client::ModDocumentFolder`.
+- **Removed constants:** `Zm::Client::ShareType`, `FolderType`, `SearchType`, `BackupTypes`, `CountTypes`, `COMMA` and
+  `DOUBLEPOINT`. Use the plain values instead, for example `cluster.count_object(:account)` or
+  `cluster.count_object('account')`.
+- **`ZimbraAttribute` keeps only `name`, `type`, `immutable?` and `objects_scope`** (plus the `is_*_scoped?`
+  predicates): `optionalIn`, `requiredIn`, `flags`, `cardinality`, `callback`, `value`, `max`, `min` and `since` were
+  removed, as well as `ZimbraAttributesCollection#all_versioned`. The attributes catalog is read from the CSV file only
+  (`zimbra-attrs.json` was removed from the gem).
+- **Cache:** only read requests (`Get*`, `Search*`, `Count*`) are cached and entries are stored with msgpack. Entries
+  written by 3.0 are ignored: you can delete the old `file_store` directory.
+- **Stricter arguments:** `Utils.format_email` raises `ArgumentError` on a nil, non-String or blank email, and
+  distribution list members `add!`/`remove!` raise `ArgumentError` on nil instead of returning false.
+- **`clone` no longer shares collections with the original:** a cloned distribution list starts with empty `members`
+  and `owners` (aliases are rebuilt from `zimbraMailAlias`).
+- **`Contact#l` is a String** (`'7'` for a new contact), like the other mailbox items.
+- TLS certificates are still not verified by default: set `ssl_verify` to enable it.
+
+#### Changes
+
+- [Added]   Deprecated aliases for the 3.0 names moved out of Zm::Client (error classes, connectors, SoapElement, SOAP constants, SoapUtils, Regex, ContentType, ContentPart): they print a warning on first use and will be removed in 4.0
+- [Fixed]   Cluster#count_object accepts a String again ('account', as in 3.0) as well as a Symbol
+- [Added]   Add live CRUD tests (accounts, account folders, appointments, contacts, identities, messages, signatures and tags, resources, distribution lists, domains, coses) against a real server in test/live, rake test:live task configured by ZIMBRA_ADMIN_URL, ZIMBRA_ADMIN_LOGIN and ZIMBRA_ADMIN_PASSWORD
+- [Fixed]   ContactJsnsBuilder no longer sends internal instance variables (updated, token, tags, folder, shared account ids) as contact attributes
+- [Fixed]   GroupContactJsnsBuilder: to_create and to_patch raised NameError, the folder is read from l, members are sent without op on creation
+- [Fixed]   MessageFlagsCollection: read!, unread!, flag! and unflag! raised NoMethodError (soap_connector called on the message instead of its account)
+- [Changed] MessageFlagsCollection: read!, unread!, flag! and unflag! update the message flags (f) after the request
+- [Fixed]   Contact: the default folder (l) is set through l= and is a String like the other mailbox items
+- [Fixed]   Base::Object#clone: the copy no longer shares the memoized jsns builder and collections of the original (a clone of a created identity or cos sent the original name), and no longer raises when the original has no id
+- [Added]   Add RBS signatures for the public API in sig/ (cluster, config, errors, admin objects and collections, mailbox entry points), rake rbs:validate and rbs:test tasks
+- [Added]   Add massive update and delete in admin collection classes
+- [Added]   Add optional TLS certificate verification in ClusterConfig (ssl_verify, ssl_ca_file, ssl_ca_path), disabled by default
+- [Changed] Cache only read SOAP requests (Get*, Search*, Count*): write and auth requests are no longer replayed from cache
+- [Changed] Store cache entries with msgpack only (no Marshal), cache files created with 0600 and directories with 0700: existing cache entries are ignored
+- [Fixed]   Mask passwords, preauth and auth tokens in debug and verbose HTTP logs
+- [Changed] Raise Zm::Error::ConnectionError (original Faraday error as cause) on connection failure, timeout and SSL error instead of Faraday errors
+- [Fixed]   REST download and read error messages were always empty (streamed body), error pages are no longer written to the destination file
+- [Fixed]   Alias, distribution list member and owner add!/remove! raised FrozenError on frozen emails and mutated the given strings
+- [Changed] Utils.format_email raises ArgumentError on nil, non-String or blank email instead of NoMethodError
+- [Fixed]   Delegated account connector shared the cluster SOAP context: every following admin request carried the account header
+- [Fixed]   Server#mailboxes and AccountsCollection#quotas left the target server set on the cluster admin connector
+- [Fixed]   MessagesCollection#find_each(secure: true) looped forever when the search request failed
+- [Changed] Replace require by autoload to reduce memory usage
+- [Changed] Share the Zimbra attributes catalog between clusters using the same attributes file (CSV parsed and accessors defined once)
+- [Changed] ZimbraAttribute keeps only name, type, immutable? and objects_scope (catalog memory reduced by about 65%): optionalIn, requiredIn, flags, cardinality, callback, value, max, min and since readers removed
+- [Removed] Remove unused zimbra-attrs.json file from the gem
+- [Removed] Remove ZimbraAttributesCollection#all_versioned (never set, always nil)
+- [Changed] Reduce allocations when building objects from SOAP responses (about 90% fewer for accounts)
+- [Changed] Autoload cache stores and msgpack: the default null_store no longer loads msgpack and FileStore (about 1.2 MB less)
+- [Added]   Add Zm::Support::Cache.storage(key), registered_storage may now hold constant names (Symbol) instead of classes
+- [Fixed]   Autoload ClusterConfigError and ClusterConfigDomain (NameError when referenced before ClusterConfig was loaded)
+- [Fixed]   Autoload Attachment and DlMembership (NameError when referenced before their collection was loaded)
+- [Fixed]   Require time explicitly: Time.parse (created_at, last_logon, appointments) only worked because csv loaded it
+- [Fixed]   DistributionListMembersCollection add!/remove! raise ArgumentError on nil instead of returning false
+- [Changed] Change code structure files
+- [Changed] Add secure option in messages find_each method
+- [Changed] Require Ruby 3.3 minimum
+- [Changed] Add csv and logger dependencies, remove bundler dependency, pin dependency major versions
+- [Fixed]   Fix default zimbra attributes file path in ClusterConfig
+- [Fixed]   Remove duplicated Recipient class in MessageRecipients
+- [Fixed]   Rename TagBuilder to TagsBuilder to match autoload (account tags raised NameError)
+- [Fixed]   Remove duplicated attribute accessors in SearchFolder
+- [Fixed]   Accept keyword attributes in admin update!, update_all! and mass_update! (local_transport! raised ArgumentError)
+- [Fixed]   Rescue Zm::Error::SoapError in mass_update! and mass_delete! (onerror option raised NameError)
+- [Changed] Fix indentation in several collection classes
+
 ## Released [3.0.0]
 
 ### [3.0.0] 2025-12(27)

data/README.md

@@ -1,57 +1,158 @@
 # zm-ruby-client
 
-Library to interface with Zimbra simply.
+[![Gem Version](https://img.shields.io/gem/v/zm-ruby-client)](https://rubygems.org/gems/zm-ruby-client)
+![Ruby](https://img.shields.io/badge/ruby-3.3%2B-CC342D)
+[![License](https://img.shields.io/badge/license-GPL--3.0-blue)](LICENSE)
 
-Author: Maxime Désécot <maxime.desecot@gmail.com>
+**Zimbra and Carbonio in plain Ruby: code that reads like what it does.**
 
-## Installation
+```ruby
+cluster.accounts.find_by(name: 'john@domain.tld').update!(zimbraAccountStatus: 'locked')
+```
 
-OS: Linux distribution LTS
+No XML, no SOAP envelopes, no token juggling. Read the line out loud, that's what it does.
 
-Language: Ruby3.2+
+- **Readable**: short verbs (`find_by`, `where`, `save!`, `update!`, `delete!`) and chainable queries.
+- **Complete**: admin side (accounts, domains, COS, distribution lists, servers…) and mailbox side
+  (messages, folders, contacts, calendars, tags, shares…), over both SOAP and REST.
+- **Lightweight**: Ruby 3.3+, few dependencies, code autoloaded on demand.
+
+## Install
 
 ```bash
 gem install zm-ruby-client
 ```
 
-## Examples of uses:
-
-### Connection:
+## Connect
 
 ```ruby
-cluster = Zm::Client::Cluster.new(Zm::Client::ClusterConfig.new('config.json'))
-cluster.login
-````
-or
-```ruby
+require 'zm-ruby-client'
+
 config = Zm::Client::ClusterConfig.new do |cc|
-  cc.zimbra_admin_url = 'https://mail.domain.tld:7071'
-  cc.zimbra_admin_login = 'admin@domain.tld'
+  cc.zimbra_admin_url      = 'https://mail.domain.tld:7071'
+  cc.zimbra_admin_login    = 'admin@domain.tld'
   cc.zimbra_admin_password = 'secret'
 end
+
 cluster = Zm::Client::Cluster.new(config)
 cluster.login
-````
+```
+
+Prefer a file? `Zm::Client::ClusterConfig.new('config.json')` (or `.yml`), see [examples/config.json](examples/config.json).
+
+TLS certificates are not verified by default. To enable verification:
+
+```ruby
+cc.ssl_verify  = true
+cc.ssl_ca_file = '/etc/ssl/certs/zimbra-ca.pem' # optional, for a private CA (or ssl_ca_path)
+```
 
-### List all accounts
+## Feel the difference
+
+**Find an account, change it.**
+
+```ruby
+account = cluster.accounts.find_by name: 'john@domain.tld'
+account.zimbraAccountStatus # => "active"
+
+account.update!(zimbraAccountStatus: 'locked')
+```
+
+**Query LDAP like a database.** Pagination is handled for you.
+
+```ruby
+cluster.accounts
+       .where('(zimbraLastLogonTimestamp<=20250101000000Z)')
+       .attrs('zimbraLastLogonTimestamp')
+       .find_each { |account| puts "#{account.name} last seen #{account.last_logon}" }
+```
+
+**Lock every dormant account. One line.**
 
 ```ruby
-filter = '(&(mail=*@domain.tld)(zimbraLastLogonTimestamp<=20190225000000Z))'
-accounts = cluster.accounts.where(filter).all
+cluster.accounts.where('(zimbraLastLogonTimestamp<=20250101000000Z)').update_all!(zimbraAccountStatus: 'locked')
 ```
 
-### Find an account
+**Step into any mailbox, no user password needed.**
 
 ```ruby
-account = cluster.accounts.find_by name: 'maxime@domain.tld'
+account.login
+
+account.messages.where('is:unread from:boss@domain.tld').all.each do |message|
+  puts "#{message.date}  #{message.su}"
+end
 ```
 
-### Create an account
+**Create anything with a block.**
 
 ```ruby
-account = Zm::Client::Account.new(cluster) do |acc|
-  acc.name = 'maxime@domain.tld'
+folder = account.folders.new do |f|
+  f.name  = 'Invoices'
+  f.color = 3
 end
-account.zimbraMailQuota = 0
-account.save
-```
+folder.save!
+```
+
+**Import and export whole folders.**
+
+```ruby
+account.folders.find(10).upload('holidays.ics')  # Calendar
+account.folders.find(2).download('inbox.tgz')    # Inbox backup
+account.folders.find(7).export_contacts          # Contacts, as CSV
+```
+
+**Ask quick questions.**
+
+```ruby
+cluster.email_exist?('john@domain.tld')               # => true
+cluster.accounts.where('(mail=*@domain.tld)').count   # => 1250
+```
+
+## Type signatures
+
+RBS signatures for the public API are shipped in `sig/`. [rbs collection](https://github.com/ruby/rbs) picks them up
+from the installed gem, for use with [Steep](https://github.com/soutaro/steep) or your editor:
+
+```bash
+bundle exec rbs collection install
+```
+
+## Upgrading from 3.0
+
+3.1 requires Ruby 3.3, moves the error classes to `Zm::Error` (`rescue Zm::Error::SoapError`) and raises
+`Zm::Error::ConnectionError` on network failures. The 3.0 names (`Zm::Client::SoapError`…) still work but print a
+deprecation warning: they will be removed in 4.0. See the [upgrade notes](CHANGELOG.md#upgrading-from-30) for the
+full list.
+
+## Development
+
+```bash
+bundle install
+bundle exec rake test          # offline unit tests, no server needed
+bundle exec rake rbs:validate  # check the RBS signatures
+bundle exec rake rbs:test      # unit tests with RBS runtime type checking
+bundle exec rubocop
+```
+
+**Live tests** run real CRUD operations (accounts, domains, COS, distribution lists, resources, and the folders,
+messages, contacts, appointments, tags, signatures and identities of an account) against a Zimbra or Carbonio server:
+
+```bash
+ZIMBRA_ADMIN_URL=https://mail.domain.tld:7071 \
+ZIMBRA_ADMIN_LOGIN=admin@domain.tld \
+ZIMBRA_ADMIN_PASSWORD=secret \
+bundle exec rake test:live
+```
+
+Each test creates its own data (accounts, lists and resources in a temporary `zmlive-*.test` domain) and deletes it
+afterwards, even when the test fails. They are skipped when a variable is missing. Set `ZIMBRA_LOG_PATH=/dev/stdout`
+to see the SOAP requests. Use a test server: the tests need full admin rights and create and delete domains.
+
+## Learn more
+
+- [examples/](examples): ready-to-run scripts
+- [CHANGELOG.md](CHANGELOG.md): what's new
+
+## License
+
+GPL-3.0, by Maxime Désécot.

data/VERSION

@@ -1 +1 @@
-3.0.1
+3.1.0

data/lib/zm/client/account/account.rb

@@ -1,23 +1,15 @@
 # frozen_string_literal: true
 
-require 'zm/client/account/account_aliases_collection'
-
 module Zm
   module Client
     # objectClass: zimbraAccount
     class Account < Base::MailboxObject
-      include RequestMethodsAdmin
+      include SoapRequest::RequestMethodsAdmin
 
       # #################################################################
       # Associations
       # #################################################################
 
-      def aliases
-        return @aliases if defined? @aliases
-
-        @aliases = AccountAliasesCollection.new(self)
-      end
-
       def cos
         return @cos if defined? @cos
 
@@ -45,12 +37,12 @@ module Zm
       end
 
       def build_flush_cache
-        soap_request = SoapElement.admin(SoapAdminConstants::FLUSH_CACHE_REQUEST)
-        node_cache = SoapElement.create('cache')
-                                .add_attributes({ type: SoapConstants::ACCOUNT, allServers: SoapUtils::ON })
+        soap_request = Zm::SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::FLUSH_CACHE_REQUEST)
+        node_cache = Zm::SoapRequest::SoapElement.create('cache')
+                                .add_attributes({ type: Zm::SoapRequest::SoapConstants::ACCOUNT, allServers: Zm::Utils::SearchUtils::ON })
         soap_request.add_node(node_cache)
-        node_entry = SoapElement.create('entry')
-                                .add_attribute(SoapConstants::BY, SoapConstants::ID)
+        node_entry = Zm::SoapRequest::SoapElement.create('entry')
+                                .add_attribute(Zm::SoapRequest::SoapConstants::BY, SoapRequest::SoapConstants::ID)
                                 .add_content(@id)
         node_cache.add_node(node_entry)
         soap_request
@@ -60,11 +52,7 @@ module Zm
         @parent.zimbra_attributes.all_account_attrs_writable_names
       end
 
-      def jsns_builder
-        return @jsns_builder if defined? @jsns_builder
-
-        @jsns_builder = AccountJsnsBuilder.new(self)
-      end
+      has_jsns_builder
 
       def batch
         return @batch if defined? @batch
@@ -72,6 +60,11 @@ module Zm
         @batch = BatchRequest.new(soap_account_connector)
       end
 
+      def empty_dumpster!
+        soap_request = Zm::SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::EMPTY_DUMPSTER_REQUEST)
+        soap_connector.invoke(soap_request)
+      end
+
       private
 
       def do_update!(hash)

data/lib/zm/client/account/account_aliases_collection.rb

@@ -14,7 +14,8 @@ module Zm
       end
 
       def add!(email)
-        return false if all.include?(Utils.format_email(email))
+        email = Utils.format_email(email)
+        return false if all.include?(email)
 
         @parent.sac.invoke(build_add(email))
 
@@ -23,13 +24,14 @@ module Zm
       end
 
       def build_add(email)
-        soap_request = SoapElement.admin(SoapAdminConstants::ADD_ACCOUNT_ALIAS_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::ADD_ACCOUNT_ALIAS_REQUEST)
         soap_request.add_attributes({ id: @parent.id, alias: email })
         soap_request
       end
 
       def remove!(email)
-        return false unless all.include?(Utils.format_email(email))
+        email = Utils.format_email(email)
+        return false unless all.include?(email)
 
         @parent.sac.invoke(build_remove(email))
 
@@ -38,7 +40,7 @@ module Zm
       end
 
       def build_remove(email)
-        soap_request = SoapElement.admin(SoapAdminConstants::REMOVE_ACCOUNT_ALIAS_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::REMOVE_ACCOUNT_ALIAS_REQUEST)
         soap_request.add_attributes({ id: @parent.id, alias: email })
         soap_request
       end

data/lib/zm/client/account/account_dls_membership_collection.rb

@@ -5,6 +5,7 @@ module Zm
     # Collection Account dls membership
     class AccountDlsMembershipCollection < Base::ObjectsCollection
       def initialize(parent)
+        super()
         @parent = parent
       end
 
@@ -13,9 +14,9 @@ module Zm
       end
 
       def build_query
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_ACCOUNT_MEMBERSHIP_REQUEST)
-        node_account = SoapElement.create(SoapConstants::ACCOUNT)
-                                  .add_attribute(SoapConstants::BY, SoapConstants::ID)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::GET_ACCOUNT_MEMBERSHIP_REQUEST)
+        node_account = SoapRequest::SoapElement.create(SoapRequest::SoapConstants::ACCOUNT)
+                                  .add_attribute(SoapRequest::SoapConstants::BY, SoapRequest::SoapConstants::ID)
                                   .add_content(@parent.id)
         soap_request.add_node(node_account)
         soap_request

data/lib/zm/client/account/account_dls_owner_collection.rb

@@ -5,6 +5,7 @@ module Zm
     # Collection Account dls membership
     class AccountDlsOwnerCollection < Base::ObjectsCollection
       def initialize(parent)
+        super()
         @parent = parent
       end
 
@@ -15,10 +16,10 @@ module Zm
       def build_query
         jsns = {
           query: "(zimbraACE=#{@parent.id} usr ownDistList)",
-          types: SearchType::DL
+          types: :distributionlists
         }
 
-        SoapElement.admin(SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
+        SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
                    .add_attributes(jsns)
       end
 

data/lib/zm/client/account/account_jsns_builder.rb

@@ -15,7 +15,7 @@ module Zm
         }
         req.compact!
 
-        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_ACCOUNT_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::CREATE_ACCOUNT_REQUEST)
                                   .add_attributes(req)
 
         add_soap_request_nodes(soap_request)
@@ -32,15 +32,15 @@ module Zm
       end
 
       def add_soap_request_node(soap_request, key, value)
-        node_attr = SoapElement.create(SoapConstants::A)
-                               .add_attribute(SoapConstants::N, key)
+        node_attr = SoapRequest::SoapElement.create(SoapRequest::SoapConstants::A)
+                               .add_attribute(SoapRequest::SoapConstants::N, key)
                                .add_content(value)
         soap_request.add_node(node_attr)
       end
 
       def to_update
-        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_ACCOUNT_REQUEST)
-                                  .add_attribute(SoapConstants::ID, @item.id)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::MODIFY_ACCOUNT_REQUEST)
+                                  .add_attribute(SoapRequest::SoapConstants::ID, @item.id)
 
         add_soap_request_nodes(soap_request)
 
@@ -48,8 +48,8 @@ module Zm
       end
 
       def to_patch(hash)
-        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_ACCOUNT_REQUEST)
-                                  .add_attribute(SoapConstants::ID, @item.id)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::MODIFY_ACCOUNT_REQUEST)
+                                  .add_attribute(SoapRequest::SoapConstants::ID, @item.id)
 
         hash.each do |key, values|
           values = [values] unless values.is_a?(Array)
@@ -62,12 +62,12 @@ module Zm
       end
 
       def to_delete
-        SoapElement.admin(SoapAdminConstants::DELETE_ACCOUNT_REQUEST)
-                   .add_attribute(SoapConstants::ID, @item.id)
+        SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::DELETE_ACCOUNT_REQUEST)
+                   .add_attribute(SoapRequest::SoapConstants::ID, @item.id)
       end
 
       def to_rename(new_name)
-        SoapElement.admin(SoapAdminConstants::RENAME_ACCOUNT_REQUEST)
+        SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::RENAME_ACCOUNT_REQUEST)
                    .add_attributes({ id: @item.id, newName: new_name })
       end
 

data/lib/zm/client/account/accounts_collection.rb

@@ -7,7 +7,7 @@ module Zm
       def initialize(parent)
         @child_class = Account
         @builder_class = AccountsBuilder
-        @search_type = SearchType::ACCOUNT
+        @search_type = :accounts
         super
       end
 
@@ -19,24 +19,20 @@ module Zm
       end
 
       def build_find_by(hash)
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_ACCOUNT_REQUEST)
-        node_account = SoapElement.create(SoapConstants::ACCOUNT)
-                                  .add_attribute(SoapConstants::BY, hash.keys.first)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::GET_ACCOUNT_REQUEST)
+        node_account = SoapRequest::SoapElement.create(SoapRequest::SoapConstants::ACCOUNT)
+                                  .add_attribute(SoapRequest::SoapConstants::BY, hash.keys.first)
                                   .add_content(hash.values.first)
         soap_request.add_node(node_account)
-        soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma)
-        soap_request.add_attribute(SoapConstants::APPLY_COS, @apply_cos)
+        soap_request.add_attribute(SoapRequest::SoapConstants::ATTRS, attrs_comma)
+        soap_request.add_attribute(SoapRequest::SoapConstants::APPLY_COS, @apply_cos)
         soap_request
       end
 
       def quotas(domain_name: @domain_name, target_server_id: @target_server_id)
         return nil if domain_name.nil? && target_server_id.nil?
 
-        if target_server_id.nil?
-          @all_servers = SoapUtils::ON
-        else
-          sac.context.target_server(target_server_id)
-        end
+        @all_servers = Zm::Utils::SearchUtils::ON if target_server_id.nil?
 
         jsns = {
           domain: domain_name,
@@ -49,11 +45,9 @@ module Zm
         }
         jsns.compact!
 
-        soap_request = SoapElement.admin(SoapAdminConstants::GET_QUOTA_USAGE_REQUEST)
+        soap_request = SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::GET_QUOTA_USAGE_REQUEST)
                                   .add_attributes(jsns)
-        json = sac.invoke(soap_request)
-
-        sac.context.target_server(nil) unless target_server_id.nil?
+        json = target_server_id.nil? ? sac.invoke(soap_request) : sac.target_invoke(soap_request, target_server_id)
 
         reset_query_params
         @builder_class.new(@parent, json).make
@@ -63,7 +57,24 @@ module Zm
 
       def reset_query_params
         super
-        @attrs = SearchType::Attributes::ACCOUNT.dup
+        @attrs = %w[
+          displayName
+          zimbraId
+          cn
+          sn
+          zimbraMailHost
+          uid
+          zimbraCOSId
+          zimbraAccountStatus
+          zimbraLastLogonTimestamp
+          description
+          zimbraIsSystemAccount
+          zimbraIsDelegatedAdminAccount
+          zimbraAuthTokenValidityValue
+          zimbraMailStatus
+          zimbraIsAdminAccount
+          zimbraIsExternalVirtualAccount
+        ]
       end
     end
   end

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

@@ -4,6 +4,9 @@ module Zm
   module Client
     # class account ace
     class Ace < Base::Object
+      extend Zm::Relationship
+      has_jsns_builder
+
       GT_USER = 'usr'
       GT_GROUP = 'grp'
       GT_DOMAIN = 'dom'
@@ -24,12 +27,6 @@ module Zm
         @parent.soap_connector.invoke(jsns_builder.to_delete)
         true
       end
-
-      def jsns_builder
-        return @jsns_builder if defined? @jsns_builder
-
-        @jsns_builder = AceJsnsBuilder.new(self)
-      end
     end
   end
 end

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

@@ -5,21 +5,21 @@ module Zm
     # class for account ace jsns builder
     class AceJsnsBuilder < Base::BaseJsnsBuilder
       def to_find
-        soap_request = SoapElement.account(SoapAccountConstants::GET_RIGHTS_REQUEST)
+        soap_request = SoapRequest::SoapElement.account(Zm::SoapRequest::SoapAccountConstants::GET_RIGHTS_REQUEST)
 
-        soap_request.add_attribute(SoapConstants::ACE, @item.rights.map { |r| { right: r } }) unless @item.rights.empty?
+        soap_request.add_attribute(SoapRequest::SoapConstants::ACE, @item.rights.map { |r| { right: r } }) unless @item.rights.empty?
 
         soap_request
       end
 
       def to_jsns
-        SoapElement.account(SoapAccountConstants::GRANT_RIGHTS_REQUEST)
-                   .add_attribute(SoapConstants::ACE, attrs)
+        SoapRequest::SoapElement.account(Zm::SoapRequest::SoapAccountConstants::GRANT_RIGHTS_REQUEST)
+                   .add_attribute(SoapRequest::SoapConstants::ACE, attrs)
       end
 
       def to_delete
-        SoapElement.account(SoapAccountConstants::REVOKE_RIGHTS_REQUEST)
-                   .add_attribute(SoapConstants::ACE, attrs)
+        SoapRequest::SoapElement.account(Zm::SoapRequest::SoapAccountConstants::REVOKE_RIGHTS_REQUEST)
+                   .add_attribute(SoapRequest::SoapConstants::ACE, attrs)
       end
 
       def attrs