zm-ruby-client 0.14.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 495fd8546a12d2a1fe034da87a2db380ea307cbbad2caf5f676bc88b2f8711be
-  data.tar.gz: cf02068191fca2875bb65c3d63e462db89f2819984be18b05f29b76a8a2070f9
+  metadata.gz: 4de72020fc5b06ed81e86eec0c27f10fbbd9d09de6f65d3299f8ed467cb5058f
+  data.tar.gz: fcc142156bdc55b58c33c66433bf7ca278ff396381514f646b74b6101b26115d
 SHA512:
-  metadata.gz: 90a577b5df0dd69cbf9a5ef8d39f30765a17a7bed17b7e624b3ac007f172fbfca76b6e1d175e17ff2ae1baa081755bff2ac58cd2e8b463d14921ec196fa0f2c8
-  data.tar.gz: 350398aeff49637ae3d6c203f2ed73ae7f5dfa3cb2cf296e75913f20037a18f6132c1083786e5dccb5d83fd519d98e01374819b1262e9baf1d3ffb5456a2213e
+  metadata.gz: 2df2ca3bdcc7ee18ebcb865e34d5a8335e2da2eff4191c83261d20ced0510f8434081f0b33ea186af791e81c56ded88b084375eed245277810cc6157282e9ce4
+  data.tar.gz: dfaa387e98fc19098640927f85d4318119d9c198c8d9e95a991c3d90fe13d1fea0524e26b2fabec1c2d6ac9d25f7dc06f5a9d7fb4105fdf280206584a62e9ae4

data/.gitignore

@@ -12,6 +12,7 @@
 /test/fixtures/
 /test/version_tmp/
 /tmp/
+/demo/
 /.idea
 /zm-ruby-client.iml
 

data/Gemfile

@@ -6,3 +6,4 @@ gem 'addressable', '~> 2.6'
 gem 'curb', '~> 0.9.8'
 gem 'nokogiri', '~>1.10.1'
 gem 'gyoku', '~>1.3.1'
+gem 'version_sorter'

data/README.md

@@ -2,6 +2,12 @@
 
 Library to interface with Zimbra simply.
 
+## Installation
+
+```bash
+sudo apt install make gcc curl libcurl4-openssl-dev
+```
+
 ## Examples of uses:
 
 ### Connection:

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

@@ -25,27 +25,28 @@ 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
+      # attr_reader :name, :id, :token
+      # attr_writer :home_url
+      # attr_accessor :password, :domainkey, :company, :zimbraCOSId, :zimbraMailHost, :zimbraMailTransport, :carLicense
+      attr_accessor :name, :id, :token, :home_url, :password, :domainkey, :carLicense
 
-      def initialize(parent, attrs = {})
-        extend(AccountCommon)
+      def initialize(parent)
+        # 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 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 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
@@ -99,7 +100,7 @@ module Zm
       end
 
       def domain_name
-        @name.split('@').last
+        @domain_name ||= @name.split('@').last
       end
 
       def domain_key
@@ -107,7 +108,7 @@ module Zm
       end
 
       def infos
-        @infos ||= read_infos
+        @infos || read_infos
       end
 
       def read_infos
@@ -117,6 +118,7 @@ module Zm
         @public_url = @infos[:publicURL]
         @zimbraCOSId = @infos[:cos][:id]
         @home_url = @infos[:rest]
+        @infos
       end
 
       def cos
@@ -253,6 +255,12 @@ module Zm
         @id = rep[:Body][:CreateAccountResponse][:account].first[:id]
       end
 
+      def set_password(new_password = nil)
+        new_password ||= @password
+        sac.set_password(@id, new_password)
+        @password = new_password
+      end
+
       def aliases
         @aliases ||= set_aliases
       end
@@ -335,6 +343,10 @@ module Zm
         @dls_owner ||= AccountDlsOwnerCollection.new(self)
       end
 
