discourse/lib/onebox/engine/github_blob_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

48 lines
1.2 KiB
Ruby

# frozen_string_literal: true
require_relative "../mixins/git_blob_onebox"
require_relative "../mixins/github_auth_header"
module Onebox
module Engine
class GithubBlobOnebox
include Onebox::Mixins::GithubAuthHeader
def self.git_regexp
%r{^https?://(www\.)?github\.com.*/blob/}
end
def self.onebox_name
"githubblob"
end
include Onebox::Mixins::GitBlobOnebox
def i18n
{
binary_file: I18n.t("onebox.github.binary_file"),
truncated_file: I18n.t("onebox.github.truncated_file"),
show_original: I18n.t("onebox.github.show_original"),
requires_iframe: I18n.t("onebox.github.requires_iframe"),
}
end
def raw_regexp
%r{github\.com/(?<user>[^/]+)/(?<repo>[^/]+)/blob/(?<sha1>[^/]+)/(?<file>[^#]+)(#(L(?<from>[^-]*)(-L(?<to>.*))?))?}mi
end
def raw_template(m)
"https://raw.githubusercontent.com/#{m[:user]}/#{m[:repo]}/#{m[:sha1]}/#{m[:file]}"
end
def title
Sanitize.fragment(Onebox::Helpers.uri_unencode(link).sub(%r{^https?\://github\.com/}, ""))
end
def auth_headers
github_auth_header
end
end
end
end