zm-ruby-client 2.2.7 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc00d91e324f3525589fe4aff9db5d55036d3d52881cc4e03a4019d4bd9a3f7c
-  data.tar.gz: 4429603c4c08dfa045d06fab04e3f1f73d90355b35ced2ebd5228888e26ef5a6
+  metadata.gz: 48d8c7101a499388568d4973d639b166246d2872013cd4fba97df7d7c8b7e8e1
+  data.tar.gz: 14e6f9537807d2495dcd911eaca7aaacba0726891b02b113e23362f882130c54
 SHA512:
-  metadata.gz: ac9161207764343feaaa8f90d64a4ea9d179eaedecfcfdbcdebf2b7e906a8a1f3122d269321dc4b96ee441087a33957fa452f01a2c0cb3a089da887e565e7ba0
-  data.tar.gz: 00e61ace101d6fd24ec2c57ff9a2cf5e79bc67d612f711199517dade6c9aae779c25ca628252e1cb5e2cb4bd2b5019f1b7384914292ab3dd2fbb0b124d8e2738
+  metadata.gz: 1ce2fa7e3ce6c17bd11fef30d57d0402d7c2fcd3d6075cc4f4d94439d2f1cf5ffd4cc428bd391ceda9d55e2602adcc77242fe0225de109868de1eed6bb19360e
+  data.tar.gz: 68867b6a6064c36d89b4dc39f456df50edb7445555da17078a5c6d02727cc64bf551977c03871bad87ec1b880654a8022965d6ca58bec26cb9c7f869d9875f48

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.2.9

data/CHANGELOG.md

@@ -1,13 +1,17 @@
 # Changelog
 
-## Unreleased [3.0.0]
+## Released [3.0.0]
 
