zm-ruby-client 3.0.1 → 3.1.0

data/lib/zm/client/appointment/appointment.rb

@@ -4,26 +4,35 @@ module Zm
   module Client
     # class for account appointment
     class Appointment < Base::Object
-      include BelongsToFolder
-      include BelongsToTag
-      include RequestMethodsMailbox
+      include Zm::Utils::BelongsToFolder
+      include Zm::Utils::BelongsToTag
+      include SoapRequest::RequestMethodsMailbox
       include MailboxItemConcern
+      extend Zm::Relationship
+      has_jsns_builder
 
       attr_accessor :uid, :name, :desc, :start_at, :dur, :end_at, :tn, :allDay, :organizer, :timezone,
-                    :calItemId, :apptId, :invId, :rev, :fb, :transp
+                    :calItemId, :apptId, :invId, :rev, :fb, :transp, :recur, :s, :ms, :f
       attr_reader :recipients, :attendees, :body
 
       alias description desc
+      alias recurrent recur
+      alias size s
 
       def initialize(parent)
-        @parent = parent
         @recipients = Recipients.new
         @body = BodyMail.new
         @attendees = Attendees.new
         @allDay = false
         @timezone = 'Europe/Berlin'
 
-        yield(self) if block_given?
+        super
+      end
+
+      def flags
+        return @flags if defined? @flags
+
+        @flags = f.chars
       end
 
       def download(dest_file_path, fmt: 'ics')
@@ -31,6 +40,11 @@ module Zm
         uploader.download_file(dest_file_path, id, FolderView::APPOINTMENT, fmt:)
       end
 
+      def read
+        uploader = @parent.build_uploader
+        uploader.read_file(id, FolderView::APPOINTMENT, fmt: 'ics')
+      end
+
       def create!
         rep = @parent.soap_connector.invoke(build_create)
 
@@ -41,12 +55,12 @@ module Zm
       end
 
       def build_create
-        SoapElement.mail(SoapMailConstants::CREATE_APPOINTMENT_REQUEST)
+        SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::CREATE_APPOINTMENT_REQUEST)
                    .add_attributes(jsns_builder.to_jsns)
       end
 
       def build_modify
-        SoapElement.mail(SoapMailConstants::MODIFY_APPOINTMENT_REQUEST)
+        SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::MODIFY_APPOINTMENT_REQUEST)
                    .add_attributes(jsns_builder.to_update)
       end
 
@@ -63,9 +77,9 @@ module Zm
       end
 
       def reload!
-        jsns = { m: { id: id, html: SoapUtils::ON } }
+        jsns = { m: { id:, html: Zm::Utils::SearchUtils::ON } }
 
-        soap_request = SoapElement.mail(SoapMailConstants::GET_MSG_REQUEST)
+        soap_request = SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::GET_MSG_REQUEST)
                                   .add_attributes(jsns)
         rep = @parent.soap_connector.invoke(soap_request)
         entry = rep[:GetMsgResponse][:m].first
@@ -147,11 +161,15 @@ module Zm
         end
       end
 
-      def jsns_builder
-        return @jsns_builder if defined? @jsns_builder
-
-        @jsns_builder = AppointmentJsnsBuilder.new(self)
+      class BodyMail
+        attr_accessor :text, :html
       end
+
+      # def jsns_builder
+      #   return @jsns_builder if defined? @jsns_builder
+      #
+      #   @jsns_builder = AppointmentJsnsBuilder.new(self)
+      # end
     end
   end
 end

data/lib/zm/client/appointment/appointment_jsns_builder.rb

@@ -3,7 +3,7 @@
 module Zm
   module Client
     # class for account appointment
