zm-ruby-client 2.0.6 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13a8f6a25daf14d60d491a527f7b9b71920afe9e5df79cbb60bceeacdbdcd606
-  data.tar.gz: f3e41e0e600c97ab87a0198bb69e305ba7e12e07d9235ae57ff2e5f6d8457e21
+  metadata.gz: b7e939168149edeb472b2e33930cfbbe97a45d8bd7012a1200df9dfe7c635f47
+  data.tar.gz: 7508c98743481ad485843e3a611efe75d6d5328107e546fbbcabc7ab8fab29ce
 SHA512:
-  metadata.gz: 38457fc1f124a1970240edbe7ee900ba02b1c9a864306c03335318eff0c106b27a16cf6598bcc3b1f931904eff7f6de31834f125a69a4177cba07aef86ca6ea7
-  data.tar.gz: 2d4491d26f0c59c8b2bc36c9f7f1ac183a3d00b06abf749005442dd67ef5fa17674f1fcd36a7bb4ae23c73a23a157f1f3a063427b938ddc7a9decda724967653
+  metadata.gz: 03ab31a3733a6add8cb01b88297536dcf6203cc29ec875e27cc0914b00357d993d0195597d0fa188c2bddc6e78835358d453538e8e5535e192d69d9d61fb929c
+  data.tar.gz: 22f3dbc7e82d70c4fc8311f36d181e0056d8c2c748a68c730c771053381b792e36802e878612a68d4b03150a50998f639b9c4027890a5453c06169809c2f0099

data/Gemfile

@@ -3,5 +3,6 @@ source 'https://rubygems.org'
 ruby ">= 2.7"
 
 gem 'addressable', '~> 2.8'
-gem 'curb', '~> 1.0'
-gem 'version_sorter', '~> 2.3'
+gem 'faraday'
+gem 'faraday-multipart'
+gem 'version_sorter', '~> 2.3'

data/README.md

@@ -11,7 +11,6 @@ OS: Linux distribution LTS
 Language: Ruby2.7+
 
 ```bash
-sudo apt install make gcc curl libcurl4-openssl-dev
 gem install zm-ruby-client
 ```
 

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

@@ -45,7 +45,7 @@ module Zm
         end
 
         def is_calendarResource_scoped?
-          @is_calendarResource_scoped ||= objects_scope.include?('calendarResource')
+          @is_calendarResource_scoped ||= objects_scope.include?('calendarResource') || objects_scope.include?('account')
         end
 
         def is_cos_scoped?

data/lib/zm/client/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'curb'
+require 'faraday'
 require 'logger'
 require 'openssl'
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'faraday/multipart'
+
 module Zm
   module Client
     class RestAccountConnector
@@ -7,8 +9,15 @@ module Zm
 
       def initialize
         @verbose = false
+        @timeout = 300
+
+        @ssl_options = {
+          verify: false,
+          verify_hostname: false,
+          verify_mode: OpenSSL::SSL::VERIFY_NONE
+        }
+
         @cookies = nil
-        @follow_location = true
       end
 
       def verbose!
@@ -19,69 +28,75 @@ module Zm
         @cookies = cookies
       end
 
-      def download(url, dest_file_path)
-        curl = init_curl_client(url)
+      def download(download_url, dest_file_path)
+        url, path = split_url(download_url)
+
+        conn = Faraday.new(**http_options(url)) do |faraday|
+          faraday.response :logger, nil, { headers: true, bodies: true, errors: true } if @verbose
+        end
+
+        response = nil
 
         File.open(dest_file_path, 'wb') do |f|
-          curl.on_body do |data|
-            f << data
-            data.size
+          response = conn.get(path) do |request|
+            request.options.on_data = Proc.new do |chunk, _, _|
+              f.write chunk
+            end
           end
-
-          curl.perform
         end
 
-        if curl.status.to_i >= 400
+        if response.status >= 400
           File.unlink(dest_file_path) if File.exist?(dest_file_path)
-
-          message = "Download failure: #{curl.body_str} (status=#{curl.status})"
-          close_curl(curl)
-          raise RestError, message
+          raise RestError, "Download failure: #{response.body} (status=#{response.status})"
         end
-
-        dest_file_path
       end
 
-      def upload(url, src_file_path)
-        curl = init_curl_client(url)
+      def upload(upload_url, src_file_path)
+        url, path = split_url(upload_url)
+
+        conn = Faraday.new(**http_options(url)) do |faraday|
+          faraday.request :multipart
+          faraday.response :logger, nil, { headers: true, bodies: true, errors: true } if @verbose
+        end
 
-        curl.http_post(Curl::PostField.file('file', src_file_path))
+        payload = { file: Faraday::Multipart::FilePart.new(src_file_path, nil) }
+        response = conn.post(path, payload)
 
-        if curl.status.to_i >= 400
+        if response.status >= 400
           messages = [
             "Upload failure ! #{src_file_path}",
-            extract_title(curl.body_str)
+            extract_title(response.body)
           ].compact
-          close_curl(curl)
+
           raise RestError, messages.join("\n")
         end
 
-        str = curl.body_str
-        close_curl(curl)
-        str
+        response.body
       end
 
       private
 
-      def close_curl(curl)
-        curl.close
-        # force process to kill socket
-        GC.start
+      def split_url(url)
+        uri = URI(url)
+        url = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+        path = [uri.path, uri.query].join('?')
+
+        [url, path]
       end
 