-### [3.0.0] 2025-04-14
+### [3.0.0] 2025-12(27)
 
 - [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
+- [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
+- [Added]   Add BatchRequest on Cluster and Account class
+- [Changed] Authorize array and undetermined parameters for add! and remove! methods
+- [Changed] Memory optimization in object initializers
+- [Changed] Replace FolderDefault as Data object
+- [Changed] Modify config admin and public url format
+- [Added]   Can access mailbox objects without mailbox login

data/Gemfile

@@ -1,12 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby ">= 3.1"
-
-gem 'addressable', '2.8.7'
-gem 'faraday', '~>2.12'
-gem 'faraday-multipart', '1.0.4'
-gem 'version_sorter', '2.3.0'
+gemspec
 
 group :development do
   gem "rubocop"

data/README.md

@@ -8,7 +8,7 @@ Author: Maxime Désécot <maxime.desecot@gmail.com>
 
 OS: Linux distribution LTS
 
-Language: Ruby2.7+
+Language: Ruby3.2+
 
 ```bash
 gem install zm-ruby-client
@@ -19,44 +19,39 @@ gem install zm-ruby-client
 ### Connection:
 
 ```ruby
-config = Zm::Client::ClusterConfig.new('config.json')
-admin = Zm::Client::Cluster.new(config)
-admin.login
+cluster = Zm::Client::Cluster.new(Zm::Client::ClusterConfig.new('config.json'))
+cluster.login
 ````
 or
 ```ruby
 config = Zm::Client::ClusterConfig.new do |cc|
-  cc.zimbra_admin_host = 'mail.domain.tld'
-  cc.zimbra_admin_scheme = 'https'
-  cc.zimbra_admin_port = 7071
+  cc.zimbra_admin_url = 'https://mail.domain.tld:7071'
   cc.zimbra_admin_login = 'admin@domain.tld'
   cc.zimbra_admin_password = 'secret'
 end
-admin = Zm::Client::Cluster.new(config)
-admin.login
+cluster = Zm::Client::Cluster.new(config)
+cluster.login
 ````
 
 ### List all accounts
 
 ```ruby
 filter = '(&(mail=*@domain.tld)(zimbraLastLogonTimestamp<=20190225000000Z))'
-accounts = admin.accounts.where(filter).all
+accounts = cluster.accounts.where(filter).all
 ```
 
 ### Find an account
 
 ```ruby
-account = admin.accounts.find_by name: 'maxime@domain.tld'
+account = cluster.accounts.find_by name: 'maxime@domain.tld'
 ```
 
 ### Create an account
 
 ```ruby
-account = Zm::Client::Account.new(admin) do |acc|
+account = Zm::Client::Account.new(cluster) 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.7
+3.0.0

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

@@ -6,64 +6,77 @@ module Zm
   module Client
     # objectClass: zimbraAccount
     class Account < Base::MailboxObject
+      include RequestMethodsAdmin
+
       # #################################################################
       # Associations
       # #################################################################
 
       def aliases
-        @aliases ||= AccountAliasesCollection.new(self)
+        return @aliases if defined? @aliases
+
+        @aliases = AccountAliasesCollection.new(self)
       end
 
       def cos
-        @cos ||= @parent.coses.find_by(id: zimbraCOSId)
+        return @cos if defined? @cos
+
+        @cos = @parent.coses.find_by(id: zimbraCOSId)
       end
 
       # #################################################################
       # SOAP Actions
       # #################################################################
 
-      def delete!
-        sac.invoke(jsns_builder.to_delete)
-        @id = nil
-      end
-
-      def modify!
-        sac.invoke(jsns_builder.to_update)
-        true
-      end
-
       def create!
-        resp = sac.invoke(jsns_builder.to_create)
+        resp = sac.invoke(build_create)
         @id = resp[:CreateAccountResponse][:account].first[:id]
       end
 
       def created_at
-        @created_at ||= Time.parse(zimbraCreateTimestamp) unless zimbraCreateTimestamp.nil?
+        return @created_at if defined? @created_at
+
+        @created_at = Time.parse(zimbraCreateTimestamp) unless zimbraCreateTimestamp.nil?
       end
 
       def flush_cache!
+        sac.invoke(build_flush_cache)
+        true
+      end
+
+      def build_flush_cache
         soap_request = SoapElement.admin(SoapAdminConstants::FLUSH_CACHE_REQUEST)
-        node_cache = SoapElement.create('cache').add_attributes({ type: SoapConstants::ACCOUNT, allServers: 1 })
+        node_cache = SoapElement.create('cache')
+                                .add_attributes({ type: SoapConstants::ACCOUNT, allServers: SoapUtils::ON })
         soap_request.add_node(node_cache)
-        node_entry = SoapElement.create('entry').add_attribute(SoapConstants::BY, SoapConstants::ID).add_content(@id)
+        node_entry = SoapElement.create('entry')
+                                .add_attribute(SoapConstants::BY, SoapConstants::ID)
+                                .add_content(@id)
         node_cache.add_node(node_entry)
-        sac.invoke(soap_request)
-        true
+        soap_request
       end
 
       def attrs_write
         @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
+
+      def batch
+        return @batch if defined? @batch
+
+        @batch = BatchRequest.new(soap_account_connector)
+      end
+
       private
 
       def do_update!(hash)
         sac.invoke(jsns_builder.to_patch(hash))
       end
-
-      def jsns_builder
-        @jsns_builder ||= AccountJsnsBuilder.new(self)
-      end
     end
   end
 end

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

@@ -16,25 +16,33 @@ module Zm
       def add!(email)
         return false if all.include?(Utils.format_email(email))
 
-        soap_request = SoapElement.admin(SoapAdminConstants::ADD_ACCOUNT_ALIAS_REQUEST)
-        soap_request.add_attributes({ id: @parent.id, alias: email })
-        @parent.sac.invoke(soap_request)
+        @parent.sac.invoke(build_add(email))
 
         all.push(email)
         true
       end
 
+      def build_add(email)
+        soap_request = SoapElement.admin(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))
 
-        soap_request = SoapElement.admin(SoapAdminConstants::REMOVE_ACCOUNT_ALIAS_REQUEST)
-        soap_request.add_attributes({ id: @parent.id, alias: email })
-        @parent.sac.invoke(soap_request)
+        @parent.sac.invoke(build_remove(email))
 
         all.delete(email)
         true
       end
 
+      def build_remove(email)
+        soap_request = SoapElement.admin(SoapAdminConstants::REMOVE_ACCOUNT_ALIAS_REQUEST)
+        soap_request.add_attributes({ id: @parent.id, alias: email })
+        soap_request
+      end
+
       private
 
       def build_aliases

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

@@ -8,15 +8,21 @@ module Zm
         @parent = parent
       end
 
-      private
-
       def make_query
+        sac.invoke(build_query)
+      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).add_content(@parent.id)
+        node_account = SoapElement.create(SoapConstants::ACCOUNT)
+                                  .add_attribute(SoapConstants::BY, SoapConstants::ID)
+                                  .add_content(@parent.id)
         soap_request.add_node(node_account)
-        sac.invoke(soap_request)
+        soap_request
       end
 
+      private
+
       def build_response
         DistributionListsBuilder.new(@parent, make_query).make
       end

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

