zm-ruby-client 0.10.4 → 0.17.1

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

@@ -8,15 +8,14 @@ module Zm
   module Client
     class SoapAdminConnector < SoapBaseConnector
 
+      # SOAP_PATH = '/service/admin/soap/'
       ADMINSPACE = 'urn:zimbraAdmin'
       A_NODE_PROC = lambda { |n| { n: n.first, _content: n.last } }
 
       attr_accessor :token
 
       def initialize(scheme, host, port)
-        @verbose = false
-        @uri = URI::HTTP.new(scheme, nil, host, port, nil, '/service/admin/soap/', nil, nil, nil)
-        init_curl_client
+        super(scheme, host, port, '/service/admin/soap/')
       end
 
       def auth(mail, password)
@@ -155,7 +154,6 @@ module Zm
         # req = { _jsns: ADMINSPACE, id: id, a: attrs.to_a.map{ |n| { n: n.first, _content: n.last } } }
         req = { _jsns: ADMINSPACE, id: id }
         body = { Body: { ModifyCosRequest: req } }.merge(hash_header(@token))
-        # puts body
         # todo ne fonctionne pas !
         # peut-être seul la version xml fonctionne. Il faudrait créer une fonction qui converti le json en xml
         curl_request(body)
@@ -168,7 +166,6 @@ module Zm
         # req[:a] = attrs.map{|i|i.last.is_a?(Array) ? i.last.map{|j|[i.first, j]} : [i]}.flatten(1).map { |n| { n: n.first, _content: n.last } }
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
-        # puts body
         curl_request(body)
       end
 
@@ -188,7 +185,6 @@ module Zm
         req[:a] = attrs.map { |i| i.last.is_a?(Array) ? i.last.map{|j|[i.first, j]} : [i] }.flatten(1).map(&A_NODE_PROC)
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
-        # puts body
         curl_request(body)
       end
 
@@ -214,6 +210,14 @@ module Zm
         curl_request(body)
       end
 
+      def set_password(id, new_password)
+        soap_name = :SetPasswordRequest
+        req = { id: id, newPassword: new_password }
+        body = init_hash_request(soap_name)
+        body[:Body][soap_name].merge!(req)
+        curl_request(body)
+      end
+
       def add_account_alias(id, email)
         generic_alias(:AddAccountAliasRequest, id, email)
       end
@@ -254,7 +258,6 @@ module Zm
         req = { id: id, alias: email }
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
-        # puts body
         curl_request(body)
       end
 
@@ -275,7 +278,17 @@ module Zm
         body = init_hash_request(:GetDomainRequest)
         body[:Body][:GetDomainRequest].merge!(req)
         # TODO: tester param attrs
-        # puts body
+        curl_request(body)
+      end
+
+      def create_domain(name, attrs = [])
+        soap_name = :CreateDomainRequest
+        req = {
+          name: name,
+          a: attrs.map(&A_NODE_PROC)
+        }
+        body = init_hash_request(soap_name)
+        body[:Body][soap_name].merge!(req)
         curl_request(body)
       end
 
@@ -289,7 +302,6 @@ module Zm
         req[:attrs] = attrs unless attrs.nil? || attrs.empty?
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
-        # puts body
         curl_request(body)
       end
 
@@ -321,6 +333,16 @@ module Zm
         curl_request(body)
       end
 
+      def get_distribution_list_membership(by_key, by = 'name', limit = nil, offset = nil)
+        soap_name = :GetDistributionListMembershipRequest
+        req = { dl: { by: by, _content: by_key }, limit: limit, offset: offset }
+        req.reject! { |_, v| v.nil? }
+        body = init_hash_request(soap_name)
+        body[:Body][soap_name].merge!(req)
+
+        curl_request(body)
+      end
+
       def delete_account(id)
         generic_delete(:DeleteAccountRequest, id)
       end
@@ -374,7 +396,6 @@ module Zm
         # body = { Body: { SearchDirectoryRequest: { _jsns: ADMINSPACE } } }.merge(hash_header(@token))
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
-        # puts body
 
         curl_request(body)
       end
@@ -409,11 +430,11 @@ module Zm
         curl_request(body)
       end
 
