Module: GitHub::API Private

Defined in:
utils/github/api.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Helper functions to access the GitHub API.

Defined Under Namespace

Classes: AuthenticationFailedError, Error, HTTPNotFoundError, MissingAuthenticationError, RateLimitExceededError, ValidationFailedError

Constant Summary collapse

GITHUB_IP_ALLOWLIST_ERROR =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

Regexp.new("Although you appear to have the correct authorization credentials, " \
"the `(.+)` organization has an IP allow list enabled, " \
"and your IP address is not permitted to access this resource").freeze
NO_CREDENTIALS_MESSAGE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

<<~MESSAGE
  No GitHub credentials found in macOS Keychain, GitHub CLI or the environment.
  #{GitHub.pat_blurb}
MESSAGE
ERRORS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

[
  AuthenticationFailedError,
  HTTPNotFoundError,
  RateLimitExceededError,
  Error,
  JSON::ParserError,
].freeze
CREDENTIAL_NAMES =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

{
  env_token:                  "HOMEBREW_GITHUB_API_TOKEN",
  github_cli_token:           "GitHub CLI login",
  keychain_username_password: "macOS Keychain GitHub",
}.freeze

Class Method Summary collapse

Class Method Details

.credentials ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



167
168
169
 
# File 'utils/github/api.rb', line 167

def self.credentials
  @credentials ||= Homebrew::EnvConfig.github_api_token || github_cli_token || keychain_username_password
end

.credentials_error_message(response_headers, needed_scopes) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Given an API response from GitHub, warn the user if their credentials have insufficient permissions.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'utils/github/api.rb', line 192

def self.credentials_error_message(response_headers, needed_scopes)
  return if response_headers.empty?

  scopes = response_headers["x-accepted-oauth-scopes"].to_s.split(", ")
  needed_scopes = Set.new(scopes || needed_scopes)
  credentials_scopes = response_headers["x-oauth-scopes"]
  return if needed_scopes.subset?(Set.new(credentials_scopes.to_s.split(", ")))

  needed_scopes = needed_scopes.to_a.join(", ").presence || "none"
  credentials_scopes = "none" if credentials_scopes.blank?

  what = CREDENTIAL_NAMES.fetch(credentials_type)
  @credentials_error_message ||= onoe <<~EOS
    Your #{what} credentials do not have sufficient scope!
    Scopes required: #{needed_scopes}
    Scopes present:  #{credentials_scopes}
    #{GitHub.pat_blurb}
  EOS
end

.credentials_type ⇒ Symbol

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



172
173
174
175
176
177
178
179
180
181
182
 
# File 'utils/github/api.rb', line 172

def self.credentials_type
  if Homebrew::EnvConfig.github_api_token.present?
    :env_token
  elsif github_cli_token.present?
    :github_cli_token
  elsif keychain_username_password.present?
    :keychain_username_password
  else
    :none
  end
end

.github_cli_token ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Gets the token from the GitHub CLI for github.com.

Returns:



133
134
135
136
137
138
139
140
141
142
143
 
# File 'utils/github/api.rb', line 133

def self.github_cli_token
  # Avoid `Formula["gh"].opt_bin` so this method works even with `HOMEBREW_DISABLE_LOAD_FORMULA`.
  env = { "PATH" => PATH.new(HOMEBREW_PREFIX/"opt/gh/bin", ENV.fetch("PATH")) }
  gh_out, _, result = system_command "gh",
                                     args:         ["auth", "token", "--hostname", "github.com"],
                                     env:          env,
                                     print_stderr: false
  return unless result.success?

  gh_out.chomp
end

.keychain_username_password ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Gets the password field from git-credential-osxkeychain for github.com, but only if that password looks like a GitHub Personal Access Token.

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'utils/github/api.rb', line 148

def self.keychain_username_password
  git_credential_out, _, result = system_command "git",
                                                 args:         ["credential-osxkeychain", "get"],
                                                 input:        ["protocol=https\n", "host=github.com\n"],
                                                 print_stderr: false
  return unless result.success?

  github_username = git_credential_out[/username=(.+)/, 1]
  github_password = git_credential_out[/password=(.+)/, 1]
  return unless github_username

  # Don't use passwords from the keychain unless they look like
  # GitHub Personal Access Tokens:
  #   https://github.com/Homebrew/brew/issues/6862#issuecomment-572610344
  return unless GITHUB_PERSONAL_ACCESS_TOKEN_REGEX.match?(github_password)

  github_password
end

.open_graphql(query, variables: nil, scopes: [].freeze, raise_errors: true) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'utils/github/api.rb', line 302

