Merge pull request #2 from ProcessMaker/feature/1

Add the pm4-sdk-lua package and client to the lua executor

Author: velkymx

.gitignore

@@ -0,0 +1 @@
+sdk-repo

Dockerfile

@@ -1,16 +1,20 @@
 # Bring in from base debian docker image
 FROM debian:9.5
 
+# Update packages, then install lua
+RUN apt-get update -qq
+RUN apt-get install -y lua5.3 luarocks liblua5.3-dev build-essential libssl-dev m4
+
 # Copy over our LUA libraries/runtime
 COPY ./src /opt/executor
 
+# Build the sdk and save it in luarocks default folder
+WORKDIR /opt/executor/pm4-sdk-lua
+RUN luarocks make --local
+
 # Set working directory to our /opt/executor location
 WORKDIR /opt/executor
 
 LABEL maintainer="taylor@processmaker.com"
 
-# Update packages, then install lua
-RUN apt-get update -qq && apt-get install -y lua5.3 luarocks liblua5.3-dev
-
-RUN luarocks install dkjson 
-
+RUN luarocks install dkjson

README.md

@@ -52,6 +52,30 @@ return data
 {"message":"dlroW olleH"}
 ```
 
+## Using the PM4 SKD
+
+The executor comes pre-configured with the ProcessMaker 4 SDK ready to use.
+
+Get an instance by calling `client.make('name')`.
+
+Here is an example of fetching all pm4 users:
+
+```lua
+users_api = client.make('users_api')
+
+filter=''
+order_by='id'
+order_direction='asc'
+per_page='10'
+include=''
+local users, ret2, ret3 = users_api:get_users(filter, order_by, order_direction, per_page, include)
+
+return {users=users}
+```
+
+See ProcessMaker API documentation for more info at /api/documentation
+on your ProcessMaker 4 instance
+
 ## Command Line Usage
 ```bash
 $ docker run -v <path to local data.json>:/opt/executor/data.json \

build.sh

@@ -0,0 +1,16 @@
+set -e
+set -x
+
+BRANCH=${BRANCH:=master}
+TAG=${TAG:=dev-${BRANCH//[\/]/-}}
+
+pushd src
+    if [[ ! -d "pm4-sdk-lua" ]]; then
+        git clone --branch ${BRANCH} --depth 1 https://github.com/ProcessMaker/pm4-sdk-lua.git
+    fi
+popd
+
+docker build -t processmaker/pm4-docker-executor-lua:${TAG} .
+rm -rf src/pm4-sdk-lua
+
+# Push to dockerhub here

src/bootstrap.lua

@@ -1,3 +1,5 @@
+require "luarocks.loader"
+
 -- Create our global variables
 data = nil
 config = nil
@@ -28,6 +30,9 @@ end
 -- Reimport our dkjson, but this can now be in local scope
 local json = require "dkjson"
 
+-- Add a client wrapper to get the pre-configured api and model instances from the sdk
+client = require("client")
+
 -- Do our script and get the response
 response = dofile("/opt/executor/script.lua")
 

src/client.lua

@@ -0,0 +1,24 @@
+require "luarocks.loader"
+
+-- This helper allows the script user to get a pre-configured client instance
+-- For example, users_api = client.make('users_api')
+local function make(name)
+    local api_class = require("pmsdk.api." .. name)
+
+    local host = os.getenv("API_HOST")
+    https, host, path = host:match("^(https?)://(.-)/(.*)$")
+
+    local api_instance = api_class.new(host, '/' .. path, {https})
+    api_instance.access_token = os.getenv('API_TOKEN')
+
+    return api_instance
+end
+
+local function model(name)
+    return require("pmsdk.model." .. name)
+end
+
+return {
+    make = make,
+    model = model
+}

test.sh

@@ -0,0 +1,20 @@
+set -e
+set -x
+
+API_TOKEN=bearer-token-here
+API_HOST=http://bpm4.local.processmaker.com/api/1.0
+
+EXECUTOR_IMAGE="processmaker/pm4-docker-executor-lua:dev-master"
+EXECUTOR_DIR=${PWD}/tests/sdk
+
+docker run --rm \
+-v $EXECUTOR_DIR/data.json:/opt/executor/data.json \
+-v $EXECUTOR_DIR/config.json:/opt/executor/config.json \
+-v $EXECUTOR_DIR/script.lua:/opt/executor/script.lua \
+-v $EXECUTOR_DIR/output.json:/opt/executor/output.json \
+-e "API_TOKEN=$API_TOKEN" \
+-e "API_HOST=$API_HOST" \
+$EXECUTOR_IMAGE lua5.3 bootstrap.lua
+
+cat $EXECUTOR_DIR/output.json
+echo '' > $EXECUTOR_DIR/output.json

tests/sdk/config.json

@@ -0,0 +1 @@
+{}

tests/sdk/data.json

@@ -0,0 +1 @@
+{}

tests/sdk/output.json

@@ -0,0 +1 @@
+