-      def flush_cache(type, all_servers, id = nil)
+      def flush_cache(type, all_servers, id = nil, target_server_id = nil)
         soap_name = :FlushCacheRequest
         req = { cache: { type: type, allServers: all_servers } }
         req[:cache].merge!({ entry: { by: :id, _content: id } }) unless id.nil?
-        body = init_hash_request(soap_name)
+        body = init_hash_request(soap_name, target_server_id)
         body[:Body][soap_name].merge!(req)
         curl_request(body)
       end
@@ -447,7 +468,6 @@ module Zm
         body = init_hash_request(soap_name)
         req = { server: { name: server_name } }
         body[:Body][soap_name].merge!(req)
-        # puts body.to_json
         curl_request(body)
       end
 
@@ -475,7 +495,6 @@ module Zm
           }
         }
         body[:Body][soap_name].merge!(req)
-        # puts body.to_json
         curl_request(body)
       end
 
@@ -495,11 +514,24 @@ module Zm
         body = init_hash_request(soap_name, dest_id)
         req = { query: {} }
         body[:Body][soap_name].merge!(req)
-        # puts body
         curl_request(body)
         # curl_xml(SoapXmlBuilder.new(body).to_xml)
       end
 
+      def set_password(id, new_password)
+        soap_name = :SetPasswordRequest
+        body = init_hash_request(soap_name)
+        req = { id: id, newPassword: new_password }
+        body[:Body][soap_name].merge!(req)
+        curl_request(body)
+      end
+
+      def get_version_info
+        soap_name = :GetVersionInfoRequest
+        body = init_hash_request(soap_name)
+        curl_request(body)
+      end
+
       def init_hash_request(soap_name, target_server = nil)
         {
           Body: {

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

@@ -16,6 +16,13 @@ module Zm
       }.freeze
       BODY = :Body
 
+      def initialize(scheme, host, port, soap_path)
+        extend(ZmLogger)
+        @verbose = false
+        @uri = URI::HTTP.new(scheme, nil, host, port, nil, soap_path, nil, nil, nil)
+        init_curl_client
+      end
+
       def verbose!
         @verbose = true
         @curl.verbose = @verbose
@@ -36,10 +43,11 @@ module Zm
       end
 
       def curl_request(body, error_handler = SoapError)
-        puts body.to_json if @verbose
+        logger.debug body.to_json
         @curl.http_post(body.to_json)
 
-        puts @curl.body_str if @verbose
+        logger.debug @curl.body_str
+
         soapbody = JSON.parse(@curl.body_str, symbolize_names: true)
         raise(error_handler, soapbody) if @curl.status.to_i >= 400
 
@@ -47,7 +55,7 @@ module Zm
       end
 
       def curl_xml(xml, error_handler = SoapError)
-        # puts xml
+        logger.debug xml
         @curl.http_post(xml)
 
         soapbody = JSON.parse(@curl.body_str, symbolize_names: true)

data/lib/zm/client/contact/contact.rb

@@ -108,7 +108,8 @@ module Zm
       end
 
       def delete!
-        @parent.sacc.contact_action(@parent.token, :delete, id)
+        @parent.sacc.contact_action(@parent.token, :delete, @id)
+        super
       end
 
       def update!(hash)

data/lib/zm/client/contact/contacts_builder.rb

@@ -4,20 +4,10 @@ module Zm
   module Client
     # class factory [contacts]
     class ContactBuilder < Base::ObjectsBuilder
-
       def initialize(parent, json)
-        @parent = parent
-        @json = json
-      end
-
-      def make
-        root = @json[:Body][:GetContactsResponse][:cn]
-        return [] if root.nil?
-
-        root = [root] unless root.is_a?(Array)
-        root.map do |s|
-          Contact.new(@parent, s)
-        end
+        super(parent, json)
+        @child_class = Contact
+        @json_item_key = :cn
       end
     end
   end

data/lib/zm/client/contact/contacts_collection.rb

@@ -3,23 +3,17 @@
 module Zm
   module Client
     # collection account contacts
-    class ContactsCollection < Base::ObjectsCollection
+    class ContactsCollection < Base::AccountObjectsCollection
       def initialize(parent)
-        @parent = parent
-      end
-
-      def new
-        contact = Contact.new(@parent)
-        yield(contact) if block_given?
-        contact
+        @child_class = Contact
+        @builder_class = ContactBuilder
+        super(parent)
       end
 
       private
 
-      def build_response
-        rep = @parent.sacc.get_all_contacts(@parent.token)
-        cb = ContactBuilder.new @parent, rep
-        cb.make
+      def make_query
+        @parent.sacc.get_all_contacts(@parent.token)
       end
     end
   end

data/lib/zm/client/cos/cos.rb

@@ -16,11 +16,11 @@ module Zm
         @zimbraZimletAvailableZimlets = [@zimbraZimletAvailableZimlets] if @zimbraZimletAvailableZimlets.is_a?(String)
       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 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
         attrs_write
@@ -46,6 +46,10 @@ module Zm
         @servers ||= read_servers
       end
 
+      def accounts
+        # todo sélectionner tous les comptes qui ont zimbraCOSID=self.id
+      end
+
       private
 
       def read_servers

data/lib/zm/client/cos/coses_builder.rb

@@ -7,22 +7,7 @@ module Zm
       def initialize(parent, json)
         super(parent, json)
         @child_class = Cos
-      end
-
-      # def make
-      #   return [] if json_items.nil?
-      #
-      #   json_items.map do |entry|
-      #     cos = Cos.new(@parent)
-      #     cos.init_from_json(entry)
-      #     cos
-      #   end
-      # end
-
-      private
-
-      def json_items
-        @json_items ||= @json[:Body][json_key][:cos]
+        @json_item_key = :cos
       end
     end
   end

data/lib/zm/client/cos/coses_collection.rb

@@ -3,29 +3,26 @@
 module Zm
   module Client
     # Collection coses
-    class CosesCollection < Base::ObjectsCollection
+    class CosesCollection < Base::AdminObjectsCollection
       def initialize(parent)
         @child_class = Cos
+        @builder_class = CosesBuilder
+        @search_type = SearchType::COS
         @parent = parent
-        reset_query_params
       end
 
-      def find_by(hash, *attrs)
-        rep = sac.get_cos(hash.values.first, hash.keys.first, attrs.join(COMMA))
+      def find_by(hash)
+        rep = sac.get_cos(hash.values.first, hash.keys.first, attrs_comma)
         entry = rep[:Body][:GetCosResponse][:cos].first
 
+        reset_query_params
         build_from_entry(entry)
       end
 
       private
 
-      def build_response
-        CosesBuilder.new(@parent, make_query).make
-      end
-
       def reset_query_params
         super
-        @search_type = SearchType::COS
         @attrs = SearchType::Attributes::COS.dup
       end
     end

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

@@ -6,21 +6,22 @@ module Zm
     # objectClass: zimbraDistributionList
     class DistributionList < Base::AdminObject
       attr_accessor :members
-      attr_reader :owners
+      attr_reader :owners, :aces
 
       def initialize(parent)
         extend(DistributionListCommon)
         super(parent)
         @members = []
         @owners = []
+        @aces = []
         @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 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
@@ -35,6 +36,7 @@ module Zm
         @zimbraMailAlias = [@zimbraMailAlias].compact unless @zimbraMailAlias.is_a?(Array)
         @zimbraMailAlias.delete(@name)
         @aliases = @zimbraMailAlias
+        set_aces_from_json
       end
 
       def create!
@@ -99,6 +101,16 @@ module Zm
         @members -= emails
       end
 
+      def add_owners!(*emails)
+        # todo à tester
+        sac.distribution_list_action(@id, :id, { op: 'addOwners', owner: { by: :name, type: :usr, _content: emails } })
+      end
+
+      def remove_owners!(*emails)
+        # todo à tester
+        sac.distribution_list_action(@id, :id, { op: 'removeOwners', owner: { by: :name, type: :usr, _content: emails } })
+      end
+
       def local_transport
         raise Zm::Client::SoapError, 'zimbraMailHost is null' if zimbraMailHost.nil?
 
@@ -120,6 +132,32 @@ module Zm
 
         zimbraMailTransport.start_with?('smtp')
       end
+
+      def memberships
+        @memberships ||= DlsMembershipCollection.new(self)
+      end
+
+      def hide_in_gal?
+        zimbraHideInGal == 'TRUE'
+      end
+
+      def group?
+        zimbraMailStatus == 'disabled'
+      end
+
+      def mailing_list?
+        zimbraMailStatus == 'enabled'
+      end
+
+      def set_aces_from_json
+        return if @zimbraACE.nil?
+
+        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
+      end
     end
   end
 end

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

@@ -2,27 +2,12 @@
 
 module Zm
   module Client
-    # class factory [resources]
+    # class factory [dls]
     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]
