zm-ruby-client 2.2.8 → 3.0.1

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

@@ -5,77 +5,74 @@ module Zm
     # class for account folder
     class Folder < Base::Object
       include BelongsToFolder
-      # include Zm::Model::AttributeChangeObserver
+      include RequestMethodsMailbox
+      include MailboxItemConcern
 
-      attr_accessor :type, :id, :uuid, :name, :absFolderPath, :l, :url, :luuid, :f, :view, :rev, :ms,
+      attr_accessor :type, :uuid, :name, :absFolderPath, :url, :luuid, :f, :view, :rev, :ms,
                     :webOfflineSyncDays, :activesyncdisabled, :n, :s, :i4ms, :i4next, :zid, :rid, :ruuid,
-                    :owner, :reminder, :acl, :itemCount, :broken, :deletable, :color, :rgb, :fb, :folders,
-                    :grants, :retention_policies,
-                    :name, :color, :rgb, :l, :url, :f, :view
+                    :owner, :reminder, :itemCount, :broken, :deletable, :color, :rgb, :fb, :folders
 
       alias nb_messages n
       alias nb_items n
       alias size s
 
       def initialize(parent)
-        super(parent)
+        super
 
-        @l = FolderDefault::ROOT[:id]
         @type = :folder
         @folders = []
-        @grants = FolderGrantsCollection.new(self)
-        @retention_policies = FolderRetentionPoliciesCollection.new(self)
 
         yield(self) if block_given?
       end
 
-      def is_immutable?
-        @is_immutable ||= Zm::Client::FolderDefault::IDS.include?(@id.to_i)
-      end
+      def l
+        return @l if defined? @l
 
-      def to_query
-        "inid:#{id}"
+        FolderDefault::ROOT.id
       end
+      alias folder_id l
 
-      def create!
-        rep = @parent.sacc.invoke(jsns_builder.to_jsns)
-        json = rep[:CreateFolderResponse][:folder].first
-        FolderJsnsInitializer.update(self, json)
-        @id
+      def grants
+        return @grants if defined? @grants
+
+        @grants = FolderGrantsCollection.new(self)
       end
+      alias acl grants
 
-      def modify!
-        @parent.sacc.invoke(jsns_builder.to_update)
-        true
+      def retention_policies
+        return @retention_policies if defined? @retention_policies
+
+        @retention_policies = FolderRetentionPoliciesCollection.new(self)
       end
 
-      def update!(hash)
-        return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
+      def is_immutable?
+        return @is_immutable if defined? @is_immutable
 
-        do_update!(hash)
+        @is_immutable = Zm::Client::FolderDefault::IDS.include?(id.to_i)
+      end
 
-        hash.each do |key, value|
-          update_attribute(key, value)
-        end
+      def to_query
+        "inid:#{id}"
+      end
 
-        true
+      def create!
+        rep = @parent.soap_connector.invoke(build_create)
+        json = rep[:CreateFolderResponse][:folder].first
+        FolderJsnsInitializer.update(self, json)
+        id
       end
 
       def color!
-        @parent.sacc.invoke(jsns_builder.to_color)
-
+        @parent.soap_connector.invoke(build_color)
         true
       end
 
-      def rename!(new_name)
-        return false if new_name == @name
-
-        @parent.sacc.invoke(jsns_builder.to_rename(new_name))
-        @name = new_name
+      def build_color
+        jsns_builder.to_color
       end
 
       def reload!
-        rep = @parent.sacc.invoke(jsns_builder.to_find)
+        rep = @parent.soap_connector.invoke(jsns_builder.to_find)
         json = rep[:GetFolderResponse][:folder].first
         FolderJsnsInitializer.update(self, json)
         true
@@ -88,16 +85,19 @@ module Zm
       def empty!
         return false if empty?
 
-        @parent.sacc.invoke(jsns_builder.to_empty)
+        @parent.soap_connector.invoke(build_empty)
         @n = 0
       end
       alias clear empty!
 
+      def build_empty
+        jsns_builder.to_empty
+      end
+
       def delete!
-        return false if is_immutable? || @id.nil?
+        return false if is_immutable? || id.nil?
 
