fix(ruby): add helper to add segment to user agent (generated)

algolia/api-clients-automation#3972

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>

lib/algolia/api/abtesting_client.rb

@@ -45,6 +45,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # Creates a new A/B test.

lib/algolia/api/analytics_client.rb

@@ -45,6 +45,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # This method allow you to send requests to the Algolia REST API.

lib/algolia/api/ingestion_client.rb

@@ -45,6 +45,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # Creates a new authentication resource.

lib/algolia/api/insights_client.rb

@@ -45,6 +45,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # This method allow you to send requests to the Algolia REST API.

lib/algolia/api/monitoring_client.rb

@@ -30,6 +30,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # This method allow you to send requests to the Algolia REST API.

lib/algolia/api/personalization_client.rb

@@ -45,6 +45,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # This method allow you to send requests to the Algolia REST API.

lib/algolia/api/query_suggestions_client.rb

@@ -45,6 +45,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.

lib/algolia/api/recommend_client.rb

@@ -38,6 +38,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # Create or update a batch of Recommend Rules  Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules.  Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn't require a facet value placeholder (it tries to match the data source item's attributes instead).

lib/algolia/api/search_client.rb

@@ -41,6 +41,14 @@ def self.create_with_config(config)
     # @return [void]
     def set_client_api_key(api_key)
       @api_client.set_client_api_key(api_key)
+
+      self
+    end
+
+    def add_user_agent_segment(segment, version = nil)
+      @api_client.config.add_user_agent_segment(segment, version)
+
+      self
     end
 
     # Creates a new API key with specific permissions and restrictions.

lib/algolia/configuration.rb

@@ -33,11 +33,17 @@ def initialize(app_id, api_key, hosts, client_name, opts = {})
 
       @user_agent = UserAgent.new.add(client_name, VERSION)
 
+      if opts[:user_agent_segments]
+        opts[:user_agent_segments].each do |segment|
+          @user_agent.add(segment)
+        end
+      end
+
       @header_params = {
         "X-Algolia-Application-Id" => app_id,
         "X-Algolia-API-Key" => api_key,
         "Content-Type" => "application/json",
-        "User-Agent" => @user_agent
+        "User-Agent" => @user_agent.value
       }
       @header_params.transform_keys!(&:downcase)
 
@@ -47,11 +53,20 @@ def initialize(app_id, api_key, hosts, client_name, opts = {})
     def set_client_api_key(api_key)
       @api_key = api_key
       @header_params["X-Algolia-API-Key"] = api_key
+
+      self
     end
 
     # The default Configuration object.
     def self.default
       @@default ||= Configuration.new
     end
+
+    def add_user_agent_segment(segment, version = nil)
+      @user_agent.add(segment, version)
+      @header_params["user-agent"] = @user_agent.value
+
+      self
+    end
   end
 end

lib/algolia/user_agent.rb

@@ -8,8 +8,14 @@ def initialize
 
     # Adds a segment to the UserAgent
     #
-    def add(segment, version)
-      @value += format("; %<segment>s (%<version>s)", segment: segment, version: version)
+    def add(segment, version = nil)
+      if version.nil?
+        @value += format("; %<segment>s", segment: segment)
+      else
+        @value += format("; %<segment>s (%<version>s)", segment: segment, version: version)
+      end
+
+      self
     end
   end
 end