Add Linux support (#1)

* Format missing indentation

* Add Linux support using libsecret-tools (secret-tool command)

* Add Linux instructions to README

Author: fariassdev

README.md

@@ -6,7 +6,7 @@ What is dotfilesync?
 
 dotfilesync is a bash script that syncs a list of local files that _you_ define, into a secret gist, that _you_ own.
 
-dotfilesync is very easy to use as it stores your gist credentials into Mac OS X Keychain, so you don't have to provide it each time.
+dotfilesync is very easy to use as it stores your gist credentials into an encrypted Keychain, so you don't have to provide it each time.
 
 You are not limited to syncing only dotfiles. Although this tool is meant for you to sync local dotfiles, it can also be used to sync any file that can be synced with gist.
 
@@ -36,9 +36,13 @@ A sample config shape can look like this:
 }
 ```
 
-### Uses OS X Keychain
+### Tools used as Keychain
 
-The tool uses [OSX security](https://ss64.com/osx/security.html) command to manage your GitHub Personal Access Token within your Keychain. This way your token is safe and encrypted by the Keychain, and you don't have to provide it each time you run the command to sync files.
+This tool stores and manage your GitHub Personal Access Token within into an encrypted Keychain. This way your token is safe and encrypted by the Keychain, and you don't have to provide it each time you run the command to sync files.
+
+For OS X based operating systems, the [OSX security](https://ss64.com/osx/security.html) command is used.
+
+For Linux based operating systems, the [secret-tools](http://www.linuxfromscratch.org/blfs/view/svn/gnome/libsecret.html) command is used to interact with [GnomeKeyring](https://wiki.gnome.org/Projects/GnomeKeyring). For more info about keyrings used on Linux systems [read this article](https://rtfm.co.ua/en/what-is-linux-keyring-gnome-keyring-secret-service-and-d-bus/#Linux_keyring_vs_gnome-keyring).
 
 ### Sync multiple files into a single secret gist
 
@@ -59,10 +63,18 @@ During a fetch operation (syncing local files from gist), a sync is performed, o
 Prerequisites
 -------------
 
-This script uses [jq](https://stedolan.github.io/jq/download/) to parse the `config.json` on the local filesystem. You can run the following command on OS X, if you have [Homebrew](https://brew.sh/) installed:
+This script uses [jq](https://stedolan.github.io/jq/download/) to parse the `config.json` on the local filesystem.
+
+## OS X
+You can run the following command on OS X, if you have [Homebrew](https://brew.sh/) installed:
 
        brew install jq
 
+## Linux
+You can install the required packages on a Debian based distro running the following command:
+
+       apt-get install jq libsecret-tools
+
 Installation
 ------------
 
@@ -77,13 +89,13 @@ Ensure the [prerequisite](#prerequisites) tools are setup. Installing dotfilesyn
   * With curl:
 
         mkdir -p ${HOME}/.dotfilesync \
-        && curl -fsSL https://raw.githubusercontent.com/snvishna/dotfilesync/master/src/dfsync_osx.sh \
+        && curl -fsSL https://raw.githubusercontent.com/snvishna/dotfilesync/master/src/dfsync.sh \
           >| ${HOME}/.dotfilesync/dfsync.sh
 
   * With wget:
 
         mkdir -p ${HOME}/.dotfilesync \
-        && wget -nv -O - https://raw.githubusercontent.com/snvishna/dotfilesync/master/src/dfsync_osx.sh \
+        && wget -nv -O - https://raw.githubusercontent.com/snvishna/dotfilesync/master/src/dfsync.sh \
           >| ${HOME}/.dotfilesync/dfsync.sh
 
 3. Add an entry in zshrc:
@@ -98,7 +110,7 @@ Ensure the [prerequisite](#prerequisites) tools are setup. Installing dotfilesyn
 
     You can create a new [person access tokens page](https://github.com/settings/tokens/new) for running the script on the command line. Follow [these instructions](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) on how to create one. Make sure you have the __gist__ scope selected to grant permission on this token.
 
-    Once you generate the personal access token, either copy it on your clipboard, or save it somewhere, since the script will need this to store within the OS X Keychain, before syncing your files in gist.
+    Once you generate the personal access token, either copy it on your clipboard, or save it somewhere, since the script will need this to store within the Keychain, before syncing your files in gist.
 
     ![](./resources/generate_personal_access_token.gif)
 
@@ -124,7 +136,7 @@ Commands
 
   It is run only __once__ as part of the installation instructions. This command does the following:
 
-  * Prompts for your GitHub username and the personal access token. It then stores this information securely in the OS X Keychain.
+  * Prompts for your GitHub username and the personal access token. It then stores this information securely in the Keychain.
 
   * Creates a new secret gist in your account with the description - "Generated by dotfilesync utility".
 
@@ -152,7 +164,7 @@ Commands
 
   This command will do the following:
 
-  * Delete the saved GitHub gist credentials from the OS X Keychain.
+  * Delete the saved GitHub gist credentials from the Keychain.
   * Delete `config.json` file from the `${HOME}/.dotfilesync` directory.
   * It does not automatically delete the saved gist from your GitHub account. Rather, it prints out the HTTP link to your gist, so you can choose to delete it.
   * It provides a link to the uninstall instructions in this README, so you can run the commands to delete the script and update the zsh config.
@@ -164,7 +176,7 @@ You can cleanup the script and all resources created by it, using the following
 
 * __Run__ `dfsync cleanup`
 
-  You can run the command to 1) Delete the saved GitHub gist credentials from the OS X Keychain 2) Delete `config.json` file from the `${HOME}/.dotfilesync` directory.
+  You can run the command to 1) Delete the saved GitHub gist credentials from the Keychain 2) Delete `config.json` file from the `${HOME}/.dotfilesync` directory.
 
 * __Delete the gist__
 

src/dfsync_osx.sh src/dfsync.shsrc/dfsync_osx.sh renamed to src/dfsync.sh

@@ -8,21 +8,44 @@ HOME_DIR=~
 DOTFILESYNC_ROOT_PATH="~/.dotfilesync"
 DOTFILESYNC_CONFIG_PATH="$DOTFILESYNC_ROOT_PATH/config.json"
 eval DOTFILESYNC_CONFIG=$DOTFILESYNC_CONFIG_PATH
+UNAME="$( command -v uname )"
+OSTYPE="$( "${UNAME}" | tr '[:upper:]' '[:lower:]')"
 
 backup() {
   cp -n $1{,.bak."$(date +%Y%m%d-%H%M%S)"}
 }
 
 addKeychainPassword() {
-  security add-generic-password -a $1 -s $3 -w $2
+  case $OSTYPE in
+    darwin*)
+      security add-generic-password -a $1 -s $3 -w $2
+      ;;
+    linux*)
+      echo $2 | secret-tool store --label $3 user $1 usage $3
+      ;;
+  esac
 }
 
 getKeychainPassword() {
-  security find-generic-password -wga $1 -s $2
+  case $OSTYPE in
+    darwin*)
+      security find-generic-password -wga $1 -s $2
+      ;;
+    linux*)
+      secret-tool lookup user $1 usage $2
+      ;;
+  esac
 }
 
 deleteKeychainPassword() {
-  security delete-generic-password -a $1 -s $2
+  case $OSTYPE in
+    darwin*)
+      security delete-generic-password -a $1 -s $2
+      ;;
+    linux*)
+      secret-tool clear user $1 usage $2
+      ;;
+  esac
 }
 
 getGistFileName() {
@@ -121,9 +144,9 @@ push() {
     read -r -p "Pushing $row to $fileName?" put_confirm_response
     if [[ "$put_confirm_response" =~ ^([yY][eE][sS]|[yY])$ ]];
     then
-    # Workaround for "No such file or directory" error when using ~ in the path: https://stackoverflow.com/a/3963747/640607
-    local absolutePath=$(echo $row | sed -e "s:~/:$homedir/:g")
-    cat $absolutePath | updateGistFile $github_user $github_password $dotfiles_gistid $fileName
+      # Workaround for "No such file or directory" error when using ~ in the path: https://stackoverflow.com/a/3963747/640607
+      local absolutePath=$(echo $row | sed -e "s:~/:$homedir/:g")
+      cat $absolutePath | updateGistFile $github_user $github_password $dotfiles_gistid $fileName
     fi
   done
 }