zm-ruby-client 2.2.7 → 3.0.0

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

@@ -8,13 +8,13 @@ module Zm
     class SoapAccountConnector < SoapBaseConnector
       class << self
         def create(config)
-          trans = new(
-            config.zimbra_public_scheme,
-            config.zimbra_public_host,
-            config.zimbra_public_port
-          )
-          trans.logger = config.logger
-          trans
+          new(
+            config.zimbra_public_url
+          ).tap do |trans|
+            trans.logger = config.logger
+            trans.cache = config.cache
+            trans.timeout = config.timeout
+          end
         end
       end
 
@@ -26,8 +26,8 @@ module Zm
         context.token(value)
       end
 
-      def initialize(scheme, host, port)
-        super(scheme, host, port, SoapAccountConstants::ACCOUNT_SERVICE_URI)
+      def initialize(url)
+        super(url, SoapAccountConstants::ACCOUNT_SERVICE_URI)
       end
 
       def auth_preauth(content, by, expires, domainkey)
@@ -35,11 +35,14 @@ module Zm
         preauth = compute_preauth(content, by, ts, expires, domainkey)
 
         soap_request = SoapElement.account(SoapAccountConstants::AUTH_REQUEST)
-        node_account = SoapElement.create(SoapConstants::ACCOUNT).add_attribute(SoapConstants::BY,
-                                                                                by).add_content(content)
+        node_account = SoapElement.create(SoapConstants::ACCOUNT)
+                                  .add_attribute(SoapConstants::BY, by)
+                                  .add_content(content)
         soap_request.add_node(node_account)
-        node_preauth = SoapElement.create(SoapConstants::PREAUTH).add_attribute(SoapConstants::TIMESTAMP,
-                                                                                ts).add_content(preauth)
+        node_preauth = SoapElement.create(SoapConstants::PREAUTH)
+                                  .add_attribute(SoapConstants::TIMESTAMP, ts)
+                                  .add_attribute(SoapConstants::EXPIRES, expires)
+                                  .add_content(preauth)
         soap_request.add_node(node_preauth)
 
         do_login(soap_request)
@@ -47,8 +50,9 @@ module Zm
 
       def auth_password(content, by, password)
         soap_request = SoapElement.account(SoapAccountConstants::AUTH_REQUEST)
-        node_account = SoapElement.create(SoapConstants::ACCOUNT).add_attribute(SoapConstants::BY,
-                                                                                by).add_content(content)
+        node_account = SoapElement.create(SoapConstants::ACCOUNT)
+                                  .add_attribute(SoapConstants::BY, by)
+                                  .add_content(content)
         soap_request.add_node(node_account)
         soap_request.add_attribute('password', password)
 

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

@@ -8,13 +8,13 @@ module Zm
     class SoapAdminConnector < SoapBaseConnector
       class << self
         def create(config)
-          trans = new(
-            config.zimbra_admin_scheme,
-            config.zimbra_admin_host,
-            config.zimbra_admin_port
-          )
-          trans.logger = config.logger
-          trans
+          new(
+            config.zimbra_admin_url
+          ).tap do |trans|
+            trans.logger = config.logger
+            trans.cache = config.cache
+            trans.timeout = config.timeout
+          end
         end
       end
 
@@ -26,8 +26,8 @@ module Zm
         context.token(value)
       end
 
-      def initialize(scheme, host, port)
-        super(scheme, host, port, SoapAdminConstants::ADMIN_SERVICE_URI)
+      def initialize(url)
+        super(url, SoapAdminConstants::ADMIN_SERVICE_URI)
       end
     end
   end

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

@@ -2,15 +2,12 @@
 
 require 'json'
 require 'openssl'
-require 'uri'
 
 require_relative 'soap_error'
 
 module Zm
   module Client
     class SoapBaseConnector
-      include ZmLogger
-
       BASESPACE = 'urn:zimbra'
       HTTP_HEADERS = {
         'Content-Type' => 'application/json; charset=utf-8',
@@ -18,8 +15,9 @@ module Zm
       }.freeze
 
       attr_reader :context
+      attr_writer :logger, :cache, :timeout
 
-      def initialize(scheme, host, port, soap_path)
+      def initialize(url, soap_path)
         @verbose = false
         @timeout = 300
 
@@ -29,8 +27,9 @@ module Zm
           verify_mode: OpenSSL::SSL::VERIFY_NONE
         }
 
+        @url = url
         @soap_path = soap_path
