zm-ruby-client 0.10.4

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Zm
+  module Client
+    module Base
+      # Abstract Class Provisionning AdminObject
+      class AdminObject < Object
+
+        def soap_admin_connector
+          @parent.soap_admin_connector
+        end
+
+        alias sac soap_admin_connector
+
+        def soap_account_connector
+          @parent.soap_account_connector
+        end
+
+        alias sacc soap_account_connector
+
+        def init_from_json(json)
+          # TODO : know in advance the typing of variables
+          super(json)
+          return unless json[:a].is_a? Array
+
+          # fix car le tableau peut contenir des {} vide !
+          json[:a].reject! { |n| n[:n].nil? }
+          json_map = json[:a].map { |n| ["@#{n[:n]}", n[:_content]] }.freeze
+
+          json_hash = json_map.reduce({}) { |h, (k, v)| (h[k] ||= []); h[k].push(v); h }.inject({}) { |h, (k, v)| v.length == 1 ? h[k] = v.first : h[k] = v; h }
+
+          json_hash.each do |k, v|
+            instance_variable_set(k, convert_json_string_value(v))
+          end
+
+          # Hash[json_map].each do |k, v|
+          #   instance_variable_set(k, convert_json_string_value(v))
+          # end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module Base
+      # Abstract Class Provisionning Object
+      class Object
+        attr_accessor :parent, :token, :name, :id
+        attr_reader :grantee_type
+
+        def initialize(parent)
+          @parent = parent
+          yield(self) if block_given?
+        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
+
+        def save!
+          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
+
+          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
+        end
+
+        def instance_variables_hash(zcs_attrs)
+          Hash[instance_variables_array(zcs_attrs)]
+        end
+
+        def arrow_name(name)
+          return name if name.to_s.start_with?('@')
+
+          "@#{name}"
+        end
+
+        def clone
+          obj = super
+          obj.remove_instance_variable(:@id)
+          yield(obj) if block_given?
+          obj
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    module Base
+      # Abstract Class Builder [object]
+      class ObjectsBuilder
+        def initialize(parent, json)
+          @parent = parent
+          @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
+        end
+
+        private
+
+        def json_key
+          @json_key ||= @json[:Body].keys.first
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'set'
+module Zm
+  module Client
+    module Base
+      # Abstract Class Collection
+      class ObjectsCollection
+        METHODS_MISSING_LIST = %i[select each map length].to_set.freeze
+        attr_reader :parent
+
+        def new
+          child = @child_class.new(@parent)
+          yield(child) if block_given?
+          child
+        end
+
+        def find(id)
+          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
+        end
+
+        def all
+          @all || all!
+        end
+
+        def all!
+          @all = build_response
+        end
+
+        def where(ldap_query)
+          return self if @ldap_query == ldap_query
+
+          @all = nil
+          @ldap_query = ldap_query
+          self
+        end
+
+        def per_page(limit)
+          return self if @limit == limit
+
+          @all = nil
+          @limit = limit
+          self
+        end
+
+        def page(offset)
+          return self if @offset == offset
+
+          @all = nil
+          @offset = offset
+          self
+        end
+
+        def order(sort_by, sort_ascending = SoapUtils::ON)
+          return self if @sort_by == sort_by && @sort_ascending == sort_ascending
+
+          @all = nil
+          @sort_by = sort_by
+          @sort_ascending = sort_ascending
+          self
+        end
+
+        def count
+          @count_only = SoapUtils::ON
+          make_query[:Body][:SearchDirectoryResponse][:num]
+        end
+
+        def attrs(*attrs)
+          return self if @attrs == attrs
+
+          @all = nil
+          @attrs = attrs
+          self
+        end
+
+        def method_missing(method, *args, &block)
+          if METHODS_MISSING_LIST.include?(method)
+            build_response.send(method, *args, &block)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(method, *)
+          METHODS_MISSING_LIST.include?(method) || super
+        end
+
+        private
+
+        def soap_admin_connector
+          @parent.soap_admin_connector
+        end
+
+        alias sac soap_admin_connector
+
+        def make_query
+          json = sac.search_directory(
+            @ldap_query, @max_result, @limit, @offset,
+            @domain_name, @apply_cos, nil, @sort_by, @search_type,
+            @sort_ascending, @count_only, attrs_comma
+          )
+          reset_query_params
+          json
+        end
+
+        def attrs_comma
+          return @attrs unless @attrs.is_a?(Array)
+
+          @attrs.uniq!
+          @attrs.join(COMMA)
+        end
+
+        def reset_query_params
+          @max_result = SoapUtils::MAX_RESULT
+          @limit = nil
+          @offset = nil
+          @sort_by = nil
+          @sort_ascending = SoapUtils::ON
+          @count_only = SoapUtils::OFF
+        end
+      end
+    end
+  end
+end

