ding_sdk 0.11.58 → 0.11.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c80eb891584541334a3bf3bc6bae0786fe213990ff0e081a42d6d35eefdae1a
-  data.tar.gz: b5aeee51853065f002916f5ff6fa7195aa63be06d9108c3ebd85120e4ec3626b
+  metadata.gz: 425bc436b8c775332e5cae324e1e9f38a70a9f41c70cab02320ac13e638241cd
+  data.tar.gz: 6a007e2538a1f80c4af0278d11b1090761b8512132a3189aa1e1fc2f52b0eb4b
 SHA512:
-  metadata.gz: '08001a7cb7cd3949c68c97cefe76dd12282ba90e51594ecf6556ac3ec09bc310f943164f205af237e9c7bcb10607ea8c5465708b45e6bc2452e8f7bc83e1dce1'
-  data.tar.gz: 983476e0e3aeadaf197732b3c347b67749661e832a10c426b61bec5122ac5882886c9e55b89b062f7a276db66c0450860ff771c0594010264bb5d75722fa5d94
+  metadata.gz: 8cdd4b59a855a10cc2e7e73efd8715cc11ecd6c1a4a32bb347a09c77bde44bc68a62a41d79f38859d4bbb2aae8df37b3017e66196ba5943c7d51fc293cfa22f0
+  data.tar.gz: 4a26210faaf7d8217a5d516ebc9ab78afd98b92d6fd823bd4bb77bf97c4e9788dea7ac5890a9af0738f612d5c390dee8a4ee7c3efb92a7c557388710b138b92f

data/lib/ding_sdk/ding.rb

@@ -5,7 +5,9 @@
 
 require 'faraday'
 require 'faraday/multipart'
+require 'faraday/retry'
 require 'sorbet-runtime'
+require_relative 'utils/retries'
 
 module DingSDK
   extend T::Sig
@@ -17,7 +19,8 @@ module DingSDK
 
     sig do
       params(
-        client: T.nilable(Faraday::Request),
+        client: T.nilable(Faraday::Connection),
+        retry_config: T.nilable(::DingSDK::Utils::RetryConfig),
         security: T.nilable(::DingSDK::Shared::Security),
         security_source: T.nilable(T.proc.returns(::DingSDK::Shared::Security)),
         server_idx: T.nilable(Integer),
@@ -25,9 +28,10 @@ module DingSDK
         url_params: T.nilable(T::Hash[Symbol, String])
       ).void
     end
-    def initialize(client: nil, security: nil, security_source: nil, server_idx: nil, server_url: nil, url_params: nil)
+    def initialize(client: nil, retry_config: nil, security: nil, security_source: nil, server_idx: nil, server_url: nil, url_params: nil)
       ## Instantiates the SDK configuring it with the provided parameters.
-      # @param [T.nilable(Faraday::Request)] client The faraday HTTP client to use for all operations
+      # @param [T.nilable(Faraday::Connection)] client The faraday HTTP client to use for all operations
+      # @param [T.nilable(::DingSDK::Utils::RetryConfig)] retry_config The retry configuration to use for all operations
       # @param [T.nilable(::DingSDK::Shared::Security)] security: The security details required for authentication
       # @param [T.proc.returns(T.nilable(::DingSDK::Shared::Security))] security_source: A function that returns security details required for authentication
       # @param [T.nilable(::Integer)] server_idx The index of the server to use for all operations
