zm-ruby-client 0.18.5 → 2.0.0

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

@@ -0,0 +1,299 @@
+# frozen_string_literal: true
+
+require 'zm/client/connector/rest_account'
+require 'zm/client/signature'
+require 'zm/client/folder'
+require 'zm/client/mountpoint'
+require 'zm/client/search_folder'
+require 'zm/client/share'
+require 'zm/client/tag'
+require 'zm/client/ace'
+require 'zm/client/contact'
+require 'zm/client/appointment'
+require 'zm/client/task'
+require 'zm/client/document'
+require 'zm/client/message'
+require 'zm/client/identity'
+require 'zm/client/upload'
+require 'zm/client/filter_rule'
+require 'zm/client/datasource'
+
+module Zm
+  module Client
+    module Base
+      # Abstract Class for Account and Resource
+      class MailboxObject < Object
+        include HasSoapAdminConnector
+
+        attr_accessor :home_url, :public_url, :password, :carLicense
+        attr_writer :used, :domain_key
+
+        def soap_account_connector
+          @soap_account_connector ||= SoapAccountConnector.create(@parent.config)
+        end
+        alias sacc soap_account_connector
+
+        def rest_account_connector
+          @rest_account_connector ||= RestAccountConnector.new
+        end
+
+        alias rac rest_account_connector
+
+        def domain_name
+          @domain_name ||= @name.split('@').last
+        end
+
+        def infos
+          @infos ||= MailboxInfosCollection.new(self)
+        end
+
+        def prefs
+          @prefs ||= MailboxPrefsCollection.new(self)
+        end
+
+        def used
+          @used || used!
+        end
+
+        def used!
+          @used = mailbox_infos[:s]
+        end
+
+        def mbxid
+          @mbxid || mbxid!
+        end
+
+        def mbxid!
+          @mbxid = mailbox_infos[:mbxid]
+        end
+
+        def mailbox_infos
+          soap_request = SoapElement.admin(SoapAdminConstants::GET_MAILBOX_REQUEST)
+          node_mbox = SoapElement.create(SoapConstants::MBOX).add_attribute(SoapConstants::ID, @id)
+          soap_request.add_node(node_mbox)
+          sac.invoke(soap_request)[:GetMailboxResponse][:mbox].first
+        end
+
+        # #################################################################
+        # Authentication
+        # #################################################################
+
+        def logged?
+          !@token.nil?
+        end
+
+        def domain_key
+          return @domain_key if @domain_key
+          return @parent.domain_key(domain_name) if @parent.logged?
+
+          nil
+        end
+
+        def login
+          if @parent.logged?
+            admin_login
+          else
+            account_login
+          end
+        end
+
+        def account_login
+          sacc.token = nil
+
+          if password
+            account_login_password
+          else
+            account_login_preauth
+          end
+        end
+
+        def account_login_preauth(expires = 0)
+          raise ZmError, 'domain key is required to login !' if domain_key.nil?
+
+          content, by = account_content_by
+
+          @token = sacc.auth_preauth(content, by, expires, domain_key)
+          sacc.context.token(@token)
+        end
+
+        def account_login_password
+          raise ZmError, 'password is required to login !' if password.nil?
+
+          content, by = account_content_by
+
+          @token = sacc.auth_password(content, by, @password)
+          sacc.context.token(@token)
+        end
+
+        def account_content_by
+          @id ? [@id, :id] : [@name, :name]
+        end
+
+        def admin_login
+          # @token = sac.delegate_auth(@name)
+
+          soap_request = SoapElement.admin(SoapAdminConstants::DELEGATE_AUTH_REQUEST)
+          node_account = SoapElement.create(SoapConstants::ACCOUNT)
+
+          if recorded?
+            node_account.add_attribute(SoapConstants::BY, SoapConstants::ID).add_content(@id)
+          else
+            node_account.add_attribute(SoapConstants::BY, SoapConstants::NAME).add_content(@name)
+          end
+
+          soap_request.add_node(node_account)
+          @token = sac.invoke(soap_request)[:DelegateAuthResponse][:authToken].first[:_content]
+          sacc.context.token(@token)
+        end
+
+        # #################################################################
+        # Associations
+        # #################################################################
+
+        def token_metadata
+          @token_metadata ||= TokenMetaData.new(@token)
+        end
+
+        def messages
+          @messages ||= MessagesCollection.new(self)
+        end
+
+        def folders
+          @folders ||= FoldersCollection.new(self)
+        end
+
+        def mountpoints
+          @mountpoints ||= MountPointsCollection.new(self)
+        end
+
+        def search_folders
+          @search_folders ||= SearchFoldersCollection.new(self)
+        end
+
+        def identities
+          @identities ||= IdentitiesCollection.new(self)
+        end
+
+        def shares
+          @shares ||= SharesCollection.new(self)
+        end
+
+        def contacts
+          @contacts ||= ContactsCollection.new(self)
+        end
+
+        def appointments
+          @appointments ||= AppointmentsCollection.new(self)
+        end
+
+        def tags
+          @tags ||= TagsCollection.new(self)
+        end
+
+        def tasks
+          @tasks ||= TasksCollection.new(self)
+        end
+
+        def aces
+          @aces ||= AcesCollection.new(self)
+        end
+        alias rights aces
+
+        def signatures
+          @signatures ||= SignaturesCollection.new(self)
+        end
+
+        def documents
+          @documents ||= DocumentsCollection.new(self)
+        end
+
+        def memberships
+          @memberships ||= AccountDlsMembershipCollection.new(self)
+        end
+
+        def dls_owner
+          @dls_owner ||= AccountDlsOwnerCollection.new(self)
+        end
+
+        def filter_rules
+          @filter_rules ||= FilterRulesCollection.new(self)
+        end
+
+        def outgoing_filter_rules
+          @outgoing_filter_rules ||= OutgoingFilterRulesCollection.new(self)
+        end
+
+        def data_sources
+          @data_sources ||= DataSourcesCollection.new(self)
+        end
+
+        # #################################################################
+        # SOAP Actions
+        # #################################################################
+
+        def password!(new_password = nil)
+          new_password ||= @password
+          return false if new_password.nil?
+
+          soap_request = SoapElement.admin(SoapAdminConstants::SET_PASSWORD_REQUEST)
+          soap_request.add_attributes({ id: @id, newPassword: new_password })
+          sac.invoke(soap_request)
+
+          @password = new_password
+        end
+
+        def rename!(email)
+          soap_request = SoapElement.admin(SoapAdminConstants::RENAME_ACCOUNT_REQUEST)
+          soap_request.add_attributes({ id: @id, newName: email })
+          sac.invoke(soap_request)
+
+          @name = email
+        end
+
+        def update!(hash)
+          return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
+
+          do_update!(hash)
+
+          hash.each do |key, value|
+            update_attribute(key, value)
+          end
+
+          true
+        end
+
+        def local_transport
+          raise Zm::Client::ZmError, 'zimbraMailHost is null' if zimbraMailHost.nil?
+
+          "lmtp:#{zimbraMailHost}:7025"
+        end
+
+        def local_transport!
+          update!(zimbraMailTransport: local_transport)
+        end
+
+        def is_local_transport?
+          return nil unless zimbraMailTransport
+
+          zimbraMailTransport.start_with?(SoapConstants::LMTP)
+        end
+
+        def is_external_transport?
+          return nil unless zimbraMailTransport
+
+          zimbraMailTransport.start_with?(SoapConstants::SMTP)
+        end
+
+        def last_logon
+          @last_logon ||= Time.parse(zimbraLastLogonTimestamp) unless zimbraLastLogonTimestamp.nil?
+        end
+
+        # #################################################################
+
+        def uploader
+          @uploader ||= Upload.new(self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    class MailboxPrefsCollection
+      def initialize(parent)
+        @parent = parent
+        @preferences = []
+      end
+
+      def all
+        @all || all!
+      end
+
+      def all!
+        build_response
+      end
+
+      def clear
+        reset_query_params
+        @all.clear
+      end
+
+      def preferences(*entries)
+        @preferences += entries
+        self
+      end
+
+      def update!(hash)
+        # The JSON version is different:
+        # {
+        #   ModifyPrefsRequest: {
+        #     "_attrs": {
+        #       "prefName1": "prefValue1",
+        #       "prefName2": "prefValue2"
+        #       "+nameOfMulitValuedPref3": "addedPrefValue3",
+        #       "-nameOfMulitValuedPref4": "removedPrefValue4",
+        #       "nameOfMulitValuedPref5": ["prefValue5one","prefValue5two"],
+        #       ...
+        #     },
+        #     _jsns: "urn:zimbraAccount"
+        #   }
+        # }
+
+        req = {
+          _attrs: hash
+        }
+
+        soap_request = SoapElement.account(SoapAccountConstants::MODIFY_PREFS_REQUEST).add_attributes(req)
+        @parent.sacc.invoke(soap_request)
+      end
+
+      private
+
+      def build_response
+        @all = make_query.dig(:GetPrefsResponse, :_attrs)
+      end
+
+      def make_query
+        soap_request = SoapElement.account(SoapAccountConstants::GET_PREFS_REQUEST).add_attributes(jsns)
+        @parent.sacc.invoke(soap_request)
+      end
+
+      def jsns
+        return nil if @preferences.empty?
+
+        { prefs: @preferences.map { |name| { name: name } } }
+      end
+
+      def reset_query_params
+        @preferences.clear
+      end
+    end
+  end
+end

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

@@ -6,49 +6,12 @@ module Zm
       # Abstract Class Provisionning Object
       class Object
         attr_accessor :parent, :token, :name, :id
-        attr_reader :grantee_type
 
         def initialize(parent)
           @parent = parent
-          @use_builder = true
           yield(self) if block_given?
         end
 
-        def disable_builder
-          @use_builder = false
-          self
-        end
-
-        def enable_builder
-          @use_builder = true
-          self
-        end
-
-        def use_builder?
-          @use_builder
-        end
-
-        def init_from_json(json)
-          @id    = json[:id]
-          @name  = json[:name]
-        end
-
-        def concat
-          instance_variables.map { |variable| instance_variable_get(variable) }
-        end
-
-        def to_s
-          concat.join(DOUBLEPOINT)
-        end
-
-        def convert_json_string_value(value)
-          return value unless value.is_a?(String)
-          return 0 if value == '0'
-
-          c = value.to_i
-          c.to_s == value ? c : value
-        end
-
         def recorded?
           !@id.nil?
         end
@@ -57,41 +20,44 @@ module Zm
           recorded? ? modify! : create!
         end
 
-        def instance_variables_array(zcs_attrs)
-          selected_attrs = zcs_attrs.map { |a| arrow_name(a).to_sym }
-          attrs_only_set = instance_variables & selected_attrs
-
-          arr = attrs_only_set.map do |name|
-            n = name.to_s[1..-1]
-            value = instance_variable_get(name)
-            [n, value]
-          end
+        def clone
+          obj = super
+          obj.remove_instance_variable(:@id)
+          yield(obj) if block_given?
+          obj
+        end
 
-          multi_value = arr.select { |a| a.last.is_a?(Array) }
-          arr.reject! { |a| a.last.is_a?(Array) }
-          multi_value.each { |a| arr += a.last.map { |v| [a.first, v] } }
-          arr
+        def logger
+          @parent.logger
         end
 
-        def instance_variables_hash(zcs_attrs)
-          Hash[instance_variables_array(zcs_attrs)]
+        def update_attribute(key, value)
+          arrow_attr_sym = Utils.arrow_name_sym(key)
+
+          if value.respond_to?(:empty?) && value.empty?
+            remove_instance_variable(arrow_attr_sym) if instance_variable_get(arrow_attr_sym)
+          else
+            instance_variable_set(arrow_attr_sym, value)
+          end
         end
 
-        def arrow_name(name)
-          return name if name.to_s.start_with?('@')
+        def to_s
+          inspect
+        end
 
-          "@#{name}"
+        def to_h
+          Hash[instance_variables_map]
         end
 
-        def clone
-          obj = super
-          obj.remove_instance_variable(:@id)
-          yield(obj) if block_given?
-          obj
+        def inspect
+          keys_str = to_h.map { |k, v| "#{k}: #{v}" }.join(', ')
+          "#{self.class}:#{format('0x00%x', (object_id << 1))} #{keys_str}"
         end
 
-        def logger
-          @parent.logger
+        def instance_variables_map
+          keys = instance_variables.dup
+          keys.delete(:@parent)
+          keys.map { |key| [key, instance_variable_get(key)] }
         end
       end
     end

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

@@ -10,24 +10,18 @@ module Zm
           @json = json
         end
 
-        def make
-          return [] if json_items.nil?
-
-          json_items.map do |entry|
-            child = @child_class.new(@parent)
-            child.init_from_json(entry)
-            child
-          end
+        def ids
+          @json[:Body][json_key][:hit]&.map { |s| s[:id] } || []
         end
 
         private
 
         def json_items
-          @json_items ||= @json[:Body][json_key][@json_item_key]
+          @json_items ||= @json[json_key][@json_item_key]
         end
 
         def json_key
-          @json_key ||= @json[:Body].keys.first
+          @json_key ||= @json.keys.first
         end
       end
     end

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

@@ -6,6 +6,8 @@ module Zm
     module Base
       # Abstract Class Collection
       class ObjectsCollection
+        include Zm::Inspector
+
         METHODS_MISSING_LIST = %i[select each map length].to_set.freeze
         attr_reader :parent
 
@@ -19,12 +21,6 @@ module Zm
           find_by(id: id)
         end
 
-        def build_from_entry(entry)
-          child = @child_class.new(@parent)
-          child.init_from_json(entry)
-          child
-        end
-
         def first
           @limit = 1
           build_response.first
@@ -46,6 +42,8 @@ module Zm
           self
         end
 
+        alias limit per_page
+
         def page(offset)
           return self if @offset == offset
 
@@ -54,6 +52,8 @@ module Zm
           self
         end
 
+        alias offset page
+
         def order(sort_by, sort_ascending = SoapUtils::ON)
           return self if @sort_by == sort_by && @sort_ascending == sort_ascending
 
@@ -93,7 +93,10 @@ module Zm
         def attrs_comma
           return @attrs unless @attrs.is_a?(Array)
 
-          @attrs.uniq!
+          # @attrs.uniq!
+          # @attrs.compact!
+          return nil if @attrs.empty?
+
           @attrs.join(COMMA)
         end
 
@@ -104,9 +107,9 @@ module Zm
           @sort_by = nil
           @sort_ascending = SoapUtils::ON
           @count_only = SoapUtils::OFF
-          @all_servers = 0
-          @refresh = 0
-          @apply_cos = 1
+          @all_servers = SoapUtils::OFF
+          @refresh = SoapUtils::OFF
+          @apply_cos = SoapUtils::ON
         end
       end
     end

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

@@ -7,21 +7,23 @@ module Zm
   module Client
     module Base
       class ZimbraAttribute < OpenStruct
-
-        # attr_accessor :flags, :id, :immutable, :max, :min, :name, :optionalIn, :order, :requiredIn, :since, :type, :value
-
         def version_start
           return @version_start unless @version_start.nil?
 
-          if since.nil?
-            @version_start = '0.0.0'
-          else
-            @version_start = VersionSorter.sort(since.split(',')).first
-          end
+          @version_start = if since.nil?
+                             '0.0.0'
+                           else
+                             VersionSorter.sort(since.split(',')).first
+                           end
 
           @version_start
         end
 
+        def immutable?
+          # @immutable.to_s == '1'
+          immutable == '1'
+        end
+
         def objects_scope
           @objects_scope ||= (optionalIn.to_s.split(',') + requiredIn.to_s.split(',')).freeze
         end