-        @uri = URI::HTTP.new(scheme, nil, host, port, nil, nil, nil, nil, nil)
+
         @context = SoapContext.new
       end
 
@@ -51,7 +50,7 @@ module Zm
 
       def http_client!
         @http_client = Faraday.new(
-          url: @uri.to_s,
+          url: @url,
           headers: HTTP_HEADERS,
           request: {
             timeout: @timeout
@@ -70,13 +69,28 @@ module Zm
       end
 
       def do_request(body, error_handler = SoapError)
-        response = http_client.post(@soap_path, body)
+        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
 
-        if response.status >= 400
-          raise(error_handler, response.body)
+          response.body
         end
 
-        JSON.parse(response.body, symbolize_names: true)
+        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)
@@ -85,13 +99,6 @@ module Zm
           Header: { context: context.to_hash, _jsns: BASESPACE }
         }
       end
-
-      def hash_header(token, target_server = nil)
-        h_context = { authToken: token, userAgent: { name: :zmsoap }, targetServer: target_server }.delete_if do |_, v|
-          v.nil?
-        end
-        { Header: { context: h_context, _jsns: BASESPACE } }
-      end
     end
   end
 end

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

@@ -9,29 +9,9 @@ module Zm
       attr_reader :reason, :code
 
       def initialize(soapbody)
-        if soapbody.start_with?('{')
-          init_from_json(soapbody)
-        elsif soapbody.start_with?('<')
-          init_from_xml(soapbody)
-        end
-
-        super "[#{@code}] [#{@reason}]"
-      end
-
-      private
-
-      def init_from_json(soapbody)
-        json = JSON.parse(soapbody, symbolize_names: true)
-        @reason = json[:Body][:Fault][:Reason][:Text]
-        @code = json[:Body][:Fault][:Detail][:Error][:Code]
-      end
-
-      def init_from_xml(soapbody)
-        code_match = soapbody.match(%r{<Code>(.*?)</Code>})
-        @code = code_match[1]
-
-        text_match = soapbody.match(%r{<soap:Reason>.*?<soap:Text>(.*?)</soap:Text>}m)
-        @reason = text_match[1]
+        @reason = soapbody.dig(:Body, :Fault, :Reason, :Text)
+        @code = soapbody.dig(:Body, :Fault, :Detail, :Error, :Code)
+        super("[#{@code}] [#{@reason}]")
       end
     end
 

data/lib/zm/client/constant.rb

@@ -6,24 +6,26 @@ module Zm
     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}/.freeze
-      BASEDN_REGEX = /^uid=/.freeze
-      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]+/.freeze
+      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
-      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
+      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,
@@ -40,7 +42,7 @@ module Zm
         TRASH
       ].freeze
 
-      IDS = ALL.map { |folder| folder[:id] }.freeze
+      IDS = ALL.map(&:id).freeze
     end
 
     module ShareType

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

@@ -6,24 +6,27 @@ module Zm
     class Contact < Base::Object
       include BelongsToFolder
       include BelongsToTag
+      include RequestMethodsMailbox
+      include MailboxItemConcern
 
       GROUP_PATTERN = 'group'
 
-      attr_accessor :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, :id, :name, :l, :type, :tn, :shared_account_id, :shared_folder_account_id,
-                    :fileAs
+      attr_accessor :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, :name, :type,
+                    :tn, :shared_account_id, :shared_folder_account_id
 
       def initialize(parent)
-        @l = FolderDefault::CONTACTS[:id]
+        @l = FolderDefault::CONTACTS.id
         @shared_account_id = nil
         @shared_folder_account_id = nil
-        super(parent)
+        super
       end
 
       def group?
@@ -39,38 +42,18 @@ module Zm
       end
 
       def create!
-        rep = @parent.sacc.invoke(jsns_builder.to_jsns)
+        rep = @parent.soap_connector.invoke(build_create)
         ContactJsnsInitializer.update(self, rep[:CreateContactResponse][:cn].first)
 
-        @id
-      end
-
-      def modify!
-        @parent.sacc.invoke(jsns_builder.to_update)
-        true
-      end
-
-      def update!(hash)
-        return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
-
-        do_update!(hash)
-
-        hash.each do |key, value|
-          update_attribute(key, value)
-        end
-
-        true
+        id
       end
 
       def rename!(*args)
         raise NotImplementedError
       end
 