@@ -8,19 +8,22 @@ module Zm
         @parent = parent
       end
 
-      private
-
       def make_query
+        @parent.sac.invoke(build_query)
+      end
+
+      def build_query
         jsns = {
           query: "(zimbraACE=#{@parent.id} usr ownDistList)",
           types: SearchType::DL
         }
 
-        soap_request = SoapElement.admin(SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
-        soap_request.add_attributes(jsns)
-        @parent.sac.invoke(soap_request)
+        SoapElement.admin(SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
+                   .add_attributes(jsns)
       end
 
+      private
+
       def build_response
         DistributionListsBuilder.new(@parent, make_query).make
       end

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

@@ -12,43 +12,49 @@ module Zm
         req = {
           name: @item.name,
           password: @item.password
-        }.reject { |_, v| v.nil? }
+        }
+        req.compact!
 
-        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_ACCOUNT_REQUEST).add_attributes(req)
+        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_ACCOUNT_REQUEST)
+                                  .add_attributes(req)
 
+        add_soap_request_nodes(soap_request)
+
+        soap_request
+      end
+
+      def add_soap_request_nodes(soap_request)
         attrs_only_set_h.each do |key, values|
           values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
-            soap_request.add_node(node_attr)
+            add_soap_request_node(soap_request, key, value)
           end
         end
+      end
 
-        soap_request
+      def add_soap_request_node(soap_request, key, value)
+        node_attr = SoapElement.create(SoapConstants::A)
+                               .add_attribute(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 = SoapElement.admin(SoapAdminConstants::MODIFY_ACCOUNT_REQUEST)
+                                  .add_attribute(SoapConstants::ID, @item.id)
 
-        attrs_only_set_h.each do |key, values|
-          values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
-            soap_request.add_node(node_attr)
-          end
-        end
+        add_soap_request_nodes(soap_request)
 
         soap_request
       end
 
       def to_patch(hash)
-        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_ACCOUNT_REQUEST).add_attribute(SoapConstants::ID,
-                                                                                                   @item.id)
+        soap_request = SoapElement.admin(SoapAdminConstants::MODIFY_ACCOUNT_REQUEST)
+                                  .add_attribute(SoapConstants::ID, @item.id)
 
         hash.each do |key, values|
           values = [values] unless values.is_a?(Array)
           values.each do |value|
-            node_attr = SoapElement.create(SoapConstants::A).add_attribute(SoapConstants::N, key).add_content(value)
-            soap_request.add_node(node_attr)
+            add_soap_request_node(soap_request, key, value)
           end
         end
 
@@ -56,7 +62,13 @@ module Zm
       end
 
       def to_delete
-        SoapElement.admin(SoapAdminConstants::DELETE_ACCOUNT_REQUEST).add_attribute('id', @item.id)
+        SoapElement.admin(SoapAdminConstants::DELETE_ACCOUNT_REQUEST)
+                   .add_attribute(SoapConstants::ID, @item.id)
+      end
+
+      def to_rename(new_name)
+        SoapElement.admin(SoapAdminConstants::RENAME_ACCOUNT_REQUEST)
+                   .add_attributes({ id: @item.id, newName: new_name })
       end
 
       def attrs_only_set_h
@@ -70,7 +82,7 @@ module Zm
           [n, values]
         end
 
-        Hash[arr]
+        arr.to_h
       end
     end
   end

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

@@ -5,23 +5,13 @@ module Zm
     # class for initialize account
     class AccountJsnsInitializer < Base::BaseJsnsInitializer
       class << self
-        def create(parent, json)
-          item = Account.new(parent)
-
-          update(item, json)
-        end
+        def klass = Account
 
         def update(item, json)
-          item.id = json[:id]
-          item.name = json[:name]
-          item.used = json[:used] unless json[:used].nil?
-          item.zimbraMailQuota = json[:limit] unless json[:limit].nil?
-
-          formatted_json(json).each do |k, v|
-            valorise(item, k, v)
-          end
+          item.used = json.delete(:used) unless json[:used].nil?
+          item.zimbraMailQuota = json.delete(:limit) unless json[:limit].nil?
 
-          item
+          super
         end
       end
     end

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

@@ -5,7 +5,7 @@ module Zm
     # class factory [accounts]
     class AccountsBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :account
       end
 

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

@@ -8,19 +8,25 @@ module Zm
         @child_class = Account
         @builder_class = AccountsBuilder
         @search_type = SearchType::ACCOUNT
-        super(parent)
+        super
       end
 
       def find_by!(hash)
