zm-ruby-client 3.0.1 → 3.1.0

data/lib/zm/{client/soap_request → soap_request}/request_methods_admin.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module SoapRequest
     module RequestMethodsAdmin
       def delete!
         sac.invoke(build_delete)
@@ -14,7 +14,7 @@ module Zm
 
       def modify!
         sac.invoke(build_modify)
-        true
+        @updated = true
       end
 
       def build_modify
@@ -25,20 +25,26 @@ module Zm
         jsns_builder.to_create
       end
 
-      def update!(hash)
+      def update!(hash = nil, update_attributes: true, **attrs)
+        hash = hash.nil? ? attrs : hash.merge(attrs)
         return false if hash.delete_if { |k, v| v.nil? || !respond_to?(k) }.empty?
 
         do_update!(hash)
 
+        do_update_attributes(hash) if update_attributes
+
+        @updated = true
+      end
+
+      def do_update_attributes(hash)
         hash.each do |key, value|
           update_attribute(key, value)
         end
-
-        true
       end
 
       def rename!(new_name)
         sac.invoke(build_rename(new_name))
+        @updated = true
         @name = new_name
       end
 

data/lib/zm/{client/soap_request → soap_request}/request_methods_mailbox.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module SoapRequest
     module RequestMethodsMailbox
       def build_create
         jsns_builder.to_jsns

