zm-ruby-client 0.14.0

data/README.md

@@ -0,0 +1,47 @@
+# zm-ruby-client
+
+Library to interface with Zimbra simply.
+
+## Examples of uses:
+
+### Connection:
+
+```ruby
+admin = Zm::Client::Cluster.new(Zm::Client::ClusterConfig.new('config.json'))
+admin.login
+````
+or
+```ruby
+config = Zm::Client::ClusterConfig.new do |cc|
+  cc.zimbra_admin_host = 'mail.domain.tld'
+  cc.zimbra_admin_scheme = 'https'
+  cc.zimbra_admin_port = 443
+  cc.zimbra_admin_login = 'admin@domain.tld'
+  cc.zimbra_admin_password = 'secret'
+end
+admin = Zm::Client::Cluster.new(config)
+admin.login
+````
+
+### List all accounts
+
+```ruby
+filter = '(&(mail=*@domain.tld)(zimbraLastLogonTimestamp<=20190225000000Z))'
+accounts = admin.accounts.where(filter).all
+```
+
+### Find an account
+
+```ruby
+account = admin.accounts.find_by name: 'maxime@domain.tld'
+```
+
+### Create an account
+
+```ruby
+account = Zm::Client::Account.new(admin) do |acc|
+  acc.name = 'maxime@domain.tld'
+end
+account.zimbraMailQuota = 0
+account.save
+```

data/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

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

@@ -0,0 +1,345 @@
+# frozen_string_literal: true
+
+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'
+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/data_source'
+require 'zm/client/message'
+require 'zm/client/identity'
+require 'zm/client/upload'
+require 'addressable/uri'
+
+module Zm
+  module Client
+    # objectClass: zimbraAccount
+    class Account < Base::AdminObject
+      attr_reader :name, :id, :token
+      attr_writer :home_url
+      attr_accessor :password, :domainkey, :company, :zimbraCOSId, :zimbraMailHost, :zimbraMailTransport, :carLicense
+
+      def initialize(parent, attrs = {})
+        extend(AccountCommon)
+        super(parent)
+        @grantee_type = 'usr'.freeze
+      end
+
+      def init_by_hash(attrs)
+        attrs.each do |k, v|
+          self.instance_variable_set(arrow_name(k), v)
+        end
+      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
+        AccountCommon::ZM_ACCOUNT_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
+        if password
+          account_login_password
+        else
+          account_login_preauth
+        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 token_metadata
+        @token_metadata ||= TokenMetaData.new(@token)
+      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 cos
+        @cos ||= @parent.coses.find_by(id: zimbraCOSId)
+      end
+
+      def used
+        @used ||= sac.get_mailbox(id)[:Body][:GetMailboxResponse][:mbox].first[:s]
+      end
+
+      def public_url
+        infos if @infos.nil?
+        @public_url
+      end
+
+      def home_url
+        infos if @infos.nil?
+        @home_url
+      end
+
+      def messages
+        @messages ||= MessagesCollection.new(self)
+      end
+
+      def folders
+        @folders ||= FoldersCollection.new(self)
+      end
+
+      def mountpoints
+        @mountpointss ||= 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 data_sources
+        @data_sources ||= DataSourcesCollection.new sac, self
+      end
+
+      def documents
+        @documents ||= DocumentsCollection.new(self)
+      end
+
+      def message_folders
+        @message_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::MESSAGE.to_s }
+      end
+
+      def contact_folders
+        @contact_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::CONTACT.to_s }
+      end
+
+      def calendar_folders
+        @calendar_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::APPOINTMENT.to_s }
+      end
+
+      def task_folders
+        @task_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::TASK.to_s }
+      end
+
+      def document_folders
+        @document_folders ||= folders.all.select { |f| f.view == Zm::Client::FolderView::DOCUMENT.to_s }
+      end
+
+      def delete!
+        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)
+
+        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!
+        attrs_to_modify = instance_variables_array(attrs_write)
+        return if attrs_to_modify.empty?
+
+        sac.modify_account(@id, attrs_to_modify)
+      end
+
+      def create!
+        rep = sac.create_account(
+          @name,
+          @password,
+          instance_variables_array(attrs_write)
+        )
+        @id = rep[:Body][:CreateAccountResponse][:account].first[:id]
+      end
+
+      def aliases
+        @aliases ||= set_aliases
+      end
+
+      def set_aliases
+        return [] if zimbraMailAlias.nil?
+        return [zimbraMailAlias] if zimbraMailAlias.is_a?(String)
+        zimbraMailAlias
+      end
+
+      def add_alias!(email)
+        sac.add_account_alias(@id, email)
+        aliases.push(email)
+      end
+
+      def remove_alias!(email)
+        sac.remove_account_alias(@id, email)
+        aliases.delete(email)
+      end
+
+      def rename!(email)
+        sac.rename_account(@id, email)
+        @name = email
+      end
+
+      def local_transport
+        raise Zm::Client::SoapError, '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?('lmtp')
+      end
+
+      def is_external_transport?
+        return nil unless zimbraMailTransport
+
+        zimbraMailTransport.start_with?('smtp')
+      end
+
+      def uploader
+        @uploader ||= Upload.new(self)
+      end
+
+      def last_logon
+        @last_logon ||= Time.parse zimbraLastLogonTimestamp unless zimbraLastLogonTimestamp.nil?
+      end
+
+      def created_at
+        @created_at ||= Time.parse zimbraCreateTimestamp unless zimbraCreateTimestamp.nil?
+      end
+
+      def flush_cache!
+        sac.flush_cache('account', 1, @id)
+      end
+
+      def move_mailbox(server)
+        raise Zm::Client::SoapError, 'zimbraMailHost is null' if zimbraMailHost.nil?
+
+        sac.move_mailbox(@name, zimbraMailHost, server.name, server.id)
+      end
+
+      def is_on_to_move?(server)
+        resp = sac.query_mailbox_move(@name, server.id)
+        resp[:Body][:QueryMailboxMoveResponse][:account].nil?
+      end
+
+      def memberships
+        @memberships ||= AccountDlsMembershipCollection.new(self)
+      end
+
+      def dls_owner
+        @dls_owner ||= AccountDlsOwnerCollection.new(self)
+      end
+
+      def init_from_json(json)
+        @used = json[:used] if json[:used]
+        @zimbraMailQuota = json[:limit] if json[:limit]
+        super(json)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Account dls membership
+    class AccountDlsMembershipCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @parent = parent
+      end
+
+      private
+
+      def make_query
+        @parent.sac.get_account_membership(@parent.id, :id)
+      end
+
+      def build_response
+        DistributionListsBuilder.new(@parent, make_query).make
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Account dls membership
+    class AccountDlsOwnerCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @parent = parent
+      end
+
+      private
+
+      def make_query
+        @parent.sac.search_directory("(zimbraACE=#{@parent.id} usr ownDistList)", SoapUtils::MAX_RESULT, nil, nil, nil, nil, nil, nil, SearchType::DL)
+      end
+
+      def build_response
+        DistributionListsBuilder.new(@parent, make_query).make
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class factory [accounts]
+    class AccountsBuilder < Base::ObjectsBuilder
+      def initialize(parent, json)
+        super(parent, json)
+        @child_class = Account
+      end
+
+      private
+
+      def json_items
+        @json_items ||= @json[:Body][json_key][:account]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # Collection Accounts
+    class AccountsCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @child_class = Account
+        @parent = parent
+        reset_query_params
+      end
+
+      def ldap
+        @apply_cos = 0
+        self
+      end
+
+      def find_by(hash)
+        rep = sac.get_account(hash.values.first, hash.keys.first, attrs_comma, @apply_cos)
+        reset_query_params
+        entry = rep[:Body][:GetAccountResponse][:account].first
+
+        build_from_entry(entry)
+      end
+
+      def find_all_quotas(domain_name = nil, target_server_id = nil)
+        json = sac.get_quota_usage(domain_name, @all_servers, @limit, @offset, @sort_by, @sort_ascending, @refresh, target_server_id)
+        reset_query_params
+        AccountsBuilder.new(@parent, json).make
+      end
+
+      private
+
+      def build_response
+        AccountsBuilder.new(@parent, make_query).make
+      end
+
+      def reset_query_params
+        super
+        @search_type = SearchType::ACCOUNT
+        @attrs = SearchType::Attributes::ACCOUNT.dup
+        @all_servers = 1
+        @refresh = 0
+        @apply_cos = 1
+      end
+    end
+  end
+end

