zm-ruby-client 0.18.3 → 2.0.2

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

@@ -6,31 +6,175 @@ module Zm
   module Client
     module Base
       class ZimbraAttributesCollection
-        attr_reader :all
+        include MissingMethodStaticCollection
+
+        ZIMBRA_ATTRS_PATH = "#{File.dirname(__FILE__)}../../../modules/common/zimbra-attrs.json"
+
+        attr_reader :all_versioned
 
         def initialize(parent)
           @parent = parent
-          @all = JSON.parse(File.read(File.expand_path(File.dirname(__FILE__) + '../../../modules/common/zimbra-attrs.json')), object_class: ZimbraAttribute).freeze
+
+          @all = JSON.parse(File.read(File.expand_path(ZIMBRA_ATTRS_PATH)), object_class: ZimbraAttribute).select do |attr|
+            attr.version_start == @parent.version || VersionSorter.sort([@parent.version, attr.version_start]).first != @parent.version
+          end.freeze
         end
 
         def set_methods
-          all_account_attrs = all_account_attrs_version(@parent.version)
-          Account.attr_reader *all_account_attrs.select { |attr| attr.immutable }.map { |attr| attr.name.to_sym }
-          Account.attr_accessor *all_account_attrs.reject { |attr| attr.immutable }.map { |attr| attr.name.to_sym }
+          set_server_methods
+          set_cos_methods
+          set_domain_methods
+          set_account_methods
+          set_distributionlist_methods
+          set_resource_methods
+        end
+
+        # ###############################
+        # Cos
+        # ###############################
+
+        def all_cos_attrs
+          @all_cos_attrs ||= @all.select(&:is_cos_scoped?).freeze
+        end
+
+        def all_cos_attrs_writable
+          @all_cos_attrs_writable ||= all_cos_attrs.reject(&:immutable?).freeze
+        end
+
+        def all_cos_attrs_writable_names
+          @all_cos_attrs_writable_names ||= all_cos_attrs_writable.map(&:name).freeze
+        end
+
+        def all_cos_attr_types_h
+          @all_cos_attr_types_h ||= Hash[all_cos_attrs.map { |attr| [attr.name, attr.type] }].freeze
+        end
+
+        def set_cos_methods
+          Cos.attr_accessor(*all_cos_attrs.map { |attr| attr.name.to_sym })
+        end
+
+        # ###############################
+        # Server
+        # ###############################
+
+        def all_server_attrs
+          @all_server_attrs ||= @all.select(&:is_server_scoped?).freeze
+        end
+
+        def all_server_attrs_writable
+          @all_server_attrs_writable ||= all_server_attrs.reject(&:immutable?).freeze
+        end
+
+        def all_server_attrs_writable_names
+          @all_server_attrs_writable_names ||= all_server_attrs_writable.map(&:name).freeze
+        end
+
+        def all_server_attr_types_h
+          @all_server_attr_types_h ||= Hash[all_server_attrs.map { |attr| [attr.name, attr.type] }].freeze
+        end
+
+        def set_server_methods
+          Server.attr_accessor(*all_server_attrs.map { |attr| attr.name.to_sym })
+        end
+
+        # ###############################
+        # Domain
+        # ###############################
+
+        def all_domain_attrs
+          @all_domain_attrs ||= @all.select(&:is_domain_scoped?).freeze
+        end
+
+        def all_domain_attrs_writable
+          @all_domain_attrs_writable ||= all_domain_attrs.reject(&:immutable?).freeze
+        end
+
+        def all_domain_attrs_writable_names
+          @all_domain_attrs_writable_names ||= all_domain_attrs_writable.map(&:name).freeze
         end
 
+        def all_domain_attr_types_h
+          @all_domain_attr_types_h ||= Hash[all_domain_attrs.map { |attr| [attr.name, attr.type] }].freeze
+        end
+
+        def set_domain_methods
+          Domain.attr_accessor(*all_domain_attrs.map { |attr| attr.name.to_sym })
+        end
+
+        # ###############################
+        # Account
+        # ###############################
+
         def all_account_attrs
