zm-ruby-client 0.18.5 → 2.0.0

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

@@ -1,136 +1,70 @@
 # frozen_string_literal: true
 
-require 'zm/modules/common/dl_common'
+require 'zm/client/distributionlist/distributionlist_aliases_collection'
+require 'zm/client/distributionlist/distributionlist_members_collection'
+require 'zm/client/distributionlist/distributionlist_owners_collection'
+require 'zm/client/distributionlist/distributionlist_aces_collection'
+
 module Zm
   module Client
     # objectClass: zimbraDistributionList
-    class DistributionList < Base::AdminObject
-      attr_accessor :members
-      attr_reader :owners, :aces
+    class DistributionList < Base::Object
+      include HasSoapAdminConnector
+
+      def aliases
+        @aliases ||= DistributionListAliasesCollection.new(self)
+      end
 
-      def initialize(parent)
-        extend(DistributionListCommon)
-        super(parent)
-        @members = []
-        @owners = []
-        @aces = []
-        @grantee_type = 'grp'.freeze
+      def members
+        @members ||= DistributionListMembersCollection.new(self)
       end
 
-      def domain_name
-        @domain_name ||= @name.split('@').last
+      def owners
+        @owners ||= DistributionListOwnersCollection.new(self)
       end
 
-      def all_instance_variable_keys
-        DistributionListCommon::ALL_ATTRS
+      def memberships
+        @memberships ||= DlsMembershipCollection.new(self)
       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
-        set_aces_from_json
+      def aces
+        @aces ||= DistributionListAcesCollection.new(self)
       end
 
       def create!
-        rep = sac.create_distribution_list(
-          @name,
-          instance_variables_array(attrs_write)
-        )
-        @id = rep[:Body][:CreateDistributionListResponse][:dl].first[:id]
+        resp = sac.invoke(jsns_builder.to_create)
+        @id = resp[: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)
+        sac.invoke(jsns_builder.to_update)
+        true
       end
 
       def update!(hash)
-        sac.modify_distribution_list(@id, hash)
+        return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
 
-        hash.each do |k, v|
-          arrow_attr_sym = "@#{k}".to_sym
+        do_update!(hash)
 
-          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
+        hash.each do |key, value|
+          update_attribute(key, value)
         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)
+        true
       end
 
-      def rename!(email)
-        sac.rename_distribution_list(@id, email)
-        @name = email
+      def rename!(new_name)
+        sac.invoke(jsns_builder.to_rename(new_name))
+        @name = new_name
       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 add_owners!(*emails)
-        sac.distribution_list_action(
-          @id,
-          :id,
-          {
-            op: 'addOwners',
-            owner: emails.map do |email|
-              { by: :name, type: :usr, _content: email }
-            end
-          }
-        )
-
-        @owners += emails
-      end
-
-      def remove_owners!(*emails)
-        sac.distribution_list_action(
-          @id,
-          :id,
-          {
-            op: 'removeOwners',
-            owner: emails.map do |email|
-              { by: :name, type: :usr, _content: email }
-            end
-          }
-        )
-
-        @owners -= emails
+        sac.invoke(jsns_builder.to_delete)
+        @id = nil
       end
 
       def local_transport
-        raise Zm::Client::SoapError, 'zimbraMailHost is null' if zimbraMailHost.nil?
+        raise Zm::Client::ZmError, 'zimbraMailHost is null' if zimbraMailHost.nil?
 
         "lmtp:#{zimbraMailHost}:7025"
       end
@@ -139,42 +73,42 @@ module Zm
         update!(zimbraMailTransport: local_transport)
       end
 
-      def is_local_transport?
+      def local_transport?
         return nil unless zimbraMailTransport
 
-        zimbraMailTransport.start_with?('lmtp')
+        zimbraMailTransport.start_with?(SoapConstants::LMTP)
       end
 
-      def is_external_transport?
+      def external_transport?
         return nil unless zimbraMailTransport
 