data/lib/zm/client/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'zm/client/base/object'
+require 'zm/client/base/account_object'
+require 'zm/client/base/admin_object'
+require 'zm/client/base/objects_builder'
+require 'zm/client/base/objects_collection'

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'zm/client/connector/soap_admin'
+require 'zm/client/connector/soap_account'
+require 'zm/client/common'
+# require 'zm/client/data_source'
+require 'zm/client/domain'
+require 'zm/client/account'
+require 'zm/client/resource'
+require 'zm/client/distributionlist'
+require 'zm/client/server'
+require 'zm/client/cos'
+require 'zm/client/license'
+# require 'zm/client/distributionlist'
+
+module Zm
+  module Client
+    # class admin connection
+    class Cluster
+      attr_reader :soap_admin_connector, :config
+
+      def initialize(config)
+        @config = config
+        @soap_admin_connector = SoapAdminConnector.new(
+          @config.zimbra_admin_scheme,
+          @config.zimbra_admin_host,
+          @config.zimbra_admin_port
+        )
+      end
+
+      def login
+        @soap_admin_connector.auth(
+          @config.zimbra_admin_login,
+          @config.zimbra_admin_password
+        )
+      end
+
+      def logged?
+        !@soap_admin_connector.token.nil?
+      end
+
+      def alive?
+        @soap_admin_connector.noop
+        true
+      rescue Zm::Client::SoapError => _
+        false
+      end
+
+      def soap_account_connector
+        @soap_account_connector ||= SoapAccountConnector.new(
+          @config.zimbra_public_scheme,
+          @config.zimbra_public_host,
+          @config.zimbra_public_port
+        )
+      end
+
+      def license
+        @license ||= LicensesCollection.new(self).find
+      rescue Zm::Client::SoapError => e
+        puts e.message
+        nil
+      end
+
+      def domains
+        @domains ||= DomainsCollection.new self
+      end
+
+      def accounts
+        @accounts ||= AccountsCollection.new self
+      end
+
+      def resources
+        @resources ||= ResourcesCollection.new self
+      end
+
+      def servers
+        @servers ||= ServersCollection.new self
+      end
+
+      def coses
+        @coses ||= CosesCollection.new self
+      end
+
+      def distributionlists
+        @distributionlists ||= DistributionListsCollection.new self
+      end
+
+      alias distribution_lists distributionlists
+
+      def domain_key(domain_name)
+        key = @config.domain_key(domain_name)
+        key ||= find_domain_key(domain_name)
+        key
+      end
+
+      def count_object(type)
+        raise ZmError, 'Unknown object type' unless Zm::Client::CountTypes::ALL.include?(type)
+
+        resp = soap_admin_connector.count_object(type)
+        resp[:Body][:CountObjectsResponse][:num]
+      end
+
+      def email_exist?(email)
+        filter = "(mail=#{email})"
+        resp = soap_admin_connector.search_directory(filter, nil, nil, nil, nil, nil, nil, nil, 'accounts,distributionlists,aliases,resources',nil, 1)
+        num = resp[:Body][:SearchDirectoryResponse][:num]
+        !num.zero?
+      end
+
+      private
+
+      def find_domain_key(domain_name)
+        domains.find_by({ name: domain_name }, 'zimbraPreAuthKey').zimbraPreAuthKey
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Zm
+  module Client
+    # class config for cluster connection
+    class ClusterConfig
+      attr_reader :to_h
+      attr_accessor :zimbra_admin_host, :zimbra_admin_scheme,
+                    :zimbra_admin_port, :zimbra_admin_login,
+                    :zimbra_admin_password, :zimbra_public_host,
+                    :zimbra_public_scheme, :zimbra_public_port,
+                    :domains
+
+      def initialize(parameters = nil)
+        @zimbra_admin_scheme = 'https'
+        @zimbra_admin_port = 7071
+        @zimbra_public_scheme = 'https'
+        @zimbra_public_port = 443
+        @domains = []
+
+        if parameters.is_a?(String)
+          init_from_file(parameters)
+        elsif parameters.is_a?(Hash)
+          @to_h = parameters
+        end
+
+        unless @to_h.nil?
+          init_from_h
+          make_config_domain
+        end
+
+        yield(self) if block_given?
+      end
+
+      def init_from_file(file_config_path)
+        if file_config_path.end_with?('.json')
+          init_from_json(file_config_path)
+        elsif file_config_path.end_with?('.yml', '.yaml')
+          init_from_yml(file_config_path)
+        else
+          raise ClusterConfigError, 'no valid config file extension'
+        end
+      end
+
+      def init_from_h
+        @zimbra_admin_host = @to_h[:zimbra_admin_host] unless @to_h[:zimbra_admin_host].nil?
+        @zimbra_admin_scheme = @to_h[:zimbra_admin_scheme] unless @to_h[:zimbra_admin_scheme].nil?
+        @zimbra_admin_port = @to_h[:zimbra_admin_port] unless @to_h[:zimbra_admin_port].nil?
+        @zimbra_admin_login = @to_h[:zimbra_admin_login] unless @to_h[:zimbra_admin_login].nil?
+        @zimbra_admin_password = @to_h[:zimbra_admin_password] unless @to_h[:zimbra_admin_password].nil?
+        @zimbra_public_host = @to_h[:zimbra_public_host] unless @to_h[:zimbra_public_host].nil?
+        @zimbra_public_scheme = @to_h[:zimbra_public_scheme] unless @to_h[:zimbra_public_scheme].nil?
+        @zimbra_public_port = @to_h[:zimbra_public_port] unless @to_h[:zimbra_public_port].nil?
+      end
+
+      def init_from_yml(file_config_path)
+        @to_h = YAML.safe_load(File.read(file_config_path), symbolize_names: true)
+      end
+
+      def init_from_json(file_config_path)
+        @to_h = JSON.parse(File.read(file_config_path), symbolize_names: true)
+      end
+
+      def make_config_domain
+        return if @to_h[:domains].nil?
+
+        @domains = @to_h[:domains].map do |h|
+          ClusterConfigDomain.new(h[:name], h[:key])
+        end
+      end
+
+      def find_domain(domain_name)
+        @domains.find { |d| d.name == domain_name }
+      end
+
+      def domain_key(domain_name)
+        domain = find_domain(domain_name)
+        return nil if domain.nil?
+
+        domain.key
+      end
+    end
+
+    # class config for connection
+    class ClusterConfigDomain
+      attr_reader :name, :key
+
+      def initialize(name, key)
+        @name = name
+        @key = key
+      end
+    end
+
+    # class error for config
+    class ClusterConfigError < StandardError
+    end
+  end
+end

