zm-ruby-client 0.14.0 → 0.18.0

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

@@ -2,22 +2,17 @@
 
 require_relative 'soap_base'
 require_relative 'soap_error'
-require_relative 'soap_xml_builder'
 
 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 } }
+      A_NODE_PROC = ->(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, SOAP_PATH, nil, nil, nil)
-        init_curl_client
+        super(scheme, host, port, '/service/admin/soap/')
       end
 
       def auth(mail, password)
@@ -47,7 +42,7 @@ module Zm
       def count_object(type)
         soap_name = :CountObjectsRequest
         body = init_hash_request(soap_name)
-        req = { type: type}
+        req = { type: type }
         body[:Body][soap_name].merge!(req)
         curl_request(body)
       end
@@ -90,7 +85,7 @@ module Zm
         curl_request(body)
       end
 
-      def create_data_source(name, account_id, type, attrs = { })
+      def create_data_source(name, account_id, type, attrs = {})
         req = {
           id: account_id,
           dataSource: {
@@ -141,23 +136,28 @@ module Zm
         curl_request(body)
       end
 
-      def create_cos(name, attrs = nil)
-        req = { name: name }
+      def create_cos(name, attrs = [])
+        req = { name: { _content: name } }
+        req[:a] = attrs.map do |i|
+          if i.last.is_a?(Array)
+            i.last.map do |j|
+              [i.first, j]
+            end
+          else
+            [i]
+          end
+        end.flatten(1).map(&A_NODE_PROC)
+
         body = init_hash_request(:CreateCosRequest)
         body[:Body][:CreateCosRequest].merge!(req)
-        # a: attrs.to_a.map(&A_NODE_PROC)
-        # a: attrs.to_a.map { |n| { n: n.first, _content: n.last } }
-        # puts SoapXmlBuilder.new(body).to_xml
-        # todo ne fonctionne pas !
-        curl_xml(SoapXmlBuilder.new(body).to_xml)
+        curl_request(body)
       end
 
-      def modify_cos(id, attrs = nil)
+      def modify_cos(id, _attrs = nil)
         # 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 !
+        # 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)
       end
@@ -165,11 +165,18 @@ module Zm
       def create_account(name, password = nil, attrs = [])
         soap_name = :CreateAccountRequest
         req = { name: name, password: password }.reject { |_, v| v.nil? }
-        req[:a] = attrs.map { |i| i.last.is_a?(Array) ? i.last.map{|j|[i.first, j]} : [i] }.flatten(1).map(&A_NODE_PROC)
+        req[:a] = attrs.map do |i|
+          if i.last.is_a?(Array)
+            i.last.map do |j|
+              [i.first, j]
+            end
+          else
+            [i]
+          end
+        end.flatten(1).map(&A_NODE_PROC)
         # 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
 
@@ -177,7 +184,15 @@ module Zm
         soap_name = :CreateCalendarResourceRequest
         req = { name: name, password: password }
         req.reject! { |_, v| v.nil? }
-        req[:a] = attrs.map { |i| i.last.is_a?(Array) ? i.last.map{|j|[i.first, j]} : [i] }.flatten(1).map(&A_NODE_PROC)
+        req[:a] = attrs.map do |i|
+          if i.last.is_a?(Array)
+            i.last.map do |j|
+              [i.first, j]
+            end
+          else
+            [i]
+          end
+        end.flatten(1).map(&A_NODE_PROC)
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
         curl_request(body)
@@ -186,10 +201,17 @@ module Zm
       def create_distribution_list(name, attrs = [])
         soap_name = :CreateDistributionListRequest
         req = { name: name }
-        req[:a] = attrs.map { |i| i.last.is_a?(Array) ? i.last.map{|j|[i.first, j]} : [i] }.flatten(1).map(&A_NODE_PROC)
+        req[:a] = attrs.map do |i|
+          if i.last.is_a?(Array)
+            i.last.map do |j|
+              [i.first, j]
+            end
+          else
+            [i]
+          end
+        end.flatten(1).map(&A_NODE_PROC)
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
-        # puts body
         curl_request(body)
       end
 
@@ -215,14 +237,6 @@ 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
@@ -231,7 +245,6 @@ module Zm
         generic_alias(:RemoveAccountAliasRequest, id, email)
       end
 
-
       def rename_account(id, email)
         generic_rename(:RenameAccountRequest, id, email)
       end
@@ -245,7 +258,7 @@ module Zm
       end
 
       def generic_members(soap_name, id, emails)
-        req = { id: id, dlm: emails.map { |email| {_content: email} } }
+        req = { id: id, dlm: emails.map { |email| { _content: email } } }
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
         curl_request(body)
@@ -263,7 +276,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
 
@@ -284,7 +296,6 @@ module Zm
         body = init_hash_request(:GetDomainRequest)
         body[:Body][:GetDomainRequest].merge!(req)
         # TODO: tester param attrs
-        # puts body
         curl_request(body)
       end
 
@@ -309,7 +320,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
 
@@ -341,6 +351,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
@@ -369,8 +389,8 @@ module Zm
         curl_request(body)
       end
 
-      def search_directory(query = nil, maxResults = nil, limit = nil, offset = nil, domain = nil, applyCos = nil, applyConfig = nil, sortBy = nil, types = nil, sortAscending = nil, countOnly = nil, attrs = nil)
-
+      def search_directory(query = nil, maxResults = nil, limit = nil, offset = nil, domain = nil, applyCos = nil,
+                           applyConfig = nil, sortBy = nil, types = nil, sortAscending = nil, countOnly = nil, attrs = nil)
         # Désactivé car moins performant !
         # req = Hash[method(__method__).parameters.map{ |p|[p.last, (eval p.last.to_s)] }].select!{ |k,v|!v.nil? }
 
@@ -394,12 +414,12 @@ 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
 
-      def get_quota_usage(domain = nil, allServers = nil, limit = nil, offset = nil, sortBy = nil, sortAscending = nil, refresh = nil, target_server_id = nil)
+      def get_quota_usage(domain = nil, allServers = nil, limit = nil, offset = nil, sortBy = nil, sortAscending = nil,
+                          refresh = nil, target_server_id = nil)
         soap_name = :GetQuotaUsageRequest
         req = {
           domain: domain,
@@ -420,20 +440,20 @@ module Zm
       def get_mailbox(id)
         soap_name = :GetMailboxRequest
         req = {
-            mbox: {
-                id: id
-            }
+          mbox: {
+            id: id
+          }
         }
         body = init_hash_request(soap_name)
         body[:Body][soap_name].merge!(req)
         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
@@ -467,7 +487,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
 
@@ -495,7 +514,6 @@ module Zm
           }
         }
         body[:Body][soap_name].merge!(req)
-        # puts body.to_json
         curl_request(body)
       end
 
@@ -505,7 +523,8 @@ module Zm
         soap_name = :MailQueueActionRequest
         value = [value] unless value.is_a?(Array)
         body = init_hash_request(soap_name)
-        req = { server: { name: server_name, queue: { name: queue_name, action: { op: op, by: by, _content: value.join(',') } } } }
+        req = { server: { name: server_name,
+                          queue: { name: queue_name, action: { op: op, by: by, _content: value.join(',') } } } }
         body[:Body][soap_name].merge!(req)
         curl_request(body)
       end
@@ -515,9 +534,21 @@ 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)

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,19 +43,10 @@ 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
-        soapbody = JSON.parse(@curl.body_str, symbolize_names: true)
-        raise(error_handler, soapbody) if @curl.status.to_i >= 400
-
-        soapbody
-      end
-
-      def curl_xml(xml, error_handler = SoapError)
-        # puts xml
-        @curl.http_post(xml)
+        logger.debug @curl.body_str
 
         soapbody = JSON.parse(@curl.body_str, symbolize_names: true)
         raise(error_handler, soapbody) if @curl.status.to_i >= 400
@@ -57,7 +55,9 @@ module Zm
       end
 
       def hash_header(token, target_server = nil)
-        context = { authToken: token, userAgent: { name: :zmsoap }, targetServer: target_server }.delete_if { |_, v| v.nil? }
+        context = { authToken: token, userAgent: { name: :zmsoap }, targetServer: target_server }.delete_if do |_, v|
+          v.nil?
+        end
         { Header: { context: context, _jsns: BASESPACE } }
       end
     end

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
@@ -39,13 +39,18 @@ module Zm
       end
 
       def create!
-        sac.create_cos(name, instance_variables_array(attrs_write))
+        rep = sac.create_cos(name, instance_variables_array(attrs_write))
+        @id = rep[:Body][:CreateCosResponse][:cos].first[:id]
       end
 
       def servers
         @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