-        zimbraMailTransport.start_with?('smtp')
-      end
-
-      def memberships
-        @memberships ||= DlsMembershipCollection.new(self)
+        zimbraMailTransport.start_with?(SoapConstants::SMTP)
       end
 
       def hide_in_gal?
-        zimbraHideInGal == 'TRUE'
+        zimbraHideInGal == SoapConstants::TRUE
       end
 
       def group?
-        zimbraMailStatus == 'disabled'
+        zimbraMailStatus == SoapConstants::DISABLED
       end
 
       def mailing_list?
-        zimbraMailStatus == 'enabled'
+        zimbraMailStatus == SoapConstants::ENABLED
+      end
+
+      def attrs_write
+        @parent.zimbra_attributes.all_distributionlist_attrs_writable_names
       end
 
-      def set_aces_from_json
-        return if @zimbraACE.nil?
+      private
 
-        zimbra_aces = @zimbraACE.is_a?(Array) ? @zimbraACE : [@zimbraACE]
-        @aces = zimbra_aces.map do |str|
-          parts = str.split(/\s+/)
-          { zimbra_id: parts[0], type: parts[1], right: parts[2] }
-        end
+      def do_update!(hash)
+        sac.invoke(jsns_builder.to_patch(hash))
+      end
+
+      def jsns_builder
+        @jsns_builder ||= DistributionListJsnsBuilder.new(self)
       end
     end
   end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    DistributionListAce = Struct.new(:zimbra_id, :type, :right)
