zm-ruby-client 0.18.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9fad2347a2f7fa88c1da39a1e3dfdc85598e3dac8e7a060866b58da8fb1aa39
-  data.tar.gz: 30b9161ed034e763748918c47675bd4440eea099bfab0a70d4089691020b7860
+  metadata.gz: 0e22c8126c13210fc0be35b5358b30d5ae7cbf12118bffe8ad522e6fdc2a2379
+  data.tar.gz: 81eca4a1ef8efd633447c93bf782cd68e522a19db80f968475404aa3fca5c5cd
 SHA512:
-  metadata.gz: e6cd34015b3ebda5f628f27722d894ef30dc1b7e7cc9500fd91cbb63cf5d138f4aa1197b5681638945cf9c8b63bec5c7e4dbb426b7f3cee2cc11921581693a6f
-  data.tar.gz: 2da81cb383c52918038f3e586e781b6d917ecd356a8414ca0e5aa5616b6d9023689c7dc294fd9194471c474b117cd8f016aef293b1e8ff5433a4d0469bbc9b91
+  metadata.gz: 1c5a99d6ff59e84e662c6715fca60e03b0087874c9679bc71309430c78c8264afea3e21c3634d4734987a3306f18c48f59e7eb94802cc1185b80893cd8615c34
+  data.tar.gz: 44cba59215626852bf2e2dc0189f10164112ffca3fa8c1878815515fa2e5e8e1ce5943f6ee235a74f8883f8a8a4a5acc2c2df5f69994a61b12ebc29fbd3f28aa

data/.gitignore

@@ -16,7 +16,7 @@
 /.idea
 /zm-ruby-client.iml
 
-/examples
+#/examples
 /vendor
 
 # Used by dotenv library to load environment variables.

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
-ruby '>= 2.6'
+ruby ">= 2.7"
 
 gem 'addressable', '~> 2.8'
 gem 'curb', '~> 1.0'
-gem 'version_sorter', '~>2.3'
+gem 'version_sorter', '~> 2.3'

data/README.md

@@ -2,10 +2,17 @@
 
 Library to interface with Zimbra simply.
 
+Author: Maxime Désécot <maxime.desecot@gmail.com>
+
 ## Installation
 
+OS: Linux distribution LTS
+
+Language: Ruby2.7+
+
 ```bash
 sudo apt install make gcc curl libcurl4-openssl-dev
+gem install zm-ruby-client
 ```
 
 ## Examples of uses:

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

@@ -1,345 +1,68 @@
 # frozen_string_literal: true
 
-require 'zm/modules/common/account_common'
-# require_relative '../../modules/common/account_galsync'
-require 'zm/client/common'
-require 'zm/client/connector/rest_account'
-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/data_source'
-require 'zm/client/message'
-require 'zm/client/identity'
-require 'zm/client/upload'
-require 'addressable/uri'
+require 'zm/client/account/account_aliases_collection'
 
 module Zm
   module Client
     # objectClass: zimbraAccount
-    class Account < Base::AdminObject
-      attr_accessor :name, :id, :token, :home_url, :public_url, :password, :domainkey, :carLicense
+    class Account < Base::MailboxObject
+      # #################################################################
+      # Associations
+      # #################################################################
 
-      def initialize(parent)
-        extend(AccountCommon)
-        super(parent)
-        @grantee_type = 'usr'.freeze
-      end
-
-      def all_instance_variable_keys
-        AccountCommon::ZM_ACCOUNT_ATTRS
-      end
-
-      def rest_account_connector
-        @rest_account_connector ||= RestAccountConnector.new
-      end
-
-      alias rac rest_account_connector
-
-      def logged?
-        !@token.nil?
-      end
-
-      def login
-        if @parent.logged?
-          admin_login
-        else
-          account_login
-        end
-      end
-
-      def account_login
-        if password
-          account_login_password
-        else
-          account_login_preauth
-        end
-      end
-
-      def account_login_preauth
-        domain_key
-        raise ZmError, 'domain key is required to login !' if @domainkey.nil?
-
-        @token = sacc.auth_preauth(@name, @domainkey)
-      end
-
-      def account_login_password
-        raise ZmError, 'password is required to login !' if password.nil?
-
-        @token = sacc.auth_password(@name, @password)
-      end
-
-      def admin_login
-        @token = sac.delegate_auth(@name)
-      end
-
-      def token_metadata
-        @token_metadata ||= TokenMetaData.new(@token)
-      end
-
-      def domain_name
-        @domain_name ||= @name.split('@').last
-      end
-
-      def domain_key
-        @domainkey ||= @parent.domain_key(domain_name)
-      end
-
-      def domain_key=(key)
-        @domainkey = key
-      end
-
-      def infos
-        @infos || read_infos
-      end
-
-      def read_infos
-        @infos = sacc.get_info(@token)[:Body][:GetInfoResponse]
-        @id = @infos[:id]
-        @used = @infos[:used]
-        @public_url = @infos[:publicURL]
-        @zimbraCOSId = @infos[:cos][:id]
-        @home_url = @infos[:rest]
-        @infos
+      def aliases
+        @aliases ||= AccountAliasesCollection.new(self)
       end
 
       def cos
         @cos ||= @parent.coses.find_by(id: zimbraCOSId)
       end
 
