zm-ruby-client 0.10.4

data/lib/zm/client/distributionlist/distributionlist.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'zm/modules/common/dl_common'
+module Zm
+  module Client
+    # objectClass: zimbraDistributionList
+    class DistributionList < Base::AdminObject
+      attr_accessor :members
+      attr_reader :owners
+
+      def initialize(parent)
+        extend(DistributionListCommon)
+        super(parent)
+        @members = []
+        @owners = []
+        @grantee_type = 'grp'.freeze
+      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 all_instance_variable_keys
+        DistributionListCommon::ALL_ATTRS
+      end
+
+      def init_from_json(json)
+        # puts json
+        # @members = json[:a].select { |a| a[:n] == 'zimbraMailForwardingAddress' }.map { |a| a[:_content] }.compact
+        @members = json[:dlm].map { |a| a[:_content] }.compact if json[:dlm].is_a?(Array)
+        @owners = json[:owners].first[:owner].map { |a| a[:name] }.compact if json[:owners].is_a?(Array)
+        super(json)
+        @zimbraMailAlias = [@zimbraMailAlias].compact unless @zimbraMailAlias.is_a?(Array)
+        @zimbraMailAlias.delete(@name)
+        @aliases = @zimbraMailAlias
+      end
+
+      def create!
+        rep = sac.create_distribution_list(
+          @name,
+          instance_variables_array(attrs_write)
+        )
+        @id = rep[:Body][:CreateDistributionListResponse][:dl].first[:id]
+      end
+
+      def modify!
+        attrs_to_modify = instance_variables_array(attrs_write)
+        return if attrs_to_modify.empty?
+
+        sac.modify_distribution_list(@id, attrs_to_modify)
+      end
+
+      def update!(hash)
+        sac.modify_distribution_list(@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
+      end
+
+      def aliases
+        @aliases ||= []
+      end
+
+      def add_alias!(email)
+        sac.add_distribution_list_alias(@id, email)
+        aliases.push(email)
+      end
+
+      def remove_alias!(email)
+        sac.remove_distribution_list_alias(@id, email)
+        aliases.delete(email)
+      end
+
+      def rename!(email)
+        sac.rename_distribution_list(@id, email)
+        @name = email
+      end
+
+      def delete!
+        sac.delete_distribution_list(@id)
+      end
+
+      def add_members!(*emails)
+        sac.add_distribution_list_members(@id, emails)
+        @members += emails
+      end
+
+      def remove_members!(*emails)
+        sac.remove_distribution_list_members(@id, emails)
+        @members -= emails
+      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
+    end
+  end
+end

data/lib/zm/client/distributionlist/distributionlists_builder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [resources]
+    class DistributionListsBuilder < Base::ObjectsBuilder
+      def initialize(parent, json)
+        super(parent, json)
+        @child_class = DistributionList
+      end
+
+      # def make
+      #   return [] if json_items.nil?
+      #
+      #   json_items.map do |entry|
+      #     dl = DistributionList.new(@parent)
+      #     dl.init_from_json(entry)
+      #     dl
+      #   end
+      # end
+
+      private
+
+      def json_items
+        @json_items ||= @json[:Body][json_key][:dl]
+      end
+    end
+  end
+end

data/lib/zm/client/distributionlist/distributionlists_collection.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Resources
+    class DistributionListsCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @child_class = DistributionList
+        @parent = parent
+        reset_query_params
+      end
+
+      def ldap
+        @apply_cos = 0
+        self
+      end
+
+      def find_by(hash)
+        rep = sac.get_distribution_list(hash.values.first, hash.keys.first, attrs_comma)
+        entry = rep[:Body][:GetDistributionListResponse][:dl].first
+
+        build_from_entry(entry)
+      end
+
+      private
+
+      def build_response
+        DistributionListsBuilder.new(@parent, make_query).make
+      end
+
+      def reset_query_params
+        super
+        @search_type = SearchType::DL
+        @attrs = SearchType::Attributes::DL.dup
+        @all_servers = 1
+        @refresh = 0
+        @apply_cos = 1
+      end
+    end
+  end
+end

data/lib/zm/client/distributionlist.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'zm/client/distributionlist/distributionlist'
+require 'zm/client/distributionlist/distributionlists_builder'
+require 'zm/client/distributionlist/distributionlists_collection'

data/lib/zm/client/document/document.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for account document
+    class Document < Base::AccountObject
+
+      INSTANCE_VARIABLE_KEYS = %i[id uuid name s d l luuid ms mdver md rev f tn t meta ct descEnabled ver leb cr cd acl loid sf tn]
+
+      attr_accessor *INSTANCE_VARIABLE_KEYS
+      attr_writer :folder
+      attr_reader :json
+
+      alias parent_id l
+
+      def initialize(parent, json = nil)
+        @parent = parent
+        init_from_json(json) if json.is_a?(Hash)
+        yield(self) if block_given?
+      end
+
+      def concat
+        INSTANCE_VARIABLE_KEYS.map { |key| instance_variable_get(arrow_name(key)) }
+      end
+
+      def folder
+        @folder ||= @parent.folders.all.find { |folder| folder.id == l }
+      end
+
+      def tag!(tag_name)
+        @parent.sacc.item_action(@parent.token, :tag, @id, tn: tag_name)
+      end
+
+      def download(dest_file_path)
+        uploader = Upload.new(@parent, RestAccountConnector.new)
+        uploader.download_file(folder.absFolderPath, nil, nil, [id], dest_file_path)
+      end
+
+      def init_from_json(json)
+        INSTANCE_VARIABLE_KEYS.each do |key|
+          var_name = "@#{key}"
+          instance_variable_set(var_name, json[key])
+        end
+      end
+    end
+  end
+end

data/lib/zm/client/document/documents_builder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [documents]
+    class DocumentsBuilder < Base::ObjectsBuilder
+      def initialize(parent, json)
+        @parent = parent
+        @json = json
+      end
+
+      def make
+        root.map do |s|
+          Document.new(@parent, s)
+        end
+      end
+
+      def ids
+        root.map { |s| s[:id] }
+      end
+
+      def root
+        root = @json[:Body][:SearchResponse][:doc]
+        return [] if root.nil?
+
+        root = [root] unless root.is_a?(Array)
+        root
+      end
+    end
+  end
+end

data/lib/zm/client/document/documents_collection.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # collection of documents
+    class DocumentsCollection < Base::ObjectsCollection
+      DEFAULT_QUERY = 'in:briefcase'
+
+      attr_accessor :more
+
+      def initialize(parent)
+        @parent = parent
+        @more = true
+        reset_query_params
+      end
+
+      def new
+        document = Document.new(@parent)
+        yield(document) if block_given?
+        document
+      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 ids
+        @options = { resultMode: 1 }
+        search_builder.ids
+      end
+
+      private
+
+      def search_response
+        rep = @parent.sacc.search(@parent.token, 'document', @offset, @limit, 'subjAsc', query, @options)
+        @more = rep[:Body][:SearchResponse][:more]
+        rep
+      end
+
+      def search_builder
+        DocumentsBuilder.new(@parent, search_response)
+      end
+
+      def build_response
+        documents = search_builder.make
+        documents.each { |appo| appo.folder = find_folder(appo) } unless @folders.empty?
+        documents
+      end
+
+      def query
+        return @query unless @query.nil?
+
+        return DEFAULT_QUERY if @folder_ids.empty?
+
+        @folder_ids.map { |id| %Q{inid:"#{id}"} }.join(' OR ')
+      end
+
+      def find_folder(document)
+        @folders.find { |folder| folder.id == document.l }
+      end
+
+      def reset_query_params
+        super
+        @query = nil
+        @folder_ids = []
+        @folders = []
+        @options = {}
+      end
+    end
+  end
+end

data/lib/zm/client/document.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'zm/client/document/document'
+require 'zm/client/document/documents_builder'
+require 'zm/client/document/documents_collection'

data/lib/zm/client/domain/domain.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # objectClass: zimbraDomain
+    class Domain < Base::AdminObject
+      INSTANCE_VARIABLE_KEYS = %i[name description zimbraDomainName zimbraDomainStatus zimbraId zimbraDomainType
+        zimbraDomainDefaultCOSId zimbraGalAccountId zimbraPreAuthKey zimbraGalLdapBindDn zimbraGalLdapBindPassword
+        zimbraGalLdapFilter zimbraGalLdapSearchBase zimbraGalLdapURL zimbraGalMode]
+
+      attr_accessor *INSTANCE_VARIABLE_KEYS
+
+      def initialize(parent)
+        super(parent)
+        @grantee_type = 'dom'.freeze
+      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 all_instance_variable_keys
+        INSTANCE_VARIABLE_KEYS
+      end
+
+      def update!(hash)
+        sac.modify_domain(@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
+      end
+
+      def accounts
+        @accounts ||= AccountsCollection.new(self)
+      end
+
+      def init_from_json(json)
+        super(json)
+        return unless json[:a].is_a? Array
+
+        n_key = :n
+        c_key = :_content
+        at_key = '@'
+
+        attrs = {}
+
+        # TODO: definir ici le typage fort des attributs pour ne pas avoir
+        # a faire des cases sur les class des attributs dans le code.
+
+        json[:a].each do |a|
+          k = "#{at_key}#{a[n_key]}".to_sym
+          v = a[c_key]
+          if !attrs[k].nil?
+            attrs[k] = [attrs[k]] unless attrs[k].is_a?(Array)
+            attrs[k].push(v)
+          else
+            attrs[k] = v
+          end
+        end
+
+        attrs.each { |k, v| instance_variable_set(k, v) }
+      end
+    end
+  end
+end

data/lib/zm/client/domain/domains_builder.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Class Builder [Domain]
+    class DomainsBuilder < Base::ObjectsBuilder
+      def initialize(parent, json)
+        super(parent, json)
+        @child_class = Domain
+      end
+
+      # def make
+      #   records = []
+      #   return records if json_items.nil?
+      #
+      #   json_items.each do |entry|
+      #     domain = Domain.new(@parent)
+      #     domain.init_from_json(entry)
+      #     records << domain
+      #   end
+      #
+      #   records
+      # end
+
+      private
+
+      def json_items
+        @json_items ||= @json[:Body][json_key][:domain]
+      end
+    end
+  end
+end

data/lib/zm/client/domain/domains_collection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Class Collection [Domain]
+    class DomainsCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @child_class = Domain
+        @parent = parent
+        reset_query_params
+      end
+
+      def find_by(hash, *attrs)
+        rep = sac.get_domain(hash.values.first, hash.keys.first, attrs.join(COMMA))
+        entry = rep[:Body][:GetDomainResponse][:domain].first
+
+        build_from_entry(entry)
+      end
+
+      private
+
+      def build_response
+        DomainsBuilder.new(@parent, make_query).make
+      end
+
+      def reset_query_params
+        super
+        @search_type = SearchType::DOMAIN
+        @attrs = SearchType::Attributes::DOMAIN.dup
+        @all_servers = 1
+        @refresh = 0
+        @apply_cos = 1
+      end
+    end
+  end
+end

data/lib/zm/client/domain.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'zm/client/domain/domain'
+require 'zm/client/domain/domains_builder'
+require 'zm/client/domain/domains_collection'