Initial commit

Author: Paolo A. Spada

.gitignore

@@ -0,0 +1 @@
+/deps/

Dockerfile

@@ -0,0 +1,11 @@
+FROM clojure
+
+ARG SRC=./deps/github.com/Commonfare-net/social-wallet-api
+
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+COPY ${SRC} /usr/src/app
+RUN lein deps
+COPY . /usr/src/app
+# CMD ["lein", "ring", "server-headless"]
+ENTRYPOINT [ "lein", "ring", "server-headless" ]

Makefile

@@ -0,0 +1,34 @@
+.PHONY: clean fetch docker/build docker/push
+
+REPO=github.com/Commonfare-net/social-wallet-api
+DEPS=./deps
+SWAPISRC=${DEPS}/${REPO}
+IMAGE="commonfare/social-wallet-api"
+
+$(shell [ -d ${SWAPISRC} ] && true || git clone https://${REPO} ${SWAPISRC})
+
+TAG ?= $(shell cd ${SWAPISRC} && git describe --tag)
+VERSION ?= $(shell echo ${TAG} | cut -d'-' -f 1)
+
+clean:
+	rm -rf ${DEPS}/*
+
+fetch:
+	cd ${SWAPISRC} && git checkout master && git reset --hard && git pull && git checkout master && git checkout ${VERSION}
+
+# comment the line of code ':host "localhost"' in order to allow the service
+# to listen on different names from localhost only
+fix:
+	mv ${SWAPISRC}/project.clj ${SWAPISRC}/project.clj.ORIGINAL
+	cat ${SWAPISRC}/project.clj.ORIGINAL | sed 's/\(:host "localhost"\)/;;\1/' > ${SWAPISRC}/project.clj
+
+docker/build: fetch fix
+	docker build . -t ${IMAGE}:${VERSION}
+	docker tag ${IMAGE}:${VERSION} ${IMAGE}:latest
+
+docker/push: docker/build
+	docker push ${IMAGE}:${VERSION}
+	docker push ${IMAGE}:latest
+
+
+all: fetch docker/build

README.md

@@ -0,0 +1,60 @@
+# Dockerize Commonfare Social Wallet API
+The purpose of this project is to create a docker image of the
+Commonfare Social Wallet API service: https://github.com/Commonfare-net/social-wallet-api
+
+## How it works
+At a glance this is very simple and consists of the follwing steps:
+ 1. Clone the source repository of Commonfare Social Wallet API (a.k.a SWAPI)
+ 2. Build a dedicated image through the Dockerfile for running SWAPI service which includes all the required Clojure/Lein/Java dependencies
+ 3. Push such image to Docker Hub
+
+## How to use it
+There is a `Makefile` that should help out when building a new image.
+
+### Build target
+Command `make docker/build` should build the image according to the provided `Dockerfile` and
+generate the final docker image named _commonfare/social-wallet-api_.  
+The image is also tagged with the git tag of the original repository:
+```
+$ docker images
+REPOSITORY                            TAG                 IMAGE ID            CREATED             SIZE
+commonfare/social-wallet-api          latest              c179ea2bd09c        8 minutes ago       767MB
+commonfare/social-wallet-api          v0.9.3              c179ea2bd09c        8 minutes ago       767MB
+```
+### Push target
+Command `make docker/push` will push the image to Docker Hub and make it publicly available
+
+### Fix target
+The `fix` target is a temporary solution that is in charge to comment out a line in the source
+code of the Social Wallet API before building the image.  
+Such line is in the project file `project.clj` and instructs the ring web server to listen only
+on the `localhost` hostname.
+
+```
+  :ring {:init    social-wallet-api.handler/init
+         :handler social-wallet-api.handler/app
+         ;; Accessible only from localhost
+         ;; https://stackoverflow.com/questions/24467539/lein-ring-server-headless-only-listen-to-localhost
+         :host "localhost"
+         :destroy social-wallet-api.handler/destroy
+         :reload-paths ["src"]}
+```
+
+If we leave such line there we will need to use docker `host` network in order to reach the
+service through (for example) `localhost:3000`.  
+As we prefer not to get container services directly using the host netwroking rather relying on
+their private container network we'd like to avoid it. But to do so and still be able to reach
+the container after some port mapping such as `<host port>:<container port>`, we need to allow
+the services to listen on other hostnames too.  
+
+So after running the `fix` target we will get the following ad are good to go with buidling the image.
+
+```
+  :ring {:init    social-wallet-api.handler/init
+         :handler social-wallet-api.handler/app
+         ;; Accessible only from localhost
+         ;; https://stackoverflow.com/questions/24467539/lein-ring-server-headless-only-listen-to-localhost
+         ;;:host "localhost"
+         :destroy social-wallet-api.handler/destroy
+         :reload-paths ["src"]}
+```