Class: Asciidoctor::Foodogsquared::Extensions::GitHubIncludeProcessor

Inherits:
Extensions::IncludeProcessor
  • Object
show all
Defined in:
lib/asciidoctor/foodogsquared/extensions/github-include-processor.rb

Instance Method Summary collapse

Instance Method Details

#handles?(target) ⇒ Boolean

Returns:

  • (Boolean) 


10
11
12
 
# File 'lib/asciidoctor/foodogsquared/extensions/github-include-processor.rb', line 10

def handles?(target)
  target.start_with? 'github:'
end

#process(doc, reader, target, attrs) ⇒ Object 



22
23
24
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
68
 
# File 'lib/asciidoctor/foodogsquared/extensions/github-include-processor.rb', line 22

def process(doc, reader, target, attrs)
  src = target.delete_prefix('github:').split('/', 3)
  owner = src.at 0
  repo = src.at 1
  namespaced_repo = "#{owner}/#{repo}"

  path = attrs['path'] || ''

  # For more information, see https://docs.github.com/en/rest/repos/contents.
  uri = URI.parse %(https://api.github.com/repos/#{owner}/#{repo}/contents/#{path})

  if attrs['rev']
    query = { ref: attrs['rev'] }
    uri.query = URI.encode_www_form query
  end

  begin
    headers = {
      'Header' => 'application/vnd.github+json',
      'X-GitHub-Api-Version' => '2022-11-28'
    }

    headers['Authorization'] = "Token #{ENV['GITHUB_API_BEARER_TOKEN']}" if ENV['GITHUB_API_BEARER_TOKEN']

    OpenURI.open_uri(uri, headers) do |f|
      response = JSON.parse(f.read)

      # If the response is an array, it is likely to be a directory. In this
      # usecase, we'll just list them.
      content = if response.is_a? Array
                  warning = %(given path '#{path}' from GitHub repo '#{repo}' is a directory)
                  warn_or_raise doc, warning
                  warning
                elsif response.is_a? Object
                  Base64.decode64 response['content'] if response['content'] && response['encoding'] == 'base64'
                end

      reader.push_include content, target, target, 1, attrs
    end
  rescue OpenURI::HTTPError => e
    warning = %(error while getting '#{path}' in GitHub repo '#{namespaced_repo}: #{e}')
    warn_or_raise doc, warning
    reader.push_include warning, target, target, 1, attrs
  end

  reader
end

#warn_or_raise(doc, warning) ⇒ Object 



14
15
16
17
18
19
20
 
# File 'lib/asciidoctor/foodogsquared/extensions/github-include-processor.rb', line 14

def warn_or_raise(doc, warning)
  if (doc.safe > Asciidoctor::SafeMode::SERVER) && !(doc.attr? 'allow-uri-read')
    raise warning
  else
    warn warning
  end
end