zm-ruby-client 0.18.5 → 2.0.0

data/lib/zm/client/folder/folders_collection.rb

@@ -4,7 +4,6 @@ module Zm
   module Client
     # collection of folders
     class FoldersCollection < Base::AccountObjectsCollection
-
       attr_reader :root
 
       attr_accessor :view, :tr, :visible, :needGranteeName, :depth
@@ -25,6 +24,10 @@ module Zm
         folder
       end
 
+      def root
+        find(1)
+      end
+
       def where(view: nil, tr: nil)
         @view = view
         @tr = tr
@@ -78,7 +81,7 @@ module Zm
       end
 
       def make_query
-        @parent.sacc.get_folder(@parent.token, jsns_builder.to_jsns)
+        @parent.sacc.invoke(jsns_builder.to_jsns)
       end
 
       def reset_query_params

data/lib/zm/client/folder/folders_jsns_builder.rb

@@ -9,13 +9,15 @@ module Zm
       end
 
       def to_jsns
-        {
+        attrs = {
           visible: @item.visible,
           needGranteeName: @item.needGranteeName,
           view: @item.view,
           depth: @item.depth,
           tr: @item.tr
         }.delete_if { |_, v| v.nil? }
+
+        SoapElement.mail(SoapMailConstants::GET_FOLDER_REQUEST).add_attributes(attrs)
       end
     end
   end

data/lib/zm/client/folder/mod_document_folder.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module DocumentFolder
-  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}:[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}}
+  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}:[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
 
   def upload(file_path)
     uploader = Zm::Client::Upload.new(@parent, Zm::Client::RestAccountConnector.new)
@@ -7,11 +9,13 @@ module DocumentFolder
 
     uuid = str.scan(UUID_REGEX).first
 
-    raise Zm::Client::RestError, "failed to extract uuid" if uuid.nil?
+    raise Zm::Client::RestError, 'failed to extract uuid' if uuid.nil?
+
+    jsns = { doc: { l: l, pload: { id: uuid } } }
 
-    upload_options = { upload: { id: uuid } }
-    rep = @parent.sacc.save_document(@parent.token, id, upload_options)
+    soap_request = SoapElement.mail(SoapMailConstants::SAVE_DOCUMENT_REQUEST).add_attributes(jsns)
+    rep = @parent.sacc.invoke(soap_request)
 
-    Zm::Client::Document.new(@parent, rep[:Body][:SaveDocumentResponse][:doc].first)
+    DocumentJsnsInitializer.create(@parent, rep[:SaveDocumentResponse][:doc].first)
   end
-end
+end

data/lib/zm/client/folder.rb

@@ -11,4 +11,4 @@ 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'
+require 'zm/client/folder/mod_document_folder'

data/lib/zm/client/identity/identities_builder.rb

@@ -6,9 +6,16 @@ module Zm
     class IdentitiesBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
         super(parent, json)
-        @child_class = Identity
         @json_item_key = :identity
       end
+
+      def make
+        return [] if json_items.nil?
+
+        json_items.map do |entry|
+          IdentityJsnsInitializer.create(@parent, entry)
+        end
+      end
     end
   end
 end

data/lib/zm/client/identity/identities_collection.rb

@@ -13,7 +13,8 @@ module Zm
       private
 
       def make_query
-        @parent.sacc.get_all_identities(@parent.token)
+        soap_request = SoapElement.account(SoapAccountConstants::GET_IDENTITIES_REQUEST)
+        @parent.sacc.invoke(soap_request)
       end
     end
   end

data/lib/zm/client/identity/identity.rb

@@ -3,63 +3,45 @@
 module Zm
   module Client
     # class account identity
-    class Identity < Base::AccountObject
-      INSTANCE_VARIABLE_KEYS = %i[id name zimbraPrefIdentityName zimbraPrefFromDisplay zimbraPrefFromAddress
-                                  zimbraPrefFromAddressType zimbraPrefReplyToEnabled zimbraPrefReplyToDisplay zimbraPrefReplyToAddress
-                                  zimbraPrefDefaultSignatureId zimbraPrefForwardReplySignatureId zimbraPrefWhenSentToEnabled
-                                  zimbraPrefWhenInFoldersEnabled zimbraPrefWhenSentToAddresses].freeze
+    class Identity < Base::Object
+      attr_accessor :id, :name, :zimbraPrefIdentityName, :zimbraPrefFromDisplay, :zimbraPrefFromAddress,
+                    :zimbraPrefFromAddressType, :zimbraPrefReplyToEnabled, :zimbraPrefReplyToDisplay,
+                    :zimbraPrefReplyToAddress, :zimbraPrefDefaultSignatureId, :zimbraPrefForwardReplySignatureId,
+                    :zimbraPrefWhenSentToEnabled, :zimbraPrefWhenInFoldersEnabled, :zimbraPrefWhenSentToAddresses
 
-      ATTRS_WRITE = %i[zimbraPrefIdentityName zimbraPrefFromDisplay zimbraPrefFromAddress
-                       zimbraPrefFromAddressType zimbraPrefReplyToEnabled zimbraPrefReplyToDisplay zimbraPrefReplyToAddress
-                       zimbraPrefDefaultSignatureId zimbraPrefForwardReplySignatureId zimbraPrefWhenSentToEnabled
-                       zimbraPrefWhenInFoldersEnabled zimbraPrefWhenSentToAddresses].freeze
-
-      attr_accessor(*INSTANCE_VARIABLE_KEYS)
-
-      def all_instance_variable_keys
-        INSTANCE_VARIABLE_KEYS
-      end
-
-      def init_from_json(json)
-        @id    = json[:id]
-        @name  = json[:name]
-        all_instance_variable_keys.each do |key|
-          value = json[:_attrs][key]
-          next if value.nil?
-
-          instance_variable_set(arrow_name(key), value)
-        end
+      def create!
+        rep = @parent.sacc.invoke(jsns_builder.to_jsns)
+        IdentityJsnsInitializer.update(self, rep[:CreateIdentityResponse][:identity].first)
+        @id
       end
 
-      def create!
-        rep = @parent.sacc.create_identity(@parent.token, name, Hash[instance_variables_array(ATTRS_WRITE)])
-        init_from_json(rep[:Body][:CreateIdentityResponse][:identity].first)
+      def modify!
+        @parent.sacc.invoke(jsns_builder.to_update)
+        true
       end
 
       def update!(hash)
-        @parent.sacc.modify_identity(@parent.token, id, hash)
+        return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
 
-        hash.each do |k, v|
-          arrow_attr_sym = "@#{k}".to_sym
+        do_update!(hash)
 
-          if v.respond_to?(:empty?) && v.empty?
-            remove_instance_variable(arrow_attr_sym) if instance_variable_get(arrow_attr_sym)
-          else
-            instance_variable_set(arrow_attr_sym, v)
-          end
+        hash.each do |key, value|
+          update_attribute(key, value)
         end
+
+        true
       end
 
-      def modify!
-        @parent.sacc.modify_identity(@parent.token, id, Hash[instance_variables_array(ATTRS_WRITE)])
+      def rename!(new_name)
+        raise NotImplementedError
       end
 
       def delete!
-        @parent.sacc.delete_identity(@parent.token, @id)
-        super
-      end
+        return if @id.nil?
 
-      def rename!(new_name); end
+        @parent.sacc.invoke(jsns_builder.to_delete)
+        @id = nil
+      end
 
       def clone
         new_identity = super do |obj|
@@ -70,6 +52,16 @@ module Zm
         yield(new_identity) if block_given?
         new_identity
       end
+
+      private
+
+      def do_update!(hash)
+        @parent.sacc.invoke(jsns_builder.to_patch(hash))
+      end
+
+      def jsns_builder
+        @jsns_builder ||= IdentityJsnsBuilder.new(self)
+      end
     end
   end
 end

data/lib/zm/client/identity/identity_jsns_builder.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for account identity jsns builder
+    class IdentityJsnsBuilder
+      def initialize(item)
+        @item = item
+      end
+
+      def to_jsns
+        soap_request = SoapElement.account(SoapAccountConstants::CREATE_IDENTITY_REQUEST)
+        node_identity = SoapElement.create(SoapConstants::IDENTITY).add_attributes({ name: @item.name, _attrs: attrs })
+        soap_request.add_node(node_identity)
+        soap_request
+      end
+
+      def to_update
+        soap_request = SoapElement.account(SoapAccountConstants::MODIFY_IDENTITY_REQUEST)
+        node_identity = SoapElement.create(SoapConstants::IDENTITY).add_attributes({ id: @item.id, _attrs: attrs })
+        soap_request.add_node(node_identity)
+        soap_request
+      end
+
+      def to_patch(hash)
+        soap_request = SoapElement.account(SoapAccountConstants::MODIFY_IDENTITY_REQUEST)
+        node_identity = SoapElement.create(SoapConstants::IDENTITY).add_attributes({ id: @item.id, _attrs: hash })
+        soap_request.add_node(node_identity)
+        soap_request
+      end
+
+      def to_delete
+        soap_request = SoapElement.account(SoapAccountConstants::DELETE_IDENTITY_REQUEST)
+        node_identity = SoapElement.create(SoapConstants::IDENTITY).add_attributes({ id: @item.id })
+        soap_request.add_node(node_identity)
+        soap_request
+      end
+
+      def attrs
+        {
+          zimbraPrefIdentityName: @item.zimbraPrefIdentityName,
+          zimbraPrefFromDisplay: @item.zimbraPrefFromDisplay,
+          zimbraPrefFromAddress: @item.zimbraPrefFromAddress,
+          zimbraPrefFromAddressType: @item.zimbraPrefFromAddressType,
+          zimbraPrefReplyToEnabled: @item.zimbraPrefReplyToEnabled,
+          zimbraPrefReplyToDisplay: @item.zimbraPrefReplyToDisplay,
+          zimbraPrefReplyToAddress: @item.zimbraPrefReplyToAddress,
+          zimbraPrefDefaultSignatureId: @item.zimbraPrefDefaultSignatureId,
+          zimbraPrefForwardReplySignatureId: @item.zimbraPrefForwardReplySignatureId,
+          zimbraPrefWhenSentToEnabled: @item.zimbraPrefWhenSentToEnabled,
+          zimbraPrefWhenInFoldersEnabled: @item.zimbraPrefWhenInFoldersEnabled,
+          zimbraPrefWhenSentToAddresses: @item.zimbraPrefWhenSentToAddresses
+        }
+      end
+    end
+  end
+end

data/lib/zm/client/identity/identity_jsns_initializer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for initialize account identity
+    class IdentityJsnsInitializer
+      class << self
+        def create(parent, json)
+          item = Identity.new(parent)
+          update(item, json)
+        end
+
+        def update(item, json)
+          item.id = json[:id]
+          item.name = json[:name]
+
+          return item if json[:_attrs].nil? || json[:_attrs].empty?
+
+          json[:_attrs].each do |k, v|
+            m = Utils.equals_name(k)
+            item.send(m, v) if item.respond_to?(m)
+          end
+
+          item
+        end
+      end
+    end
+  end
+end

data/lib/zm/client/identity.rb

@@ -1,5 +1,7 @@
 # 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'
+require 'zm/client/identity/identities_collection'

data/lib/zm/client/license/license.rb

@@ -2,28 +2,15 @@
 
 module Zm
   module Client
-    # objectClass: zimbraDomain
-    class License < Base::AdminObject
-
-      INSTANCE_VARIABLE_KEYS = %i[
-        AccountsLimit ArchivingAccountsLimit AttachmentConversionEnabled AttachmentIndexingAccountsLimit BackupEnabled
-        CrossMailboxSearchEnabled EwsAccountsLimit HierarchicalStorageManagementEnabled ISyncAccountsLimit InstallType
-        IssuedOn IssuedToEmail IssuedToName LicenseId MAPIConnectorAccountsLimit MobileSyncAccountsLimit
-        MobileSyncEnabled ResellerName SMIMEAccountsLimit TouchClientsAccountsLimit TwoFactorAuthAccountsLimit
-        ValidFrom ValidUntil VoiceAccountsLimit ZSSAccountsLimit ZTalkAccountsLimit
-      ]
-
-      attr_accessor *INSTANCE_VARIABLE_KEYS
-
-      def init_from_json(json)
-        json[:attr].each do |a|
-          instance_variable_set(arrow_name(a[:name]), a[:_content])
-        end
-      end
-
-      def to_s
-        INSTANCE_VARIABLE_KEYS.map { |v| [v, instance_variable_get(arrow_name(v))].join(' : ') }.join("\n")
-      end
+    # objectClass: License
+    class License < Base::Object
+      attr_accessor :AccountsLimit, :ArchivingAccountsLimit, :AttachmentConversionEnabled,
+                    :AttachmentIndexingAccountsLimit, :BackupEnabled, :CrossMailboxSearchEnabled, :EwsAccountsLimit,
+                    :HierarchicalStorageManagementEnabled, :ISyncAccountsLimit, :InstallType, :IssuedOn,
+                    :IssuedToEmail, :IssuedToName, :LicenseId, :MAPIConnectorAccountsLimit, :MobileSyncAccountsLimit,
+                    :MobileSyncEnabled, :ResellerName, :SMIMEAccountsLimit, :TouchClientsAccountsLimit,
+                    :TwoFactorAuthAccountsLimit, :ValidFrom, :ValidUntil, :VoiceAccountsLimit, :ZSSAccountsLimit,
+                    :ZTalkAccountsLimit
     end
   end
 end

data/lib/zm/client/license/license_jsns_initializer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for initialize license
+    class LicenseJsnsInitializer
+      class << self
+        def create(parent, json)
+          item = License.new(parent)
+
+          json[:attr].each do |a|
+            item.instance_variable_set(Utils.arrow_name(a[:name]), a[:_content])
+          end
+
+          item
+        end
+      end
+    end
+  end
+end

data/lib/zm/client/license/licenses_collection.rb

@@ -9,20 +9,10 @@ module Zm
       end
 
       def find
-        req = sac.get_license
-        entry = req[:Body][:GetLicenseResponse][:license].first
-        license = License.new(@parent)
-        license.init_from_json(entry)
-        license
+        soap_request = SoapElement.admin(SoapAdminConstants::GET_LICENSE_REQUEST)
+        entry = sac.invoke(soap_request)[:GetLicenseResponse][:license].first
+        LicenseJsnsInitializer.create(@parent, entry)
       end
-
-      private
-
-      def soap_admin_connector
-        @parent.soap_admin_connector
-      end
-
-      alias sac soap_admin_connector
     end
   end
 end

data/lib/zm/client/license.rb

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

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

@@ -0,0 +1,55 @@
+# 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 << '?' << Utils.format_url_params(h)
+
+          uploader = Upload.new(@parent, RestAccountConnector.new)
+          uploader.download_file_with_url(url, dest_file_path)
+        end
+
+        def account
+          @parent.parent
+        end
+      end
+    end
+  end
+end