zm-ruby-client 0.10.4

data/lib/zm/client/constant.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    COMMA = ','
+    DOUBLEPOINT = ' :: '
+
+    module Regex
+      UUID_REGEX = %r{[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}}
+      BASEDN_REGEX = %r{^uid=}
+      SHARED_CONTACT = %r{[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}:[0-9]+}
+    end
+
+    module FolderDefault
+      ROOT = { id: 1, name: '', path: '/', type: 'unknown' }.freeze
+      BRIEFCASE = { id: 16, name: 'Briefcase', path: '/Briefcase', type: 'document' }.freeze
+      CALENDAR = { id: 10, name: 'Calendar', path: '/Calendar', type: 'appointment' }.freeze
+      CHATS = { id: 14, name: 'Chats', path: '/Chats', type: 'message' }.freeze
+      CONTACTS = { id: 7, name: 'Contacts', path: '/Contacts', type: 'contact' }.freeze
+      DRAFTS = { id: 6, name: 'Drafts', path: '/Drafts', type: 'message' }.freeze
+      EMAILED = { id: 13, name: 'Emailed Contacts', path: '/Emailed Contacts', type: 'contact' }.freeze
+      INBOX = { id: 2, name: 'Inbox', path: '/Inbox', type: 'message' }.freeze
+      JUNK = { id: 4, name: 'Junk', path: '/Junk', type: 'message' }.freeze
+      SENT = { id: 5, name: 'Sent', path: '/Sent', type: 'message' }.freeze
+      TASKS = { id: 15, name: 'Tasks', path: '/Tasks', type: 'task' }.freeze
+      TRASH = { id: 3, name: 'Trash', path: '/Trash', type: 'unknown' }.freeze
+
+      ALL = [
+        ROOT,
+        BRIEFCASE,
+        CALENDAR,
+        CHATS,
+        CONTACTS,
+        DRAFTS,
+        EMAILED,
+        INBOX,
+        JUNK,
+        SENT,
+        TASKS,
+        TRASH
+      ].freeze
+
+      IDS = ALL.map { |folder| folder[:id] }.freeze
+    end
+
+    module ShareType
+      VIEWER = :r
+      MANAGER = :rwidx
+      ADMIN = :rwidxa
+    end
+
+    module FolderView
+      UNKNOWN = 'unknown'
+      MESSAGE = 'message'
+      APPOINTMENT = 'appointment'
+      TASK = 'task'
+      DOCUMENT = 'document'
+      CONTACT = 'contact'
+      ALL = [MESSAGE, APPOINTMENT, TASK, DOCUMENT, CONTACT].freeze
+    end
+
+    module FolderType
+      FOLDER = :folder
+      LINK = :link
+      SEARCH = :search
+      ALL = [FOLDER, LINK, SEARCH].freeze
+    end
+
+    module SoapUtils
+      MAX_RESULT = 1_000_000
+      ON = 1
+      OFF = 0
+      OFFSET = 0
+      LIMIT_RESULT = 10_000
+    end
+
+    module SearchType
+      ACCOUNT = :accounts
+      DL = :distributionlists
+      ALIAS = :aliases
+      RESOURCE = :resources
+      DOMAIN = :domains
+      COS = :coses
+
+      module Attributes
+        ACCOUNT = %i[
+          displayName
+          zimbraId
+          cn
+          sn
+          zimbraMailHost
+          uid
+          zimbraCOSId
+          zimbraAccountStatus
+          zimbraLastLogonTimestamp
+          description
+          zimbraIsSystemAccount
+          zimbraIsDelegatedAdminAccount
+          zimbraAuthTokenValidityValue
+          zimbraMailStatus
+          zimbraIsAdminAccount
+          zimbraIsExternalVirtualAccount
+        ].freeze
+
+        DL = %i[
+          displayName
+          zimbraId
+          zimbraMailHost
+          uid
+          description
+          zimbraMailStatus
+          zimbraMailAlias
+        ].freeze
+
+        ALIAS = %i[
+          zimbraAliasTargetId
+          zimbraId
+          targetName
+          uid
+          type
+          description
+          zimbraIsDelegatedAdminAccount
+          zimbraIsAdminAccount
+          zimbraIsSystemResource
+          zimbraIsSystemAccount
+          zimbraIsExternalVirtualAccount
+        ].freeze
+
+        RESOURCE = %i[
+          displayName
+          zimbraId
+          zimbraMailHost
+          uid
+          zimbraAccountStatus
+          description
+          zimbraCalResType
+          zimbraIsDelegatedAdminAccount
+          zimbraIsAdminAccount
+          zimbraIsSystemResource
+          zimbraIsSystemAccount
+          zimbraIsExternalVirtualAccount
+        ].freeze
+
+        DOMAIN = %i[
+          description
+          zimbraDomainName
+          zimbraDomainStatus
+          zimbraId
+          zimbraDomainType
+          zimbraDomainDefaultCOSId
+        ].freeze
+
+        COS = %i[
+          cn
+          description
+          zimbraMailHostPool
+          zimbraMailQuota
+        ].freeze
+      end
+    end
+
+    module ServerServices
+      AMAVIS = 'amavis'
+      ANTIVIRUS = 'antivirus'
+      ANTISPAM = 'antispam'
+      OPENDKIM = 'opendkim'
+      DNSCACHE = 'dnscache'
+      LOGGER = 'logger'
+      LDAP = 'ldap'
+      SERVICE = 'service'
+      ZIMBRA = 'zimbra'
+      ZIMBRA_ADMIN = 'zimbraAdmin'
+      ZIMLET = 'zimlet'
+      MAILBOX = 'mailbox'
+      MEMCACHED = 'memcached'
+      SPELL = 'spell'
+      MTA = 'mta'
+      PROXY = 'proxy'
+      STATS = 'stats'
+      SNMP = 'snmp'
+    end
+
+    module MtaQueueName
+      INCOMING = 'incoming'
+      DEFERRED = 'deferred'
+      CORRUPT = 'corrupt'
+      ACTIVE = 'active'
+      HOLD = 'hold'
+      ALL = [INCOMING, DEFERRED, CORRUPT, ACTIVE, HOLD]
+    end
+
+    module MtaQueueAction
+      HOLD = 'hold'
+      RELEASE = 'release'
+      DELETE = 'delete'
+      REQUEUE = 'requeue'
+    end
+
+    module BackupTypes
+      FULL = 'full'
+      INCREMENTAL = 'incremental'
+    end
+
+    module CountTypes
+      USER_ACCOUNT = 'userAccount'
+      ACCOUNT = 'account'
+      ALIAS = 'alias'
+      DL = 'dl'
+      DOMAIN = 'domain'
+      COS = 'cos'
+      SERVER = 'server'
+      RESOURCE = 'calresource'
+      INTERNAL_USER_ACCOUNT = 'internalUserAccount'
+      ALL = [USER_ACCOUNT, ACCOUNT, ALIAS, DL, DOMAIN, COS, SERVER, RESOURCE, INTERNAL_USER_ACCOUNT]
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class account tag
+    class Contact < Base::AccountObject
+      GROUP_PATTERN = 'group'
+
+      INSTANCE_VARIABLE_KEYS = %i[
+        anniversary assistantPhone birthday callbackPhone carPhone company companyPhone custom1 department email email2
+        email3 email4 email5 email6 email7 firstName fullName homeCity homeCountry homeFax homePhone homePostalCode
+        homeState homeStreet homeURL imAddress1 imAddress2 imAddress3 imAddress4 imAddress5 jobTitle lastName maidenName
+        middleName mobilePhone namePrefix nameSuffix nickname notes otherCity otherCountry otherFax otherPhone
+        otherPostalCode otherState otherStreet otherURL pager workCity workCountry workFax workPhone workPostalCode
+        workState workStreet workURL image
+      ].freeze
+
+      attr_accessor *INSTANCE_VARIABLE_KEYS
+      attr_accessor :id, :name, :l, :type, :members, :old_members, :tn
+
+      def initialize(parent, json = nil)
+        @parent  = parent
+        @members = []
+        @custom_keys = []
+        init_from_json(json) if json.is_a?(Hash)
+        yield(self) if block_given?
+        @old_members = @members.clone
+      end
+
+      def is_group?
+        @type == GROUP_PATTERN
+      end
+
+      def emails
+        [email, email2, email3, email4, email5, email6, email7].compact
+      end
+
+      def emails_h
+        {
+            'email' => email,
+            'email2' => email2,
+            'email3' => email3,
+            'email4' => email4,
+            'email5' => email5,
+            'email6' => email6,
+            'email7' => email7
+        }.compact
+      end
+
+      def concat
+        [id, name, l] + all_instance_variable_keys.map { |key| instance_variable_get(arrow_name(key)) }
+      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 init_from_json(json)
+        @id   = json[:id]
+        @name = json[:fileAsStr]
+        @l    = json[:l]
+        @tn   = json[:tn]
+
+        init_instance_variable_from_json(json[:_attrs])
+
+        return unless is_group?
+
+        extend(GroupContact)
+        init_members_from_json(json[:m])
+      end
+
+      def init_instance_variable_from_json(json_attrs)
+        return if json_attrs.nil?
+
+        @type = json_attrs[:type]
+
+        make_custom_keys(json_attrs)
+
+        all_instance_variable_keys.each do |key|
+          instance_variable_set(arrow_name(key), json_attrs[key])
+        end
+      end
+
+      def make_custom_keys(json_attrs)
+        @custom_keys = json_attrs.keys - INSTANCE_VARIABLE_KEYS - %i[type fileAs]
+        return if @custom_keys.empty?
+
+        self.class.attr_accessor(*@custom_keys)
+      rescue StandardError => _
+        @custom_keys.clear
+        nil
+      end
+
+      def all_instance_variable_keys
+        INSTANCE_VARIABLE_KEYS + @custom_keys
+      end
+
+      def add_custom_property(key, value)
+        instance_variable_set(arrow_name(key), value)
+        @custom_keys << key unless all_instance_variable_keys.include?(key)
+      end
+
+      def create!
+        rep = @parent.sacc.create_contact(@parent.token, l, instance_variables_array(all_instance_variable_keys))
+        init_from_json(rep[:Body][:CreateContactResponse][:cn].first)
+      end
+
+      def delete!
+        @parent.sacc.contact_action(@parent.token, :delete, id)
+      end
+
+      def update!(hash)
+        @parent.sacc.modify_contact(@parent.token, id, hash)
+        hash.each { |k, v| send "#{k}=", v }
+      end
+
+      def modify!
+        @parent.sacc.modify_contact(@parent.token, id, instance_variables_array(all_instance_variable_keys))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    class ConcatMember
+      INTERNAL = 'C'
+      FREE     = 'I'
+      LDAP     = 'G'
+      ADD      = '+'
+      DEL      = '-'
+
+      class << self
+        def find_type_by_value(value)
+          return INTERNAL if !value.to_i.zero? || Zm::Client::Regex::SHARED_CONTACT.match(value)
+          return LDAP if Zm::Client::Regex::BASEDN_REGEX.match(value)
+
+          FREE
+        end
+
+        def init_by_value(value)
+          type_v = find_type_by_value(value)
+          new(type_v, value)
+        end
+      end
+
+      attr_reader :type, :value, :op
+
+      def initialize(type, value, op = nil)
+        @op = op
+        @type = type
+        @value = value
+      end
+
+      def concat
+        [@value, @type, @op]
+      end
+
+      def to_s
+        concat.join(' :: ')
+      end
+
+      def internal?
+        @type == INTERNAL && !Zm::Client::Regex::SHARED_CONTACT.match(value)
+      end
+
+      def shared?
+        @type == INTERNAL && Zm::Client::Regex::SHARED_CONTACT.match(value)
+      end
+
+      def free?
+        @type == FREE
+      end
+
+      def ldap?
+        @type == LDAP
+      end
+
+      def add!
+        @op = ADD
+      end
+
+      def remove!
+        @op = DEL
+      end
+
+      def construct_soap_node
+        node = { type: @type, value: @value }
+        node[:op] = @op unless @op.nil?
+        node
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # collection account contacts
+    class ContactsCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @parent = parent
+      end
+
+      def new
+        contact = Contact.new(@parent)
+        yield(contact) if block_given?
+        contact
+      end
+
+      private
+
+      def build_response
+        rep = @parent.sacc.get_all_contacts(@parent.token)
+        cb = ContactBuilder.new @parent, rep
+        cb.make
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module GroupContact
+  def init_members_from_json(m)
+    return if m.nil?
+
+    @members = m.map { |m| Zm::Client::ConcatMember.new(m[:type], m[:value]) }
+  end
+
+  def create!
+    rep = @parent.sacc.create_group_contact(@parent.token, l, construct_soap_attrs, construct_soap_node_members)
+    init_from_json(rep[:Body][:CreateContactResponse][:cn].first)
+  end
+
+  def modify!
+    @parent.sacc.modify_group_contact(@parent.token, id, construct_soap_attrs, construct_soap_node_members)
+  end
+
+  def construct_soap_attrs
+    [[:nickname, @name], [:fullname, @name], [:fileAs, "8:#{@name}"], %i[type group]]
+  end
+
+  def add_contacts(contacts)
+    contacts = [contacts] unless contacts.is_a?(Array)
+    new_members = contacts.map { |c| add_member_by_value(c.id) }
+    add_members(new_members)
+  end
+
+  def add_members(new_members)
+    new_members = [new_members] unless new_members.is_a?(Array)
+    @members += new_members
+  end
+
+  def add_members_by_values(member_values)
+    member_values = [member_values] unless member_values.is_a?(Array)
+    current_member_values = @members.map(&:value)
+    member_values.reject! { |value| current_member_values.include?(value) }
+    member_values.each { |value| add_member_by_value(value) }
+  end
+
+  def add_member_by_value(value)
+    @members << Zm::Client::ConcatMember.init_by_value(value)
+  end
+
+  def delete_members(del_members)
+    del_members = [del_members] unless del_members.is_a?(Array)
+    @members -= del_members
+  end
+
+  def del_members_by_values(member_values)
+    member_values = [member_values] unless member_values.is_a?(Array)
+    @members.delete_if { |m| member_values.include?(m.value) }
+  end
+
+  def ldap_members
+    return [] if @members.nil?
+
+    @members.select(&:ldap?)
+  end
+
+  def has_ldap_members?
+    ldap_members.any?
+  end
+
+  def construct_soap_node_members
+    if recorded?
+      (old_members - @members).each(&:remove!)
+      (@members - old_members).each(&:add!)
+      (old_members + @members).uniq.reject { |m| m.op.nil? }.map(&:construct_soap_node)
+    else
+      @members.map(&:construct_soap_node)
+    end
+  end
+end