-      def delete!
-        return false if @id.nil?
-
-        @parent.sacc.invoke(jsns_builder.to_delete)
-        @id = nil
+      def build_rename(*args)
+        raise NotImplementedError
       end
 
       def reload!
@@ -79,12 +62,10 @@ module Zm
 
       private
 
-      def do_update!(hash)
-        @parent.sacc.invoke(jsns_builder.to_patch(hash))
-      end
-
       def jsns_builder
-        @jsns_builder ||= ContactJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = ContactJsnsBuilder.new(self)
       end
     end
   end

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

@@ -10,7 +10,7 @@ module Zm
         jsns = {
           cn: {
             a: instance_variables_array(all_instance_variables).map(&Utils::A_NODE_PROC),
-            l: @item.folder_id || Zm::Client::FolderDefault::CONTACTS[:id]
+            l: @item.l || Zm::Client::FolderDefault::CONTACTS.id
           }
         }
 

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

@@ -11,32 +11,10 @@ module Zm
         end
 
         def update(item, json)
-          part_id = json[:id].split(':')
-
-          if part_id.length == 1
-            item.id = json[:id].to_i
-          elsif part_id.length == 2
-            item.shared_account_id = part_id.first
-            item.id = part_id.last.to_i
-          else
-            item.id = json[:id]
-          end
-
-          part_l = json[:l].split(':')
-
-          if part_l.length == 1
-            item.l = json[:l].to_i
-          elsif part_l.length == 2
-            item.shared_folder_account_id = part_l.first
-            item.l = part_l.last.to_i
-          else
-            item.l = json[:l]
-          end
-
-          # item.id   = json[:id]
-          item.name = json[:fileAsStr]
-          # item.l    = json[:l].to_i
-          item.tn   = json[:tn]
+          item.id = json.delete(:id)
+          item.l = json.delete(:l)
+          item.name = json.delete(:fileAsStr)
+          item.tn   = json.delete(:tn)
 
           if json[:_attrs].is_a?(Hash)
             make_custom_keys(json[:_attrs], item)

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

@@ -5,7 +5,7 @@ module Zm
     # class factory [contacts]
     class ContactBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @json_item_key = :cn
       end
 

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

@@ -3,33 +3,13 @@
 module Zm
   module Client
     # collection account contacts
-    class ContactsCollection < Base::AccountObjectsCollection
+    class ContactsCollection < Base::AccountSearchObjectsCollection
       def initialize(parent)
+        super
         @child_class = Contact
         @builder_class = ContactBuilder
-        @folder_id = nil
-        super(parent)
-      end
-
-      def folder(folder)
-        return self unless folder.is_a?(Zm::Client::Folder)
-
-        folder_id(folder.id)
-      end
-
-      def folder_id(folder_id)
-        return self if @folder_id == folder_id
-
-        @folder_id = folder_id
-        self
-      end
-
-      private
-
-      def make_query
-        jsns = @folder_id.nil? ? nil : { l: @folder_id }
-        soap_request = SoapElement.mail(SoapMailConstants::GET_CONTACTS_REQUEST).add_attributes(jsns)
-        @parent.sacc.invoke(soap_request)
+        @type = SoapConstants::CONTACT
+        @folder_ids = [FolderDefault::CONTACTS.id]
       end
     end
   end

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

@@ -7,17 +7,16 @@ module Zm
       EXCLUDE_INSTANCE_VARIABLE_KEYS = %i[@id @name @parent @l @type @tn @jsns_builder].freeze
 
       def to_jsns
-        jsns = {
+        {
           cn: {
             a: instance_variables_array.map(&Utils::A_NODE_PROC),
-            l: @item.folder_id || Zm::Client::FolderDefault::CONTACTS[:id],
-            m: @item.members.all.map do |m|
-              { type: m.type, value: m.value }
-            end
+            l: @item.folder_id || Zm::Client::FolderDefault::CONTACTS.id,
+            m: members_node
           }
         }
 
-        SoapElement.mail(SoapMailConstants::CREATE_CONTACT_REQUEST).add_attributes(jsns)
+        SoapElement.mail(SoapMailConstants::CREATE_CONTACT_REQUEST)
+                   .add_attributes(jsns)
       end
 
       def to_update
@@ -25,30 +24,36 @@ module Zm
           cn: {
             a: instance_variables_array.map(&Utils::A_NODE_PROC),
             id: @item.id,
-            m: @item.members.all.reject(&:current?).map do |m|
-              { type: m.type, value: m.value, op: m.op }
-            end
+            m: members_node
           }
         }
 
