zm-ruby-client 0.10.4

data/lib/zm/client/mta_queue/mta_queues_collection.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection MtaQueues
+    class MtaQueuesCollection < Base::ObjectsCollection
+      METHODS_MISSING_LIST = %i[select each map length].to_set.freeze
+
+      def initialize(parent)
+        @parent = parent
+        reset_query_params
+      end
+
+      def all
+        @all ||= all!
+      end
+
+      def all!
+        build_response
+      end
+
+      def defaults
+        @all || defaults!
+      end
+
+      def defaults!
+        # queues = []
+        Zm::Client::MtaQueueName::ALL.each do |queue_name|
+          queue = MtaQueue.new(@parent)
+          queue.name = queue_name
+          set_dynamic_queue_method(queue)
+          @queues_h[queue_name] = queue
+          # queues << queue
+        end
+        # @all = queues
+        @all = @queues_h.values
+      end
+
+      def find(queue_name)
+        raise ZmError, 'Unknown queue name' unless Zm::Client::MtaQueueName::ALL.include?(queue_name)
+        all! if @queues_h.empty?
+        @queues_h[queue_name]
+      end
+
+      def method_missing(method, *args, &block)
+        if METHODS_MISSING_LIST.include?(method)
+          build_response.send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, *)
+        METHODS_MISSING_LIST.include?(method) || super
+      end
+
+      private
+
+      def make_query
+        sac.get_mail_queue_info(@parent.name)
+      end
+
+      def build_response
+        queues = MtaQueuesBuilder.new(@parent, make_query).make
+        clear_dynamic_methods
+
+        queues.each do |queue|
+          set_dynamic_queue_method(queue)
+          @queues_h[queue.name] = queue
+        end
+        queues
+      end
+
+      def set_dynamic_queue_method(queue)
+        s_name = "@#{queue.name}"
+        instance_variable_set(s_name, queue)
+        self.class.attr_reader queue.name
+        @dynamic_methods << s_name
+      end
+
+      def clear_dynamic_methods
+        return if @dynamic_methods.empty?
+
+        @dynamic_methods.each do |name|
+          remove_instance_variable(name) if instance_variable_get(name)
+        end
+      end
+
+      def reset_query_params
+        @dynamic_methods = []
+        @queues_h = {}
+      end
+    end
+  end
+end

data/lib/zm/client/mta_queue.rb

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

data/lib/zm/client/mta_queue_item/mta_queue_item.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    class MtaQueueItem < Base::AdminObject
+      attr_reader :name, :n
+
+      INSTANCE_VARIABLE_KEYS = %i[size fromdomain id reason time to addr filter host from todomain received]
+      attr_reader *INSTANCE_VARIABLE_KEYS
+
+      def mta_queue
+        parent
+      end
+
+      def server
+        mta_queue.parent
+      end
+
+      def to_h
+        hashmap = Hash[INSTANCE_VARIABLE_KEYS.map { |key| [key, instance_variable_get(arrow_name(key))] }]
+        hashmap.delete_if { |_, v| v.nil? }
+        hashmap
+      end
+
+      def sent_at
+        @sent_at ||= Time.at(@time / 1000)
+      rescue StandardError => e
+        nil
+      end
+
+      def hold!
+        sac.mail_queue_action(server.name, mta_queue.name, Zm::Client::MtaQueueAction::HOLD, @id)
+      end
+
+      def init_from_json(json)
+        @size = json[:size]
+        @fromdomain = json[:fromdomain]
+        @id = json[:id]
+        @reason = json[:reason]
+        @time = json[:time].to_i
+        @to = json[:to] ? json[:to].split(',') : []
+        @addr = json[:addr]
+        @filter = json[:filter]
+        @host = json[:host]
+        @from = json[:from]
+        @todomain = json[:todomain] ? json[:todomain].split(',') : []
+        @received = json[:received]
+      end
+    end
+  end
+end

data/lib/zm/client/mta_queue_item/mta_queue_items_builder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [MtaQueueItem]
+    class MtaQueueItemsBuilder < Base::ObjectsBuilder
+      def make
+        records = []
+        return records if json_items.nil?
+
+        json_items.each do |entry|
+          mta_queue = MtaQueueItem.new(@parent)
+          mta_queue.init_from_json(entry)
+          records << mta_queue
+        end
+        records
+      end
+
+      private
+
+      def json_items
+        # puts @json
+        @json_items ||= @json[:Body][json_key][:server].first[:queue].first[:qi]
+      end
+    end
+  end
+end