-      def used
-        @used ||= sac.get_mailbox(id)[:Body][:GetMailboxResponse][:mbox].first[:s]
-      end
-
-      def public_url
-        infos if @infos.nil?
-        @public_url
-      end
-
-      def home_url
-        infos if @infos.nil?
-        @home_url
-      end
-
-      def messages
-        @messages ||= MessagesCollection.new(self)
-      end
-
-      def folders
-        @folders ||= FoldersCollection.new(self)
-      end
-
-      def mountpoints
-        @mountpointss ||= MountPointsCollection.new(self)
-      end
-
-      def search_folders
-        @search_folders ||= SearchFoldersCollection.new(self)
-      end
-
-      def identities
-        @identities ||= IdentitiesCollection.new(self)
-      end
-
-      def shares
-        @shares ||= SharesCollection.new(self)
-      end
-
-      def contacts
-        @contacts ||= ContactsCollection.new(self)
-      end
-
-      def appointments
-        @appointments ||= AppointmentsCollection.new(self)
-      end
-
-      def tags
-        @tags ||= TagsCollection.new(self)
-      end
-
-      def tasks
-        @tasks ||= TasksCollection.new(self)
-      end
-
-      def aces
-        @aces ||= AcesCollection.new(self)
-      end
-      alias rights aces
-
-      def signatures
-        @signatures ||= SignaturesCollection.new(self)
-      end
-
-      def data_sources
-        @data_sources ||= DataSourcesCollection.new sac, self
-      end
-
-      def documents
-        @documents ||= DocumentsCollection.new(self)
-      end
-
-      def message_folders
-        @message_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::MESSAGE.to_s }
-      end
-
-      def contact_folders
-        @contact_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::CONTACT.to_s }
-      end
-
-      def calendar_folders
-        @calendar_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::APPOINTMENT.to_s }
-      end
-
-      def task_folders
-        @task_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::TASK.to_s }
-      end
-
-      def document_folders
-        @document_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::DOCUMENT.to_s }
-      end
+      # #################################################################
+      # SOAP Actions
+      # #################################################################
 
       def delete!
-        sac.delete_account(@id)
-      end
-
-      def password!(new_password)
-        sac.set_password(@id, new_password)
-        @password = new_password
-      end
-
-      def update!(hash)
-        sac.modify_account(@id, hash)
-
-        hash.each do |k, v|
-          arrow_attr_sym = "@#{k}".to_sym
-
-          if v.respond_to?(:empty?) && v.empty?
-            self.remove_instance_variable(arrow_attr_sym) if self.instance_variable_get(arrow_attr_sym)
-          else
-            self.instance_variable_set(arrow_attr_sym, v)
-          end
-        end
+        sac.invoke(jsns_builder.to_delete)
+        @id = nil
       end
 
       def modify!
-        attrs_to_modify = instance_variables_array(attrs_write)
-        return if attrs_to_modify.empty?
-
-        sac.modify_account(@id, attrs_to_modify)
+        sac.invoke(jsns_builder.to_update)
+        true
       end
 
       def create!