data/lib/zm/client/account.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'zm/client/account/account'
+require 'zm/client/account/accounts_builder'
+require 'zm/client/account/accounts_collection'
+require 'zm/client/account/account_dls_membership_collection'
+require 'zm/client/account/account_dls_owner_collection'

data/lib/zm/client/ace/ace.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class account ace
+    class Ace < Base::AccountObject
+
+      INSTANCE_VARIABLE_KEYS = %i[zid gt right d]
+
+      attr_accessor *INSTANCE_VARIABLE_KEYS
+
+      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!
+        # todo
+      end
+
+      def delete!
+        # todo
+      end
+
+      def rename!(new_name)
+        # todo
+      end
+    end
+  end
+end

data/lib/zm/client/ace/aces_builder.rb

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

data/lib/zm/client/ace/aces_collection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # collection account aces
+    class AcesCollection < Base::ObjectsCollection
+      def initialize(parent)
+        @parent = parent
+        reset_query_params
+      end
+
+      def new
+        ace = Ace.new(@parent)
+        yield(ace) if block_given?
+        ace
+      end
+
+      def rights(*rights)
+        @rights = rights
+        self
+      end
+
+      private
+
+      def build_response
+        rep = @parent.sacc.get_rights(@parent.token, @rights)
+        ab = AcesBuilder.new @parent, rep
+        ab.make
+      end
+
+      def reset_query_params
+        @rights = %i[sendAs sendOnBehalfOf]
+      end
+    end
+  end
+end

data/lib/zm/client/ace.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'zm/client/ace/ace'
+require 'zm/client/ace/aces_builder'
+require 'zm/client/ace/aces_collection'