From f41c13ffbe0c8ea8256a287969b92f30bc724112 Mon Sep 17 00:00:00 2001
From: Hadley <s.markoski@gmail.com>
Date: Tue, 23 Jul 2024 14:13:50 -0400
Subject: [PATCH] FLEX-9231: Add remote user IP option

---
 lib/spark_api/configuration.rb | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lib/spark_api/configuration.rb b/lib/spark_api/configuration.rb
index 0d2bbf9a..7c046ed7 100644
--- a/lib/spark_api/configuration.rb
+++ b/lib/spark_api/configuration.rb
@@ -11,7 +11,7 @@ module Configuration
     # valid configuration options
     VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint, 
       :user_agent, :version, :ssl, :ssl_verify, :oauth2_provider, :authentication_mode, 
-      :auth_endpoint, :callback, :compress, :timeout, :middleware, :dictionary_version, :request_id_chain].freeze
+      :auth_endpoint, :callback, :compress, :timeout, :middleware, :dictionary_version, :request_id_chain, :user_ip_address].freeze
     OAUTH2_KEYS = [:authorization_uri, :access_uri, :client_id, :client_secret,
       # Requirements for authorization_code grant type
       :redirect_uri,  
@@ -46,8 +46,10 @@ module Configuration
     DEFAULT_MIDDLEWARE = 'spark_api'
     DEFAULT_DICTIONARY_VERSION = nil
     DEFAULT_REQUEST_ID_CHAIN = nil
+    DEFAULT_USER_IP_ADDRESS = nil
     
     X_SPARK_API_USER_AGENT = "X-SparkApi-User-Agent"
+    X_USER_IP_ADDRESS = "X-User-IP-Address"
 
     attr_accessor *VALID_OPTION_KEYS
     def configure
@@ -82,6 +84,7 @@ def reset_configuration
       self.middleware = DEFAULT_MIDDLEWARE
       self.dictionary_version = DEFAULT_DICTIONARY_VERSION
       self.request_id_chain = DEFAULT_REQUEST_ID_CHAIN
+      self.user_ip_address = DEFAULT_USER_IP_ADDRESS
       self
     end
   end