seam 2.137.0 → 2.139.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 127b82c7a575d44523d96d4f7abeb7f6e2c08a0ef31f0578fe1e215a197cbbd5
-  data.tar.gz: b7f55dea5261cbb03284de35dd1a1905db3f7caeacf31d64a25082882b5a1349
+  metadata.gz: 2b94008b86b31b1f480fc2c3276075bc61d83a74dd09ea0af2b7831f39e603c3
+  data.tar.gz: 1f4a039c2309d9b31c82cb9c295c09fb925161150f64eede25fcad60e35c89c0
 SHA512:
-  metadata.gz: 33585716bb7d6d70c7936e5abd084414574eb9204a0ad728b57e94790972b5cc4a552ba145cf95c43d718eaae3febafd6ca3c52ebae88eba889f516e8d2af489
-  data.tar.gz: 153856dcd1afc01426ca4a6f00951c3231ae265963c1978c6ec5017d7b9e3a61269e91621f3d46ff01a50257422a8ec95d73a85d9739c6a8c82a93af0d13c50f
+  metadata.gz: c23cbe8e1da6b13568c3cdb1676d7e19c68068aaa99b651ae1915ce4ec04eb776def06af72e3b592381e200e9dd85dbc20e7d568ebe60ea5092e17b27151b67c
+  data.tar.gz: 23f38b1e3c55349694570c17aa70a1d3e6696336d04ec0506ba4758360fdc2a651f9229263efb2c5168f95903f3525c85163ebb1b92de1856f18775e30d830df

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.137.0)
+    seam (2.139.0)
       faraday (~> 2.7)
       faraday-retry (~> 2.2)
       svix (~> 1.30)

data/README.md

