Initially adding lyrics tool

This commit is contained in:
Alex Epstein 2017-08-19 13:43:49 -04:00
parent 61e9aad6b3
commit 89a4d1f32e
1 changed files with 198 additions and 0 deletions

198
lyrics/lyrics Executable file
View File

@ -0,0 +1,198 @@
#!/usr/bin/env bash
# Author: Alexander Epstein https://github.com/alexanderepstein
currentVersion="1.18.1"
configuredClient=""
artist="false"
song="false"
## This function determines which http get tool the system has installed and returns an error if there isnt one
getConfiguredClient()
{
if command -v curl &>/dev/null; then
configuredClient="curl"
elif command -v wget &>/dev/null; then
configuredClient="wget"
elif command -v http &>/dev/null; then
configuredClient="httpie"
elif command -v fetch &>/dev/null; then
configuredClient="fetch"
else
echo "Error: This tool reqires either curl, wget, httpie or fetch to be installed." >&2
return 1
fi
}
getConfiguredPython()
{
if command -v python2 &>/dev/null ; then
configuredPython="python2"
elif command -v python &>/dev/null ; then
configuredPython="python"
else
echo "Error: This tool requires python 2 to be installed."
return 1
fi
}
if [[ $(uname) != "Darwin" ]]; then
python()
{
case "$configuredPython" in
python2) python2 "$@";;
python) python "$@";;
esac
}
fi
## Allows to call the users configured client without if statements everywhere
httpGet()
{
case "$configuredClient" in
curl) curl -A curl -s "$@" ;;
wget) wget -qO- "$@" ;;
httpie) http -b GET "$@" ;;
fetch) fetch -q "$@" ;;
esac
}
update()
{
# Author: Alexander Epstein https://github.com/alexanderepstein
# Update utility version 1.2.0
# To test the tool enter in the defualt values that are in the examples for each variable
repositoryName="Bash-Snippets" #Name of repostiory to be updated ex. Sandman-Lite
githubUserName="alexanderepstein" #username that hosts the repostiory ex. alexanderepstein
nameOfInstallFile="install.sh" # change this if the installer file has a different name be sure to include file extension if there is one
latestVersion=$(httpGet https://api.github.com/repos/$githubUserName/$repositoryName/tags | grep -Eo '"name":.*?[^\\]",'| head -1 | grep -Eo "[0-9.]+" ) #always grabs the tag without the v option
if [[ $currentVersion == "" || $repositoryName == "" || $githubUserName == "" || $nameOfInstallFile == "" ]]; then
echo "Error: update utility has not been configured correctly." >&2
exit 1
elif [[ $latestVersion == "" ]]; then
echo "Error: no active internet connection" >&2
exit 1
else
if [[ "$latestVersion" != "$currentVersion" ]]; then
echo "Version $latestVersion available"
echo -n "Do you wish to update $repositoryName [Y/n]: "
read -r answer
if [[ "$answer" == [Yy] ]]; then
cd ~ || { echo 'Update Failed'; exit 1; }
if [[ -d ~/$repositoryName ]]; then rm -r -f $repositoryName || { echo "Permissions Error: try running the update as sudo"; exit 1; } ; fi
git clone "https://github.com/$githubUserName/$repositoryName" || { echo "Couldn't download latest version"; exit 1; }
cd $repositoryName || { echo 'Update Failed'; exit 1; }
git checkout "v$latestVersion" 2> /dev/null || git checkout "$latestVersion" 2> /dev/null || echo "Couldn't git checkout to stable release, updating to latest commit."
chmod a+x install.sh #this might be necessary in your case but wasnt in mine.
./$nameOfInstallFile "update" || exit 1
cd ..
rm -r -f $repositoryName || { echo "Permissions Error: update succesfull but cannot delete temp files located at ~/$repositoryName delete this directory with sudo"; exit 1; }
else
exit 1
fi
else
echo "$repositoryName is already the latest version"
fi
fi
}
checkInternet()
{
httpGet github.com > /dev/null 2>&1 || { echo "Error: no active internet connection" >&2; return 1; } # query github with a get request
}
getLyrics()
{
encodedArtist=$(echo $1 | sed s/" "/%20/g | sed s/"&"/%26/g | sed s/,/%2C/g | sed s/-/%2D/g)
encodedSong=$(echo $2 | sed s/" "/%20/g | sed s/"&"/%26/g | sed s/,/%2C/g | sed s/-/%2D/g)
response=$(httpGet "https://api.lyrics.ovh/v1/$encodedArtist/$encodedSong")
lyrics=$(echo $response | python -c "import sys, json; print json.load(sys.stdin)['lyrics']" 2> /dev/null)
if [[ $lyrics == "" ]];then { echo "Error: no lyrics found!"; return 1; }; fi
}
printLyrics()
{
if [ -z $filePath ];then echo -e "$lyrics"
else
if [ -f $filePath ];then
echo -n "File already exists, do you want to overwrite it [Y/n]: "
read -r answer
if [[ "$answer" == [Yy] ]]; then
echo -e "$lyrics" > $filePath;
fi
fi
fi
}
usage()
{
cat <<EOF
Lyrics
Description: Short desciption of the tool.
Usage: tool [flags] or tool [flags] [arguments]
-u Update Bash-Snippet Tools
-h Show the help
-v Get the tool version
Examples:
tool
tool
EOF
}
while getopts "f:a:s:uvh" opt; do
case "$opt" in
\?) echo "Invalid option: -$OPTARG" >&2
exit 1
;;
h) usage
exit 0
;;
v) echo "Version $currentVersion"
exit 0
;;
u) checkInternet || exit 1
update
exit 0
;;
f)
filePath=$OPTARG
;;
a)
artist="true"
;;
s)
song="true"
;;
:) echo "Option -$OPTARG requires an argument." >&2file="false"
exit 1
;;
esac
done
# special set of first arguments that have a specific behavior across tools
if [[ $# == "0" ]]; then
usage ## if calling the tool with no flags and args chances are you want to return usage
exit 0
elif [[ $# == "1" ]]; then
if [[ $1 == "update" ]]; then
getConfiguredClient || exit 1
checkInternet || exit 1
update || exit 1
exit 0
elif [[ $1 == "help" ]]; then
usage
exit 0
fi
fi
if ! $artist || ! $song;then { echo "Error: the -a and the -s flag must be used to fetch lyrics."; exit 1; }; fi
song=$(echo "$@" | grep -Eo "\-s [ a-z A-Z 0-9 . \ ]*[ -]?" | sed s/-s//g | sed s/-//g | sed s/^" "//g)
if [[ $song == "" ]];then { echo "Error: song could not be parsed from input."; exit 1; };fi
artist=$(echo "$@" | grep -Eo "\-a [ a-z A-Z 0-9 . \ ]*[ -]?" | sed s/-a//g | sed s/-//g | sed s/^" "//g)
if [[ $artist == "" ]];then { echo "Error: artist could not be parsed from input."; exit 1; };fi
getConfiguredClient || exit 1
if [[ $(uname) != "Darwin" ]]; then getConfiguredPython || exit 1;fi
checkInternet || exit 1
getLyrics "$artist" "$song" || exit 1
printLyrics