zm-ruby-client 0.14.0 → 0.17.1

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

@@ -11,6 +11,40 @@ module Zm
         end
 
         alias sacc soap_account_connector
+
+        def concat
+          all_instance_variable_keys.map { |key| instance_variable_get(arrow_name(key)) }
+        end
+
+        def init_from_json(json)
+          all_instance_variable_keys.each do |key|
+            next if json[key].nil?
+            instance_variable_set(arrow_name(key), json[key])
+          end
+        end
+
+        def to_h
+          hashmap = Hash[all_instance_variable_keys.map { |key| [key, instance_variable_get(arrow_name(key))] }]
+          hashmap.delete_if { |_, v| v.nil? }
+          hashmap
+        end
+
+        def create!
+          @id
+        end
+
+        def modify!
+          rename!
+          true
+        end
+
+        def rename!
+          true
+        end
+
+        def delete!
+          remove_instance_variable(:@id)
+        end
       end
     end
   end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module Base
+      # Collection AccountObjectsCollection
+      class AccountObjectsCollection < ObjectsCollection
+        def initialize(parent)
+          @parent = parent
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module Base
+      # Collection AccountSearchObjectsCollection
+      class AccountSearchObjectsCollection < AccountObjectsCollection
+        attr_accessor :more
+
+        def initialize(parent)
+          super(parent)
+          @more = true
+          reset_query_params
+        end
+
+        def find(id)
+          rep = @parent.sacc.get_msg(@parent.token, id, { html: 1 })
+          entry = rep[:Body][:GetMsgResponse][:m].first
+
+          msg = @child_class.new(@parent)
+          msg.init_from_json(entry)
+          msg
+        end
+
+        def start_at(start_at)
+          @start_at = start_at
+          self
+        end
+
+        def end_at(end_at)
+          @end_at = end_at
+          self
+        end
+
+        def folders(folders)
+          @folders = folders
+          @folder_ids = @folders.map(&:id)
+          self
+        end
+
+        def folder_ids(folder_ids)
+          @folder_ids = folder_ids
+          self
+        end
+
+        def where(query)
+          @query = query
+          self
+        end
+
+        def order(sort_by)
+          return self if @sort_by == sort_by
+
+          @all = nil
+          @sort_by = sort_by
+          self
+        end
+
+        def ids
+          @options = { resultMode: 1 }
+          search_builder.ids
+        end
+
+        def reset
+          reset_query_params
+        end
+
+        private
+
+        def make_query
+          @parent.sacc.search(@parent.token, @type, @offset, @limit, @sort_by, query, build_options)
+        end
+
+        def search_builder
+          @builder_class.new(@parent, search_response)
+        end
+
+        def search_response
+          rep = make_query
+          @more = rep[:Body][:SearchResponse][:more]
+          rep
+        end
+
+        def build_response
+          items = search_builder.make
+          items.each { |item| item.folder = find_folder(item) } unless @folders.empty?
+          items
+        end
+
+        def find_folder(item)
+          @folders.find { |folder| folder.id == item.l }
+        end
+
+        def query
+          return @query unless @query.nil?
+
+          return nil if @folder_ids.empty?
+
+          @folder_ids.map { |id| %Q{inid:"#{id}"} }.join(' OR ')
+        end
+
+        def build_options
+          start_at_ts = @start_at.is_a?(Time) ? (@start_at.to_f * 1000).to_i : nil
+          end_at_ts = @end_at.is_a?(Time) ? (@end_at.to_f * 1000).to_i : nil
+
+          {
+            resultMode: @resultMode,
+            calExpandInstStart: start_at_ts,
+            calExpandInstEnd: end_at_ts,
+          }.delete_if { |_, v| v.nil? }
+        end
+
+        def reset_query_params
+          super
+          @resultMode = 'NORMAL'
+          @start_at = nil
+          @end_at = nil
+          @query = nil
+          @folder_ids = []
+          @folders = []
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,12 @@ module Zm
 
         alias sacc soap_account_connector
 