@@ -39,6 +39,7 @@ accurate and fully typed.
     - [Additional Options](#additional-options)
     - [Setting the endpoint](#setting-the-endpoint)
     - [Setting the request timeout](#setting-the-request-timeout)
+    - [Retry behavior](#retry-behavior)
     - [Configuring the Faraday Client](#configuring-the-faraday-client)
     - [Using the Faraday Client](#using-the-faraday-client)
     - [Overriding the Client](#overriding-the-client)
@@ -443,6 +444,17 @@ seam = Seam.new(
 
 A request that exceeds the timeout raises `Faraday::TimeoutError`.
 
+#### Retry behavior
+
+By default, the SDK makes up to three attempts: the initial request and two
+retries. Retries are limited to `GET`, `HEAD`, `OPTIONS`, `PUT`, and `DELETE`
+requests that fail because of a transport error, timeout, HTTP 429 response, or
+HTTP 5xx response. `POST` and `PATCH` requests are not retried.
+
+Retries use exponential backoff with jitter: approximately 200–240 ms before
+the first retry and 400–480 ms before the second. A longer `Retry-After` header
+is honored. The request timeout is reset for each attempt.
+
 #### Configuring the Faraday Client
 
 The Faraday client and retry behavior may be configured with custom initiation options

data/lib/seam/http_single_workspace.rb

@@ -16,13 +16,45 @@ module Seam
 
       attr_reader :client, :defaults
 
-      def initialize(client: nil, api_key: nil, personal_access_token: nil, workspace_id: nil, endpoint: nil,
-        wait_for_action_attempt: true, timeout: nil, faraday_options: {}, faraday_retry_options: {})
+      OPTION_NOT_PROVIDED = Object.new.freeze
+      private_constant :OPTION_NOT_PROVIDED
+
+      def initialize(client: nil, api_key: OPTION_NOT_PROVIDED, personal_access_token: OPTION_NOT_PROVIDED,
+        workspace_id: OPTION_NOT_PROVIDED, endpoint: OPTION_NOT_PROVIDED,
+        wait_for_action_attempt: OPTION_NOT_PROVIDED, timeout: OPTION_NOT_PROVIDED,
+        faraday_options: OPTION_NOT_PROVIDED, faraday_retry_options: OPTION_NOT_PROVIDED)
+        supplied_options = {
+          api_key: api_key,
+          personal_access_token: personal_access_token,
+          workspace_id: workspace_id,
+          endpoint: endpoint,
+          wait_for_action_attempt: wait_for_action_attempt,
+          timeout: timeout,
+          faraday_options: faraday_options,
+          faraday_retry_options: faraday_retry_options
+        }.reject { |_, value| value.equal?(OPTION_NOT_PROVIDED) }
+        invalid_options = supplied_options.keys - [:wait_for_action_attempt]
+
+        if client && invalid_options.any?
+          raise Http::Options::SeamInvalidOptionsError.new(
+            "The client option cannot be used with any other option, but received: #{supplied_options.keys.join(", ")}"
+          )
+        end
+
+        wait_for_action_attempt = true if wait_for_action_attempt.equal?(OPTION_NOT_PROVIDED)
         @defaults = Seam::DeepHashAccessor.new({"wait_for_action_attempt" => wait_for_action_attempt})
 
         # A client carries its own endpoint and authorization, so the auth
         # options are only parsed when one has to be built.
         @client = client || begin
+          api_key = nil if api_key.equal?(OPTION_NOT_PROVIDED)
+          personal_access_token = nil if personal_access_token.equal?(OPTION_NOT_PROVIDED)
+          workspace_id = nil if workspace_id.equal?(OPTION_NOT_PROVIDED)
+          endpoint = nil if endpoint.equal?(OPTION_NOT_PROVIDED)
+          timeout = nil if timeout.equal?(OPTION_NOT_PROVIDED)
+          faraday_options = {} if faraday_options.equal?(OPTION_NOT_PROVIDED)
+          faraday_retry_options = {} if faraday_retry_options.equal?(OPTION_NOT_PROVIDED)
+
           options = Http::Options.parse_options(api_key: api_key, personal_access_token: personal_access_token,
             workspace_id: workspace_id, endpoint: endpoint)
           @endpoint = options[:endpoint]
@@ -35,10 +67,6 @@ module Seam
         initialize_routes(client: @client, defaults: @defaults)
       end
 
-      def lts_version
-        Seam::LTS_VERSION
-      end
-
       def create_paginator(request, params = {})
         Paginator.new(request, params)
       end

data/lib/seam/http_without_workspace.rb

@@ -2,7 +2,6 @@
 
 require_relative "request"
 require_relative "parse_options"
-require_relative "lts_version"
 require_relative "version"
 require_relative "auth"
 require_relative "resources/index"
@@ -14,26 +13,47 @@ module Seam
     class WithoutWorkspace
       attr_reader :client, :defaults
 
-      def initialize(personal_access_token: nil, endpoint: nil, wait_for_action_attempt: true, timeout: nil,
-        faraday_options: {}, faraday_retry_options: {})
+      OPTION_NOT_PROVIDED = Object.new.freeze
+      private_constant :OPTION_NOT_PROVIDED
+
+      def initialize(client: nil, personal_access_token: OPTION_NOT_PROVIDED, endpoint: OPTION_NOT_PROVIDED,
+        wait_for_action_attempt: OPTION_NOT_PROVIDED, timeout: OPTION_NOT_PROVIDED,
+        faraday_options: OPTION_NOT_PROVIDED, faraday_retry_options: OPTION_NOT_PROVIDED)
+        supplied_options = {
+          personal_access_token: personal_access_token,
+          endpoint: endpoint,
+          wait_for_action_attempt: wait_for_action_attempt,
+          timeout: timeout,
+          faraday_options: faraday_options,
+          faraday_retry_options: faraday_retry_options
+        }.reject { |_, value| value.equal?(OPTION_NOT_PROVIDED) }
+        invalid_options = supplied_options.keys - [:wait_for_action_attempt]
+
+        if client && invalid_options.any?
+          raise Http::Options::SeamInvalidOptionsError.new(
+            "The client option cannot be used with any other option, but received: #{supplied_options.keys.join(", ")}"
+          )
+        end
+
+        wait_for_action_attempt = true if wait_for_action_attempt.equal?(OPTION_NOT_PROVIDED)
         @wait_for_action_attempt = wait_for_action_attempt
         @defaults = {"wait_for_action_attempt" => wait_for_action_attempt}
 
-        options = Http::Options.parse_without_workspace_options(personal_access_token: personal_access_token,
-          endpoint: endpoint)
-        @endpoint = options[:endpoint]
-        @auth_headers = options[:auth_headers]
+        @client = client || begin
+          personal_access_token = nil if personal_access_token.equal?(OPTION_NOT_PROVIDED)
+          endpoint = nil if endpoint.equal?(OPTION_NOT_PROVIDED)
+          timeout = nil if timeout.equal?(OPTION_NOT_PROVIDED)
+          faraday_options = {} if faraday_options.equal?(OPTION_NOT_PROVIDED)
+          faraday_retry_options = {} if faraday_retry_options.equal?(OPTION_NOT_PROVIDED)
 
-        @client = Http::Request.create_faraday_client(@endpoint, @auth_headers, faraday_options,
-          faraday_retry_options, timeout: timeout)
-      end
-
-      def self.lts_version
-        Seam::LTS_VERSION
-      end
+          options = Http::Options.parse_without_workspace_options(personal_access_token: personal_access_token,
+            endpoint: endpoint)
+          @endpoint = options[:endpoint]
+          @auth_headers = options[:auth_headers]
 
-      def lts_version
-        Seam::LTS_VERSION
+          Http::Request.create_faraday_client(@endpoint, @auth_headers, faraday_options,
+            faraday_retry_options, timeout: timeout)
+        end
       end
 
       def workspaces

data/lib/seam/request.rb

@@ -3,7 +3,6 @@
 require "faraday"
 require "faraday/retry"
 require_relative "defaults"
-require_relative "lts_version"
 require_relative "version"
 require_relative "paginator"
 
@@ -24,7 +23,11 @@ module Seam
 
         default_faraday_retry_options = {
           max: 2,
-          backoff_factor: 2
+          interval: 0.2,
+          interval_randomness: 0.2,
+          backoff_factor: 2,
+          exceptions: Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed],
+          retry_statuses: [429] + (500..599).to_a
         }
 
         faraday_retry_options = default_faraday_retry_options.merge(faraday_retry_options)
@@ -43,8 +46,7 @@ module Seam
           "User-Agent" => "seam-ruby/#{Seam::VERSION}",
           "Content-Type" => "application/json",
           :"seam-sdk-name" => "seamapi/ruby",
-          :"seam-sdk-version" => Seam::VERSION,
-          :"seam-lts-version" => Seam::LTS_VERSION
+          :"seam-sdk-version" => Seam::VERSION
         }
       end
 

data/lib/seam/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Seam
-  VERSION = "2.137.0"
+  VERSION = "2.139.0"
 end

data/lib/seam.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "seam/lts_version"
 require_relative "seam/http"
 require_relative "seam/http_without_workspace"
 require_relative "seam/webhook"
@@ -19,8 +18,4 @@ module Seam
   def self.from_personal_access_token(personal_access_token, workspace_id, endpoint: nil, wait_for_action_attempt: true, timeout: nil)
     Seam::Http.from_personal_access_token(personal_access_token, workspace_id, endpoint: endpoint, wait_for_action_attempt: wait_for_action_attempt, timeout: timeout)
   end
-
-  def self.lts_version
-    Seam::LTS_VERSION
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seam
 version: !ruby/object:Gem::Version
-  version: 2.137.0
+  version: 2.139.0
 platform: ruby
 authors:
 - Seam Labs, Inc.
@@ -198,7 +198,6 @@ files:
 - lib/seam/http.rb
 - lib/seam/http_single_workspace.rb
 - lib/seam/http_without_workspace.rb
-- lib/seam/lts_version.rb
 - lib/seam/options.rb
 - lib/seam/paginator.rb
 - lib/seam/parse_options.rb

data/lib/seam/lts_version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Seam
-  LTS_VERSION = "1.0.0"
-end