def self.open_graphql(query, variables: nil, scopes: [].freeze, raise_errors: true)
  data = { query: query, variables: variables }
  result = open_rest("#{API_URL}/graphql", scopes: scopes, data: data, request_method: "POST")

  if raise_errors
    if result["errors"].present?
      raise Error, result["errors"].map { |e| "#{e["type"]}: #{e["message"]}" }.join("\n")
    end

    result["data"]
  else
    result
  end
end

.open_rest(url, data: nil, data_binary_path: nil, request_method: nil, scopes: [].freeze, parse_json: true) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'utils/github/api.rb', line 212

def self.open_rest(
  url, data: nil, data_binary_path: nil, request_method: nil, scopes: [].freeze, parse_json: true
)
  # This is a no-op if the user is opting out of using the GitHub API.
  return block_given? ? yield({}) : {} if Homebrew::EnvConfig.no_github_api?

  # This is a Curl format token, not a Ruby one.
  # rubocop:disable Style/FormatStringToken
  args = ["--header", "Accept: application/vnd.github+json", "--write-out", "\n%{http_code}"]
  # rubocop:enable Style/FormatStringToken

  token = credentials
  args += ["--header", "Authorization: token #{token}"] if credentials_type != :none
  args += ["--header", "X-GitHub-Api-Version:2022-11-28"]

  data_tmpfile = nil
  if data
    begin
      data = JSON.pretty_generate data
      data_tmpfile = Tempfile.new("github_api_post", HOMEBREW_TEMP)
    rescue JSON::ParserError => e
      raise Error, "Failed to parse JSON request:\n#{e.message}\n#{data}", e.backtrace
    end
  end

  if data_binary_path.present?
    args += ["--data-binary", "@#{data_binary_path}"]
    args += ["--header", "Content-Type: application/gzip"]
  end

  headers_tmpfile = Tempfile.new("github_api_headers", HOMEBREW_TEMP)
  begin
    if data_tmpfile
      data_tmpfile.write data
      data_tmpfile.close
      args += ["--data", "@#{data_tmpfile.path}"]

      args += ["--request", request_method.to_s] if request_method
    end

    args += ["--dump-header", T.must(headers_tmpfile.path)]

    output, errors, status = Utils::Curl.curl_output("--location", url.to_s, *args, secrets: [token])
    output, _, http_code = output.rpartition("\n")
    output, _, http_code = output.rpartition("\n") if http_code == "000"
    headers = headers_tmpfile.read
  ensure
    if data_tmpfile
      data_tmpfile.close
      data_tmpfile.unlink
    end
    headers_tmpfile.close
    headers_tmpfile.unlink
  end

  begin
    raise_error(output, errors, http_code, headers, scopes) if !http_code.start_with?("2") || !status.success?

    return if http_code == "204" # No Content

    output = JSON.parse output if parse_json
    if block_given?
      yield output
    else
      output
    end
  rescue JSON::ParserError => e
    raise Error, "Failed to parse JSON response\n#{e.message}", e.backtrace
  end
end

.paginate_rest(url, additional_query_params: nil, per_page: 100) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'utils/github/api.rb', line 283

def self.paginate_rest(url, additional_query_params: nil, per_page: 100)
  (1..API_MAX_PAGES).each do |page|
    retry_count = 1
    result = begin
      API.open_rest("#{url}?per_page=#{per_page}&page=#{page}&#{additional_query_params}")
    rescue Error
      if retry_count < PAGINATE_RETRY_COUNT
        retry_count += 1
        retry
      end

      raise
    end
    break if result.blank?

    yield(result, page)
  end
end

.raise_error(output, errors, http_code, headers, scopes) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'utils/github/api.rb', line 317

def self.raise_error(output, errors, http_code, headers, scopes)
  json = begin
    JSON.parse(output)
  rescue
    nil
  end
  message = json&.[]("message") || "curl failed! #{errors}"

  meta = {}
  headers.lines.each do |l|
    key, _, value = l.delete(":").partition(" ")
    key = key.downcase.strip
    next if key.empty?

    meta[key] = value.strip
  end

  credentials_error_message(meta, scopes)

  case http_code
  when "401"
    raise AuthenticationFailedError.new(credentials_type, message)
  when "403"
    if meta.fetch("x-ratelimit-remaining", 1).to_i <= 0
      reset = meta.fetch("x-ratelimit-reset").to_i
      raise RateLimitExceededError.new(reset, message)
    end

    raise AuthenticationFailedError.new(credentials_type, message)
  when "404"
    raise MissingAuthenticationError if credentials_type == :none && scopes.present?

    raise HTTPNotFoundError, message
  when "422"
    errors = json&.[]("errors") || []
    raise ValidationFailedError.new(message, errors)
  else
    raise Error, message
  end
end