+        def to_h
+          hashmap = Hash[all_instance_variable_keys.map { |key| [key, instance_variable_get(arrow_name(key))] }]
+          hashmap.delete_if { |_, v| v.nil? }
+          hashmap
+        end
+
         def init_from_json(json)
           # TODO : know in advance the typing of variables
           super(json)

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module Base
+      # Collection AdminObjectsCollection
+      class AdminObjectsCollection < ObjectsCollection
+        def initialize(parent)
+          @parent = parent
+          reset_query_params
+        end
+
+        def ldap
+          @apply_cos = 0
+          self
+        end
+
+        def where(ldap_query)
+          @all = nil
+          ldap_filter.add(ldap_query)
+
+          self
+        end
+
+        def attrs(*attrs)
+          return self if @attrs == attrs
+
+          @all = nil
+          @attrs = attrs
+          self
+        end
+
+        def count
+          @count_only = SoapUtils::ON
+          make_query[:Body][:SearchDirectoryResponse][:num]
+        end
+
+        private
+
+        def make_query
+          json = sac.search_directory(
+            ldap_filter.join, @max_result, @limit, @offset,
+            @domain_name, @apply_cos, @apply_config, @sort_by, @search_type,
+            @sort_ascending, @count_only, attrs_comma
+          )
+          reset_query_params
+          json
+        end
+
+        def ldap_filter
+          @ldap_filter ||= LdapFilter.new
+        end
+
+        # def build_response
+        #   @builder_class.new(@parent, make_query).make
+        # end
+
+        def reset_query_params
+          super
+          ldap_filter.clear
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module Base
+      # class for account object jsns builder
+      class BaseJsnsBuilder
+
+        def initialize(item)
+          @item = item
+        end
+
+        def to_delete
+          { id: @item.id }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module Base
+      # class for account object jsns initializer
+      class BaseJsnsInitializer
+
+        def initialize(parent, json)
+          @parent = parent
+          @json = json
+        end
+
+        def create
+          @item ||= @child_class.new(@parent)
+
+          @item.instance_variable_set(:@id, @json[:id])
+          @item.instance_variable_set(:@name, @json[:name])
+        end
+
+        def arrow_name(name)
+          return name if name.to_s.start_with?('@')
+
+          "@#{name}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module Base
+      # Abstract Class FolderObject
+      class FolderObject < AccountObject
+
+        def initialize(parent)
+          @l = FolderDefault::ROOT[:id]
+          super(parent)
+        end
+
+        def color!
+          @parent.sacc.folder_action(@parent.token, jsns_builder.to_color) if color_changed? || rgb_changed?
+          true
+        end
+
+        def delete!
+          @parent.sacc.folder_action(@parent.token, jsns_builder.to_delete)
+          super
+        end
+
+        def modify!
+          @parent.sacc.folder_action(@parent.token, jsns_builder.to_update)
+          true
+        end
+
+        def move!
+          @parent.sacc.folder_action(@parent.token, jsns_builder.to_move) if l_changed?
+          true
+        end
+
+        def rename!
+          @parent.sacc.folder_action(@parent.token, jsns_builder.to_rename) if name_changed?
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    class LdapFilter
+      def initialize(base_filter = nil)
+        @base_filter = base_filter
+        @parts = []
+      end
+
+      def add(filter)
+        if filter.is_a?(String) && !filter.empty?
+          @parts << filter
+        elsif filter.is_a?(Hash)
+          @parts += filter.map { |k, v| "(#{k}=#{v})" }
+        end
+      end
+
+      def clear
+        @parts.clear
+      end
+
+      def join
+        arr = @parts.dup
+        arr.unshift(@base_filter) unless @base_filter.nil?
+
+        return arr.first if arr.length <= 1
+
+        "(&#{arr.join})"
+      end
+    end
+  end
+end

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

@@ -10,9 +10,24 @@ module Zm
 
         def initialize(parent)
           @parent = parent
+          @use_builder = true
           yield(self) if block_given?
         end
 
+        def disable_builder
+          @use_builder = false
+          self
+        end
+
+        def enable_builder
+          @use_builder = true
+          self
+        end
+
+        def use_builder?
+          @use_builder
+        end
+
         def init_from_json(json)
           @id    = json[:id]
           @name  = json[:name]
@@ -74,6 +89,10 @@ module Zm
           yield(obj) if block_given?
           obj
         end
+
+        def logger
+          @parent.logger
+        end
       end
     end
   end

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

@@ -22,6 +22,10 @@ module Zm
 
         private
 
+        def json_items
+          @json_items ||= @json[:Body][json_key][@json_item_key]
+        end
+
         def json_key
           @json_key ||= @json[:Body].keys.first
         end

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

@@ -38,14 +38,6 @@ module Zm
           @all = build_response
         end
 
-        def where(ldap_query)
-          return self if @ldap_query == ldap_query
-
-          @all = nil
-          @ldap_query = ldap_query
-          self
-        end
-
         def per_page(limit)
           return self if @limit == limit
 
@@ -71,19 +63,6 @@ module Zm
           self
         end
 
-        def count
-          @count_only = SoapUtils::ON
-          make_query[:Body][:SearchDirectoryResponse][:num]
-        end
-
-        def attrs(*attrs)
-          return self if @attrs == attrs
-
-          @all = nil
-          @attrs = attrs
-          self
-        end
-
         def method_missing(method, *args, &block)
           if METHODS_MISSING_LIST.include?(method)
             build_response.send(method, *args, &block)
@@ -96,24 +75,21 @@ module Zm
           METHODS_MISSING_LIST.include?(method) || super
         end
 
+        def logger
+          @parent.logger
+        end
+
         private
 
+        def build_response
+          @builder_class.new(@parent, make_query).make
+        end
+
         def soap_admin_connector
           @parent.soap_admin_connector
         end
-
         alias sac soap_admin_connector
 