-    class AppointmentJsnsBuilder < BaseAccountJsnsBuilder
+    class AppointmentJsnsBuilder < Base::BaseAccountJsnsBuilder
       def to_jsns
         {
           m: {
@@ -22,7 +22,7 @@ module Zm
 
       def to_update
         jsns = to_jsns
-        jsns[:comp] = SoapUtils::OFF
+        jsns[:comp] = Zm::Utils::SearchUtils::OFF
         jsns[:id] = @item.id
         jsns[:m][:inv][:uid] = @item.uid
         jsns
@@ -43,18 +43,18 @@ module Zm
       def body_to_jsns
         [
           {
-            ct: ContentPart::ALTERNATIVE,
+            ct: Zm::Utils::ContentPart::ALTERNATIVE,
             mp: [body_text_jsns, body_html_jsns]
           }
         ]
       end
 
       def body_text_jsns
-        { ct: ContentType::TEXT, content: { _content: @item.body.text } }
+        { ct: Zm::Utils::ContentType::TEXT, content: { _content: @item.body.text } }
       end
 
       def body_html_jsns
-        { ct: ContentType::HTML, content: { _content: @item.body.html } }
+        { ct: Zm::Utils::ContentType::HTML, content: { _content: @item.body.html } }
       end
 
       def comp_to_jsns

data/lib/zm/client/appointment/appointment_jsns_initializer.rb

@@ -31,6 +31,11 @@ module Zm
         @appointment.tn = @json.delete(:tn)
         @appointment.l = @json.delete(:l)
         @appointment.uid = @json.delete(:uid)
+        @appointment.recur = @json.delete(:recur) || false
+        @appointment.s = @json.delete(:s).to_i
+        @appointment.ms = @json.delete(:ms).to_i
+        @appointment.rev = @json.delete(:rev).to_i
+        @appointment.f = @json.delete(:f) || ''
 
         if inv.nil?
           init_from_search
@@ -108,7 +113,7 @@ module Zm
       end
 
       def comp
-        raise Zm::Client::ZmError, 'invalid appointment received' if inv[:comp].nil?
+        raise Zm::Error::ZmError, 'invalid appointment received' if inv[:comp].nil?
 
         @comp ||= inv[:comp].first
       end

data/lib/zm/client/appointment/appointments_collection.rb

@@ -8,14 +8,14 @@ module Zm
         super
         @child_class = Appointment
         @builder_class = AppointmentsBuilder
-        @type = SoapConstants::APPOINTMENT
-        @sort_by = SoapConstants::DATE_ASC
+        @type = SoapRequest::SoapConstants::APPOINTMENT
+        @sort_by = SoapRequest::SoapConstants::DATE_ASC
       end
 
       def find(id)
-        jsns = { m: { id: id, html: SoapUtils::ON } }
+        jsns = { m: { id:, html: Zm::Utils::SearchUtils::ON } }
 
-        soap_request = SoapElement.mail(SoapMailConstants::GET_MSG_REQUEST)
+        soap_request = SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::GET_MSG_REQUEST)
                                   .add_attributes(jsns)
         rep = @parent.soap_connector.invoke(soap_request)
         entry = rep[:GetMsgResponse][:m].first
@@ -23,16 +23,19 @@ module Zm
         AppointmentJsnsInitializer.new(@parent, entry).create
       end
 
-      def find_each(offset: 0, limit: 500, &block)
-        (Time.at(0).year..(Time.now.year + 10)).each do |year|
-          @start_at ||= Time.new(year, 1, 1).to_i * 1000
-          @end_at ||= Time.new(year, 12, 31).to_i * 1000
+      def find_each(offset: 0, limit: 500, start_year: nil, end_year: nil, &)
+        start_year ||= Time.now.year - 10
+        end_year ||= Time.now.year + 10
+
+        (start_year..end_year).each do |year|
+          @start_at = Time.new(year, 1, 1).to_i * 1000
+          @end_at = Time.new(year, 12, 31).to_i * 1000
           @more = true
           @offset = offset
           @limit = limit
 
           while @more
-            build_response.each { |item| block.call(item) }
+            build_response.each(&)
             @offset += @limit
           end
         end

data/lib/zm/client/backup/backup.rb

@@ -3,6 +3,9 @@
 module Zm
   module Client
     class Backup < Base::Object
+      FULL = 'full'
+      INCREMENTAL = 'incremental'
+
       attr_accessor :label, :type, :aborted, :start, :end, :minRedoSeq, :maxRedoSeq, :live, :accounts
 
       alias name label
@@ -28,11 +31,11 @@ module Zm
       end
 
       def full?
-        @type == Zm::Client::BackupTypes::FULL
+        @type == FULL
       end
 
       def incremental?
-        @type == Zm::Client::BackupTypes::INCREMENTAL
+        @type == INCREMENTAL
       end
     end
   end

data/lib/zm/client/backup/backups_collection.rb

@@ -5,14 +5,15 @@ module Zm
     # Collection Backups
     class BackupsCollection < Base::ObjectsCollection
       def initialize(parent)
+        super()
         @parent = parent
       end
 
       private
 
       def make_query
-        soap_request = SoapElement.admin(SoapAdminConstants::BACKUP_QUERY_REQUEST)
-                                  .add_attribute(SoapConstants::QUERY, {})
+        soap_request = Zm::SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::BACKUP_QUERY_REQUEST)
+                                  .add_attribute(Zm::SoapRequest::SoapConstants::QUERY, {})
         sac.target_invoke(soap_request, @parent.id)
       end
 

data/lib/zm/client/base/account_objects_collection.rb

@@ -6,6 +6,7 @@ module Zm
       # Collection AccountObjectsCollection
       class AccountObjectsCollection < ObjectsCollection
         def initialize(parent)
+          super()
           @parent = parent
         end
       end

data/lib/zm/client/base/account_search_objects_collection.rb

