Docker support added

.gitignore

@@ -8,6 +8,7 @@ pom.xml.asc
 /src/gnowdb/neo4j/gconf.clj
 /neo4j/data/
 backups/
+/rcs-repo/
 .lein-deps-sum
 .lein-repl-history
 .lein-plugins/

Dockerfile

@@ -0,0 +1,72 @@
+#--------------------------------------------------------------------#
+# Dockerfile for creating gnowdb docker image  
+# File name    : Dockerfile
+# File version : 1.0
+# Created by   : Mr. Mrunal M. Nachankar
+# Created on   : Thu Oct  4 15:12:01 IST 2018
+# Modified by  : None
+# Modified on  : Not yet
+# Description  : This file is used for creating gnowdb docker image.
+# Important    : 1. It is based on clojure - 1.9.0.384 image (Exact base docker image- clojure:tools-deps-1.9.0.394-alpine). This image is based on alpine OS.
+#                2. create "/usr/src/app" for using it as workplace
+#                3. Install lein app /engine
+#                4. Install git
+#                5. git clone gnowdb directory
+#                6. Check for existence of files after cloning
+#                7. Trigger command : "lein repl". This will take time as it will download dependenices
+#                8. Expose 3000 port to render api call outputs in web browser
+#                9. Change the working directory as "/usr/src/app/gnowdb"
+#                4. Start lein ring server
+# File version : 2.0
+# Modified by  : Mr. Mrunal M. Nachankar
+# Modified on  : Fri Oct  5 02:05:28 IST 2018
+# v2.0 changes : 1. changed lein repo becuase of error (Ref - https://github.com/pandeiro/docker-lein/blob/master/Dockerfile)
+#                1.1 on terminal "WARNING: Ignoring https://apkproxy.herokuapp.com/sgerrand/alpine-pkg-leiningen/x86_64/APKINDEX.tar.gz: IO ERROR"
+#                1.2 on web url "https://apkproxy.herokuapp.com/sgerrand/alpine-pkg-leiningen/x86_64/APKINDEX.tar.gz:" - "GET https://api.github.com/repos/sgerrand/alpine-pkg-leiningen/releases/latest: 403 API rate limit exceeded for 54.161.227.147. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.); rate reset in 9m11.102348936s"
+# File version : 3.0
+# Modified by  : Mr. Mrunal M. Nachankar
+# Modified on  : Fri Oct  5 23:56:57 IST 2018
+# v3.0 changes : 1. Removed unwanted blank line
+#                2. Removed unnecessary cd command
+#                3. As we just need to download the dependenices, I am usng "lein deps" instead of "lein repl"
+#                3. For using custom config(gconf.clj), Trying to mount it via volume (in docker-compose.yml). If file is present in required directory, just replace it with actual file (in Dockerfile). Once the changes are done, restart the container to make it effective."
+# File version : 3.1
+# Modified by  : Mr. Mrunal M. Nachankar
+# Modified on  : Sat Oct  6 01:36:48 IST 2018
+# v3.1 changes : 1. Added ";" for termination of bash/sh command execution and added print statement incase of file found.
+# File version : 3.2
+# Modified by  : Mr. Mrunal M. Nachankar
+# Modified on  : Sun Oct  7 11:25:09 IST 2018
+# v3.2 changes : 1. Added install command for rcs.
+# File version : 3.3
+# Modified by  : Mr. Mrunal M. Nachankar
+# Modified on  : Sun Oct  7 14:20:09 IST 2018
+# v3.3 changes : Changed server to server-headless to remove warning as suggested by Surrendra
+#--------------------------------------------------------------------#
+
+FROM clojure:tools-deps-1.9.0.394-alpine
+
+MAINTAINER [email protected]
+
+ENV LEIN_REPO=https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein
+ENV LEIN_ROOT=true
+ENV GNOWDB_REPO=https://github.com/mrunal4/gnowdb
+
+RUN mkdir -p /usr/src/app   \
+    &&   cd /usr/src/app   \
+    &&   wget -q -O /usr/bin/lein ${LEIN_REPO}   \
+    &&   chmod +x /usr/bin/lein   \
+    &&   apk add rcs --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing/ --allow-untrusted --no-cache   \
+    &&   apk add --no-cache  git   \
+    &&   git clone ${GNOWDB_REPO}   \
+    &&   ls -ltr gnowdb   \
+    &&   cd gnowdb   \
+    &&   lein deps
+
+EXPOSE 3000
+
+WORKDIR /usr/src/app/gnowdb
+
+ENTRYPOINT if [ -f /root/gnowdb_settings/gconf.clj ]; then echo "File found, hence copying the file gconf.clj"; cp -av /root/gnowdb_settings/gconf.clj /usr/src/app/gnowdb/src/gnowdb/neo4j; else echo "File not found"; fi   \
+    &&   cd /usr/src/app/gnowdb   \
+    &&   lein ring server-headless