-        @parent.sacc.invoke(jsns_builder.to_delete)
-        @id = nil
+        @parent.soap_connector.invoke(build_delete)
       end
 
       def remove_flag!(pattern)
@@ -106,47 +106,65 @@ module Zm
       end
 
       def add_message(eml, d = nil, f = nil, tn = nil)
+        @parent.soap_connector.invoke(build_add_message(eml, d, f, tn))
+      end
+
+      def build_add_message(eml, d = nil, f = nil, tn = nil)
         m = {
           l: id,
           d: d,
           f: f,
           tn: tn,
           content: { _content: eml }
-        }.reject { |_, v| v.nil? }
+        }
+        m.compact!
 
         attrs = { m: m }
 
-        soap_request = SoapElement.mail(SoapMailConstants::ADD_MSG_REQUEST).add_attributes(attrs)
-        @parent.sacc.invoke(soap_request)
+        SoapElement.mail(SoapMailConstants::ADD_MSG_REQUEST)
+                   .add_attributes(attrs)
       end
 
       def add_appointments(ics)
+        @parent.soap_connector.invoke(build_add_appointments(ics)).dig(:ImportAppointmentsResponse, :appt)
+      end
+
+      def build_add_appointments(ics)
         attrs = { l: id, ct: SoapConstants::TEXT_CALENDAR }
         soap_request = SoapElement.mail(SoapMailConstants::IMPORT_APPOINTMENTS_REQUEST).add_attributes(attrs)
         node_content = SoapElement.create(SoapConstants::CONTENT).add_content(ics)
         soap_request.add_node(node_content)
-        @parent.sacc.invoke(soap_request).dig(:ImportAppointmentsResponse, :appt)
+        soap_request
       end
 
-      def download(dest_file_path, fmt = 'tgz')
-        uploader = Upload.new(@parent, RestAccountConnector.new)
-        uploader.download_folder(@id, fmt, dest_file_path)
+      def add_contacts(csv)
+        @parent.soap_connector.invoke(build_add_contacts(csv)).dig(:ImportContactsResponse, :cn)
       end
 
-      def upload(file_path, fmt = nil, types = nil, resolve = 'replace')
-        fmt ||= File.extname(file_path)[1..]
-        uploader = Upload.new(@parent, RestAccountConnector.new)
-        uploader.send_file(absFolderPath, fmt, types, resolve, file_path)
+      def build_add_contacts(csv)
+        attrs = { l: id, ct: SoapConstants::CSV }
+        soap_request = SoapElement.mail(SoapMailConstants::IMPORT_CONTACTS_REQUEST).add_attributes(attrs)
+        node_content = SoapElement.create(SoapConstants::CONTENT).add_content(csv)
+        soap_request.add_node(node_content)
+        soap_request
       end
 
-      private
+      def download(dest_file_path, fmt: nil)
+        uploader = @parent.build_uploader
+        uploader.download_folder(dest_file_path, id, fmt:)
+      end
 
-      def do_update!(hash)
-        @parent.sacc.invoke(jsns_builder.to_patch(hash))
+      def upload(src_file_path, fmt: nil, resolve: nil)
+        uploader = @parent.build_uploader
+        uploader.send_file(src_file_path, id, fmt:, type: view, resolve:)
       end
 
+      private
+
       def jsns_builder
-        @jsns_builder ||= FolderJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = FolderJsnsBuilder.new(self)
       end
     end
   end

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

@@ -54,11 +54,11 @@ module Zm
       end
 
       def save!
-        @parent.sacc.invoke(jsns_builder.to_create)
+        @parent.soap_connector.invoke(jsns_builder.to_create)
       end
 
       def delete!
-        @parent.sacc.invoke(jsns_builder.to_delete)
+        @parent.soap_connector.invoke(jsns_builder.to_delete)
         @parent.all.delete(self)
       end
 
@@ -67,12 +67,12 @@ module Zm
       end
 
       def to_h
-        Hash[instance_variables_map]
+        instance_variables_map.to_h
       end
 
       def inspect
         keys_str = to_h.map { |k, v| "#{k}: #{v}" }.join(', ')
