Module: GitHub

Defined in:
Library/Homebrew/dev-cmd/pull.rb,
Library/Homebrew/utils/github.rb

Defined Under Namespace

Classes: AuthenticationFailedError, RateLimitExceededError

Constant Summary collapse

API_URL =
"https://api.github.com".freeze
CREATE_GIST_SCOPES =
["gist"].freeze
CREATE_ISSUE_SCOPES =
["public_repo"].freeze
ALL_SCOPES =
(CREATE_GIST_SCOPES + CREATE_ISSUE_SCOPES).freeze
ALL_SCOPES_URL =
Formatter.url("https://github.com/settings/tokens/new?scopes=#{ALL_SCOPES.join(",")}&description=Homebrew").freeze
Error =
Class.new(RuntimeError)
HTTPNotFoundError =
Class.new(Error)

Class Method Summary collapse

Class Method Details

.api_credentialsObject



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'Library/Homebrew/utils/github.rb', line 54

def api_credentials
  @api_credentials ||= begin
    if ENV["HOMEBREW_GITHUB_API_TOKEN"]
      ENV["HOMEBREW_GITHUB_API_TOKEN"]
    elsif ENV["HOMEBREW_GITHUB_API_USERNAME"] && ENV["HOMEBREW_GITHUB_API_PASSWORD"]
      [ENV["HOMEBREW_GITHUB_API_PASSWORD"], ENV["HOMEBREW_GITHUB_API_USERNAME"]]
    else
      github_credentials = api_credentials_from_keychain
      github_username = github_credentials[/username=(.+)/, 1]
      github_password = github_credentials[/password=(.+)/, 1]
      if github_username && github_password
        [github_password, github_username]
      else
        []
      end
    end
  end
end

.api_credentials_error_message(response_headers, needed_scopes) ⇒ Object



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'Library/Homebrew/utils/github.rb', line 94

def api_credentials_error_message(response_headers, needed_scopes)
  return if response_headers.empty?

  @api_credentials_error_message_printed ||= begin
    unauthorized = (response_headers["http/1.1"] == "401 Unauthorized")
    scopes = response_headers["x-accepted-oauth-scopes"].to_s.split(", ")
    needed_human_scopes = needed_scopes.join(", ")
    needed_human_scopes = "none" if needed_human_scopes.empty?
    if !unauthorized && scopes.empty?
      credentials_scopes = response_headers["x-oauth-scopes"]

      case GitHub.api_credentials_type
      when :keychain
        onoe <<~EOS
          Your macOS keychain GitHub credentials do not have sufficient scope!
          Scopes they need: #{needed_human_scopes}
          Scopes they have: #{credentials_scopes}
          Create a personal access token: #{ALL_SCOPES_URL}
          and then set HOMEBREW_GITHUB_API_TOKEN as the authentication method instead.
        EOS
      when :environment
        onoe <<~EOS
          Your HOMEBREW_GITHUB_API_TOKEN does not have sufficient scope!
          Scopes they need: #{needed_human_scopes}
          Scopes it has: #{credentials_scopes}
          Create a new personal access token: #{ALL_SCOPES_URL}
          and then set the new HOMEBREW_GITHUB_API_TOKEN as the authentication method instead.
        EOS
      end
    end
    true
  end
end

.api_credentials_from_keychainObject



73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'Library/Homebrew/utils/github.rb', line 73

def api_credentials_from_keychain
  Utils.popen(["git", "credential-osxkeychain", "get"], "w+") do |pipe|
    pipe.write "protocol=https\nhost=github.com\n"
    pipe.close_write
    pipe.read
  end
rescue Errno::EPIPE
  # The above invocation via `Utils.popen` can fail, causing the pipe to be
  # prematurely closed (before we can write to it) and thus resulting in a
  # broken pipe error. The root cause is usually a missing or malfunctioning
  # `git-credential-osxkeychain` helper.
  ""
end

.api_credentials_typeObject



87
88
89
90
91
92
# File 'Library/Homebrew/utils/github.rb', line 87

def api_credentials_type
  token, username = api_credentials
  return :none if !token || token.empty?
  return :environment if !username || username.empty?
  :keychain
end

.issues_for_formula(name, options = {}) ⇒ Object



236
237
238
239
# File 'Library/Homebrew/utils/github.rb', line 236

def issues_for_formula(name, options = {})
  tap = options[:tap] || CoreTap.instance
  search_issues(name, state: "open", repo: "#{tap.user}/homebrew-#{tap.repo}", in: "title")
end

.open(url, data: nil, scopes: [].freeze) ⇒ Object



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'Library/Homebrew/utils/github.rb', line 128