+      def ranking(op, email = nil)
+        sacc.ranking_action(@token, op, email)
+      end
+
       def init_from_json(json)
         @used = json[:used] if json[:used]
         @zimbraMailQuota = json[:limit] if json[:limit]

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for initialize account
+    class AccountJsnsInitializer
+      class << self
+        def create(parent, json)
+          item = Account.new(parent)
+
+          update(item, json)
+        end
+
+        def update(item, json)
+
+          attr_types_h = item.parent.zimbra_attributes.all_account_attr_types_h
+
+          # puts attr_types_h
+
+          item.id    = json[:id]
+          item.name  = json[:name]
+
+          json[:a].reject! { |n| n[:n].nil? }
+          json_map = Hash[json[:a].map { |n| [n[:n], n[:_content]] }].freeze
+
+          # puts json_map
+
+          # item.parent.zimbra_attributes.all_account_attrs.each do |attr|
+          #   if attr.type.nil?
+          #     # p attr
+          #   else
+          #     json_field = json_map[attr.name]
+          #     puts json_field unless json_field.nil?
+          #   end
+          # end
+
+          item.init_from_json(json)
+
+          item
+        end
+      end
+    end
+  end
+end

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

@@ -7,12 +7,15 @@ module Zm
       def initialize(parent, json)
         super(parent, json)
         @child_class = Account
+        @json_item_key = :account
       end
 
-      private
+      def make
+        return [] if json_items.nil?
 
-      def json_items
-        @json_items ||= @json[:Body][json_key][:account]
+        json_items.map do |entry|
+          AccountJsnsInitializer.create(@parent, entry)
+        end
       end
     end
   end

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

@@ -3,45 +3,36 @@
 module Zm
   module Client
     # Collection Accounts
-    class AccountsCollection < Base::ObjectsCollection
+    class AccountsCollection < Base::AdminObjectsCollection
       def initialize(parent)
         @child_class = Account
-        @parent = parent
-        reset_query_params
-      end
-
-      def ldap
-        @apply_cos = 0
-        self
+        @builder_class = AccountsBuilder
+        @search_type = SearchType::ACCOUNT
+        super(parent)
       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
+        # puts entry
 
+        reset_query_params
         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)
+      def quotas
+        return nil if @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
+        @builder_class.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

data/lib/zm/client/account.rb

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

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

@@ -9,23 +9,36 @@ module Zm
 
       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
+      def all_instance_variable_keys
+        INSTANCE_VARIABLE_KEYS
       end
 
       def create!
-        # todo
+        rep = @parent.sacc.grant_rights(get_token, jsns_builder.to_jsns)
+        json = rep[:Body][:GrantRightsResponse][:ace].first if rep[:Body][:GrantRightsResponse][:ace].is_a?(Array)
+        AceJsnsInitializer.update(self, json) unless json.nil?
+        true
       end
 
       def delete!
-        # todo
+        @parent.sacc.revoke_rights(get_token, jsns_builder.to_delete)
+        @parent.all.delete(self)
+        true
       end
 
-      def rename!(new_name)
-        # todo
+      private
+
+      def jsns_builder
+        @jsns_builder ||= AceJsnsBuilder.new(self)
+      end
+
+      def get_token(target = self)
+        token = nil
+        return target.token if target.respond_to?(:token) && !target.token.nil?
+
+        token = get_token(target.parent) if target.respond_to?(:parent)
+
+        token
       end
     end
   end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for account folder jsns builder
+    class AceJsnsBuilder < Base::BaseJsnsBuilder
+
+      def to_find
+        return nil if @item.rights.empty?
+
+        ace = @item.rights.map { |r| { right: r } }
+        { ace: ace }
+      end
+
+      def to_jsns
+        ace = {
+          zid: @item.zid,
+          gt: @item.gt,
+          right: @item.right,
+          d: @item.d
+        }.reject { |_, v| v.nil? }
+
+        { ace: ace }
+      end
+
+      def to_delete
+        ace = {
+          zid: @item.zid,
+          gt: @item.gt,
+          right: @item.right,
+          d: @item.d
+        }.reject { |_, v| v.nil? }
+
+        { ace: ace }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zm
+  module Client
+    # class for initialize account ace
+    class AceJsnsInitializer
+      class << self
+        def create(parent, json)
+          item = Ace.new(parent)
+
+          update(item, json)
+        end
+
+        def update(item, json)
+
+          item.instance_variable_set(:@zid, json[:zid])
+          item.instance_variable_set(:@gt, json[:gt])
+          item.instance_variable_set(:@right, json[:right])
+          item.instance_variable_set(:@d, json[:d])
+
+          item
+        end
+      end
+    end
+  end
+end

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