-        "#{self.class}:#{format('0x00%x', (object_id << 1))} #{keys_str}"
+        "#{self.class}:#{format('0x00%x', object_id << 1)} #{keys_str}"
       end
 
       def instance_variables_map
@@ -84,7 +84,9 @@ module Zm
       private
 
       def jsns_builder
-        @jsns_builder ||= FolderGrantJsnsBuilder.new(self)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = FolderGrantJsnsBuilder.new(self)
       end
 
       def get_token(target = self)

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

@@ -12,7 +12,8 @@ module Zm
           d: @item.d,
           expiry: @item.expiry,
           key: @item.key
-        }.delete_if { |_, v| v.nil? }
+        }
+        grant.compact!
 
         attrs = {
           action: {
@@ -22,7 +23,8 @@ module Zm
           }
         }
 
-        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST).add_attributes(attrs)
+        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST)
+                   .add_attributes(attrs)
       end
 
       alias to_create to_jsns
@@ -39,7 +41,8 @@ module Zm
           }
         }
 
-        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST).add_attributes(attrs)
+        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST)
+                   .add_attributes(attrs)
       end
 
       def delete_zid

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

@@ -59,10 +59,8 @@ module Zm
         @parent.parent.soap_account_connector
       end
 
-      alias sacc soap_account_connector
-
-      def to_s
-        @all.map(&:to_s)
+      def soap_connector
+        @parent.parent.soap_connector
       end
     end
   end

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

@@ -19,11 +19,13 @@ module Zm
           url: @item.url,
           fb: @item.fb,
           view: @item.view
-        }.delete_if { |_, v| v.nil? }
+        }
+        folder.compact!
 
         attrs = { folder: folder }
 
-        SoapElement.mail(SoapMailConstants::CREATE_FOLDER_REQUEST).add_attributes(attrs)
+        SoapElement.mail(SoapMailConstants::CREATE_FOLDER_REQUEST)
+                   .add_attributes(attrs)
       end
 
       alias to_create to_jsns
@@ -40,7 +42,8 @@ module Zm
           url: @item.url,
           fb: @item.fb,
           view: @item.view
-        }.delete_if { |_, v| v.nil? }
+        }
+        action.compact!
 
         if @item.is_immutable?
           action.delete(:name)
@@ -49,7 +52,8 @@ module Zm
 
         attrs = { action: action }
 
-        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST).add_attributes(attrs)
+        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST)
+                   .add_attributes(attrs)
       end
 
       def to_patch(options)
@@ -60,7 +64,8 @@ module Zm
 
         attrs = { action: action }
 
-        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST).add_attributes(attrs)
+        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST)
+                   .add_attributes(attrs)
       end
 
       def to_retentionpolicy
@@ -74,7 +79,8 @@ module Zm
           }
         }
 
-        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST).add_attributes(attrs)
+        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST)
+                   .add_attributes(attrs)
       end
 
       def to_empty
@@ -86,7 +92,8 @@ module Zm
 
         attrs = { action: action }
 
-        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST).add_attributes(attrs)
+        SoapElement.mail(SoapMailConstants::FOLDER_ACTION_REQUEST)
+                   .add_attributes(attrs)
       end
 
       private

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

@@ -6,54 +6,51 @@ module Zm
     class FolderJsnsInitializer
       class << self
         def create(parent, json)
-          item = Folder.new(parent)
-          update(item, json)
+          Folder.new(parent).tap do |item|
+            update(item, json)
+          end
         end
 
         def update(item, json)