-        SoapElement.mail(SoapMailConstants::MODIFY_CONTACT_REQUEST).add_attributes(jsns)
+        SoapElement.mail(SoapMailConstants::MODIFY_CONTACT_REQUEST)
+                   .add_attributes(jsns)
       end
 
       def to_patch(hash)
-        jsns = {
+        {
           cn: {
             id: @item.id,
             a: hash.map(&Utils::A_ARRAY_PROC).flatten(1).map(&Utils::A_NODE_PROC)
           }
         }
 
-        SoapElement.mail(SoapMailConstants::MODIFY_CONTACT_REQUEST).add_attributes(jsns)
+        SoapElement.mail(SoapMailConstants::MODIFY_CONTACT_REQUEST)
+                   .add_attributes(jsns)
       end
 
       alias to_create to_jsns
 
+      def members_node
+        @item.members.all.reject(&:current?).map do |m|
+          { type: m.type, value: m.value, op: m.op }
+        end
+      end
+
       def instance_variables_array
-        [[:nickname, @item.name], [:fullName, @item.name], [:fileAs, "8:#{@item.name}"], %i[type group]]
+        [[:nickname, @item.name], [:fullname, @item.name], [:fileAs, "8:#{@item.name}"], %i[type group]]
       end
     end
   end

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

@@ -2,10 +2,14 @@
 
 module GroupContact
   def members
-    @members ||= Zm::Client::ContactMembersCollection.new(self)
+    return @members if defined? @members
+
+    @members = Zm::Client::ContactMembersCollection.new(self)
   end
 
   def jsns_builder
-    @jsns_builder ||= Zm::Client::GroupContactJsnsBuilder.new(self)
+    return @jsns_builder if defined? @jsns_builder
+
+    @jsns_builder = Zm::Client::GroupContactJsnsBuilder.new(self)
   end
 end

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

@@ -7,10 +7,14 @@ module Zm
       include HasSoapAdminConnector
 
       def modify!
-        sac.invoke(jsns_builder.to_update)
+        sac.invoke(build_modify)
         true
       end
 
+      def build_modify
+        jsns_builder.to_update
+      end
+
       def update!(hash)
         return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
 
@@ -24,49 +28,69 @@ module Zm
       end
 
       def create!
-        resp = sac.invoke(jsns_builder.to_create)
+        resp = sac.invoke(build_create)
 
         @id = resp[:CreateCosResponse][:cos].first[:id]
       end
 
+      def build_create
+        jsns_builder.to_create
+      end
+
       def delete!
-        sac.invoke(jsns_builder.to_delete)
+        sac.invoke(build_delete)
+      end
+
+      def build_delete
+        jsns_builder.to_delete
       end
 
       def clone!(new_name)
-        resp = sac.invoke(jsns_builder.to_copy(new_name))
+        resp = sac.invoke(build_clone(new_name))
         resp[:CopyCosResponse][:cos].first[:id]
       end
 
+      def build_clone(new_name)
+        jsns_builder.to_copy(new_name)
+      end
+
       def servers
-        @servers ||= CosServersCollection.new(self)
+        return @servers if defined? @servers
+
+        @servers = CosServersCollection.new(self)
       end
 
       def domains
         return if @id.nil?
 
-        @domains ||= CosDomainsCollection.new(self)
+        return @domains if defined? @domains
+
+        @domains = CosDomainsCollection.new(self)
       end
 
       def accounts
         return if @id.nil?
 
-        @accounts ||= CosAccountsCollection.new(self)
+        return @accounts if defined? @accounts
+
+        @accounts = CosAccountsCollection.new(self)
       end
 
       def attrs_write
         @parent.zimbra_attributes.all_cos_attrs_writable_names
       end
 
+      def jsns_builder
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = CosJsnsBuilder.new(self)
+      end
+
       private
 
       def do_update!(hash)
         sac.invoke(jsns_builder.to_patch(hash))
       end
-
-      def jsns_builder
-        @jsns_builder ||= CosJsnsBuilder.new(self)
-      end
     end
   end
 end

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

@@ -5,7 +5,7 @@ module Zm
     # Collection Domains for cos
     class CosDomainsCollection < DomainsCollection
       def initialize(parent)
-        super(parent)
+        super
 
         @default_ldap_filter = "(zimbraDomainDefaultCOSId=#{@parent.id})"
       end