mirror of
https://github.com/public-apis/public-apis.git
synced 2024-09-21 00:01:12 +02:00
61 lines
2.1 KiB
Ruby
Executable File
61 lines
2.1 KiB
Ruby
Executable File
#!/usr/bin/env ruby
|
|
|
|
auth_keys = ['apiKey', 'OAuth', 'X-Mashape-Key', 'No']
|
|
punctuation = ['.', '?', '!']
|
|
https_keys = ['Yes', 'No']
|
|
args = ARGV
|
|
filename = args[0]
|
|
$errors = []
|
|
|
|
def add_error(line_num, message)
|
|
$errors.push("(L%03d) #{message}" % line_num)
|
|
end
|
|
|
|
File.foreach(filename).with_index do | line, line_num |
|
|
line_num += 1
|
|
if line.start_with?('|')
|
|
# Skip table schema lines
|
|
if line.eql? "|---|---|---|---|---|\n"
|
|
next
|
|
end
|
|
values = line.split("|")
|
|
################# DESCRIPTION ################
|
|
# First character should be capitalized
|
|
desc_val = values[2].lstrip.chop
|
|
if !/[[:upper:]]/.match(desc_val[0])
|
|
add_error(line_num, "Invalid Description (first char not uppercase): #{desc_val}")
|
|
end
|
|
# value should not be punctuated
|
|
last_char = desc_val[desc_val.length-1]
|
|
if punctuation.include?(last_char)
|
|
add_error(line_num, "Invalid Description (description should not end with \"#{last_char}\")")
|
|
end
|
|
#################### AUTH ####################
|
|
# Values should conform to valid options only
|
|
auth_val = values[3].lstrip.chop.tr('``', '')
|
|
if !auth_keys.include?(auth_val)
|
|
add_error(line_num, "Invalid Auth (not a valid option): #{auth_val}")
|
|
end
|
|
#################### HTTPS ###################
|
|
# Values should be either "Yes" or "No"
|
|
https_val = values[4].lstrip.chop
|
|
if !https_keys.include?(https_val)
|
|
add_error(line_num, "(#{line_num}) Invalid HTTPS: (must use \"Yes\" or \"No\"): #{https_val}")
|
|
end
|
|
#################### LINK ####################
|
|
# Url should be wrapped in "[Go!]" view
|
|
link_val = values[5].lstrip.chop
|
|
if !link_val.start_with?("[Go!](") || !link_val.end_with?(')')
|
|
add_error(line_num, "(#{line_num}) Invalid Link: (format should be \"[Go!](<LINK>)\"): #{link_val}")
|
|
end
|
|
end
|
|
end
|
|
if $errors.length > 0
|
|
$errors.each do | e |
|
|
puts e
|
|
end
|
|
exit(1)
|
|
else
|
|
exit(0)
|
|
end
|