3pp-mirror/public-apis
1
0
Fork 0
mirror of https://github.com/public-apis/public-apis.git synced 2025-05-17 11:06:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add punctuation check for Description

Browse source
This commit is contained in:
Dave Machado 2017-07-28 11:22:52 -04:00
parent 60e1f8c623
commit 60fbe68f78
1 changed files with 15 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

19
build/validate_format.rb
View file

@ -1,5 +1,6 @@
#!/usr/bin/env ruby #!/usr/bin/env ruby
auth_keys = ['apiKey', 'OAuth', 'X-Mashape-Key', 'No'] auth_keys = ['apiKey', 'OAuth', 'X-Mashape-Key', 'No']
punctuation = ['.', '?', '!']
https_keys = ['Yes', 'No'] https_keys = ['Yes', 'No']
args = ARGV args = ARGV
filename = args[0] filename = args[0]
@ -12,25 +13,35 @@ File.foreach(filename).with_index do |line, line_num|
next next
end end
values = line.split("|") values = line.split("|")
# Check Description to make sure first character is capitalized ################# DESCRIPTION ################
# First character should be capitalized
desc_val = values[2].lstrip.chop desc_val = values[2].lstrip.chop
if !/[[:upper:]]/.match(desc_val[0]) if !/[[:upper:]]/.match(desc_val[0])
puts "(#{line_num}) Invalid Description (first char not uppercase): #{desc_val}" puts "(#{line_num}) Invalid Description (first char not uppercase): #{desc_val}"
fail_flag = true fail_flag = true
end end
# Check Auth values to conform to valid options only # value should not be punctuated
last_char = desc_val[desc_val.length-1]
if punctuation.include?(last_char)
puts "(#{line_num}) Invalid Description (description should not end with \"#{last_char}\")"
fail_flag = true
end
#################### AUTH ####################
# Values should conform to valid options only
auth_val = values[3].lstrip.chop.tr('``', '') auth_val = values[3].lstrip.chop.tr('``', '')
if !auth_keys.include?(auth_val) if !auth_keys.include?(auth_val)
puts "(#{line_num}) Invalid Auth (not a valid option): #{auth_val}" puts "(#{line_num}) Invalid Auth (not a valid option): #{auth_val}"
fail_flag = true fail_flag = true
end end
# Check HTTPS Support values to be either "Yes" or "No" #################### HTTPS ###################
# Values should be either "Yes" or "No"
https_val = values[4].lstrip.chop https_val = values[4].lstrip.chop
if !https_keys.include?(https_val) if !https_keys.include?(https_val)
puts "(#{line_num}) Invalid HTTPS: (must use \"Yes\" or \"No\"): #{https_val}" puts "(#{line_num}) Invalid HTTPS: (must use \"Yes\" or \"No\"): #{https_val}"
fail_flag = true fail_flag = true
end end
# Check Link to ensure url is wrapped in "[Go!]" view #################### LINK ####################
# Url should be wrapped in "[Go!]" view
link_val = values[5].lstrip.chop link_val = values[5].lstrip.chop
if !link_val.start_with?("[Go!](") || !link_val.end_with?(')') if !link_val.start_with?("[Go!](") || !link_val.end_with?(')')
puts "(#{line_num}) Invalid Link: (format should be \"[Go!](<LINK>)\"): #{link_val}" puts "(#{line_num}) Invalid Link: (format should be \"[Go!](<LINK>)\"): #{link_val}"