@@ -52,6 +56,7 @@ module DingSDK
       server_idx = 0 if server_idx.nil?
       @sdk_configuration = SDKConfiguration.new(
         client,
+        retry_config,
         security,
         security_source,
         server_url,

data/lib/ding_sdk/lookup.rb

@@ -5,7 +5,9 @@
 
 require 'faraday'
 require 'faraday/multipart'
+require 'faraday/retry'
 require 'sorbet-runtime'
+require_relative 'utils/retries'
 
 module DingSDK
   extend T::Sig
@@ -41,7 +43,9 @@ module DingSDK
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.get(url) do |req|
+      connection = @sdk_configuration.client
+
+      r = connection.get(url) do |req|
         req.headers = headers
         req.params = query_params
         security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil

data/lib/ding_sdk/otp.rb

@@ -5,7 +5,9 @@
 
 require 'faraday'
 require 'faraday/multipart'
+require 'faraday/retry'
 require 'sorbet-runtime'
+require_relative 'utils/retries'
 
 module DingSDK
   extend T::Sig
@@ -31,7 +33,9 @@ module DingSDK
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.post(url) do |req|
+      connection = @sdk_configuration.client
+
+      r = connection.post(url) do |req|
         req.headers = headers
         security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
         Utils.configure_request_security(req, security) if !security.nil?
@@ -77,7 +81,9 @@ module DingSDK
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.post(url) do |req|
+      connection = @sdk_configuration.client
+
+      r = connection.post(url) do |req|
         req.headers = headers
         security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
         Utils.configure_request_security(req, security) if !security.nil?
@@ -123,7 +129,9 @@ module DingSDK
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.post(url) do |req|
+      connection = @sdk_configuration.client
+
+      r = connection.post(url) do |req|
         req.headers = headers
         security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
         Utils.configure_request_security(req, security) if !security.nil?
@@ -176,7 +184,9 @@ module DingSDK
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.get(url) do |req|
+      connection = @sdk_configuration.client
+
+      r = connection.get(url) do |req|
         req.headers = headers
         security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
         Utils.configure_request_security(req, security) if !security.nil?
@@ -215,7 +225,9 @@ module DingSDK
       headers['Accept'] = 'application/json'
       headers['user-agent'] = @sdk_configuration.user_agent
 
-      r = @sdk_configuration.client.post(url) do |req|
+      connection = @sdk_configuration.client
+
+      r = connection.post(url) do |req|
         req.headers = headers
         security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
         Utils.configure_request_security(req, security) if !security.nil?

data/lib/ding_sdk/sdkconfiguration.rb

@@ -5,7 +5,9 @@
 
 require 'faraday'
 require 'faraday/multipart'
+require 'faraday/retry'
 require 'sorbet-runtime'
+require_relative 'utils/retries'
 
 module DingSDK
   extend T::Sig
@@ -19,6 +21,7 @@ module DingSDK
     extend T::Sig
 
     field :client, T.nilable(Faraday::Connection)
+    field :retry_config, T.nilable(::DingSDK::Utils::RetryConfig)
     field :security_source, T.nilable(T.proc.returns(T.nilable(::DingSDK::Shared::Security)))
     field :server_url, T.nilable(String)
     field :server_idx, T.nilable(Integer)
@@ -28,11 +31,19 @@ module DingSDK
     field :gen_version, String
     field :user_agent, String
 
-
-
-    sig { params(client: T.nilable(Faraday::Connection), security: T.nilable(::DingSDK::Shared::Security), security_source: T.nilable(T.proc.returns(::DingSDK::Shared::Security)), server_url: T.nilable(String), server_idx: T.nilable(Integer)).void }
-    def initialize(client, security, security_source, server_url, server_idx)
+    sig do
+      params(
+        client: T.nilable(Faraday::Connection),
+        retry_config: T.nilable(::DingSDK::Utils::RetryConfig),
+        security: T.nilable(::DingSDK::Shared::Security),
+        security_source: T.nilable(T.proc.returns(::DingSDK::Shared::Security)),
+        server_url: T.nilable(String),
+        server_idx: T.nilable(Integer)
+      ).void
+    end
+    def initialize(client, retry_config, security, security_source, server_url, server_idx)
       @client = client
+      @retry_config = retry_config
       @server_url = server_url
       @server_idx = server_idx.nil? ? 0 : server_idx
       raise StandardError, "Invalid server index #{server_idx}" if @server_idx.negative? || @server_idx >= SERVERS.length
@@ -43,9 +54,9 @@ module DingSDK
       end
       @language = 'ruby'
       @openapi_doc_version = '1.0.0'
-      @sdk_version = '0.11.58'
-      @gen_version = '2.545.4'
-      @user_agent = 'speakeasy-sdk/ruby 0.11.58 2.545.4 1.0.0 ding_sdk'
+      @sdk_version = '0.11.60'
+      @gen_version = '2.548.1'
+      @user_agent = 'speakeasy-sdk/ruby 0.11.60 2.548.1 1.0.0 ding_sdk'
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

data/lib/ding_sdk/utils/retries.rb

@@ -0,0 +1,95 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday/retry'
+require 'sorbet-runtime'
+
+module DingSDK
+  module Utils
+    class BackoffStrategy
+      extend T::Sig
+
+      sig { returns(T.nilable(::Float)) }
+      attr_accessor :exponent
+
+      sig { returns(T.nilable(::Integer)) }
+      attr_accessor :initial_interval
+
+      sig { returns(T.nilable(::Integer)) }
+      attr_accessor :max_elapsed_time
+
+      sig { returns(T.nilable(::Integer)) }
+      attr_accessor :max_interval
+
+      sig do
+        params(
+          exponent: T.nilable(::Float),
+          initial_interval: T.nilable(::Integer),
+          max_elapsed_time: T.nilable(::Integer),
+          max_interval: T.nilable(::Integer)
+        ).void
+      end
+      def initialize(exponent: nil, initial_interval: nil, max_elapsed_time: nil, max_interval: nil)
+        @exponent = T.let(exponent, T.nilable(::Float))
+        @initial_interval = T.let(initial_interval, T.nilable(::Integer))
+        @max_elapsed_time = T.let(max_elapsed_time, T.nilable(::Integer))
+        @max_interval = T.let(max_interval, T.nilable(::Integer))
+      end
+    end
+
+    class RetryConfig
+      extend T::Sig
+
+      sig { returns(T.nilable(BackoffStrategy)) }
+      attr_accessor :backoff
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :retry_connection_errors
+
+      sig { returns(T.nilable(::String)) }
+      attr_accessor :strategy
+
+      sig do
+        params(
+          backoff: T.nilable(BackoffStrategy),
+          retry_connection_errors: T.nilable(T::Boolean),
+          strategy: T.nilable(::String)
+        ).void
+      end
+      def initialize(backoff: nil, retry_connection_errors: nil, strategy: nil)
+        @backoff = T.let(backoff, T.nilable(BackoffStrategy))
+        @retry_connection_errors = T.let(retry_connection_errors, T.nilable(T::Boolean))
+        @strategy = T.let(strategy, T.nilable(::String))
+      end
+
+      sig { params(initial_time: ::Time).returns(::Hash) }
+      def to_faraday_retry_options(initial_time:)
+        retry_options = {
+          # must overwrite default max of 2 retries and it must be positive
+          max: 1_000_000_000,
+          # ensure all HTTP methods are retried, especially via retry_if
+          methods: [],
+        }
+
+        if @retry_connection_errors
+          retry_options[:exceptions] = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
+        end
+
+        if @strategy == 'backoff' && @backoff
+          retry_options[:backoff_factor] = @backoff.exponent unless @backoff.exponent.nil?
+          retry_options[:interval] = (@backoff.initial_interval.to_f / 1000) unless @backoff.initial_interval.nil?
+          retry_options[:max_interval] = @backoff.max_interval unless @backoff.max_interval.nil?
+
+          unless @backoff.max_elapsed_time.nil?
+            stop_time = initial_time + (@backoff.max_elapsed_time.to_f / 1000)
+            retry_options[:retry_if] = ->(_env, _exc) { Time.now < stop_time }
+          end
+        end
+
+        retry_options
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ding_sdk
 version: !ruby/object:Gem::Version
-  version: 0.11.58
+  version: 0.11.60
 platform: ruby
 authors:
 - Ding
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.2
+        version: 1.73.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.73.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.2
+        version: 0.37.1
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +225,7 @@ files:
 - lib/ding_sdk/models/shared/status.rb
 - lib/ding_sdk/otp.rb
 - lib/ding_sdk/sdkconfiguration.rb
+- lib/ding_sdk/utils/retries.rb
 - lib/ding_sdk/utils/utils.rb
 homepage: https://github.com/ding-live/ding-ruby.git
 licenses: