zm-ruby-client 0.10.4

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

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for account folder
+    class Folder < Base::AccountObject
+
+      INSTANCE_VARIABLE_KEYS = %i[type id uuid name absFolderPath l url luuid f
+        view rev ms webOfflineSyncDays activesyncdisabled n s i4ms i4next zid rid
+        ruuid owner reminder acl itemCount broken deletable color rgb fb]
+
+      attr_accessor *INSTANCE_VARIABLE_KEYS
+      attr_accessor :folders, :grants, :retention_policies
+
+      def concat
+        INSTANCE_VARIABLE_KEYS.map { |key| instance_variable_get(arrow_name(key)) }
+      end
+
+      alias nb_messages n
+      alias nb_items n
+      alias parent_id l
+      alias size s
+
+      def initialize(parent, json = nil, key = :folder)
+        @parent = parent
+        @type = key
+        @folders = []
+        @grants = []
+        @retention_policies = []
+        init_from_json(json) if json.is_a?(Hash)
+        yield(self) if block_given?
+        extend(DocumentFolder) if view == 'document'
+      end
+
+      def is_immutable?
+        @is_immutable ||= Zm::Client::FolderDefault::IDS.include?(@id.to_i)
+      end
+
+      def to_query
+        "inid:#{id}"
+      end
+
+      def to_h
+        {
+          f: f,
+          name: name,
+          l: l,
+          color: color,
+          rgb: rgb,
+          url: url,
+          fb: fb,
+          view: view
+        }
+      end
+
+      def create!
+        options = to_h
+        options.delete_if { |_, v| v.nil? }
+        rep = @parent.sacc.create_folder(@parent.token, options)
+        # rep = @parent.sacc.create_folder(@parent.token, @l, @name, @view, @color)
+        init_from_json(rep[:Body][:CreateFolderResponse][:folder].first)
+      end
+
+      def modify!
+        options = to_h
+        options.delete_if { |_, v| v.nil? }
+
+        if is_immutable?
+          options.delete(:name)
+          options.delete(:l)
+        end
+
+        update!(options)
+      end
+
+      def update!(options)
+        @parent.sacc.folder_action(@parent.token, 'update', @id, options)
+      end
+
+      def rename!(new_name)
+        @parent.sacc.folder_action(@parent.token, 'rename', @id, name: new_name)
+        @name = new_name
+      end
+
+      def add_retention_policy!(retention_policies)
+        options = retention_policies.is_a?(Hash) ? retention_policies : retention_policies.map(&:to_h).reduce({}, :merge)
+        @parent.sacc.folder_action(@parent.token, 'retentionPolicy', @id, retentionPolicy: options)
+      end
+
+      def move!(folder_id)
+        @parent.sacc.folder_action(@parent.token, 'move', @id, l: folder_id)
+        @l = folder_id
+      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 reload!
+        rep = @parent.sacc.get_folder(@parent.token, @id)
+        init_from_json(rep[:Body][:GetFolderResponse][:folder].first)
+      end
+
+      def empty?
+        @n.zero?
+      end
+
+      def empty!
+        @parent.sacc.folder_action(
+          @parent.token,
+          :empty,
+          @id,
+          recursive: false
+        )
+      end
+      alias clear empty!
+
+      def delete!
+        @parent.sacc.folder_action(@parent.token, :delete, @id)
+      end
+
+      #
+      # folder_grant: Zm::Client::FolderGrant
+      #
+      def grant!(folder_grant)
+        @parent.sacc.folder_action(
+            @parent.token,
+            'grant',
+            @id,
+            grant: folder_grant.to_h
+        )
+      end
+
+      # def grant!(parent, right)
+      #   @parent.sacc.folder_action(
+      #     @parent.token,
+      #     'grant',
+      #     @id,
+      #     grant: {
+      #       zid: parent.id,
+      #       gt: parent.grantee_type,
+      #       perm: right
+      #     }
+      #   )
+      # end
+
+      def remove_grant!(zid)
+        @parent.sacc.folder_action(
+          @parent.token,
+          '!grant',
+          @id,
+          zid: zid
+        )
+      end
+
+      def retention_policies_h
+        @retention_policies.map(&:to_h).reduce({}, :merge)
+      end
+
+      def upload(file_path, fmt = nil, types = nil, resolve = 'replace')
+        fmt ||= File.extname(file_path)[1..-1]
+        # @parent.uploader.send_file(absFolderPath, fmt, types, resolve, file_path)
+        uploader = Upload.new(@parent, RestAccountConnector.new)
+        uploader.send_file(absFolderPath, fmt, types, resolve, file_path)
+      end
+
+      def import(file_path)
+        uploader = Upload.new(@parent, RestAccountConnector.new)
+        uploader.send_file(absFolderPath, 'tgz', nil, 'skip', file_path)
+      end
+
+      def download(dest_file_path, fmt = 'tgz')
+        uploader = Upload.new(@parent, RestAccountConnector.new)
+        # uploader.download_file(absFolderPath, fmt, [view], nil, dest_file_path)
+        uploader.download_folder(@id, fmt, dest_file_path)
+      end
+
+      def export(dest_file_path)
+        h = {
+          fmt: 'tgz',
+          emptyname: 'Vide',
+          charset: 'UTF-8',
+          auth: 'qp',
+          zauthtoken: @parent.token,
+          query: to_query
+        }
+
+        url_query = absFolderPath + '?' + h.map { |k, v| [k, v].join('=') }.join('&')
+
+        @parent.uploader.download_file_with_url(url_query, dest_file_path)
+      end
+
+      def init_from_json(json)
+        INSTANCE_VARIABLE_KEYS.each do |key|
+          var_name = "@#{key}"
+          instance_variable_set(var_name, json[key])
+        end
+
+        if !json[:acl].nil? && json[:acl][:grant].is_a?(Array)
+          @grants = json[:acl][:grant].map { |grant| FolderGrant.create_by_json(self, grant) }
+        end
+
+        if json[:retentionPolicy].is_a?(Array)
+          @retention_policies = json[:retentionPolicy].first.map do |k, v|
+            FolderRetentionPolicy.create_by_json(self, k, v.first)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for account folder
+    class FolderGrant < Base::AccountObject
+      attr_accessor :zid, :gt, :perm, :d
+
+      class << self
+        def create_by_json(parent, json)
+          fg = self.new(parent)
+          fg.init_from_json(json)
+          fg
+        end
+      end
+
+      def concat
+        [zid, gt, perm, d]
+      end
+
+      def is_account?
+        gt == 'usr'
+      end
+
+      def is_dom?
+        gt == 'dom'
+      end
+
+      def is_dl?
+        gt == 'grp'
+      end
+
+      def is_public?
+        gt == 'pub'
+      end
+
+      def is_external?
+        gt == 'guest'
+      end
+
+      def init_from_json(json)
+        @zid = json[:zid]
+        @gt = json[:gt]
+        @perm = json[:perm]
+        @d = json[:d]
+      end
+
+      def to_h
+        {
+            zid: @zid,
+            gt: @gt,
+            perm: @perm,
+            d: @d
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for account folder retention policy
+    class FolderRetentionPolicy < Base::AccountObject
+
+      class << self
+        def create_by_json(parent, policy, json)
+          frp = self.new(parent)
+          frp.init_from_json(policy, json)
+          frp
+        end
+      end
+
+      attr_accessor :type, :policy, :lifetime
+
+      def keep?
+        @policy == :keep
+      end
+
+      def purge?
+        @policy == :purge
+      end
+
+      def init_from_json(policy, json)
+        return if json.empty? || json[:policy].nil?
+
+        @policy = policy
+        @type = json[:policy].first[:type]
+        @lifetime = json[:policy].first[:lifetime]
+      end
+
+      def to_h
+        # :purge=>[{:policy=>[{:lifetime=>"366d", :type=>"user"}]}]
+        {
+          @policy => {
+            policy: {
+              lifetime: @lifetime,
+              type: @type
+            }
+          }
+        }
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [folders]
+    class FoldersBuilder < Base::ObjectsBuilder
+      def initialize(account, json)
+        @account = account
+        @json = json
+        @key = :folder
+        @root_folder = nil
+        @list = []
+      end
+
+      def ids
+        root = @json[:Body][:GetFolderResponse][@key]
+        construct_tree_ids(root.first[@key])
+        @list
+      end
+
+      def construct_tree_ids(json_folders)
+        json_folders.each do |json_folder|
+          @list << json_folder[:id]
+          construct_tree_ids(json_folder[@key]) if !json_folder[@key].nil? && json_folder[@key].any?
+        end
+      end
+
+      def make
+        root = @json[:Body][:GetFolderResponse][@key]
+
+        @root_folder = Folder.new(@account, root.first)
+
+        if !root.first[@key].nil? && root.first[@key].any?
+          construct_tree(@root_folder, root.first[@key])
+        end
+
+        @root_folder
+      end
+
+      def construct_tree(parent_folder, json_folders)
+        json_folders.each do |json_folder|
+          folder = Folder.new(@account, json_folder)
+          parent_folder.folders << folder
+
+          construct_tree(folder, json_folder[@key]) if !json_folder[@key].nil? && json_folder[@key].any?
+        end
+      end
+
+      def flatten(folder = @root_folder, collector = [])
+        collector.push(folder)
+        folder.folders.each do |child|
+          flatten(child, collector)
+        end
+        collector
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # collection of folders
+    class FoldersCollection < Base::ObjectsCollection
+      METHODS_MISSING_LIST = %i[select each map length].to_set.freeze
+
+      attr_reader :root
+
+      def initialize(parent)
+        @parent = parent
+        @root = nil
+        reset_query_params
+      end
+
+      def new
+        folder = Folder.new(@parent)
+        yield(folder) if block_given?
+        folder
+      end
+
+      def where(view: nil, tr: nil)
+        @view = view
+        @tr = tr
+        @all = nil
+        self
+      end
+
+      def ids
+        fb = FoldersBuilder.new @parent, make_query
+        fb.ids
+      end
+
+      def all
+        @all || all!
+      end
+
+      def all!
+        build_response
+      end
+
+      def clear
+        @all = nil
+        @root = nil
+        reset_query_params
+      end
+
+      private
+
+      def build_response
+        rep = make_query
+        fb = FoldersBuilder.new @parent, rep
+        @root = fb.make
+        @all = fb.flatten
+        @all.select! { |folder| folder.view == @view } unless @view.nil?
+        @all
+      end
+
+      def make_query
+        @parent.sacc.get_all_folders(@parent.token, @view, @tr)
+      end
+
+      def reset_query_params
+        @view = nil
+        @tr = nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+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}}
+
+  def upload(file_path)
+    uploader = Zm::Client::Upload.new(@parent, Zm::Client::RestAccountConnector.new)
+    str = uploader.upload_attachment(file_path)
+
+    uuid = str.scan(UUID_REGEX).first
+
+    raise Zm::Client::RestError, "failed to extract uuid" if uuid.nil?
+
+    upload_options = { upload: { id: uuid } }
+    rep = @parent.sacc.save_document(@parent.token, id, upload_options)
+
+    Zm::Client::Document.new(@parent, rep[:Body][:SaveDocumentResponse][:doc].first)
+  end
+end

data/lib/zm/client/folder.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'zm/client/folder/folder'
+require 'zm/client/folder/folder_grant'
+require 'zm/client/folder/folder_retention_policy'
+require 'zm/client/folder/folders_builder'
+require 'zm/client/folder/folders_collection'
+require 'zm/client/folder/mod_document_folder'

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [identitys]
+    class IdentitiesBuilder < Base::ObjectsBuilder
+      def initialize(parent, json)
+        @parent = parent
+        @json = json
+      end
+
+      def make
+        root = @json[:Body][:GetIdentitiesResponse][:identity]
+        return [] if root.nil?
+
+        root = [root] unless root.is_a?(Array)
+        root.map do |s|
+          identity = Identity.new(@parent)
+          identity.init_from_json(s)
+          identity
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # collection account identitys
+    class IdentitiesCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @parent = parent
+      end
+
+      def new
+        identity = Identity.new(@parent)
+        yield(identity) if block_given?
+        identity
+      end
+
+      private
+
+      def build_response
+        rep = @parent.sacc.get_all_identities(@parent.token)
+        ib = IdentitiesBuilder.new @parent, rep
+        ib.make
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+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]
+
+      ATTRS_WRITE = %i[zimbraPrefIdentityName zimbraPrefFromDisplay zimbraPrefFromAddress
+        zimbraPrefFromAddressType zimbraPrefReplyToEnabled zimbraPrefReplyToDisplay zimbraPrefReplyToAddress
+        zimbraPrefDefaultSignatureId zimbraPrefForwardReplySignatureId zimbraPrefWhenSentToEnabled
+        zimbraPrefWhenInFoldersEnabled]
+
+      attr_accessor *INSTANCE_VARIABLE_KEYS
+
+      def concat
+        INSTANCE_VARIABLE_KEYS.map { |key| instance_variable_get(arrow_name(key)) }
+      end
+
+      def init_from_json(json)
+        super(json)
+        INSTANCE_VARIABLE_KEYS.each do |key|
+          value = json[:_attrs][key]
+          next if value.nil?
+
+          instance_variable_set(arrow_name(key), value)
+        end
+      end
+
+      def create!
+        rep = @parent.sacc.create_identity(@parent.token, name, instance_variables_array(ATTRS_WRITE))
+        init_from_json(rep[:Body][:CreateIdentityResponse][:identity].first)
+      end
+
+      def update!(hash)
+        @parent.sacc.modify_identity(@parent.token, id, hash)
+
+        hash.each do |k, v|
+          arrow_attr_sym = "@#{k}".to_sym
+
+          if v.respond_to?(:empty?) && v.empty?
+            self.remove_instance_variable(arrow_attr_sym) if self.instance_variable_get(arrow_attr_sym)
+          else
+            self.instance_variable_set(arrow_attr_sym, v)
+          end
+        end
+      end
+
+      def modify!
+        @parent.sacc.modify_identity(@parent.token, id, instance_variables_array(ATTRS_WRITE))
+      end
+
+      def delete!
+        @parent.sacc.delete_identity(@parent.token, id)
+      end
+
+      def rename!(new_name)
+      end
+
+      def clone
+        new_identity = super do |obj|
+          [:@zimbraPrefDefaultSignatureId, :@zimbraPrefForwardReplySignatureId].each do |arrow_key|
+            obj.remove_instance_variable(arrow_key) if obj.instance_variable_get(arrow_key)
+          end
+        end
+        yield(new_identity) if block_given?
+        new_identity
+      end
+    end
+  end
+end

data/lib/zm/client/identity.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'zm/client/identity/identity'
+require 'zm/client/identity/identities_builder'
+require 'zm/client/identity/identities_collection'

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+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
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Class Collection [Domain]
+    class LicensesCollection
+      def initialize(parent)
+        @parent = parent
+      end
+
+      def find
+        req = sac.get_license
+        entry = req[:Body][:GetLicenseResponse][:license].first
+        license = License.new(@parent)
+        license.init_from_json(entry)
+        license
+      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

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