zm-ruby-client 0.10.4 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2179dff314053e41480d35e8dc012dc64509f4f51939682daf89fe96a3ed9bf3
-  data.tar.gz: 9b27f7a2c40226ba8691cd19afa8647a86fb3596a5b6a724a693637ccbc760f9
+  metadata.gz: 495fd8546a12d2a1fe034da87a2db380ea307cbbad2caf5f676bc88b2f8711be
+  data.tar.gz: cf02068191fca2875bb65c3d63e462db89f2819984be18b05f29b76a8a2070f9
 SHA512:
-  metadata.gz: 364b6e0e612a76caf9350129e0adf852a5ad7847c7d79d306bbaa53a289802462d3324a862ff827c5087150ade21236d0bd287d8ad92844da0c46a149ce13904
-  data.tar.gz: c49afd819b6a5bd34fa1e9bc0f2a9fe6705c2d41389174c83a2f1e5bcdc97f0a48d2af5b02cb1e0f771ed363b8d9c2dca13475fbc45f8726f6a35fe6cad11dc6
+  metadata.gz: 90a577b5df0dd69cbf9a5ef8d39f30765a17a7bed17b7e624b3ac007f172fbfca76b6e1d175e17ff2ae1baa081755bff2ac58cd2e8b463d14921ec196fa0f2c8
+  data.tar.gz: 350398aeff49637ae3d6c203f2ed73ae7f5dfa3cb2cf296e75913f20037a18f6132c1083786e5dccb5d83fd519d98e01374819b1262e9baf1d3ffb5456a2213e

data/lib/zm/client/account/account.rb

@@ -2,6 +2,7 @@
 
 require 'zm/modules/common/account_common'
 # require_relative '../../modules/common/account_galsync'
+require 'zm/client/common'
 require 'zm/client/connector/rest_account'
 require 'zm/client/signature'
 require 'zm/client/folder'
@@ -93,6 +94,10 @@ module Zm
         @token = sac.delegate_auth(@name)
       end
 
+      def token_metadata
+        @token_metadata ||= TokenMetaData.new(@token)
+      end
+
       def domain_name
         @name.split('@').last
       end
@@ -213,6 +218,11 @@ module Zm
         sac.delete_account(@id)
       end
 
+      def password!(new_password)
+        sac.set_password(@id, new_password)
+        @password = new_password
+      end
+
       def update!(hash)
         sac.modify_account(@id, hash)
 

data/lib/zm/client/cluster/cluster.rb

@@ -54,6 +54,10 @@ module Zm
         )
       end
 
+      def token_metadata
+        @token_metadata ||= TokenMetaData.new(@soap_admin_connector.token)
+      end
+
       def license
         @license ||= LicensesCollection.new(self).find
       rescue Zm::Client::SoapError => e

data/lib/zm/client/common/token_metadata.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    class TokenMetaDataError < StandardError; end
+
+    class TokenMetaData
+      def initialize(token)
+        raise TokenMetaDataError, 'no such token' unless token.is_a?(String)
+
+        parts = token.split('_')
+        raise TokenMetaDataError, 'invalid token' unless parts.length == 3
+
+        @key_id = parts[0]
+        @hmac = parts[1]
+        @encoded = parts[2]
+      end
+
+      def decoded
+        @decoded ||= [@encoded].pack('H*')
+      end
+
+      def metadatas
+        @metadatas ||= Hash[decoded.split(';').map { |v| key, len, str = v.split(/[:=]/); [key, str] }].freeze
+      end
+
+      def zimbra_id
+        metadatas['id']
+      end
+
+      def is_admin?
+        @is_admin ||= metadatas['admin'] == '1'
+      end
+
+      def server_version
+        metadatas['version']
+      end
+
+      def expire_at
+        @expire_at ||= Time.at(metadatas['exp'].to_f / 1000).freeze
+      end
+    end
+  end
+end

data/lib/zm/client/common.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 require 'zm/client/common/recipients'
-require 'zm/client/common/message'
+require 'zm/client/common/message'
+require 'zm/client/common/token_metadata'