-          @all_account_attrs ||= @all.select { |attr| attr.is_account_scoped? }.freeze
+          @all_account_attrs ||= @all.select { |attr| attr.is_account_scoped? || attr.is_mailRecipient_scoped? }.freeze
+        end
+
+        def all_account_attrs_writable
+          @all_account_attrs_writable ||= all_account_attrs.reject(&:immutable?).freeze
+        end
+
+        def all_account_attrs_writable_names
+          @all_account_attrs_writable_names ||= all_account_attrs_writable.map(&:name).freeze
         end
 
         def all_account_attr_types_h
           @all_account_attr_types_h ||= Hash[all_account_attrs.map { |attr| [attr.name, attr.type] }].freeze
         end
 
-        # retourne tous les attributs qui ont une version
-        # inférieure ou égale à la version données en paramètre
-        def all_account_attrs_version(version)
-          all_account_attrs.select { |attr| attr.version_start == version || VersionSorter.sort([version, attr.version_start]).first != version }
+        def set_account_methods
+          Account.attr_accessor(*all_account_attrs.map { |attr| attr.name.to_sym })
+        end
+
+        # ###############################
+        # Distribution List
+        # ###############################
+
+        def all_distributionlist_attrs
+          @all_distributionlist_attrs ||= @all.select do |attr|
+            attr.is_distributionList_scoped? || attr.is_group_scoped? || attr.is_groupDynamicUnit_scoped? || attr.is_groupStaticUnit_scoped?
+          end.freeze
+        end
+
+        def all_distributionlist_attrs_writable
+          @all_distributionlist_attrs_writable ||= all_distributionlist_attrs.reject(&:immutable?).freeze
+        end
+
+        def all_distributionlist_attrs_writable_names
+          @all_distributionlist_attrs_writable_names ||= all_distributionlist_attrs_writable.map(&:name).freeze
+        end
+
+        def all_distributionlist_attrs_types_h
+          @all_distributionlist_attrs_types_h ||= Hash[all_distributionlist_attrs.map do |attr|
+                                                         [attr.name, attr.type]
+                                                       end].freeze
+        end
+
+        def set_distributionlist_methods
+          DistributionList.attr_accessor(*all_distributionlist_attrs.map { |attr| attr.name.to_sym })
+        end
+
+        # ###############################
+        # Calendar Resource
+        # ###############################
+
+        def all_resource_attrs
+          @all_resource_attrs ||= @all.select(&:is_calendarResource_scoped?).freeze
+        end
+
+        def all_resource_attrs_writable
+          @all_resource_attrs_writable ||= all_resource_attrs.reject(&:immutable?).freeze
+        end
+
+        def all_resource_attrs_writable_names
+          @all_resource_attrs_writable_names ||= all_resource_attrs_writable.map(&:name).freeze
+        end
+
+        def all_resource_attrs_types_h
+          @all_resource_attrs_types_h ||= Hash[all_resource_attrs.map { |attr| [attr.name, attr.type] }].freeze
+        end
+
+        def set_resource_methods
+          Resource.attr_accessor(*all_resource_attrs.map { |attr| attr.name.to_sym })
         end
       end
     end

data/lib/zm/client/base.rb

@@ -4,19 +4,19 @@ require 'curb'
 require 'logger'
 require 'openssl'
 
-require 'zm/modules/zm_logger'
-require 'zm/modules/zm_model'
+require 'zm/modules/base'
 
 require 'zm/client/base/zimbra_attributes_collection'
 require 'zm/client/base/object'
-require 'zm/client/base/account_object'
-require 'zm/client/base/folder_object'
+require 'zm/client/base/base_account_jsns_builder'
 require 'zm/client/base/base_jsns_builder'
 require 'zm/client/base/base_jsns_initializer'
-require 'zm/client/base/admin_object'
 require 'zm/client/base/objects_builder'
 require 'zm/client/base/objects_collection'
 require 'zm/client/base/admin_objects_collection'
 require 'zm/client/base/account_objects_collection'
 require 'zm/client/base/account_search_objects_collection'
 require 'zm/client/base/ldap_filter'
+require 'zm/client/base/mailbox_object'
+require 'zm/client/base/mailbox_infos_collection'
+require 'zm/client/base/mailbox_prefs_collection'

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

@@ -3,11 +3,10 @@
 require 'zm/client/connector/soap_admin'
 require 'zm/client/connector/soap_account'
 require 'zm/client/common'
-# require 'zm/client/data_source'
 require 'zm/client/account'
-require 'zm/client/domain'
 require 'zm/client/resource'
 require 'zm/client/distributionlist'
+require 'zm/client/domain'
 require 'zm/client/server'
 require 'zm/client/cos'
 require 'zm/client/license'
