Expose authenticator on Client via attr_reader

Author: sferik

lib/x/client.rb

@@ -44,6 +44,13 @@ class Client
     #   client.default_object_class = OpenStruct
     attr_accessor :default_object_class
 
+    # The authenticator for API requests
+    # @api public
+    # @return [Authenticator] the authenticator instance
+    # @example Check if the OAuth 2.0 token has expired
+    #   client.authenticator.token_expired?
+    attr_reader :authenticator
+
     def_delegators :@connection, :open_timeout, :read_timeout, :write_timeout, :proxy_url, :debug_output
     def_delegators :@connection, :open_timeout=, :read_timeout=, :write_timeout=, :proxy_url=, :debug_output=
     def_delegators :@redirect_handler, :max_redirects
@@ -144,9 +151,9 @@ def delete(endpoint, headers: {}, array_class: default_array_class, object_class
     # @return [Hash, Array, nil] the parsed response body
     def execute_request(http_method, endpoint, body: nil, headers: {}, array_class: default_array_class, object_class: default_object_class)
       uri = URI.join(base_url, endpoint)
-      request = @request_builder.build(http_method:, uri:, body:, headers:, authenticator: @authenticator)
+      request = @request_builder.build(http_method:, uri:, body:, headers:, authenticator:)
       response = @connection.perform(request:)
-      response = @redirect_handler.handle(response:, request:, base_url:, authenticator: @authenticator)
+      response = @redirect_handler.handle(response:, request:, base_url:, authenticator:)
       @response_parser.parse(response:, array_class:, object_class:)
     end
   end

sig/x.rbs

@@ -274,6 +274,7 @@ module X
     attr_accessor base_url: String
     attr_accessor default_array_class: singleton(Array)
     attr_accessor default_object_class: singleton(Hash)
+    attr_reader authenticator: Authenticator | BearerTokenAuthenticator | OAuthAuthenticator | OAuth2Authenticator
     def initialize: (?api_key: String?, ?api_key_secret: String?, ?access_token: String?, ?access_token_secret: String?, ?bearer_token: String?, ?client_id: String?, ?client_secret: String?, ?refresh_token: String?, ?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer, ?write_timeout: Integer, ?debug_output: untyped, ?proxy_url: String?, ?default_array_class: singleton(Array), ?default_object_class: singleton(Hash), ?max_redirects: Integer) -> void
     def get: (String endpoint, ?headers: Hash[String, String], ?array_class: Class, ?object_class: Class) -> untyped
     def post: (String endpoint, ?String? body, ?headers: Hash[String, String], ?array_class: Class, ?object_class: Class) -> untyped

test/x/client_initialization_test.rb

@@ -8,7 +8,7 @@ class ClientOAuthInitializationTest < Minitest::Test
     def test_initialize_oauth_credentials
       client = Client.new(**test_oauth_credentials)
 
-      authenticator = client.instance_variable_get(:@authenticator)
+      authenticator = client.authenticator
 
       assert_instance_of OAuthAuthenticator, authenticator
       assert_equal TEST_API_KEY, authenticator.api_key
@@ -21,7 +21,7 @@ def test_missing_oauth_credentials
       test_oauth_credentials.each_key do |missing_credential|
         client = Client.new(**test_oauth_credentials.except(missing_credential))
 
-        assert_instance_of Authenticator, client.instance_variable_get(:@authenticator)
+        assert_instance_of Authenticator, client.authenticator
       end
     end
 
@@ -33,7 +33,7 @@ def test_setting_oauth_credentials
         assert_equal value, client.public_send(credential)
       end
 
-      assert_instance_of OAuthAuthenticator, client.instance_variable_get(:@authenticator)
+      assert_instance_of OAuthAuthenticator, client.authenticator
     end
 
     def test_setting_oauth_credentials_reinitializes_authenticator
@@ -55,7 +55,7 @@ class ClientOAuth2InitializationTest < Minitest::Test
     def test_initialize_oauth2_credentials
       client = Client.new(**test_oauth2_credentials)
 
-      authenticator = client.instance_variable_get(:@authenticator)
+      authenticator = client.authenticator
 
       assert_instance_of OAuth2Authenticator, authenticator
       assert_equal TEST_CLIENT_ID, authenticator.client_id
@@ -68,7 +68,7 @@ def test_missing_oauth2_credentials
       test_oauth2_credentials.each_key do |missing_credential|
         client = Client.new(**test_oauth2_credentials.except(missing_credential))
 
-        assert_instance_of Authenticator, client.instance_variable_get(:@authenticator)
+        assert_instance_of Authenticator, client.authenticator
       end
     end
 
@@ -80,7 +80,7 @@ def test_setting_oauth2_credentials
         assert_equal value, client.public_send(credential)
       end
 
-      assert_instance_of OAuth2Authenticator, client.instance_variable_get(:@authenticator)
+      assert_instance_of OAuth2Authenticator, client.authenticator
     end
 
     def test_setting_oauth2_credentials_reinitializes_authenticator
@@ -103,31 +103,53 @@ def test_oauth1_takes_precedence_over_oauth2
       client = Client.new(**test_oauth_credentials, client_id: TEST_CLIENT_ID, client_secret: TEST_CLIENT_SECRET,
         refresh_token: TEST_REFRESH_TOKEN)
 
-      assert_instance_of OAuthAuthenticator, client.instance_variable_get(:@authenticator)
+      assert_instance_of OAuthAuthenticator, client.authenticator
     end
 
     def test_oauth2_takes_precedence_over_bearer_token
       client = Client.new(**test_oauth2_credentials, bearer_token: TEST_BEARER_TOKEN)
 
-      assert_instance_of OAuth2Authenticator, client.instance_variable_get(:@authenticator)
+      assert_instance_of OAuth2Authenticator, client.authenticator
     end
 
     def test_setting_bearer_token
       client = Client.new
       client.bearer_token = "bearer_token"
 
       assert_equal "bearer_token", client.bearer_token
-      assert_instance_of BearerTokenAuthenticator, client.instance_variable_get(:@authenticator)
+      assert_instance_of BearerTokenAuthenticator, client.authenticator
     end
 
     def test_authenticator_remains_unchanged_if_no_new_credentials
       client = Client.new
-      initial_authenticator = client.instance_variable_get(:@authenticator)
+      initial_authenticator = client.authenticator
 
       client.api_key = nil
       client.bearer_token = nil
 
-      assert_equal initial_authenticator, client.instance_variable_get(:@authenticator)
+      assert_equal initial_authenticator, client.authenticator
+    end
+
+    def test_initialize_authenticator_uses_instance_variable_not_accessor
+      client = Client.new(**test_oauth_credentials)
+      original_authenticator = client.authenticator
+      clear_all_credentials(client)
+
+      # If code uses accessor (nil), falls through to Authenticator.new; if @authenticator, preserves original
+      client.stub(:authenticator, nil) { client.send(:initialize_authenticator) }
+
+      assert_equal original_authenticator, client.authenticator
+    end
+
+    private
+
+    def clear_all_credentials(client)
+      %i[@api_key @api_key_secret @access_token @access_token_secret].each do |var|
+        client.instance_variable_set(var, nil)
+      end
+      %i[@bearer_token @client_id @client_secret @refresh_token].each do |var|
+        client.instance_variable_set(var, nil)
+      end
     end
   end