def open(url, data: nil, scopes: [].freeze)
  # This is a no-op if the user is opting out of using the GitHub API.
  return block_given? ? yield({}) : {} if ENV["HOMEBREW_NO_GITHUB_API"]

  args = %W[--header application/vnd.github.v3+json --write-out \n%{http_code}] # rubocop:disable Lint/NestedPercentLiteral
  args += curl_args

  token, username = api_credentials
  case api_credentials_type
  when :keychain
    args += %W[--user #{username}:#{token}]
  when :environment
    args += ["--header", "Authorization: token #{token}"]
  end

  data_tmpfile = nil
  if data
    begin
      data = JSON.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

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

    args += ["--dump-header", headers_tmpfile.path]

    output, errors, status = curl_output(url.to_s, "--location", *args)
    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
    if !http_code.start_with?("2") && !status.success?
      raise_api_error(output, errors, http_code, headers, scopes)
    end
    json = JSON.parse output
    if block_given?
      yield json
    else
      json
    end
  rescue JSON::ParserError => e
    raise Error, "Failed to parse JSON response\n#{e.message}", e.backtrace
  end
end


241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'Library/Homebrew/utils/github.rb', line 241

def print_pull_requests_matching(query)
  open_or_closed_prs = search_issues(query, type: "pr", user: "Homebrew")

  open_prs = open_or_closed_prs.select { |i| i["state"] == "open" }
  prs = if !open_prs.empty?
    puts "Open pull requests:"
    open_prs
  else
    puts "Closed pull requests:" unless open_or_closed_prs.empty?
    open_or_closed_prs
  end

  prs.each { |i| puts "#{i["title"]} (#{i["html_url"]})" }
end

.private_repo?(full_name) ⇒ Boolean

Returns:

  • (Boolean)


256
257
258
259
# File 'Library/Homebrew/utils/github.rb', line 256

def private_repo?(full_name)
  uri = url_to "repos", full_name
  open(uri) { |json| json["private"] }
end

.query_string(*main_params, **qualifiers) ⇒ Object



261
262
263
264
265
266
267
268
269
# File 'Library/Homebrew/utils/github.rb', line 261

def query_string(*main_params, **qualifiers)
  params = main_params

  params += qualifiers.flat_map do |key, value|
    Array(value).map { |v| "#{key}:#{v}" }
  end

  "q=#{URI.encode_www_form_component(params.join(" "))}&per_page=100"
end

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'Library/Homebrew/utils/github.rb', line 191

def raise_api_error(output, errors, http_code, headers, scopes)
  meta = {}
  headers.lines.each do |l|
    key, _, value = l.delete(":").partition(" ")
    key = key.downcase.strip
    next if key.empty?
    meta[key] = value.strip
  end

  if meta.fetch("x-ratelimit-remaining", 1).to_i <= 0
    reset = meta.fetch("x-ratelimit-reset").to_i
    error = JSON.parse(output)["message"]
    raise RateLimitExceededError.new(reset, error)
  end

  GitHub.api_credentials_error_message(meta, scopes)

  case http_code
  when "401", "403"
    raise AuthenticationFailedError, output
  when "404"
    raise HTTPNotFoundError, output
  else
    error = begin
      JSON.parse(output)["message"]
    rescue
      nil
    end
    error ||= "curl failed! #{errors}"
    raise Error, error
  end
end

.repository(user, repo) ⇒ Object



228
229
230
# File 'Library/Homebrew/utils/github.rb', line 228

def repository(user, repo)
  open(url_to("repos", user, repo))
end

.search(entity, *queries, **qualifiers) ⇒ Object



275
276
277
278
279
# File 'Library/Homebrew/utils/github.rb', line 275

def search(entity, *queries, **qualifiers)
  uri = url_to "search", entity
  uri.query = query_string(*queries, **qualifiers)
  open(uri) { |json| json.fetch("items", []) }
end

.search_code(**qualifiers) ⇒ Object



232
233
234
# File 'Library/Homebrew/utils/github.rb', line 232

def search_code(**qualifiers)
  search("code", **qualifiers)
end

.search_issues(query, **qualifiers) ⇒ Object



224
225
226
# File 'Library/Homebrew/utils/github.rb', line 224

def search_issues(query, **qualifiers)
  search("issues", query, **qualifiers)
end

.test_bot_user(user) ⇒ Object

Return the corresponding test-bot user name for the given GitHub organization.



65
66
67
68
69
70
# File 'Library/Homebrew/dev-cmd/pull.rb', line 65

def test_bot_user(user)
  test_bot = ARGV.value "test-bot-user"
  return test_bot if test_bot
  return "BrewTestBot" if user.casecmp("homebrew").zero?
  "#{user.capitalize}TestBot"
end

.url_to(*subroutes) ⇒ Object



271
272
273
# File 'Library/Homebrew/utils/github.rb', line 271

def url_to(*subroutes)
  URI.parse([API_URL, *subroutes].join("/"))
end