-          item.type = json[:type]
-          item.id = json[:id].to_i
-          item.uuid = json[:uuid]
-          item.name = json[:name]
-          item.absFolderPath = json[:absFolderPath]
-          item.l = json[:l].to_i
-          item.url = json[:url]
-          item.luuid = json[:luuid]
-          item.f = json[:f]
-          item.view = json[:view]
-          item.rev = json[:rev]
-          item.ms = json[:ms]
-          item.webOfflineSyncDays = json[:webOfflineSyncDays]
-          item.activesyncdisabled = json[:activesyncdisabled]
-          item.n = json[:n]
-          item.s = json[:s]
-          item.i4ms = json[:i4ms]
-          item.i4next = json[:i4next]
-          item.zid = json[:zid]
-          item.rid = json[:rid]
-          item.ruuid = json[:ruuid]
-          item.owner = json[:owner]
-          item.reminder = json[:reminder]
-          item.acl = json[:acl]
-          item.itemCount = json[:itemCount]
-          item.broken = json[:broken]
-          item.deletable = json[:deletable]
-          item.color = json[:color]
-          item.rgb = json[:rgb]
-          item.fb = json[:fb]
+          item.type = json.delete(:type)
+          item.id = json.delete(:id)
+          item.uuid = json.delete(:uuid)
+          item.name = json.delete(:name)
+          item.absFolderPath = json.delete(:absFolderPath)
+          item.l = json.delete(:l)
+          item.url = json.delete(:url)
+          item.luuid = json.delete(:luuid)
+          item.f = json.delete(:f)
+          item.view = json.delete(:view)
+          item.rev = json.delete(:rev)
+          item.ms = json.delete(:ms)
+          item.webOfflineSyncDays = json.delete(:webOfflineSyncDays)
+          item.activesyncdisabled = json.delete(:activesyncdisabled)
+          item.n = json.delete(:n)
+          item.s = json.delete(:s)
+          item.i4ms = json.delete(:i4ms)
+          item.i4next = json.delete(:i4next)
+          item.zid = json.delete(:zid)
+          item.rid = json.delete(:rid)
+          item.ruuid = json.delete(:ruuid)
+          item.owner = json.delete(:owner)
+          item.reminder = json.delete(:reminder)
+          item.itemCount = json.delete(:itemCount)
+          item.broken = json.delete(:broken)
+          item.deletable = json.delete(:deletable)
+          item.color = json.delete(:color)
+          item.rgb = json.delete(:rgb)
+          item.fb = json.delete(:fb)
 
-          if !json[:acl].nil? && json[:acl][:grant].is_a?(Array)
-            json[:acl][:grant].each do |json|
-              item.grants.create(json[:zid], json[:gt], json[:perm], json[:d])
-            end
-          end
+          update_grants(item, json)
 
-          if json[:retentionPolicy].is_a?(Array)
-            json[:retentionPolicy].first.map do |policy, v|
-              next if v.first[:policy].nil?
+          if (policies = json.fetch(:retentionPolicy, []).first).is_a?(Array)
+            policies.each do |policy, v|
+              params = v.first[:policy]&.first
+              next if params.nil?
 
-              type = v.first[:policy].first[:type]
-              lifetime = v.first[:policy].first[:lifetime]
+              type = params.delete(:type)
+              lifetime = params.delete(:lifetime)
               item.retention_policies.create(policy, lifetime, type)
             end
           end
@@ -62,6 +59,26 @@ module Zm
 
           item
         end
+
+        private
+
+        def update_grants(item, json)
+          acl = json.delete(:acl)
+          return unless acl.is_a?(Hash)
+
+          grants = acl[:grant]
+          grants = [grants] unless grants.is_a?(Array)
+          grants.compact!
+
+          grants.each do |grant|
+            item.grants.create(
+              grant.delete(:zid),
+              grant.delete(:gt),
+              grant.delete(:perm),
+              grant.delete(:d)
+            )
+          end
+        end
       end
     end
   end

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

@@ -25,14 +25,16 @@ module Zm
       end
 
       def save!
-        @parent.sacc.invoke(jsns_builder.to_retentionpolicy)
+        @parent.soap_connector.invoke(jsns_builder.to_retentionpolicy)
         true
       end
 
       private
 
       def jsns_builder
-        @jsns_builder ||= FolderJsnsBuilder.new(@parent)
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = FolderJsnsBuilder.new(@parent)
       end
     end
   end

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

@@ -5,7 +5,7 @@ module Zm
     # class factory [folders]
     class FoldersBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        super(parent, json)
+        super
         @key = :folder
         @root_folder = nil
         @list = []

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

@@ -4,18 +4,17 @@ module Zm
   module Client
     # collection of folders
     class FoldersCollection < Base::AccountObjectsCollection