data/lib/zm/client/contact.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'zm/client/contact/contact'
+require 'zm/client/contact/contact_member'
+require 'zm/client/contact/contacts_builder'
+require 'zm/client/contact/contacts_collection'
+require 'zm/client/contact/mod_group_contact'

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'zm/modules/common/cos_common'
+module Zm
+  module Client
+    # objectClass: zimbraCos
+    class Cos < Base::AdminObject
+      def initialize(parent)
+        extend(CosCommon)
+        super(parent)
+      end
+
+      def init_from_json(json)
+        super(json)
+        @zimbraMailHostPool = [@zimbraMailHostPool] if @zimbraMailHostPool.is_a?(String)
+        @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 all_instance_variable_keys
+        attrs_write
+      end
+
+      def duplicate(attrs = {})
+        # n = clone
+        # attrs.each{|k,v| n.instance_variable_set(k, v) }
+        # n.id = nil
+        # n.zimbraId = nil
+        # n
+      end
+
+      def modify!
+        # sac.modify_cos(id, instance_variables_array)
+      end
+
+      def create!
+        sac.create_cos(name, instance_variables_array(attrs_write))
+      end
+
+      def servers
+        @servers ||= read_servers
+      end
+
+      private
+
+      def read_servers
+        sc = ServersCollection.new self
+        @zimbraMailHostPool.map do |server_id|
+          sc.find_by id: server_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [coses]
+    class CosesBuilder < Base::ObjectsBuilder
+      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]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection coses
+    class CosesCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @child_class = 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))
+        entry = rep[:Body][:GetCosResponse][:cos].first
+
+        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
+  end
+end

data/lib/zm/client/cos.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'zm/client/cos/cos'
+require 'zm/client/cos/coses_builder'
+require 'zm/client/cos/coses_collection'

data/lib/zm/client/data_source.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'zm/client/data_source/data_source'
+require 'zm/client/data_source/data_sources_builder'
+require 'zm/client/data_source/data_sources_collection'