-        def make_query
-          json = sac.search_directory(
-            @ldap_query, @max_result, @limit, @offset,
-            @domain_name, @apply_cos, nil, @sort_by, @search_type,
-            @sort_ascending, @count_only, attrs_comma
-          )
-          reset_query_params
-          json
-        end
-
         def attrs_comma
           return @attrs unless @attrs.is_a?(Array)
 
@@ -128,6 +104,9 @@ module Zm
           @sort_by = nil
           @sort_ascending = SoapUtils::ON
           @count_only = SoapUtils::OFF
+          @all_servers = 0
+          @refresh = 0
+          @apply_cos = 1
         end
       end
     end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'version_sorter'
+
+module Zm
+  module Client
+    module Base
+      class ZimbraAttribute < OpenStruct
+
+        # attr_accessor :flags, :id, :immutable, :max, :min, :name, :optionalIn, :order, :requiredIn, :since, :type, :value
+
+        def version_start
+          return @version_start unless @version_start.nil?
+
+          if since.nil?
+            @version_start = '0.0.0'
+          else
+            @version_start = VersionSorter.sort(since.split(',')).first
+          end
+
+          @version_start
+        end
+
+        def objects_scope
+          @objects_scope ||= (optionalIn.to_s.split(',') + requiredIn.to_s.split(',')).freeze
+        end
+
+        def is_account_scoped?
+          @is_account_scoped ||= objects_scope.include?('account')
+        end
+
+        def is_aclTarget_scoped?
+          @is_aclTarget_scoped ||= objects_scope.include?('aclTarget')
+        end
+
+        def is_alias_scoped?
+          @is_alias_scoped ||= objects_scope.include?('alias')
+        end
+
+        def is_alwaysOnCluster_scoped?
+          @is_alwaysOnCluster_scoped ||= objects_scope.include?('alwaysOnCluster')
+        end
+
+        def is_calendarResource_scoped?
+          @is_calendarResource_scoped ||= objects_scope.include?('calendarResource')
+        end
+
+        def is_cos_scoped?
+          @is_cos_scoped ||= objects_scope.include?('cos')
+        end
+
+        def is_dataSource_scoped?
+          @is_dataSource_scoped ||= objects_scope.include?('dataSource')
+        end
+
+        def is_distributionList_scoped?
+          @is_distributionList_scoped ||= objects_scope.include?('distributionList')
+        end
+
+        def is_domain_scoped?
+          @is_domain_scoped ||= objects_scope.include?('domain')
+        end
+
+        def is_globalConfig_scoped?
+          @is_globalConfig_scoped ||= objects_scope.include?('globalConfig')
+        end
+
+        def is_group_scoped?
+          @is_group_scoped ||= objects_scope.include?('group')
+        end
+
+        def is_groupDynamicUnit_scoped?
+          @is_groupDynamicUnit_scoped ||= objects_scope.include?('groupDynamicUnit')
+        end
+
+        def is_groupStaticUnit_scoped?
+          @is_groupStaticUnit_scoped ||= objects_scope.include?('groupStaticUnit')
+        end
+
+        def is_identity_scoped?
+          @is_identity_scoped ||= objects_scope.include?('identity')
+        end
+
+        def is_mailRecipient_scoped?
+          @is_mailRecipient_scoped ||= objects_scope.include?('mailRecipient')
+        end
+
+        def is_mimeEntry_scoped?
+          @is_mimeEntry_scoped ||= objects_scope.include?('mimeEntry')
+        end
+
+        def is_objectEntry_scoped?
+          @is_objectEntry_scoped ||= objects_scope.include?('objectEntry')
+        end
+
+        def is_server_scoped?
+          @is_server_scoped ||= objects_scope.include?('server')
+        end
+
+        def is_signature_scoped?
+          @is_signature_scoped ||= objects_scope.include?('signature')
+        end
+
+        def is_ucService_scoped?
+          @is_ucService_scoped ||= objects_scope.include?('ucService')
+        end
+
+        def is_xmppComponent_scoped?
+          @is_xmppComponent_scoped ||= objects_scope.include?('xmppComponent')
+        end
+
+        def is_zimletEntry_scoped?
+          @is_zimletEntry_scoped ||= objects_scope.include?('zimletEntry')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'zm/client/base/zimbra_attribute'
+
+module Zm
+  module Client
+    module Base
+      class ZimbraAttributesCollection
+        attr_reader :all
+
+        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
+        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 }
+        end
+
+        def all_account_attrs
+          @all_account_attrs ||= @all.select { |attr| attr.is_account_scoped? }.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 }
+        end
+      end
+    end
+  end
+end

data/lib/zm/client/base.rb

@@ -1,7 +1,22 @@
 # frozen_string_literal: true
 
+require 'curb'
+require 'logger'
+require 'openssl'
+
+require 'zm/modules/zm_logger'
+require 'zm/modules/zm_model'
+
+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_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'