data/lib/zm/client/mta_queue_item/mta_queue_items_collection.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection MtaQueues
+    class MtaQueueItemsCollection < Base::ObjectsCollection
+      METHODS_MISSING_LIST = %i[select each map length].to_set.freeze
+
+      def initialize(parent)
+        @parent = parent
+        reset_query_params
+      end
+
+      def mta_queue
+        parent
+      end
+
+      def server
+        mta_queue.parent
+      end
+
+      def all
+        @all ||= all!
+      end
+
+      def all!
+        build_response
+      end
+
+      def where(fields)
+        @fields = fields
+        self
+      end
+
+      def fromdomain(value)
+        @fields[:fromdomain] = value
+        self
+      end
+
+      def todomain(value)
+        @fields[:todomain] = value
+        self
+      end
+
+      def ids
+        all.map(&:id)
+      end
+
+      def do_action(action_name)
+        sac.mail_queue_action(server.name, mta_queue.name, action_name, ids)
+      end
+
+      def hold!
+        do_action(Zm::Client::MtaQueueAction::HOLD)
+      end
+
+      def release!
+        do_action(Zm::Client::MtaQueueAction::RELEASE)
+      end
+
+      def delete!
+        do_action(Zm::Client::MtaQueueAction::DELETE)
+      end
+
+      def requeue!
+        do_action(Zm::Client::MtaQueueAction::REQUEUE)
+      end
+
+      def method_missing(method, *args, &block)
+        if METHODS_MISSING_LIST.include?(method)
+          build_response.send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, *)
+        METHODS_MISSING_LIST.include?(method) || super
+      end
+
+      private
+
+      def make_query
+        json = sac.get_mail_queue(@parent.parent.name, @parent.name, @offset, @limit, @fields)
+        reset_query_params
+        json
+      end
+
+      def build_response
+        MtaQueueItemsBuilder.new(@parent, make_query).make
+      end
+
+      def reset_query_params
+        super
+        @fields = {}
+      end
+    end
+  end
+end

data/lib/zm/client/mta_queue_item.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'zm/client/mta_queue_item/mta_queue_item'
+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/resource.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'zm/modules/common/resource_common'
+
+module Zm
+  module Client
+    # objectClass: zimbraCalendarResource
+    class Resource < Base::AdminObject
+      # attr_reader :name, :id, :domainkey, :used, :token
+      attr_accessor :home_url
+
+      def initialize(parent)
+        extend(ResourceCommon)
+        super(parent)
+        @grantee_type = 'usr'.freeze
+      end
+
+      def to_h
+        hashmap = Hash[all_instance_variable_keys.map { |key| [key, instance_variable_get(arrow_name(key))] }]
+        hashmap.delete_if { |_, v| v.nil? }
+        hashmap
+      end
+
+      def all_instance_variable_keys
+        ResourceCommon::ALL_ATTRS
+      end
+
+      def rest_account_connector
+        @rest_account_connector ||= RestAccountConnector.new
+      end
+
+      alias rac rest_account_connector
+
+      def logged?
+        !@token.nil?
+      end
+
+      def login
+        if @parent.logged?
+          admin_login
+        else
+          account_login
+        end
+      end
+
+      def account_login_preauth
+        domain_key
+        raise ZmError, 'domain key is required to login !' if @domainkey.nil?
+
+        @token = sacc.auth_preauth(@name, @domainkey)
+      end
+
+      def account_login_password
+        raise ZmError, 'password is required to login !' if password.nil?
+
+        @token = sacc.auth_password(@name, @password)
+      end
+
+      def admin_login
+        @token = sac.delegate_auth(@name)
+      end
+
+      def domain_name
+        @name.split('@').last
+      end
+
+      def domain_key
+        @domainkey ||= @parent.domain_key(domain_name)
+      end
+
+      def infos
+        @infos ||= read_infos
+      end
+
+      def read_infos
+        @infos = sacc.get_info(@token)[:Body][:GetInfoResponse]
+        @id = @infos[:id]
+        @used = @infos[:used]
+        @public_url = @infos[:publicURL]
+        @zimbraCOSId = @infos[:cos][:id]
+        @home_url = @infos[:rest]
+      end
+
+      def folders
+        @folders ||= FoldersCollection.new(self)
+      end
+
+      def delete!
+        sac.delete_resource(@id)
+      end
+
+      def update!(hash)
+        sac.modify_resource(@id, hash)
+        hash.each { |k, v| send "#{k}=", v }
+      end
+
+      def modify!
+        attrs_to_modify = instance_variables_array(attrs_write)
+        return if attrs_to_modify.empty?
+
+        sac.modify_resource(@id, attrs_to_modify)
+      end
+
+      def create!
+        rep = sac.create_resource(
+          @name,
+          @password,
+          instance_variables_array(attrs_write)
+        )
+        @id = rep[:Body][:CreateCalendarResourceResponse][:calresource].first[:id]
+      end
+
+      def uploader
+        @uploader ||= Upload.new(self)
+      end
+
+      # def download(folder_path, fmt, types, dest_file_path)
+      #   url_folder_path = File.join(@home_url, folder_path.to_s)
+      #   uri = Addressable::URI.new
+      #   uri.query_values = {
+      #       fmt: fmt,
+      #       types: types.join(','),
+      #       emptyname: 'Vide',
+      #       charset: 'UTF-8',
+      #       auth: 'qp',
+      #       zauthtoken: @token
+      #   }
+      #   url_folder_path << '?' << uri.query
+      #
+      #   rac.download(url_folder_path, dest_file_path)
+      # end
+      #
+      # def upload(folder_path, fmt, types, resolve, src_file_path)
+      #   url_folder_path = File.join(@home_url, folder_path.to_s)
+      #   uri = Addressable::URI.new
+      #   uri.query_values = {
+      #     fmt: fmt,
+      #     types: types.join(','),
+      #     resolve: resolve,
+      #     auth: 'qp',
+      #     zauthtoken: @token
+      #   }
+      #   url_folder_path << '?' << uri.query
+      #
+      #   rac.upload(url_folder_path, src_file_path)
+      # end
+    end
+  end
+end