@@ -21,8 +21,8 @@ module Zm
         end
 
         def build_find(id)
-          SoapElement.mail(SoapMailConstants::GET_MSG_REQUEST)
-                     .add_attributes({ m: { id: id, html: SoapUtils::ON } })
+          SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::GET_MSG_REQUEST)
+                     .add_attributes({ m: { id:, html: Zm::Utils::SearchUtils::ON } })
         end
 
         def start_at(start_at)
@@ -92,7 +92,7 @@ module Zm
             offset: @offset,
             limit: @limit,
             sortBy: @sort_by,
-            query: query,
+            query:,
             header: @headers
           }
 
@@ -100,7 +100,7 @@ module Zm
 
           jsns.compact!
 
-          SoapElement.mail(SoapMailConstants::SEARCH_REQUEST)
+          SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::SEARCH_REQUEST)
                      .add_attributes(jsns)
         end
 
@@ -112,8 +112,8 @@ module Zm
 
           attrs.compact!
 
-          soap_request = SoapElement.mail(SoapMailConstants::ITEM_ACTION_REQUEST)
-          node_action = SoapElement.create(SoapConstants::ACTION).add_attributes(attrs)
+          soap_request = SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::ITEM_ACTION_REQUEST)
+          node_action = SoapRequest::SoapElement.create(SoapRequest::SoapConstants::ACTION).add_attributes(attrs)
           soap_request.add_node(node_action)
           @parent.soap_connector.invoke(soap_request)
         end

data/lib/zm/client/base/admin_objects_collection.rb

@@ -5,7 +5,10 @@ module Zm
     module Base
       # Collection AdminObjectsCollection
       class AdminObjectsCollection < ObjectsCollection
+        ONERRORS = %w[continue stop].freeze
+
         def initialize(parent)
+          super()
           @parent = parent
           @persistent = false
           reset_query_params
@@ -15,14 +18,14 @@ module Zm
           find_by!(hash)
         end
 
-        def find_by_or_nil(hash, error_handler = SoapError)
+        def find_by_or_nil(hash, error_handler = Zm::Error::SoapError)
           find_by(hash)
         rescue error_handler => _e
           nil
         end
 
         def ldap
-          @apply_cos = SoapUtils::OFF
+          @apply_cos = Zm::Utils::SearchUtils::OFF
           self
         end
 
@@ -47,9 +50,9 @@ module Zm
 
         def count
           reset_query_params
-          @count_only = SoapUtils::ON
+          @count_only = Zm::Utils::SearchUtils::ON
           json = make_query
-          @count_only = SoapUtils::OFF
+          @count_only = Zm::Utils::SearchUtils::OFF
           json[:SearchDirectoryResponse][:num]
         end
 
@@ -59,7 +62,7 @@ module Zm
           self
         end
 
-        def find_each(offset: 0, limit: 1_000, &block)
+        def find_each(offset: 0, limit: 1_000, &)
           previous_persistent = @persistent.dup
           @persistent = true
 
@@ -71,7 +74,7 @@ module Zm
           @limit = limit
 
           while @offset < total
-            build_response.each { |item| block.call(item) }
+            build_response.each(&)
             @offset += @limit
           end
 
@@ -88,12 +91,62 @@ module Zm
         end
 
         def build_query