@@ -5,19 +5,16 @@ module Zm
     # class factory [aces]
     class AcesBuilder < Base::ObjectsBuilder
       def initialize(parent, json)
-        @parent = parent
-        @json = json
+        super(parent, json)
+        @child_class = Ace
+        @json_item_key = :ace
       end
 
       def make
-        root = @json[:Body][:GetRightsResponse][:ace]
-        return [] if root.nil?
+        return [] if json_items.nil?
 
-        root = [root] unless root.is_a?(Array)
-        root.map do |s|
-          ace = Ace.new(@parent)
-          ace.init_from_json(s)
-          ace
+        json_items.map do |entry|
+          AceJsnsInitializer.create(@parent, entry)
         end
       end
     end

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

@@ -3,33 +3,47 @@
 module Zm
   module Client
     # collection account aces
-    class AcesCollection < Base::ObjectsCollection
+    class AcesCollection < Base::AccountObjectsCollection
+      attr_reader :rights
+
       def initialize(parent)
-        @parent = parent
+        super(parent)
+        @builder_class = AcesBuilder
+        @jsns_builder = AceJsnsBuilder.new(self)
         reset_query_params
       end
 
       def new
-        ace = Ace.new(@parent)
+        ace = Ace.new(self)
         yield(ace) if block_given?
         ace
       end
 
-      def rights(*rights)
-        @rights = rights
+      def where(*rights)
+        @rights += rights
+        @rights.uniq!
         self
       end
 
+      def soap_account_connector
+        @parent.soap_account_connector
+      end
+
+      alias sacc soap_account_connector
+
       private
 
+      def make_query
+        @parent.sacc.get_rights(@parent.token, @jsns_builder.to_find)
+      end
+
       def build_response
-        rep = @parent.sacc.get_rights(@parent.token, @rights)
-        ab = AcesBuilder.new @parent, rep
-        ab.make
+        @builder_class.new(self, make_query).make
       end
 
       def reset_query_params
-        @rights = %i[sendAs sendOnBehalfOf]
+        # @rights = %i[sendAs sendOnBehalfOf]
+        @rights = []
       end
     end
   end

data/lib/zm/client/ace.rb

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

data/lib/zm/client/appointment/appointment.rb

@@ -15,7 +15,6 @@ module Zm
       alias description desc
       alias parent_id l
 
-      # def initialize(parent, json = nil)
       def initialize(parent)
         @parent = parent
         @recipients = Recipients.new
@@ -26,8 +25,8 @@ module Zm
         yield(self) if block_given?
       end
 
-      def concat
-        INSTANCE_VARIABLE_KEYS.map { |key| instance_variable_get(arrow_name(key)) }
+      def all_instance_variable_keys
+        INSTANCE_VARIABLE_KEYS
       end
 
       def folder
@@ -41,7 +40,6 @@ module Zm
       end
 
       def create!
-        jsns_builder = AppointmentJsnsBuilder.new(self)
         rep = @parent.sacc.create_appointment(@parent.token, jsns_builder.to_jsns)
         rep_h = rep[:Body][:CreateAppointmentResponse]
 
@@ -51,7 +49,6 @@ module Zm
       end
 
       def modify!
-        jsns_builder = AppointmentJsnsBuilder.new(self)
         @parent.sacc.modify_appointment(@parent.token, jsns_builder.to_update)
       end
 
@@ -64,8 +61,8 @@ module Zm
       end
 
       def delete!