data/lib/zm/client/connector/soap_account.rb

@@ -11,6 +11,7 @@ module Zm
   module Client
     class SoapAccountConnector < SoapBaseConnector
 
+      SOAP_PATH = '/service/soap/'
       MAILSPACE = 'urn:zimbraMail'
       ACCOUNTSPACE = 'urn:zimbraAccount'
       A_NODE_PROC = lambda { |n| { n: n.first, _content: n.last } }
@@ -18,7 +19,7 @@ module Zm
       A_NODE_PROC_ARROW_NAME = lambda { |n| { :@name => n.first, content!: n.last } }
 
       def initialize(scheme, host, port)
-        @uri = URI::HTTP.new(scheme, nil, host, port, nil, '/service/soap/', nil, nil, nil)
+        @uri = URI::HTTP.new(scheme, nil, host, port, nil, SOAP_PATH, nil, nil, nil)
         init_curl_client
       end
 

data/lib/zm/client/connector/soap_admin.rb

@@ -8,6 +8,7 @@ module Zm
   module Client
     class SoapAdminConnector < SoapBaseConnector
 
+      SOAP_PATH = '/service/admin/soap/'
       ADMINSPACE = 'urn:zimbraAdmin'
       A_NODE_PROC = lambda { |n| { n: n.first, _content: n.last } }
 
@@ -15,7 +16,7 @@ module Zm
 
       def initialize(scheme, host, port)
         @verbose = false
-        @uri = URI::HTTP.new(scheme, nil, host, port, nil, '/service/admin/soap/', nil, nil, nil)
+        @uri = URI::HTTP.new(scheme, nil, host, port, nil, SOAP_PATH, nil, nil, nil)
         init_curl_client
       end
 
@@ -214,6 +215,14 @@ module Zm
         curl_request(body)
       end
 
+      def set_password(id, new_password)
+        soap_name = :SetPasswordRequest
+        req = { id: id, newPassword: new_password }
+        body = init_hash_request(soap_name)
+        body[:Body][soap_name].merge!(req)
+        curl_request(body)
+      end
+
       def add_account_alias(id, email)
         generic_alias(:AddAccountAliasRequest, id, email)
       end
@@ -279,6 +288,17 @@ module Zm
         curl_request(body)
       end
 
+      def create_domain(name, attrs = [])
+        soap_name = :CreateDomainRequest
+        req = {
+          name: name,
+          a: attrs.map(&A_NODE_PROC)
+        }
+        body = init_hash_request(soap_name)
+        body[:Body][soap_name].merge!(req)
+        curl_request(body)
+      end
+
       def modify_domain(id, attrs = [])
         generic_modify(:ModifyDomainRequest, id, attrs)
       end

data/lib/zm/client/document/document.rb

@@ -31,6 +31,10 @@ module Zm
         @parent.sacc.item_action(@parent.token, :tag, @id, tn: tag_name)
       end
 
+      def delete!
+        @parent.sacc.item_action(@parent.token, :delete, @id)
+      end
+
       def download(dest_file_path)
         uploader = Upload.new(@parent, RestAccountConnector.new)
         uploader.download_file(folder.absFolderPath, nil, nil, [id], dest_file_path)

data/lib/zm/client/domain/domain.rb

@@ -6,7 +6,7 @@ module Zm
     class Domain < Base::AdminObject
       INSTANCE_VARIABLE_KEYS = %i[name description zimbraDomainName zimbraDomainStatus zimbraId zimbraDomainType
         zimbraDomainDefaultCOSId zimbraGalAccountId zimbraPreAuthKey zimbraGalLdapBindDn zimbraGalLdapBindPassword
-        zimbraGalLdapFilter zimbraGalLdapSearchBase zimbraGalLdapURL zimbraGalMode]
+        zimbraGalLdapFilter zimbraGalLdapSearchBase zimbraGalLdapURL zimbraGalMode zimbraMailTransport]
 
       attr_accessor *INSTANCE_VARIABLE_KEYS
 
@@ -25,6 +25,17 @@ module Zm
         INSTANCE_VARIABLE_KEYS
       end
 