@@ -16,13 +15,11 @@ module Zm
   module Client
     # class admin connection
     class Cluster
-
-      attr_reader :soap_admin_connector, :config, :zimbra_attributes
-
-      attr_reader :type, :version, :release, :buildDate, :host, :majorversion, :minorversion, :microversion
+      attr_reader :soap_admin_connector, :config, :zimbra_attributes, :type, :version, :release, :buildDate, :host,
+                  :majorversion, :minorversion, :microversion
 
       def initialize(config)
-        extend(ZmLogger)
+        # extend(ZmLogger)
 
         @config = config
         @version = config.zimbra_version
@@ -30,26 +27,30 @@ module Zm
         @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
+        @soap_admin_connector = SoapAdminConnector.create(@config)
       end
 
       def has_admin_credentials?
         @config.has_admin_credentials?
       end
 
+      def token
+        @soap_admin_connector.token
+      end
+
+      def token=(value)
+        @soap_admin_connector.token= value
+      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
-        )
+        logger.info 'Get Admin session token'
+
+        soap_request = SoapElement.admin(SoapAdminConstants::AUTH_REQUEST)
+        soap_request.add_attributes(name: @config.zimbra_admin_login, password: @config.zimbra_admin_password)
+        soap_resp = @soap_admin_connector.invoke(soap_request, Zm::Client::AuthError)
+        @soap_admin_connector.context.token(soap_resp[:AuthResponse][:authToken].first[:_content])
       end
 
       def logged?
@@ -57,25 +58,14 @@ module Zm
       end
 
       def alive?
-        @soap_admin_connector.noop
+        soap_request = SoapElement.admin(SoapAdminConstants::NO_OP_REQUEST)
+        @soap_admin_connector.invoke(soap_request)
         true
       rescue Zm::Client::SoapError => e
         logger.error "Admin session token alive ? #{e.message}"
         false
       end
 
-      def soap_account_connector
-        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
         @token_metadata ||= TokenMetaData.new(@soap_admin_connector.token)
       end
@@ -122,20 +112,30 @@ module Zm
       def count_object(type)
         raise ZmError, 'Unknown object type' unless Zm::Client::CountTypes::ALL.include?(type)
 
-        resp = soap_admin_connector.count_object(type)
-        resp[:Body][:CountObjectsResponse][:num]
+        soap_request = SoapElement.admin(SoapAdminConstants::COUNT_OBJECTS_REQUEST)
+        soap_request.add_attribute('type', type)
+        soap_resp = @soap_admin_connector.invoke(soap_request)
+        soap_resp[:CountObjectsResponse][:num]
       end
 
       def email_exist?(email)
