zm-ruby-client 0.14.0 → 0.18.0

data/lib/zm/client/cluster/cluster.rb

@@ -4,31 +4,48 @@ require 'zm/client/connector/soap_admin'
 require 'zm/client/connector/soap_account'
 require 'zm/client/common'
 # require 'zm/client/data_source'
-require 'zm/client/domain'
 require 'zm/client/account'
+require 'zm/client/domain'
 require 'zm/client/resource'
 require 'zm/client/distributionlist'
 require 'zm/client/server'
 require 'zm/client/cos'
 require 'zm/client/license'
-# require 'zm/client/distributionlist'
 
 module Zm
   module Client
     # class admin connection
     class Cluster
-      attr_reader :soap_admin_connector, :config
+
+      attr_reader :soap_admin_connector, :config, :zimbra_attributes
+
+      attr_reader :type, :version, :release, :buildDate, :host, :majorversion, :minorversion, :microversion
 
       def initialize(config)
+        extend(ZmLogger)
+
         @config = config
+        @version = config.zimbra_version
+
+        @zimbra_attributes = Base::ZimbraAttributesCollection.new(self)
+        @zimbra_attributes.set_methods
+
         @soap_admin_connector = SoapAdminConnector.new(
           @config.zimbra_admin_scheme,
           @config.zimbra_admin_host,
           @config.zimbra_admin_port
         )
+        @soap_admin_connector.logger = logger
+      end
+
+      def has_admin_credentials?
+        @config.has_admin_credentials?
       end
 
       def login