+      def create!
+        attrs_write = INSTANCE_VARIABLE_KEYS.dup
+        attrs_write.delete(:name)
+
+        rep = sac.create_domain(
+          @name,
+          instance_variables_array(attrs_write)
+        )
+        @id = rep[:Body][:CreateDomainResponse][:domain].first[:id]
+      end
+
       def update!(hash)
         sac.modify_domain(@id, hash)
 

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

@@ -46,6 +46,31 @@ module Zm
         reset_query_params
       end
 
+      def document
+        @view = FolderDefault::BRIEFCASE[:type]
+        self
+      end
+
+      def appointment
+        @view = FolderDefault::CALENDAR[:type]
+        self
+      end
+
+      def contact
+        @view = FolderDefault::CONTACTS[:type]
+        self
+      end
+
+      def message
+        @view = FolderDefault::INBOX[:type]
+        self
+      end
+
+      def task
+        @view = FolderDefault::TASKS[:type]
+        self
+      end
+
       private
 
       def build_response

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

@@ -8,12 +8,12 @@ module Zm
       INSTANCE_VARIABLE_KEYS = %i[id name zimbraPrefIdentityName zimbraPrefFromDisplay zimbraPrefFromAddress
         zimbraPrefFromAddressType zimbraPrefReplyToEnabled zimbraPrefReplyToDisplay zimbraPrefReplyToAddress
         zimbraPrefDefaultSignatureId zimbraPrefForwardReplySignatureId zimbraPrefWhenSentToEnabled
-        zimbraPrefWhenInFoldersEnabled]
+        zimbraPrefWhenInFoldersEnabled zimbraPrefWhenSentToAddresses]
 
       ATTRS_WRITE = %i[zimbraPrefIdentityName zimbraPrefFromDisplay zimbraPrefFromAddress
         zimbraPrefFromAddressType zimbraPrefReplyToEnabled zimbraPrefReplyToDisplay zimbraPrefReplyToAddress
         zimbraPrefDefaultSignatureId zimbraPrefForwardReplySignatureId zimbraPrefWhenSentToEnabled
-        zimbraPrefWhenInFoldersEnabled]
+        zimbraPrefWhenInFoldersEnabled zimbraPrefWhenSentToAddresses]
 
       attr_accessor *INSTANCE_VARIABLE_KEYS
 

data/lib/zm/client/version.rb

@@ -9,8 +9,8 @@ module Zm
 
     module VERSION
       MAJOR = 0
-      MINOR = 10
-      TINY  = 4
+      MINOR = 14
+      TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].compact.join('.')
     end

data/lib/zm/modules/common/dl_common.rb

@@ -7,6 +7,8 @@ module DistributionListCommon
     cn
     zimbraMailForwardingAddress
     description
+    zimbraDistributionListSendShareMessageToNewMembers
+    zimbraNotes
   ].freeze
 
   ATTRS_READ = %w[zimbraMailAlias]
@@ -18,6 +20,7 @@ module DistributionListCommon
     zimbraMailTransport
     zimbraMailForwardingAddress
     description
+    zimbraDistributionListSendShareMessageToNewMembers
   ].freeze
 
   ATTRS_READ.each { |attr| attr_reader attr }

data/test/domains.rb

@@ -59,4 +59,12 @@ class TestDomain < Minitest::Test
     assert domain.name == name
   end
 
+  def test_create_domain
+    name = @fixture_domains['domains']['toto']['name']
+    domain = @admin.domains.new do |acc|
+      acc.name = name
+    end
+    domain.save!
+    assert !domain.id.nil?
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zm-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.14.0
 platform: ruby
 authors:
 - Maxime Désécot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-22 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -111,6 +111,7 @@ files:
 - lib/zm/client/common.rb
 - lib/zm/client/common/message.rb
 - lib/zm/client/common/recipients.rb
+- lib/zm/client/common/token_metadata.rb
 - lib/zm/client/config.rb
 - lib/zm/client/connector/rest_account.rb
 - lib/zm/client/connector/soap_account.rb