clicksign-ruby-sdk 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d76bec5fed9c775d1277ef1d0cd7158a87f7234d71fcd2fc8933a4421c8dba1
-  data.tar.gz: d18db7bdcf3825e7d266ff30609f9034c0a8e2fbb3d7f82352ae1e4a0c7ef0dd
+  metadata.gz: a8730a44f32966cd0d6978150f4c5c5e821de5c168b94f4e69ced112cef211cc
+  data.tar.gz: afe6780086fe195e7559470d86674d83b8927c725e96213f1bb930a43808af54
 SHA512:
-  metadata.gz: d1f36573b8720bb2d5548540cabcb1b9d995b8cc6afb877e6b02844cef69a73af2708901c2f50dd43ca540db7f098c61077bfc9647a5e880928c361707da9069
-  data.tar.gz: d7b63661a2702eaaecfd59d65508964110965ed32a4dd26f273199951c7353f9761a8f5269389e8aec83044c3bc54562e458fa885180817f17b0ad19fec59b67
+  metadata.gz: c939a985f4caf49b47d15b2b6637550e20083cf217f077bf0d50c042946b693db885bb8ccad98abc1bfb48a7465d5ebc8ed9c47eef4aac8f32a078c9560fcb12
+  data.tar.gz: 80ee966ee546d6b401c7e427afa7bd7b881b64fb342e18e068469bb24f8b043220b1edc3d853bb3b348e1fac95c4e68284bf14a8a8ef1ac4325b25d176ce7f84

data/REVISION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/lib/clicksign/client.rb

@@ -14,7 +14,7 @@ module Clicksign
     }.freeze
 
     def initialize(api_key:, base_url:, open_timeout: 2, read_timeout: 10,
-      write_timeout: 10, max_retries: 0)
+      write_timeout: 10, max_retries: 3)
       @api_key       = api_key
       @base_url      = base_url
       @open_timeout  = open_timeout
@@ -42,6 +42,13 @@ module Clicksign
       execute_with_retry(request, uri)
     end
 
+    def put(path, body:)
+      uri = build_uri(path)
+      request = Net::HTTP::Put.new(uri, headers)
+      request.body = body.to_json
+      execute_with_retry(request, uri)
+    end
+
     def delete(path, body: nil)
       uri = build_uri(path)
       request = Net::HTTP::Delete.new(uri, headers)
@@ -70,7 +77,7 @@ module Clicksign
              Clicksign::ServerError => e
         raise unless e.retryable? && attempts <= @max_retries
 
-        delay = RetryBackoff.delay(attempts)
+        delay = RetryBackoff.retry_delay(attempts, e.response_headers)
         publish_retry(request, uri, attempts, e, delay)
         sleep(delay)
         retry

data/lib/clicksign/configuration.rb

@@ -15,7 +15,7 @@ module Clicksign
       @open_timeout  = 2
       @read_timeout  = 10
       @write_timeout = 10
-      @max_retries   = 0
+      @max_retries   = 3
     end
 
     def environment=(env)

data/lib/clicksign/error_handler.rb

@@ -50,7 +50,9 @@ module Clicksign
       errors = body['errors']
       return response.message unless errors.is_a?(Array)
 
-      result = errors.filter_map { |e| e['detail'] || e['title'] }.join(', ')
+      result = errors.filter_map do |e|
+        e.is_a?(Hash) && (e['detail'] || e['title'])
+      end.join(', ')
       result.empty? ? response.message : result
     end
   end

data/lib/clicksign/json_api/atomic_results_parser.rb

@@ -24,6 +24,7 @@ module Clicksign
       end
 
       def build_operation_result(slot:, index:, op:, envelope_id:)
+        slot ||= {}
         errors = slot['errors']
         requirement = build_requirement(slot['data'], envelope_id: envelope_id)
 
@@ -54,7 +55,7 @@ module Clicksign
       def format_errors(errors)
         return 'Validation failed' unless errors.is_a?(Array)
 
-        errors.filter_map { |e| e['detail'] || e['title'] }.join(', ')
+        errors.filter_map { |e| e.is_a?(Hash) && (e['detail'] || e['title']) }.join(', ')
       end
     end
   end

data/lib/clicksign/json_api/bulk_operations_client.rb

@@ -43,7 +43,8 @@ module Clicksign
         begin
           attempts += 1
           execute_once(request, uri, attempt: attempts)
-        rescue Clicksign::TimeoutError => e
+        rescue Clicksign::TimeoutError, Clicksign::RateLimitError,
+               Clicksign::ServerError => e
           raise unless e.retryable? && attempts <= @max_retries
 
           delay = RetryBackoff.delay(attempts)

data/lib/clicksign/json_api/parser.rb

@@ -10,7 +10,8 @@ module Clicksign
         data = case raw_data
                when Array then raw_data.map { |item| build(item) }
                when Hash  then [build(raw_data)]
-               else            []
+               when nil   then []
+               else raise Error, "Unexpected JSON:API data type: #{raw_data.class}"
                end
 
         included = Array(raw['included'])

data/lib/clicksign/resource.rb

@@ -232,7 +232,7 @@ module Clicksign
           return true
         end
 
-        items.size >= per
+        per.positive? && items.size >= per
       end
 
       def build_instance(data, parent_id: nil)

data/lib/clicksign/resources/folder.rb

@@ -15,7 +15,9 @@ module Clicksign
       end
 
       def child_folder_ids
-        Array(relationships.dig('folders', 'data')).filter_map { |d| d['id'] }
+        Array(relationships.dig('folders', 'data')).filter_map do |d|
+          d.is_a?(Hash) ? d['id'] : nil
+        end
       end
     end
   end

data/lib/clicksign/resources/membership.rb

@@ -13,6 +13,21 @@ module Clicksign
         )
       end
 
+      def update(**attributes)
+        raw = self.class.client.put(
+          "#{base_path}/#{@id}",
+          body: JsonApi::Serializer.dump(
+            type: self.class.resource_type, id: @id, attributes: attributes,
+          ),
+        )
+        parsed = JsonApi::Parser.parse(raw)
+        data   = parsed[:data].first
+        raise NotFoundError, 'API returned null data' if data.nil?
+
+        load_data(data, parent_id: @_parent_id)
+        self
+      end
+
       def user_id
         relationships.dig('user', 'data', 'id')
       end

data/lib/clicksign/resources/notarial/requirement.rb

@@ -42,6 +42,11 @@ module Clicksign
         end
         private_class_method :list_related
 
+        def update(**)
+          raise NotImplementedError,
+            'Requirement does not support update (API does not provide this endpoint)'
+        end
+
         def base_path
           eid = @_parent_id || envelope_id
           if eid.nil?

data/lib/clicksign/retry_backoff.rb

@@ -18,5 +18,22 @@ module Clicksign
 
       rng.rand(max)
     end
+
+    def parse_retry_after(headers)
+      return nil unless headers.is_a?(Hash)
+
+      raw = headers['retry-after'] || headers['Retry-After']
+      return nil if raw.nil? || raw.to_s.strip.empty?
+
+      Float(raw.to_s.strip)
+    rescue ArgumentError, TypeError
+      nil
+    end
+
+    def retry_delay(attempt, headers = nil, rng: Random)
+      jitter      = delay(attempt, rng: rng)
+      retry_after = parse_retry_after(headers)
+      retry_after ? [jitter, retry_after].max : jitter
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Clicksign