Instructions.txt

@@ -0,0 +1,114 @@
+The GnowDB features are exposed via REST API
+
+To set up the server on your system and use the GnowDB features, follow the steps:
+
+Clone the directory gnowdb on your system
+
+Go to the directory 'gnowdb'
+
+Type 'lein ring server' on the command line to start the server.
+
+The server will start on 'localhost:xxxx' where xxxx is the port number
+
+Go to 'localhost:xxxx/login' to login either as a user or an admin. There are certain features which only need to identify the username and password  supplied in the POST request, whereas certain features require authorization as a 'user' or an 'admin'.
+
+To use the api through command line, we make use of curl. Here is a sample curl command to login:
+
+curl -H "Content-Type: application/json" -X POST -d '{"username":"a","password":"abc"}' --cookie-jar ./cookies.txt localhost:3000/login -i
+
+This will return:
+
+HTTP/1.1 303 See Other
+Date: Wed, 12 Jul 2017 17:51:16 GMT
+Location: /api
+Set-Cookie: ring-session=ba99d3f6-b0e5-4b68-96a2-0a77e8eea404;Path=/;HttpOnly
+Content-Length: 0
+Server: Jetty(7.6.8.v20121106)
+
+The login form expects POSTing a map with keys :username and :password as shown. --cookie-jar will help in storing the session as a cookie in cookies.txt. 
+
+'Location: /api' in the response means it's redirecting you to the welcome page of gnowdb api.
+
+You can check by typing:
+
+curl -X GET localhost:3000/api  -i
+
+Response:
+
+HTTP/1.1 200 OK
+Date: Wed, 12 Jul 2017 17:54:03 GMT
+Content-Type: text/html;charset=UTF-8
+Content-Length: 21
+Server: Jetty(7.6.8.v20121106)
+
+WELCOME TO GNOWDB API
+
+
+Now, you can test whether you are a user or an admin using the sample uri's provided as below:
+
+curl -X GET --cookie ./cookies.txt localhost:3000/role-user  -i
+
+Response:
+
+HTTP/1.1 200 OK
+Date: Wed, 12 Jul 2017 17:55:46 GMT
+Content-Type: text/html;charset=UTF-8
+Content-Length: 14
+Server: Jetty(7.6.8.v20121106)
+
+You're a user!
+
+curl -X GET --cookie ./cookies.txt localhost:3000/role-admin  -i
+
+Response:
+
+HTTP/1.1 403 Forbidden
+Date: Wed, 12 Jul 2017 17:56:38 GMT
+Content-Length: 47
+Server: Jetty(7.6.8.v20121106)
+
+Sorry, you do not have access to this resource.
+
+The below url is to check if you are authenticated or not, and doesn't put restriction on your role. 
+
+curl -X GET --cookie ./cookies.txt localhost:3000/requires-authentication  -i
+
+Response:
+
+HTTP/1.1 200 OK
+Date: Wed, 12 Jul 2017 17:57:26 GMT
+Content-Type: text/html;charset=UTF-8
+Content-Length: 26
+Server: Jetty(7.6.8.v20121106)
+
+Thanks for authenticating!
+
+Now, you can access the GnowDB functions as per the access given to you as a user or an admin.
+
+You can logout as:
+
+HTTP/1.1 302 Found
+Date: Wed, 12 Jul 2017 18:00:00 GMT
+Location: /api
+Content-Length: 0
+Server: Jetty(7.6.8.v20121106)
+
+This is redirectiong the user to the welcome page for the api : localhost:3000/api
+
+Now if you try to authenticate or authorize it will redirect you to the login page until you start a new ring login session
+
+curl -X GET --cookie ./cookies.txt localhost:3000/requires-authentication  -i
+
+Response:
+
+HTTP/1.1 302 Found
+Date: Wed, 12 Jul 2017 18:01:32 GMT
+Location: http://localhost:3000/login
+Content-Length: 0
+Server: Jetty(7.6.8.v20121106)
+
+
+
+
+
+

docker-compose.yml

@@ -0,0 +1,25 @@
+version: "3"
+services:
+  gnowdb:
+    build: ./
+    image: gnowdb:v1
+    container_name: gnowdbc
+    links:
+      - neo4j:neo4jc
+    ports:
+      - 3000:3000
+    volumes:
+      - /tmp/gnowdb_data/gnowdb_settings:/root/gnowdb_settings
+    #   - /tmp/gnowdb/data:/usr/src/app
+
+  neo4j:
+    image: neo4j:3.4.7-enterprise
+    container_name: neo4jc
+    ports:
+      - 7473:7473           #https
+      - 7474:7474           #http
+      - 7687:7687           #bolt
+    environment:
+      - NEO4J_ACCEPT_LICENSE_AGREEMENT=yes
+    # volumes:
+    #   - /tmp/neo4j/data:/data

neo4j/conf/neo4j.conf