-      def init_curl_client(url)
-        ::Curl::Easy.new(url) 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
-          curl.verbose = @verbose
-          curl.cookies = @cookies
-        end
+      def headers
+        { 'Cookie' => @cookies, 'User-Agent' => 'ZmRubyClient' }
+      end
+
+      def http_options(url)
+        {
+          url: url,
+          headers: headers,
+          request: {
+            timeout: @timeout
+          },
+          ssl: @ssl_options
+        }
       end
 
       def extract_title(str)

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

@@ -2,7 +2,6 @@
 
 require 'json'
 require 'openssl'
-require 'curb'
 require 'uri'
 
 require_relative 'soap_error'
@@ -14,14 +13,24 @@ module Zm
 
       BASESPACE = 'urn:zimbra'
       HTTP_HEADERS = {
-        'Content-Type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json; charset=utf-8',
+        'User-Agent' => 'ZmRubyClient'
       }.freeze
 
       attr_reader :context
 
       def initialize(scheme, host, port, soap_path)
         @verbose = false
-        @uri = URI::HTTP.new(scheme, nil, host, port, nil, soap_path, nil, nil, nil)
+        @timeout = 300
+
+        @ssl_options = {
+          verify: false,
+          verify_hostname: false,
+          verify_mode: OpenSSL::SSL::VERIFY_NONE
+        }
+
+        @soap_path = soap_path
+        @uri = URI::HTTP.new(scheme, nil, host, port, nil, nil, nil, nil, nil)
         @context = SoapContext.new
       end
 
@@ -30,7 +39,7 @@ module Zm
       end
 
       def invoke(soap_element, error_handler = SoapError)
-        curl_request(envelope(soap_element), error_handler)[:Body]
+        do_request(envelope(soap_element), error_handler)[:Body]
       end
 
       def target_invoke(soap_element, target_id, error_handler = SoapError)
@@ -40,45 +49,38 @@ module Zm
         resp
       end
 
-      private
-
-      def init_curl_client
-        ::Curl::Easy.new(@uri.to_s) do |curl|
-          curl.timeout = 300
-          curl.enable_cookies = false
-          curl.encoding = ''
-          curl.headers = HTTP_HEADERS
-          curl.ssl_verify_peer = false
-          curl.ssl_verify_host = 0
-          curl.verbose = @verbose
+      def http_client!
+        @http_client = Faraday.new(
+          url: @uri.to_s,
+          headers: HTTP_HEADERS,
+          request: {
+            timeout: @timeout
+          },
+          ssl: @ssl_options
+        ) do |faraday|
+          faraday.request :json
+          faraday.response :logger, nil, { headers: true, bodies: true, errors: true } if @verbose
         end
       end
 
-      def curl_request(body, error_handler = SoapError)
-        curl = init_curl_client
-        logger.debug body.to_json
-        curl.http_post(body.to_json)
+      private
 
-        logger.debug curl.body_str
+      def http_client
+        @http_client || http_client!
+      end
+
+      def do_request(body, error_handler = SoapError)
+        response = http_client.post(@soap_path, body)
 
-        soapbody = JSON.parse(curl.body_str, symbolize_names: true)
+        soapbody = JSON.parse(response.body, symbolize_names: true)
 
-        if curl.status.to_i >= 400
-          close_curl(curl)
+        if response.status >= 400
           raise(error_handler, soapbody)
         end
 
-        close_curl(curl)
-
         soapbody
       end
 
-      def close_curl(curl)
-        curl.close
-        # force process to kill socket
-        GC.start
-      end
-
       def envelope(soap_element)
         {
           Body: soap_element.to_hash,

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

@@ -13,8 +13,6 @@ module Zm
                     :grants, :retention_policies,
                     :name, :color, :rgb, :l, :url, :f, :view
 
-      # define_changed_attributes :name, :color, :rgb, :l, :url, :f, :view
-
       alias nb_messages n
       alias nb_items n
       alias size s
@@ -29,8 +27,6 @@ module Zm
         @retention_policies = FolderRetentionPoliciesCollection.new(self)
 
         yield(self) if block_given?
-
-        extend(DocumentFolder) if view == Zm::Client::FolderView::DOCUMENT
       end
 
       def is_immutable?
@@ -66,7 +62,6 @@ module Zm
       end
 
       def color!
-        # @parent.sacc.invoke(jsns_builder.to_color) if color_changed? || rgb_changed?
         @parent.sacc.invoke(jsns_builder.to_color)
 
         true

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

@@ -58,6 +58,8 @@ module Zm
             end
           end
 
+          item.extend(DocumentFolder) if item.view == Zm::Client::FolderView::DOCUMENT
+
           item
         end
       end

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

@@ -11,11 +11,11 @@ module DocumentFolder
 
     raise Zm::Client::RestError, 'failed to extract uuid' if uuid.nil?
 
-    jsns = { doc: { l: l, pload: { id: uuid } } }
+    jsns = { doc: { l: @id, upload: { id: uuid } } }
 
-    soap_request = SoapElement.mail(SoapMailConstants::SAVE_DOCUMENT_REQUEST).add_attributes(jsns)
+    soap_request = Zm::Client::SoapElement.mail(Zm::Client::SoapMailConstants::SAVE_DOCUMENT_REQUEST).add_attributes(jsns)
     rep = @parent.sacc.invoke(soap_request)
 
-    DocumentJsnsInitializer.create(@parent, rep[:SaveDocumentResponse][:doc].first)
+    Zm::Client::DocumentJsnsInitializer.create(@parent, rep[:SaveDocumentResponse][:doc].first)
   end
 end

data/lib/zm/client/version.rb

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