-        rep = sac.create_account(
-          @name,
-          @password,
-          instance_variables_array(attrs_write)
-        )
-        @id = rep[:Body][:CreateAccountResponse][:account].first[:id]
-      end
-
-      def set_password(new_password = nil)
-        new_password ||= @password
-        sac.set_password(@id, new_password)
-        @password = new_password
-      end
-
-      def aliases
-        @aliases ||= set_aliases
-      end
-
-      def set_aliases
-        return [] if zimbraMailAlias.nil?
-        return [zimbraMailAlias] if zimbraMailAlias.is_a?(String)
-        zimbraMailAlias
-      end
-
-      def add_alias!(email)
-        sac.add_account_alias(@id, email)
-        aliases.push(email)
-      end
-
-      def remove_alias!(email)
-        sac.remove_account_alias(@id, email)
-        aliases.delete(email)
-      end
-
-      def rename!(email)
-        sac.rename_account(@id, email)
-        @name = email
-      end
-
-      def local_transport
-        raise Zm::Client::SoapError, 'zimbraMailHost is null' if zimbraMailHost.nil?
-
-        "lmtp:#{zimbraMailHost}:7025"
-      end
-
-      def local_transport!
-        update!(zimbraMailTransport: local_transport)
-      end
-
-      def is_local_transport?
-        return nil unless zimbraMailTransport
-
-        zimbraMailTransport.start_with?('lmtp')
-      end
-
-      def is_external_transport?
-        return nil unless zimbraMailTransport
-
-        zimbraMailTransport.start_with?('smtp')
-      end
-
-      def uploader
-        @uploader ||= Upload.new(self)
-      end
-
-      def last_logon
-        @last_logon ||= Time.parse zimbraLastLogonTimestamp unless zimbraLastLogonTimestamp.nil?
+        resp = sac.invoke(jsns_builder.to_create)
+        @id = resp[:CreateAccountResponse][:account].first[:id]
       end
 
       def created_at
-        @created_at ||= Time.parse zimbraCreateTimestamp unless zimbraCreateTimestamp.nil?
+        @created_at ||= Time.parse(zimbraCreateTimestamp) unless zimbraCreateTimestamp.nil?
       end
 
       def flush_cache!
-        sac.flush_cache('account', 1, @id)
-      end
-
-      def move_mailbox(server)
-        raise Zm::Client::SoapError, 'zimbraMailHost is null' if zimbraMailHost.nil?
-
-        sac.move_mailbox(@name, zimbraMailHost, server.name, server.id)
+        soap_request = SoapElement.admin(SoapAdminConstants::FLUSH_CACHE_REQUEST)
+        node_cache = SoapElement.create('cache').add_attributes({ type: SoapConstants::ACCOUNT, allServers: 1 })
+        soap_request.add_node(node_cache)
+        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
       end
 
-      def is_on_to_move?(server)
-        resp = sac.query_mailbox_move(@name, server.id)
-        resp[:Body][:QueryMailboxMoveResponse][:account].nil?
+      def attrs_write
+        @parent.zimbra_attributes.all_account_attrs_writable_names
       end
 
-      def memberships
-        @memberships ||= AccountDlsMembershipCollection.new(self)
-      end
-
-      def dls_owner
-        @dls_owner ||= AccountDlsOwnerCollection.new(self)
-      end
+      private
 
-      def ranking(op, email = nil)
-        sacc.ranking_action(@token, op, email)
+      def do_update!(hash)
+        sac.invoke(jsns_builder.to_patch(hash))
       end
 
-      def init_from_json(json)
-        @used = json[:used] if json[:used]
-        @zimbraMailQuota = json[:limit] if json[:limit]
-        super(json)
+      def jsns_builder
+        @jsns_builder ||= AccountJsnsBuilder.new(self)
       end
     end
   end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Account Aliases
+    class AccountAliasesCollection
+      def initialize(parent)
+        @parent = parent
+        build_aliases
+      end
+
+      def all
+        @parent.zimbraMailAlias
+      end
+
+      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)
+
+        all.push(email)
+        true
+      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)
+
+        all.delete(email)
+        true
+      end
+
+      private
+
+      def build_aliases
+        return if @parent.zimbraMailAlias.is_a?(Array)
+
+        if @parent.zimbraMailAlias.nil?
+          @parent.zimbraMailAlias = []
+          return
+        end
+
+        @parent.zimbraMailAlias = [@parent.zimbraMailAlias]
+      end
+    end
+  end
+end

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