+
+    # Collection Account Aliases
+    class DistributionListAcesCollection
+      include MissingMethodStaticCollection
+
+      def initialize(parent)
+        @parent = parent
+        @all = []
+        build_aces
+      end
+
+      private
+
+      def build_aces
+        return if @parent.zimbraACE.nil?
+
+        zimbra_aces = @parent.zimbraACE.is_a?(Array) ? @parent.zimbraACE : [@parent.zimbraACE]
+
+        @all = zimbra_aces.map do |str|
+          parts = str.split(/\s+/)
+          DistributionListAce.new(parts[0], parts[1], parts[2])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Account Aliases
+    class DistributionListAliasesCollection
+      include MissingMethodStaticCollection
+
+      def initialize(parent)
+        @parent = parent
+        @all = []
+        build_aliases
+      end
+
+      def add!(email)
+        return false if @all.include?(Utils.format_email(email))
+
+        soap_request = SoapElement.admin(SoapAdminConstants::ADD_DISTRIBUTION_LIST_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_DISTRIBUTION_LIST_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.nil?
+
+        case @parent.zimbraMailAlias
+        when Array
+          @all += @parent.zimbraMailAlias
+        when String
+          @all.push(@parent.zimbraMailAlias)
+        end
+
+        @all.delete(@parent.name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for distribution list jsns builder
+    class DistributionListJsnsBuilder
+      def initialize(item)
+        @item = item
+      end
+
+      def to_create
+        soap_request = SoapElement.admin(SoapAdminConstants::CREATE_DISTRIBUTION_LIST_REQUEST).add_attribute(
+          SoapConstants::NAME, @item.name
+        )
+
+        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_DISTRIBUTION_LIST_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_DISTRIBUTION_LIST_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_DISTRIBUTION_LIST_REQUEST).add_attribute(SoapConstants::ID,
+                                                                                              @item.id)
+      end
+
+      def to_rename(new_name)
+        SoapElement.admin(SoapAdminConstants::RENAME_DISTRIBUTION_LIST_REQUEST).add_attributes({ id: @id,
+                                                                                                 newName: new_name })
+      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/distributionlist/distributionlist_jsns_initializer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for initialize distribution list
+    class DistributionListJsnsInitializer < Base::BaseJsnsInitializer
+      class << self
+        def create(parent, json)
+          item = DistributionList.new(parent)
+
+          update(item, json)
+        end
+
+        def update(item, json)
+          item.id = json[:id]
+          item.name = json[:name]
+
+          formatted_json(json).each do |k, v|
+            valorise(item, k, v)
+          end
+
+          item.members.all = json[:dlm].map { |a| a[:_content] }.compact if json[:dlm].is_a?(Array)
+          item.owners.all = json[:owners].first[:owner].map { |a| a[:name] }.compact if json[:owners].is_a?(Array)
+
+          # todo: ajouter dans les members les valeurs de zimbraMailForwardingAddress si members.all.empty?
+
+          item
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Account Aliases
+    class DistributionListMembersCollection
+      attr_accessor :all
+
+      def initialize(parent)
+        @parent = parent
+        @all = []
+      end
+
+      def add!(emails)
+        emails.each { |email| Utils.format_email(email) }
+        emails.delete_if { |email| @all.include?(email) }
+        return false if emails.empty?
+
+        soap_request = SoapElement.admin(SoapAdminConstants::ADD_DISTRIBUTION_LIST_MEMBER_REQUEST)
+        soap_request.add_attribute('id', @parent.id)
+        node_dlm = SoapElement.create('dlm')
+        node_dlm.add_content(emails)
+        soap_request.add_node(node_dlm)
+        @parent.sac.invoke(soap_request)
+
+        @all += emails
+        true
+      end
+
+      def remove!(emails)
+        emails.each { |email| Utils.format_email(email) }
+        emails.delete_if { |email| !@all.include?(email) }
+        return false if emails.empty?
+
+        soap_request = SoapElement.admin(SoapAdminConstants::REMOVE_DISTRIBUTION_LIST_MEMBER_REQUEST)
+        soap_request.add_attribute('id', @parent.id)
+        node_dlm = SoapElement.create('dlm')
+        node_dlm.add_content(emails)
+        soap_request.add_node(node_dlm)
+        @parent.sac.invoke(soap_request)
+
+        @all -= emails
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Account Aliases
+    class DistributionListOwnersCollection
+      attr_accessor :all
+
+      def initialize(parent)
+        @parent = parent
+        @all = []
+      end
+
+      def add!(*emails)
+        emails.each { |email| Utils.format_email(email) }
+        emails.delete_if { |email| @all.include?(email) }
+        return false if emails.empty?
+
+        @parent.sac.invoke(jsns('addOwners', emails))
+
+        @all += emails
+        true
+      end
+
+      def remove!(*emails)
+        emails.each { |email| Utils.format_email(email) }
+        emails.delete_if { |email| !@all.include?(email) }
+        return false if emails.empty?
+
+        @parent.sac.invoke(jsns('removeOwners', emails))
+
+        @all -= emails
+        true
+      end
+
+      private
+
+      def jsns(op, emails)
+        soap_request = SoapElement.account(SoapAccountConstants::DISTRIBUTION_LIST_ACTION_REQUEST)
+        node_dl = SoapElement.create('dl').add_attribute(SoapConstants::BY, SoapConstants::ID).add_content(@parent.id)
+        soap_request.add_node(node_dl)
+        node_action = SoapElement.create(SoapConstants::ACTION).add_attributes({ op: op, owner: jsns_owners(emails) })
+        soap_request.add_node(node_action)
+        soap_request
+      end
+
+      def jsns_owners(emails)
+        emails.map { |email| { by: :name, type: :usr, _content: email } }
+      end
+    end
+  end
+end

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

@@ -6,9 +6,16 @@ module Zm
     class DistributionListsBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
         super(parent, json)
-        @child_class = DistributionList
         @json_item_key = :dl
       end
+
+      def make
+        return [] if json_items.nil?
+
+        json_items.map do |entry|
+          DistributionListJsnsInitializer.create(@parent, entry)
+        end
+      end
     end
   end
 end

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

@@ -8,16 +8,18 @@ module Zm
         @child_class = DistributionList
         @builder_class = DistributionListsBuilder
         @search_type = SearchType::DL
-        @parent = parent
-        reset_query_params
+        super(parent)
       end
 
-      def find_by(hash)
-        rep = sac.get_distribution_list(hash.values.first, hash.keys.first, attrs_comma)
-        entry = rep[:Body][:GetDistributionListResponse][:dl].first
+      def find_by!(hash)
+        soap_request = SoapElement.admin(SoapAdminConstants::GET_DISTRIBUTION_LIST_REQUEST)
+        node_dl = SoapElement.create(SoapConstants::DL).add_attribute(SoapConstants::BY, hash.keys.first).add_content(hash.values.first)
+        soap_request.add_node(node_dl)
+        soap_request.add_attribute(SoapConstants::ATTRS, attrs_comma)
+        entry = sac.invoke(soap_request)[:GetDistributionListResponse][:dl].first
 
         reset_query_params
-        build_from_entry(entry)
+        DistributionListJsnsInitializer.create(@parent, entry)
       end
 
       private
@@ -25,9 +27,6 @@ module Zm
       def reset_query_params
         super
         @attrs = SearchType::Attributes::DL.dup
-        @all_servers = 1
-        @refresh = 0
-        @apply_cos = 1
       end
     end
   end

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

@@ -12,7 +12,10 @@ module Zm
       private
 
       def make_query
-        @parent.sac.get_distribution_list_membership(@parent.id, :id)
+        soap_request = SoapElement.admin(SoapAdminConstants::GET_DISTRIBUTION_LIST_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/distributionlist.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'zm/client/distributionlist/distributionlist'
+require 'zm/client/distributionlist/distributionlist_jsns_builder'
+require 'zm/client/distributionlist/distributionlist_jsns_initializer'
 require 'zm/client/distributionlist/distributionlists_builder'
 require 'zm/client/distributionlist/distributionlists_collection'
 require 'zm/client/distributionlist/dls_membership_collection'

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

@@ -3,46 +3,49 @@
 module Zm
   module Client
     # class for account document
-    class Document < Base::AccountObject
+    class Document < Base::Object
+      include BelongsToFolder
+      include BelongsToTag
 
-      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 :id, :uuid, :name, :s, :d, :l, :luuid, :ms, :mdver, :md, :rev, :f, :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?
+      def create!
+        raise NotImplementedError
       end
 
-      def all_instance_variable_keys
-        INSTANCE_VARIABLE_KEYS
+      def modify!
+        raise NotImplementedError
       end
 
-      def folder
-        @folder ||= @parent.folders.all.find { |folder| folder.id == l }
+      def update!(*args)
+        raise NotImplementedError
       end
 
-      def tag!(tag_name)
-        @parent.sacc.item_action(@parent.token, :tag, @id, tn: tag_name)
+      def rename!(*args)
+        raise NotImplementedError
       end
 
-      def move!(folder_id)
-        @parent.sacc.item_action(@parent.token, 'move', @id, l: folder_id)
-        @l = folder_id
+      def delete!
+        return false if @id.nil?
+
+        @parent.sacc.invoke(jsns_builder.to_delete)
+        @id = nil
       end
 
-      def delete!
-        @parent.sacc.item_action(@parent.token, :delete, @id)
+      def reload!
+        raise NotImplementedError
       end
 
       def download(dest_file_path)
         uploader = Upload.new(@parent, RestAccountConnector.new)
-        uploader.download_file(folder.absFolderPath, nil, nil, [id], dest_file_path)
+        uploader.download_file( Zm::Client::FolderDefault::ROOT[:path], nil, [Zm::Client::FolderView::DOCUMENT], [@id], dest_file_path)
+      end
+
+      private
+
+      def jsns_builder
+        @jsns_builder ||= DocumentJsnsBuilder.new(self)
       end
     end
   end