@@ -1,6 +1,6 @@
 wrapper.java.additional=-Dneo4j.ext.udc.source=docker
-ha.host.data=e4adfd7a2b11:6001
-ha.host.coordination=e4adfd7a2b11:5001
+ha.host.data=88cd236c668d:6001
+ha.host.coordination=88cd236c668d:5001
 dbms.tx_log.rotation.retention.policy=100M size
 dbms.security.auth_enabled=false
 dbms.memory.pagecache.size=512M
@@ -12,11 +12,11 @@ dbms.connector.https.listen_address=0.0.0.0:7473
 dbms.connector.http.listen_address=0.0.0.0:7474
 dbms.connector.bolt.listen_address=0.0.0.0:7687
 causal_clustering.transaction_listen_address=0.0.0.0:6000
-causal_clustering.transaction_advertised_address=e4adfd7a2b11:6000
+causal_clustering.transaction_advertised_address=88cd236c668d:6000
 causal_clustering.raft_listen_address=0.0.0.0:7000
-causal_clustering.raft_advertised_address=e4adfd7a2b11:7000
+causal_clustering.raft_advertised_address=88cd236c668d:7000
 causal_clustering.discovery_listen_address=0.0.0.0:5000
-causal_clustering.discovery_advertised_address=e4adfd7a2b11:5000
+causal_clustering.discovery_advertised_address=88cd236c668d:5000
 dbms.security.procedures.unrestricted=apoc.*
 apoc.export.file.enabled=true
 apoc.import.file.enabled=true

project.clj

@@ -7,29 +7,32 @@
   :license {:name "GNU AFFERO GENERAL PUBLIC LICENSE Version 3"
             :url "https://www.gnu.org/licenses/agpl.txt"}
   :dependencies [
-                 [org.clojure/clojure "1.8.0"]
+                 [org.clojure/clojure "1.9.0"]
                  [org.neo4j.driver/neo4j-java-driver "1.3.0"]
-		 [compojure "1.3.4"]
-                 [ring-server "0.3.1"]
-                 [ring/ring-defaults "0.3.0"]
+                 [compojure "1.3.4"]
+                 [ring-server "0.5.0"]
+                 [ring/ring-defaults "0.3.2"]
                  [ring/ring-json "0.4.0"]
-                 [liberator "0.13"]
-                 [cheshire "5.2.0"]
-		 [async-watch "0.1.1"]
-                 [digest "1.4.5"] ;;for hashing
+                 [liberator "0.15.2"]
+                 [com.cemerick/friend "0.2.3"] ;For Authentication
+                 [cheshire "5.8.1"]
+                 [async-watch "0.1.1"]
+                 [digest "1.4.8"] ;;for hashing
                  [org.clojure/math.combinatorics "0.1.4"] ;;for nth permutation
-                 [clj-fuzzy "0.4.0"] ;;for levenshtein distance
-                 [com.novemberain/pantomime "2.9.0"];;to extract mime types
+                 [clj-fuzzy "0.4.1"] ;;for levenshtein distance
+                 [com.novemberain/pantomime "2.10.0"];;to extract mime types
                  [progrock "0.1.2"] ;;For progress bars
+                 [org.slf4j/slf4j-api "1.6.1"] ;; Mrunal - Thu Oct  4 22:50:21 IST 2018 - To remove 'SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".' error - Ref(https://stackoverflow.com/questions/7421612/slf4j-failed-to-load-class-org-slf4j-impl-staticloggerbinder and https://stackoverflow.com/questions/24956310/clojure-log4j-1-2-16-slf4j-1-5-6-clashing-with-clj-tika-and-ring-middleware-l)
+                 [org.slf4j/slf4j-log4j12 "1.6.1"] ;; Mrunal - Thu Oct  4 22:50:21 IST 2018 - To remove 'SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".' error - Ref(https://stackoverflow.com/questions/7421612/slf4j-failed-to-load-class-org-slf4j-impl-staticloggerbinder and https://stackoverflow.com/questions/24956310/clojure-log4j-1-2-16-slf4j-1-5-6-clashing-with-clj-tika-and-ring-middleware-l)
                 ] 
 
 
 
   :main ^:skip-aot gnowdb.core
   :target-path "target/%s"
   :profiles {:uberjar {:aot :all}}
-  :plugins [[lein-codox "0.10.3"] [cider/cider-nrepl "0.15.0-SNAPSHOT"] [lein-ring "0.8.12"]]
-	:ring {	:handler gnowdb.handler/app
-         	:init gnowdb.handler/init
-         	:destroy gnowdb.handler/destroy} )
+  :plugins [[lein-codox "0.10.3"] [cider/cider-nrepl "0.18.0"] [lein-ring "0.12.4"]]
+  :ring { :handler gnowdb.handler/app
+          :init gnowdb.handler/init
+          :destroy gnowdb.handler/destroy} )