+        raise ClusterConfigError, 'admin credentials are missing' unless @config.has_admin_credentials?
+
+        logger.info "Get Admin session token"
         @soap_admin_connector.auth(
           @config.zimbra_admin_login,
           @config.zimbra_admin_password
@@ -42,16 +59,21 @@ module Zm
       def alive?
         @soap_admin_connector.noop
         true
-      rescue Zm::Client::SoapError => _
+      rescue Zm::Client::SoapError => e
+        logger.error "Admin session token alive ? #{e.message}"
         false
       end
 
       def soap_account_connector
-        @soap_account_connector ||= SoapAccountConnector.new(
+        return @soap_account_connector unless @soap_account_connector.nil?
+
+        @soap_account_connector = SoapAccountConnector.new(
           @config.zimbra_public_scheme,
           @config.zimbra_public_host,
           @config.zimbra_public_port
         )
+        @soap_account_connector.logger = logger
+        @soap_account_connector
       end
 
       def token_metadata
@@ -61,7 +83,7 @@ module Zm
       def license
         @license ||= LicensesCollection.new(self).find
       rescue Zm::Client::SoapError => e
-        puts e.message
+        logger.error "Get License info #{e.message}"
         nil
       end
 
@@ -111,10 +133,24 @@ module Zm
         !num.zero?
       end
 
+      def infos!
+        rep = soap_admin_connector.get_version_info
+        json = rep[:Body][:GetVersionInfoResponse][:info].first
+
+        instance_variable_set(:@type, json[:type])
+        instance_variable_set(:@version, json[:version])
+        instance_variable_set(:@release, json[:release])
+        instance_variable_set(:@buildDate, json[:buildDate])
+        instance_variable_set(:@host, json[:host])
+        instance_variable_set(:@majorversion, json[:majorversion])
+        instance_variable_set(:@minorversion, json[:minorversion])
+        instance_variable_set(:@microversion, json[:microversion])
+      end
+
       private
 
       def find_domain_key(domain_name)
-        domains.find_by({ name: domain_name }, 'zimbraPreAuthKey').zimbraPreAuthKey
+        domains.attrs('zimbraPreAuthKey').find_by(name: domain_name).zimbraPreAuthKey
       end
     end
   end

data/lib/zm/client/cluster/cluster_config.rb

@@ -11,18 +11,16 @@ module Zm
                     :zimbra_admin_port, :zimbra_admin_login,
                     :zimbra_admin_password, :zimbra_public_host,
                     :zimbra_public_scheme, :zimbra_public_port,
-                    :domains
+                    :domains, :zimbra_version
 
       def initialize(parameters = nil)
-        @zimbra_admin_scheme = 'https'
-        @zimbra_admin_port = 7071
-        @zimbra_public_scheme = 'https'
-        @zimbra_public_port = 443
         @domains = []
+        @zimbra_version = '8.8.15'
 
-        if parameters.is_a?(String)
+        case parameters
+        when String
           init_from_file(parameters)
-        elsif parameters.is_a?(Hash)
+        when Hash
           @to_h = parameters
         end
 
@@ -45,14 +43,15 @@ module Zm
       end
 
       def init_from_h
-        @zimbra_admin_host = @to_h[:zimbra_admin_host] unless @to_h[:zimbra_admin_host].nil?
-        @zimbra_admin_scheme = @to_h[:zimbra_admin_scheme] unless @to_h[:zimbra_admin_scheme].nil?
-        @zimbra_admin_port = @to_h[:zimbra_admin_port] unless @to_h[:zimbra_admin_port].nil?
-        @zimbra_admin_login = @to_h[:zimbra_admin_login] unless @to_h[:zimbra_admin_login].nil?
-        @zimbra_admin_password = @to_h[:zimbra_admin_password] unless @to_h[:zimbra_admin_password].nil?
-        @zimbra_public_host = @to_h[:zimbra_public_host] unless @to_h[:zimbra_public_host].nil?
-        @zimbra_public_scheme = @to_h[:zimbra_public_scheme] unless @to_h[:zimbra_public_scheme].nil?
-        @zimbra_public_port = @to_h[:zimbra_public_port] unless @to_h[:zimbra_public_port].nil?
+        @zimbra_admin_host = @to_h.fetch(:zimbra_admin_host, nil)
+        @zimbra_admin_scheme = @to_h.fetch(:zimbra_admin_scheme, 'https')
+        @zimbra_admin_port = @to_h.fetch(:zimbra_admin_port, 7071)
+        @zimbra_admin_login = @to_h.fetch(:zimbra_admin_login, nil)
+        @zimbra_admin_password = @to_h.fetch(:zimbra_admin_password, nil)
+        @zimbra_public_host = @to_h.fetch(:zimbra_public_host, nil)
+        @zimbra_public_scheme = @to_h.fetch(:zimbra_public_scheme, 'https')
+        @zimbra_public_port = @to_h.fetch(:zimbra_public_port, 443)
+        @zimbra_version = @to_h.fetch(:zimbra_version, '8.8.15')
       end
 
       def init_from_yml(file_config_path)
@@ -81,6 +80,10 @@ module Zm
 
         domain.key
       end
+
+      def has_admin_credentials?
+        !@zimbra_admin_host.nil? && !@zimbra_admin_login.nil? && !@zimbra_admin_password.nil?
+      end
     end
 
     # class config for connection
@@ -94,7 +97,6 @@ module Zm
     end
 
     # class error for config
-    class ClusterConfigError < StandardError
-    end
+    class ClusterConfigError < StandardError; end
   end
 end

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

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'openssl'
-require 'curb'
-
 module Zm
   module Client
     class RestAccountConnector

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

@@ -2,25 +2,18 @@
 
 require_relative 'soap_base'
 require_relative 'soap_error'
-require 'gyoku'
-
-# include OpenSSL
-# include Digest
 
 module Zm
   module Client
     class SoapAccountConnector < SoapBaseConnector
-
-      SOAP_PATH = '/service/soap/'
       MAILSPACE = 'urn:zimbraMail'
       ACCOUNTSPACE = 'urn:zimbraAccount'
-      A_NODE_PROC = lambda { |n| { n: n.first, _content: n.last } }
-      A_NODE_PROC_NAME = lambda { |n| { name: n.first, _content: n.last } }
-      A_NODE_PROC_ARROW_NAME = lambda { |n| { :@name => n.first, content!: n.last } }
+      A_NODE_PROC = ->(n) { { n: n.first, _content: n.last } }
+      A_NODE_PROC_NAME = ->(n) { { name: n.first, _content: n.last } }
+      A_NODE_PROC_ARROW_NAME = ->(n) { { :@name => n.first, content!: n.last } }
 
       def initialize(scheme, host, port)
-        @uri = URI::HTTP.new(scheme, nil, host, port, nil, SOAP_PATH, nil, nil, nil)
-        init_curl_client
+        super(scheme, host, port, '/service/soap/')
       end
 
       def auth_template(mail)
@@ -174,75 +167,41 @@ module Zm
       # -------------------------------
       # FOLDER
 
-      def get_folder(token, id)
-        soap_name = :GetFolderRequest
-        body = init_hash_request(token, soap_name)
-        req = { folder: { l: id } }
-        body[:Body][soap_name].merge!(req)
-        curl_request(body)
+      def get_folder(token, jsns)
+        jsns_request(:GetFolderRequest, token, jsns)
       end
 
-      def get_all_folders(token, view = nil, tr = nil)
-        soap_name = :GetFolderRequest
-        body = init_hash_request(token, soap_name)
-        req = { view: view, tr: tr }.reject { |_, v| v.nil? }
-        body[:Body][soap_name].merge!(req)
-        curl_request(body)
-      end
+      # def get_all_folders(token, view = nil, tr = nil)
+      #   soap_name = :GetFolderRequest
+      #   body = init_hash_request(token, soap_name)
+      #   req = { view: view, tr: tr }.reject { |_, v| v.nil? }
+      #   body[:Body][soap_name].merge!(req)
+      #   curl_request(body)
+      # end
 
-      def create_folder(token, folder_options)
-        soap_name = :CreateFolderRequest
-        # folder = { l: parent_id, name: name, view: view, color: color }.merge(options)
-        req = { folder: folder_options }
-        body = init_hash_request(token, soap_name)
-        body[:Body][soap_name].merge!(req)
-        curl_request(body)
+      def create_folder(token, jsns)
+        jsns_request(:CreateFolderRequest, token, jsns)
       end
 
-      def folder_action(token, op, id, options = {})
-        soap_name = :FolderActionRequest
-        action = { op: op, id: id }.merge(options)
-        req = { action: action }
-        body = init_hash_request(token, soap_name)
-        body[:Body][soap_name].merge!(req)
-        curl_request(body)
+      def folder_action(token, jsns)
+        jsns_request(:FolderActionRequest, token, jsns)
       end
 
       def get_all_search_folders(token)
-        body = init_hash_request(token, :GetSearchFolderRequest)
+        soap_name = :GetSearchFolderRequest
+        body = init_hash_request(token, soap_name)
         curl_request(body)
       end
 
       # -------------------------------
       # SEARCH FOLDER
 
-      def create_search_folder(token, name, query, types = 'messages', l = 1, color = nil, sort_by = nil)
-        search = {
-            name: name,
-            query: query,
-            types: types,
-            sortBy: sort_by,
-            color: color,
-            l: l
-        }.reject { |_, v| v.nil? }
-
-        req = { search: search }
-        body = init_hash_request(token, :CreateSearchFolderRequest)
-        body[:Body][:CreateSearchFolderRequest].merge!(req)
-        curl_request(body)
+      def create_search_folder(token, jsns)
+        jsns_request(:CreateSearchFolderRequest, token, jsns)
       end
 
-      def modify_search_folder(token, id, query, types = 'messages')
-        search = {
-          id: id,
-          query: query,
-          types: types
-        }.reject { |_, v| v.nil? }
-
-        req = { search: search }
-        body = init_hash_request(token, :ModifySearchFolderRequest)
-        body[:Body][:ModifySearchFolderRequest].merge!(req)
-        curl_request(body)
+      def modify_search_folder(token, jsns)
+        jsns_request(:ModifySearchFolderRequest, token, jsns)
       end
 
       # -------------------------------
@@ -266,12 +225,8 @@ module Zm
       # -------------------------------
       # SHARE
 
-      def create_mountpoint(token, link_option)
-        soap_name = :CreateMountpointRequest
-        req = { link: link_option }
-        body = init_hash_request(token, soap_name)
-        body[:Body][soap_name].merge!(req)
-        curl_request(body)
+      def create_mountpoint(token, jsns)
+        jsns_request(:CreateMountpointRequest, token, jsns)
       end
 
       def get_share_info(token, options = {})
@@ -282,49 +237,16 @@ module Zm
         curl_request(body)
       end
 
-      def get_rights(token, rights)
-        soap_name = :GetRightsRequest
-        ace = rights.map { |r| { right: r } }
-        req = { ace: ace }
-        body = init_hash_request(token, soap_name, ACCOUNTSPACE)
-        body[:Body][soap_name].merge!(req)
-        curl_request(body)
+      def get_rights(token, jsns)
+        jsns_request(:GetRightsRequest, token, jsns, ACCOUNTSPACE)
       end
 
-      def grant_rights(token, zid = nil, gt = nil, right = nil, d = nil, key = nil, pw = nil, deny = nil, chkgt = nil)
-        ace = {
-          zid: zid,
-          gt: gt,
-          right: right,
-          d: d,
-          key: key,
-          pw: pw,
-          deny: deny,
-          chkgt: chkgt
-        }.reject { |_, v| v.nil? }
-
-        req = { ace: ace }
-        body = init_hash_request(token, :GrantRightsRequest, ACCOUNTSPACE)
-        body[:Body][:GrantRightsRequest].merge!(req)
-        curl_request(body)
+      def grant_rights(token, jsns)
+        jsns_request(:GrantRightsRequest, token, jsns, ACCOUNTSPACE)
       end
 
-      def revoke_rights(token, zid = nil, gt = nil, right = nil, d = nil, key = nil, pw = nil, deny = nil, chkgt = nil)
-        ace = {
-          zid: zid,
-          gt: gt,
-          right: right,
-          d: d,
-          key: key,
-          pw: pw,
-          deny: deny,
-          chkgt: chkgt
-        }.reject { |_, v| v.nil? }
-
-        req = { ace: ace }
-        body = init_hash_request(token, :RevokeRightsRequest, ACCOUNTSPACE)
-        body[:Body][:RevokeRightsRequest].merge!(req)
-        curl_request(body)
+      def revoke_rights(token, jsns)
+        jsns_request(:RevokeRightsRequest, token, jsns, ACCOUNTSPACE)
       end
 
       # -------------------------------
@@ -332,7 +254,7 @@ module Zm
 
       def get_msg(token, id, options = {})
         req = { m: { id: id } }
-        req[:m].merge(options) unless options.empty?
+        req[:m].merge!(options) unless options.empty?
         body = init_hash_request(token, :GetMsgRequest)
         body[:Body][:GetMsgRequest].merge!(req)
         curl_request(body)
@@ -350,7 +272,7 @@ module Zm
         req = { m: m }
         body = init_hash_request(token, :SendMsgRequest)
         body[:Body][:SendMsgRequest].merge!(req)
-        curl_request(body)
+        # curl_request(body)
       end
 
       def add_msg(token, l, eml, d = nil, f = nil, tn = nil)
@@ -378,19 +300,12 @@ module Zm
         curl_request(body)
       end
 
-      def create_tag(token, name, color, rgb)
-        body = init_hash_request(token, :CreateTagRequest)
-        req = { tag: { name: name, color: color, rgb: rgb }.reject { |_, v| v.nil? } }
-        body[:Body][:CreateTagRequest].merge!(req)
-        curl_request(body)
+      def create_tag(token, jsns)
+        jsns_request(:CreateTagRequest, token, jsns)
       end
 
-      def tag_action(token, op, id, options = {})
-        action = { op: op, id: id }.merge(options)
-        req = { action: action }
-        body = init_hash_request(token, :TagActionRequest)
-        body[:Body][:TagActionRequest].merge!(req)
-        curl_request(body)
+      def tag_action(token, jsns)
+        jsns_request(:TagActionRequest, token, jsns)
       end
 
       # -------------------------------
@@ -401,26 +316,20 @@ module Zm
         curl_request(body)
       end
 
-      def create_identity(token, name, attrs = [])
+      def create_identity(token, name, attrs = {})
         soap_name = :CreateIdentityRequest
-        req = { identity: { :@name => name, a: attrs.to_a.map(&A_NODE_PROC_ARROW_NAME) } }
-        body = init_hash_arrow_request(token, soap_name, ACCOUNTSPACE)
-        body[:Envelope][:Body][soap_name].merge!(req)
-        body_xml = Gyoku.xml(body, { :key_converter => :none })
-        # puts body_xml
-        # todo ne fonctionne pas en JS !
-        curl_xml(body_xml)
+        req = { identity: { name: name, _attrs: attrs } }
+        body = init_hash_request(token, soap_name, ACCOUNTSPACE)
+        body[:Body][soap_name].merge!(req)
+        curl_request(body)
       end
 
-      def modify_identity(token, id, attrs = [])
+      def modify_identity(token, id, attrs = {})
         soap_name = :ModifyIdentityRequest
-        req = { identity: { :@id => id, a: attrs.to_a.map(&A_NODE_PROC_ARROW_NAME) } }
-        body = init_hash_arrow_request(token, soap_name, ACCOUNTSPACE)
-        body[:Envelope][:Body][soap_name].merge!(req)
-        body_xml = Gyoku.xml(body, { :key_converter => :none })
-        # puts body_xml
-        # todo ne fonctionne pas en JS !
-        curl_xml(body_xml)
+        req = { identity: { id: id, _attrs: attrs } }
+        body = init_hash_request(token, soap_name, ACCOUNTSPACE)
+        body[:Body][soap_name].merge!(req)
+        curl_request(body)
       end
 
       def delete_identity(token, id)
@@ -441,18 +350,6 @@ module Zm
         curl_request(body)
       end
 
-      def modify_prefs(token, prefs)
-        soap_name = :ModifyPrefsRequest
-        req = { pref: prefs.map { |pref, value| { name: pref, _content: value } } }
-        body = init_hash_request(token, soap_name, ACCOUNTSPACE)
-        body[:Body][soap_name].merge!(req) if req.any?
-        #puts body
-        #curl_request(body)
-        #puts SoapXmlBuilder.new(body).to_xml
-        # todo ne fonctionne pas en JS !
-        curl_xml(SoapXmlBuilder.new(body).to_xml)
-      end
-
       def get_filter_rules(token)
         soap_name = :GetFilterRulesRequest
         body = init_hash_request(token, soap_name)
@@ -487,18 +384,17 @@ module Zm
         curl_request(body)
       end
 
-      def delete_signature(token, id)
+      def delete_signature(token, jsns)
         soap_name = :DeleteSignatureRequest
-        req = { signature: { id: id } }
         body = init_hash_request(token, soap_name, ACCOUNTSPACE)
-        body[:Body][soap_name].merge!(req)
+        body[:Body][soap_name].merge!(jsns)
         curl_request(body)
       end
 
       # -------------------------------
       # GENERIC
 
-      def get_info(token, sections = 'mbox', rights = nil)
+      def get_info(token, sections = 'mbox,prefs,attrs,zimlets,props,idents,sigs,dsrcs,children', rights = nil)
         req = { rights: rights, sections: sections }.reject { |_, v| v.nil? }
         body = init_hash_request(token, :GetInfoRequest, ACCOUNTSPACE)
         body[:Body][:GetInfoRequest].merge!(req) if req.any?
@@ -513,7 +409,8 @@ module Zm
           offset: offset,
           limit: limit,
           sortBy: sortBy,
-          query: query
+          query: query,
+          header: [{ n: 'messageIdHeader' }]
         }.merge!(options)
         req.reject! { |_, v| v.nil? }
 
@@ -522,6 +419,28 @@ module Zm
         curl_request(body)
       end
 
+      def jsns_request(soap_name, token, jsns, namespace = MAILSPACE)
+        body = init_hash_request(token, soap_name, namespace)
+        body[:Body][soap_name].merge!(jsns) if jsns.is_a?(Hash)
+        curl_request(body)
+      end
+
+      def ranking_action(token, op, email = nil)
+        soap_name = :RankingActionRequest
+        req = {
+          action: {
+            op: op,
+            email: email
+          }
+        }
+        req[:action].delete_if { |_, v| v.nil? }
+
+        body = init_hash_request(token, soap_name)
+        body[:Body][soap_name].merge!(req) if req.any?
+
+        curl_request(body)
+      end
+
       private
 
       def compute_preauth(mail, ts, domainkey)
@@ -531,33 +450,13 @@ module Zm
         hmac.to_s
       end
 
-      def init_hash_request(token, soap_name, jsns = MAILSPACE)
+      def init_hash_request(token, soap_name, namespace = MAILSPACE)
         {
           Body: {
-            soap_name => { _jsns: jsns }
+            soap_name => { _jsns: namespace }
           }
         }.merge(hash_header(token))
       end
-
-      def init_hash_arrow_request(token, soap_name, jsns = MAILSPACE)
-        { Envelope: {
-            :@xmlns => 'http://schemas.xmlsoap.org/soap/envelope/',
-            '@xmlns:urn' => 'urn:zimbra',
-            Header: {
-              context: {
-                authToken: token,
-                :@xmlns => BASESPACE,
-                format: {
-                    :@type => 'js'
-                }
-              }
-            },
-            Body: {
-              soap_name => { :@xmlns => jsns }
-            }
-          }
-        }
-      end
     end
   end
 end