-          SoapElement.admin(SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
+          SoapRequest::SoapElement.admin(Zm::SoapRequest::SoapAdminConstants::SEARCH_DIRECTORY_REQUEST)
                      .add_attributes(jsns)
         end
 
+        def update_all!(hash = nil, onerror: ONERRORS.first, update_attributes: true, **attrs)
+          mass_update!(build_response, hash, onerror:, update_attributes:, **attrs)
+        end
+
+        def mass_update!(items, hash = nil, onerror: ONERRORS.first, update_attributes: true, **attrs)
+          hash = hash.nil? ? attrs : hash.merge(attrs)
+          format_mass_items_parameter(items)
+
+          items.each do |item|
+            item.update!(hash, update_attributes:)
+          rescue Zm::Error::SoapError => e
+            @parent.logger.error e.message
+            @parent.logger.debug e.backtrace.join("\n")
+
+            return items if onerror == ONERRORS.last
+          end
+
+          items
+        end
+
+        def delete_all!(onerror: ONERRORS.first)
+          mass_delete!(build_response, onerror:)
+        end
+
+        def mass_delete!(items, onerror: ONERRORS.first)
+          format_mass_items_parameter(items)
+
+          items.each do |item|
+            item.delete!
+          rescue Zm::Error::SoapError => e
+            @parent.logger.error e.message
+            @parent.logger.debug e.backtrace.join("\n")
+
+            return items if onerror == ONERRORS.last
+          end
+
+          items
+        end
+
         private
 
+        def format_mass_items_parameter(items)
+          items.map! do |item|
+            if item.is_a?(@child_class)
+              item.updated = false
+              item
+            else
+              new { |acc| acc.id = item }
+            end
+          end
+        end
+
         def ldap_filter
           return @ldap_filter if defined? @ldap_filter
 

data/lib/zm/client/base/base_account_jsns_builder.rb

@@ -2,93 +2,95 @@
 
 module Zm
   module Client
-    # class for account tag jsns builder
-    class BaseAccountJsnsBuilder
-      def initialize(item)
-        @item = item
-      end
-
-      def to_tag(tag_name = nil)
-        tag_name ||= @item.tn
-
-        attrs = {
-          op: :tag,
-          id: @item.id,
-          tn: tag_name
-        }
-
-        build(attrs)
-      end
-
-      def to_move(new_folder_id = nil)
-        new_folder_id ||= @item.l
-
-        attrs = {
-          op: :move,
-          id: @item.id,
-          l: new_folder_id
-        }
-
-        build(attrs)
-      end
-
-      def to_patch(hash)
-        attrs = {
-          op: :update,
-          id: @item.id
-        }.merge(hash)
-
-        attrs.compact!
-
-        build(attrs)
-      end
-
-      def to_delete
-        attrs = {
-          op: :delete,
-          id: @item.id
-        }
-
-        build(attrs)
-      end
-
-      def to_rename(new_name = nil)
-        new_name ||= @item.name
-
-        attrs = {
-          op: :rename,
-          id: @item.id,
-          name: new_name
-        }
-
-        build(attrs)
-      end
-
-      def to_color
-        attrs = {
-          op: :color,
-          id: @item.id,
-          rgb: @item.rgb,
-          color: @item.color
-        }
-
-        build(attrs)
-      end
-
-      def to_trash
-        attrs = {
-          op: :trash,
-          id: @item.id
-        }
-
-        build(attrs)
-      end
-
-      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
+    module Base
+      # class for account tag jsns builder
+      class BaseAccountJsnsBuilder
+        def initialize(item)
+          @item = item
+        end
+
+        def to_tag(tag_name = nil)
+          tag_name ||= @item.tn
+
+          attrs = {
+            op: :tag,
+            id: @item.id,
+            tn: tag_name
+          }
+
+          build(attrs)
+        end
+
+        def to_move(new_folder_id = nil)
+          new_folder_id ||= @item.l
+
+          attrs = {
+            op: :move,
+            id: @item.id,
+            l: new_folder_id
+          }
+
+          build(attrs)
+        end
+
+        def to_patch(hash)
+          attrs = {
+            op: :update,
+            id: @item.id
+          }.merge(hash)
+
+          attrs.compact!
+
+          build(attrs)
+        end
+
+        def to_delete
+          attrs = {
+            op: :delete,
+            id: @item.id
+          }
+
+          build(attrs)
+        end
+
+        def to_rename(new_name = nil)
+          new_name ||= @item.name
+
+          attrs = {
+            op: :rename,
+            id: @item.id,
+            name: new_name
+          }
+
+          build(attrs)
+        end
+
+        def to_color
+          attrs = {
+            op: :color,
+            id: @item.id,
+            rgb: @item.rgb,
+            color: @item.color
+          }
+
+          build(attrs)
+        end
+
+        def to_trash
+          attrs = {
+            op: :trash,
+            id: @item.id
+          }
+
+          build(attrs)
+        end
+
+        def build(attrs)
+          soap_request = SoapRequest::SoapElement.mail(SoapRequest::SoapMailConstants::ITEM_ACTION_REQUEST)
+          node_action = SoapRequest::SoapElement.create(SoapRequest::SoapConstants::ACTION).add_attributes(attrs)
+          soap_request.add_node(node_action)
+          soap_request
+        end
       end
     end
   end

data/lib/zm/client/base/base_jsns_builder.rb

@@ -15,7 +15,7 @@ module Zm
         def to_jsns
           {
             name: @item.name,
-            a: instance_variables_array.map(&A_ARRAY_PROC).flatten(1).map(&A_NODE_PROC)
+            a: instance_variables_array.flat_map(&A_ARRAY_PROC).map(&A_NODE_PROC)
           }
         end
 
@@ -24,14 +24,14 @@ module Zm
         def to_update
           {
             id: @item.id,
-            a: instance_variables_array.map(&A_ARRAY_PROC).flatten(1).map(&A_NODE_PROC)
+            a: instance_variables_array.flat_map(&A_ARRAY_PROC).map(&A_NODE_PROC)
           }
         end
 
         def to_patch(hash)
           {
             id: @item.id,
-            a: hash.map(&A_ARRAY_PROC).flatten(1).map(&A_NODE_PROC)
+            a: hash.flat_map(&A_ARRAY_PROC).map(&A_NODE_PROC)
           }
         end