-        jsns_builder = AppointmentJsnsBuilder.new(self)
         @parent.sacc.cancel_appointment(@parent.token, jsns_builder.to_delete)
+        super
       end
 
       def free!
@@ -138,6 +135,12 @@ module Zm
           @rsvp = rsvp
         end
       end
+
+      private
+
+      def jsns_builder
+        @jsns_builder ||= AppointmentJsnsBuilder.new(self)
+      end
     end
   end
 end

data/lib/zm/client/appointment/appointments_collection.rb

@@ -3,13 +3,13 @@
 module Zm
   module Client
     # collection of appointments
-    class AppointmentsCollection < Base::ObjectsCollection
-      attr_accessor :more
-
+    class AppointmentsCollection < Base::AccountSearchObjectsCollection
       def initialize(parent)
-        @parent = parent
-        @more = true
-        reset_query_params
+        super(parent)
+        @child_class = Appointment
+        @builder_class = AppointmentsBuilder
+        @type = 'appointment'
+        @sort_by = 'dateAsc'
       end
 
       def find(id)
@@ -17,90 +17,6 @@ module Zm
         entry = rep[:Body][:GetMsgResponse][:m].first
         AppointmentJsnsInitializer.new(@parent, entry).create
       end
-
-      def new
-        appointment = Appointment.new(@parent)
-        yield(appointment) if block_given?
-        appointment
-      end
-
-      def start_at(start_at)
-        @start_at = start_at
-        self
-      end
-
-      def end_at(end_at)
-        @end_at = end_at
-        self
-      end
-
-      def folders(folders)
-        @folders = folders
-        @folder_ids = @folders.map(&:id)
-        self
-      end
-
-      def folder_ids(folder_ids)
-        @folder_ids = folder_ids
-        self
-      end
-
-      def where(query)
-        @query = query
-        self
-      end
-
-      def ids
-        search_builder.ids
-      end
-
-      private
-
-      def search_response
-        rep = @parent.sacc.search(@parent.token, 'appointment', @offset, @limit, 'dateAsc', query, build_options)
-        @more = rep[:Body][:SearchResponse][:more]
-        rep
-      end
-
-      def search_builder
-        AppointmentsBuilder.new(@parent, search_response)
-      end
-
-      def build_response
-        appointments = search_builder.make
-        appointments.each { |appo| appo.folder = find_folder(appo) } unless @folders.empty?
-        appointments
-      end
-
-      def build_options
-        return {} if !@start_at.is_a?(Time) && !@end_at.is_a?(Time)
-
-        {
-          calExpandInstStart: (@start_at.to_f * 1000).to_i,
-          calExpandInstEnd: (@end_at.to_f * 1000).to_i,
-        }
-      end
-
-      def query
-        return @query unless @query.nil?
-
-        return nil if @folder_ids.empty?
-
-        @folder_ids.map { |id| %Q{inid:"#{id}"} }.join(' OR ')
-      end
-
-      def find_folder(appointment)
-        @folders.find { |folder| folder.id == appointment.l }
-      end
-
-      def reset_query_params
-        super
-        @start_at = nil
-        @end_at = nil
-        @query = nil
-        @folder_ids = []
-        @folders = []
-      end
     end
   end
 end

data/lib/zm/client/backup/backup.rb

@@ -13,12 +13,16 @@ module Zm
         parent
       end
 
-      def to_h
-        hashmap = Hash[INSTANCE_VARIABLE_KEYS.map { |key| [key, instance_variable_get(arrow_name(key))] }]
-        hashmap.delete_if { |_, v| v.nil? }
-        hashmap
+      def all_instance_variable_keys
+        INSTANCE_VARIABLE_KEYS
       end
 
+      # def to_h
+      #   hashmap = Hash[INSTANCE_VARIABLE_KEYS.map { |key| [key, instance_variable_get(arrow_name(key))] }]
+      #   hashmap.delete_if { |_, v| v.nil? }
+      #   hashmap
+      # end
+
       def to_s
         to_h.to_s
       end