Class: OpenAI::Auth::SubjectTokenProviders::GCPIDTokenProvider

Inherits:
Object
  • Object
show all
Includes:
OpenAI::Auth::SubjectTokenProvider
Defined in:
lib/openai/auth/subject_token_providers/gcp_id_token_provider.rb,
sig/openai/auth/subject_token_providers.rbs

Constant Summary collapse

METADATA_HOST = 
"metadata.google.internal"
DEFAULT_AUDIENCE = 
"https://api.openai.com/v1"
DEFAULT_TIMEOUT = 
10.0

Instance Method Summary collapse

Constructor Details

#initialize(audience: self.class::DEFAULT_AUDIENCE, timeout: self.class::DEFAULT_TIMEOUT) ⇒ GCPIDTokenProvider

Returns a new instance of GCPIDTokenProvider.

Parameters:

  • audience: (String) (defaults to: self.class::DEFAULT_AUDIENCE)
  • timeout: (Float) (defaults to: self.class::DEFAULT_TIMEOUT) 


13
14
15
16
17
18
19
 
# File 'lib/openai/auth/subject_token_providers/gcp_id_token_provider.rb', line 13

def initialize(
  audience: self.class::DEFAULT_AUDIENCE,
  timeout: self.class::DEFAULT_TIMEOUT
)
  @audience = audience
  @timeout = timeout
end

Instance Method Details

#get_token ⇒ String

Returns:

  • (String) 


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/openai/auth/subject_token_providers/gcp_id_token_provider.rb', line 25

def get_token
  path = "/computeMetadata/v1/instance/service-accounts/default/identity"
  uri = URI::HTTP.build(
    host: self.class::METADATA_HOST,
    path: path,
    query: URI.encode_www_form("audience" => @audience)
  )

  request = Net::HTTP::Get.new(uri)
  request["Metadata-Flavor"] = "Google"

  response = Net::HTTP
    .start(
      uri.hostname,
      uri.port,
      use_ssl: false,
      open_timeout: @timeout,
      read_timeout: @timeout
    ) do |http|
      http.request(request)
    end

  unless response.is_a?(Net::HTTPSuccess)
    raise(
      OpenAI::Errors::SubjectTokenProviderError.new(
        message: "GCP Metadata Server returned #{response.code}: #{response.body}",
        provider: "gcp-metadata"
      )
    )
  end

  response.body
rescue OpenAI::Errors::SubjectTokenProviderError
  raise
rescue StandardError => e
  raise(
    OpenAI::Errors::SubjectTokenProviderError.new(
      message: "Failed to fetch token from GCP Metadata Server: #{e.message}",
      provider: "gcp-metadata",
      cause: e
    )
  )
end

#token_type ⇒ Symbol

Returns:

  • (Symbol) 


21
22
23
 
# File 'lib/openai/auth/subject_token_providers/gcp_id_token_provider.rb', line 21

def token_type
  TokenType::ID
end