zm-ruby-client 3.0.1 → 3.1.0

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

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'openssl'
-
-require_relative 'soap_error'
-
-module Zm
-  module Client
-    class SoapBaseConnector
-      BASESPACE = 'urn:zimbra'
-      HTTP_HEADERS = {
-        'Content-Type' => 'application/json; charset=utf-8',
-        'User-Agent' => 'ZmRubyClient'
-      }.freeze
-
-      attr_reader :context
-      attr_writer :logger, :cache, :timeout
-
-      def initialize(url, soap_path)
-        @verbose = false
-        @timeout = 300
-
-        @ssl_options = {
-          verify: false,
-          verify_hostname: false,
-          verify_mode: OpenSSL::SSL::VERIFY_NONE
-        }
-
-        @url = url
-        @soap_path = soap_path
-
-        @context = SoapContext.new
-      end
-
-      def verbose!
-        @verbose = true
-      end
-
-      def invoke(soap_element, error_handler = SoapError)
-        do_request(envelope(soap_element), error_handler)[:Body]
-      end
-
-      def target_invoke(soap_element, target_id, error_handler = SoapError)
-        @context.target_server(target_id)
-        resp = invoke(soap_element, error_handler)
-        @context.target_server(nil)
-        resp
-      end
-
-      def http_client!
-        @http_client = Faraday.new(
-          url: @url,
-          headers: HTTP_HEADERS,
-          request: {
-            timeout: @timeout
-          },
-          ssl: @ssl_options
-        ) do |faraday|
-          faraday.request :json
-          faraday.response :logger, nil, { headers: true, bodies: true, errors: true } if @verbose
-        end
-      end
-
-      private
-
-      def http_client
-        @http_client || http_client!
-      end
-
-      def do_request(body, error_handler = SoapError)
-        json_body = body.to_json
-        @logger.debug json_body
-
-        # cache json response
-        # no cache if response raise
-        json_response = @cache.fetch(json_body) do
-          @logger.debug 'Load from remote'
-          response = http_client.post(@soap_path, json_body)
-          @logger.debug response.body
-
-          raise(error_handler, JSON.parse(response.body, symbolize_names: true)) if response.status >= 400
-
-          response.body
-        end
-
-        JSON.parse(json_response, symbolize_names: true)
-
-        # rescue Faraday::ConnectionFailed, SocketError => error
-        #   @logger.error "SoapConnectorError (#{error.class}): #{error.message}"
-        #   # raise error
-        #   {}
-        #   nil
-      end
-
-      def envelope(soap_element)
-        {
-          Body: soap_element.to_hash,
-          Header: { context: context.to_hash, _jsns: BASESPACE }
-        }
-      end
-    end
-  end
-end