data/lib/zm/client/resource/resources_builder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [resources]
+    class ResourcesBuilder < Base::ObjectsBuilder
+      def initialize(parent, json)
+        super(parent, json)
+        @child_class = Resource
+      end
+
+      # def make
+      #   return [] if json_items.nil?
+      #
+      #   json_items.map do |entry|
+      #     resource = Resource.new(@parent)
+      #     resource.init_from_json(entry)
+      #     resource
+      #   end
+      # end
+
+      private
+
+      def json_items
+        @json_items ||= @json[:Body][json_key][:calresource]
+      end
+    end
+  end
+end

data/lib/zm/client/resource/resources_collection.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Resources
+    class ResourcesCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @child_class = Resource
+        @parent = parent
+        reset_query_params
+      end
+
+      def ldap
+        @apply_cos = 0
+        self
+      end
+
+      def find_by(hash)
+        rep = sac.get_resource(hash.values.first, hash.keys.first, attrs_comma)
+        entry = rep[:Body][:GetCalendarResourceResponse][:calresource].first
+
+        build_from_entry(entry)
+      end
+
+      private
+
+      def build_response
+        ResourcesBuilder.new(@parent, make_query).make
+      end
+
+      def reset_query_params
+        super
+        @search_type = SearchType::RESOURCE
+        @attrs = SearchType::Attributes::RESOURCE.dup
+        @all_servers = 1
+        @refresh = 0
+        @apply_cos = 1
+      end
+    end
+  end
+end

data/lib/zm/client/resource.rb

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

data/lib/zm/client/search_folder/search_folder.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class account SearchFolder
+    class SearchFolder < Base::AccountObject
+
+      INSTANCE_VARIABLE_KEYS = %i[id uuid deletable name absFolderPath l luuid color rgb rev ms webOfflineSyncDays activesyncdisabled query sortBy types]
+
+      attr_accessor *INSTANCE_VARIABLE_KEYS
+
+      def concat
+        INSTANCE_VARIABLE_KEYS.map { |key| instance_variable_get(arrow_name(key)) }
+      end
+
+      def init_from_json(json)
+        INSTANCE_VARIABLE_KEYS.each do |key|
+          var_name = "@#{key}"
+          instance_variable_set(var_name, json[key])
+        end
+      end
+
+      def create!
+        rep = @parent.sacc.create_search_folder(@parent.token, name, query, types, l, color, sortBy)
+        init_from_json(rep[:Body][:CreateSearchFolderResponse][:search].first)
+      end
+
+      def modify!
+        @parent.sacc.modify_search_folder(@parent.token, id, query, types)
+        @parent.sacc.folder_action(@parent.token, :update, id, build_update_options)
+      end
+
+      def query!(new_query)
+        @parent.sacc.modify_search_folder(@parent.token, id, new_query, types)
+        instance_variable_set("@query", new_query)
+      end
+
+      def color!(new_color)
+        key = new_color.to_i.zero? ? :rgb : :color
+        options = {}
+        options[key] = new_color
+        @parent.sacc.folder_action(@parent.token, :color, @id, options)
+        instance_variable_set("@#{key}", new_color)
+      end
+
+      def build_update_options
+        {
+          name: @name,
+          color: @color,
+          rgb: @rgb
+        }.delete_if { |_, v| v.nil? }
+      end
+
+      def delete!
+        @parent.sacc.folder_action(@parent.token, :delete, id)
+      end
+
+      def rename!(new_name)
+        # todo
+      end
+    end
+  end
+end

data/lib/zm/client/search_folder/search_folders_builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [folders]
+    class SearchFoldersBuilder < Base::ObjectsBuilder
+      def initialize(parent, json)
+        @parent = parent
+        @json = json
+      end
+
+      def make
+        root = @json[:Body][:GetSearchFolderResponse][:search]
+        return [] if root.nil?
+
+        root = [root] unless root.is_a?(Array)
+
+        root.map do |s|
+          f = SearchFolder.new(@parent)
+          f.init_from_json(s)
+          f
+        end
+      end
+    end
+  end
+end

data/lib/zm/client/search_folder/search_folders_collection.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # collection of folders
+    class SearchFoldersCollection < Base::ObjectsCollection
+      METHODS_MISSING_LIST = %i[select each map length].to_set.freeze
+
+      def initialize(parent)
+        @parent = parent
+      end
+
+      def new
+        folder = SearchFolder.new(@parent)
+        yield(folder) if block_given?
+        folder
+      end
+
+      private
+
+      def build_response
+        rep = @parent.sacc.get_all_search_folders(@parent.token)
+        fb = SearchFoldersBuilder.new @parent, rep
+        fb.make
+      end
+    end
+  end
+end

data/lib/zm/client/search_folder.rb

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