+        @json_item_key = :dl
       end
     end
   end

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

@@ -3,34 +3,27 @@
 module Zm
   module Client
     # Collection Resources
-    class DistributionListsCollection < Base::ObjectsCollection
+    class DistributionListsCollection < Base::AdminObjectsCollection
       def initialize(parent)
         @child_class = DistributionList
+        @builder_class = DistributionListsBuilder
+        @search_type = SearchType::DL
         @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
 
+        reset_query_params
         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

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    DlMembership = Struct.new(:name, :id, :via)
+
+    class DlsMembershipCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @parent = parent
+      end
+
+      private
+
+      def make_query
+        @parent.sac.get_distribution_list_membership(@parent.id, :id)
+      end
+
+      def build_response
+        @all = make_query.dig(:Body, :GetDistributionListMembershipResponse, :dl) || []
+        @all.map { |json| DlMembership.new(json[:name], json[:id], json[:via]) }
+      end
+    end
+  end
+end

data/lib/zm/client/distributionlist.rb

@@ -3,3 +3,4 @@
 require 'zm/client/distributionlist/distributionlist'
 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

@@ -19,8 +19,8 @@ module Zm
         yield(self) if block_given?
       end
 
-      def concat
-        INSTANCE_VARIABLE_KEYS.map { |key| instance_variable_get(arrow_name(key)) }
+      def all_instance_variable_keys
+        INSTANCE_VARIABLE_KEYS
       end
 
       def folder