-      attr_reader :root
-
       attr_accessor :view, :tr, :visible, :needGranteeName, :depth
 
       def initialize(parent)
         @child_class = Folder
         @builder_class = FoldersBuilder
-        super(parent)
+        super
         @root = nil
         reset_query_params
       end
 
+      # TODO: forcer id en string
       def find(id)
         folder = @child_class.new(@parent) do |f|
           f.id = id
@@ -31,7 +30,6 @@ module Zm
       def where(view: nil, tr: nil)
         @view = view
         @tr = tr
-        @all = nil
         self
       end
 
@@ -40,48 +38,57 @@ module Zm
       end
 
       def clear
-        @all = nil
         @root = nil
         reset_query_params
       end
 
       def document
-        @view = FolderDefault::BRIEFCASE[:type]
+        @view = FolderDefault::BRIEFCASE.type
         self
       end
 
       def appointment
-        @view = FolderDefault::CALENDAR[:type]
+        @view = FolderDefault::CALENDAR.type
         self
       end
 
       def contact
-        @view = FolderDefault::CONTACTS[:type]
+        @view = FolderDefault::CONTACTS.type
         self
       end
 
       def message
-        @view = FolderDefault::INBOX[:type]
+        @view = FolderDefault::INBOX.type
         self
       end
 
       def task
-        @view = FolderDefault::TASKS[:type]
+        @view = FolderDefault::TASKS.type
         self
       end
 
+      def jsns_builder
+        return @jsns_builder if defined? @jsns_builder
+
+        @jsns_builder = FoldersJsnsBuilder.new(self)
+      end
+
+      def build_query
+        jsns_builder.to_jsns
+      end
+
       private
 
       def build_response
         fb = @builder_class.new(@parent, make_query)
         @root = fb.make
-        @all = fb.flatten
-        @all.select! { |folder| folder.view == @view } unless @view.nil?
-        @all
+        folders = fb.flatten
+        folders.select! { |folder| folder.view == @view } unless @view.nil?
+        folders
       end
 
       def make_query
-        @parent.sacc.invoke(jsns_builder.to_jsns)
+        @parent.soap_connector.invoke(jsns_builder.to_jsns)
       end
 
       def reset_query_params
@@ -91,10 +98,6 @@ module Zm
         @needGranteeName = nil
         @depth = nil
       end
-
-      def jsns_builder
-        @jsns_builder ||= FoldersJsnsBuilder.new(self)
-      end
     end
   end
 end

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

@@ -15,9 +15,11 @@ module Zm
           view: @item.view,
           depth: @item.depth,
           tr: @item.tr
-        }.delete_if { |_, v| v.nil? }
+        }
+        attrs.compact!
 
-        SoapElement.mail(SoapMailConstants::GET_FOLDER_REQUEST).add_attributes(attrs)
+        SoapElement.mail(SoapMailConstants::GET_FOLDER_REQUEST)
+                   .add_attributes(attrs)
       end
     end
   end

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module DocumentFolder
-  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
+  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}/
 
   def upload(file_path)
-    uploader = Zm::Client::Upload.new(@parent, Zm::Client::RestAccountConnector.new)
+    uploader = @parent.build_uploader
     str = uploader.upload_attachment(file_path)
 
     uuid = str.scan(UUID_REGEX).first
@@ -13,8 +13,9 @@ module DocumentFolder
 
     jsns = { doc: { l: @id, upload: { id: uuid } } }
 
-    soap_request = Zm::Client::SoapElement.mail(Zm::Client::SoapMailConstants::SAVE_DOCUMENT_REQUEST).add_attributes(jsns)
-    rep = @parent.sacc.invoke(soap_request)
+    soap_request = Zm::Client::SoapElement.mail(Zm::Client::SoapMailConstants::SAVE_DOCUMENT_REQUEST)
+                                          .add_attributes(jsns)
+    rep = @parent.soap_connector.invoke(soap_request)
 
     Zm::Client::DocumentJsnsInitializer.create(@parent, rep[:SaveDocumentResponse][:doc].first)
   end

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

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