discourse/lib/onebox/engine/github_commit_onebox.rb
Martin Brennan 560e8aff75
FEATURE: Allow oneboxing private GitHub URLs (#27705)
This commit adds the ability to onebox private GitHub
commits, pull requests, issues, blobs, and actions using
a new `github_onebox_access_token` site setting. The token
must be set up in correctly to have access to the repos needed.

To do this successfully with the Oneboxer, we need to skip
redirects on the github.com host, otherwise we get a 404
on the URL before it is translated into a GitHub API URL
and has the appropriate headers added.
2024-07-10 09:39:31 +10:00

59 lines
1.7 KiB
Ruby

# frozen_string_literal: true
require_relative "../mixins/github_body"
require_relative "../mixins/github_auth_header"
module Onebox
module Engine
class GithubCommitOnebox
include Engine
include LayoutSupport
include JSON
include Onebox::Mixins::GithubBody
include Onebox::Mixins::GithubAuthHeader
matches_regexp(%r{^https?://(?:www\.)?(?:(?:\w)+\.)?(github)\.com(?:/)?(?:.)*/commit/})
always_https
def url
"https://api.github.com/repos/#{match[:owner]}/#{match[:repository]}/commits/#{match[:sha]}"
end
private
def match
return @match if defined?(@match)
@match =
@url.match(%{github\.com/(?<owner>[^/]+)/(?<repository>[^/]+)/commit/(?<sha>[^/]+)})
@match ||=
@url.match(
%{github\.com/(?<owner>[^/]+)/(?<repository>[^/]+)/pull/(?<pr>[^/]+)/commit/(?<sha>[^/]+)},
)
@match
end
def data
result = raw(github_auth_header).clone
lines = result["commit"]["message"].split("\n")
result["title"] = lines.first
result["body"], result["excerpt"] = compute_body(lines[1..lines.length].join("\n"))
committed_at = Time.parse(result["commit"]["committer"]["date"])
result["committed_at"] = committed_at.strftime("%I:%M%p - %d %b %y %Z")
result["committed_at_date"] = committed_at.strftime("%F")
result["committed_at_time"] = committed_at.strftime("%T")
result["link"] = link
ulink = URI(link)
result["domain"] = "#{ulink.host}/#{ulink.path.split("/")[1]}/#{ulink.path.split("/")[2]}"
result["i18n"] = { committed: I18n.t("onebox.github.committed") }
result
end
end
end
end