@@ -31,17 +31,19 @@ module Zm
         @parent.sacc.item_action(@parent.token, :tag, @id, tn: tag_name)
       end
 
+      def move!(folder_id)
+        @parent.sacc.item_action(@parent.token, 'move', @id, l: folder_id)
+        @l = folder_id
+      end
+
+      def delete!
+        @parent.sacc.item_action(@parent.token, :delete, @id)
+      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/domain/domain.rb

@@ -6,7 +6,7 @@ module Zm
     class Domain < Base::AdminObject
       INSTANCE_VARIABLE_KEYS = %i[name description zimbraDomainName zimbraDomainStatus zimbraId zimbraDomainType
         zimbraDomainDefaultCOSId zimbraGalAccountId zimbraPreAuthKey zimbraGalLdapBindDn zimbraGalLdapBindPassword
-        zimbraGalLdapFilter zimbraGalLdapSearchBase zimbraGalLdapURL zimbraGalMode]
+        zimbraGalLdapFilter zimbraGalLdapSearchBase zimbraGalLdapURL zimbraGalMode zimbraMailTransport]
 
       attr_accessor *INSTANCE_VARIABLE_KEYS
 
@@ -15,16 +15,27 @@ module Zm
         @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 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 create!
+        attrs_write = INSTANCE_VARIABLE_KEYS.dup
+        attrs_write.delete(:name)
+
+        rep = sac.create_domain(
+          @name,
+          instance_variables_array(attrs_write)
+        )
+        @id = rep[:Body][:CreateDomainResponse][:domain].first[:id]
+      end
+
       def update!(hash)
         sac.modify_domain(@id, hash)
 
@@ -40,9 +51,14 @@ module Zm
       end
 
       def accounts
-        @accounts ||= AccountsCollection.new(self)
+        @accounts ||= DomainAccountsCollection.new(self)
       end
 
+      # def account_quotas(server_id)
+      #   rep = sac.get_quota_usage(name, nil, nil, nil, nil, nil, nil, server_id)
+      #   AccountsBuilder.new(@parent, rep).make
+      # end
+
       def init_from_json(json)
         super(json)
         return unless json[:a].is_a? Array

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Accounts from domain
+    class DomainAccountsCollection < AccountsCollection
+      def initialize(parent)
+        @domain_name = parent.name
+        super(parent)
+      end
+    end
+  end
+end

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

@@ -7,25 +7,7 @@ module Zm
       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]
+        @json_item_key = :domain
       end
     end
   end