@@ -11,7 +11,10 @@ module Zm
       private
 
       def make_query
-        @parent.sac.get_account_membership(@parent.id, :id)
+        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)
+        soap_request.add_node(node_account)
+        sac.invoke(soap_request)
       end
 
       def build_response

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

@@ -11,7 +11,14 @@ module Zm
       private
 
       def make_query
-        @parent.sac.search_directory("(zimbraACE=#{@parent.id} usr ownDistList)", SoapUtils::MAX_RESULT, nil, nil, nil, nil, nil, nil, SearchType::DL)
+        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)
       end
 
       def build_response

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for account jsns builder
+    class AccountJsnsBuilder
+      def initialize(item)
+        @item = item
+      end
+
+      def to_create
+        req = {
+          name: @item.name,
+          password: @item.password
+        }.reject { |_, v| v.nil? }
+
+        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_ACCOUNT_REQUEST).add_attributes(req)
+
+        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
+
+        soap_request
+      end
+
+      def to_update
+        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
+
+        soap_request
+      end
+
+      def to_patch(hash)
+        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)
+          end
+        end
+
+        soap_request
+      end
+
+      def to_delete
+        SoapElement.admin(SoapAdminConstants::DELETE_ACCOUNT_REQUEST).add_attribute('id', @item.id)
+      end
+
+      def attrs_only_set_h
+        selected_attrs = @item.attrs_write.map { |a| Utils.arrow_name_sym(a) }
+        attrs_only_set = @item.instance_variables & selected_attrs
+
+        arr = attrs_only_set.map do |name|
+          n = name.to_s[1..]
+          values = @item.instance_variable_get(name)
+          values = [values] unless values.is_a?(Array)
+          [n, values]
+        end
+
+        Hash[arr]
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Zm
   module Client
     # class for initialize account
-    class AccountJsnsInitializer
+    class AccountJsnsInitializer < Base::BaseJsnsInitializer
       class << self
         def create(parent, json)
           item = Account.new(parent)
@@ -12,29 +12,14 @@ module Zm
         end
 
         def update(item, json)
-
-          # attr_types_h = item.parent.zimbra_attributes.all_account_attr_types_h
-
-          # puts attr_types_h
-
-          item.id    = json[:id]
-          item.name  = json[:name]
-
-          json[:a]&.reject! { |n| n[:n].nil? }
-          # json_map = Hash[json[:a].map { |n| [n[:n], n[:_content]] }].freeze
-
-          # puts json_map
-
-          # item.parent.zimbra_attributes.all_account_attrs.each do |attr|
-          #   if attr.type.nil?
-          #     # p attr
-          #   else
-          #     json_field = json_map[attr.name]
-          #     puts json_field unless json_field.nil?
-          #   end
-          # end
-
-          item.init_from_json(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
         end

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

@@ -6,7 +6,6 @@ module Zm
     class AccountsBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
         super(parent, json)
-        @child_class = Account
         @json_item_key = :account
       end
 

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

@@ -11,19 +11,43 @@ module Zm
         super(parent)
       end
 
-      def find_by(hash)
-        rep = sac.get_account(hash.values.first, hash.keys.first, attrs_comma, @apply_cos)
-        entry = rep[:Body][:GetAccountResponse][:account].first
-        # puts entry
+      def 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)
+        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
-        build_from_entry(entry)
+        AccountJsnsInitializer.create(@parent, entry)
       end
 
-      def quotas
-        return nil if @domain_name.nil? && @target_server_id.nil?
+      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
+
+        jsns = {
+          domain: domain_name,
+          allServers: @all_servers,
+          limit: @limit,
+          offset: @offset,
+          sortBy: @sort_by,
+          sortAscending: @sort_ascending,
+          refresh: @refresh
+        }.delete_if { |_, value| value.nil? }
+
+        soap_request = SoapElement.admin(SoapAdminConstants::GET_QUOTA_USAGE_REQUEST)
+        soap_request.add_attributes(jsns)
+        json = sac.invoke(soap_request)
+
+        sac.context.target_server(nil) unless target_server_id.nil?
 
-        json = sac.get_quota_usage(@domain_name, @all_servers, @limit, @offset, @sort_by, @sort_ascending, @refresh, @target_server_id)
         reset_query_params
         @builder_class.new(@parent, json).make
       end