-        filter = "(mail=#{email})"
-        resp = soap_admin_connector.search_directory(filter, nil, nil, nil, nil, nil, nil, nil, 'accounts,distributionlists,aliases,resources',nil, 1)
-        num = resp[:Body][:SearchDirectoryResponse][:num]
-        !num.zero?
+        jsns = {
+          query: "(mail=#{email})",
+          types: 'accounts,distributionlists,aliases,resources',
+          countOnly: SoapUtils::ON
+        }
+
+        soap_request = SoapElement.admin(SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
+        soap_request.add_attributes(jsns)
+        soap_resp = @soap_admin_connector.invoke(soap_request)
+        !soap_resp[:SearchDirectoryResponse][:num].zero?
       end
 
       def infos!
-        rep = soap_admin_connector.get_version_info
-        json = rep[:Body][:GetVersionInfoResponse][:info].first
+        soap_request = SoapElement.admin(SoapAdminConstants::GET_VERSION_INFO_REQUEST)
+        soap_response = @soap_admin_connector.invoke(soap_request)
+
+        json = soap_response[:GetVersionInfoResponse][:info].first
 
         instance_variable_set(:@type, json[:type])
         instance_variable_set(:@version, json[:version])
@@ -152,6 +152,10 @@ module Zm
       def find_domain_key(domain_name)
         domains.attrs('zimbraPreAuthKey').find_by(name: domain_name).zimbraPreAuthKey
       end
+
+      def logger
+        @config.logger
+      end
     end
   end
 end

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

@@ -6,11 +6,11 @@ module Zm
   module Client
     # class config for cluster connection
     class ClusterConfig
+      include ZmLogger
+
       attr_reader :to_h
-      attr_accessor :zimbra_admin_host, :zimbra_admin_scheme,
-                    :zimbra_admin_port, :zimbra_admin_login,
-                    :zimbra_admin_password, :zimbra_public_host,
-                    :zimbra_public_scheme, :zimbra_public_port,
+      attr_accessor :zimbra_admin_host, :zimbra_admin_scheme, :zimbra_admin_port, :zimbra_admin_login,
+                    :zimbra_admin_password, :zimbra_public_host, :zimbra_public_scheme, :zimbra_public_port,
                     :domains, :zimbra_version
 
       def initialize(parameters = nil)
@@ -51,7 +51,7 @@ module Zm
         @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')
+        @zimbra_version = @to_h.fetch(:zimbra_version, @zimbra_version)
       end
 
       def init_from_yml(file_config_path)

data/lib/zm/client/common/recipients.rb

@@ -2,7 +2,6 @@
 
 module Zm
   module Client
-
     # Collection recipients
     class Recipients
       def initialize
@@ -20,9 +19,10 @@ module Zm
       end
 
       def del(recipient)
-        if recipient.is_a?(Recipient)
+        case recipient
+        when Recipient
           @recipients.delete(recipient)
-        elsif recipient.is_a?(String)
+        when String
           @recipients.delete_if { |r| r.email == recipient }
         end
       end

data/lib/zm/client/common/token_metadata.rb

@@ -21,7 +21,10 @@ module Zm
       end
 
       def metadatas
-        @metadatas ||= Hash[decoded.split(';').map { |v| key, len, str = v.split(/[:=]/); [key, str] }].freeze
+        @metadatas ||= Hash[decoded.split('').map do |v|
+          key, _, str = v.split(/[:=]/)
+          [key, str]
+        end].freeze
       end
 
       def zimbra_id

data/lib/zm/client/common/utils.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'addressable/uri'
+
+module Zm
+  module Client
+    module Utils
+      A_ARRAY_PROC = ->(i) { i.last.is_a?(Array) ? i.last.map { |j| [i.first, j] } : [i] }
+      A_NODE_PROC = ->(n) { { n: n.first, _content: n.last } }
+      ARROW = '@'
+      EQUALS = '='
+
+      class << self
+        def format_email(email)
+          email.strip!
+          email.downcase!
+          email
+        end
+
+        def format_url_params(hash)
+          uri = Addressable::URI.new
+          uri.query_values = hash
+          uri.query
+        end
+
+        # TODO: chercher - remplacer toutes les occurences dans le code
+        def arrow_name(name)
+          return name if name.to_s.start_with?(ARROW)
+
+          "#{ARROW}#{name}"
+        end
+
+        def arrow_name_sym(name)
+          arrow_name(name).to_sym
+        end
+
+        def equals_name(name)
+          return name if name.to_s.end_with?(EQUALS)
+
+          "#{name}#{EQUALS}"
+        end
+
+        def map_format(array, klass, method_name)
+          array.map! do |item|
+            if item.is_a?(klass)
+              item
+            elsif item.respond_to?(method_name)
+              item.name
+            end
+          end
+          array.compact!
+          array
+        end
+      end
+    end
+  end
+end

data/lib/zm/client/common.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'zm/client/common/utils'
 require 'zm/client/common/recipients'
 require 'zm/client/common/message'
-require 'zm/client/common/token_metadata'
+require 'zm/client/common/token_metadata'

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

@@ -16,23 +16,33 @@ module Zm
         @curl.verbose = @verbose
       end
 
-      def cookie(cookie)
-        @curl.headers['Cookie'] = cookie
+      def cookies(cookies)
+        @curl.cookies = cookies
       end
 
       def download(url, dest_file_path)
-        @curl.url = URI.escape(url)
+        @curl.url = url
         File.open(dest_file_path, 'wb') do |f|
           @curl.on_body do |data|
             f << data
             data.size
           end
+
           @curl.perform
         end
+
+        if @curl.status.to_i >= 400
+          File.unlink(dest_file_path) if File.exist?(dest_file_path)
+
+          message = "Download failure: #{@curl.body_str} (status=#{@curl.status})"
+          raise RestError, message
+        end
+
+        dest_file_path
       end
 
       def upload(url, src_file_path)
-        @curl.url = URI.escape(url)
+        @curl.url = url
         @curl.http_post(Curl::PostField.file('file', src_file_path))
 
         if @curl.status.to_i >= 400