Support passing http client options

Author: andrii-balitskyi

lib/seam/http_multi_workspace.rb

@@ -10,12 +10,12 @@ module Http
     class MultiWorkspace
       attr_reader :client, :wait_for_action_attempt, :defaults
 
-      def initialize(personal_access_token:, endpoint: nil, wait_for_action_attempt: true)
+      def initialize(personal_access_token:, endpoint: nil, wait_for_action_attempt: true, client_options: {})
         @wait_for_action_attempt = wait_for_action_attempt
         @defaults = {"wait_for_action_attempt" => wait_for_action_attempt}
         @endpoint = Http::Options.get_endpoint(endpoint)
         @auth_headers = Http::Auth.get_auth_headers_for_multi_workspace_personal_access_token(personal_access_token)
-        @client = Seam::Http::Request.create_faraday_client(@endpoint, @auth_headers)
+        @client = Seam::Http::Request.create_faraday_client(@endpoint, @auth_headers, client_options)
       end
 
       def self.lts_version
@@ -30,11 +30,12 @@ def workspaces
         @workspaces ||= WorkspacesProxy.new(Seam::Clients::Workspaces.new(self))
       end
 
-      def self.from_personal_access_token(personal_access_token, endpoint: nil, wait_for_action_attempt: true)
+      def self.from_personal_access_token(personal_access_token, endpoint: nil, wait_for_action_attempt: true, client_options: {})
         new(
           personal_access_token: personal_access_token,
           endpoint: endpoint,
-          wait_for_action_attempt: wait_for_action_attempt
+          wait_for_action_attempt: wait_for_action_attempt,
+          client_options: client_options
         )
       end
 

lib/seam/http_single_workspace.rb

@@ -12,25 +12,25 @@ class SingleWorkspace
       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)
+        wait_for_action_attempt: true, client_options: {})
         options = Http::Options.parse_options(api_key: api_key, personal_access_token: personal_access_token, workspace_id: workspace_id, endpoint: endpoint)
         @endpoint = options[:endpoint]
         @auth_headers = options[:auth_headers]
         @defaults = Seam::DeepHashAccessor.new({"wait_for_action_attempt" => wait_for_action_attempt})
 
-        @client = client || Seam::Http::Request.create_faraday_client(@endpoint, @auth_headers)
+        @client = client || Seam::Http::Request.create_faraday_client(@endpoint, @auth_headers, client_options)
       end
 
       def lts_version
         Seam::LTS_VERSION
       end
 
-      def self.from_api_key(api_key, endpoint: nil, wait_for_action_attempt: false)
-        new(api_key: api_key, endpoint: endpoint, wait_for_action_attempt: wait_for_action_attempt)
+      def self.from_api_key(api_key, endpoint: nil, wait_for_action_attempt: false, client_options: {})
+        new(api_key: api_key, endpoint: endpoint, wait_for_action_attempt: wait_for_action_attempt, client_options: client_options)
       end
 
-      def self.from_personal_access_token(personal_access_token, workspace_id, endpoint: nil, wait_for_action_attempt: false)
-        new(personal_access_token: personal_access_token, workspace_id: workspace_id, endpoint: endpoint, wait_for_action_attempt: wait_for_action_attempt)
+      def self.from_personal_access_token(personal_access_token, workspace_id, endpoint: nil, wait_for_action_attempt: false, client_options: {})
+        new(personal_access_token: personal_access_token, workspace_id: workspace_id, endpoint: endpoint, wait_for_action_attempt: wait_for_action_attempt, client_options: client_options)
       end
 
       def request_seam_object(method, path, klass, inner_object, config = {})

lib/seam/request.rb

@@ -6,12 +6,18 @@
 module Seam
   module Http
     module Request
-      def self.create_faraday_client(endpoint, auth_headers)
-        Faraday.new(endpoint) do |builder|
+      def self.create_faraday_client(endpoint, auth_headers, client_options = {})
+        default_options = {
+          url: endpoint,
+          headers: auth_headers.merge(default_headers)
+        }
+
+        options = deep_merge(default_options, client_options)
+
+        Faraday.new(options) do |builder|
           builder.request :json
           builder.request :retry, backoff_factor: 2
           builder.response :json
-          builder.headers = auth_headers.merge(default_headers)
         end
       end
 
@@ -57,6 +63,20 @@ def self.default_headers
           :"seam-lts-version" => Seam::LTS_VERSION
         }
       end
+
+      def self.deep_merge(hash1, hash2)
+        result = hash1.dup
+        hash2.each do |key, value|
+          result[key] = if value.is_a?(Hash) && result[key].is_a?(Hash)
+            deep_merge(result[key], value)
+          else
+            value
+          end
+        end
+        result
+      end
+
+      private_class_method :deep_merge
     end
   end
 end

spec/seam_client/client_options_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Seam::Http::SingleWorkspace do
+  let(:api_key) { "seam_test_api_key" }
+  let(:endpoint) { "https://example.com/api" }
+  let(:client_options) do
+    {
+      headers: { "Custom-Header" => "Test-Value" },
+      request: { timeout: 30 }
+    }
+  end
+
+  describe "client options" do
+    it "passes client_options to the Faraday client" do
+      expect(Faraday).to receive(:new).with(
+        hash_including(
+          headers: hash_including("Custom-Header" => "Test-Value"),
+          request: { timeout: 30 }
+        )
+      ).and_call_original
+
+      client = described_class.new(
+        api_key: api_key,
+        endpoint: endpoint,
+        client_options: client_options
+      )
+
+      expect(client).to be_a(Seam::Http::SingleWorkspace)
+    end
+
+    it "merges client_options with default options" do
+      client = described_class.new(
+        api_key: api_key,
+        endpoint: endpoint,
+        client_options: client_options
+      )
+
+      faraday_client = client.instance_variable_get(:@client)
+      expect(faraday_client.headers["Custom-Header"]).to eq("Test-Value")
+      expect(faraday_client.options.timeout).to eq(30)
+      expect(faraday_client.headers["Authorization"]).to eq("Bearer #{api_key}")
+    end
+  end
+end