data/lib/zm/{client/soap_request/account_soap_constants.rb → soap_request/soap_account_constants.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module SoapRequest
     module SoapAccountConstants
       ACCOUNT_SERVICE_URI = '/service/soap/'
 

data/lib/zm/{client/soap_request/admin_soap_constants.rb → soap_request/soap_admin_constants.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module SoapRequest
     module SoapAdminConstants
       ADMIN_SERVICE_URI = '/service/admin/soap/'
 

data/lib/zm/{client/soap_request → soap_request}/soap_constants.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module SoapRequest
     module SoapConstants
       BY = 'by'
       ID = 'id'

data/lib/zm/{client/soap_request → soap_request}/soap_context.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module SoapRequest
     class SoapContext
-      # attr_reader :token, :user_agent, :target_server
-
       def initialize
         @token = nil
         @user_agent = 'zmsoap'
@@ -12,11 +10,21 @@ module Zm
         @account = nil
       end
 
+      def initialize_copy(source)
+        super
+        @source = source
+        @token = nil
+      end
+
       def token(str)
         @token = str
         self
       end
 
+      def auth_token
+        @token || @source&.auth_token
+      end
+
       def user_agent(str)
         @user_agent = str
         self
@@ -28,13 +36,13 @@ module Zm
       end
 
       def account(by, value)
-        @account = { by: by, _content: value }
+        @account = { by:, _content: value }
         self
       end
 
       def to_hash
         h = {
-          authToken: @token,
+          authToken: auth_token,
           userAgent: { name: @user_agent },
           account: @account,
           targetServer: @target_server

data/lib/zm/{client/soap_request → soap_request}/soap_element.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module SoapRequest
     class SoapElement
       class << self
         def create(name)

data/lib/zm/{client/soap_request/mail_soap_constants.rb → soap_request/soap_mail_constants.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module SoapRequest
     module SoapMailConstants
       ACCOUNT_SERVICE_URI = '/service/soap/'
 

data/lib/zm/soap_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zm
+  module SoapRequest
+    autoload :SoapContext, 'zm/soap_request/soap_context'
+    autoload :SoapAdminConstants, 'zm/soap_request/soap_admin_constants'
+    autoload :SoapAccountConstants, 'zm/soap_request/soap_account_constants'
+    autoload :SoapMailConstants, 'zm/soap_request/soap_mail_constants'
+    autoload :SoapConstants, 'zm/soap_request/soap_constants'
+    autoload :SoapElement, 'zm/soap_request/soap_element'
+    autoload :RequestMethodsAdmin, 'zm/soap_request/request_methods_admin'
+    autoload :RequestMethodsMailbox, 'zm/soap_request/request_methods_mailbox'
+  end
+end

data/lib/zm/support/cache/entry.rb

@@ -10,12 +10,12 @@ module Zm
           def factory
             @factory ||= MessagePack::Factory.new.tap do |msgpack_factory|
               msgpack_factory.register_type(
-                0x01,
+                0x02,
                 self,
                 packer: ->(entry) { entry.pack.to_msgpack },
                 unpacker: lambda { |data|
                   value, expires_at, version = MessagePack.unpack(data)
-                  new(Marshal.load(value), version: version, expires_at: expires_at)
+                  new(value, version:, expires_at:)
                 }
               )
             end
@@ -49,7 +49,7 @@ module Zm
         end
 
         def pack
-          members = [Marshal.dump(@value), @expires_at, @version]
+          members = [@value, @expires_at, @version]
           members.pop while !members.empty? && members.last.nil?
           members
         end

data/lib/zm/support/cache/file_store.rb

@@ -6,10 +6,8 @@ module Zm
   module Support
     module Cache
       class FileStore < Store
-        Cache.register_storage(:file_store, self)
-
         class << self
-          def test_required_options(options)
+          def valid_options?(options)
             options.key?(:cache_path)
           end
         end
@@ -54,7 +52,7 @@ module Zm
         def read_serialized_entry(key, **)
           File.binread(key) if File.exist?(key)
         rescue StandardError => e
-          warn "FileStoreError (#{e}): #{e.message}"
+          @logger&.error "FileStoreError (#{e}): #{e.message}"
           nil
         end
 
@@ -64,7 +62,7 @@ module Zm
 
         def write_serialized_entry(key, payload, **)
           ensure_cache_path(File.dirname(key))
-          File.write(key, payload)
+          File.open(key, 'wb', 0o600) { |f| f.write(payload) }
           true
         end
 
@@ -120,7 +118,7 @@ module Zm
         end
 
         def ensure_cache_path(path)
-          FileUtils.makedirs(path)
+          FileUtils.makedirs(path, mode: 0o700)
         end
 
         def search_dir(dir, &callback)

data/lib/zm/support/cache/null_store.rb

@@ -4,10 +4,8 @@ module Zm
   module Support
     module Cache
       class NullStore < Store
-        Cache.register_storage(:null_store, self)
-
-        def fetch(_name, _options = nil, &block)
-          block.call
+        def fetch(_name, _options = nil)
+          yield
         end
 
         def read(_name, _options = nil)

data/lib/zm/support/cache/store.rb

@@ -4,13 +4,17 @@ module Zm
   module Support
     module Cache
       class Store
+        class << self
+          def valid_options?(options)
+            options.is_a?(Hash)
+          end
+        end
+
         attr_reader :options
         attr_writer :logger
 
         def initialize(options = {})
           @options = options
-          @coder = Cache::Entry.factory
-          @digest = OpenSSL::Digest.new('sha256')
           @logger = nil
         end
 
@@ -64,7 +68,7 @@ module Zm
           key = normalize_key(name, options)
           version = normalize_version(options)
 
-          entry = Entry.new(value, **options, version: version)
+          entry = Entry.new(value, **options, version:)
           write_entry(key, entry, **options)
         end
 
@@ -114,9 +118,9 @@ module Zm
                       end
 
           if namespace
-            @digest.hexdigest("#{namespace}:#{key}")
+            OpenSSL::Digest::SHA256.hexdigest("#{namespace}:#{key}")
           else
-            @digest.hexdigest(key)
+            OpenSSL::Digest::SHA256.hexdigest(key)
           end
         end
 
@@ -177,18 +181,22 @@ module Zm
 
           value = yield
 
-          entry = Entry.new(value, **options, version: version)
+          entry = Entry.new(value, **options, version:)
           write_entry(key, entry, **options)
           value
         end
 
+        def coder
+          @coder ||= Entry.factory
+        end
+
         def serialize_entry(entry, **)
-          @coder.dump(entry)
+          coder.dump(entry)
         end
 
         def deserialize_entry(payload, **)
-          @coder.load(payload)
-        rescue DeserializationError
+          coder.load(payload)
+        rescue DeserializationError, MessagePack::UnpackError, EOFError
           nil
         end
       end

data/lib/zm/support/cache.rb

@@ -5,22 +5,27 @@ module Zm
     module Cache
       DeserializationError = Class.new(StandardError)
 
+      autoload :Entry, 'zm/support/cache/entry'
+      autoload :Strategy, 'zm/support/cache/strategy'
+      autoload :RequestStrategy, 'zm/support/cache/request_strategy'
+      autoload :Store, 'zm/support/cache/store'
+      autoload :NullStore, 'zm/support/cache/null_store'
+      autoload :FileStore, 'zm/support/cache/file_store'
+
       class << self
         def registered_storage
-          @registered_storage ||= {}
+          @registered_storage ||= { null_store: :NullStore, file_store: :FileStore }
         end
 
         def register_storage(key, klass)
           registered_storage[key] = klass
         end
+
+        def storage(key)
+          klass = registered_storage[key]
+          klass.is_a?(Symbol) ? const_get(klass) : klass
+        end
       end
     end
   end
 end
-
-require 'zm/support/cache/entry'
-require 'zm/support/cache/strategy'
-require 'zm/support/cache/request_strategy'
-require 'zm/support/cache/store'
-require 'zm/support/cache/null_store'
-require 'zm/support/cache/file_store'

data/lib/zm/support.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Zm
+  module Support
+    autoload :Cache, 'zm/support/cache'
+  end
+end

data/lib/zm/{modules → utils}/belongs_to_folder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module Utils
     module BelongsToFolder
       def folder=(folder)
         return if folder.nil?

data/lib/zm/{modules → utils}/belongs_to_tag.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module Utils
     module BelongsToTag
       def tags
         return @tags if defined? @tags
 
-        @tags = AccountObject::TagsCollection.new(self)
+        @tags = Zm::Client::AccountObjectTagsCollection.new(self)
       end
     end
   end

data/lib/zm/utils/content_part.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Zm
+  module Utils
+    module ContentPart
+      ALTERNATIVE = 'multipart/alternative'
+    end
+  end
+end

data/lib/zm/utils/content_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Zm
+  module Utils
+    module ContentType
+      TEXT = 'text/plain'
+      HTML = 'text/html'
+      ALL = [TEXT, HTML].freeze
+    end
+  end
+end

data/lib/zm/{modules → utils}/has_soap_admin_connector.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Zm
-  module Client
+  module Utils
     module HasSoapAdminConnector
       def soap_admin_connector
         @parent.soap_admin_connector

data/lib/zm/utils/inspector.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zm
+  module Utils
+    module Inspector
+      def to_s
+        inspect
+      end
+
+      def to_h
+        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}"
+      end
+
+      def instance_variables_map
+        keys = instance_variables.dup
+        keys.delete(:@parent)
+        keys.map { |key| [key, instance_variable_get(key)] }
+      end
+    end
+  end
+end

data/lib/zm/utils/log_filter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Zm
+  module Utils
+    # mask credentials and tokens in logged SOAP and HTTP payloads
+    module LogFilter
+      FILTERED = '[FILTERED]'
+      JSON_STRING = '"(?:[^"\\\\]|\\\\.)*"'
+
+      PATTERNS = [
+        [/("(?:password|newPassword|authToken)":)#{JSON_STRING}/o, "\\1\"#{FILTERED}\""],
+        [/("(?:authToken|preauth)":\[?\{[^}]*?"_content":)#{JSON_STRING}/o, "\\1\"#{FILTERED}\""],
+        [/("n":"(?:userPassword|zimbraPreAuthKey)","_content":)#{JSON_STRING}/o, "\\1\"#{FILTERED}\""],
+        [/(ZM_(?:ADMIN_)?AUTH_TOKEN=)[^;\s"]+/, "\\1#{FILTERED}"]
+      ].freeze
+
+      module_function
+
+      def filter(str)
+        return str if str.nil?
+
+        PATTERNS.inject(str) { |result, (pattern, replacement)| result.gsub(pattern, replacement) }
+      end
+
+      def apply(formatter)
+        PATTERNS.each { |pattern, replacement| formatter.filter(pattern, replacement) }
+      end
+    end
+  end
+end

data/lib/zm/utils/missing_method_static_collection.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zm
+  module Utils
+    module MissingMethodStaticCollection
+      attr_reader :all
+
+      def method_missing(method, *, &)
+        if @all.respond_to?(method)
+          @all.send(method, *, &)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/zm/utils/regex.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Zm
+  module Utils
+    module Regex
+      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}/
+      BASEDN_REGEX = /^uid=/
+      SHARED_CONTACT = /[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-9]+/
+    end
+  end
+end

data/lib/zm/utils/search_utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Zm
+  module Utils
+    module SearchUtils
+      MAX_RESULT = 1_000_000
+      ON = 1
+      OFF = 0
+      OFFSET = 0
+      LIMIT_RESULT = 10_000
+    end
+  end
+end

data/lib/zm/utils.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Zm
+  module Utils
+    autoload :Inspector, 'zm/utils/inspector'
+    autoload :MissingMethodStaticCollection, 'zm/utils/missing_method_static_collection'
+    autoload :HasSoapAdminConnector, 'zm/utils/has_soap_admin_connector'
+    autoload :BelongsToFolder, 'zm/utils/belongs_to_folder'
+    autoload :BelongsToTag, 'zm/utils/belongs_to_tag'
+    autoload :Regex, 'zm/utils/regex'
+    autoload :ContentPart,  'zm/utils/content_part'
+    autoload :ContentType,  'zm/utils/content_type'
+    autoload :SearchUtils,  'zm/utils/search_utils'
+    autoload :LogFilter, 'zm/utils/log_filter'
+  end
+end

data/lib/zm-ruby-client.rb

@@ -1,3 +1,15 @@
 # frozen_string_literal: true
 
+require 'date'
+require 'time'
+require 'faraday'
+require 'openssl'
+require 'json'
+
+require 'zm/error'
+require 'zm/utils'
+require 'zm/connector'
+require 'zm/support'
+require 'zm/relationship'
+require 'zm/soap_request'
 require 'zm/client'