data/lib/zm/client/constant.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-module Zm
-  module Client
-    COMMA = ','
-    DOUBLEPOINT = ' :: '
-
-    module Regex
-      UUID_REGEX = /[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 = /^uid=/
-      SHARED_CONTACT = /[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
-      FolderData = Data.define(:id, :name, :path, :type)
-
-      ROOT = FolderData.new(1, '', '/', 'unknown')
-      INBOX = FolderData.new(2, 'Inbox', '/Inbox', 'message')
-      TRASH = FolderData.new(3, 'Trash', '/Trash', 'unknown')
-      JUNK = FolderData.new(4, 'Junk', '/Junk', 'message')
-      SENT = FolderData.new(5, 'Sent', '/Sent', 'message')
-      DRAFTS = FolderData.new(6, 'Drafts', '/Drafts', 'message')
-      CONTACTS = FolderData.new(7, 'Contacts', '/Contacts', 'contact')
-      CALENDAR = FolderData.new(10, 'Calendar', '/Calendar', 'appointment')
-      EMAILED = FolderData.new(13, 'Emailed Contacts', '/Emailed Contacts', 'contact')
-      CHATS = FolderData.new(14, 'Chats', '/Chats', 'message')
-      TASKS = FolderData.new(15, 'Tasks', '/Tasks', 'task')
-      BRIEFCASE = FolderData.new(16, 'Briefcase', '/Briefcase', 'document')
-
-      ALL = [
-        ROOT,
-        BRIEFCASE,
-        CALENDAR,
-        CHATS,
-        CONTACTS,
-        DRAFTS,
-        EMAILED,
-        INBOX,
-        JUNK,
-        SENT,
-        TASKS,
-        TRASH
-      ].freeze
-
-      IDS = ALL.map(&: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 = %w[
-          displayName
-          zimbraId
-          cn
-          sn
-          zimbraMailHost
-          uid
-          zimbraCOSId
-          zimbraAccountStatus
-          zimbraLastLogonTimestamp
-          description
-          zimbraIsSystemAccount
-          zimbraIsDelegatedAdminAccount
-          zimbraAuthTokenValidityValue
-          zimbraMailStatus
-          zimbraIsAdminAccount
-          zimbraIsExternalVirtualAccount
-        ].freeze
-
-        DL = %w[
-          displayName
-          zimbraId
-          zimbraMailHost
-          uid
-          description
-          zimbraMailStatus
-          zimbraMailAlias
-        ].freeze
-
-        ALIAS = %w[
-          zimbraAliasTargetId
-          zimbraId
-          targetName
-          uid
-          type
-          description
-          zimbraIsDelegatedAdminAccount
-          zimbraIsAdminAccount
-          zimbraIsSystemResource
-          zimbraIsSystemAccount
-          zimbraIsExternalVirtualAccount
-        ].freeze
-
-        RESOURCE = %w[
-          displayName
-          zimbraId
-          zimbraMailHost
-          uid
-          zimbraAccountStatus
-          description
-          zimbraCalResType
-          zimbraIsDelegatedAdminAccount
-          zimbraIsAdminAccount
-          zimbraIsSystemResource
-          zimbraIsSystemAccount
-          zimbraIsExternalVirtualAccount
-        ].freeze
-
-        DOMAIN = %w[
-          description
-          zimbraDomainName
-          zimbraDomainStatus
-          zimbraId
-          zimbraDomainType
-          zimbraDomainDefaultCOSId
-        ].freeze
-
-        COS = %w[
-          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].freeze
-    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].freeze
-    end
-
-    module ContentType
-      TEXT = 'text/plain'
-      HTML = 'text/html'
-      ALL = [TEXT, HTML].freeze
-    end
-
-    module ContentPart
-      ALTERNATIVE = 'multipart/alternative'
-    end
-  end
-end

data/lib/zm/client/contact.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/contact/contact'
-require 'zm/client/contact/contact_members_collection'
-require 'zm/client/contact/mod_group_contact'
-require 'zm/client/contact/contact_jsns_initializer'
-require 'zm/client/contact/contact_jsns_builder'
-require 'zm/client/contact/group_contact_jsns_builder'
-require 'zm/client/contact/contact_member'
-require 'zm/client/contact/contacts_builder'
-require 'zm/client/contact/contacts_collection'

data/lib/zm/client/cos.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/cos/cos'
-require 'zm/client/cos/cos_jsns_initializer'
-require 'zm/client/cos/cos_jsns_builder'
-require 'zm/client/cos/coses_builder'
-require 'zm/client/cos/coses_collection'
-require 'zm/client/cos/cos_servers_collection'
-require 'zm/client/cos/cos_domains_collection'
-require 'zm/client/cos/cos_accounts_collection'

data/lib/zm/client/datasource.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/datasource/datasource'
-require 'zm/client/datasource/datasource_jsns_initializer'
-require 'zm/client/datasource/datasource_jsns_builder'
-require 'zm/client/datasource/datasources_builder'
-require 'zm/client/datasource/datasources_collection'

data/lib/zm/client/distributionlist.rb

@@ -1,8 +0,0 @@
-# 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.rb

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

data/lib/zm/client/domain.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/domain/domain'
-require 'zm/client/domain/domains_builder'
-require 'zm/client/domain/domain_jsns_builder'
-require 'zm/client/domain/domain_jsns_initializer'
-require 'zm/client/domain/domains_collection'
-require 'zm/client/domain/domain_accounts_collection'
-require 'zm/client/domain/domain_distributionlists_collection'
-require 'zm/client/domain/domain_resources_collection'

data/lib/zm/client/filter_rule.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/filter_rules/filter_rule'
-require 'zm/client/filter_rules/filter_rule_jsns_initializer'
-require 'zm/client/filter_rules/filter_rules_builder'
-require 'zm/client/filter_rules/filter_rules_collection'
-require 'zm/client/filter_rules/outgoing_filter_rules_collection'

data/lib/zm/client/folder.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/folder/folder'
-require 'zm/client/folder/folder_jsns_builder'
-require 'zm/client/folder/folder_jsns_initializer'
-require 'zm/client/folder/folders_jsns_builder'
-require 'zm/client/folder/folder_grant'
-require 'zm/client/folder/folder_grants_collection'
-require 'zm/client/folder/folder_grant_jsns_builder'
-require 'zm/client/folder/folder_retention_policy'
-require 'zm/client/folder/folder_retention_policies_collection'
-require 'zm/client/folder/folders_builder'
-require 'zm/client/folder/folders_collection'
-require 'zm/client/folder/mod_document_folder'

data/lib/zm/client/identity.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/identity/identity'
-require 'zm/client/identity/identity_jsns_builder'
-require 'zm/client/identity/identity_jsns_initializer'
-require 'zm/client/identity/identities_builder'
-require 'zm/client/identity/identities_collection'

data/lib/zm/client/license.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/license/license'
-require 'zm/client/license/license_jsns_initializer'
-require 'zm/client/license/licenses_collection'

data/lib/zm/client/message/attachments_collection.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Zm
-  module Client
-    class Message
-      # collection attachments
-      class AttachmentsCollection
-        include MissingMethodStaticCollection
-
-        attr_reader :all
-
-        def initialize
-          @all = []
-        end
-
-        def add(attachment)
-          return unless attachment.is_a?(Attachment)
-
-          @all.push(attachment)
-        end
-      end
-
-      # class attachment for email
-      class Attachment
-        attr_accessor :aid, :part, :mid, :ct, :s, :filename, :ci, :cd
-
-        def initialize(parent)
-          @parent = parent
-          yield(self) if block_given?
-        end
-
-        def download(dest_file_path)
-          h = {
-            id: @parent.id,
-            part: part,
-            auth: 'qp',
-            zauthtoken: account.token,
-            disp: 'a'
-          }
-
-          url = account.home_url
-
-          url << '?' << h.map { |k, v| "#{k}=#{v}" }.join('&')
-
-          uploader = @parent.build_uploader
-          uploader.download_file_with_url(url, dest_file_path)
-        end
-
-        def account
-          @parent.parent
-        end
-      end
-    end
-  end
-end

data/lib/zm/client/message/message_flags.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-module Zm
-  module Client
-    # class message for account
-    class Message
-      class FlagsCollection
-        def initialize(parent)
-          @parent = parent
-        end
-
-        def all
-          @all ||= @parent.f.to_s.chars
-        end
-
-        # properties
-
-        def unread?
-          all.include?('u')
-        end
-
-        def flagged?
-          all.include?('f')
-        end
-
-        def attachment?
-          all.include?('a')
-        end
-
-        def replied
-          all.include?('r')
-        end
-
-        def sent_by_me?
-          all.include?('s')
-        end
-
-        def forwarded?
-          all.include?('w')
-        end
-
-        def calendar_invite?
-          all.include?('v')
-        end
-
-        def draft?
-          all.include?('d')
-        end
-
-        def imap_deleted?
-          all.include?('x')
-        end
-
-        def notification?
-          all.include?('n')
-        end
-
-        def urgent?
-          all.include?('!')
-        end
-
-        def low_priority?
-          all.include?('?')
-        end
-
-        def priority?
-          all.include?('+')
-        end
-
-        # actions
-
-        def unread!
-          @parent.soap_connector.invoke(build_unread)
-        end
-
-        def build_unread
-          build({ op: '!read', id: @parent.id })
-        end
-
-        def read!
-          @parent.soap_connector.invoke(build_read)
-        end
-
-        def build_read
-          build({ op: 'read', id: @parent.id })
-        end
-
-        def unflag!
-          @parent.soap_connector.invoke(build_unflag)
-        end
-
-        def build_unflag
-          build({ op: '!flag', id: @parent.id })
-        end
-
-        def flag!
-          @parent.soap_connector.invoke(build_flag)
-        end
-
-        def build_flag
-          build({ op: 'flag', id: @parent.id })
-        end
-
-        private
-
-        def build(attrs)
-          soap_request = SoapElement.mail(SoapMailConstants::ITEM_ACTION_REQUEST)
-          node_action = SoapElement.create(SoapConstants::ACTION).add_attributes(attrs)
-          soap_request.add_node(node_action)
-          soap_request
-        end
-      end
-    end
-  end
-end

data/lib/zm/client/message.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/message/message'
-require 'zm/client/message/message_flags'
-require 'zm/client/message/message_recipients'
-require 'zm/client/message/attachments_collection'
-require 'zm/client/message/message_jsns_builder'
-require 'zm/client/message/message_jsns_initializer'
-require 'zm/client/message/messages_builder'
-require 'zm/client/message/messages_collection'

data/lib/zm/client/mountpoint.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/mountpoint/mountpoint'
-require 'zm/client/mountpoint/mountpoint_jsns_builder'
-require 'zm/client/mountpoint/mountpoint_jsns_initializer'
-require 'zm/client/mountpoint/mountpoints_builder'
-require 'zm/client/mountpoint/mountpoints_collection'

data/lib/zm/client/mta_queue.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/mta_queue/mta_queue'
-require 'zm/client/mta_queue/mta_queue_jsns_initializer'
-require 'zm/client/mta_queue/mta_queue_jsns_builder'
-require 'zm/client/mta_queue/mta_queues_builder'
-require 'zm/client/mta_queue/mta_queues_collection'

data/lib/zm/client/mta_queue_item.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/mta_queue_item/mta_queue_item'
-require 'zm/client/mta_queue_item/mta_queue_item_jsns_initializer'
-require 'zm/client/mta_queue_item/mta_queue_items_builder'
-require 'zm/client/mta_queue_item/mta_queue_items_collection'

data/lib/zm/client/resource.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/resource/resource'
-require 'zm/client/resource/resource_jsns_builder'
-require 'zm/client/resource/resource_jsns_initializer'
-require 'zm/client/resource/resources_builder'
-require 'zm/client/resource/resources_collection'

data/lib/zm/client/search_folder.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/search_folder/search_folder'
-require 'zm/client/search_folder/search_folder_jsns_builder'
-require 'zm/client/search_folder/search_folder_jsns_initializer'
-require 'zm/client/search_folder/search_folders_builder'
-require 'zm/client/search_folder/search_folders_collection'

data/lib/zm/client/server.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/server/server'
-require 'zm/client/server/server_jsns_initializer'
-require 'zm/client/server/servers_builder'
-require 'zm/client/server/servers_collection'
-require 'zm/client/server/server_accounts_collection'

data/lib/zm/client/share.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/share/share'
-require 'zm/client/share/share_jsns_initializer'
-require 'zm/client/share/shares_builder'
-require 'zm/client/share/shares_collection'
-require 'zm/client/share/share_mountpoints_collection'

data/lib/zm/client/signature.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'zm/client/signature/signature'
-require 'zm/client/signature/signature_jsns_builder'
-require 'zm/client/signature/signature_jsns_initializer'
-require 'zm/client/signature/signatures_builder'
-require 'zm/client/signature/signatures_collection'