Merge pull request #262 from veracioux:tuterm_demo

Add automated CLI demonstrations

Contributors:
  * @veracioux
  * @spirillen

README.rst

@@ -150,6 +150,7 @@ contribution(s) and or issue report which made or make `PyFunceble`_ a better to
 
 -   Avinash Reddy - `@AvinashReddy3108`_
 -   Daniel - `@dnmTX`_
+-   Haris Gušić - `@veracioux`_
 -   gwarser - `@gwarser`_
 -   hawkeye116477 - `@hawkeye116477`_
 -   Human Being - `@T145`_
@@ -296,6 +297,7 @@ License
 .. _@T145: https://github.com/T145
 .. _@tartley: https://github.com/tartley
 .. _@theskumar: https://github.com/theskumar
+.. _@veracioux: https://github.com/veracioux
 .. _@Wally3K: https://github.com/WaLLy3K
 .. _@xxcriticxx: https://github.com/xxcriticxx
 .. _@yaml: https://github.com/yaml

docs/contributors.rst

@@ -18,6 +18,7 @@ contribution(s) and or issue report which made or make `PyFunceble`_ a better to
 -   Avinash Reddy - `@AvinashReddy3108`_
 -   Daniel - `@dnmTX`_
 -   gwarser - `@gwarser`_
+-   Haris Gušić - `@veracioux`_
 -   hawkeye116477 - `@hawkeye116477`_
 -   Human Being - `@T145`_
 -   Imre Kristoffer Eilertsen - `@DandelionSprout`_
@@ -60,6 +61,7 @@ contribution(s) and or issue report which made or make `PyFunceble`_ a better to
 .. _@speedmann: https://github.com/speedmann
 .. _@spirillen: https://mypdns.org/spirillen
 .. _@T145: https://github.com/T145
+.. _@veracioux: https://github.com/veracioux
 .. _@Wally3K: https://github.com/WaLLy3K
 .. _@xxcriticxx: https://github.com/xxcriticxx
 .. _@ybreza: https://github.com/ybreza

examples/demo/config.sh.in

@@ -0,0 +1,21 @@
+# Common config for demo scripts
+configure() {
+    DELAY=0.07
+    DELAY_SEP=0.22
+    DELAY_PROMPT=0.6
+
+# No messages/warnings in the current versions of the scripts
+# but if we add them, their colors can be changed here
+    # COLOR_WARNING='1;91'
+    # COLOR_MESSAGE='1;32'
+
+    # If you want to use the colorful prompt
+    TUTERM_NAME='PyFunceble-demo'
+    # Set the terminal width/height
+}
+
+prompt() {
+# For a more colorful prompt, uncomment the following:
+    # echo -ne "\033[1;94m$TUTERM_NAME \033[1;35m$(pwd | sed "s:$HOME:~:")\033[0;33m $\033[0m "
+    echo -n '[funilrys@funilrys PyFunceble]$ '
+}

examples/demo/landing_page_demo_1.tut

@@ -0,0 +1,14 @@
+#!/usr/bin/env tuterm
+
+source config.sh.in
+
+run() {
+    c PyFunceble --version
+    c PyFunceble -a -d example.org
+    c PyFunceble -a -d example.org --whois-lookup
+    c PyFunceble -a -d exampleee.com
+    c PyFunceble -a -d microsoft_google.com
+    c exit
+}
+
+# vim: filetype=sh

examples/demo/landing_page_demo_2.tut

@@ -0,0 +1,15 @@
+#!/usr/bin/env tuterm
+
+source config.sh.in
+
+run() {
+    c PyFunceble --version
+    c PyFunceble -d 9.9.9.9                         # Neutral stable
+    c PyFunceble -d 2620:fe::fe                     # quad9 IPv6 (As I recall GHA now supports IPv6)
+    c PyFunceble -d 194.187.99.221                  # Adult CDN: https://mypdns.org/my-privacy-dns/porn-records/-/issues?scope=all&state=all&label_name[]=IP%3A%3ABlackListing
+    c PyFunceble -d 45.136.204.40                   # 23 phis: https://github.com/mitchellkrogza/phishing/pull/67
+    c PyFunceble -u http://18.191.88.103/login.html # As we can do urls too, this is a inactive Phis
+    c exit
+}
+
+# vim: filetype=sh

examples/demo/landing_page_demo_3.tut

@@ -0,0 +1,14 @@
+#!/usr/bin/env tuterm
+
+source config.sh.in
+
+run() {
+    c PyFunceble --version
+    c PyFunceble -u https://github.com/funilrys
+    c PyFunceble -u https://github.com/microsoft_google
+    c PyFunceble -u https://microsoft_google.com
+    c PyFunceble -u https://microsoft_google.com --local
+    c exit
+}
+
+# vim: filetype=sh

examples/demo/record.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env sh
+
+set -e
+
+# Pre-warm PyFunceble for better performance
+echo Pre-warming for better recording performance
+for i in $(seq 1 10); do
+    PyFunceble --version >/dev/null
+done
+
+for file in "$@"; do
+    mkdir -p "/tmp/PyFunceble"
+    cast="/tmp/PyFunceble/$(basename "$file").cast"
+    rm -f "$cast"
+    stty cols 166 rows 45
+    asciinema rec -c "tuterm $file --mode demo" "$cast"
+done

examples/demo/upload.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+
+set -e
+
+for file in "$@"; do
+    cast="/tmp/PyFunceble/$(basename "$file").cast"
+    asciinema upload "$cast" | grep 'https:' | sed 's/^\s*//'
+done