data/lib/zm/client/cluster.rb

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

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # message content
+    class BodyMail
+      attr_accessor :text, :html
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+
+    # Collection recipients
+    class Recipients
+      def initialize
+        @recipients = []
+      end
+
+      def map(&block)
+        @recipients.map(&block)
+      end
+
+      def add(recipient)
+        return unless recipient.is_a?(Recipient)
+
+        @recipients.push(recipient)
+      end
+
+      def del(recipient)
+        if recipient.is_a?(Recipient)
+          @recipients.delete(recipient)
+        elsif recipient.is_a?(String)
+          @recipients.delete_if { |r| r.email == recipient }
+        end
+      end
+
+      def clear
+        @recipients.clear
+      end
+
+      def to
+        @recipients.select { |r| r.field == Recipient::TO }
+      end
+
+      def cc
+        @recipients.select { |r| r.field == Recipient::CC }
+      end
+
+      def bcc
+        @recipients.select { |r| r.field == Recipient::BCC }
+      end
+
+      def from
+        @recipients.select { |r| r.field == Recipient::FROM }
+      end
+    end
+
+    # Class one recipient for email
+    class Recipient
+      FROM = :f
+      TO = :t
+      CC = :c
+      BCC = :b
+
+      attr_accessor :field, :email, :display_name
+
+      def initialize(field, email, display_name = nil)
+        @email = email
+        @field = field.to_sym
+        @display_name = display_name
+      end
+    end
+  end
+end

data/lib/zm/client/common.rb

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

data/lib/zm/client/config.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # module de configuration du client Zm::Client
+    module Config
+      extend self
+
+      # TODO
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'curb'
+
+module Zm
+  module Client
+    class RestAccountConnector
+      attr_reader :verbose, :follow_location
+
+      def initialize
+        @verbose = false
+        @follow_location = true
+        @curl = easy_curl
+      end
+
+      def verbose!
+        @verbose = true
+        @curl.verbose = @verbose
+      end
+
+      def cookie(cookie)
+        @curl.headers['Cookie'] = cookie
+      end
+
+      def download(url, dest_file_path)
+        @curl.url = URI.escape(url)
+        File.open(dest_file_path, 'wb') do |f|
+          @curl.on_body do |data|
+            f << data
+            data.size
+          end
+          @curl.perform
+        end
+      end
+
+      def upload(url, src_file_path)
+        @curl.url = URI.escape(url)
+        @curl.http_post(Curl::PostField.file('file', src_file_path))
+
+        if @curl.status.to_i >= 400
+          messages = [
+            "Upload failure ! #{src_file_path}",
+            extract_title(@curl.body_str)
+          ].compact
+          raise RestError, messages.join("\n")
+        end
+
+        @curl.body_str
+      end
+
+      private
+
+      def easy_curl
+        Curl::Easy.new do |curl|
+          curl.timeout = 300
+          curl.enable_cookies = false
+          curl.encoding = ''
+          curl.ssl_verify_peer = false
+          curl.ssl_verify_host = 0
+          curl.multipart_form_post = true
+          curl.verbose = verbose
+          curl.follow_location = follow_location
+        end
+      end
+
+      def extract_title(str)
+        str.scan(%r{<title>(.*)</title>}).first.first
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end