+        entry = sac.invoke(build_find_by(hash))[:GetAccountResponse][:account].first
+
+        reset_query_params
+        AccountJsnsInitializer.create(@parent, entry)
+      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).add_content(hash.values.first)
+        node_account = SoapElement.create(SoapConstants::ACCOUNT)
+                                  .add_attribute(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)
-        entry = sac.invoke(soap_request)[:GetAccountResponse][:account].first
-
-        reset_query_params
-        AccountJsnsInitializer.create(@parent, entry)
+        soap_request
       end
 
       def quotas(domain_name: @domain_name, target_server_id: @target_server_id)
@@ -40,10 +46,11 @@ module Zm
           sortBy: @sort_by,
           sortAscending: @sort_ascending,
           refresh: @refresh
-        }.delete_if { |_, value| value.nil? }
+        }
+        jsns.compact!
 
         soap_request = SoapElement.admin(SoapAdminConstants::GET_QUOTA_USAGE_REQUEST)
-        soap_request.add_attributes(jsns)
+                                  .add_attributes(jsns)
         json = sac.invoke(soap_request)
 
         sac.context.target_server(nil) unless target_server_id.nil?

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

@@ -13,7 +13,7 @@ module Zm
       attr_accessor :zid, :gt, :right, :d
 
       def create!
-        rep = @parent.sacc.invoke(jsns_builder.to_jsns)
+        rep = @parent.soap_connector.invoke(jsns_builder.to_jsns)
 
         json = rep[:GrantRightsResponse][:ace].first if rep[:GrantRightsResponse][:ace].is_a?(Array)
         AceJsnsInitializer.update(self, json) unless json.nil?
@@ -21,14 +21,14 @@ module Zm
       end
 
       def delete!
-        @parent.sacc.invoke(jsns_builder.to_delete)
+        @parent.soap_connector.invoke(jsns_builder.to_delete)
         true
       end
 
-      private
-
       def jsns_builder
-        @jsns_builder ||= AceJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = AceJsnsBuilder.new(self)
       end
     end
   end

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

@@ -13,24 +13,24 @@ module Zm
       end
 
       def to_jsns
-        soap_request = SoapElement.account(SoapAccountConstants::GRANT_RIGHTS_REQUEST)
-        soap_request.add_attribute(SoapConstants::ACE, attrs)
-        soap_request
+        SoapElement.account(SoapAccountConstants::GRANT_RIGHTS_REQUEST)
+                   .add_attribute(SoapConstants::ACE, attrs)
       end
 
       def to_delete
-        soap_request = SoapElement.account(SoapAccountConstants::REVOKE_RIGHTS_REQUEST)
-        soap_request.add_attribute(SoapConstants::ACE, attrs)
-        soap_request
+        SoapElement.account(SoapAccountConstants::REVOKE_RIGHTS_REQUEST)
+                   .add_attribute(SoapConstants::ACE, attrs)
       end
 
       def attrs
-        {
+        h = {
           zid: @item.zid,
           gt: @item.gt,
           right: @item.right,
           d: @item.d
-        }.reject { |_, v| v.nil? }
+        }
+        h.compact!
+        h
       end
     end
   end

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

@@ -6,16 +6,16 @@ module Zm
     class AceJsnsInitializer
       class << self
         def create(parent, json)
-          item = Ace.new(parent)
-
-          update(item, json)
+          Ace.new(parent).tap do |item|
+            update(item, json)
+          end
         end
 
         def update(item, json)
-          item.instance_variable_set(:@zid, json[:zid])
-          item.instance_variable_set(:@gt, json[:gt])
-          item.instance_variable_set(:@right, json[:right])
-          item.instance_variable_set(:@d, json[:d])
+          item.zid = json.delete(:zid)
+          item.gt = json.delete(:gt)
+          item.right = json.delete(:right)
+          item.d = json.delete(:d)
 
           item
         end

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

@@ -5,7 +5,7 @@ module Zm
     # class factory [aces]
     class AcesBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :ace
       end
 

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

@@ -43,7 +43,7 @@ module Zm
       end
 
       def initialize(parent)
-        super(parent)
+        super
         @child_class = Ace
         @builder_class = AcesBuilder
         @jsns_builder = AceJsnsBuilder.new(self)
@@ -60,7 +60,7 @@ module Zm
       private
 
       def make_query
-        @parent.sacc.invoke(@jsns_builder.to_find)
+        @parent.soap_connector.invoke(@jsns_builder.to_find)
       end
 
       def reset_query_params