Skip to content

RUBY-3209 Generate api docs #2768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ data/*
gemfiles/*.gemfile.lock
.env.private*
.env
build
119 changes: 119 additions & 0 deletions upload-api-docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
#!/usr/bin/env ruby

require 'bundler/inline'

gemfile true do
source 'https://rubygems.org'
gem 'nokogiri'
gem 'aws-sdk-s3'
gem 'yard'
end

require 'aws-sdk-s3'
require 'optparse'
require 'yard'

class FileUploader
def initialize(options)
Aws.config.update({
region: options[:region],
credentials: Aws::Credentials.new(options[:access_key], options[:secret_key])
})
Aws.use_bundled_cert!
@s3 = Aws::S3::Client.new
@bucket = options[:bucket]
@prefix = options[:prefix]
@docs_path = options[:docs_path]
end

def upload_docs
Dir.glob("#{@docs_path}/**/*").each do |file|
next if File.directory?(file)

upload_file(file, key(file))
print '.'
$stdout.flush
end
puts "\nDone!"
end

private

def key(file)
File.join(@prefix, file.gsub("#{@docs_path}/", ''))
end

def upload_file(file, key)
mime_type = mime_type(file)
@s3.put_object(bucket: @bucket, key: key, body: File.read(file), content_type: mime_type)
end

def mime_type(file)
{
'.html' => 'text/html',
'.css' => 'text/css',
'.js' => 'application/javascript',
}.fetch(File.extname(file))
end
end

class Options
def initialize
@options = {}
parse_cli_options!
parse_env_options!
@options[:prefix] = "docs/ruby-driver/current/api"
@options[:docs_path] = "build/public/current/api"
end

def [](key)
@options[key]
end

private

def parse_cli_options!
OptionParser.new do |opts|
opts.banner = "Usage: upload-api-docs [options]"

opts.on('-b BUCKET', '--bucket=BUCKET', 'S3 Bucket to upload') do |b|
@options[:bucket] = b
end
opts.on('-r REGION', '--region=REGION', 'AWS region') do |r|
@options[:region] = r
end
end.parse!
[:bucket, :region].each do |opt|
raise OptionParser::MissingArgument, "Option --#{opt} is required" unless @options[opt]
end
end

def parse_env_options!
@options[:access_key] = ENV.fetch('DOCS_AWS_ACCESS_KEY_ID') do
raise ArgumentError, 'Please provide aws access key via DOCS_AWS_ACCESS_KEY_ID env variable'
end
@options[:secret_key] = ENV.fetch('DOCS_AWS_SECRET_ACCESS_KEY') do
raise ArgumentError, 'Please provide aws secret key via DOCS_AWS_SECRET_ACCESS_KEY env variable'
end
end
end

def generate_docs(options)
YARD::CLI::Yardoc.run(
'.',
'--exclude', './.evergreen',
'--exclude', './.mod',
'--exclude', './examples',
'--exclude', './profile',
'--exclude', './release',
'--exclude', './spec',
'--readme', './README.md',
'-o', options[:docs_path]
)
end


options = Options.new
generate_docs(options)
FileUploader.new(options).upload_docs
return 0